@wf-financing/ui-sdk 0.1.3 → 2.0.0

package/README.md

@@ -1,64 +1,55 @@
 # Wayflyer Financing UI SDK
 
-Wayflyer provides a `@wf-financing/ui-sdk` package that can be used as a client-side UI SDK to interact with the Embedded Finance API. It provides a single method to mount the CTA banner in the partner UI.
+Wayflyer provides a `@wf-financing/ui-sdk` - a client-side UI SDK to interact with the Embedded Finance API. Its primary method mounts the CTA banner in the partner UI.
 
 ## Installation
 
-Install the package directly from NPM with `npm install @wf-financing/ui-sdk`.  
-To minimize the bundle size and reduce the impact on partners' page load times, the SDK uses dynamic imports to load the main part of the functionality.
+Install the package directly from NPM with `npm install @wf-financing/ui-sdk`. To minimize the bundle size and reduce the impact on partners' page load times, the SDK uses dynamic imports to load the main part of the functionality.
 
 ## Instantiation
 
 To initialize `WayflyerUiSdk`, call the static method `loadSdk` with the following parameters:
 
-1. `targetId` - The DOM element's ID where the CTA is supposed to be mounted.
-2. `partnerDesignId` - The ID of the partner theme that needs to be applied to the CTA.
-   - **Note**: The partner must request Wayflyer to generate a special theme ID.
-3. `partnerCallback` - A function of type `PartnerCallbackType`, which is also provided by the `@wf-financing/ui-sdk` package.
-4. `companyToken` - The merchant identifier.
+1. `companyToken` - The merchant identifier.
    - **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.
+2. `options` (optional) – an object of type `SdkOptionsType` that provides an ability for SDK to run in different modes (e.g. sandbox mode).
 
 ```jsx
-import { type IWayflyerUiCtaSdk, WayflyerUiSdk } from '@wf-financing/ui-sdk';
+import { WayflyerUiSdk } from '@wf-financing/ui-sdk';
 
-const wayflyerSdk = (await WayflyerUiSdk.loadSdk(targetId, partnerDesignId, partnerCallback, companyToken)) as IWayflyerUiCtaSdk;
+const wayflyerUiSdk = await WayflyerUiSdk.loadSdk(companyToken);
 ```
 
 ## SDK methods
-### `mountCta()`
+
+### `mountCta(targetId, partnerCallback)`
+
 This function mounts the CTA banner once it's called.
 
+1. `targetId` - the `id` of the DOM element where the CTA banner should be mounted.
+2. `partnerCallback` – a callback function that should return data of type `PartnerCallbackType`.
+
 ```jsx
-wayflyerSdk.mountCta();
-```
+import { type PartnerCallbackType } from '@wf-financing/ui-sdk';
 
-## Mocked mode
-To simplify the testing process, the SDK can be initialized in mock mode. To do so, pass a fifth argument of type `MockedModeType`.
-In mock mode, the partner can manually set responses for SDK methods via the `sdkScenario` field in the optional `mockedMode` argument.
+const partnerCallback: PartnerCallbackType = await () => {};
 
-```jsx
-import { WayflyerUiSdk, type MockedModeType, SdkScenarios } from '@wf-financing/ui-sdk';
+wayflyerUiSdk.mountCta(targetId, partnerCallback);
+```
+
+## Sandbox
 
-const mockedModeNewApplication: MockedModeType = {
-   isMockedMode: true,
-   sdkScenario: SdkScenarios.INDICATIVE_NEW_APPLICATION,
-};
+To simplify the testing process, the SDK can be initialized in sandbox mode. To do so, pass the second argument of type `SdkOptionsType` with `isSandbox` flag set to `true`. In sandbox mode, the partner can simulate responses for SDK methods with the help of the additional package `@wf-financing/sandbox-ui`.
 
-const mockedModeNewApplication: MockedModeType = {
-   isMockedMode: true,
-   sdkScenario: SdkScenarios.GENERIC_NEW_APPLICATION,
-};
+```jsx
+import { WayflyerUiSdk, type SdkOptionsType, type PartnerCallbackType } from '@wf-financing/ui-sdk';
 
-const mockedModeContinueApplication: MockedModeType = {
-   isMockedMode: true,
-   sdkScenario: SdkScenarios.CONTINUE_APPLICATION,
-};
+const options: SdkOptionsType = { isSandbox: true };
+const wayflyerUiSdk = await WayflyerUiSdk.loadSdk(companyToken, options);
 
-const mockedModeNoCta: MockedModeType = {
-   isMockedMode: true,
-   sdkScenario: SdkScenarios.NO_CTA,
-};
+const partnerCallback: PartnerCallbackType = await () => {};
 
-const wayflyerSdk = (await WayflyerUiSdk.loadSdk(targetId, partnerDesignId, partnerCallback, companyToken, mockedMode)) as IWayflyerUiCtaSdk;
+wayflyerUiSdk.mountCta(targetId, partnerCallback);
 ```
-After instantiation with the mockedMode parameter, the CTA banner will behave according to the specified scenario.
+
+After instantiation in sandbox mode, the SDK will call the sandbox environment API.

package/dist/config/url.d.ts

@@ -1 +1 @@
-export declare const UI_PACKAGE_URL = "https://cdn.jsdelivr.net/npm/@wf-financing/ui@1/dist/index.es.js";
+export declare const UI_PACKAGE_URL = "https://embedded-finance-frontend.vercel.app/npm/@wf-financing/ui@3";

package/dist/index.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});var l=(i=>(i.NO_CTA="no_cta",i.CONTINUE_APPLICATION="continue_application",i.GENERIC_NEW_APPLICATION="generic_new_application",i.INDICATIVE_NEW_APPLICATION="indicative_new_application",i))(l||{});const d="wayflyer-ui-package",w="https://cdn.jsdelivr.net/npm/@wf-financing/ui@1/dist/index.es.js",s=(i,r,n,a,o)=>{if(!window.WayflyerUiCtaSdk)throw new Error("Failed to load WayflyerUiCtaSdk from the script.");const t=window.WayflyerUiCtaSdk;return new t(i,r,n,a,o)},c=(i,r,n,a,o,t)=>new Promise((e,y)=>{i.onload=()=>{try{e(s(r,n,a,o,t))}catch(S){y(S)}}}),f=async(i,r,n,a,o)=>{try{const t=document.getElementById(d);if(window.WayflyerUiCtaSdk)return s(i,r,n,a,o);if(t)return c(t,i,r,n,a,o);const e=document.createElement("script");return e.src=w,e.type="module",e.id=d,e.async=!0,document.head.appendChild(e),c(e,i,r,n,a,o)}catch(t){throw console.error("Error in loading headless SDK:",t),new Error("Failed to load script")}};class u{static async loadSdk(r,n,a,o,t){return await f(r,n,a,o,t)}}exports.SdkScenarios=l;exports.WayflyerUiSdk=u;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const d="wayflyer-ui-package",l="https://embedded-finance-frontend.vercel.app/npm/@wf-financing/ui@3",a=(i,t)=>{if(!window.WayflyerUiSdk)throw new Error("Failed to load WayflyerUiSdk from the script.");const e=window.WayflyerUiSdk;return new e(i,t)},n=(i,t,e)=>new Promise((r,o)=>{i.onload=()=>{try{r(a(t,e))}catch(c){o(c)}}}),y=async(i,t)=>{try{const e=document.getElementById(d);if(window.WayflyerUiSdk)return a(i,t);if(e)return n(e,i,t);const r=document.createElement("script");return r.src=l,r.type="module",r.id=d,r.async=!0,document.head.appendChild(r),n(r,i,t)}catch(e){throw console.error("Error in loading headless SDK:",e),new Error("Failed to load script")}};class s{static async loadSdk(t,e){return await y(t,e)}}exports.WayflyerUiSdk=s;

package/dist/index.d.ts

@@ -1,3 +1,2 @@
-export type { IWayflyerUiCtaSdk, PartnerCallbackType, MockedModeType } from '@wf-financing/embedded-types';
-export { SdkScenarios } from '@wf-financing/embedded-types';
+export type { IWayflyerUiSdk, PartnerCallbackType, SdkOptionsType } from '@wf-financing/embedded-types';
 export { WayflyerUiSdk } from './sdk';

package/dist/index.es.js

@@ -1,43 +1,34 @@
-var w = /* @__PURE__ */ ((i) => (i.NO_CTA = "no_cta", i.CONTINUE_APPLICATION = "continue_application", i.GENERIC_NEW_APPLICATION = "generic_new_application", i.INDICATIVE_NEW_APPLICATION = "indicative_new_application", i))(w || {});
-const c = "wayflyer-ui-package", S = "https://cdn.jsdelivr.net/npm/@wf-financing/ui@1/dist/index.es.js", s = (i, e, n, a, o) => {
-  if (!window.WayflyerUiCtaSdk)
-    throw new Error("Failed to load WayflyerUiCtaSdk from the script.");
-  const t = window.WayflyerUiCtaSdk;
-  return new t(i, e, n, a, o);
-}, d = (i, e, n, a, o, t) => new Promise((r, l) => {
+const d = "wayflyer-ui-package", l = "https://embedded-finance-frontend.vercel.app/npm/@wf-financing/ui@3", a = (i, t) => {
+  if (!window.WayflyerUiSdk)
+    throw new Error("Failed to load WayflyerUiSdk from the script.");
+  const r = window.WayflyerUiSdk;
+  return new r(i, t);
+}, n = (i, t, r) => new Promise((e, o) => {
   i.onload = () => {
     try {
-      r(s(e, n, a, o, t));
-    } catch (y) {
-      l(y);
+      e(a(t, r));
+    } catch (c) {
+      o(c);
     }
   };
-}), f = async (i, e, n, a, o) => {
+}), y = async (i, t) => {
   try {
-    const t = document.getElementById(c);
-    if (window.WayflyerUiCtaSdk)
-      return s(i, e, n, a, o);
-    if (t)
-      return d(
-        t,
-        i,
-        e,
-        n,
-        a,
-        o
-      );
-    const r = document.createElement("script");
-    return r.src = S, r.type = "module", r.id = c, r.async = !0, document.head.appendChild(r), d(r, i, e, n, a, o);
-  } catch (t) {
-    throw console.error("Error in loading headless SDK:", t), new Error("Failed to load script");
+    const r = document.getElementById(d);
+    if (window.WayflyerUiSdk)
+      return a(i, t);
+    if (r)
+      return n(r, i, t);
+    const e = document.createElement("script");
+    return e.src = l, e.type = "module", e.id = d, e.async = !0, document.head.appendChild(e), n(e, i, t);
+  } catch (r) {
+    throw console.error("Error in loading headless SDK:", r), new Error("Failed to load script");
   }
 };
-class C {
-  static async loadSdk(e, n, a, o, t) {
-    return await f(e, n, a, o, t);
+class s {
+  static async loadSdk(t, r) {
+    return await y(t, r);
   }
 }
 export {
-  w as SdkScenarios,
-  C as WayflyerUiSdk
+  s as WayflyerUiSdk
 };

package/dist/sdk/index.d.ts

@@ -1,5 +1,5 @@
-import { PartnerCallbackType, MockedModeType } from '@wf-financing/embedded-types';
+import { SdkOptionsType, IWayflyerUiSdk } from '@wf-financing/embedded-types';
 
 export declare class WayflyerUiSdk {
-    static loadSdk(targetId: string, partnerDesignId: string, partnerCallback: PartnerCallbackType, companyToken: string, mockedMode?: MockedModeType): Promise<void | import('@wf-financing/embedded-types').IWayflyerUiCtaSdk>;
+    static loadSdk(companyToken: string, options?: SdkOptionsType): Promise<IWayflyerUiSdk>;
 }

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

@@ -1,5 +1,5 @@
-import { IWayflyerUiCtaSdk, PartnerCallbackType, MockedModeType } from '@wf-financing/embedded-types';
+import { IWayflyerUiSdk, SdkOptionsType } from '@wf-financing/embedded-types';
 
-type LoadUiSdkModeType = (targetId: string, partnerDesignId: string, partnerCallback: PartnerCallbackType, companyToken: string, mockedMode?: MockedModeType) => Promise<IWayflyerUiCtaSdk | void>;
+type LoadUiSdkModeType = (companyToken: string, options?: SdkOptionsType) => Promise<IWayflyerUiSdk | void>;
 export declare const loadUiSdkMode: LoadUiSdkModeType;
 export {};

package/dist/utils/initializeUiSdk.d.ts

@@ -1,3 +1,3 @@
-import { IWayflyerUiCtaSdk, PartnerCallbackType, MockedModeType } from '@wf-financing/embedded-types';
+import { IWayflyerUiSdk, SdkOptionsType } from '@wf-financing/embedded-types';
 
-export declare const initializeUiSdk: (targetId: string, partnerDesignId: string, partnerCallback: PartnerCallbackType, companyToken: string, mockedMode?: MockedModeType) => IWayflyerUiCtaSdk;
+export declare const initializeUiSdk: (companyToken: string, options?: SdkOptionsType) => IWayflyerUiSdk;

package/dist/utils/loadScriptAndInitializeSdk.d.ts

@@ -1,3 +1,3 @@
-import { IWayflyerUiCtaSdk, PartnerCallbackType, MockedModeType } from '@wf-financing/embedded-types';
+import { IWayflyerUiSdk, SdkOptionsType } from '@wf-financing/embedded-types';
 
-export declare const loadScriptAndInitializeSdk: (script: HTMLScriptElement, targetId: string, partnerDesignId: string, partnerCallback: PartnerCallbackType, companyToken: string, isMockedMode?: MockedModeType) => Promise<IWayflyerUiCtaSdk>;
+export declare const loadScriptAndInitializeSdk: (script: HTMLScriptElement, companyToken: string, options?: SdkOptionsType) => Promise<IWayflyerUiSdk>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wf-financing/ui-sdk",
-  "version": "0.1.3",
+  "version": "2.0.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,7 @@
     "dist"
   ],
   "dependencies": {
-    "@wf-financing/embedded-types": "0.3.0"
+    "@wf-financing/embedded-types": "0.4.1"
   },
   "devDependencies": {
     "vite": "^6.3.5",