@wf-financing/ui-sdk 2.1.7 → 3.1.0

package/README.md

@@ -12,7 +12,7 @@ To initialize `WayflyerUiSdk`, call the static method `loadSdk` with the followi
 
 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).
+2. `options` (optional) – an object of type `UiSdkOptions` that provides an ability to configure SDK behaviour.
 
 ```jsx
 import { WayflyerUiSdk } from '@wf-financing/ui-sdk';
@@ -26,8 +26,11 @@ const wayflyerUiSdk = await WayflyerUiSdk.loadSdk(companyToken);
 
 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 `StartHostedApplicationRequestType`.
+## `options` parameter
+When initializing the SDK, the options parameter allows you to configure its behavior:
+1) `options.skipAnimations` - by default, animations are enabled for the CTA banner. Set this to true to disable animations.
+2) `options.isSandbox` - enables sandbox (non-production) mode for the SDK.
+3) `options.language` - sets the preferred language for the UI. If not provided, English will be used as the default.
 
 ```jsx
 import { type PartnerCallbackType, type StartHostedApplicationRequestType } from '@wf-financing/ui-sdk';
@@ -48,12 +51,12 @@ The callback may also be used to execute partner-related logic in response to th
 
 ## Sandbox
 
-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`.
+To simplify the testing process, the SDK can be initialized in sandbox mode. To do so, pass the second argument of type `UiSdkOptions` 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`.
 
 ```jsx
-import { WayflyerUiSdk, type SdkOptionsType, type PartnerCallbackType, type StartHostedApplicationRequestType } from '@wf-financing/ui-sdk';
+import { WayflyerUiSdk, type UiSdkOptions, type PartnerCallbackType, type StartHostedApplicationRequestType } from '@wf-financing/ui-sdk';
 
-const options: SdkOptionsType = { isSandbox: true };
+const options: UiSdkOptions = { isSandbox: true };
 const wayflyerUiSdk = await WayflyerUiSdk.loadSdk(companyToken, options);
 
 const partnerCallback: PartnerCallbackType = await () => {

package/dist/config/applicationVersion.d.ts

@@ -0,0 +1 @@
+export declare const APPLICATION_VERSION: string;

package/dist/config/index.d.ts

@@ -1,2 +1,3 @@
 export { WAYFLYER_UI_PACKAGE_ID } from './scriptId';
 export { UI_PACKAGE_URL } from './url';
+export { APPLICATION_VERSION } from './applicationVersion';

package/dist/config/url.d.ts

@@ -1 +1 @@
-export declare const UI_PACKAGE_URL = "https://embedded-finance-frontend.vercel.app/npm/@wf-financing/ui@3";
+export declare const UI_PACKAGE_URL = "https://embedded-finance-frontend.vercel.app/npm/@wf-financing/ui@4";

package/dist/index.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});var h=Object.defineProperty,m=(r,e,t)=>e in r?h(r,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):r[e]=t,c=(r,e,t)=>m(r,typeof e!="symbol"?e+"":e,t);const v="https://api.wayflyer.com",I="https://sandbox-api.wayflyer.com",b=r=>{try{return JSON.parse(atob(r.split(".")[1]))}catch{return null}},y={"Content-Type":"application/json"},u={event:"/financing/v1/company/event/",error:"/financing/v1/error/"},g="wf_session_v1",U=1800*1e3,k=1440*60*1e3;class E{getSessionId(){const e=Date.now();let t=this.loadSession();return(!t||this.isSessionExpired(t,e))&&(t=this.mintNewSession(e)),t.lastActivity=e,this.saveSession(t),t.sessionId}isSessionExpired(e,t){const n=t-e.lastActivity>U,s=t-e.createdAt>k;return n||s}mintNewSession(e){return{sessionId:crypto.randomUUID(),createdAt:e,lastActivity:e}}loadSession(){try{const e=sessionStorage.getItem(g);return e?JSON.parse(e):null}catch{return null}}saveSession(e){try{sessionStorage.setItem(g,JSON.stringify(e))}catch{console.warn("Failed to save session context")}}}const p=class i{constructor(e,t){c(this,"baseUrl",null),c(this,"sessionManager"),this.companyToken=e,this.baseUrl=t?I:v,this.sessionManager=new E}static getGlobalInstance(){return window.WayflyerLogger||null}static setGlobalInstance(e){window.WayflyerLogger=e}static initialize(e,t){i.getGlobalInstance()&&console.warn("Logger re-initialized");const n=new i(e,t==null?void 0:t.isSandbox);i.setGlobalInstance(n)}static getMandatoryProperties(e){const t=b(e),[n,s]=(t==null?void 0:t.sub.split("|"))||[],a=t==null?void 0:t.user_id;return{partnerId:n,companyId:s,userId:a}}static getInstance(){const e=i.getGlobalInstance();if(!e)throw new Error("Logger not initialized. Call initialize() first.");return e}static async logEvent(e,t){if(this.isDevEnvironment)return;const n=i.getInstance(),s=n.sessionManager.getSessionId(),a={...y,Authorization:`Bearer ${n.companyToken}`,"X-Session-ID":s};try{const o={...i.getMandatoryProperties(n.companyToken),...t},l=await fetch(n.baseUrl+u.event,{method:"POST",headers:a,body:JSON.stringify({timestamp:new Date().toISOString(),event_name:e,properties:o})});if(l.status===200)return await l.json()}catch(o){console.error("Failed to log event",o)}}static async logError(e,t){if(this.isDevEnvironment){console.error(e);return}const n=i.getInstance(),s=n.sessionManager.getSessionId(),a={...y,"X-Session-ID":s};try{const o={...i.getMandatoryProperties(n.companyToken),...t},l=await fetch(n.baseUrl+u.error,{method:"POST",headers:a,body:JSON.stringify({timestamp:new Date().toISOString(),message:e,properties:o})});if(l.status===200)return await l.json()}catch(o){console.warn("Failed to log error",o)}}};c(p,"isDevEnvironment",!1);let d=p;const S="wayflyer-ui-package",A="https://embedded-finance-frontend.vercel.app/npm/@wf-financing/ui@3",w=(r,e)=>{if(!window.WayflyerUiSdk)throw new Error("Failed to load WayflyerUiSdk from the script.");const t=window.WayflyerUiSdk;return new t(r,e)},f=(r,e,t)=>new Promise((n,s)=>{r.onload=()=>{try{n(w(e,t))}catch(a){s(a)}}}),D=async(r,e)=>{try{const t=document.getElementById(S);if(window.WayflyerUiSdk)return w(r,e);if(t)return f(t,r,e);const n=document.createElement("script");return n.src=A,n.type="module",n.id=S,n.async=!0,n.onerror=()=>d.logError("Failed to load ui SDK script"),document.head.appendChild(n),f(n,r,e)}catch{throw new Error("Failed to load script")}};class O{static async loadSdk(e,t){d.initialize(e,t);const n=await D(e,t);return d.logEvent("ui_sdk_initialized"),n}}exports.WayflyerUiSdk=O;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});var m=Object.defineProperty,h=(i,e,t)=>e in i?m(i,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):i[e]=t,l=(i,e,t)=>h(i,typeof e!="symbol"?e+"":e,t);const v="https://api.wayflyer.com",I="https://sandbox-api.wayflyer.com",b=i=>{try{return JSON.parse(atob(i.split(".")[1]))}catch{return null}},y={"Content-Type":"application/json"},u={event:"/financing/v1/company/event/",error:"/financing/v1/error/"},g="wf_session_v1",k=1800*1e3,U=1440*60*1e3;class E{getSessionId(){const e=Date.now();let t=this.loadSession();return(!t||this.isSessionExpired(t,e))&&(t=this.mintNewSession(e)),t.lastActivity=e,this.saveSession(t),t.sessionId}isSessionExpired(e,t){const n=t-e.lastActivity>k,s=t-e.createdAt>U;return n||s}mintNewSession(e){return{sessionId:crypto.randomUUID(),createdAt:e,lastActivity:e}}loadSession(){try{const e=sessionStorage.getItem(g);return e?JSON.parse(e):null}catch{return null}}saveSession(e){try{sessionStorage.setItem(g,JSON.stringify(e))}catch{console.warn("Failed to save session context")}}}const w=class a{constructor(e,t){l(this,"baseUrl",null),l(this,"sessionManager"),this.companyToken=e,this.baseUrl=t?I:v,this.sessionManager=new E}static getGlobalInstance(){return window.WayflyerLogger||null}static setGlobalInstance(e){window.WayflyerLogger=e}static initialize(e,t){a.getGlobalInstance()&&console.warn("Logger re-initialized");const n=new a(e,t==null?void 0:t.isSandbox);a.setGlobalInstance(n)}static getMandatoryProperties(e){const t=b(e),[n,s]=(t==null?void 0:t.sub.split("|"))||[],o=t==null?void 0:t.user_id;return{partner_id:n,company_id:s,user_id:o}}static getInstance(){const e=a.getGlobalInstance();if(!e)throw new Error("Logger not initialized. Call initialize() first.");return e}static async logEvent(e,t){if(this.isDevEnvironment)return;const n=a.getInstance(),s=n.sessionManager.getSessionId(),o={...y,Authorization:`Bearer ${n.companyToken}`,"X-Session-ID":s};try{const r={...a.getMandatoryProperties(n.companyToken),...t},c=await fetch(n.baseUrl+u.event,{method:"POST",headers:o,body:JSON.stringify({timestamp:new Date().toISOString(),event_name:e,properties:r})});if(c.status===200)return await c.json()}catch(r){console.error("Failed to log event",r)}}static async logError(e,t){if(this.isDevEnvironment){console.error(e);return}const n=a.getInstance(),s=n.sessionManager.getSessionId(),o={...y,"X-Session-ID":s};try{const r={...a.getMandatoryProperties(n.companyToken),...t},c=await fetch(n.baseUrl+u.error,{method:"POST",headers:o,body:JSON.stringify({timestamp:new Date().toISOString(),message:e,properties:r})});if(c.status===200)return await c.json()}catch(r){console.warn("Failed to log error",r)}}};l(w,"isDevEnvironment",!1);let d=w;const p="wayflyer-ui-package",A="https://embedded-finance-frontend.vercel.app/npm/@wf-financing/ui@4",z="3.1.0",f=(i,e)=>{if(!window.WayflyerUiSdk)throw new Error("Failed to load WayflyerUiSdk from the script.");const t=window.WayflyerUiSdk;return new t(i,e)},S=(i,e,t)=>new Promise((n,s)=>{i.onload=()=>{try{n(f(e,t))}catch(o){s(o)}}}),D=async(i,e)=>{try{const t=document.getElementById(p);if(window.WayflyerUiSdk)return f(i,e);if(t)return S(t,i,e);const n=document.createElement("script");return n.src=A,n.type="module",n.id=p,n.async=!0,n.onerror=()=>d.logError("Failed to load ui SDK script"),document.head.appendChild(n),S(n,i,e)}catch{throw new Error("Failed to load script")}};class O{static async loadSdk(e,t){const n=Date.now();d.initialize(e,t);const s=await D(e,t),r=Date.now()-n;return d.logEvent("ui_sdk_initialized",{entry_point_version:z,sdk_version:(s==null?void 0:s.sdkVersion)??"unknown version",sdk_initialization_latency:r}),s}}exports.WayflyerUiSdk=O;

package/dist/index.d.ts

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

package/dist/index.es.js

@@ -1,7 +1,7 @@
-var h = Object.defineProperty, m = (r, e, t) => e in r ? h(r, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : r[e] = t, l = (r, e, t) => m(r, typeof e != "symbol" ? e + "" : e, t);
-const v = "https://api.wayflyer.com", I = "https://sandbox-api.wayflyer.com", b = (r) => {
+var f = Object.defineProperty, h = (i, e, t) => e in i ? f(i, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : i[e] = t, l = (i, e, t) => h(i, typeof e != "symbol" ? e + "" : e, t);
+const v = "https://api.wayflyer.com", I = "https://sandbox-api.wayflyer.com", k = (i) => {
   try {
-    return JSON.parse(atob(r.split(".")[1]));
+    return JSON.parse(atob(i.split(".")[1]));
   } catch {
     return null;
   }
@@ -10,15 +10,15 @@ const v = "https://api.wayflyer.com", I = "https://sandbox-api.wayflyer.com", b
 }, u = {
   event: "/financing/v1/company/event/",
   error: "/financing/v1/error/"
-}, g = "wf_session_v1", U = 1800 * 1e3, E = 1440 * 60 * 1e3;
-class k {
+}, g = "wf_session_v1", b = 1800 * 1e3, E = 1440 * 60 * 1e3;
+class U {
   getSessionId() {
     const e = Date.now();
     let t = this.loadSession();
     return (!t || this.isSessionExpired(t, e)) && (t = this.mintNewSession(e)), t.lastActivity = e, this.saveSession(t), t.sessionId;
   }
   isSessionExpired(e, t) {
-    const n = t - e.lastActivity > U, s = t - e.createdAt > E;
+    const n = t - e.lastActivity > b, s = t - e.createdAt > E;
     return n || s;
   }
   mintNewSession(e) {
@@ -44,9 +44,9 @@ class k {
     }
   }
 }
-const w = class i {
+const S = class a {
   constructor(e, t) {
-    l(this, "baseUrl", null), l(this, "sessionManager"), this.companyToken = e, this.baseUrl = t ? I : v, this.sessionManager = new k();
+    l(this, "baseUrl", null), l(this, "sessionManager"), this.companyToken = e, this.baseUrl = t ? I : v, this.sessionManager = new U();
   }
   static getGlobalInstance() {
     return window.WayflyerLogger || null;
@@ -55,44 +55,44 @@ const w = class i {
     window.WayflyerLogger = e;
   }
   static initialize(e, t) {
-    i.getGlobalInstance() && console.warn("Logger re-initialized");
-    const n = new i(e, t == null ? void 0 : t.isSandbox);
-    i.setGlobalInstance(n);
+    a.getGlobalInstance() && console.warn("Logger re-initialized");
+    const n = new a(e, t == null ? void 0 : t.isSandbox);
+    a.setGlobalInstance(n);
   }
   static getMandatoryProperties(e) {
-    const t = b(e), [n, s] = (t == null ? void 0 : t.sub.split("|")) || [], a = t == null ? void 0 : t.user_id;
-    return { partnerId: n, companyId: s, userId: a };
+    const t = k(e), [n, s] = (t == null ? void 0 : t.sub.split("|")) || [], o = t == null ? void 0 : t.user_id;
+    return { partner_id: n, company_id: s, user_id: o };
   }
   static getInstance() {
-    const e = i.getGlobalInstance();
+    const e = a.getGlobalInstance();
     if (!e)
       throw new Error("Logger not initialized. Call initialize() first.");
     return e;
   }
   static async logEvent(e, t) {
     if (this.isDevEnvironment) return;
-    const n = i.getInstance(), s = n.sessionManager.getSessionId(), a = {
+    const n = a.getInstance(), s = n.sessionManager.getSessionId(), o = {
       ...y,
       Authorization: `Bearer ${n.companyToken}`,
       "X-Session-ID": s
     };
     try {
-      const o = {
-        ...i.getMandatoryProperties(n.companyToken),
+      const r = {
+        ...a.getMandatoryProperties(n.companyToken),
         ...t
       }, c = await fetch(n.baseUrl + u.event, {
         method: "POST",
-        headers: a,
+        headers: o,
         body: JSON.stringify({
           timestamp: (/* @__PURE__ */ new Date()).toISOString(),
           event_name: e,
-          properties: o
+          properties: r
         })
       });
       if (c.status === 200)
         return await c.json();
-    } catch (o) {
-      console.error("Failed to log event", o);
+    } catch (r) {
+      console.error("Failed to log event", r);
     }
   }
   static async logError(e, t) {
@@ -100,63 +100,68 @@ const w = class i {
       console.error(e);
       return;
     }
-    const n = i.getInstance(), s = n.sessionManager.getSessionId(), a = {
+    const n = a.getInstance(), s = n.sessionManager.getSessionId(), o = {
       ...y,
       "X-Session-ID": s
     };
     try {
-      const o = {
-        ...i.getMandatoryProperties(n.companyToken),
+      const r = {
+        ...a.getMandatoryProperties(n.companyToken),
         ...t
       }, c = await fetch(n.baseUrl + u.error, {
         method: "POST",
-        headers: a,
+        headers: o,
         body: JSON.stringify({
           timestamp: (/* @__PURE__ */ new Date()).toISOString(),
           message: e,
-          properties: o
+          properties: r
         })
       });
       if (c.status === 200)
         return await c.json();
-    } catch (o) {
-      console.warn("Failed to log error", o);
+    } catch (r) {
+      console.warn("Failed to log error", r);
     }
   }
 };
-l(w, "isDevEnvironment", !1);
-let d = w;
-const S = "wayflyer-ui-package", A = "https://embedded-finance-frontend.vercel.app/npm/@wf-financing/ui@3", f = (r, e) => {
+l(S, "isDevEnvironment", !1);
+let d = S;
+const p = "wayflyer-ui-package", A = "https://embedded-finance-frontend.vercel.app/npm/@wf-financing/ui@4", z = "3.1.0", m = (i, e) => {
   if (!window.WayflyerUiSdk)
     throw new Error("Failed to load WayflyerUiSdk from the script.");
   const t = window.WayflyerUiSdk;
-  return new t(r, e);
-}, p = (r, e, t) => new Promise((n, s) => {
-  r.onload = () => {
+  return new t(i, e);
+}, w = (i, e, t) => new Promise((n, s) => {
+  i.onload = () => {
     try {
-      n(f(e, t));
-    } catch (a) {
-      s(a);
+      n(m(e, t));
+    } catch (o) {
+      s(o);
     }
   };
-}), D = async (r, e) => {
+}), D = async (i, e) => {
   try {
-    const t = document.getElementById(S);
+    const t = document.getElementById(p);
     if (window.WayflyerUiSdk)
-      return f(r, e);
+      return m(i, e);
     if (t)
-      return p(t, r, e);
+      return w(t, i, e);
     const n = document.createElement("script");
-    return n.src = A, n.type = "module", n.id = S, n.async = !0, n.onerror = () => d.logError("Failed to load ui SDK script"), document.head.appendChild(n), p(n, r, e);
+    return n.src = A, n.type = "module", n.id = p, n.async = !0, n.onerror = () => d.logError("Failed to load ui SDK script"), document.head.appendChild(n), w(n, i, e);
   } catch {
     throw new Error("Failed to load script");
   }
 };
 class O {
   static async loadSdk(e, t) {
+    const n = Date.now();
     d.initialize(e, t);
-    const n = await D(e, t);
-    return d.logEvent("ui_sdk_initialized"), n;
+    const s = await D(e, t), r = Date.now() - n;
+    return d.logEvent("ui_sdk_initialized", {
+      entry_point_version: z,
+      sdk_version: (s == null ? void 0 : s.sdkVersion) ?? "unknown version",
+      sdk_initialization_latency: r
+    }), s;
   }
 }
 export {

package/dist/sdk/index.d.ts

@@ -1,5 +1,5 @@
-import { IWayflyerUiSdk, SdkOptionsType } from '@wf-financing/embedded-types';
+import { IWayflyerUiSdk, UiSdkOptions } from '@wf-financing/embedded-types';
 
 export declare class WayflyerUiSdk {
-    static loadSdk(companyToken: string, options?: SdkOptionsType): Promise<IWayflyerUiSdk>;
+    static loadSdk(companyToken: string, options?: UiSdkOptions): Promise<IWayflyerUiSdk>;
 }

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

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

package/dist/utils/initializeUiSdk.d.ts

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

package/dist/utils/loadScriptAndInitializeSdk.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wf-financing/ui-sdk",
-  "version": "2.1.7",
+  "version": "3.1.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "types": "dist/index.d.ts",
@@ -15,8 +15,8 @@
     "dist"
   ],
   "dependencies": {
-    "@wf-financing/embedded-types": "0.7.1",
-    "@wf-financing/logger": "1.1.3"
+    "@wf-financing/embedded-types": "1.1.0",
+    "@wf-financing/logger": "2.1.0"
   },
   "devDependencies": {
     "vite": "^6.3.5",