@worldcoin/idkit-core 4.0.0-dev.777cdbe → 4.0.1-dev.8abccc4

package/dist/index.d.cts

@@ -80,20 +80,22 @@ type IDKitSessionConfig = {
     environment?: "production" | "staging";
 };
 
-type CredentialType = "orb" | "face" | "secure_document" | "document" | "device";
+interface OrbLegacyPreset {
+    type: "OrbLegacy";
+    signal?: string;
+}
 
-interface CredentialRequestType {
-    type: CredentialType;
-    /** Signal can be a string or raw bytes (Uint8Array) */
-    signal?: string | Uint8Array;
-    genesis_issued_at_min?: number;
-    expires_at_min?: number;
+interface SecureDocumentLegacyPreset {
+    type: "SecureDocumentLegacy";
+    signal?: string;
 }
 
-type ConstraintNode =
-    | CredentialRequestType
-    | { any: ConstraintNode[] }
-    | { all: ConstraintNode[] };
+interface DocumentLegacyPreset {
+    type: "DocumentLegacy";
+    signal?: string;
+}
+
+type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset;
 
 
 
@@ -223,73 +225,20 @@ type Status$1 =
 
 
 
-interface OrbLegacyPreset {
-    type: "OrbLegacy";
-    signal?: string;
-}
-
-interface SecureDocumentLegacyPreset {
-    type: "SecureDocumentLegacy";
-    signal?: string;
-}
+type CredentialType = "orb" | "face" | "secure_document" | "document" | "device";
 
-interface DocumentLegacyPreset {
-    type: "DocumentLegacy";
-    signal?: string;
+interface CredentialRequestType {
+    type: CredentialType;
+    /** Signal can be a string or raw bytes (Uint8Array) */
+    signal?: string | Uint8Array;
+    genesis_issued_at_min?: number;
+    expires_at_min?: number;
 }
 
-type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset;
-/**
- * Unified builder for creating `IDKit` requests and sessions (WASM)
- */
-declare class IDKitBuilder$1 {
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Creates a `BridgeConnection` with the given constraints
-   */
-  constraints(constraints_json: any): Promise<any>;
-  /**
-   * Creates a new builder for proving an existing session
-   */
-  static forProveSession(session_id: string, app_id: string, rp_context: RpContextWasm, action_description?: string | null, bridge_url?: string | null, override_connect_base_url?: string | null, environment?: string | null): IDKitBuilder$1;
-  /**
-   * Creates a new builder for creating a new session
-   */
-  static forCreateSession(app_id: string, rp_context: RpContextWasm, action_description?: string | null, bridge_url?: string | null, override_connect_base_url?: string | null, environment?: string | null): IDKitBuilder$1;
-  /**
-   * Creates a new builder for uniqueness requests
-   */
-  constructor(app_id: string, action: string, rp_context: RpContextWasm, action_description: string | null | undefined, bridge_url: string | null | undefined, allow_legacy_proofs: boolean, override_connect_base_url?: string | null, environment?: string | null);
-  /**
-   * Creates a `BridgeConnection` from a preset (works for all request types)
-   */
-  preset(preset_json: any): Promise<any>;
-}
-/**
- * RP Context for protocol-level proof requests (WASM binding)
- *
- * Contains RP-specific data needed to construct a `ProofRequest`.
- */
-declare class RpContextWasm {
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Creates a new RP context
-   *
-   * # Arguments
-   * * `rp_id` - The registered RP ID (e.g., `"rp_123456789abcdef0"`)
-   * * `nonce` - Unique nonce for this proof request
-   * * `created_at` - Unix timestamp (seconds since epoch) when created
-   * * `expires_at` - Unix timestamp (seconds since epoch) when expires
-   * * `signature` - The RP's ECDSA signature of the `nonce` and `created_at` timestamp
-   *
-   * # Errors
-   *
-   * Returns an error if `rp_id` is not a valid RP ID (must start with `rp_`)
-   */
-  constructor(rp_id: string, nonce: string, created_at: bigint, expires_at: bigint, signature: string);
-}
+type ConstraintNode =
+    | CredentialRequestType
+    | { any: ConstraintNode[] }
+    | { all: ConstraintNode[] };
 
 
 
@@ -377,6 +326,19 @@ declare enum IDKitErrorCodes {
     Cancelled = "cancelled"
 }
 
+interface BuilderConfig {
+    type: "request" | "session" | "proveSession";
+    app_id: string;
+    action?: string;
+    session_id?: string;
+    rp_context?: RpContext;
+    action_description?: string;
+    bridge_url?: string;
+    allow_legacy_proofs?: boolean;
+    override_connect_base_url?: string;
+    environment?: string;
+}
+
 /**
  * IDKit Request
  * Pure functional API for World ID verification - no dependencies
@@ -482,7 +444,7 @@ declare function all(...nodes: ConstraintNode[]): {
  *
  * @example
  * ```typescript
- * const request = await IDKit.request({ app_id, action, rp_context })
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
  *   .preset(orbLegacy({ signal: 'user-123' }))
  * ```
  */
@@ -500,7 +462,7 @@ declare function orbLegacy(opts?: {
  *
  * @example
  * ```typescript
- * const request = await IDKit.request({ app_id, action, rp_context })
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
  *   .preset(secureDocumentLegacy({ signal: 'user-123' }))
  * ```
  */
@@ -518,7 +480,7 @@ declare function secureDocumentLegacy(opts?: {
  *
  * @example
  * ```typescript
- * const request = await IDKit.request({ app_id, action, rp_context })
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
  *   .preset(documentLegacy({ signal: 'user-123' }))
  * ```
  */
@@ -526,11 +488,15 @@ declare function documentLegacy(opts?: {
     signal?: string;
 }): DocumentLegacyPreset;
 /**
- * Merged builder for IDKit requests
+ * Builder for IDKit requests
+ *
+ * Stores configuration and defers transport selection to `.preset()` / `.constraints()`.
+ * In World App: uses native postMessage transport (no WASM needed).
+ * On web: uses WASM bridge transport (QR code + polling).
  */
 declare class IDKitBuilder {
-    private wasmBuilder;
-    constructor(wasmBuilder: IDKitBuilder$1);
+    private config;
+    constructor(config: BuilderConfig);
     /**
      * Creates an IDKit request with the given constraints
      *
@@ -539,67 +505,64 @@ declare class IDKitBuilder {
      *
      * @example
      * ```typescript
-     * const builder = await IDKit.request({ app_id, action, rp_context });
-     * const request = await builder.constraints(any(CredentialRequest('orb'), CredentialRequest('face')));
+     * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: false })
+     *   .constraints(any(CredentialRequest('orb'), CredentialRequest('face')));
      * ```
      */
+    constraints(constraints: ConstraintNode): Promise<IDKitRequest>;
     /**
      * Creates an IDKit request from a preset (works for all request types)
      *
      * Presets provide a simplified way to create requests with predefined
      * credential configurations.
      *
-     * @param preset - A preset object from orbLegacy()
+     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), or documentLegacy()
      * @returns A new IDKitRequest instance
      *
      * @example
      * ```typescript
-     * const builder = await IDKit.request({ app_id, action, rp_context });
-     * const request = await builder.preset(orbLegacy({ signal: 'user-123' }));
+     * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
+     *   .preset(orbLegacy({ signal: 'user-123' }));
      * ```
      */
     preset(preset: Preset): Promise<IDKitRequest>;
 }
 /**
- * Creates an IDKit request builder
+ * Creates an IDKit verification request builder
  *
  * This is the main entry point for creating World ID verification requests.
- * Use the builder pattern with constraints to specify which credentials to accept.
+ * Use the builder pattern with `.preset()` or `.constraints()` to specify
+ * which credentials to accept.
  *
  * @param config - Request configuration
  * @returns IDKitBuilder - A builder instance
  *
  * @example
  * ```typescript
- * import { IDKit, CredentialRequest, any } from '@worldcoin/idkit-core'
- *
- * // Initialize WASM (only needed once)
- * await IDKit.init()
+ * import { IDKit, CredentialRequest, any, orbLegacy } from '@worldcoin/idkit-core'
  *
- * // Create request items
- * const orb = CredentialRequest('orb', { signal: 'user-123' })
- * const face = CredentialRequest('face')
+ * // With preset (legacy support)
+ * const request = await IDKit.request({
+ *   app_id: 'app_staging_xxxxx',
+ *   action: 'my-action',
+ *   rp_context: { ... },
+ *   allow_legacy_proofs: true,
+ * }).preset(orbLegacy({ signal: 'user-123' }));
  *
- * // Create a verification request with constraints
+ * // With constraints (v4 only)
  * const request = await IDKit.request({
  *   app_id: 'app_staging_xxxxx',
  *   action: 'my-action',
- *   rp_context: {
- *     rp_id: 'rp_123456789abcdef0',
- *     nonce: 'unique-nonce',
- *     created_at: Math.floor(Date.now() / 1000),
- *     expires_at: Math.floor(Date.now() / 1000) + 3600,
- *     signature: 'ecdsa-signature-from-backend',
- *   },
+ *   rp_context: { ... },
  *   allow_legacy_proofs: false,
- * }).constraints(any(orb, face));
+ * }).constraints(any(CredentialRequest('orb'), CredentialRequest('face')));
  *
- * // Display QR code
- * console.log('Scan this:', request.connectorURI)
+ * // In World App: connectorURI is empty, result comes via postMessage
+ * // On web: connectorURI is the QR URL to display
+ * console.log(request.connectorURI);
  *
- * // Wait for proof
- * const proof = await request.pollUntilCompletion()
- * console.log('Success:', proof)
+ * // Wait for result — same interface in both environments
+ * const proof = await request.pollUntilCompletion();
  * ```
  */
 declare function createRequest(config: IDKitRequestConfig): IDKitBuilder;
@@ -661,25 +624,24 @@ declare function proveSession(sessionId: string, config: IDKitSessionConfig): ID
  *
  * @example
  * ```typescript
- * import { IDKit, CredentialRequest, any } from '@worldcoin/idkit-core'
- *
- * // Initialize (only needed once)
- * await IDKit.init()
+ * import { IDKit, CredentialRequest, any, orbLegacy } from '@worldcoin/idkit-core'
  *
- * // Create a request
+ * // Create a verification request
  * const request = await IDKit.request({
  *   app_id: 'app_staging_xxxxx',
  *   action: 'my-action',
  *   rp_context: { ... },
- * }).constraints(any(CredentialRequest('orb'), CredentialRequest('face')))
+ *   allow_legacy_proofs: true,
+ * }).preset(orbLegacy({ signal: 'user-123' }))
  *
- * // Display QR and wait for proof
+ * // In World App: result comes via postMessage (no QR needed)
+ * // On web: display QR code and wait for proof
  * console.log(request.connectorURI)
  * const proof = await request.pollUntilCompletion()
  * ```
  */
 declare const IDKit: {
-    /** Initialize WASM for browser environments */
+    /** Initialize WASM for browser environments (not needed in World App) */
     init: typeof initIDKit;
     /** Initialize WASM for Node.js/server environments */
     initServer: typeof initIDKitServer;

package/dist/index.d.ts

@@ -80,20 +80,22 @@ type IDKitSessionConfig = {
     environment?: "production" | "staging";
 };
 
-type CredentialType = "orb" | "face" | "secure_document" | "document" | "device";
+interface OrbLegacyPreset {
+    type: "OrbLegacy";
+    signal?: string;
+}
 
-interface CredentialRequestType {
-    type: CredentialType;
-    /** Signal can be a string or raw bytes (Uint8Array) */
-    signal?: string | Uint8Array;
-    genesis_issued_at_min?: number;
-    expires_at_min?: number;
+interface SecureDocumentLegacyPreset {
+    type: "SecureDocumentLegacy";
+    signal?: string;
 }
 
-type ConstraintNode =
-    | CredentialRequestType
-    | { any: ConstraintNode[] }
-    | { all: ConstraintNode[] };
+interface DocumentLegacyPreset {
+    type: "DocumentLegacy";
+    signal?: string;
+}
+
+type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset;
 
 
 
@@ -223,73 +225,20 @@ type Status$1 =
 
 
 
-interface OrbLegacyPreset {
-    type: "OrbLegacy";
-    signal?: string;
-}
-
-interface SecureDocumentLegacyPreset {
-    type: "SecureDocumentLegacy";
-    signal?: string;
-}
+type CredentialType = "orb" | "face" | "secure_document" | "document" | "device";
 
-interface DocumentLegacyPreset {
-    type: "DocumentLegacy";
-    signal?: string;
+interface CredentialRequestType {
+    type: CredentialType;
+    /** Signal can be a string or raw bytes (Uint8Array) */
+    signal?: string | Uint8Array;
+    genesis_issued_at_min?: number;
+    expires_at_min?: number;
 }
 
-type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset;
-/**
- * Unified builder for creating `IDKit` requests and sessions (WASM)
- */
-declare class IDKitBuilder$1 {
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Creates a `BridgeConnection` with the given constraints
-   */
-  constraints(constraints_json: any): Promise<any>;
-  /**
-   * Creates a new builder for proving an existing session
-   */
-  static forProveSession(session_id: string, app_id: string, rp_context: RpContextWasm, action_description?: string | null, bridge_url?: string | null, override_connect_base_url?: string | null, environment?: string | null): IDKitBuilder$1;
-  /**
-   * Creates a new builder for creating a new session
-   */
-  static forCreateSession(app_id: string, rp_context: RpContextWasm, action_description?: string | null, bridge_url?: string | null, override_connect_base_url?: string | null, environment?: string | null): IDKitBuilder$1;
-  /**
-   * Creates a new builder for uniqueness requests
-   */
-  constructor(app_id: string, action: string, rp_context: RpContextWasm, action_description: string | null | undefined, bridge_url: string | null | undefined, allow_legacy_proofs: boolean, override_connect_base_url?: string | null, environment?: string | null);
-  /**
-   * Creates a `BridgeConnection` from a preset (works for all request types)
-   */
-  preset(preset_json: any): Promise<any>;
-}
-/**
- * RP Context for protocol-level proof requests (WASM binding)
- *
- * Contains RP-specific data needed to construct a `ProofRequest`.
- */
-declare class RpContextWasm {
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Creates a new RP context
-   *
-   * # Arguments
-   * * `rp_id` - The registered RP ID (e.g., `"rp_123456789abcdef0"`)
-   * * `nonce` - Unique nonce for this proof request
-   * * `created_at` - Unix timestamp (seconds since epoch) when created
-   * * `expires_at` - Unix timestamp (seconds since epoch) when expires
-   * * `signature` - The RP's ECDSA signature of the `nonce` and `created_at` timestamp
-   *
-   * # Errors
-   *
-   * Returns an error if `rp_id` is not a valid RP ID (must start with `rp_`)
-   */
-  constructor(rp_id: string, nonce: string, created_at: bigint, expires_at: bigint, signature: string);
-}
+type ConstraintNode =
+    | CredentialRequestType
+    | { any: ConstraintNode[] }
+    | { all: ConstraintNode[] };
 
 
 
@@ -377,6 +326,19 @@ declare enum IDKitErrorCodes {
     Cancelled = "cancelled"
 }
 
+interface BuilderConfig {
+    type: "request" | "session" | "proveSession";
+    app_id: string;
+    action?: string;
+    session_id?: string;
+    rp_context?: RpContext;
+    action_description?: string;
+    bridge_url?: string;
+    allow_legacy_proofs?: boolean;
+    override_connect_base_url?: string;
+    environment?: string;
+}
+
 /**
  * IDKit Request
  * Pure functional API for World ID verification - no dependencies
@@ -482,7 +444,7 @@ declare function all(...nodes: ConstraintNode[]): {
  *
  * @example
  * ```typescript
- * const request = await IDKit.request({ app_id, action, rp_context })
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
  *   .preset(orbLegacy({ signal: 'user-123' }))
  * ```
  */
@@ -500,7 +462,7 @@ declare function orbLegacy(opts?: {
  *
  * @example
  * ```typescript
- * const request = await IDKit.request({ app_id, action, rp_context })
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
  *   .preset(secureDocumentLegacy({ signal: 'user-123' }))
  * ```
  */
@@ -518,7 +480,7 @@ declare function secureDocumentLegacy(opts?: {
  *
  * @example
  * ```typescript
- * const request = await IDKit.request({ app_id, action, rp_context })
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
  *   .preset(documentLegacy({ signal: 'user-123' }))
  * ```
  */
@@ -526,11 +488,15 @@ declare function documentLegacy(opts?: {
     signal?: string;
 }): DocumentLegacyPreset;
 /**
- * Merged builder for IDKit requests
+ * Builder for IDKit requests
+ *
+ * Stores configuration and defers transport selection to `.preset()` / `.constraints()`.
+ * In World App: uses native postMessage transport (no WASM needed).
+ * On web: uses WASM bridge transport (QR code + polling).
  */
 declare class IDKitBuilder {
-    private wasmBuilder;
-    constructor(wasmBuilder: IDKitBuilder$1);
+    private config;
+    constructor(config: BuilderConfig);
     /**
      * Creates an IDKit request with the given constraints
      *
@@ -539,67 +505,64 @@ declare class IDKitBuilder {
      *
      * @example
      * ```typescript
-     * const builder = await IDKit.request({ app_id, action, rp_context });
-     * const request = await builder.constraints(any(CredentialRequest('orb'), CredentialRequest('face')));
+     * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: false })
+     *   .constraints(any(CredentialRequest('orb'), CredentialRequest('face')));
      * ```
      */
+    constraints(constraints: ConstraintNode): Promise<IDKitRequest>;
     /**
      * Creates an IDKit request from a preset (works for all request types)
      *
      * Presets provide a simplified way to create requests with predefined
      * credential configurations.
      *
-     * @param preset - A preset object from orbLegacy()
+     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), or documentLegacy()
      * @returns A new IDKitRequest instance
      *
      * @example
      * ```typescript
-     * const builder = await IDKit.request({ app_id, action, rp_context });
-     * const request = await builder.preset(orbLegacy({ signal: 'user-123' }));
+     * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
+     *   .preset(orbLegacy({ signal: 'user-123' }));
      * ```
      */
     preset(preset: Preset): Promise<IDKitRequest>;
 }
 /**
- * Creates an IDKit request builder
+ * Creates an IDKit verification request builder
  *
  * This is the main entry point for creating World ID verification requests.
- * Use the builder pattern with constraints to specify which credentials to accept.
+ * Use the builder pattern with `.preset()` or `.constraints()` to specify
+ * which credentials to accept.
  *
  * @param config - Request configuration
  * @returns IDKitBuilder - A builder instance
  *
  * @example
  * ```typescript
- * import { IDKit, CredentialRequest, any } from '@worldcoin/idkit-core'
- *
- * // Initialize WASM (only needed once)
- * await IDKit.init()
+ * import { IDKit, CredentialRequest, any, orbLegacy } from '@worldcoin/idkit-core'
  *
- * // Create request items
- * const orb = CredentialRequest('orb', { signal: 'user-123' })
- * const face = CredentialRequest('face')
+ * // With preset (legacy support)
+ * const request = await IDKit.request({
+ *   app_id: 'app_staging_xxxxx',
+ *   action: 'my-action',
+ *   rp_context: { ... },
+ *   allow_legacy_proofs: true,
+ * }).preset(orbLegacy({ signal: 'user-123' }));
  *
- * // Create a verification request with constraints
+ * // With constraints (v4 only)
  * const request = await IDKit.request({
  *   app_id: 'app_staging_xxxxx',
  *   action: 'my-action',
- *   rp_context: {
- *     rp_id: 'rp_123456789abcdef0',
- *     nonce: 'unique-nonce',
- *     created_at: Math.floor(Date.now() / 1000),
- *     expires_at: Math.floor(Date.now() / 1000) + 3600,
- *     signature: 'ecdsa-signature-from-backend',
- *   },
+ *   rp_context: { ... },
  *   allow_legacy_proofs: false,
- * }).constraints(any(orb, face));
+ * }).constraints(any(CredentialRequest('orb'), CredentialRequest('face')));
  *
- * // Display QR code
- * console.log('Scan this:', request.connectorURI)
+ * // In World App: connectorURI is empty, result comes via postMessage
+ * // On web: connectorURI is the QR URL to display
+ * console.log(request.connectorURI);
  *
- * // Wait for proof
- * const proof = await request.pollUntilCompletion()
- * console.log('Success:', proof)
+ * // Wait for result — same interface in both environments
+ * const proof = await request.pollUntilCompletion();
  * ```
  */
 declare function createRequest(config: IDKitRequestConfig): IDKitBuilder;
@@ -661,25 +624,24 @@ declare function proveSession(sessionId: string, config: IDKitSessionConfig): ID
  *
  * @example
  * ```typescript
- * import { IDKit, CredentialRequest, any } from '@worldcoin/idkit-core'
- *
- * // Initialize (only needed once)
- * await IDKit.init()
+ * import { IDKit, CredentialRequest, any, orbLegacy } from '@worldcoin/idkit-core'
  *
- * // Create a request
+ * // Create a verification request
  * const request = await IDKit.request({
  *   app_id: 'app_staging_xxxxx',
  *   action: 'my-action',
  *   rp_context: { ... },
- * }).constraints(any(CredentialRequest('orb'), CredentialRequest('face')))
+ *   allow_legacy_proofs: true,
+ * }).preset(orbLegacy({ signal: 'user-123' }))
  *
- * // Display QR and wait for proof
+ * // In World App: result comes via postMessage (no QR needed)
+ * // On web: display QR code and wait for proof
  * console.log(request.connectorURI)
  * const proof = await request.pollUntilCompletion()
  * ```
  */
 declare const IDKit: {
-    /** Initialize WASM for browser environments */
+    /** Initialize WASM for browser environments (not needed in World App) */
     init: typeof initIDKit;
     /** Initialize WASM for Node.js/server environments */
     initServer: typeof initIDKitServer;