@worldcoin/idkit-core 4.0.13 → 4.0.15-dev.0587d15

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-export { RpSignature, signRequest } from '@worldcoin/idkit-server';
+export { RpSignature, SignRequestParams, signRequest } from '@worldcoin/idkit-server';
 export { hashSignal } from './hashing.cjs';
 
 /**
@@ -47,6 +47,8 @@ type IDKitRequestConfig = {
     action_description?: string;
     /** URL to a third-party bridge to use when connecting to the World App. Optional. */
     bridge_url?: string;
+    /** Optional deep-link callback URL appended as `return_to` on the connector URL. */
+    return_to?: string;
     /**
      * Whether to accept legacy (v3) World ID proofs as fallback.
      *
@@ -77,68 +79,17 @@ type IDKitSessionConfig = {
     action_description?: string;
     /** URL to a third-party bridge to use when connecting to the World App. Optional. */
     bridge_url?: string;
+    /** Optional deep-link callback URL appended as `return_to` on the connector URL. */
+    return_to?: string;
     /** Optional override for the connect base URL (e.g., for staging environments) */
     override_connect_base_url?: string;
     /** Optional environment override. Defaults to "production". */
     environment?: "production" | "staging";
 };
 
-interface OrbLegacyPreset {
-    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
-    type: "OrbLegacy";
-    signal?: string;
-}
-
-interface SecureDocumentLegacyPreset {
-    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
-    type: "SecureDocumentLegacy";
-    signal?: string;
-}
-
-interface DocumentLegacyPreset {
-    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
-    type: "DocumentLegacy";
-    signal?: string;
-}
-
-interface SelfieCheckLegacyPreset {
-    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
-    /** Preview: Selfie Check is currently in preview. Contact us if you need it enabled. */
-    type: "SelfieCheckLegacy";
-    signal?: string;
-}
-
-interface DeviceLegacyPreset {
-    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
-    type: "DeviceLegacy";
-    signal?: string;
-}
-
-type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset | DeviceLegacyPreset;
-
-
-
-type CredentialType = "orb" | "face" | "secure_document" | "document" | "device";
-
-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 ConstraintNode =
-    | CredentialRequestType
-    | { any: ConstraintNode[] }
-    | { all: ConstraintNode[] }
-    | { enumerate: ConstraintNode[] };
-
-
-
 /** V4 response item for World ID v4 uniqueness proofs */
 interface ResponseItemV4 {
-    /** Credential identifier (e.g., "orb", "face", "document") */
+    /** Credential identifier (e.g., "proof_of_human", "face", "passport", "mnc") */
     identifier: string;
     /** Signal hash (optional, included if signal was provided in request) */
     signal_hash?: string;
@@ -146,7 +97,7 @@ interface ResponseItemV4 {
     proof: string[];
     /** RP-scoped nullifier (hex) */
     nullifier: string;
-    /** Credential issuer schema ID (1=orb, 2=face, 3=secure_document, 4=document, 5=device) */
+    /** Credential issuer schema ID (1=proof_of_human, 11=face, 9303=passport, 9310=mnc) */
     issuer_schema_id: number;
     /** Minimum expiration timestamp (unix seconds) */
     expires_at_min: number;
@@ -154,7 +105,7 @@ interface ResponseItemV4 {
 
 /** V3 response item for World ID v3 (legacy format) */
 interface ResponseItemV3 {
-    /** Credential identifier (e.g., "orb", "face") */
+    /** Credential identifier (e.g., "proof_of_human", "face") */
     identifier: string;
     /** Signal hash (optional, included if signal was provided in request) */
     signal_hash?: string;
@@ -168,7 +119,7 @@ interface ResponseItemV3 {
 
 /** Session response item for World ID v4 session proofs */
 interface ResponseItemSession {
-    /** Credential identifier (e.g., "orb", "face", "document") */
+    /** Credential identifier (e.g., "proof_of_human", "face", "passport", "mnc") */
     identifier: string;
     /** Signal hash (optional, included if signal was provided in request) */
     signal_hash?: string;
@@ -176,7 +127,7 @@ interface ResponseItemSession {
     proof: string[];
     /** Session nullifier: 1st element is the session nullifier, 2nd is the generated action (hex strings) */
     session_nullifier: string[];
-    /** Credential issuer schema ID (1=orb, 2=face, 3=secure_document, 4=document, 5=device) */
+    /** Credential issuer schema ID (1=proof_of_human, 11=face, 9303=passport, 9310=mnc) */
     issuer_schema_id: number;
     /** Minimum expiration timestamp (unix seconds) */
     expires_at_min: number;
@@ -240,25 +191,78 @@ type IDKitResult = IDKitResultV3 | IDKitResultV4 | IDKitResultSession;
 
 /** Error codes from World App (mirrors Rust AppError) */
 type IDKitErrorCode =
-    | "user_rejected"
-    | "verification_rejected"
-    | "credential_unavailable"
-    | "malformed_request"
-    | "invalid_network"
-    | "inclusion_proof_pending"
-    | "inclusion_proof_failed"
-    | "unexpected_response"
-    | "connection_failed"
-    | "max_verifications_reached"
-    | "failed_by_host_app"
-    | "generic_error";
+| "user_rejected"
+| "verification_rejected"
+| "credential_unavailable"
+| "malformed_request"
+| "invalid_network"
+| "inclusion_proof_pending"
+| "inclusion_proof_failed"
+| "unexpected_response"
+| "connection_failed"
+| "max_verifications_reached"
+| "failed_by_host_app"
+| "generic_error";
 
 /** Status returned from pollForStatus() */
 type Status$1 =
-    | { type: "waiting_for_connection" }
-    | { type: "awaiting_confirmation" }
-    | { type: "confirmed"; result: IDKitResult }
-    | { type: "failed"; error: IDKitErrorCode };
+| { type: "waiting_for_connection" }
+| { type: "awaiting_confirmation" }
+| { type: "confirmed"; result: IDKitResult }
+| { type: "failed"; error: IDKitErrorCode };
+
+
+
+interface OrbLegacyPreset {
+    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
+    type: "OrbLegacy";
+    signal?: string;
+}
+
+interface SecureDocumentLegacyPreset {
+    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
+    type: "SecureDocumentLegacy";
+    signal?: string;
+}
+
+interface DocumentLegacyPreset {
+    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
+    type: "DocumentLegacy";
+    signal?: string;
+}
+
+interface SelfieCheckLegacyPreset {
+    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
+    /** Preview: Selfie Check is currently in preview. Contact us if you need it enabled. */
+    type: "SelfieCheckLegacy";
+    signal?: string;
+}
+
+interface DeviceLegacyPreset {
+    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
+    type: "DeviceLegacy";
+    signal?: string;
+}
+
+type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset | DeviceLegacyPreset;
+
+
+
+type CredentialType = "proof_of_human" | "face" | "passport" | "mnc";
+
+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 ConstraintNode =
+| CredentialRequestType
+| { any: ConstraintNode[] }
+| { all: ConstraintNode[] }
+| { enumerate: ConstraintNode[] };
 
 /**
  * Result types - re-exported from WASM bindings
@@ -288,6 +292,10 @@ declare enum IDKitErrorCodes {
     Cancelled = "cancelled"
 }
 
+/**
+ * Check if running inside World App
+ */
+declare function isInWorldApp(): boolean;
 interface BuilderConfig {
     type: "request" | "session" | "proveSession";
     app_id: string;
@@ -296,6 +304,7 @@ interface BuilderConfig {
     rp_context?: RpContext;
     action_description?: string;
     bridge_url?: string;
+    return_to?: string;
     allow_legacy_proofs?: boolean;
     override_connect_base_url?: string;
     environment?: string;
@@ -310,7 +319,7 @@ interface BuilderConfig {
 interface WaitOptions {
     /** Milliseconds between polls (default: 1000) */
     pollInterval?: number;
-    /** Total timeout in milliseconds (default: 300000 = 5 minutes) */
+    /** Total timeout in milliseconds (default: 900000 = 15 minutes) */
     timeout?: number;
     /** AbortSignal for cancellation */
     signal?: AbortSignal;
@@ -453,7 +462,7 @@ declare class IDKitBuilder {
      * @example
      * ```typescript
      * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: false })
-     *   .constraints(any(CredentialRequest('orb'), CredentialRequest('face')));
+     *   .constraints(any(CredentialRequest('proof_of_human'), CredentialRequest('face')));
      * ```
      */
     constraints(constraints: ConstraintNode): Promise<IDKitRequest>;
@@ -502,7 +511,7 @@ declare class IDKitBuilder {
  *   action: 'my-action',
  *   rp_context: { ... },
  *   allow_legacy_proofs: false,
- * }).constraints(enumerate(CredentialRequest('orb'), CredentialRequest('face')));
+ * }).constraints(enumerate(CredentialRequest('proof_of_human'), CredentialRequest('face')));
  *
  * // In World App: connectorURI is empty, result comes via postMessage
  * // On web: connectorURI is the QR URL to display
@@ -571,4 +580,4 @@ declare const isWeb: () => boolean;
  */
 declare const isNode: () => boolean;
 
-export { type AbiEncodedValue, type ConstraintNode, type CredentialRequestType, type CredentialType, type DeviceLegacyPreset, type DocumentLegacyPreset, IDKit, type IDKitCompletionResult, type IDKitErrorCode, IDKitErrorCodes, type IDKitRequest, type IDKitRequestConfig, type IDKitResult, type IDKitResultSession, type IDKitSessionConfig, type OrbLegacyPreset, type Preset, type ResponseItemSession, type ResponseItemV3, type ResponseItemV4, type RpContext, type SecureDocumentLegacyPreset, type SelfieCheckLegacyPreset, type Status$1 as Status, type WaitOptions, deviceLegacy, documentLegacy, isNode, isReactNative, isWeb, orbLegacy, secureDocumentLegacy, selfieCheckLegacy };
+export { type AbiEncodedValue, type ConstraintNode, type CredentialRequestType, type CredentialType, type DeviceLegacyPreset, type DocumentLegacyPreset, IDKit, type IDKitCompletionResult, type IDKitErrorCode, IDKitErrorCodes, type IDKitRequest, type IDKitRequestConfig, type IDKitResult, type IDKitResultSession, type IDKitSessionConfig, type OrbLegacyPreset, type Preset, type ResponseItemSession, type ResponseItemV3, type ResponseItemV4, type RpContext, type SecureDocumentLegacyPreset, type SelfieCheckLegacyPreset, type Status$1 as Status, type WaitOptions, deviceLegacy, documentLegacy, isInWorldApp, isNode, isReactNative, isWeb, orbLegacy, secureDocumentLegacy, selfieCheckLegacy };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { RpSignature, signRequest } from '@worldcoin/idkit-server';
+export { RpSignature, SignRequestParams, signRequest } from '@worldcoin/idkit-server';
 export { hashSignal } from './hashing.js';
 
 /**
@@ -47,6 +47,8 @@ type IDKitRequestConfig = {
     action_description?: string;
     /** URL to a third-party bridge to use when connecting to the World App. Optional. */
     bridge_url?: string;
+    /** Optional deep-link callback URL appended as `return_to` on the connector URL. */
+    return_to?: string;
     /**
      * Whether to accept legacy (v3) World ID proofs as fallback.
      *
@@ -77,68 +79,17 @@ type IDKitSessionConfig = {
     action_description?: string;
     /** URL to a third-party bridge to use when connecting to the World App. Optional. */
     bridge_url?: string;
+    /** Optional deep-link callback URL appended as `return_to` on the connector URL. */
+    return_to?: string;
     /** Optional override for the connect base URL (e.g., for staging environments) */
     override_connect_base_url?: string;
     /** Optional environment override. Defaults to "production". */
     environment?: "production" | "staging";
 };
 
-interface OrbLegacyPreset {
-    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
-    type: "OrbLegacy";
-    signal?: string;
-}
-
-interface SecureDocumentLegacyPreset {
-    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
-    type: "SecureDocumentLegacy";
-    signal?: string;
-}
-
-interface DocumentLegacyPreset {
-    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
-    type: "DocumentLegacy";
-    signal?: string;
-}
-
-interface SelfieCheckLegacyPreset {
-    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
-    /** Preview: Selfie Check is currently in preview. Contact us if you need it enabled. */
-    type: "SelfieCheckLegacy";
-    signal?: string;
-}
-
-interface DeviceLegacyPreset {
-    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
-    type: "DeviceLegacy";
-    signal?: string;
-}
-
-type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset | DeviceLegacyPreset;
-
-
-
-type CredentialType = "orb" | "face" | "secure_document" | "document" | "device";
-
-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 ConstraintNode =
-    | CredentialRequestType
-    | { any: ConstraintNode[] }
-    | { all: ConstraintNode[] }
-    | { enumerate: ConstraintNode[] };
-
-
-
 /** V4 response item for World ID v4 uniqueness proofs */
 interface ResponseItemV4 {
-    /** Credential identifier (e.g., "orb", "face", "document") */
+    /** Credential identifier (e.g., "proof_of_human", "face", "passport", "mnc") */
     identifier: string;
     /** Signal hash (optional, included if signal was provided in request) */
     signal_hash?: string;
@@ -146,7 +97,7 @@ interface ResponseItemV4 {
     proof: string[];
     /** RP-scoped nullifier (hex) */
     nullifier: string;
-    /** Credential issuer schema ID (1=orb, 2=face, 3=secure_document, 4=document, 5=device) */
+    /** Credential issuer schema ID (1=proof_of_human, 11=face, 9303=passport, 9310=mnc) */
     issuer_schema_id: number;
     /** Minimum expiration timestamp (unix seconds) */
     expires_at_min: number;
@@ -154,7 +105,7 @@ interface ResponseItemV4 {
 
 /** V3 response item for World ID v3 (legacy format) */
 interface ResponseItemV3 {
-    /** Credential identifier (e.g., "orb", "face") */
+    /** Credential identifier (e.g., "proof_of_human", "face") */
     identifier: string;
     /** Signal hash (optional, included if signal was provided in request) */
     signal_hash?: string;
@@ -168,7 +119,7 @@ interface ResponseItemV3 {
 
 /** Session response item for World ID v4 session proofs */
 interface ResponseItemSession {
-    /** Credential identifier (e.g., "orb", "face", "document") */
+    /** Credential identifier (e.g., "proof_of_human", "face", "passport", "mnc") */
     identifier: string;
     /** Signal hash (optional, included if signal was provided in request) */
     signal_hash?: string;
@@ -176,7 +127,7 @@ interface ResponseItemSession {
     proof: string[];
     /** Session nullifier: 1st element is the session nullifier, 2nd is the generated action (hex strings) */
     session_nullifier: string[];
-    /** Credential issuer schema ID (1=orb, 2=face, 3=secure_document, 4=document, 5=device) */
+    /** Credential issuer schema ID (1=proof_of_human, 11=face, 9303=passport, 9310=mnc) */
     issuer_schema_id: number;
     /** Minimum expiration timestamp (unix seconds) */
     expires_at_min: number;
@@ -240,25 +191,78 @@ type IDKitResult = IDKitResultV3 | IDKitResultV4 | IDKitResultSession;
 
 /** Error codes from World App (mirrors Rust AppError) */
 type IDKitErrorCode =
-    | "user_rejected"
-    | "verification_rejected"
-    | "credential_unavailable"
-    | "malformed_request"
-    | "invalid_network"
-    | "inclusion_proof_pending"
-    | "inclusion_proof_failed"
-    | "unexpected_response"
-    | "connection_failed"
-    | "max_verifications_reached"
-    | "failed_by_host_app"
-    | "generic_error";
+| "user_rejected"
+| "verification_rejected"
+| "credential_unavailable"
+| "malformed_request"
+| "invalid_network"
+| "inclusion_proof_pending"
+| "inclusion_proof_failed"
+| "unexpected_response"
+| "connection_failed"
+| "max_verifications_reached"
+| "failed_by_host_app"
+| "generic_error";
 
 /** Status returned from pollForStatus() */
 type Status$1 =
-    | { type: "waiting_for_connection" }
-    | { type: "awaiting_confirmation" }
-    | { type: "confirmed"; result: IDKitResult }
-    | { type: "failed"; error: IDKitErrorCode };
+| { type: "waiting_for_connection" }
+| { type: "awaiting_confirmation" }
+| { type: "confirmed"; result: IDKitResult }
+| { type: "failed"; error: IDKitErrorCode };
+
+
+
+interface OrbLegacyPreset {
+    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
+    type: "OrbLegacy";
+    signal?: string;
+}
+
+interface SecureDocumentLegacyPreset {
+    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
+    type: "SecureDocumentLegacy";
+    signal?: string;
+}
+
+interface DocumentLegacyPreset {
+    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
+    type: "DocumentLegacy";
+    signal?: string;
+}
+
+interface SelfieCheckLegacyPreset {
+    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
+    /** Preview: Selfie Check is currently in preview. Contact us if you need it enabled. */
+    type: "SelfieCheckLegacy";
+    signal?: string;
+}
+
+interface DeviceLegacyPreset {
+    /** This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions. */
+    type: "DeviceLegacy";
+    signal?: string;
+}
+
+type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset | DeviceLegacyPreset;
+
+
+
+type CredentialType = "proof_of_human" | "face" | "passport" | "mnc";
+
+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 ConstraintNode =
+| CredentialRequestType
+| { any: ConstraintNode[] }
+| { all: ConstraintNode[] }
+| { enumerate: ConstraintNode[] };
 
 /**
  * Result types - re-exported from WASM bindings
@@ -288,6 +292,10 @@ declare enum IDKitErrorCodes {
     Cancelled = "cancelled"
 }
 
+/**
+ * Check if running inside World App
+ */
+declare function isInWorldApp(): boolean;
 interface BuilderConfig {
     type: "request" | "session" | "proveSession";
     app_id: string;
@@ -296,6 +304,7 @@ interface BuilderConfig {
     rp_context?: RpContext;
     action_description?: string;
     bridge_url?: string;
+    return_to?: string;
     allow_legacy_proofs?: boolean;
     override_connect_base_url?: string;
     environment?: string;
@@ -310,7 +319,7 @@ interface BuilderConfig {
 interface WaitOptions {
     /** Milliseconds between polls (default: 1000) */
     pollInterval?: number;
-    /** Total timeout in milliseconds (default: 300000 = 5 minutes) */
+    /** Total timeout in milliseconds (default: 900000 = 15 minutes) */
     timeout?: number;
     /** AbortSignal for cancellation */
     signal?: AbortSignal;
@@ -453,7 +462,7 @@ declare class IDKitBuilder {
      * @example
      * ```typescript
      * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: false })
-     *   .constraints(any(CredentialRequest('orb'), CredentialRequest('face')));
+     *   .constraints(any(CredentialRequest('proof_of_human'), CredentialRequest('face')));
      * ```
      */
     constraints(constraints: ConstraintNode): Promise<IDKitRequest>;
@@ -502,7 +511,7 @@ declare class IDKitBuilder {
  *   action: 'my-action',
  *   rp_context: { ... },
  *   allow_legacy_proofs: false,
- * }).constraints(enumerate(CredentialRequest('orb'), CredentialRequest('face')));
+ * }).constraints(enumerate(CredentialRequest('proof_of_human'), CredentialRequest('face')));
  *
  * // In World App: connectorURI is empty, result comes via postMessage
  * // On web: connectorURI is the QR URL to display
@@ -571,4 +580,4 @@ declare const isWeb: () => boolean;
  */
 declare const isNode: () => boolean;
 
-export { type AbiEncodedValue, type ConstraintNode, type CredentialRequestType, type CredentialType, type DeviceLegacyPreset, type DocumentLegacyPreset, IDKit, type IDKitCompletionResult, type IDKitErrorCode, IDKitErrorCodes, type IDKitRequest, type IDKitRequestConfig, type IDKitResult, type IDKitResultSession, type IDKitSessionConfig, type OrbLegacyPreset, type Preset, type ResponseItemSession, type ResponseItemV3, type ResponseItemV4, type RpContext, type SecureDocumentLegacyPreset, type SelfieCheckLegacyPreset, type Status$1 as Status, type WaitOptions, deviceLegacy, documentLegacy, isNode, isReactNative, isWeb, orbLegacy, secureDocumentLegacy, selfieCheckLegacy };
+export { type AbiEncodedValue, type ConstraintNode, type CredentialRequestType, type CredentialType, type DeviceLegacyPreset, type DocumentLegacyPreset, IDKit, type IDKitCompletionResult, type IDKitErrorCode, IDKitErrorCodes, type IDKitRequest, type IDKitRequestConfig, type IDKitResult, type IDKitResultSession, type IDKitSessionConfig, type OrbLegacyPreset, type Preset, type ResponseItemSession, type ResponseItemV3, type ResponseItemV4, type RpContext, type SecureDocumentLegacyPreset, type SelfieCheckLegacyPreset, type Status$1 as Status, type WaitOptions, deviceLegacy, documentLegacy, isInWorldApp, isNode, isReactNative, isWeb, orbLegacy, secureDocumentLegacy, selfieCheckLegacy };