@aithos/sdk 0.1.0-alpha.3 → 0.1.0-alpha.31

package/dist/src/data.d.ts

@@ -0,0 +1,97 @@
+export interface AithosSchemaLite {
+    readonly schema: string;
+    readonly indexable: ReadonlySet<string>;
+    readonly encrypted: ReadonlySet<string>;
+    readonly auto: ReadonlySet<string>;
+    readonly defaults: Readonly<Record<string, unknown>>;
+}
+export interface CreateDataClientArgs {
+    /** Base URL of the deployed PDS (e.g. https://abc.execute-api.eu-west-3.amazonaws.com). */
+    readonly pdsUrl: string;
+    /** Subject DID — typically did:key:… in dev, did:aithos:… in prod. */
+    readonly did: string;
+    /**
+     * Ed25519 sphere seed (32 bytes). For did:key this is the same as
+     * the key embedded in the DID itself. For did:aithos this is the
+     * subject's `#data` (or `#public`) sphere key.
+     */
+    readonly sphereSeed: Uint8Array;
+    /**
+     * The verification method URL within the DID document used to sign
+     * envelopes. For did:key this is `<did>#<multibase>`. For did:aithos
+     * this is `<did>#data` (or `#public`).
+     */
+    readonly verificationMethod: string;
+    /** Optional fetch implementation. Defaults to globalThis.fetch. */
+    readonly fetch?: typeof fetch;
+}
+export interface DataClient {
+    /** Get / create a collection handle. */
+    collection(name: string): DataCollection;
+    /** Initialize a new collection with an explicit schema. */
+    createCollection(args: {
+        name: string;
+        schema: string;
+        forwardSecrecy?: "best_effort" | "strict";
+    }): Promise<void>;
+    /** List collections owned by this subject. */
+    listCollections(): Promise<readonly {
+        name: string;
+        schema: string;
+        record_count: number;
+    }[]>;
+    /** List gamma audit entries. */
+    listGammaEntries(opts?: {
+        limit?: number;
+        opPrefix?: string;
+        verify?: boolean;
+    }): Promise<unknown>;
+    /** Drop in-memory cache (CMK, collection metadata, …). */
+    reset(): void;
+}
+export interface DataCollection {
+    readonly name: string;
+    /**
+     * Insert a record. The object MAY contain both indexable and
+     * encrypted fields per the schema; the SDK splits them.
+     */
+    insert(record: Record<string, unknown>): Promise<string>;
+    /** Fetch one record by id (decrypted client-side). */
+    get(recordId: string): Promise<Record<string, unknown> | null>;
+    /** List records, decrypted. Pagination via opaque cursor. */
+    list(opts?: ListOpts): Promise<{
+        items: Record<string, unknown>[];
+        nextCursor?: string;
+    }>;
+    /**
+     * Replace a record. Same shape as insert; the SDK splits indexable
+     * vs encrypted again per the schema.
+     */
+    update(recordId: string, record: Record<string, unknown>): Promise<void>;
+    /** Soft-delete a record. */
+    delete(recordId: string): Promise<void>;
+}
+export interface ListOpts {
+    readonly filter?: {
+        readonly equals?: {
+            field: string;
+            value: unknown;
+        };
+        readonly contains?: {
+            field: string;
+            value: string;
+        };
+        readonly tagsAny?: readonly string[];
+        readonly tagsAll?: readonly string[];
+        readonly range?: {
+            field: string;
+            gte?: string;
+            lte?: string;
+        };
+    };
+    readonly order?: "newest" | "oldest";
+    readonly limit?: number;
+    readonly cursor?: string;
+}
+export declare function createDataClient(args: CreateDataClientArgs): DataClient;
+//# sourceMappingURL=data.d.ts.map