@frankieone/one-sdk 1.7.15 → 1.7.16

package/dist/cli/cli.js

@@ -0,0 +1,130 @@
+#!/usr/bin/env node
+
+/* eslint-disable no-undef */
+/* eslint-disable no-console */
+import { spawnSync, spawn } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+import os from 'os';
+
+const executableName = 'onesdk-cli';
+
+const installationPath = () => {
+  const errorMsg = 'Failed to find executable path.';
+
+  // First, check the 'npm' executable path. with this we can resolve whether
+  // user using some kind of nvm or fnm or any other node version manager.
+  const whichCmd = spawnSync('which', ['npm']);
+  if (whichCmd.error) {
+    console.error(errorMsg, whichCmd.error);
+    process.exit(1);
+  }
+  const whichOutput = whichCmd.stdout.toString().trim();
+
+  // Replace the 'npm' executable path with the 'onesdk-cli' executable path.
+  const sedCmd = spawnSync(
+    'sed',
+    ['-e', 's|bin/npm|lib/node_modules/@frankieone/one-sdk/dist/cli|'],
+    { input: whichOutput },
+  );
+
+  if (sedCmd.error) {
+    console.error(errorMsg, sedCmd.error);
+    process.exit(1);
+  }
+
+  // Check if the resolved path exists.
+  const resolvedPath = sedCmd.stdout.toString().trim();
+  if (resolvedPath && fs.existsSync(resolvedPath)) {
+    return resolvedPath;
+  }
+
+  // Fallback for npx and local installations
+  const npxPath = path.resolve(
+    process.cwd(),
+    'node_modules/@frankieone/one-sdk/dist/cli',
+  );
+
+  if (fs.existsSync(npxPath)) {
+    return npxPath;
+  }
+
+  console.error(errorMsg, 'Executable not found');
+  process.exit(1);
+};
+
+const darwinExecutable = (basePath) => {
+  const arch = os.arch();
+
+  switch (arch) {
+    case 'arm64':
+      return `${basePath}/darwin-arm64/${executableName}`;
+
+    case 'x64':
+      return `${basePath}/darwin-amd64/${executableName}`;
+
+    default:
+      return undefined;
+  }
+};
+
+const linuxExecutable = (basePath) => {
+  const arch = os.arch();
+
+  switch (arch) {
+    case 'arm64':
+      return `${basePath}/linux-arm64/${executableName}`;
+
+    case 'x64':
+      return `${basePath}/linux-amd64/${executableName}`;
+
+    default:
+      return undefined;
+  }
+};
+
+const windowsExecutable = (basePath) => {
+  return `${basePath}/windows-amd64/${executableName}.exe`;
+};
+
+const executableFile = () => {
+  const basePath = installationPath();
+  const kernelName = os.type();
+
+  switch (kernelName) {
+    case 'Linux':
+      return linuxExecutable(basePath);
+
+    case 'Darwin':
+      return darwinExecutable(basePath);
+
+    case 'Windows_NT':
+      return windowsExecutable(basePath);
+
+    default:
+      return undefined;
+  }
+};
+
+const executable = executableFile();
+if (!executable) {
+  console.error('Unsupported platform.');
+  process.exit(1);
+}
+
+const args = process.argv.slice(2);
+const child = spawn(executable, args, { stdio: 'inherit' });
+
+child.on('error', (err) => {
+  console.error('Failed to start child process.', err);
+});
+
+child.on('exit', (code, signal) => {
+  if (code && code !== 0) {
+    console.log('Process exited with code: ' + code);
+  }
+
+  if (!code && signal) {
+    console.log('Process exited with signal: ' + signal);
+  }
+});

package/dist/cli/templateGenerator.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+/* eslint-disable no-undef */
+/* eslint-disable no-console */
+function parseArgs(args) {
+  return {
+    flowId: args[2],
+    env: args[3],
+    cid: args[4],
+    ccid: args[5],
+    apiKey: args[6],
+  };
+}
+
+(async () => {
+  try {
+    const isDev = process.env.CLI_MODE === 'dev';
+    const modulePath = isDev
+      ? '../modules/cli/index.js'
+      : '../esm/modules/cli/index.js';
+
+    const templateModule = await import(modulePath);
+    const generateOneSdkFlow = templateModule.default;
+
+    if (typeof generateOneSdkFlow !== 'function') {
+      throw new Error('generateOneSdkFlow is not a function');
+    }
+
+    const { flowId, env, cid, ccid, apiKey } = parseArgs(process.argv);
+
+    process.stdout.write(
+      generateOneSdkFlow({
+        flowId,
+        env,
+        cid,
+        ccid,
+        apiKey,
+      }),
+    );
+  } catch (error) {
+    console.error('Error loading module:', error);
+  }
+})();

package/dist/commit.txt

@@ -1 +1 @@
-21911ba7fe2d3da7a611dc7b20237a5d1c8b5776
+f6ab2b2c63ce981817c71c8fe383028f84b52a4a

package/dist/esm/modules/cli/index.d.ts

@@ -0,0 +1,8 @@
+export default function generateOneSdkFlow({ flowId, env, cid, ccid, apiKey }: {
+    flowId: any;
+    env: any;
+    cid: any;
+    ccid: any;
+    apiKey: any;
+}): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/modules/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../modules/cli/index.js"],"names":[],"mappings":"AAGA;;;;;;WAEC"}

package/dist/esm/modules/cli/index.js

@@ -0,0 +1,6 @@
+import createHTML from './template/index.js';
+// @param {string} flowId - the id of the flow to generate, idv / idv_review / manual_kyc
+export default function generateOneSdkFlow({ flowId, env, cid, ccid, apiKey }) {
+    return createHTML(flowId)({ env, cid, ccid, apiKey });
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/cli/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../modules/cli/index.js"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAE7C,yFAAyF;AACzF,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE;IAC3E,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AACxD,CAAC"}

package/dist/esm/modules/cli/template/index.d.ts

@@ -0,0 +1,7 @@
+export default function createHTML(flowId: any): ({ env, cid, ccid, apiKey }: {
+    env: any;
+    cid: any;
+    ccid: any;
+    apiKey: any;
+}) => string;
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/modules/cli/template/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../modules/cli/template/index.js"],"names":[],"mappings":"AAuDA;;;;;aAkBC"}

package/dist/esm/modules/cli/template/index.js

@@ -0,0 +1,68 @@
+import { templateIdv } from './templateIdv.js';
+import { templateIdvReview } from './templateIdvReview.js';
+import { templateManualKyc } from './templateManualKyc.js';
+const backendURL = {
+    dev: "https://backend.latest.frankiefinancial.io",
+    qa: "https://backend.qa.frankiefinancial.io",
+    uat: "https://backend.kycaml.uat.frankiefinancial.io",
+    prod: "https://backend.kycaml.frankiefinancial.io",
+};
+const js = String.raw;
+const createRequestTokenFunction = ({ env, cid, ccid, apiKey }) => js `
+    // Function to get an authentication token from the FrankieOne API
+    // This token is required to initialize OneSDK
+    async function getToken() {
+      // WARNING: This is for testing purposes only
+      // In production, token generation should happen server-side for security
+
+      // Replace these placeholder values with your actual credentials
+      const customerId = '${cid}';
+      // Optional: leave empty if not applicable (for multi-tenant setups)
+      const customerChildId = '${ccid}';
+      const apiKey = '${apiKey}';
+
+      // Create authentication key by base64 encoding the credentials
+      const authKey = btoa(
+        [customerId, customerChildId, apiKey].filter(Boolean).join(':'),
+      );
+
+      // Replace this with your own logic to generate a unique customer reference
+      const customerReference = Math.random().toString(36).substring(2);
+
+      // Request a machine session token from FrankieOne
+      const tokenResponse = await fetch(
+        '${backendURL[env]}/auth/v2/machine-session',
+        {
+          method: 'POST',
+          headers: {
+            authorization: 'machine ' + authKey,
+            'Content-Type': 'application/json',
+          },
+          body: JSON.stringify({
+            permissions: {
+              preset: 'one-sdk',
+              reference: customerReference,
+            },
+          }),
+        },
+      );
+
+      return await tokenResponse.json();
+    }`;
+export default function createHTML(flowId) {
+    return function ({ env, cid, ccid, apiKey }) {
+        const getTokenImpl = createRequestTokenFunction({ env, cid, ccid, apiKey });
+        switch (flowId) {
+            case 'idv':
+                return templateIdv(getTokenImpl);
+            case 'idv_review':
+                return templateIdvReview(getTokenImpl);
+            case 'manual_kyc':
+                return templateManualKyc(getTokenImpl);
+            default:
+                return 'Unknown flow ID';
+        }
+    };
+}
+;
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/cli/template/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../modules/cli/template/index.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,MAAM,UAAU,GAAG;IACjB,GAAG,EAAE,4CAA4C;IACjD,EAAE,EAAE,wCAAwC;IAC5C,GAAG,EAAE,gDAAgD;IACrD,IAAI,EAAE,4CAA4C;CACnD,CAAC;AAEF,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC;AAEtB,MAAM,0BAA0B,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,CAAA;;;;;;;;4BAQzC,GAAG;;iCAEE,IAAI;wBACb,MAAM;;;;;;;;;;;;WAYnB,UAAU,CAAC,GAAG,CAAC;;;;;;;;;;;;;;;;;MAiBpB,CAAC;AAEP,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,MAAM;IACvC,OAAO,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE;QACzC,MAAM,YAAY,GAAG,0BAA0B,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAE5E,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,KAAK;gBACR,OAAO,WAAW,CAAC,YAAY,CAAC,CAAC;YAEnC,KAAK,YAAY;gBACf,OAAO,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAEzC,KAAK,YAAY;gBACf,OAAO,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAEzC;gBACE,OAAO,iBAAiB,CAAC;QAC7B,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAAA,CAAC"}

package/dist/esm/modules/cli/template/templateIdv.d.ts

@@ -0,0 +1,2 @@
+export function templateIdv(getTokenImpl: any): string;
+//# sourceMappingURL=templateIdv.d.ts.map

package/dist/esm/modules/cli/template/templateIdv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateIdv.d.ts","sourceRoot":"","sources":["../../../../../modules/cli/template/templateIdv.js"],"names":[],"mappings":"AAEO,uDA0GC"}

package/dist/esm/modules/cli/template/templateIdv.js

@@ -0,0 +1,109 @@
+const html = String.raw;
+export const templateIdv = (getTokenImpl) => html `<!-- Generated by OneSDK CLI -->
+<!-- More information: https://docs.frankieone.com/v1.14.1/docs/about-onesdk -->
+
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <!-- UTF-8 encoding ensures proper display of special characters in the UI -->
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>OneSDK - IDV</title>
+
+    <!-- Load the OneSDK library from FrankieOne CDN -->
+    <!-- You can change the version number in the URL to use a different version -->
+    <script src="https://assets.frankiefinancial.io/one-sdk/v1/oneSdk.umd.js"></script>
+
+    <script>
+    ${getTokenImpl}
+
+    // Main function to initialize and start OneSDK
+    async function startOneSdk() {
+      const sessionToken = await getToken();
+
+      // Initialize OneSDK with configuration
+      const oneSdk = await OneSdk({
+        session: sessionToken,
+        mode: 'production',
+        recipe: {
+          form: {
+            provider: {
+              name: 'react',
+              // UNCOMMENT AND ADD YOUR KEY to use Google Places address autocomplete
+              // googleApiKey: "<GOOGLE_API_KEY>",
+            },
+          },
+        },
+      });
+
+      const oneSdkIndividual = oneSdk.individual();
+      oneSdkIndividual.addConsent("general");
+      oneSdkIndividual.addConsent("docs");
+      oneSdkIndividual.addConsent("creditheader");
+      await oneSdkIndividual.submit();
+      // Create an IDV (Identity Verification) flow instance
+      const idv = oneSdk.flow('idv');
+
+      const successScreen = oneSdk.component('form', {
+        name: 'RESULT',
+        mode: 'individual',
+        type: 'manual',
+        state: 'SUCCESS',
+        title: { label: "Thanks, you're all done" },
+        cta: null,
+      });
+
+      const failedScreen = oneSdk.component("form", {
+        name: "RESULT",
+        mode: "individual",
+        state: "FAIL",
+        type: "manual",
+      });
+
+      // Mount the IDV flow to the container element
+      idv.mount('#idv-el');
+
+      // Handle loading states during verification
+      idv.on('loading', () => {
+        console.log('loading');
+      });
+
+      // Handle verification results
+      idv.on('results', async ({ checkStatus, document, entityId }) => {
+        if (checkStatus) {
+          console.log('results succesful');
+          successScreen.mount("#idv-el");
+        } else {
+          console.log('no data returned');
+        }
+      });
+
+      // Handle errors during verification
+      idv.on('error', ({ message, payload }) => {
+        console.log('received error');
+        console.log(message, payload);
+      });
+
+      // Handle completion of document detection/capture
+      idv.on('detection_complete', (message) => {
+        console.log('capture finished');
+        console.log(message);
+      });
+
+      // Log all OneSDK events to console for debugging
+      idv.on('*', (message) => {
+        console.log(message);
+      });
+    }
+    </script>
+  </head>
+
+  <body style="background-color: white" onload="startOneSdk()">
+    <!-- Container element where OneSDK will mount its UI components -->
+  <div
+    id="idv-el"
+    style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; display: flex; justify-content: center; align-items: center;"
+  ></div>
+  </body>
+</html>`;
+//# sourceMappingURL=templateIdv.js.map

package/dist/esm/modules/cli/template/templateIdv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateIdv.js","sourceRoot":"","sources":["../../../../../modules/cli/template/templateIdv.js"],"names":[],"mappings":"AAAA,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC;AAExB,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAA;;;;;;;;;;;;;;;;MAgB3C,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA0FV,CAAC"}

package/dist/esm/modules/cli/template/templateIdvReview.d.ts

@@ -0,0 +1,2 @@
+export function templateIdvReview(getTokenImpl: any): string;
+//# sourceMappingURL=templateIdvReview.d.ts.map

package/dist/esm/modules/cli/template/templateIdvReview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateIdvReview.d.ts","sourceRoot":"","sources":["../../../../../modules/cli/template/templateIdvReview.js"],"names":[],"mappings":"AAEO,6DA0HC"}

package/dist/esm/modules/cli/template/templateIdvReview.js

@@ -0,0 +1,125 @@
+const html = String.raw;
+export const templateIdvReview = (getTokenImpl) => html `<!-- Generated by OneSDK CLI -->
+<!-- More information: https://docs.frankieone.com/v1.14.1/docs/about-onesdk -->
+
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <!-- UTF-8 encoding ensures proper display of special characters in the UI -->
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>OneSDK - IDV+Review</title>
+
+    <!-- Load the OneSDK library from FrankieOne CDN -->
+    <!-- You can change the version number in the URL to use a different version -->
+    <script src="https://assets.frankiefinancial.io/one-sdk/v1/oneSdk.umd.js"></script>
+
+    <script>
+    ${getTokenImpl}
+
+    // Main function to initialize and start OneSDK
+    async function startOneSdk() {
+      const sessionToken = await getToken();
+
+      // Initialize OneSDK with configuration
+      const oneSdk = await OneSdk({
+        session: sessionToken,
+        mode: 'production',
+        recipe: {
+          form: {
+            provider: {
+              name: 'react',
+              // UNCOMMENT AND ADD YOUR KEY to use Google Places address autocomplete
+              // googleApiKey: "<GOOGLE_API_KEY>",
+            },
+          },
+        },
+      });
+
+      const oneSdkIndividual = oneSdk.individual();
+      oneSdkIndividual.addConsent("general");
+      oneSdkIndividual.addConsent("docs");
+      oneSdkIndividual.addConsent("creditheader");
+      await oneSdkIndividual.submit();
+
+      // Create an IDV flow instance for identity verification
+      const idv = oneSdk.flow('idv');
+
+      // Create review component for OCR (Optical Character Recognition) review
+      const review = oneSdk.component('form', {
+        name: 'REVIEW',
+        type: 'ocr',
+        mode: 'individual',
+        verify: true
+      });
+
+      const successScreen = oneSdk.component('form', {
+        name: 'RESULT',
+        mode: 'individual',
+        type: 'manual',
+        state: 'SUCCESS',
+        title: { label: "Thanks, you're all done" },
+        cta: null,
+      });
+
+      const failedScreen = oneSdk.component("form", {
+        name: "RESULT",
+        mode: "individual",
+        state: "FAIL",
+        type: "manual",
+      });
+
+      review.on('form:review:ready', async () => {
+        try {
+          // Submit the review form and run verification
+          let res = oneSdkIndividual.submit({ verify: true });
+          console.log('submit and run verification result: ', res);
+          successScreen.mount('#idv-el');
+        } catch (error) {
+          console.error(error);
+          failedScreen.mount('#idv-el');
+        }
+      });
+
+      // Mount the IDV flow to the container element
+      idv.mount('#idv-el');
+
+      // Handle verification results
+      idv.on('results', async ({ checkStatus, document, entityId }) => {
+        if (checkStatus) {
+          console.log('results succesful');
+          review.mount('#idv-el');
+        } else {
+          console.log('no data returned');
+        }
+      });
+
+      // Handle errors during verification
+      idv.on('error', ({ message, payload }) => {
+        console.log('received error');
+        console.log(message, payload);
+      });
+
+      // Handle completion of document detection/capture
+      idv.on('detection_complete', (message) => {
+        console.log('capture finished');
+        console.log(message);
+      });
+
+      // Log all events for debugging
+      idv.on('*', (message) => {
+        console.log(message);
+      });
+    }
+    </script>
+  </head>
+
+  <body style="background-color: white" onload="startOneSdk()">
+    <!-- Container element where OneSDK will mount its UI components -->
+  <div
+    id="idv-el"
+    style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; display: flex; justify-content: center; align-items: center;"
+  ></div>
+  </body>
+</html>`;
+//# sourceMappingURL=templateIdvReview.js.map

package/dist/esm/modules/cli/template/templateIdvReview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateIdvReview.js","sourceRoot":"","sources":["../../../../../modules/cli/template/templateIdvReview.js"],"names":[],"mappings":"AAAA,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC;AAExB,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAA;;;;;;;;;;;;;;;;MAgBjD,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA0GV,CAAC"}

package/dist/esm/modules/cli/template/templateManualKyc.d.ts

@@ -0,0 +1,2 @@
+export function templateManualKyc(getTokenImpl: any): string;
+//# sourceMappingURL=templateManualKyc.d.ts.map

package/dist/esm/modules/cli/template/templateManualKyc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateManualKyc.d.ts","sourceRoot":"","sources":["../../../../../modules/cli/template/templateManualKyc.js"],"names":[],"mappings":"AAEO,6DAoNC"}