@wf-financing/logger 1.0.0

package/README.md

@@ -0,0 +1,50 @@
+# Wayflyer Embedded Finance Logger
+
+The `@wf-financing/logger` package provides a singleton logging utility. It allows logging business events and errors.
+
+## Usage
+
+Before logging any events or errors, the Logger must be initialized. This usually happens at the entry point of your application.
+
+The Logger utilizes a global singleton pattern to ensure the instance is shared across different bundles (e.g., between your main application and injected UI scripts).
+
+```jsx
+import { Logger } from '@wf-financing/logger';
+import { SdkOptionsType } from '@wf-financing/types';
+
+const companyToken = 'your-company-token';
+
+// Optional: Configure for Sandbox environment
+const options: SdkOptionsType = { isSandbox: true };
+
+// Initialize the singleton
+Logger.initialize(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.
+
+## Logging Events & Errors
+
+Once initialized, you can import Logger anywhere in your application (or in separate bundles loaded on the same page) to log data.
+
+```jsx
+import { Logger } from '@wf-financing/logger';
+
+// Log a standard event
+await Logger.logEvent('banner_viewed', {
+  user_id: 123,
+});
+
+// Log an error
+try {
+  // ... some operation
+} catch (err) {
+  await Logger.logError('failed_to_load_financing', {
+    error_message: err.message,
+  });
+}
+```
+
+## Shared Scope
+
+This package uses the global window scope to store the Logger instance `window.WayflyerLogger`. This ensures that if you are loading multiple bundles (e.g., a main SDK and a dynamic UI script), they all share the same Logger instance without needing to re-initialize or pass tokens manually.

package/dist/config/index.d.ts

@@ -0,0 +1 @@
+export { API_BASE_URL, SANDBOX_API_BASE_URL } from './urls';

package/dist/config/urls.d.ts

@@ -0,0 +1,2 @@
+export declare const API_BASE_URL: any;
+export declare const SANDBOX_API_BASE_URL: any;

package/dist/index.cjs.js

@@ -0,0 +1 @@
+"use strict";var y=Object.defineProperty;var d=(s,t,e)=>t in s?y(s,t,{enumerable:!0,configurable:!0,writable:!0,value:e}):s[t]=e;var i=(s,t,e)=>d(s,typeof t!="symbol"?t+"":t,e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const g="https://api.wayflyer.com",f="https://sandbox-api.wayflyer.com",c={"Content-Type":"application/json"},l={event:"/financing/v1/company/event/",error:"/financing/v1/error/"};class n{constructor(t,e){i(this,"baseUrl",null);this.companyToken=t,this.baseUrl=e?f:g}static getGlobalInstance(){return window.WayflyerLogger||null}static setGlobalInstance(t){window.WayflyerLogger=t}static initialize(t,e){n.getGlobalInstance()&&console.warn("Logger re-initialized");const a=new n(t,e==null?void 0:e.isSandbox);n.setGlobalInstance(a)}static getInstance(){const t=n.getGlobalInstance();if(!t)throw new Error("Logger not initialized. Call initialize() first.");return t}static async logEvent(t,e){const a=n.getInstance(),r={...c,Authorization:`Bearer ${a.companyToken}`};try{const o=await fetch(a.baseUrl+l.event,{method:"POST",headers:r,body:JSON.stringify({timestamp:new Date().toISOString(),event_name:t,properties:e||{}})});if(o.status===200)return await o.json()}catch(o){console.error("Failed to log event",o)}}static async logError(t,e){const a=n.getInstance();try{const r=await fetch(a.baseUrl+l.error,{method:"POST",headers:c,body:JSON.stringify({timestamp:new Date().toISOString(),message:t,properties:e||{}})});if(r.status===200)return await r.json()}catch(r){console.error("Failed to log error",r)}}}exports.Logger=n;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { Logger } from './logger';

package/dist/index.es.js

@@ -0,0 +1,74 @@
+var y = Object.defineProperty;
+var d = (s, t, e) => t in s ? y(s, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : s[t] = e;
+var i = (s, t, e) => d(s, typeof t != "symbol" ? t + "" : t, e);
+const f = "https://api.wayflyer.com", p = "https://sandbox-api.wayflyer.com", c = {
+  "Content-Type": "application/json"
+}, l = {
+  event: "/financing/v1/company/event/",
+  error: "/financing/v1/error/"
+};
+class n {
+  constructor(t, e) {
+    i(this, "baseUrl", null);
+    this.companyToken = t, this.baseUrl = e ? p : f;
+  }
+  static getGlobalInstance() {
+    return window.WayflyerLogger || null;
+  }
+  static setGlobalInstance(t) {
+    window.WayflyerLogger = t;
+  }
+  static initialize(t, e) {
+    n.getGlobalInstance() && console.warn("Logger re-initialized");
+    const a = new n(t, e == null ? void 0 : e.isSandbox);
+    n.setGlobalInstance(a);
+  }
+  static getInstance() {
+    const t = n.getGlobalInstance();
+    if (!t)
+      throw new Error("Logger not initialized. Call initialize() first.");
+    return t;
+  }
+  static async logEvent(t, e) {
+    const a = n.getInstance(), r = {
+      ...c,
+      Authorization: `Bearer ${a.companyToken}`
+    };
+    try {
+      const o = await fetch(a.baseUrl + l.event, {
+        method: "POST",
+        headers: r,
+        body: JSON.stringify({
+          timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+          event_name: t,
+          properties: e || {}
+        })
+      });
+      if (o.status === 200)
+        return await o.json();
+    } catch (o) {
+      console.error("Failed to log event", o);
+    }
+  }
+  static async logError(t, e) {
+    const a = n.getInstance();
+    try {
+      const r = await fetch(a.baseUrl + l.error, {
+        method: "POST",
+        headers: c,
+        body: JSON.stringify({
+          timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+          message: t,
+          properties: e || {}
+        })
+      });
+      if (r.status === 200)
+        return await r.json();
+    } catch (r) {
+      console.error("Failed to log error", r);
+    }
+  }
+}
+export {
+  n as Logger
+};

package/dist/logger/const.d.ts

@@ -0,0 +1,7 @@
+export declare const defaultHeaders: {
+    'Content-Type': string;
+};
+export declare const endpoints: {
+    event: string;
+    error: string;
+};

package/dist/logger/index.d.ts

@@ -0,0 +1,17 @@
+import { SdkOptionsType } from '@wf-financing/embedded-types';
+
+type Properties = {
+    [key: string]: string | number | null;
+};
+export declare class Logger {
+    private readonly companyToken;
+    private readonly baseUrl;
+    private constructor();
+    private static getGlobalInstance;
+    private static setGlobalInstance;
+    static initialize(companyToken: string, options?: SdkOptionsType): void;
+    private static getInstance;
+    static logEvent(event_name: string, options?: Properties): Promise<void | any>;
+    static logError(message: string, options?: Properties): Promise<void | any>;
+}
+export {};

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,31 @@
+{
+  "name": "@wf-financing/logger",
+  "version": "1.0.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.6.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "vite build",
+    "prepare-logger": "pnpm clean && pnpm build && pnpm pack",
+    "publish-logger": "pnpm clean && pnpm build && pnpm publish --access public --no-git-checks",
+    "test": "vitest",
+    "test:coverage": "vitest --coverage"
+  }
+}