@worldcoin/idkit-core 4.0.10 → 4.0.13-dev.cd5a8f0

package/dist/index.d.cts

@@ -85,7 +85,7 @@ type IDKitSessionConfig = {
 
 /** 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;
@@ -93,7 +93,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;
@@ -101,7 +101,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;
@@ -115,7 +115,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;
@@ -123,7 +123,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;
@@ -187,43 +187,25 @@ 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 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[] };
+| { type: "waiting_for_connection" }
+| { type: "awaiting_confirmation" }
+| { type: "confirmed"; result: IDKitResult }
+| { type: "failed"; error: IDKitErrorCode };
 
 
 
@@ -252,7 +234,31 @@ interface SelfieCheckLegacyPreset {
     signal?: string;
 }
 
-type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset;
+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
@@ -282,6 +288,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;
@@ -391,6 +401,23 @@ declare function secureDocumentLegacy(opts?: {
 declare function documentLegacy(opts?: {
     signal?: string;
 }): DocumentLegacyPreset;
+/**
+ * Creates a DeviceLegacy preset for World ID 3.0 legacy support
+ *
+ * This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions.
+ *
+ * @param opts - Optional configuration with signal
+ * @returns A DeviceLegacy preset
+ *
+ * @example
+ * ```typescript
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
+ *   .preset(deviceLegacy({ signal: 'user-123' }))
+ * ```
+ */
+declare function deviceLegacy(opts?: {
+    signal?: string;
+}): DeviceLegacyPreset;
 /**
  * Creates a SelfieCheckLegacy preset for face verification
  *
@@ -430,7 +457,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>;
@@ -440,7 +467,7 @@ declare class IDKitBuilder {
      * Presets provide a simplified way to create requests with predefined
      * credential configurations.
      *
-     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), or selfieCheckLegacy()
+     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), selfieCheckLegacy(), or deviceLegacy()
      * @returns A new IDKitRequest instance
      *
      * @example
@@ -479,7 +506,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
@@ -520,6 +547,8 @@ declare const IDKit: {
     secureDocumentLegacy: typeof secureDocumentLegacy;
     /** Create a DocumentLegacy preset for World ID 3.0 legacy support */
     documentLegacy: typeof documentLegacy;
+    /** Create a DeviceLegacy preset for World ID 3.0 legacy support */
+    deviceLegacy: typeof deviceLegacy;
     /** Create a SelfieCheckLegacy preset for face verification */
     selfieCheckLegacy: typeof selfieCheckLegacy;
 };
@@ -546,4 +575,4 @@ declare const isWeb: () => boolean;
  */
 declare const isNode: () => boolean;
 
-export { type AbiEncodedValue, type ConstraintNode, type CredentialRequestType, type CredentialType, 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, 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

@@ -85,7 +85,7 @@ type IDKitSessionConfig = {
 
 /** 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;
@@ -93,7 +93,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;
@@ -101,7 +101,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;
@@ -115,7 +115,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;
@@ -123,7 +123,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;
@@ -187,43 +187,25 @@ 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 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[] };
+| { type: "waiting_for_connection" }
+| { type: "awaiting_confirmation" }
+| { type: "confirmed"; result: IDKitResult }
+| { type: "failed"; error: IDKitErrorCode };
 
 
 
@@ -252,7 +234,31 @@ interface SelfieCheckLegacyPreset {
     signal?: string;
 }
 
-type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset;
+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
@@ -282,6 +288,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;
@@ -391,6 +401,23 @@ declare function secureDocumentLegacy(opts?: {
 declare function documentLegacy(opts?: {
     signal?: string;
 }): DocumentLegacyPreset;
+/**
+ * Creates a DeviceLegacy preset for World ID 3.0 legacy support
+ *
+ * This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions.
+ *
+ * @param opts - Optional configuration with signal
+ * @returns A DeviceLegacy preset
+ *
+ * @example
+ * ```typescript
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
+ *   .preset(deviceLegacy({ signal: 'user-123' }))
+ * ```
+ */
+declare function deviceLegacy(opts?: {
+    signal?: string;
+}): DeviceLegacyPreset;
 /**
  * Creates a SelfieCheckLegacy preset for face verification
  *
@@ -430,7 +457,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>;
@@ -440,7 +467,7 @@ declare class IDKitBuilder {
      * Presets provide a simplified way to create requests with predefined
      * credential configurations.
      *
-     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), or selfieCheckLegacy()
+     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), selfieCheckLegacy(), or deviceLegacy()
      * @returns A new IDKitRequest instance
      *
      * @example
@@ -479,7 +506,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
@@ -520,6 +547,8 @@ declare const IDKit: {
     secureDocumentLegacy: typeof secureDocumentLegacy;
     /** Create a DocumentLegacy preset for World ID 3.0 legacy support */
     documentLegacy: typeof documentLegacy;
+    /** Create a DeviceLegacy preset for World ID 3.0 legacy support */
+    deviceLegacy: typeof deviceLegacy;
     /** Create a SelfieCheckLegacy preset for face verification */
     selfieCheckLegacy: typeof selfieCheckLegacy;
 };
@@ -546,4 +575,4 @@ declare const isWeb: () => boolean;
  */
 declare const isNode: () => boolean;
 
-export { type AbiEncodedValue, type ConstraintNode, type CredentialRequestType, type CredentialType, 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, 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 };