@miden-sdk/miden-sdk 0.13.2 → 0.14.0-alpha

package/dist/docs-entry.d.ts

@@ -0,0 +1,36 @@
+/**
+ * TypeDoc entry point — curated subset of the public API.
+ * Only types listed here (or transitively referenced) appear in generated docs.
+ * Runtime consumers should import from index.d.ts, not this file.
+ */
+
+// Curated WASM re-exports: only types referenced in the public API
+export {
+  Account,
+  AccountCode,
+  AccountFile,
+  AccountHeader,
+  AccountId,
+  AccountStorage,
+  AssetVault,
+  ConsumableNoteRecord,
+  Felt,
+  InputNoteRecord,
+  Note,
+  NoteExportFormat,
+  NoteFile,
+  NoteId,
+  NoteTag,
+  OutputNote,
+  OutputNoteRecord,
+  SyncSummary,
+  TransactionId,
+  TransactionProver,
+  TransactionRecord,
+  TransactionRequest,
+  TransactionSummary,
+  Word,
+} from "./crates/miden_client_web";
+
+// All simplified API types
+export * from "./api-types";

package/dist/index.d.ts

@@ -1,33 +1,19 @@
 // Re-export everything from the WASM module
 export * from "./crates/miden_client_web";
 
-// Import types we need for augmentation
+// Re-export all simplified API types
+export * from "./api-types";
+
+// Import types needed for the @internal class declarations below
 import type {
-  WebClient as WasmWebClient,
+  WebClient as WasmWebClientBase,
   SyncSummary,
-  TransactionProver,
 } from "./crates/miden_client_web";
-
-// Import the full namespace for the MidenArrayConstructors type
-import type * as WasmExports from "./crates/miden_client_web";
-
-// Export the WASM WebClient type alias for users who need to reference it explicitly
-export type { WebClient as WasmWebClient } from "./crates/miden_client_web";
-
-// Callback types for external keystore support
-export type GetKeyCallback = (
-  pubKey: Uint8Array
-) => Promise<Uint8Array | null | undefined> | Uint8Array | null | undefined;
-
-export type InsertKeyCallback = (
-  pubKey: Uint8Array,
-  secretKey: Uint8Array
-) => Promise<void> | void;
-
-export type SignCallback = (
-  pubKey: Uint8Array,
-  signingInputs: Uint8Array
-) => Promise<Uint8Array> | Uint8Array;
+import type {
+  GetKeyCallback,
+  InsertKeyCallback,
+  SignCallback,
+} from "./api-types";
 
 export type LogLevel =
   | "error"
@@ -47,45 +33,20 @@ export type LogLevel =
  */
 export declare function setupLogging(logLevel: LogLevel): void;
 
-type MidenArrayConstructors = {
-  [K in keyof typeof WasmExports as K extends `${string}Array`
-    ? K
-    : never]: (typeof WasmExports)[K];
-};
+// ════════════════════════════════════════════════════════════════
+// Internal exports (not public API — for tests and advanced usage)
+// ════════════════════════════════════════════════════════════════
 
-export declare const MidenArrays: MidenArrayConstructors;
-
-// WebClient wrapper class that uses a worker and forwards missing methods to WASM.
-export declare class WebClient extends WasmWebClient {
-  /**
-   * Factory method to create and initialize a new wrapped WebClient.
-   *
-   * @param rpcUrl - The RPC URL (optional).
-   * @param noteTransportUrl - The note transport URL (optional).
-   * @param seed - The seed for the account (optional).
-   * @param network - Optional name for the store. Setting this allows multiple clients to be used in the same browser.
-   * @returns A promise that resolves to a fully initialized WebClient.
-   */
+/** @internal Low-level WebClient wrapper. Use MidenClient instead. */
+export declare class WasmWebClient extends WasmWebClientBase {
   static createClient(
     rpcUrl?: string,
     noteTransportUrl?: string,
     seed?: Uint8Array,
-    network?: string,
+    storeName?: string,
     logLevel?: LogLevel
-  ): Promise<WebClient>;
+  ): Promise<WasmWebClient>;
 
-  /**
-   * Factory method to create and initialize a new wrapped WebClient with a remote keystore.
-   *
-   * @param rpcUrl - The RPC URL (optional).
-   * @param noteTransportUrl - The note transport URL (optional).
-   * @param seed - The seed for the account (optional).
-   * @param storeName - Optional name for the store. Setting this allows multiple clients to be used in the same browser.
-   * @param getKeyCb - Callback used to retrieve secret keys for a given public key.
-   * @param insertKeyCb - Callback used to persist secret keys in the external store.
-   * @param signCb - Callback used to create signatures for the provided inputs.
-   * @returns A promise that resolves to a fully initialized WebClient.
-   */
   static createClientWithExternalKeystore(
     rpcUrl?: string,
     noteTransportUrl?: string,
@@ -95,66 +56,23 @@ export declare class WebClient extends WasmWebClient {
     insertKeyCb?: InsertKeyCallback,
     signCb?: SignCallback,
     logLevel?: LogLevel
-  ): Promise<WebClient>;
+  ): Promise<WasmWebClient>;
 
-  /** Returns the default transaction prover configured on the client. */
-  defaultTransactionProver(): TransactionProver;
-
-  /**
-   * Syncs the client state with the Miden node.
-   *
-   * This method coordinates concurrent calls using the Web Locks API:
-   * - If a sync is already in progress, callers wait and receive the same result
-   * - Cross-tab coordination ensures only one sync runs at a time per database
-   *
-   * @returns A promise that resolves to a SyncSummary with the sync results.
-   */
   syncState(): Promise<SyncSummary>;
-
-  /**
-   * Syncs the client state with the Miden node with an optional timeout.
-   *
-   * This method coordinates concurrent calls using the Web Locks API:
-   * - If a sync is already in progress, callers wait and receive the same result
-   * - Cross-tab coordination ensures only one sync runs at a time per database
-   * - If a timeout is specified and exceeded, the method throws an error
-   *
-   * @param timeoutMs - Optional timeout in milliseconds. If 0 or not provided, waits indefinitely.
-   * @returns A promise that resolves to a SyncSummary with the sync results.
-   */
-  syncStateWithTimeout(timeoutMs?: number): Promise<SyncSummary>;
-
-  /**
-   * Terminates the underlying worker.
-   */
+  syncStateWithTimeout(timeoutMs: number): Promise<SyncSummary>;
   terminate(): void;
 }
 
-// MockWebClient class that extends the WebClient wrapper
-export declare class MockWebClient extends WebClient {
-  /**
-   * Factory method to create and initialize a new wrapped MockWebClient.
-   *
-   * @param serializedMockChain - Serialized mock chain (optional).
-   * @param serializedMockNoteTransportNode - Serialized mock note transport node (optional).
-   * @param seed - Seed for account initialization (optional).
-   * @returns A promise that resolves to a fully initialized MockWebClient.
-   */
+/** @internal Low-level MockWebClient wrapper. Use MidenClient.createMock() instead. */
+export declare class MockWasmWebClient extends WasmWebClient {
   static createClient(
-    serializedMockChain?: ArrayBuffer | Uint8Array,
-    serializedMockNoteTransportNode?: ArrayBuffer | Uint8Array,
+    serializedMockChain?: Uint8Array,
+    serializedMockNoteTransportNode?: Uint8Array,
     seed?: Uint8Array,
     logLevel?: LogLevel
-  ): Promise<MockWebClient>;
-
-  /** Syncs the mock state and returns the resulting summary. */
-  syncState(): Promise<SyncSummary>;
+  ): Promise<MockWasmWebClient>;
 
-  /**
-   * Syncs the client state with the Miden node with an optional timeout.
-   *
-   * @param timeoutMs - Optional timeout in milliseconds. If 0 or not provided, waits indefinitely.
-   * @returns A promise that resolves to a SyncSummary with the sync results.
-   */
-  syncStateWithTimeout(timeoutMs?: number): Promise<SyncSummary>;
+  proveBlock(): void;
+  serializeMockChain(): Uint8Array;
+  serializeMockNoteTransportNode(): Uint8Array;
 }