@worldcoin/idkit-core 4.1.4 → 4.1.6

package/dist/index.d.cts

@@ -194,6 +194,8 @@ type IDKitErrorCode =
 | "user_rejected"
 | "verification_rejected"
 | "credential_unavailable"
+| "world_id_4_not_available"
+| "world_id_3_not_available"
 | "malformed_request"
 | "invalid_network"
 | "inclusion_proof_pending"
@@ -211,6 +213,7 @@ type IDKitErrorCode =
 | "timestamp_too_far_in_future"
 | "invalid_timestamp"
 | "rp_signature_expired"
+| "identity_attributes_not_matched"
 | "generic_error";
 
 /** Status returned from pollForStatus() */
@@ -253,7 +256,19 @@ interface DeviceLegacyPreset {
     signal?: string;
 }
 
-type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset | DeviceLegacyPreset;
+interface ProofOfHumanPreset {
+    /** Requests a World ID 4.0 proof-of-human credential with legacy Orb fallback. */
+    type: "ProofOfHuman";
+    signal?: string;
+}
+
+interface PassportPreset {
+    /** Requests a World ID 4.0 passport credential with legacy document fallback. */
+    type: "Passport";
+    signal?: string;
+}
+
+type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset | DeviceLegacyPreset | ProofOfHumanPreset | PassportPreset;
 
 
 
@@ -288,6 +303,8 @@ declare enum IDKitErrorCodes {
     UserRejected = "user_rejected",
     VerificationRejected = "verification_rejected",
     CredentialUnavailable = "credential_unavailable",
+    WorldId4NotAvailable = "world_id_4_not_available",
+    WorldId3NotAvailable = "world_id_3_not_available",
     MalformedRequest = "malformed_request",
     InvalidNetwork = "invalid_network",
     InclusionProofPending = "inclusion_proof_pending",
@@ -305,6 +322,7 @@ declare enum IDKitErrorCodes {
     TimestampTooFarInFuture = "timestamp_too_far_in_future",
     InvalidTimestamp = "invalid_timestamp",
     RpSignatureExpired = "rp_signature_expired",
+    IdentityAttributesNotMatched = "identity_attributes_not_matched",
     GenericError = "generic_error",
     InvalidRpIdFormat = "invalid_rp_id_format",
     Timeout = "timeout",
@@ -374,6 +392,27 @@ interface IDKitRequest {
     /** Poll continuously until completion or timeout */
     pollUntilCompletion(options?: WaitOptions): Promise<IDKitCompletionResult>;
 }
+/**
+ * An invite-code mode World ID verification request (WDP-73).
+ *
+ * Sibling shape to {@link IDKitRequest}, but discovery happens through a
+ * URL pointing at the `world.org/verify` landing page (which displays the
+ * code for the user to type into World App). The polling lifecycle is
+ * byte-identical to URL mode — same `Status`, same `IDKitCompletionResult` —
+ * so adopters write the same poll loop.
+ */
+interface IDKitInviteCodeRequest {
+    /** URL to display to the user. Same shape as URL/QR mode's `connectorURI` with `&c=<code>&a=<app_id>` appended. */
+    readonly connectorURI: string;
+    /** Unix-seconds expiry of the unredeemed code. After this point bridge will reject the redeem. */
+    readonly expiresAt: number;
+    /** Unique request ID for this verification */
+    readonly requestId: string;
+    /** Poll once for current status (for manual polling) */
+    pollOnce(): Promise<Status>;
+    /** Poll continuously until completion or timeout */
+    pollUntilCompletion(options?: WaitOptions): Promise<IDKitCompletionResult>;
+}
 /**
  * Creates a CredentialRequest for a credential type
  *
@@ -523,13 +562,43 @@ declare function deviceLegacy(opts?: {
  *
  * @example
  * ```typescript
- * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: false })
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
  *   .preset(selfieCheckLegacy({ signal: 'user-123' }))
  * ```
  */
 declare function selfieCheckLegacy(opts?: {
     signal?: string;
 }): SelfieCheckLegacyPreset;
+/**
+ * Creates a ProofOfHuman preset for World ID 4.0 with legacy Orb fallback
+ *
+ * @param opts - Optional configuration with signal
+ * @returns A ProofOfHuman preset
+ *
+ * @example
+ * ```typescript
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
+ *   .preset(proofOfHuman({ signal: 'user-123' }))
+ * ```
+ */
+declare function proofOfHuman(opts?: {
+    signal?: string;
+}): ProofOfHumanPreset;
+/**
+ * Creates a Passport preset for World ID 4.0 with legacy document fallback
+ *
+ * @param opts - Optional configuration with signal
+ * @returns A Passport preset
+ *
+ * @example
+ * ```typescript
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: false })
+ *   .preset(passport({ signal: 'user-123' }))
+ * ```
+ */
+declare function passport(opts?: {
+    signal?: string;
+}): PassportPreset;
 /**
  * Builder for IDKit requests
  *
@@ -559,7 +628,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(), selfieCheckLegacy(), or deviceLegacy()
+     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), selfieCheckLegacy(), deviceLegacy(), proofOfHuman(), or passport()
      * @returns A new IDKitRequest instance
      *
      * @example
@@ -570,6 +639,39 @@ declare class IDKitBuilder {
      */
     preset(preset: Preset): Promise<IDKitRequest>;
 }
+/**
+ * Builder for invite-code mode requests (WDP-73).
+ *
+ * Code mode is bridge-only by definition: the user is on a different device
+ * than World App (e.g. desktop browser ↔ phone), so there's no in-app native
+ * postMessage path to branch on. This builder skips the `isInWorldApp()`
+ * check that {@link IDKitBuilder} performs.
+ */
+declare class IDKitInviteCodeBuilder {
+    private config;
+    constructor(config: BuilderConfig);
+    /**
+     * Creates an invite-code mode IDKit request with the given constraints.
+     *
+     * @param constraints - Constraint tree (CredentialRequest or any/all/enumerate combinators)
+     * @returns A new IDKitInviteCodeRequest instance
+     *
+     * @example
+     * ```typescript
+     * const request = await IDKit.requestWithInviteCode({ app_id, action, rp_context, allow_legacy_proofs: false })
+     *   .constraints(any(CredentialRequest('proof_of_human'), CredentialRequest('face')));
+     * displayLink(request.connectorURI);
+     * ```
+     */
+    constraints(constraints: ConstraintNode): Promise<IDKitInviteCodeRequest>;
+    /**
+     * Creates an invite-code mode IDKit request from a preset.
+     *
+     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), selfieCheckLegacy(), deviceLegacy(), proofOfHuman(), or passport()
+     * @returns A new IDKitInviteCodeRequest instance
+     */
+    preset(preset: Preset): Promise<IDKitInviteCodeRequest>;
+}
 /**
  * Creates an IDKit verification request builder
  *
@@ -609,6 +711,27 @@ declare class IDKitBuilder {
  * ```
  */
 declare function createRequest(config: IDKitRequestConfig): IDKitBuilder;
+/**
+ * Creates an invite-code mode IDKit request builder (WDP-73).
+ *
+ * Sibling entry point to {@link createRequest}. Validates the same required
+ * fields, returns a {@link IDKitInviteCodeBuilder} whose `.constraints()` /
+ * `.preset()` methods produce {@link IDKitInviteCodeRequest} handles.
+ *
+ * @example
+ * ```typescript
+ * const request = await IDKit.requestWithInviteCode({
+ *   app_id: 'app_staging_xxxxx',
+ *   action: 'my-action',
+ *   rp_context: { ... },
+ *   allow_legacy_proofs: false,
+ * }).constraints(any(CredentialRequest('proof_of_human'), CredentialRequest('face')));
+ *
+ * displayLink(request.connectorURI);          // user opens this URL on their phone
+ * const proof = await request.pollUntilCompletion();
+ * ```
+ */
+declare function createRequestWithInviteCode(config: IDKitRequestConfig): IDKitInviteCodeBuilder;
 /**
  * Creates a new session builder (no action, no existing session_id)
  *
@@ -687,6 +810,8 @@ declare function proveSession(sessionId: `session_${string}`, config: IDKitSessi
 declare const IDKit: {
     /** Create a new verification request */
     request: typeof createRequest;
+    /** Create a new invite-code mode verification request (WDP-73) */
+    requestWithInviteCode: typeof createRequestWithInviteCode;
     /** Create a new session (no action, no existing session_id) */
     createSession: typeof createSession;
     /** Prove an existing session (no action, has session_id) */
@@ -709,6 +834,10 @@ declare const IDKit: {
     deviceLegacy: typeof deviceLegacy;
     /** Create a SelfieCheckLegacy preset for face verification */
     selfieCheckLegacy: typeof selfieCheckLegacy;
+    /** Create a ProofOfHuman preset for World ID 4.0 with legacy Orb fallback */
+    proofOfHuman: typeof proofOfHuman;
+    /** Create a Passport preset for World ID 4.0 with legacy document fallback */
+    passport: typeof passport;
 };
 
 /**
@@ -736,4 +865,4 @@ declare const isNode: () => boolean;
 declare function isDebug(): boolean;
 declare function setDebug(enabled: boolean): void;
 
-export { type AbiEncodedValue, type ConstraintNode, CredentialRequest, 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, all, any, deviceLegacy, documentLegacy, enumerate, isDebug, isInWorldApp, isNode, isReactNative, isWeb, orbLegacy, secureDocumentLegacy, selfieCheckLegacy, setDebug };
+export { type AbiEncodedValue, type ConstraintNode, CredentialRequest, type CredentialRequestType, type CredentialType, type DeviceLegacyPreset, type DocumentLegacyPreset, IDKit, type IDKitCompletionResult, type IDKitErrorCode, IDKitErrorCodes, type IDKitInviteCodeRequest, type IDKitRequest, type IDKitRequestConfig, type IDKitResult, type IDKitResultSession, type IDKitSessionConfig, type OrbLegacyPreset, type PassportPreset, type Preset, type ProofOfHumanPreset, type ResponseItemSession, type ResponseItemV3, type ResponseItemV4, type RpContext, type SecureDocumentLegacyPreset, type SelfieCheckLegacyPreset, type Status$1 as Status, type WaitOptions, all, any, deviceLegacy, documentLegacy, enumerate, isDebug, isInWorldApp, isNode, isReactNative, isWeb, orbLegacy, passport, proofOfHuman, secureDocumentLegacy, selfieCheckLegacy, setDebug };

package/dist/index.d.ts

@@ -194,6 +194,8 @@ type IDKitErrorCode =
 | "user_rejected"
 | "verification_rejected"
 | "credential_unavailable"
+| "world_id_4_not_available"
+| "world_id_3_not_available"
 | "malformed_request"
 | "invalid_network"
 | "inclusion_proof_pending"
@@ -211,6 +213,7 @@ type IDKitErrorCode =
 | "timestamp_too_far_in_future"
 | "invalid_timestamp"
 | "rp_signature_expired"
+| "identity_attributes_not_matched"
 | "generic_error";
 
 /** Status returned from pollForStatus() */
@@ -253,7 +256,19 @@ interface DeviceLegacyPreset {
     signal?: string;
 }
 
-type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset | DeviceLegacyPreset;
+interface ProofOfHumanPreset {
+    /** Requests a World ID 4.0 proof-of-human credential with legacy Orb fallback. */
+    type: "ProofOfHuman";
+    signal?: string;
+}
+
+interface PassportPreset {
+    /** Requests a World ID 4.0 passport credential with legacy document fallback. */
+    type: "Passport";
+    signal?: string;
+}
+
+type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset | DeviceLegacyPreset | ProofOfHumanPreset | PassportPreset;
 
 
 
@@ -288,6 +303,8 @@ declare enum IDKitErrorCodes {
     UserRejected = "user_rejected",
     VerificationRejected = "verification_rejected",
     CredentialUnavailable = "credential_unavailable",
+    WorldId4NotAvailable = "world_id_4_not_available",
+    WorldId3NotAvailable = "world_id_3_not_available",
     MalformedRequest = "malformed_request",
     InvalidNetwork = "invalid_network",
     InclusionProofPending = "inclusion_proof_pending",
@@ -305,6 +322,7 @@ declare enum IDKitErrorCodes {
     TimestampTooFarInFuture = "timestamp_too_far_in_future",
     InvalidTimestamp = "invalid_timestamp",
     RpSignatureExpired = "rp_signature_expired",
+    IdentityAttributesNotMatched = "identity_attributes_not_matched",
     GenericError = "generic_error",
     InvalidRpIdFormat = "invalid_rp_id_format",
     Timeout = "timeout",
@@ -374,6 +392,27 @@ interface IDKitRequest {
     /** Poll continuously until completion or timeout */
     pollUntilCompletion(options?: WaitOptions): Promise<IDKitCompletionResult>;
 }
+/**
+ * An invite-code mode World ID verification request (WDP-73).
+ *
+ * Sibling shape to {@link IDKitRequest}, but discovery happens through a
+ * URL pointing at the `world.org/verify` landing page (which displays the
+ * code for the user to type into World App). The polling lifecycle is
+ * byte-identical to URL mode — same `Status`, same `IDKitCompletionResult` —
+ * so adopters write the same poll loop.
+ */
+interface IDKitInviteCodeRequest {
+    /** URL to display to the user. Same shape as URL/QR mode's `connectorURI` with `&c=<code>&a=<app_id>` appended. */
+    readonly connectorURI: string;
+    /** Unix-seconds expiry of the unredeemed code. After this point bridge will reject the redeem. */
+    readonly expiresAt: number;
+    /** Unique request ID for this verification */
+    readonly requestId: string;
+    /** Poll once for current status (for manual polling) */
+    pollOnce(): Promise<Status>;
+    /** Poll continuously until completion or timeout */
+    pollUntilCompletion(options?: WaitOptions): Promise<IDKitCompletionResult>;
+}
 /**
  * Creates a CredentialRequest for a credential type
  *
@@ -523,13 +562,43 @@ declare function deviceLegacy(opts?: {
  *
  * @example
  * ```typescript
- * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: false })
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
  *   .preset(selfieCheckLegacy({ signal: 'user-123' }))
  * ```
  */
 declare function selfieCheckLegacy(opts?: {
     signal?: string;
 }): SelfieCheckLegacyPreset;
+/**
+ * Creates a ProofOfHuman preset for World ID 4.0 with legacy Orb fallback
+ *
+ * @param opts - Optional configuration with signal
+ * @returns A ProofOfHuman preset
+ *
+ * @example
+ * ```typescript
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: true })
+ *   .preset(proofOfHuman({ signal: 'user-123' }))
+ * ```
+ */
+declare function proofOfHuman(opts?: {
+    signal?: string;
+}): ProofOfHumanPreset;
+/**
+ * Creates a Passport preset for World ID 4.0 with legacy document fallback
+ *
+ * @param opts - Optional configuration with signal
+ * @returns A Passport preset
+ *
+ * @example
+ * ```typescript
+ * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: false })
+ *   .preset(passport({ signal: 'user-123' }))
+ * ```
+ */
+declare function passport(opts?: {
+    signal?: string;
+}): PassportPreset;
 /**
  * Builder for IDKit requests
  *
@@ -559,7 +628,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(), selfieCheckLegacy(), or deviceLegacy()
+     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), selfieCheckLegacy(), deviceLegacy(), proofOfHuman(), or passport()
      * @returns A new IDKitRequest instance
      *
      * @example
@@ -570,6 +639,39 @@ declare class IDKitBuilder {
      */
     preset(preset: Preset): Promise<IDKitRequest>;
 }
+/**
+ * Builder for invite-code mode requests (WDP-73).
+ *
+ * Code mode is bridge-only by definition: the user is on a different device
+ * than World App (e.g. desktop browser ↔ phone), so there's no in-app native
+ * postMessage path to branch on. This builder skips the `isInWorldApp()`
+ * check that {@link IDKitBuilder} performs.
+ */
+declare class IDKitInviteCodeBuilder {
+    private config;
+    constructor(config: BuilderConfig);
+    /**
+     * Creates an invite-code mode IDKit request with the given constraints.
+     *
+     * @param constraints - Constraint tree (CredentialRequest or any/all/enumerate combinators)
+     * @returns A new IDKitInviteCodeRequest instance
+     *
+     * @example
+     * ```typescript
+     * const request = await IDKit.requestWithInviteCode({ app_id, action, rp_context, allow_legacy_proofs: false })
+     *   .constraints(any(CredentialRequest('proof_of_human'), CredentialRequest('face')));
+     * displayLink(request.connectorURI);
+     * ```
+     */
+    constraints(constraints: ConstraintNode): Promise<IDKitInviteCodeRequest>;
+    /**
+     * Creates an invite-code mode IDKit request from a preset.
+     *
+     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), selfieCheckLegacy(), deviceLegacy(), proofOfHuman(), or passport()
+     * @returns A new IDKitInviteCodeRequest instance
+     */
+    preset(preset: Preset): Promise<IDKitInviteCodeRequest>;
+}
 /**
  * Creates an IDKit verification request builder
  *
@@ -609,6 +711,27 @@ declare class IDKitBuilder {
  * ```
  */
 declare function createRequest(config: IDKitRequestConfig): IDKitBuilder;
+/**
+ * Creates an invite-code mode IDKit request builder (WDP-73).
+ *
+ * Sibling entry point to {@link createRequest}. Validates the same required
+ * fields, returns a {@link IDKitInviteCodeBuilder} whose `.constraints()` /
+ * `.preset()` methods produce {@link IDKitInviteCodeRequest} handles.
+ *
+ * @example
+ * ```typescript
+ * const request = await IDKit.requestWithInviteCode({
+ *   app_id: 'app_staging_xxxxx',
+ *   action: 'my-action',
+ *   rp_context: { ... },
+ *   allow_legacy_proofs: false,
+ * }).constraints(any(CredentialRequest('proof_of_human'), CredentialRequest('face')));
+ *
+ * displayLink(request.connectorURI);          // user opens this URL on their phone
+ * const proof = await request.pollUntilCompletion();
+ * ```
+ */
+declare function createRequestWithInviteCode(config: IDKitRequestConfig): IDKitInviteCodeBuilder;
 /**
  * Creates a new session builder (no action, no existing session_id)
  *
@@ -687,6 +810,8 @@ declare function proveSession(sessionId: `session_${string}`, config: IDKitSessi
 declare const IDKit: {
     /** Create a new verification request */
     request: typeof createRequest;
+    /** Create a new invite-code mode verification request (WDP-73) */
+    requestWithInviteCode: typeof createRequestWithInviteCode;
     /** Create a new session (no action, no existing session_id) */
     createSession: typeof createSession;
     /** Prove an existing session (no action, has session_id) */
@@ -709,6 +834,10 @@ declare const IDKit: {
     deviceLegacy: typeof deviceLegacy;
     /** Create a SelfieCheckLegacy preset for face verification */
     selfieCheckLegacy: typeof selfieCheckLegacy;
+    /** Create a ProofOfHuman preset for World ID 4.0 with legacy Orb fallback */
+    proofOfHuman: typeof proofOfHuman;
+    /** Create a Passport preset for World ID 4.0 with legacy document fallback */
+    passport: typeof passport;
 };
 
 /**
@@ -736,4 +865,4 @@ declare const isNode: () => boolean;
 declare function isDebug(): boolean;
 declare function setDebug(enabled: boolean): void;
 
-export { type AbiEncodedValue, type ConstraintNode, CredentialRequest, 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, all, any, deviceLegacy, documentLegacy, enumerate, isDebug, isInWorldApp, isNode, isReactNative, isWeb, orbLegacy, secureDocumentLegacy, selfieCheckLegacy, setDebug };
+export { type AbiEncodedValue, type ConstraintNode, CredentialRequest, type CredentialRequestType, type CredentialType, type DeviceLegacyPreset, type DocumentLegacyPreset, IDKit, type IDKitCompletionResult, type IDKitErrorCode, IDKitErrorCodes, type IDKitInviteCodeRequest, type IDKitRequest, type IDKitRequestConfig, type IDKitResult, type IDKitResultSession, type IDKitSessionConfig, type OrbLegacyPreset, type PassportPreset, type Preset, type ProofOfHumanPreset, type ResponseItemSession, type ResponseItemV3, type ResponseItemV4, type RpContext, type SecureDocumentLegacyPreset, type SelfieCheckLegacyPreset, type Status$1 as Status, type WaitOptions, all, any, deviceLegacy, documentLegacy, enumerate, isDebug, isInWorldApp, isNode, isReactNative, isWeb, orbLegacy, passport, proofOfHuman, secureDocumentLegacy, selfieCheckLegacy, setDebug };