@hsuite/smart-engines-sdk 3.10.0 → 3.12.0

package/CHANGELOG.md

@@ -252,7 +252,7 @@ class MyService {
   ValidatorRules` section, two new rows in the "Available clients" table,
   and a pointer to the full developer guide.
 - Complete developer guide added at
-  `docs/developers/libs/rules-engine.md#smart-app-sdk-guide` — covers
+  `docs/internal/developers/libs/rules-engine.md#smart-app-sdk-guide` — covers
   authoring paths, composer reference tables, publish + entity-create
   end-to-end flow, `baas.rules.*` + `baas.entities.*` reference, and 7
   common pitfalls.

package/README.md

@@ -235,7 +235,7 @@ const sim = await baas.rules.simulate({ ruleRef, action: 'mint', context: { amou
 // sim.isValid === true | false (+ reason)
 ```
 
-Full reference: [Smart-App SDK Guide](../../docs/developers/libs/rules-engine.md#smart-app-sdk-guide)
+Full reference: [Smart-App SDK Guide](../../docs/internal/developers/libs/rules-engine.md#smart-app-sdk-guide)
 
 ---
 

package/dist/index.d.ts

@@ -1954,14 +1954,19 @@ export declare class ClusterDiscoveryClient {
 	private verifyAgainstTrustAnchor;
 	private pickRandomIndex;
 }
+export type HttpCallOptions = {
+	customerToken?: string;
+	headers?: Record<string, string>;
+};
 export type HttpClient = {
-	post<T = any>(path: string, body: unknown): Promise<T>;
-	get<T = any>(path: string): Promise<T>;
-	put<T = any>(path: string, body: unknown): Promise<T>;
-	patch<T = any>(path: string, body: unknown): Promise<T>;
-	delete<T = any>(path: string): Promise<T>;
-	getText(path: string): Promise<string>;
-	upload<T = any>(path: string, file: Blob | Buffer, filename: string, metadata?: Record<string, string>, fieldName?: string): Promise<T>;
+	post<T = any>(path: string, body: unknown, opts?: HttpCallOptions): Promise<T>;
+	get<T = any>(path: string, opts?: HttpCallOptions): Promise<T>;
+	put<T = any>(path: string, body: unknown, opts?: HttpCallOptions): Promise<T>;
+	patch<T = any>(path: string, body: unknown, opts?: HttpCallOptions): Promise<T>;
+	delete<T = any>(path: string, opts?: HttpCallOptions): Promise<T>;
+	getText(path: string, opts?: HttpCallOptions): Promise<string>;
+	getBinary(path: string, opts?: HttpCallOptions): Promise<Uint8Array>;
+	upload<T = any>(path: string, file: Blob | Buffer, filename: string, metadata?: Record<string, string>, fieldName?: string, opts?: HttpCallOptions): Promise<T>;
 	setAuthToken(token: string | undefined): void;
 	getAuthToken(): string | undefined;
 };
@@ -3874,45 +3879,66 @@ export type AgentWithdrawRequest = {
 	amount: string;
 	destination: string;
 };
+export type AgentExecuteRequest = {
+	capability: string;
+	chain?: string;
+	params: Record<string, unknown>;
+};
+export type AgentExecuteStepResult = {
+	kind: "onchain" | "offchain";
+	status: string;
+	transactionBytes?: string;
+	ref?: string;
+	detail?: Record<string, unknown>;
+};
+export type AgentExecuteResponse = {
+	capability: string;
+	steps: AgentExecuteStepResult[];
+	awaitingApproval?: boolean;
+	pendingOpId?: string;
+};
 export type AgentPreparedTransactionResponse = PreparedTransactionResponse & {
 	success: true;
 };
 export declare class AgentsClient {
 	private readonly http;
 	constructor(http: HttpClient);
-	register(request: AgentRegisterRequest): Promise<AgentInfo>;
-	get(agentId: string): Promise<AgentInfo>;
-	list(): Promise<{
+	register(request: AgentRegisterRequest, opts?: HttpCallOptions): Promise<AgentInfo>;
+	get(agentId: string, opts?: HttpCallOptions): Promise<AgentInfo>;
+	list(opts?: HttpCallOptions): Promise<{
 		agents: AgentInfo[];
 		total: number;
 	}>;
-	fund(agentId: string, request: AgentFundRequest): Promise<AgentPreparedTransactionResponse>;
-	trade(agentId: string, request: AgentTradeRequest): Promise<AgentPreparedTransactionResponse>;
-	withdraw(agentId: string, request: AgentWithdrawRequest): Promise<AgentPreparedTransactionResponse>;
-	pause(agentId: string): Promise<{
+	fund(agentId: string, request: AgentFundRequest, opts?: HttpCallOptions): Promise<AgentPreparedTransactionResponse>;
+	trade(agentId: string, request: AgentTradeRequest, opts?: HttpCallOptions): Promise<AgentPreparedTransactionResponse>;
+	withdraw(agentId: string, request: AgentWithdrawRequest, opts?: HttpCallOptions): Promise<AgentPreparedTransactionResponse>;
+	execute(agentId: string, request: AgentExecuteRequest, opts?: HttpCallOptions): Promise<AgentExecuteResponse & {
+		success: true;
+	}>;
+	pause(agentId: string, opts?: HttpCallOptions): Promise<{
 		success: boolean;
 		status: string;
 	}>;
-	resume(agentId: string): Promise<{
+	resume(agentId: string, opts?: HttpCallOptions): Promise<{
 		success: boolean;
 		status: string;
 	}>;
-	revoke(agentId: string): Promise<{
+	revoke(agentId: string, opts?: HttpCallOptions): Promise<{
 		success: boolean;
 		status: string;
 	}>;
-	updateRules(agentId: string, rules: Partial<AgentRules>): Promise<AgentInfo>;
-	getEvents(agentId: string): Promise<{
+	updateRules(agentId: string, rules: Partial<AgentRules>, opts?: HttpCallOptions): Promise<AgentInfo>;
+	getEvents(agentId: string, opts?: HttpCallOptions): Promise<{
 		events: AgentEvent[];
 		total: number;
 	}>;
-	getBalances(agentId: string): Promise<{
+	getBalances(agentId: string, opts?: HttpCallOptions): Promise<{
 		balances: AgentBalance[];
 	}>;
-	approve(agentId: string, operationId: string): Promise<{
+	approve(agentId: string, operationId: string, opts?: HttpCallOptions): Promise<{
 		success: boolean;
 	}>;
-	reject(agentId: string, operationId: string): Promise<{
+	reject(agentId: string, operationId: string, opts?: HttpCallOptions): Promise<{
 		success: boolean;
 	}>;
 }
@@ -4128,6 +4154,13 @@ export type BaasFunctionResources = {
 	timeout: number;
 	maxConcurrency?: number;
 };
+export type BaasSignedCode = {
+	code: string;
+	signature: string;
+	publicKey: string;
+	timestamp: string;
+	hash: string;
+};
 export type BaasFunctionDeployRequest = {
 	name: string;
 	description?: string;
@@ -4141,6 +4174,15 @@ export type BaasFunctionDeployRequest = {
 	}>;
 	resources?: Partial<BaasFunctionResources>;
 	environment?: Record<string, string>;
+	signedCode?: BaasSignedCode;
+};
+export type BaasFunctionEvalRequest = {
+	name?: string;
+	code: string;
+	runtime?: BaasFunctionRuntime;
+	resources?: Partial<BaasFunctionResources>;
+	input?: Record<string, unknown>;
+	signedCode?: BaasSignedCode;
 };
 export type BaasFunctionDeployResult = {
 	functionId: string;
@@ -5354,6 +5396,58 @@ declare function xlmToStroops(xlm: string | number): string;
 declare function validateBitcoinAddress(address: string): boolean;
 declare function satoshisToBtc(satoshis: string | number): string;
 declare function btcToSatoshis(btc: string | number): string;
+export type ModelProvider = "anthropic" | "openai" | "gemini";
+export type ChatMessage = {
+	role: "system" | "user" | "assistant";
+	content: string;
+};
+export type InferArgs = {
+	system?: string;
+	messages: ChatMessage[];
+	maxTokens?: number;
+};
+export type InferResult = {
+	ok: boolean;
+	text?: string;
+	error?: string;
+	raw?: unknown;
+};
+export type IModelProvider = {
+	readonly provider: ModelProvider;
+	infer(args: InferArgs): Promise<InferResult>;
+};
+export declare function createAnthropicProvider(opts: {
+	apiKey: string;
+	model: string;
+}): IModelProvider;
+export declare function createOpenAiProvider(opts: {
+	apiKey: string;
+	model: string;
+}): IModelProvider;
+export declare function createGeminiProvider(opts: {
+	apiKey: string;
+	model: string;
+}): IModelProvider;
+export declare function createModelProvider(opts: {
+	provider: ModelProvider;
+	apiKey: string;
+	model: string;
+}): IModelProvider;
+export type InferJsonResult<T> = {
+	ok: boolean;
+	value?: T;
+	error?: string;
+	raw?: string;
+};
+export declare function inferJson<T = unknown>(opts: {
+	provider: ModelProvider;
+	apiKey: string;
+	model: string;
+	system?: string;
+	input: unknown;
+	maxTokens?: number;
+	parse?: (raw: unknown) => T;
+}): Promise<InferJsonResult<T>>;
 export type StateRootResponse = {
 	appId: string;
 	stateRoot: string;
@@ -5410,21 +5504,21 @@ export declare class StorageClient {
 	private readonly http;
 	private readonly getAppId;
 	constructor(http: HttpClient, getAppId: () => string);
-	upload(file: Blob | Buffer, filename: string, metadata?: Record<string, string>): Promise<BaasUploadResult>;
-	download(cid: string): Promise<any>;
-	getMetadata(cid: string): Promise<BaasFileMetadata>;
-	delete(cid: string): Promise<{
+	upload(file: Blob | Buffer, filename: string, metadata?: Record<string, string>, opts?: HttpCallOptions): Promise<BaasUploadResult>;
+	download(cid: string, opts?: HttpCallOptions): Promise<Uint8Array>;
+	getMetadata(cid: string, opts?: HttpCallOptions): Promise<BaasFileMetadata>;
+	delete(cid: string, opts?: HttpCallOptions): Promise<{
 		success: boolean;
 	}>;
 	listFiles(pagination?: {
 		limit?: number;
 		offset?: number;
-	}): Promise<{
+	}, opts?: HttpCallOptions): Promise<{
 		files: BaasFileInfo[];
 		total: number;
 	}>;
-	getUsage(): Promise<BaasStorageUsage>;
-	exists(cid: string): Promise<{
+	getUsage(opts?: HttpCallOptions): Promise<BaasStorageUsage>;
+	exists(cid: string, opts?: HttpCallOptions): Promise<{
 		exists: boolean;
 		cid: string;
 	}>;
@@ -5433,57 +5527,59 @@ export declare class FunctionsClient {
 	private readonly http;
 	private readonly getAppId;
 	constructor(http: HttpClient, getAppId: () => string);
-	deploy(request: BaasFunctionDeployRequest): Promise<BaasFunctionDeployResult>;
-	invoke(functionId: string, payload?: unknown): Promise<BaasFunctionResult>;
-	list(): Promise<{
+	signCode(code: string): Promise<BaasSignedCode>;
+	deploy(request: BaasFunctionDeployRequest, opts?: HttpCallOptions): Promise<BaasFunctionDeployResult>;
+	invoke(functionId: string, payload?: unknown, opts?: HttpCallOptions): Promise<BaasFunctionResult>;
+	eval(request: BaasFunctionEvalRequest, opts?: HttpCallOptions): Promise<BaasFunctionResult>;
+	list(opts?: HttpCallOptions): Promise<{
 		functions: BaasFunctionInfo[];
 		total: number;
 	}>;
-	get(functionId: string): Promise<BaasFunctionInfo>;
-	update(functionId: string, updates: Partial<BaasFunctionDeployRequest>): Promise<BaasFunctionInfo>;
-	delete(functionId: string): Promise<{
+	get(functionId: string, opts?: HttpCallOptions): Promise<BaasFunctionInfo>;
+	update(functionId: string, updates: Partial<BaasFunctionDeployRequest>, opts?: HttpCallOptions): Promise<BaasFunctionInfo>;
+	delete(functionId: string, opts?: HttpCallOptions): Promise<{
 		success: boolean;
 	}>;
-	getLogs(functionId: string, options?: BaasFunctionLogOptions): Promise<{
+	getLogs(functionId: string, options?: BaasFunctionLogOptions, opts?: HttpCallOptions): Promise<{
 		logs: BaasFunctionLog[];
 		total: number;
 	}>;
-	getStats(): Promise<any>;
+	getStats(opts?: HttpCallOptions): Promise<any>;
 }
 export declare class MessagingClient {
 	private readonly http;
 	private readonly getAppId;
 	constructor(http: HttpClient, getAppId: () => string);
-	createChannel(config: BaasChannelConfig): Promise<BaasChannelConfig & {
+	createChannel(config: BaasChannelConfig, opts?: HttpCallOptions): Promise<BaasChannelConfig & {
 		channelId: string;
 	}>;
-	deleteChannel(channelId: string): Promise<{
+	deleteChannel(channelId: string, opts?: HttpCallOptions): Promise<{
 		success: boolean;
 	}>;
-	getChannel(channelId: string): Promise<BaasChannelConfig & {
+	getChannel(channelId: string, opts?: HttpCallOptions): Promise<BaasChannelConfig & {
 		channelId: string;
 		messageCount: number;
 	}>;
-	listChannels(): Promise<{
+	listChannels(opts?: HttpCallOptions): Promise<{
 		channels: Array<BaasChannelConfig & {
 			channelId: string;
 		}>;
 		total: number;
 	}>;
-	publish(channel: string, message: Record<string, unknown>, metadata?: Record<string, unknown>): Promise<BaasPublishResult>;
-	getHistory(channel: string, options?: BaasHistoryOptions): Promise<{
+	publish(channel: string, message: Record<string, unknown>, metadata?: Record<string, unknown>, opts?: HttpCallOptions): Promise<BaasPublishResult>;
+	getHistory(channel: string, options?: BaasHistoryOptions, opts?: HttpCallOptions): Promise<{
 		messages: BaasMessage[];
 		total: number;
 		hasMore: boolean;
 	}>;
-	setPresence(channel: string, member: BaasPresenceMember): Promise<{
+	setPresence(channel: string, member: BaasPresenceMember, opts?: HttpCallOptions): Promise<{
 		success: boolean;
 	}>;
-	removePresence(channel: string, clientId: string): Promise<{
+	removePresence(channel: string, clientId: string, opts?: HttpCallOptions): Promise<{
 		success: boolean;
 	}>;
-	getPresence(channel: string): Promise<BaasPresenceInfo>;
-	getStats(): Promise<any>;
+	getPresence(channel: string, opts?: HttpCallOptions): Promise<BaasPresenceInfo>;
+	getStats(opts?: HttpCallOptions): Promise<any>;
 }
 export type CustomerSessionChallenge = {
 	challenge: string;
@@ -25514,6 +25610,9 @@ declare namespace subscription {
 declare namespace faucet {
 	export { FaucetChallenge, FaucetClient, FaucetDispenseRequest, FaucetDispenseResult, FaucetDispensed, FaucetRateLimited, FaucetStatusResponse, FaucetTrustlineRequired };
 }
+declare namespace ai {
+	export { ChatMessage, IModelProvider, InferArgs, InferJsonResult, InferResult, ModelProvider, createAnthropicProvider, createGeminiProvider, createModelProvider, createOpenAiProvider, inferJson };
+}
 declare namespace bridge {
 	export { BridgeChain, BridgeClaimRecord, BridgeClaimStatus, BridgeClient, BridgeConfig, BridgeDestinationConfig, BridgeDirection, BridgeGenesisBinding, BridgeMode, BridgeOperationConfig, BridgeRulesConfig, BridgeSourceConfig, BridgeStatus, BridgeSupply, BridgeTrustLevel, CreateBridgeRequest, CreateBridgeResponse, ListBridgesOptions, ListBridgesResponse, ListClaimsOptions, ListClaimsResponse, PortRequest, PortResult, ReturnRequest };
 }
@@ -25542,7 +25641,7 @@ declare namespace personhood {
 	export { PERSONHOOD_VERIFIER_NOT_CONFIGURED, PersonhoodAttestationMethod, PersonhoodCert, PersonhoodClient, PersonhoodProof, PersonhoodVerifyParams, isPersonhoodVerifierNotConfigured };
 }
 declare namespace baas {
-	export { AgentBalance, AgentEvent, AgentFundRequest, AgentInfo, AgentOperation, AgentRegisterRequest, AgentRules, AgentRulesValidationResult, AgentStatus, AgentTradeRequest, AgentWithdrawRequest, AgentsClient, AuthenticateOptions, BaasAppListResponse, BaasAuthConfig, BaasAuthResult, BaasChallengeRequest, BaasChallengeResponse, BaasChannelConfig, BaasClient, BaasClientConfig, BaasConnectToClusterConfig, BaasDeleteResult, BaasDeployRequest, BaasDeployResponse, BaasDocument, BaasEndpoints, BaasError, BaasErrorDetails, BaasErrorResponse, BaasFileInfo, BaasFileMetadata, BaasFindResult, BaasFunctionDeployRequest, BaasFunctionDeployResult, BaasFunctionInfo, BaasFunctionLog, BaasFunctionLogOptions, BaasFunctionResources, BaasFunctionResult, BaasFunctionRuntime, BaasHistoryOptions, BaasInitRequest, BaasInitResponse, BaasInsertResult, BaasMerkleProof, BaasMessage, BaasPresenceInfo, BaasPresenceMember, BaasPublishResult, BaasQueryOptions, BaasReissuePushCredentialsResponse, BaasRevokeKekResponse, BaasRollbackRequest, BaasRotateKekResponse, BaasRuntimeStatus, BaasService, BaasSessionInfo, BaasSetWebhookResponse, BaasStateTransition, BaasStorageUsage, BaasSupportedChain, BaasTriggerType, BaasUpdateResult, BaasUploadFrontendResponse, BaasUploadResult, BaasVerifyRequest, ChannelSubscription, CreateAccountRequest$1 as BaasCreateAccountRequest, CreateAgentRequest, CreateTokenRequest$1 as CreateTokenRequest, CreateTopicRequest, DatabaseClient, DatabaseStatsResponse, DbComparisonOperator, DbDocument, DbQuery, DeployedApp, DeployedAppInfo, DeployedAppLimits, DeployedAppStatus, DeployedAppUsage, DeploymentClient, DeprecateRuleResponse, DocumentProofResponse, EntitiesClient, EntityCreationResult, EntityInfo, EntitySecurityMode, EntityType$1 as BaasEntityType, FunctionsClient, FundWith, LaunchpadEntityRequest, LaunchpadEntityResult, ListEntitiesFilter, ListEntitiesResponse, ListRulesFilter, ListRulesResponse, MessageHandler, MessagingClient, PreparedEntityCreation, PublishRuleResponse, RulesClient, SimulateRuleRequest, StateRootResponse, StateTransitionsResponse, StorageClient, ValidationResult, VersionHistoryResponse, validateAgentRules };
+	export { AgentBalance, AgentEvent, AgentFundRequest, AgentInfo, AgentOperation, AgentRegisterRequest, AgentRules, AgentRulesValidationResult, AgentStatus, AgentTradeRequest, AgentWithdrawRequest, AgentsClient, AuthenticateOptions, BaasAppListResponse, BaasAuthConfig, BaasAuthResult, BaasChallengeRequest, BaasChallengeResponse, BaasChannelConfig, BaasClient, BaasClientConfig, BaasConnectToClusterConfig, BaasDeleteResult, BaasDeployRequest, BaasDeployResponse, BaasDocument, BaasEndpoints, BaasError, BaasErrorDetails, BaasErrorResponse, BaasFileInfo, BaasFileMetadata, BaasFindResult, BaasFunctionDeployRequest, BaasFunctionDeployResult, BaasFunctionEvalRequest, BaasFunctionInfo, BaasFunctionLog, BaasFunctionLogOptions, BaasFunctionResources, BaasFunctionResult, BaasFunctionRuntime, BaasHistoryOptions, BaasInitRequest, BaasInitResponse, BaasInsertResult, BaasMerkleProof, BaasMessage, BaasPresenceInfo, BaasPresenceMember, BaasPublishResult, BaasQueryOptions, BaasReissuePushCredentialsResponse, BaasRevokeKekResponse, BaasRollbackRequest, BaasRotateKekResponse, BaasRuntimeStatus, BaasService, BaasSessionInfo, BaasSetWebhookResponse, BaasSignedCode, BaasStateTransition, BaasStorageUsage, BaasSupportedChain, BaasTriggerType, BaasUpdateResult, BaasUploadFrontendResponse, BaasUploadResult, BaasVerifyRequest, ChannelSubscription, CreateAccountRequest$1 as BaasCreateAccountRequest, CreateAgentRequest, CreateTokenRequest$1 as CreateTokenRequest, CreateTopicRequest, DatabaseClient, DatabaseStatsResponse, DbComparisonOperator, DbDocument, DbQuery, DeployedApp, DeployedAppInfo, DeployedAppLimits, DeployedAppStatus, DeployedAppUsage, DeploymentClient, DeprecateRuleResponse, DocumentProofResponse, EntitiesClient, EntityCreationResult, EntityInfo, EntitySecurityMode, EntityType$1 as BaasEntityType, FunctionsClient, FundWith, LaunchpadEntityRequest, LaunchpadEntityResult, ListEntitiesFilter, ListEntitiesResponse, ListRulesFilter, ListRulesResponse, MessageHandler, MessagingClient, PreparedEntityCreation, PublishRuleResponse, RulesClient, SimulateRuleRequest, StateRootResponse, StateTransitionsResponse, StorageClient, ValidationResult, VersionHistoryResponse, validateAgentRules };
 }
 declare namespace pqcVerify {
 	export { FetchRegistryOptions, PqcCertV1, PqcCertV1Schema, PqcCertV1Signer, ValidatorRegistrySnapshot, VerifyResult, fetchRegistrySnapshot, parsePqcCert, verifyPqcAttestation };
@@ -25551,6 +25650,7 @@ declare namespace pqcVerify {
 export {
 	RetryConfig as ResilienceRetryConfig,
 	RetryConfig$1 as RetryConfig,
+	ai,
 	auth,
 	baas,
 	bridge,