Class ClavizClient

Hierarchy

ClavizClient

Constructors

constructor

new ClavizClient(url: string, token: string): ClavizClient

Parameters
- url: string
- token: string
Returns ClavizClient

Methods

deleteFacts

deleteFacts(factIds: string[]): Promise<void>

Removes facts by IDs.

Parameters
- factIds: string[]
  
  array of fact IDs.
Returns Promise<void>

destroyFunctionInstance

destroyFunctionInstance(functionId: string): Promise<void>

Stops function (if it is processing) and deletes it.

Parameters
- functionId: string
Returns Promise<void>

executeFunction

executeFunction<T>(functionId: string, parameters: any, signal?: AbortSignal, engineName?: string): Promise<T>

Executes a cancellable Claviz Function in separate thread.

Type parameters
- T
Parameters
- functionId: string
  
  Function ID.
- parameters: any
  
  Object representing function parameters.
- Optional signal: AbortSignal
  
  A signal object that can be used to cancel the execution.
- Optional engineName: string
  
  Name of the engine to use for function execution.
Returns Promise<T>
A promise that resolves to the result of the function.

getBranches

getBranches(): Promise<Branch[]>

Returns all branches in the system.

Returns Promise<Branch[]>

getCollectionEntities

getCollectionEntities(branchId?: null): Promise<CollectionEntity[]>

Returns all collection entities.

Parameters
- branchId: null = null
  
  The branch ID to get collections from.
Returns Promise<CollectionEntity[]>

getComponentEntities

getComponentEntities(): Promise<ComponentEntity[]>

Returns all component entities.

Returns Promise<ComponentEntity[]>

getCurrentUser

getCurrentUser(): Promise<UserInfo>

Returns info about the current user.

Returns Promise<UserInfo>

getCurrentUserBranch

getCurrentUserBranch(): Promise<Branch>

Returns current user branch.

Returns Promise<Branch>

getFactData

getFactData<T>(factId: string): Promise<FactData<T>>

Returns data about the fact.

Type parameters
- T
Parameters
- factId: string
Returns Promise<FactData<T>>

getFactHistory

getFactHistory<T>(factId: string, pageIndex?: number, pageSize?: number): Promise<FactHistory<T>>

Returns fact history.

Type parameters
- T
Parameters
- factId: string
- pageIndex: number = 0
- pageSize: number = 10
Returns Promise<FactHistory<T>>

getFunctionEntities

getFunctionEntities(): Promise<FunctionEntity[]>

Returns all function entities.

Returns Promise<FunctionEntity[]>

getFunctionInstanceStatus

getFunctionInstanceStatus(functionInstanceId: string): Promise<FunctionInstance>

Returns started function info by instance id.

Parameters
- functionInstanceId: string
Returns Promise<FunctionInstance>

getStartedBackgroundFunctions

getStartedBackgroundFunctions(): Promise<BackgroundFunction[]>

Returns all started background functions.

Returns Promise<BackgroundFunction[]>

getStartedFunctionInstances

getStartedFunctionInstances(): Promise<FunctionInstance[]>

Returns info about all started function instances.

Returns Promise<FunctionInstance[]>

getUserGroupList

getUserGroupList(): Promise<UserGroup[]>

Returns list of all user groups in system.

Returns Promise<UserGroup[]>

getUserList

getUserList(): Promise<UserInfo[]>

Returns list of all users in system.

Returns Promise<UserInfo[]>

importFacts

importFacts<T>(collectionId: string, facts: T[]): Promise<void>

Imports facts in batch.

Type parameters
- T
Parameters
- collectionId: string
- facts: T[]
Returns Promise<void>

migrateFacts

migrateFacts(options: MigrateFacts): Promise<any>

Migrates facts from one branch to another.

Parameters
- options: MigrateFacts
  
  The options for migration.
Returns Promise<any>

query

query<T>(expression: string, userAgnostic?: boolean): Promise<T[]>

Executes provided expression for collection.

Type parameters
- T
Parameters
- expression: string
  
  The expression to execute.
- userAgnostic: boolean = false
  
  If true, the expression will be executed as if it was run by the admin.
Returns Promise<T[]>

saveFact

saveFact<T>(factId: string, collectionId: string, fields: T): Promise<SavedFact<T>>

Saves/updates a fact.

Type parameters
- T
Parameters
- factId: string
- collectionId: string
- fields: T
Returns Promise<SavedFact<T>>

startBackgroundFunction

startBackgroundFunction(functionId: string): Promise<void>

Starts background function.

Parameters
- functionId: string
Returns Promise<void>

stopBackgroundFunction

stopBackgroundFunction(functionId: string): Promise<void>

Stops background function.

Parameters
- functionId: string
Returns Promise<void>

validateFact

validateFact<T>(collectionId: string, facts: FactValidationRequest<T>[], signal?: AbortSignal): Promise<FactValidationResult<T>>

Type parameters
- T
Parameters
- collectionId: string
- facts: FactValidationRequest<T>[]
- Optional signal: AbortSignal
Returns Promise<FactValidationResult<T>>

Generated using TypeDoc