@worldcoin/idkit-core 4.0.7 → 4.0.8

package/README.md

@@ -56,19 +56,19 @@ const request = await IDKit.request({
 const qrUrl = request.connectorURI;
 ```
 
-**Available presets:** `orbLegacy`, `documentLegacy`, `secureDocumentLegacy`, `selfieCheck`
+**Available presets:** `orbLegacy`, `documentLegacy`, `secureDocumentLegacy`, `selfieCheckLegacy`
 
 Selfie check preset example:
 
 ```typescript
-import { IDKit, selfieCheck } from "@worldcoin/idkit-core";
+import { IDKit, selfieCheckLegacy } from "@worldcoin/idkit-core";
 
 const request = await IDKit.request({
   app_id: "app_xxxxx",
   action: "my-action",
   rp_context: rpContext,
   allow_legacy_proofs: false,
-}).preset(selfieCheck({ signal: "user-123" }));
+}).preset(selfieCheckLegacy({ signal: "user-123" }));
 ```
 
 ## Handling the Result

package/dist/index.cjs

@@ -392,12 +392,12 @@ function hashSignal(signal) {
     wasm.__wbindgen_export4(deferred2_0, deferred2_1, 1);
   }
 }
-function __wasm_bindgen_func_elem_605(arg0, arg1) {
-  wasm.__wasm_bindgen_func_elem_605(arg0, arg1);
-}
 function __wasm_bindgen_func_elem_968(arg0, arg1, arg2) {
   wasm.__wasm_bindgen_func_elem_968(arg0, arg1, addHeapObject(arg2));
 }
+function __wasm_bindgen_func_elem_605(arg0, arg1) {
+  wasm.__wasm_bindgen_func_elem_605(arg0, arg1);
+}
 function __wasm_bindgen_func_elem_1353(arg0, arg1, arg2, arg3) {
   wasm.__wasm_bindgen_func_elem_1353(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
 }
@@ -2180,8 +2180,8 @@ function secureDocumentLegacy(opts = {}) {
 function documentLegacy(opts = {}) {
   return { type: "DocumentLegacy", signal: opts.signal };
 }
-function selfieCheck(opts = {}) {
-  return { type: "SelfieCheck", signal: opts.signal };
+function selfieCheckLegacy(opts = {}) {
+  return { type: "SelfieCheckLegacy", signal: opts.signal };
 }
 function createWasmBuilderFromConfig(config) {
   if (!config.rp_context) {
@@ -2264,7 +2264,7 @@ var IDKitBuilder2 = class {
    * Presets provide a simplified way to create requests with predefined
    * credential configurations.
    *
-   * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), or selfieCheck()
+   * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), or selfieCheckLegacy()
    * @returns A new IDKitRequest instance
    *
    * @example
@@ -2341,8 +2341,8 @@ var IDKit = {
   secureDocumentLegacy,
   /** Create a DocumentLegacy preset for World ID 3.0 legacy support */
   documentLegacy,
-  /** Create a SelfieCheck preset for face verification */
-  selfieCheck
+  /** Create a SelfieCheckLegacy preset for face verification */
+  selfieCheckLegacy
 };
 
 // src/lib/platform.ts
@@ -2389,4 +2389,4 @@ exports.isReactNative = isReactNative;
 exports.isWeb = isWeb;
 exports.orbLegacy = orbLegacy;
 exports.secureDocumentLegacy = secureDocumentLegacy;
-exports.selfieCheck = selfieCheck;
+exports.selfieCheckLegacy = selfieCheckLegacy;

package/dist/index.d.cts

@@ -84,27 +84,31 @@ type IDKitSessionConfig = {
 };
 
 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 SelfieCheckPreset {
+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: "SelfieCheck";
+    type: "SelfieCheckLegacy";
     signal?: string;
 }
 
-type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckPreset;
+type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset;
 
 
 
@@ -339,8 +343,7 @@ interface IDKitRequest {
 /**
  * Creates an OrbLegacy preset for World ID 3.0 legacy support
  *
- * This preset creates an IDKit request compatible with both World ID 4.0 and 3.0 protocols.
- * Use this when you need backward compatibility with older World App versions.
+ * This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions.
  *
  * @param opts - Optional configuration with signal
  * @returns An OrbLegacy preset
@@ -357,8 +360,7 @@ declare function orbLegacy(opts?: {
 /**
  * Creates a SecureDocumentLegacy preset for World ID 3.0 legacy support
  *
- * This preset creates an IDKit request compatible with both World ID 4.0 and 3.0 protocols.
- * Use this when you need backward compatibility with older World App versions.
+ * 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 SecureDocumentLegacy preset
@@ -375,8 +377,7 @@ declare function secureDocumentLegacy(opts?: {
 /**
  * Creates a DocumentLegacy preset for World ID 3.0 legacy support
  *
- * This preset creates an IDKit request compatible with both World ID 4.0 and 3.0 protocols.
- * Use this when you need backward compatibility with older World App versions.
+ * 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 DocumentLegacy preset
@@ -391,26 +392,25 @@ declare function documentLegacy(opts?: {
     signal?: string;
 }): DocumentLegacyPreset;
 /**
- * Creates a SelfieCheck preset for face verification
+ * Creates a SelfieCheckLegacy preset for face verification
  *
  * Preview: Selfie Check is currently in preview.
  * Contact us if you need it enabled.
  *
- * This preset requests face credentials in v4 constraints.
- * In legacy compatibility fields, it maps to verification level "face".
+ * 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 SelfieCheck preset
+ * @returns A SelfieCheckLegacy preset
  *
  * @example
  * ```typescript
  * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: false })
- *   .preset(selfieCheck({ signal: 'user-123' }))
+ *   .preset(selfieCheckLegacy({ signal: 'user-123' }))
  * ```
  */
-declare function selfieCheck(opts?: {
+declare function selfieCheckLegacy(opts?: {
     signal?: string;
-}): SelfieCheckPreset;
+}): SelfieCheckLegacyPreset;
 /**
  * Builder for IDKit requests
  *
@@ -440,7 +440,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 selfieCheck()
+     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), or selfieCheckLegacy()
      * @returns A new IDKitRequest instance
      *
      * @example
@@ -520,8 +520,8 @@ declare const IDKit: {
     secureDocumentLegacy: typeof secureDocumentLegacy;
     /** Create a DocumentLegacy preset for World ID 3.0 legacy support */
     documentLegacy: typeof documentLegacy;
-    /** Create a SelfieCheck preset for face verification */
-    selfieCheck: typeof selfieCheck;
+    /** Create a SelfieCheckLegacy preset for face verification */
+    selfieCheckLegacy: typeof selfieCheckLegacy;
 };
 
 /**
@@ -546,4 +546,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 SelfieCheckPreset, type Status$1 as Status, type WaitOptions, documentLegacy, isNode, isReactNative, isWeb, orbLegacy, secureDocumentLegacy, selfieCheck };
+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 };

package/dist/index.d.ts

@@ -84,27 +84,31 @@ type IDKitSessionConfig = {
 };
 
 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 SelfieCheckPreset {
+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: "SelfieCheck";
+    type: "SelfieCheckLegacy";
     signal?: string;
 }
 
-type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckPreset;
+type Preset = OrbLegacyPreset | SecureDocumentLegacyPreset | DocumentLegacyPreset | SelfieCheckLegacyPreset;
 
 
 
@@ -339,8 +343,7 @@ interface IDKitRequest {
 /**
  * Creates an OrbLegacy preset for World ID 3.0 legacy support
  *
- * This preset creates an IDKit request compatible with both World ID 4.0 and 3.0 protocols.
- * Use this when you need backward compatibility with older World App versions.
+ * This preset only returns World ID 3.0 proofs. Use it for compatibility with older IDKit versions.
  *
  * @param opts - Optional configuration with signal
  * @returns An OrbLegacy preset
@@ -357,8 +360,7 @@ declare function orbLegacy(opts?: {
 /**
  * Creates a SecureDocumentLegacy preset for World ID 3.0 legacy support
  *
- * This preset creates an IDKit request compatible with both World ID 4.0 and 3.0 protocols.
- * Use this when you need backward compatibility with older World App versions.
+ * 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 SecureDocumentLegacy preset
@@ -375,8 +377,7 @@ declare function secureDocumentLegacy(opts?: {
 /**
  * Creates a DocumentLegacy preset for World ID 3.0 legacy support
  *
- * This preset creates an IDKit request compatible with both World ID 4.0 and 3.0 protocols.
- * Use this when you need backward compatibility with older World App versions.
+ * 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 DocumentLegacy preset
@@ -391,26 +392,25 @@ declare function documentLegacy(opts?: {
     signal?: string;
 }): DocumentLegacyPreset;
 /**
- * Creates a SelfieCheck preset for face verification
+ * Creates a SelfieCheckLegacy preset for face verification
  *
  * Preview: Selfie Check is currently in preview.
  * Contact us if you need it enabled.
  *
- * This preset requests face credentials in v4 constraints.
- * In legacy compatibility fields, it maps to verification level "face".
+ * 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 SelfieCheck preset
+ * @returns A SelfieCheckLegacy preset
  *
  * @example
  * ```typescript
  * const request = await IDKit.request({ app_id, action, rp_context, allow_legacy_proofs: false })
- *   .preset(selfieCheck({ signal: 'user-123' }))
+ *   .preset(selfieCheckLegacy({ signal: 'user-123' }))
  * ```
  */
-declare function selfieCheck(opts?: {
+declare function selfieCheckLegacy(opts?: {
     signal?: string;
-}): SelfieCheckPreset;
+}): SelfieCheckLegacyPreset;
 /**
  * Builder for IDKit requests
  *
@@ -440,7 +440,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 selfieCheck()
+     * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), or selfieCheckLegacy()
      * @returns A new IDKitRequest instance
      *
      * @example
@@ -520,8 +520,8 @@ declare const IDKit: {
     secureDocumentLegacy: typeof secureDocumentLegacy;
     /** Create a DocumentLegacy preset for World ID 3.0 legacy support */
     documentLegacy: typeof documentLegacy;
-    /** Create a SelfieCheck preset for face verification */
-    selfieCheck: typeof selfieCheck;
+    /** Create a SelfieCheckLegacy preset for face verification */
+    selfieCheckLegacy: typeof selfieCheckLegacy;
 };
 
 /**
@@ -546,4 +546,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 SelfieCheckPreset, type Status$1 as Status, type WaitOptions, documentLegacy, isNode, isReactNative, isWeb, orbLegacy, secureDocumentLegacy, selfieCheck };
+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 };

package/dist/index.js

@@ -389,12 +389,12 @@ function hashSignal(signal) {
     wasm.__wbindgen_export4(deferred2_0, deferred2_1, 1);
   }
 }
-function __wasm_bindgen_func_elem_605(arg0, arg1) {
-  wasm.__wasm_bindgen_func_elem_605(arg0, arg1);
-}
 function __wasm_bindgen_func_elem_968(arg0, arg1, arg2) {
   wasm.__wasm_bindgen_func_elem_968(arg0, arg1, addHeapObject(arg2));
 }
+function __wasm_bindgen_func_elem_605(arg0, arg1) {
+  wasm.__wasm_bindgen_func_elem_605(arg0, arg1);
+}
 function __wasm_bindgen_func_elem_1353(arg0, arg1, arg2, arg3) {
   wasm.__wasm_bindgen_func_elem_1353(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
 }
@@ -2177,8 +2177,8 @@ function secureDocumentLegacy(opts = {}) {
 function documentLegacy(opts = {}) {
   return { type: "DocumentLegacy", signal: opts.signal };
 }
-function selfieCheck(opts = {}) {
-  return { type: "SelfieCheck", signal: opts.signal };
+function selfieCheckLegacy(opts = {}) {
+  return { type: "SelfieCheckLegacy", signal: opts.signal };
 }
 function createWasmBuilderFromConfig(config) {
   if (!config.rp_context) {
@@ -2261,7 +2261,7 @@ var IDKitBuilder2 = class {
    * Presets provide a simplified way to create requests with predefined
    * credential configurations.
    *
-   * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), or selfieCheck()
+   * @param preset - A preset object from orbLegacy(), secureDocumentLegacy(), documentLegacy(), or selfieCheckLegacy()
    * @returns A new IDKitRequest instance
    *
    * @example
@@ -2338,8 +2338,8 @@ var IDKit = {
   secureDocumentLegacy,
   /** Create a DocumentLegacy preset for World ID 3.0 legacy support */
   documentLegacy,
-  /** Create a SelfieCheck preset for face verification */
-  selfieCheck
+  /** Create a SelfieCheckLegacy preset for face verification */
+  selfieCheckLegacy
 };
 
 // src/lib/platform.ts
@@ -2373,4 +2373,4 @@ function isValidHex(s) {
   return /^[0-9a-fA-F]+$/.test(s);
 }
 
-export { IDKit, IDKitErrorCodes, documentLegacy, hashSignal2 as hashSignal, isNode, isReactNative, isWeb, orbLegacy, secureDocumentLegacy, selfieCheck };
+export { IDKit, IDKitErrorCodes, documentLegacy, hashSignal2 as hashSignal, isNode, isReactNative, isWeb, orbLegacy, secureDocumentLegacy, selfieCheckLegacy };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@worldcoin/idkit-core",
-  "version": "4.0.7",
+  "version": "4.0.8",
   "description": "Core IDKit SDK for World ID - Pure TypeScript, no dependencies",
   "type": "module",
   "main": "./dist/index.cjs",