@worldcoin/idkit 2.1.0 → 2.2.0

package/build/index.d.ts

@@ -1,9 +1,9 @@
-import { C as Config } from './config-BRFx4nLT.js';
-export { W as WidgetProps } from './config-BRFx4nLT.js';
+import { C as Config, W as WidgetProps } from './config-BRFx4nLT.js';
 import * as react from 'react';
-export { IErrorState, ISuccessResult, VerificationLevel } from '@worldcoin/idkit-core';
 export { solidityEncode } from '@worldcoin/idkit-core/hashing';
 export { IVerifyResponse, verifyCloudProof } from '@worldcoin/idkit-core/backend';
+import { IDKitConfig, VerificationState, ISuccessResult, AppErrorCodes } from '@worldcoin/idkit-core';
+export { IErrorState, ISuccessResult, VerificationLevel, VerificationState } from '@worldcoin/idkit-core';
 
 type HookConfig = Partial<Pick<Config, 'handleVerify' | 'onSuccess'>>;
 declare const useIDKit: ({ handleVerify, onSuccess }?: HookConfig) => {
@@ -11,6 +11,46 @@ declare const useIDKit: ({ handleVerify, onSuccess }?: HookConfig) => {
     setOpen: (open: boolean) => void;
 };
 
-declare const _default: react.NamedExoticComponent<any>;
+declare const _default: react.NamedExoticComponent<WidgetProps>;
 
-export { Config, _default as IDKitWidget, useIDKit };
+type UseSessionConfig = IDKitConfig;
+type UseSessionResult = {
+    /** The current verification state */
+    status: VerificationState;
+    /** The QR code URI that users can scan to verify */
+    sessionURI: string | null;
+    /** The verification result if successful */
+    result: ISuccessResult | null;
+    /** Error code if verification failed */
+    errorCode: AppErrorCodes | null;
+    /** Function to reset the session and start over */
+    reset: () => void;
+};
+/**
+ * A beginner-friendly React hook for World ID verification sessions.
+ *
+ * This hook automatically:
+ * - Creates a verification session
+ * - Generates a QR code URI for scanning
+ * - Polls for verification updates
+ * - Stops polling when verification completes or fails
+ *
+ * @param config - The World ID configuration object
+ * @returns Session state and controls
+ *
+ * @example
+ * ```tsx
+ * const { status, sessionURI, result, errorCode } = useSession({
+ *   app_id: 'app_staging_12345',
+ *   action: 'login',
+ *   signal: 'user_123'
+ * })
+ *
+ * if (status === VerificationState.WaitingForConnection) {
+ *   return <QRCodeSVG value={sessionURI} />
+ * }
+ * ```
+ */
+declare function useSession(config: UseSessionConfig): UseSessionResult;
+
+export { Config, _default as IDKitWidget, type UseSessionConfig, type UseSessionResult, WidgetProps, useIDKit, useSession };

package/build/index.js

@@ -2026,13 +2026,56 @@ var BaseWidget_default = IDKitWidget;
 var IDKitWidget_default = memo(BaseWidget_default);
 
 // src/index.ts
-import { VerificationLevel as VerificationLevel2 } from "@worldcoin/idkit-core";
 import { solidityEncode } from "@worldcoin/idkit-core/hashing";
 import { verifyCloudProof } from "@worldcoin/idkit-core/backend";
+import { VerificationLevel as VerificationLevel2, VerificationState as VerificationState3 } from "@worldcoin/idkit-core";
+
+// src/hooks/useSession.ts
+import { useEffect as useEffect6 } from "react";
+import { useShallow } from "zustand/react/shallow";
+import { VerificationState as VerificationState2 } from "@worldcoin/idkit-core";
+import { useWorldBridgeStore as useWorldBridgeStore2 } from "@worldcoin/idkit-core";
+var TERMINAL_STATES = [VerificationState2.Confirmed, VerificationState2.Failed];
+function useSession(config) {
+  const { reset, result, connectorURI, createClient, pollForUpdates, verificationState, errorCode } = useWorldBridgeStore2(
+    useShallow((state) => ({
+      reset: state.reset,
+      result: state.result,
+      connectorURI: state.connectorURI,
+      createClient: state.createClient,
+      pollForUpdates: state.pollForUpdates,
+      verificationState: state.verificationState,
+      errorCode: state.errorCode
+    }))
+  );
+  useEffect6(() => {
+    if (verificationState === VerificationState2.PreparingClient && !connectorURI) {
+      void createClient(config);
+    }
+  }, [verificationState, connectorURI, createClient, config]);
+  useEffect6(() => {
+    if (TERMINAL_STATES.includes(verificationState)) return;
+    const interval = setInterval(() => {
+      void pollForUpdates();
+    }, 3e3);
+    return () => {
+      clearInterval(interval);
+    };
+  }, [verificationState, pollForUpdates]);
+  return {
+    status: verificationState,
+    sessionURI: connectorURI,
+    result,
+    errorCode,
+    reset
+  };
+}
 export {
   IDKitWidget_default as IDKitWidget,
   VerificationLevel2 as VerificationLevel,
+  VerificationState3 as VerificationState,
   solidityEncode,
   useIDKit_default as useIDKit,
+  useSession,
   verifyCloudProof
 };

package/package.json

@@ -92,7 +92,7 @@
       ]
     }
   },
-  "version": "2.1.0",
+  "version": "2.2.0",
   "scripts": {
     "build": "npm run build:css && tsup",
     "build:css": "npx tailwindcss -i ./src/styles/styles.css -o ./build/index.css --minify",

package/src/index.ts

@@ -1,11 +1,15 @@
 import useIDKit from './hooks/useIDKit'
 import IDKitWidget from '@/components/IDKitWidget/index'
 import type { WidgetProps, Config } from '@/types/config'
-import { VerificationLevel } from '@worldcoin/idkit-core'
 import { solidityEncode } from '@worldcoin/idkit-core/hashing'
 import { verifyCloudProof } from '@worldcoin/idkit-core/backend'
 import type { IVerifyResponse } from '@worldcoin/idkit-core/backend'
 import type { ISuccessResult, IErrorState } from '@worldcoin/idkit-core'
+import { VerificationLevel, VerificationState } from '@worldcoin/idkit-core'
 
-export { IDKitWidget, useIDKit, solidityEncode, verifyCloudProof, VerificationLevel }
+export { IDKitWidget, useIDKit, solidityEncode, verifyCloudProof, VerificationLevel, VerificationState }
 export type { ISuccessResult, IErrorState, IVerifyResponse, Config, WidgetProps }
+
+// Session API
+export { useSession } from '@/hooks/useSession'
+export type { UseSessionConfig, UseSessionResult } from '@/hooks/useSession'