@wf-financing/headless-sdk 2.0.0 → 3.0.1

package/README.md

@@ -4,15 +4,20 @@ Wayflyer provides a `@wf-financing/headless-sdk` package that can be used as a c
 
 ## 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.
+To minimize bundle size and reduce the impact on partners' page load times, the SDK uses dynamic imports to load the main functionality.
 
 ## Instantiation
-Initialize the Wayflyer headless SDK by passing the `companyToken` and a pointer that specifies whether the SDK should work in mocked mode.
+Initialize the Wayflyer headless SDK by passing the `companyToken` and an optional `options` object with a type of `SdkOptionsType` that specifies additional functionality of SDK instance - e.g. consuming sandbox API instead of the production.
 
 ```jsx
-import { type IHeadlessWayflyerSdk, WayflyerHeadlessSdk } from '@wf-financing/headless-sdk';
+import { WayflyerHeadlessSdk, SdkOptionsType } from '@wf-financing/headless-sdk';
 
-const wayflyerSdk = (await WayflyerHeadlessCtaSdk.loadSdk('token')) as IHeadlessWayflyerSdk;
+// instantiation in production mode
+const wayflyerHeadlessSdk = await WayflyerHeadlessSdk.loadSdk(companyToken);
+
+// instantiation in sandbox mode, `options` type of SdkOptionsType
+const options: SdkOptionsType = { isSandbox: true };
+const wayflyerHeadlessSdk = await WayflyerHeadlessSdk.loadSdk(companyToken, options);
 ```
 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.
 
@@ -47,71 +52,26 @@ Returns a URL to the Wayflyer landing page after the submission of the merchant
 ```jsx
 import type { ContinueHostedApplicationResponseType } from '@wf-financing/headless-sdk';
 
-const startHostedApplication: ContinueHostedApplicationResponseType = await wayflyerSdk.startHostedApplication(merchantData);
+const startHostedApplication: ContinueHostedApplicationResponseType = await wayflyerSdk.continueHostedApplication();
 ```
 
-## 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`.
+### `dismissCta()`
+Dismiss CTA for current combination of company and user.
 
 ```jsx
-import { WayflyerHeadlessCtaSdk } from '@wf-financing/headless-sdk';
-
-const wayflyerSdk = (await WayflyerHeadlessCtaSdk.loadSdk('token', true)) as IHeadlessWayflyerSdk;
+await wayflyerSdk.dismissCta();
 ```
-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.
+## Sandbox
 
-```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.
+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 additional package `@wf-financing/sandbox-ui`.
 
 ```jsx
-import { StartHostedApplicationResponseTypes } from '@wf-financing/headless-sdk';
+import { WayflyerHeadlessSdk, SdkOptionsType } from '@wf-financing/headless-sdk';
 
-wayflyerSdk.setStartHostedApplicationResponse(StartHostedApplicationResponseTypes.REDIRECT_URL);
-wayflyerSdk.setStartHostedApplicationResponse(StartHostedApplicationResponseTypes.BAD_REQUEST);
-wayflyerSdk.setStartHostedApplicationResponse(StartHostedApplicationResponseTypes.INVALID_TOKEN);
+const options: SdkOptionsType = { isSandbox: true };
+const wayflyerSdk = await WayflyerHeadlessSdk.loadSdk(companyToken, options);
 ```
 
-### `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/index.d.ts

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

package/dist/sdk/index.d.ts

@@ -1,5 +1,5 @@
-import { SdkOptionsType } from '@wf-financing/embedded-types';
+import { SdkOptionsType, IWayflyerHeadlessSdk } from '@wf-financing/embedded-types';
 
 export declare class WayflyerHeadlessSdk {
-    static loadSdk(companyToken: string, options?: SdkOptionsType): Promise<void | import('@wf-financing/embedded-types').IHeadlessWayflyerSdk>;
+    static loadSdk(companyToken: string, options?: SdkOptionsType): Promise<IWayflyerHeadlessSdk>;
 }

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

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

package/dist/utils/initializeHeadlessSdk.d.ts

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

package/dist/utils/loadScriptAndInitializeSdk.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wf-financing/headless-sdk",
-  "version": "2.0.0",
+  "version": "3.0.1",
   "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.4.0"
+    "@wf-financing/embedded-types": "0.4.1"
   },
   "devDependencies": {
     "vite": "^6.3.5",