@bind-protocol/sdk 0.2.0 → 0.4.0

package/dist/types-B6S0axfE.d.cts

@@ -0,0 +1,200 @@
+/**
+ * Core types for the Bind Protocol SDK
+ */
+
+/**
+ * Configuration options for BindClient
+ */
+interface BindClientOptions {
+    /** Your Bind Protocol API key */
+    apiKey: string;
+    /** API base URL (default: https://api.bindprotocol.com) */
+    baseUrl?: string;
+}
+type ProveJobStatus = 'pending' | 'processing' | 'completed' | 'failed';
+type ProveJobInputs = Record<string, string>;
+interface ProveJobOutputs {
+    proofKey: string | null;
+    vkKey: string | null;
+    pubsKey: string | null;
+    proofHexKey: string | null;
+    vkHexKey: string | null;
+    pubsHexKey: string | null;
+}
+interface SubmitProveJobRequest {
+    circuitId: string;
+    inputs: ProveJobInputs;
+}
+interface ProveJob {
+    jobId: string;
+    status: ProveJobStatus;
+    circuitId: string;
+    createdAt: string;
+    startedAt: string | null;
+    completedAt: string | null;
+    error: string | null;
+    outputs?: ProveJobOutputs;
+    attestationId?: string;
+    zkVerifyTxHash?: string;
+}
+interface ProveJobSummary {
+    jobId: string;
+    status: ProveJobStatus;
+    circuitId: string;
+    createdAt: string;
+    startedAt: string | null;
+    completedAt: string | null;
+    error: string | null;
+}
+interface SubmitProveJobResponse {
+    success: boolean;
+    data?: {
+        jobId: string;
+        status: ProveJobStatus;
+        circuitId: string;
+        createdAt: string;
+    };
+    error?: string;
+    requiredCredits?: number;
+    availableCredits?: number;
+}
+interface GetProveJobResponse {
+    success: boolean;
+    data?: ProveJob;
+    error?: string;
+}
+interface ListProveJobsOptions {
+    status?: ProveJobStatus;
+    limit?: number;
+    offset?: number;
+}
+interface ListProveJobsResponse {
+    success: boolean;
+    data?: {
+        jobs: ProveJobSummary[];
+        pagination: {
+            limit: number;
+            offset: number;
+            count: number;
+            total: number;
+        };
+    };
+    error?: string;
+}
+type CircuitStatus = 'active' | 'disabled' | 'deprecated';
+type CircuitValidationStatus = 'pending' | 'validating' | 'validated' | 'failed';
+interface Circuit {
+    circuitId: string;
+    name: string;
+    description?: string;
+    version: string;
+    status: CircuitStatus;
+    policyId?: string;
+    policyVersion?: string;
+    scheme: string;
+    validationStatus?: CircuitValidationStatus;
+    createdAt: string;
+    updatedAt?: string;
+}
+interface ListCircuitsResponse {
+    success: boolean;
+    data?: Circuit[];
+    error?: string;
+}
+interface GetCircuitResponse {
+    success: boolean;
+    data?: Circuit;
+    error?: string;
+}
+interface ActivateCircuitResponse {
+    success: boolean;
+    data?: {
+        circuitId: string;
+        status: CircuitStatus;
+        message: string;
+    };
+    error?: string;
+    validationStatus?: CircuitValidationStatus;
+    validationErrors?: unknown;
+}
+interface BindCredential {
+    /** The policy used to generate this credential */
+    policyId: string;
+    /** Prove job ID that generated the proof */
+    jobId: string;
+    /** zkVerify attestation ID (on-chain proof reference) */
+    attestationId?: string;
+    /** zkVerify transaction hash */
+    zkVerifyTxHash?: string;
+    /** Disclosed claims (visible to verifiers) */
+    claims: Record<string, unknown>;
+    /** Credential issuance timestamp */
+    issuedAt: string;
+    /** Credential expiration timestamp */
+    expiresAt?: string;
+}
+type ZkTlsSessionStatus = 'pending' | 'processing' | 'completed' | 'failed' | 'expired';
+interface ZkTlsExtractor {
+    id: string;
+    name: string;
+    description: string;
+    claims: string[];
+    logo?: string;
+    enabled: boolean;
+    requiresOAuth: boolean;
+    oauthProvider?: string;
+}
+interface ZkTlsWitness {
+    id: string;
+    publicKey: string;
+}
+interface ZkTlsAttestation {
+    id: string;
+    extractor: string;
+    claims: Record<string, unknown>;
+    witness: ZkTlsWitness;
+    signature: string;
+    createdAt: number;
+    expiresAt: number;
+    url: string;
+    method: string;
+}
+interface ZkTlsSession {
+    id: string;
+    extractor: string;
+    status: ZkTlsSessionStatus;
+    error?: string;
+    attestation?: ZkTlsAttestation;
+    createdAt: number;
+    updatedAt: number;
+}
+interface ListExtractorsResponse {
+    success: boolean;
+    data?: ZkTlsExtractor[];
+    error?: string;
+}
+interface ListAttestationsResponse {
+    success: boolean;
+    data?: ZkTlsAttestation[];
+    error?: string;
+}
+interface GetAttestationResponse {
+    success: boolean;
+    data?: ZkTlsAttestation;
+    error?: string;
+}
+interface CreateSessionResponse {
+    success: boolean;
+    data?: {
+        sessionId: string;
+        authUrl: string;
+    };
+    error?: string;
+}
+interface GetSessionResponse {
+    success: boolean;
+    data?: ZkTlsSession;
+    error?: string;
+}
+
+export type { ActivateCircuitResponse as A, BindClientOptions as B, CircuitStatus as C, GetProveJobResponse as G, ListProveJobsOptions as L, ProveJobStatus as P, SubmitProveJobRequest as S, ZkTlsSessionStatus as Z, ProveJobInputs as a, ProveJobOutputs as b, ProveJob as c, ProveJobSummary as d, SubmitProveJobResponse as e, ListProveJobsResponse as f, CircuitValidationStatus as g, Circuit as h, ListCircuitsResponse as i, GetCircuitResponse as j, BindCredential as k, ZkTlsExtractor as l, ZkTlsWitness as m, ZkTlsAttestation as n, ZkTlsSession as o, ListExtractorsResponse as p, ListAttestationsResponse as q, GetAttestationResponse as r, CreateSessionResponse as s, GetSessionResponse as t };

package/dist/types-B6S0axfE.d.ts

@@ -0,0 +1,200 @@
+/**
+ * Core types for the Bind Protocol SDK
+ */
+
+/**
+ * Configuration options for BindClient
+ */
+interface BindClientOptions {
+    /** Your Bind Protocol API key */
+    apiKey: string;
+    /** API base URL (default: https://api.bindprotocol.com) */
+    baseUrl?: string;
+}
+type ProveJobStatus = 'pending' | 'processing' | 'completed' | 'failed';
+type ProveJobInputs = Record<string, string>;
+interface ProveJobOutputs {
+    proofKey: string | null;
+    vkKey: string | null;
+    pubsKey: string | null;
+    proofHexKey: string | null;
+    vkHexKey: string | null;
+    pubsHexKey: string | null;
+}
+interface SubmitProveJobRequest {
+    circuitId: string;
+    inputs: ProveJobInputs;
+}
+interface ProveJob {
+    jobId: string;
+    status: ProveJobStatus;
+    circuitId: string;
+    createdAt: string;
+    startedAt: string | null;
+    completedAt: string | null;
+    error: string | null;
+    outputs?: ProveJobOutputs;
+    attestationId?: string;
+    zkVerifyTxHash?: string;
+}
+interface ProveJobSummary {
+    jobId: string;
+    status: ProveJobStatus;
+    circuitId: string;
+    createdAt: string;
+    startedAt: string | null;
+    completedAt: string | null;
+    error: string | null;
+}
+interface SubmitProveJobResponse {
+    success: boolean;
+    data?: {
+        jobId: string;
+        status: ProveJobStatus;
+        circuitId: string;
+        createdAt: string;
+    };
+    error?: string;
+    requiredCredits?: number;
+    availableCredits?: number;
+}
+interface GetProveJobResponse {
+    success: boolean;
+    data?: ProveJob;
+    error?: string;
+}
+interface ListProveJobsOptions {
+    status?: ProveJobStatus;
+    limit?: number;
+    offset?: number;
+}
+interface ListProveJobsResponse {
+    success: boolean;
+    data?: {
+        jobs: ProveJobSummary[];
+        pagination: {
+            limit: number;
+            offset: number;
+            count: number;
+            total: number;
+        };
+    };
+    error?: string;
+}
+type CircuitStatus = 'active' | 'disabled' | 'deprecated';
+type CircuitValidationStatus = 'pending' | 'validating' | 'validated' | 'failed';
+interface Circuit {
+    circuitId: string;
+    name: string;
+    description?: string;
+    version: string;
+    status: CircuitStatus;
+    policyId?: string;
+    policyVersion?: string;
+    scheme: string;
+    validationStatus?: CircuitValidationStatus;
+    createdAt: string;
+    updatedAt?: string;
+}
+interface ListCircuitsResponse {
+    success: boolean;
+    data?: Circuit[];
+    error?: string;
+}
+interface GetCircuitResponse {
+    success: boolean;
+    data?: Circuit;
+    error?: string;
+}
+interface ActivateCircuitResponse {
+    success: boolean;
+    data?: {
+        circuitId: string;
+        status: CircuitStatus;
+        message: string;
+    };
+    error?: string;
+    validationStatus?: CircuitValidationStatus;
+    validationErrors?: unknown;
+}
+interface BindCredential {
+    /** The policy used to generate this credential */
+    policyId: string;
+    /** Prove job ID that generated the proof */
+    jobId: string;
+    /** zkVerify attestation ID (on-chain proof reference) */
+    attestationId?: string;
+    /** zkVerify transaction hash */
+    zkVerifyTxHash?: string;
+    /** Disclosed claims (visible to verifiers) */
+    claims: Record<string, unknown>;
+    /** Credential issuance timestamp */
+    issuedAt: string;
+    /** Credential expiration timestamp */
+    expiresAt?: string;
+}
+type ZkTlsSessionStatus = 'pending' | 'processing' | 'completed' | 'failed' | 'expired';
+interface ZkTlsExtractor {
+    id: string;
+    name: string;
+    description: string;
+    claims: string[];
+    logo?: string;
+    enabled: boolean;
+    requiresOAuth: boolean;
+    oauthProvider?: string;
+}
+interface ZkTlsWitness {
+    id: string;
+    publicKey: string;
+}
+interface ZkTlsAttestation {
+    id: string;
+    extractor: string;
+    claims: Record<string, unknown>;
+    witness: ZkTlsWitness;
+    signature: string;
+    createdAt: number;
+    expiresAt: number;
+    url: string;
+    method: string;
+}
+interface ZkTlsSession {
+    id: string;
+    extractor: string;
+    status: ZkTlsSessionStatus;
+    error?: string;
+    attestation?: ZkTlsAttestation;
+    createdAt: number;
+    updatedAt: number;
+}
+interface ListExtractorsResponse {
+    success: boolean;
+    data?: ZkTlsExtractor[];
+    error?: string;
+}
+interface ListAttestationsResponse {
+    success: boolean;
+    data?: ZkTlsAttestation[];
+    error?: string;
+}
+interface GetAttestationResponse {
+    success: boolean;
+    data?: ZkTlsAttestation;
+    error?: string;
+}
+interface CreateSessionResponse {
+    success: boolean;
+    data?: {
+        sessionId: string;
+        authUrl: string;
+    };
+    error?: string;
+}
+interface GetSessionResponse {
+    success: boolean;
+    data?: ZkTlsSession;
+    error?: string;
+}
+
+export type { ActivateCircuitResponse as A, BindClientOptions as B, CircuitStatus as C, GetProveJobResponse as G, ListProveJobsOptions as L, ProveJobStatus as P, SubmitProveJobRequest as S, ZkTlsSessionStatus as Z, ProveJobInputs as a, ProveJobOutputs as b, ProveJob as c, ProveJobSummary as d, SubmitProveJobResponse as e, ListProveJobsResponse as f, CircuitValidationStatus as g, Circuit as h, ListCircuitsResponse as i, GetCircuitResponse as j, BindCredential as k, ZkTlsExtractor as l, ZkTlsWitness as m, ZkTlsAttestation as n, ZkTlsSession as o, ListExtractorsResponse as p, ListAttestationsResponse as q, GetAttestationResponse as r, CreateSessionResponse as s, GetSessionResponse as t };

package/dist/types-Be7Jc5V8.d.cts

@@ -0,0 +1,68 @@
+import { a as ProveJobInputs } from './types-B6S0axfE.cjs';
+
+/**
+ * Base types for data source adapters
+ *
+ * Adapters abstract away the data source specifics and provide a uniform
+ * interface for fetching data that can be used as circuit inputs.
+ */
+
+/**
+ * Base interface for all data source adapters
+ * Each adapter knows how to fetch data from a specific source
+ * and transform it into circuit inputs.
+ */
+interface DataAdapter<TConfig = unknown, TQuery = unknown, TData = unknown> {
+    /** Unique identifier for this adapter */
+    readonly id: string;
+    /** Human-readable name */
+    readonly name: string;
+    /** Description of what data source this adapter connects to */
+    readonly description: string;
+    /**
+     * Fetch raw data from the data source
+     * @param query - Adapter-specific query parameters
+     * @returns Raw data from the source
+     */
+    fetchData(query: TQuery): Promise<TData>;
+    /**
+     * Transform raw data into circuit inputs
+     * @param data - Raw data from fetchData
+     * @param circuitId - Target circuit ID (adapters may support multiple circuits)
+     * @returns Inputs ready for prove job submission
+     */
+    toCircuitInputs(data: TData, circuitId: string): ProveJobInputs;
+}
+/**
+ * Adapter registration entry
+ */
+interface AdapterRegistration<TConfig = unknown> {
+    /** Adapter factory function */
+    create: (config: TConfig) => DataAdapter;
+    /** Default configuration */
+    defaultConfig?: Partial<TConfig>;
+    /** Supported circuit IDs */
+    supportedCircuits: string[];
+}
+/**
+ * Common telemetry data structure that adapters can transform their data into
+ */
+interface TelemetryData {
+    /** Array of telemetry signal readings */
+    signals: TelemetrySignal[];
+    /** Timestamp of the data collection period start */
+    periodStart: string;
+    /** Timestamp of the data collection period end */
+    periodEnd: string;
+    /** Subject identifier (e.g., vehicle ID) */
+    subjectId: string;
+}
+/**
+ * Individual telemetry signal reading
+ */
+interface TelemetrySignal {
+    timestamp: string;
+    [key: string]: string | number | boolean | string[] | null;
+}
+
+export type { AdapterRegistration as A, DataAdapter as D, TelemetryData as T, TelemetrySignal as a };

package/dist/types-D1-qiyJO.d.ts

@@ -0,0 +1,68 @@
+import { a as ProveJobInputs } from './types-B6S0axfE.js';
+
+/**
+ * Base types for data source adapters
+ *
+ * Adapters abstract away the data source specifics and provide a uniform
+ * interface for fetching data that can be used as circuit inputs.
+ */
+
+/**
+ * Base interface for all data source adapters
+ * Each adapter knows how to fetch data from a specific source
+ * and transform it into circuit inputs.
+ */
+interface DataAdapter<TConfig = unknown, TQuery = unknown, TData = unknown> {
+    /** Unique identifier for this adapter */
+    readonly id: string;
+    /** Human-readable name */
+    readonly name: string;
+    /** Description of what data source this adapter connects to */
+    readonly description: string;
+    /**
+     * Fetch raw data from the data source
+     * @param query - Adapter-specific query parameters
+     * @returns Raw data from the source
+     */
+    fetchData(query: TQuery): Promise<TData>;
+    /**
+     * Transform raw data into circuit inputs
+     * @param data - Raw data from fetchData
+     * @param circuitId - Target circuit ID (adapters may support multiple circuits)
+     * @returns Inputs ready for prove job submission
+     */
+    toCircuitInputs(data: TData, circuitId: string): ProveJobInputs;
+}
+/**
+ * Adapter registration entry
+ */
+interface AdapterRegistration<TConfig = unknown> {
+    /** Adapter factory function */
+    create: (config: TConfig) => DataAdapter;
+    /** Default configuration */
+    defaultConfig?: Partial<TConfig>;
+    /** Supported circuit IDs */
+    supportedCircuits: string[];
+}
+/**
+ * Common telemetry data structure that adapters can transform their data into
+ */
+interface TelemetryData {
+    /** Array of telemetry signal readings */
+    signals: TelemetrySignal[];
+    /** Timestamp of the data collection period start */
+    periodStart: string;
+    /** Timestamp of the data collection period end */
+    periodEnd: string;
+    /** Subject identifier (e.g., vehicle ID) */
+    subjectId: string;
+}
+/**
+ * Individual telemetry signal reading
+ */
+interface TelemetrySignal {
+    timestamp: string;
+    [key: string]: string | number | boolean | string[] | null;
+}
+
+export type { AdapterRegistration as A, DataAdapter as D, TelemetryData as T, TelemetrySignal as a };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bind-protocol/sdk",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "TypeScript SDK for the Bind Protocol - privacy-preserving credential issuance and verification",
   "license": "MIT",
   "keywords": [
@@ -36,6 +36,11 @@
       "types": "./dist/adapters/dimo/index.d.ts",
       "import": "./dist/adapters/dimo/index.js",
       "require": "./dist/adapters/dimo/index.cjs"
+    },
+    "./adapters/zktls": {
+      "types": "./dist/adapters/zktls/index.d.ts",
+      "import": "./dist/adapters/zktls/index.js",
+      "require": "./dist/adapters/zktls/index.cjs"
     }
   },
   "files": [
@@ -46,7 +51,9 @@
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
-    "test": "vitest",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
     "typecheck": "tsc --noEmit",
     "lint": "eslint src",
     "clean": "rm -rf dist",
@@ -58,6 +65,7 @@
   "devDependencies": {
     "@dimo-network/data-sdk": "^1.4.0",
     "@types/node": "^20.0.0",
+    "@vitest/coverage-v8": "^1.0.0",
     "tsup": "^8.0.0",
     "typescript": "^5.3.0",
     "vitest": "^1.0.0"

package/dist/types-o4sbOK_a.d.cts

@@ -1,101 +0,0 @@
-/**
- * Core types for the Bind Protocol SDK
- */
-
-/**
- * Configuration options for BindClient
- */
-interface BindClientOptions {
-    /** Your Bind Protocol API key */
-    apiKey: string;
-    /** API base URL (default: https://api.bindprotocol.com) */
-    baseUrl?: string;
-}
-type ProveJobStatus = 'pending' | 'processing' | 'completed' | 'failed';
-type ProveJobInputs = Record<string, string>;
-interface ProveJobOutputs {
-    proofKey: string | null;
-    vkKey: string | null;
-    pubsKey: string | null;
-    proofHexKey: string | null;
-    vkHexKey: string | null;
-    pubsHexKey: string | null;
-}
-interface SubmitProveJobRequest {
-    circuitId: string;
-    inputs: ProveJobInputs;
-}
-interface ProveJob {
-    jobId: string;
-    status: ProveJobStatus;
-    circuitId: string;
-    createdAt: string;
-    startedAt: string | null;
-    completedAt: string | null;
-    error: string | null;
-    outputs?: ProveJobOutputs;
-    attestationId?: string;
-    zkVerifyTxHash?: string;
-}
-interface ProveJobSummary {
-    jobId: string;
-    status: ProveJobStatus;
-    circuitId: string;
-    createdAt: string;
-    startedAt: string | null;
-    completedAt: string | null;
-    error: string | null;
-}
-interface SubmitProveJobResponse {
-    success: boolean;
-    data?: {
-        jobId: string;
-        status: ProveJobStatus;
-        circuitId: string;
-        createdAt: string;
-    };
-    error?: string;
-    requiredCredits?: number;
-    availableCredits?: number;
-}
-interface GetProveJobResponse {
-    success: boolean;
-    data?: ProveJob;
-    error?: string;
-}
-interface ListProveJobsOptions {
-    status?: ProveJobStatus;
-    limit?: number;
-    offset?: number;
-}
-interface ListProveJobsResponse {
-    success: boolean;
-    data?: {
-        jobs: ProveJobSummary[];
-        pagination: {
-            limit: number;
-            offset: number;
-            count: number;
-            total: number;
-        };
-    };
-    error?: string;
-}
-interface BindCredential {
-    /** The policy used to generate this credential */
-    policyId: string;
-    /** Prove job ID that generated the proof */
-    jobId: string;
-    /** zkVerify attestation ID (on-chain proof reference) */
-    attestationId?: string;
-    /** zkVerify transaction hash */
-    zkVerifyTxHash?: string;
-    /** Disclosed claims (visible to verifiers) */
-    claims: Record<string, unknown>;
-    /** Credential issuance timestamp */
-    issuedAt: string;
-    /** Credential expiration timestamp */
-    expiresAt?: string;
-}
-
-export type { BindClientOptions as B, GetProveJobResponse as G, ListProveJobsOptions as L, ProveJobStatus as P, SubmitProveJobRequest as S, ProveJobInputs as a, ProveJobOutputs as b, ProveJob as c, ProveJobSummary as d, SubmitProveJobResponse as e, ListProveJobsResponse as f, BindCredential as g };