@wf-financing/headless-sdk 0.1.0

package/README.md

@@ -0,0 +1,117 @@
+# Wayflyer Financing Headless SDK
+
+Wayflyer provides a `@wf-financing/headless-sdk` package that can be used as a client-side headless SDK to interact with the Embedded Finance API.
+
+## Installation
+Install the package directly from NPM with `npm install @wf-financing/headless-sdk`.  
+To minimize bundle size and reduce the impact on partners' page load times, the SDK uses dynamic imports to load main part of functionality.
+
+## Instantiation
+Initialize the Wayflyer headless SDK by passing the `companyToken` and a pointer that specifies whether the SDK should work in mocked mode.
+
+```jsx
+import { type IHeadlessWayflyerSdk, WayflyerHeadlessSdk } from '@wf-financing/headless-sdk';
+
+const wayflyerSdk = (await WayflyerHeadlessCtaSdk.loadSdk('token')) as IHeadlessWayflyerSdk;
+```
+Note: The companyToken should be minted using the Company Token endpoint on the partner's backend. See the Authentication section [here](https://docs.wayflyer.com/embedded-finance/authentication) for more details.
+
+## SDK methods
+### `getCta()`
+Returns the configuration for the CTA to show to the user.
+
+```jsx
+import type { CtaResponseType } from '@wf-financing/headless-sdk';
+
+const cta: CtaResponseType = await wayflyerSdk.getCta();
+```
+
+### `startHostedApplication(applicationRequest)`
+Returns a URL to the Wayflyer landing page after the user has given consent for sharing personal data.
+
+```jsx
+import type { StartHostedApplicationRequestType, StartHostedApplicationResponseType } from '@wf-financing/headless-sdk';
+
+const merchantData: StartHostedApplicationRequestType = {
+  company_data: {},
+  user_data: {},
+  partner_data: {},
+};
+
+const startHostedApplication: StartHostedApplicationResponseType = await wayflyerSdk.startHostedApplication(merchantData);
+```
+
+### `continueHostedApplication()`
+Returns a URL to the Wayflyer landing page after the submission of the merchant funding application.
+
+```jsx
+import type { ContinueHostedApplicationResponseType } from '@wf-financing/headless-sdk';
+
+const startHostedApplication: ContinueHostedApplicationResponseType = await wayflyerSdk.startHostedApplication(merchantData);
+```
+
+## Mocked mode
+To simplify the testing process, the SDK can be initialized in mock mode. To do so, pass a second argument with the value `true`.
+
+```jsx
+import { WayflyerHeadlessCtaSdk } from '@wf-financing/headless-sdk';
+
+const wayflyerSdk = (await WayflyerHeadlessCtaSdk.loadSdk('token', true)) as IHeadlessWayflyerSdk;
+```
+In mock mode, partner can manually set responses for SDK methods via additional methods:
+1. `setCtaResponse(responseType: CtaResponseTypes)`
+2. `setStartHostedApplicationResponse(responseType: StartHostedApplicationResponseTypes)`
+3. `setContinueHostedApplicationResponse(responseType: ContinueHostedApplicationResponseTypes)`
+4. `setSdkScenario(sdkScenario: SdkScenarios)`
+
+### `setCtaResponse(responseType: CtaResponseTypes)`
+Sets a mocked response for the `getCta()` method.
+
+```jsx
+import { CtaResponseTypes } from '@wf-financing/headless-sdk';
+
+wayflyerSdk.setCtaResponse(CtaResponseTypes.GENERIC_OFFER);
+wayflyerSdk.setCtaResponse(CtaResponseTypes.INDICATIVE_OFFER);
+wayflyerSdk.setCtaResponse(CtaResponseTypes.CONTINUE_HOSTED_APPLICATION);
+wayflyerSdk.setCtaResponse(CtaResponseTypes.NO_CTA);
+wayflyerSdk.setCtaResponse(CtaResponseTypes.INVALID_TOKEN);
+```
+
+### `setCtaResponse(responseType: CtaResponseTypes)`
+Sets a mocked response for the `startHostedApplication(applicationRequest: StartHostedApplicationRequestType)` method.
+
+```jsx
+import { StartHostedApplicationResponseTypes } from '@wf-financing/headless-sdk';
+
+wayflyerSdk.setStartHostedApplicationResponse(StartHostedApplicationResponseTypes.REDIRECT_URL);
+wayflyerSdk.setStartHostedApplicationResponse(StartHostedApplicationResponseTypes.BAD_REQUEST);
+wayflyerSdk.setStartHostedApplicationResponse(StartHostedApplicationResponseTypes.INVALID_TOKEN);
+```
+
+### `setContinueHostedApplicationResponse(responseType: ContinueHostedApplicationResponseTypes)`
+Sets a mocked response for the `continueHostedApplication()` method.
+
+```jsx
+import { ContinueHostedApplicationResponseTypes } from '@wf-financing/headless-sdk';
+
+wayflyerSdk.setContinueHostedApplicationResponse(ContinueHostedApplicationResponseTypes.REDIRECT_URL);
+wayflyerSdk.setContinueHostedApplicationResponse(ContinueHostedApplicationResponseTypes.BAD_REQUEST);
+wayflyerSdk.setContinueHostedApplicationResponse(ContinueHostedApplicationResponseTypes.INVALID_TOKEN);
+```
+
+### `setSdkScenario(sdkScenario: SdkScenarios)`
+Provides complex mocked scenarios for complete E2E testing. This ensures that partners do not encounter incompatible responses for different methods, such as `startHostedApplication(applicationRequest: StartHostedApplicationRequestType)` and `continueHostedApplication()`, which cannot return valid responses at the same time.
+
+```jsx
+import { SdkScenarios } from '@wf-financing/headless-sdk';
+
+wayflyerSdk.setSdkScenario(SdkScenarios.INDICATIVE_NEW_APPLICATION);
+wayflyerSdk.setSdkScenario(SdkScenarios.GENERIC_NEW_APPLICATION);
+wayflyerSdk.setSdkScenario(SdkScenarios.CONTINUE_APPLICATION);
+wayflyerSdk.setSdkScenario(SdkScenarios.NO_CTA);
+```
+
+Note: After calling `setSdkScenario(sdkScenario: SdkScenarios)`, other methods for setting manual responses will no longer have any effect.
+
+## Next Steps
+For further details on using the SDK, troubleshooting, or expanding on these examples, check out our [full documentation](https://docs.wayflyer.com/).

package/dist/config/index.d.ts

@@ -0,0 +1,2 @@
+export { WAYFLYER_HEADLESS_SDK_ID } from './scriptId';
+export { HEADLESS_PACKAGE_URL } from './url';

package/dist/config/scriptId.d.ts

@@ -0,0 +1 @@
+export declare const WAYFLYER_HEADLESS_SDK_ID = "wayflyer-headless-sdk";

package/dist/config/url.d.ts

@@ -0,0 +1 @@
+export declare const HEADLESS_PACKAGE_URL = "https://unpkg.com/@wf-financing/headless@1/dist/index.es.js";

package/dist/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});var s=(e=>(e.GENERIC_OFFER="generic_offer",e.INDICATIVE_OFFER="indicative_offer",e.CONTINUE_HOSTED_APPLICATION="continue_hosted_application",e.NO_CTA="no_cta",e.INVALID_TOKEN="invalid_token",e))(s||{}),d=(e=>(e.REDIRECT_URL="redirect_url",e.BAD_REQUEST="bad_request",e.INVALID_TOKEN="invalid_token",e))(d||{}),o=(e=>(e.REDIRECT_URL="redirect_url",e.BAD_REQUEST="bad_request",e.INVALID_TOKEN="invalid_token",e))(o||{}),l=(e=>(e.NO_CTA="no_cta",e.CONTINUE_APPLICATION="continue_application",e.GENERIC_NEW_APPLICATION="generic_new_application",e.INDICATIVE_NEW_APPLICATION="indicative_new_application",e))(l||{}),c=(e=>(e.GENERIC_OFFER="generic_offer",e.INDICATIVE_OFFER="indicative_offer",e.CONTINUE_APPLICATION="continue_application",e))(c||{});const n="wayflyer-headless-sdk",y="https://unpkg.com/@wf-financing/headless@1/dist/index.es.js",E=(e,a)=>{if(!window.WayflyerHeadlessSdk)throw new Error("Failed to load WayflyerHeadlessSdk from the script.");const t=window.WayflyerHeadlessSdk;return new t(e,a)},i=(e,a,t)=>new Promise((r,I)=>{e.onload=()=>{try{r(E(a,t))}catch(p){I(p)}}}),S=async(e,a)=>{try{const t=document.getElementById(n);if(window.WayflyerHeadlessSdk)return E(e,a);if(t)return i(t,e,a);const r=document.createElement("script");return r.src=y,r.type="module",r.id=n,r.async=!0,document.head.appendChild(r),i(r,e,a)}catch(t){throw console.error("Error in loading headless SDK:",t),new Error("Failed to load script")}};class _{static async loadSdk(a,t){return await S(a,t)}}exports.ContinueHostedApplicationResponseTypes=o;exports.CtaResponseTypes=s;exports.CtaStateType=c;exports.SdkScenarios=l;exports.StartHostedApplicationResponseTypes=d;exports.WayflyerHeadlessCtaSdk=_;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { ContinueHostedApplicationResponseTypes, CtaResponseTypes, CtaStateType, StartHostedApplicationResponseTypes, SdkScenarios, } from '@wf-financing/embedded-types';
+export type { CanadianProvinceCode, CompanyDataType, ContinueHostedApplicationResponseType, CountryCode, CtaContinueFundingType, CtaGenericOfferType, CtaIndicativeOfferType, CtaResponseType, IHeadlessWayflyerSdk, StartHostedApplicationRequestType, StartHostedApplicationResponseType, UserDataType, USStateCode, } from '@wf-financing/embedded-types';
+export { WayflyerHeadlessCtaSdk } from './sdk';

package/dist/index.es.js

@@ -0,0 +1,40 @@
+var l = /* @__PURE__ */ ((e) => (e.GENERIC_OFFER = "generic_offer", e.INDICATIVE_OFFER = "indicative_offer", e.CONTINUE_HOSTED_APPLICATION = "continue_hosted_application", e.NO_CTA = "no_cta", e.INVALID_TOKEN = "invalid_token", e))(l || {}), c = /* @__PURE__ */ ((e) => (e.REDIRECT_URL = "redirect_url", e.BAD_REQUEST = "bad_request", e.INVALID_TOKEN = "invalid_token", e))(c || {}), E = /* @__PURE__ */ ((e) => (e.REDIRECT_URL = "redirect_url", e.BAD_REQUEST = "bad_request", e.INVALID_TOKEN = "invalid_token", e))(E || {}), I = /* @__PURE__ */ ((e) => (e.NO_CTA = "no_cta", e.CONTINUE_APPLICATION = "continue_application", e.GENERIC_NEW_APPLICATION = "generic_new_application", e.INDICATIVE_NEW_APPLICATION = "indicative_new_application", e))(I || {}), p = /* @__PURE__ */ ((e) => (e.GENERIC_OFFER = "generic_offer", e.INDICATIVE_OFFER = "indicative_offer", e.CONTINUE_APPLICATION = "continue_application", e))(p || {});
+const r = "wayflyer-headless-sdk", _ = "https://unpkg.com/@wf-financing/headless@1/dist/index.es.js", s = (e, a) => {
+  if (!window.WayflyerHeadlessSdk)
+    throw new Error("Failed to load WayflyerHeadlessSdk from the script.");
+  const t = window.WayflyerHeadlessSdk;
+  return new t(e, a);
+}, i = (e, a, t) => new Promise((n, d) => {
+  e.onload = () => {
+    try {
+      n(s(a, t));
+    } catch (o) {
+      d(o);
+    }
+  };
+}), A = async (e, a) => {
+  try {
+    const t = document.getElementById(r);
+    if (window.WayflyerHeadlessSdk)
+      return s(e, a);
+    if (t)
+      return i(t, e, a);
+    const n = document.createElement("script");
+    return n.src = _, n.type = "module", n.id = r, n.async = !0, document.head.appendChild(n), i(n, e, a);
+  } catch (t) {
+    throw console.error("Error in loading headless SDK:", t), new Error("Failed to load script");
+  }
+};
+class N {
+  static async loadSdk(a, t) {
+    return await A(a, t);
+  }
+}
+export {
+  E as ContinueHostedApplicationResponseTypes,
+  l as CtaResponseTypes,
+  p as CtaStateType,
+  I as SdkScenarios,
+  c as StartHostedApplicationResponseTypes,
+  N as WayflyerHeadlessCtaSdk
+};

package/dist/sdk/index.d.ts

@@ -0,0 +1,3 @@
+export declare class WayflyerHeadlessCtaSdk {
+    static loadSdk(companyToken: string, isMockedMode?: boolean): Promise<void | import('@wf-financing/embedded-types').IHeadlessWayflyerSdk>;
+}

package/dist/sdk-mode/index.d.ts

@@ -0,0 +1 @@
+export { loadHeadlessSdkMode } from './loadHeadlessMode';

package/dist/sdk-mode/loadHeadlessMode.d.ts

@@ -0,0 +1,5 @@
+import { IHeadlessWayflyerSdk } from '@wf-financing/embedded-types';
+
+type LoadHeadlessSdkModeType = (companyToken: string, isMockedMode?: boolean) => Promise<IHeadlessWayflyerSdk | void>;
+export declare const loadHeadlessSdkMode: LoadHeadlessSdkModeType;
+export {};

package/dist/utils/index.d.ts

@@ -0,0 +1,2 @@
+export { initializeHeadlessSdk } from './initializeHeadlessSdk';
+export { loadScriptAndInitializeSdk } from './loadScriptAndInitializeSdk';

package/dist/utils/initializeHeadlessSdk.d.ts

@@ -0,0 +1,3 @@
+import { IHeadlessWayflyerSdk } from '@wf-financing/embedded-types';
+
+export declare const initializeHeadlessSdk: (companyToken: string, isMockedMode?: boolean) => IHeadlessWayflyerSdk;

package/dist/utils/loadScriptAndInitializeSdk.d.ts

@@ -0,0 +1,3 @@
+import { IHeadlessWayflyerSdk } from '@wf-financing/embedded-types';
+
+export declare const loadScriptAndInitializeSdk: (script: HTMLScriptElement, companyToken: string, isMockedMode?: boolean) => Promise<IHeadlessWayflyerSdk>;

package/dist/vite.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vite').UserConfig;
+export default _default;

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@wf-financing/headless-sdk",
+  "version": "0.1.0",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.es.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@wf-financing/embedded-types": "0.2.6"
+  },
+  "devDependencies": {
+    "vite": "^6.3.5",
+    "vite-plugin-dts": "^3.4.0",
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "vite build",
+    "prepare-sdk-cta": "pnpm clean && pnpm build && pnpm pack",
+    "publish-sdk-cta": "pnpm clean && pnpm build && pnpm publish --access public --no-git-checks",
+    "test": "vitest",
+    "test:coverage": "vitest --coverage"
+  }
+}