@no-witness-labs/midday-sdk 0.2.0 → 0.2.1

package/dist/providers/IndexedDBPrivateStateProvider.d.ts

@@ -0,0 +1,270 @@
+/**
+ * IndexedDB-based private state provider for browser environments.
+ *
+ * ## API Design
+ *
+ * This module uses a **module-function pattern**:
+ *
+ * - **Stateless**: Functions operate on PrivateStateProvider data
+ * - **Module functions**: `PrivateState.get(provider, id)`, `PrivateState.set(provider, id, state)`
+ * - **Data-oriented**: Provider is plain data, not an instance with methods
+ *
+ * ### Usage Patterns
+ *
+ * ```typescript
+ * // Promise user
+ * const provider = PrivateState.makeIndexedDB({ privateStateStoreName: 'my-app' });
+ * const state = await PrivateState.get(provider, 'myContract');
+ * await PrivateState.set(provider, 'myContract', { count: 0 });
+ *
+ * // Effect user
+ * const provider = PrivateState.makeIndexedDB({ privateStateStoreName: 'my-app' });
+ * const state = yield* PrivateState.effect.get(provider, 'myContract');
+ * ```
+ *
+ * @since 0.2.0
+ * @module
+ */
+import { Context, Effect, Layer } from 'effect';
+import { BrowserLevel } from 'browser-level';
+import type { PrivateStateProvider } from '@midnight-ntwrk/midnight-js-types';
+import { PrivateStateError } from './errors.js';
+type ContractAddress = string;
+type SigningKey = unknown;
+/**
+ * Configuration for IndexedDB private state storage.
+ *
+ * @since 0.2.0
+ * @category model
+ */
+export interface IndexedDBPrivateStateConfig {
+    /** Name of the IndexedDB store */
+    privateStateStoreName: string;
+    /** Password for encryption (optional, uses default if not provided) */
+    password?: string;
+}
+/**
+ * Represents a private state provider.
+ *
+ * This is plain data - use module functions to operate on it.
+ *
+ * @since 0.2.0
+ * @category model
+ */
+export interface PrivateStateProviderData {
+    /** State database */
+    readonly stateDb: BrowserLevel<string, Uint8Array> | Map<string, unknown>;
+    /** Signing key database */
+    readonly signingKeyDb: BrowserLevel<string, Uint8Array> | Map<string, SigningKey>;
+    /** Encryption function */
+    readonly encrypt: (data: Uint8Array) => Uint8Array;
+    /** Decryption function */
+    readonly decrypt: (data: Uint8Array) => Uint8Array;
+    /** Type indicator */
+    readonly type: 'indexeddb' | 'memory';
+}
+declare function getEffect(provider: PrivateStateProviderData, privateStateId: string): Effect.Effect<unknown | null, PrivateStateError>;
+declare function setEffect(provider: PrivateStateProviderData, privateStateId: string, state: unknown): Effect.Effect<void, PrivateStateError>;
+declare function removeEffect(provider: PrivateStateProviderData, privateStateId: string): Effect.Effect<void, PrivateStateError>;
+declare function clearEffect(provider: PrivateStateProviderData): Effect.Effect<void, PrivateStateError>;
+declare function setSigningKeyEffect(provider: PrivateStateProviderData, address: ContractAddress, signingKey: SigningKey): Effect.Effect<void, PrivateStateError>;
+declare function getSigningKeyEffect(provider: PrivateStateProviderData, address: ContractAddress): Effect.Effect<SigningKey | null, PrivateStateError>;
+declare function removeSigningKeyEffect(provider: PrivateStateProviderData, address: ContractAddress): Effect.Effect<void, PrivateStateError>;
+declare function clearSigningKeysEffect(provider: PrivateStateProviderData): Effect.Effect<void, PrivateStateError>;
+/**
+ * Create an IndexedDB-based private state provider.
+ *
+ * @param config - Configuration options
+ * @returns PrivateStateProviderData
+ *
+ * @example
+ * ```typescript
+ * const provider = makeIndexedDB({
+ *   privateStateStoreName: 'my-dapp-state',
+ *   password: 'user-password',
+ * });
+ * ```
+ *
+ * @since 0.2.0
+ * @category constructors
+ */
+export declare function makeIndexedDB(config: IndexedDBPrivateStateConfig): PrivateStateProviderData;
+/**
+ * Create an in-memory private state provider (no persistence).
+ *
+ * @returns PrivateStateProviderData
+ *
+ * @example
+ * ```typescript
+ * const provider = makeInMemory();
+ * ```
+ *
+ * @since 0.2.0
+ * @category constructors
+ */
+export declare function makeInMemory(): PrivateStateProviderData;
+/**
+ * Get private state.
+ *
+ * @since 0.2.0
+ * @category operations
+ */
+export declare function get(provider: PrivateStateProviderData, privateStateId: string): Promise<unknown | null>;
+/**
+ * Set private state.
+ *
+ * @since 0.2.0
+ * @category operations
+ */
+export declare function set(provider: PrivateStateProviderData, privateStateId: string, state: unknown): Promise<void>;
+/**
+ * Remove private state.
+ *
+ * @since 0.2.0
+ * @category operations
+ */
+export declare function remove(provider: PrivateStateProviderData, privateStateId: string): Promise<void>;
+/**
+ * Clear all private state.
+ *
+ * @since 0.2.0
+ * @category operations
+ */
+export declare function clear(provider: PrivateStateProviderData): Promise<void>;
+/**
+ * Set signing key.
+ *
+ * @since 0.2.0
+ * @category operations
+ */
+export declare function setSigningKey(provider: PrivateStateProviderData, address: ContractAddress, signingKey: SigningKey): Promise<void>;
+/**
+ * Get signing key.
+ *
+ * @since 0.2.0
+ * @category operations
+ */
+export declare function getSigningKey(provider: PrivateStateProviderData, address: ContractAddress): Promise<SigningKey | null>;
+/**
+ * Remove signing key.
+ *
+ * @since 0.2.0
+ * @category operations
+ */
+export declare function removeSigningKey(provider: PrivateStateProviderData, address: ContractAddress): Promise<void>;
+/**
+ * Clear all signing keys.
+ *
+ * @since 0.2.0
+ * @category operations
+ */
+export declare function clearSigningKeys(provider: PrivateStateProviderData): Promise<void>;
+/**
+ * Raw Effect APIs for advanced users.
+ *
+ * @since 0.2.0
+ * @category effect
+ */
+export declare const effect: {
+    get: typeof getEffect;
+    set: typeof setEffect;
+    remove: typeof removeEffect;
+    clear: typeof clearEffect;
+    setSigningKey: typeof setSigningKeyEffect;
+    getSigningKey: typeof getSigningKeyEffect;
+    removeSigningKey: typeof removeSigningKeyEffect;
+    clearSigningKeys: typeof clearSigningKeysEffect;
+};
+/**
+ * Create a browser-compatible private state provider using IndexedDB.
+ *
+ * This function returns a PrivateStateProvider compatible with midnight-js.
+ *
+ * @param config - Configuration options
+ * @returns PrivateStateProvider compatible with midnight-js
+ *
+ * @example
+ * ```typescript
+ * const provider = indexedDBPrivateStateProvider({
+ *   privateStateStoreName: 'my-dapp-state',
+ *   password: 'user-password',
+ * });
+ *
+ * // Use with Client.create()
+ * const client = await Client.create({
+ *   privateStateProvider: provider,
+ *   // ...
+ * });
+ * ```
+ *
+ * @since 0.2.0
+ * @category constructors
+ */
+export declare function indexedDBPrivateStateProvider(config: IndexedDBPrivateStateConfig): PrivateStateProvider<string, unknown>;
+/**
+ * Create an in-memory private state provider (no persistence).
+ *
+ * This function returns a PrivateStateProvider compatible with midnight-js.
+ *
+ * @returns PrivateStateProvider that stores state in memory
+ *
+ * @example
+ * ```typescript
+ * const provider = inMemoryPrivateStateProvider();
+ *
+ * // Use with Client.create()
+ * const client = await Client.create({
+ *   privateStateProvider: provider,
+ *   // ...
+ * });
+ * ```
+ *
+ * @since 0.2.0
+ * @category constructors
+ */
+export declare function inMemoryPrivateStateProvider(): PrivateStateProvider<string, unknown>;
+/**
+ * Service interface for PrivateState operations.
+ *
+ * @since 0.2.0
+ * @category service
+ */
+export interface PrivateStateServiceImpl {
+    readonly get: (provider: PrivateStateProviderData, privateStateId: string) => Effect.Effect<unknown | null, PrivateStateError>;
+    readonly set: (provider: PrivateStateProviderData, privateStateId: string, state: unknown) => Effect.Effect<void, PrivateStateError>;
+    readonly remove: (provider: PrivateStateProviderData, privateStateId: string) => Effect.Effect<void, PrivateStateError>;
+    readonly clear: (provider: PrivateStateProviderData) => Effect.Effect<void, PrivateStateError>;
+    readonly setSigningKey: (provider: PrivateStateProviderData, address: string, signingKey: unknown) => Effect.Effect<void, PrivateStateError>;
+    readonly getSigningKey: (provider: PrivateStateProviderData, address: string) => Effect.Effect<unknown | null, PrivateStateError>;
+    readonly removeSigningKey: (provider: PrivateStateProviderData, address: string) => Effect.Effect<void, PrivateStateError>;
+    readonly clearSigningKeys: (provider: PrivateStateProviderData) => Effect.Effect<void, PrivateStateError>;
+}
+declare const PrivateStateService_base: Context.TagClass<PrivateStateService, "PrivateStateService", PrivateStateServiceImpl>;
+/**
+ * Context.Tag for PrivateStateService dependency injection.
+ *
+ * @since 0.2.0
+ * @category service
+ */
+export declare class PrivateStateService extends PrivateStateService_base {
+}
+/**
+ * Live Layer for PrivateStateService.
+ *
+ * @since 0.2.0
+ * @category layer
+ */
+export declare const PrivateStateLive: Layer.Layer<PrivateStateService>;
+declare const PrivateStateProviderService_base: Context.TagClass<PrivateStateProviderService, "PrivateStateProviderService", PrivateStateProvider<string, any>>;
+/**
+ * Private state provider service for dependency injection.
+ *
+ * This tag allows injecting a PrivateStateProvider instance.
+ *
+ * @since 0.3.0
+ * @category services
+ */
+export declare class PrivateStateProviderService extends PrivateStateProviderService_base {
+}
+export {};
+//# sourceMappingURL=IndexedDBPrivateStateProvider.d.ts.map

package/dist/providers/IndexedDBPrivateStateProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexedDBPrivateStateProvider.d.ts","sourceRoot":"","sources":["../../src/providers/IndexedDBPrivateStateProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAIhD,KAAK,eAAe,GAAG,MAAM,CAAC;AAG9B,KAAK,UAAU,GAAG,OAAO,CAAC;AAE1B;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C,kCAAkC;IAClC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC,qBAAqB;IACrB,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1E,2BAA2B;IAC3B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClF,0BAA0B;IAC1B,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,UAAU,CAAC;IACnD,0BAA0B;IAC1B,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,UAAU,CAAC;IACnD,qBAAqB;IACrB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,QAAQ,CAAC;CACvC;AAMD,iBAAS,SAAS,CAChB,QAAQ,EAAE,wBAAwB,EAClC,cAAc,EAAE,MAAM,GACrB,MAAM,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,EAAE,iBAAiB,CAAC,CA2BlD;AAED,iBAAS,SAAS,CAChB,QAAQ,EAAE,wBAAwB,EAClC,cAAc,EAAE,MAAM,EACtB,KAAK,EAAE,OAAO,GACb,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAsBxC;AAED,iBAAS,YAAY,CACnB,QAAQ,EAAE,wBAAwB,EAClC,cAAc,EAAE,MAAM,GACrB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAyBxC;AAED,iBAAS,WAAW,CAAC,QAAQ,EAAE,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAgB/F;AAED,iBAAS,mBAAmB,CAC1B,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,UAAU,GACrB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAsBxC;AAED,iBAAS,mBAAmB,CAC1B,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,eAAe,GACvB,MAAM,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI,EAAE,iBAAiB,CAAC,CA2BrD;AAED,iBAAS,sBAAsB,CAC7B,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,eAAe,GACvB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAyBxC;AAED,iBAAS,sBAAsB,CAAC,QAAQ,EAAE,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAgB1G;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,2BAA2B,GAAG,wBAAwB,CAiC3F;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,IAAI,wBAAwB,CAQvD;AAED;;;;;GAKG;AACH,wBAAsB,GAAG,CACvB,QAAQ,EAAE,wBAAwB,EAClC,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAEzB;AAED;;;;;GAKG;AACH,wBAAsB,GAAG,CACvB,QAAQ,EAAE,wBAAwB,EAClC,cAAc,EAAE,MAAM,EACtB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;GAKG;AACH,wBAAsB,MAAM,CAC1B,QAAQ,EAAE,wBAAwB,EAClC,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;GAKG;AACH,wBAAsB,KAAK,CAAC,QAAQ,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CAE7E;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CACjC,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CACjC,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAE5B;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CAExF;AAED;;;;;GAKG;AACH,eAAO,MAAM,MAAM;;;;;;;;;CASlB,CAAC;AAMF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,2BAA2B,GAClC,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,CA6BvC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,4BAA4B,IAAI,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,CA6BpF;AAMD;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,GAAG,EAAE,CACZ,QAAQ,EAAE,wBAAwB,EAClC,cAAc,EAAE,MAAM,KACnB,MAAM,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC;IACtD,QAAQ,CAAC,GAAG,EAAE,CACZ,QAAQ,EAAE,wBAAwB,EAClC,cAAc,EAAE,MAAM,EACtB,KAAK,EAAE,OAAO,KACX,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC5C,QAAQ,CAAC,MAAM,EAAE,CACf,QAAQ,EAAE,wBAAwB,EAClC,cAAc,EAAE,MAAM,KACnB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC5C,QAAQ,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,wBAAwB,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC/F,QAAQ,CAAC,aAAa,EAAE,CACtB,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,OAAO,KAChB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC5C,QAAQ,CAAC,aAAa,EAAE,CACtB,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,MAAM,KACZ,MAAM,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC;IACtD,QAAQ,CAAC,gBAAgB,EAAE,CACzB,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,MAAM,KACZ,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC5C,QAAQ,CAAC,gBAAgB,EAAE,CACzB,QAAQ,EAAE,wBAAwB,KAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;CAC7C;;AAED;;;;;GAKG;AACH,qBAAa,mBAAoB,SAAQ,wBAGtC;CAAG;AAMN;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAS5D,CAAC;;AAEH;;;;;;;GAOG;AACH,qBAAa,2BAA4B,SAAQ,gCAG9C;CAAG"}