TokenModel
Defined in: packages/core/src/models/token.ts:16
Data operations for CI tokens.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TokenModel(
db,tables?):TokenModel
Defined in: packages/core/src/models/token.ts:24
Parameters
Section titled “Parameters”Database adapter.
tables?
Section titled “tables?”TokenTables
Table handles.
Returns
Section titled “Returns”TokenModel
Methods
Section titled “Methods”create()
Section titled “create()”create(
projectId,input):Promise<Token>
Defined in: packages/core/src/models/token.ts:37
Create a token record storing its hash.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
Project ID.
Token name, hash, and optional owning user ID (null for legacy/admin-token minting; such tokens resolve as viewer).
string
string
userId?
Section titled “userId?”string | null
Returns
Section titled “Returns”Promise<Token>
The created token.
findByHash()
Section titled “findByHash()”findByHash(
hash):Promise<Token|null>
Defined in: packages/core/src/models/token.ts:85
Fetch a token by its hashed value, or null if not found.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Token | null>
get(
projectId,id):Promise<Token|null>
Defined in: packages/core/src/models/token.ts:73
Fetch a token by id within a project, or null if not found.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
string
Returns
Section titled “Returns”Promise<Token | null>
issue()
Section titled “issue()”issue(
projectId,input):Promise<{token:Token;value:string; }>
Defined in: packages/core/src/models/token.ts:56
Mint a new shelf_ token for a project and store only its hash.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
string
userId?
Section titled “userId?”string | null
Returns
Section titled “Returns”Promise<{ token: Token; value: string; }>
The stored record and the plaintext value (shown to the user once).
list()
Section titled “list()”list(
projectId):Promise<Token[]>
Defined in: packages/core/src/models/token.ts:66
List all tokens for a project.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
Returns
Section titled “Returns”Promise<Token[]>
remove()
Section titled “remove()”remove(
id):Promise<void>
Defined in: packages/core/src/models/token.ts:94
Delete a token by id.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>