@vpdev2/metakyc 1.0.55 → 1.0.57

package/dist/client/session.d.ts

@@ -1,5 +1,4 @@
-export interface PreCreateApplicantParams {
-    workflowKey: string;
+export interface ApplicantPreFillParams {
     firstName?: string;
     lastName?: string;
     email?: string;
@@ -17,23 +16,31 @@ export interface CreateSessionTokenParams {
     /** String client ID (non-ABP projects). Provide this OR tenantId. */
     clientId?: string;
     /**
-     * Optional external reference ID to bind the session token to a specific user.
-     * When set, the server enforces that all API calls made with this token
-     * can only create/access applicants matching this externalRefId.
+     * Your system's unique user identifier. The server automatically creates or
+     * finds an applicant matching this ID, so the response always includes `applicantId`.
+     */
+    externalRefId: string;
+    /**
+     * Workflow key for this session. Together with `externalRefId`, the server
+     * creates or retrieves the applicant assigned to this workflow.
+     */
+    workflowKey: string;
+    /**
+     * When true, the SDK shows the company applicant form instead of individual.
+     * Embedded in the token so the SDK auto-detects the form type.
      */
-    externalRefId?: string;
+    isCompany?: boolean;
     /**
-     * Optional: pre-create a skeleton applicant during token creation.
-     * When provided, the response includes `applicantId` which can be passed
-     * to the SDK so the CreateApplicantForm starts pre-filled.
+     * Optional pre-fill data for the applicant (email, name, etc.).
+     * The applicant is always created; this just seeds initial field values.
      */
-    applicant?: PreCreateApplicantParams;
+    applicant?: ApplicantPreFillParams;
 }
 export interface SessionTokenResult {
     accessToken: string;
     expiresInSeconds: number;
-    /** Present when an applicant was pre-created via the `applicant` parameter. */
-    applicantId?: number;
+    /** The applicant ID created/found for this externalRefId + workflowKey combination. */
+    applicantId: number;
 }
 /**
  * Server-side utility to create a short-lived SDK session token.

package/dist/client/session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../src/client/session.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,qBAAa,cAAc;WACZ,WAAW,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAkCxF"}
+{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../src/client/session.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAC;CACpC;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,uFAAuF;IACvF,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,qBAAa,cAAc;WACZ,WAAW,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CA6CxF"}

package/dist/components/MetaKYC.d.ts

@@ -0,0 +1,31 @@
+import { default as React } from 'react';
+import { WorkflowResultType } from '../types';
+export interface MetaKYCProps {
+    /** Override company detection from the token. When true, shows the company form. */
+    isCompany?: boolean;
+    /** Called when the entire workflow completes */
+    onComplete?: (result: WorkflowResultType) => void;
+    /** Called when an error occurs */
+    onError?: (error: Error) => void;
+    /** Called after the applicant is created (before the workflow starts) */
+    onApplicantCreated?: (applicantId: number) => void;
+    className?: string;
+}
+/**
+ * Unified MetaKYC component.
+ *
+ * Automatically determines what to display based on the session token:
+ * - If no applicant exists for the token's ExternalRefId → shows the create form
+ * - If an applicant exists but has no progress (skeleton) → shows the create form (pre-filled)
+ * - If an applicant has active progress → shows the KYC workflow
+ * - If finished or on-hold → shows the status display (handled inside KycWorkflow)
+ *
+ * Usage:
+ * ```tsx
+ * <MetaKYCProvider config={{ baseUrl, getAccessToken: () => token }}>
+ *   <MetaKYC onComplete={(result) => console.log(result)} />
+ * </MetaKYCProvider>
+ * ```
+ */
+export declare const MetaKYC: React.FC<MetaKYCProps>;
+//# sourceMappingURL=MetaKYC.d.ts.map

package/dist/components/MetaKYC.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetaKYC.d.ts","sourceRoot":"","sources":["../../src/components/MetaKYC.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAQ1B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEnD,MAAM,WAAW,YAAY;IAC3B,oFAAoF;IACpF,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gDAAgD;IAChD,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAClD,kCAAkC;IAClC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,YAAY,CAuH1C,CAAC"}

package/dist/components/index.d.ts

@@ -7,4 +7,5 @@ export * from './Header';
 export * from './CreateApplicantForm';
 export * from './CreateCompanyApplicantForm';
 export * from './KycWorkflow';
+export * from './MetaKYC';
 //# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC"}

package/dist/hooks/index.d.ts

@@ -1,4 +1,5 @@
 export * from './useKycWorkflow';
+export * from './useMetaKYCFlow';
 export * from './useQuestionnaire';
 export * from './useUploadDocument';
 export * from './useAppropriatenessTest';

package/dist/hooks/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,eAAe,CAAC;AAC9B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,eAAe,CAAC;AAC9B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC"}

package/dist/hooks/useMetaKYCFlow.d.ts

@@ -0,0 +1,18 @@
+import { SdkPhase } from '../types';
+export interface MetaKYCFlowState {
+    phase: SdkPhase | 'loading' | 'error';
+    applicantId?: number;
+    isCompany: boolean;
+    workflowKey?: string;
+    error?: Error;
+    isLoading: boolean;
+    /**
+     * Transition to the workflow phase after applicant creation.
+     * Call this from the form's onSuccess callback.
+     */
+    transitionToWorkflow: (applicantId: number) => void;
+    /** Re-fetch the SDK state from the backend */
+    refresh: () => Promise<void>;
+}
+export declare function useMetaKYCFlow(isCompanyOverride?: boolean): MetaKYCFlowState;
+//# sourceMappingURL=useMetaKYCFlow.d.ts.map

package/dist/hooks/useMetaKYCFlow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMetaKYCFlow.d.ts","sourceRoot":"","sources":["../../src/hooks/useMetaKYCFlow.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,SAAS,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,oBAAoB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;IACpD,8CAA8C;IAC9C,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED,wBAAgB,cAAc,CAAC,iBAAiB,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAiD5E"}