@trusset/sdk 0.1.0 → 0.5.0

package/dist/flow-Cz8A09rn.d.mts

@@ -0,0 +1,171 @@
+/**
+ * Base API response envelope returned by all Trusset endpoints.
+ */
+interface ApiResponse<T> {
+    success: boolean;
+    data?: T;
+    error?: ApiError;
+    metadata: ResponseMetadata;
+}
+interface ApiError {
+    code: string;
+    message: string;
+    details?: unknown;
+}
+interface ResponseMetadata {
+    requestId: string;
+    timestamp: string;
+    total?: number;
+}
+/**
+ * SDK configuration passed to TrussetClient on init.
+ */
+interface TrussetConfig {
+    /** API key from the Trusset issuer dashboard. */
+    apiKey: string;
+    /**
+     * Base URL of the Trusset API.
+     * Defaults to https://api.trusset.org
+     */
+    baseUrl?: string;
+    /**
+     * Request timeout in milliseconds. Default: 30000 (30s).
+     */
+    timeoutMs?: number;
+    /**
+     * Max retries on transient failures (5xx, network). Default: 3.
+     */
+    maxRetries?: number;
+    /**
+     * Custom logger. Defaults to silent.
+     */
+    logger?: Logger;
+}
+interface Logger {
+    debug(msg: string, meta?: Record<string, unknown>): void;
+    info(msg: string, meta?: Record<string, unknown>): void;
+    warn(msg: string, meta?: Record<string, unknown>): void;
+    error(msg: string, meta?: Record<string, unknown>): void;
+}
+interface PaginationOptions {
+    limit?: number;
+    offset?: number;
+}
+/**
+ * A broadcast transaction, as returned by a signer's `sendTransaction`.
+ * Matches the shape of an ethers v5 `TransactionResponse`.
+ */
+interface SignedTransaction {
+    hash: string;
+    wait(confirmations?: number): Promise<unknown>;
+}
+/**
+ * Anything that can sign and broadcast a transaction. An ethers v5 `Signer`
+ * (`Wallet`, `JsonRpcSigner`, ...) satisfies this without any adapter.
+ *
+ * Trusset never holds a key: on-chain writes return unsigned calldata that
+ * the wallet holder signs. The signer you pass must be the registered issuer
+ * wallet, since the identity registry checks its role on-chain.
+ */
+interface TransactionSigner {
+    sendTransaction(transaction: UnsignedTransaction): Promise<SignedTransaction>;
+    getAddress?(): Promise<string>;
+    getChainId?(): Promise<number>;
+    _signTypedData?(domain: Record<string, unknown>, types: Record<string, Array<{
+        name: string;
+        type: string;
+    }>>, value: Record<string, unknown>): Promise<string>;
+    signMessage?(message: string | Uint8Array): Promise<string>;
+    estimateGas?(transaction: UnsignedTransaction): Promise<{
+        toString(): string;
+    }>;
+}
+interface UnsignedTransaction {
+    to?: string;
+    data: string;
+    value?: string;
+    chainId?: number;
+    gasLimit?: string;
+}
+/**
+ * Sign and broadcast the prepared transaction, then confirm it with the
+ * backend. Convenience only - the SDK does not verify the calldata it was
+ * handed. If your integration depends on the transaction doing exactly what
+ * you asked, decode and assert `transaction.to` and `transaction.data`
+ * yourself, in your own pinned code, before signing.
+ */
+interface SignOptions {
+    signer: TransactionSigner;
+    /** Confirmations to wait for before confirming with the backend. Default: 1. */
+    confirmations?: number;
+}
+/**
+ * Confirm a transaction you signed and broadcast yourself. The backend reads
+ * the mined receipt and only then updates its records.
+ */
+interface ConfirmOptions {
+    txHash: string;
+}
+interface SignedStep {
+    functionName: string | null;
+    txHash: string | null;
+    optional: boolean;
+    error?: string;
+}
+
+type FetchLike = (input: string, init: RequestInit) => Promise<Response>;
+interface HttpClientConfig {
+    baseUrl: string;
+    apiKey: string;
+    timeoutMs: number;
+    maxRetries: number;
+    logger: Logger;
+    fetch: FetchLike;
+}
+type RetryClass = 'read' | 'write' | 'confirm';
+interface RequestOptions {
+    timeoutMs?: number;
+    retry?: RetryClass;
+}
+interface BinaryResponse {
+    bytes: Uint8Array;
+    contentType: string;
+    filename: string | null;
+}
+type Params = Record<string, string | number | boolean | undefined>;
+declare class HttpClient {
+    private readonly config;
+    constructor(config: Partial<HttpClientConfig> & {
+        apiKey: string;
+    });
+    get<T>(path: string, params?: Params, options?: RequestOptions): Promise<T>;
+    /** GET that also returns the response metadata (used for list totals). */
+    getWithMeta<T>(path: string, params?: Params): Promise<{
+        data: T;
+        metadata: ResponseMetadata;
+    }>;
+    getBinary(path: string, params?: Params, options?: RequestOptions): Promise<BinaryResponse>;
+    post<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    put<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    patch<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    delete<T>(path: string, options?: RequestOptions): Promise<T>;
+    postForm<T>(path: string, form: FormData, params?: Params, options?: RequestOptions): Promise<T>;
+    private buildUrl;
+    private retryClass;
+    private canRetry;
+    private headers;
+    private send;
+    private requestEnvelope;
+    private requestBinary;
+    private throwIfFailed;
+    private withRetries;
+}
+
+interface ChainSource {
+    instanceChainId(): Promise<number>;
+}
+interface PlanOptions {
+    confirmIndex?: number | 'last' | null;
+}
+
+export { type ApiError as A, type ConfirmOptions as C, HttpClient as H, type Logger as L, type PaginationOptions as P, type ResponseMetadata as R, type SignedStep as S, type TrussetConfig as T, type UnsignedTransaction as U, type ApiResponse as a, type SignOptions as b, type SignedTransaction as c, type TransactionSigner as d, type ChainSource as e, type PlanOptions as f };

package/dist/flow-Cz8A09rn.d.ts

@@ -0,0 +1,171 @@
+/**
+ * Base API response envelope returned by all Trusset endpoints.
+ */
+interface ApiResponse<T> {
+    success: boolean;
+    data?: T;
+    error?: ApiError;
+    metadata: ResponseMetadata;
+}
+interface ApiError {
+    code: string;
+    message: string;
+    details?: unknown;
+}
+interface ResponseMetadata {
+    requestId: string;
+    timestamp: string;
+    total?: number;
+}
+/**
+ * SDK configuration passed to TrussetClient on init.
+ */
+interface TrussetConfig {
+    /** API key from the Trusset issuer dashboard. */
+    apiKey: string;
+    /**
+     * Base URL of the Trusset API.
+     * Defaults to https://api.trusset.org
+     */
+    baseUrl?: string;
+    /**
+     * Request timeout in milliseconds. Default: 30000 (30s).
+     */
+    timeoutMs?: number;
+    /**
+     * Max retries on transient failures (5xx, network). Default: 3.
+     */
+    maxRetries?: number;
+    /**
+     * Custom logger. Defaults to silent.
+     */
+    logger?: Logger;
+}
+interface Logger {
+    debug(msg: string, meta?: Record<string, unknown>): void;
+    info(msg: string, meta?: Record<string, unknown>): void;
+    warn(msg: string, meta?: Record<string, unknown>): void;
+    error(msg: string, meta?: Record<string, unknown>): void;
+}
+interface PaginationOptions {
+    limit?: number;
+    offset?: number;
+}
+/**
+ * A broadcast transaction, as returned by a signer's `sendTransaction`.
+ * Matches the shape of an ethers v5 `TransactionResponse`.
+ */
+interface SignedTransaction {
+    hash: string;
+    wait(confirmations?: number): Promise<unknown>;
+}
+/**
+ * Anything that can sign and broadcast a transaction. An ethers v5 `Signer`
+ * (`Wallet`, `JsonRpcSigner`, ...) satisfies this without any adapter.
+ *
+ * Trusset never holds a key: on-chain writes return unsigned calldata that
+ * the wallet holder signs. The signer you pass must be the registered issuer
+ * wallet, since the identity registry checks its role on-chain.
+ */
+interface TransactionSigner {
+    sendTransaction(transaction: UnsignedTransaction): Promise<SignedTransaction>;
+    getAddress?(): Promise<string>;
+    getChainId?(): Promise<number>;
+    _signTypedData?(domain: Record<string, unknown>, types: Record<string, Array<{
+        name: string;
+        type: string;
+    }>>, value: Record<string, unknown>): Promise<string>;
+    signMessage?(message: string | Uint8Array): Promise<string>;
+    estimateGas?(transaction: UnsignedTransaction): Promise<{
+        toString(): string;
+    }>;
+}
+interface UnsignedTransaction {
+    to?: string;
+    data: string;
+    value?: string;
+    chainId?: number;
+    gasLimit?: string;
+}
+/**
+ * Sign and broadcast the prepared transaction, then confirm it with the
+ * backend. Convenience only - the SDK does not verify the calldata it was
+ * handed. If your integration depends on the transaction doing exactly what
+ * you asked, decode and assert `transaction.to` and `transaction.data`
+ * yourself, in your own pinned code, before signing.
+ */
+interface SignOptions {
+    signer: TransactionSigner;
+    /** Confirmations to wait for before confirming with the backend. Default: 1. */
+    confirmations?: number;
+}
+/**
+ * Confirm a transaction you signed and broadcast yourself. The backend reads
+ * the mined receipt and only then updates its records.
+ */
+interface ConfirmOptions {
+    txHash: string;
+}
+interface SignedStep {
+    functionName: string | null;
+    txHash: string | null;
+    optional: boolean;
+    error?: string;
+}
+
+type FetchLike = (input: string, init: RequestInit) => Promise<Response>;
+interface HttpClientConfig {
+    baseUrl: string;
+    apiKey: string;
+    timeoutMs: number;
+    maxRetries: number;
+    logger: Logger;
+    fetch: FetchLike;
+}
+type RetryClass = 'read' | 'write' | 'confirm';
+interface RequestOptions {
+    timeoutMs?: number;
+    retry?: RetryClass;
+}
+interface BinaryResponse {
+    bytes: Uint8Array;
+    contentType: string;
+    filename: string | null;
+}
+type Params = Record<string, string | number | boolean | undefined>;
+declare class HttpClient {
+    private readonly config;
+    constructor(config: Partial<HttpClientConfig> & {
+        apiKey: string;
+    });
+    get<T>(path: string, params?: Params, options?: RequestOptions): Promise<T>;
+    /** GET that also returns the response metadata (used for list totals). */
+    getWithMeta<T>(path: string, params?: Params): Promise<{
+        data: T;
+        metadata: ResponseMetadata;
+    }>;
+    getBinary(path: string, params?: Params, options?: RequestOptions): Promise<BinaryResponse>;
+    post<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    put<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    patch<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    delete<T>(path: string, options?: RequestOptions): Promise<T>;
+    postForm<T>(path: string, form: FormData, params?: Params, options?: RequestOptions): Promise<T>;
+    private buildUrl;
+    private retryClass;
+    private canRetry;
+    private headers;
+    private send;
+    private requestEnvelope;
+    private requestBinary;
+    private throwIfFailed;
+    private withRetries;
+}
+
+interface ChainSource {
+    instanceChainId(): Promise<number>;
+}
+interface PlanOptions {
+    confirmIndex?: number | 'last' | null;
+}
+
+export { type ApiError as A, type ConfirmOptions as C, HttpClient as H, type Logger as L, type PaginationOptions as P, type ResponseMetadata as R, type SignedStep as S, type TrussetConfig as T, type UnsignedTransaction as U, type ApiResponse as a, type SignOptions as b, type SignedTransaction as c, type TransactionSigner as d, type ChainSource as e, type PlanOptions as f };