@rezfiliate/sdk 0.0.0-stage → 1.0.2

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# @rezfiliate/sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Typed browser loader for the Rezfiliate Stripe, Paddle, and Lemon Squeezy storefront SDKs.
+
+## Install
+
+```sh
+npm install @rezfiliate/sdk
+```
+
+## Load the storefront SDK
+
+Call `Rezfiliate` in browser code. It loads the selected hosted script, returns the typed API, and reuses the script if that integration is already loaded.
+
+```ts
+import { Rezfiliate } from "@rezfiliate/sdk";
+
+const rezfiliate = await Rezfiliate("stripe");
+await rezfiliate.ready;
+
+const attribution = rezfiliate.attachAttribution();
+await rezfiliate.track("signup");
+```
+
+Supported platforms are `stripe`, `paddle`, and `lemonsqueezy`. The package loads hosted scripts from `https://rezfiliate.com/sdk/`.

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+export type RezfiliatePlatform = "stripe" | "paddle" | "lemonsqueezy";
+export type ConsentState = "granted" | "denied" | "unknown";
+export type ConversionType = "signup" | "sign_up" | "purchase" | "refund" | "subscription_started" | "subscription_renewed" | "subscription_cancelled" | "subscription_ended";
+export interface Attribution {
+    ref_code?: string;
+    click_id?: string;
+}
+export interface RezfiliateApi {
+    readonly platform: RezfiliatePlatform;
+    readonly ready: Promise<void>;
+    getClickId(): string | null;
+    getReferralCode(): string | null;
+    attachAttribution<T extends Record<string, unknown> = Record<string, unknown>>(existing?: T): T & Attribution;
+    track(type: ConversionType, amount?: number): Promise<boolean>;
+    setConsent(consent: ConsentState): void;
+    getConsent(): ConsentState;
+    setupBanner(): void;
+}
+export interface RezfiliateConfig {
+    domain?: string;
+    showBanner?: boolean;
+    bannerText?: string;
+    bannerBgColor?: string;
+    bannerTextColor?: string;
+}
+declare global {
+    interface Window {
+        Rezfiliate?: RezfiliateApi;
+        RezfiliateConfig?: RezfiliateConfig;
+    }
+}
+/** Loads the matching browser SDK and returns its common typed global API. */
+export declare function Rezfiliate(platform: RezfiliatePlatform): Promise<RezfiliateApi>;

package/dist/index.js

@@ -0,0 +1,88 @@
+const SDK_ORIGIN = "https://rezfiliate.com";
+const pendingLoads = new Map();
+function isApi(value, platform) {
+    if (!value || typeof value !== "object")
+        return false;
+    const api = value;
+    return api.platform === platform &&
+        !!api.ready && typeof api.ready.then === "function" &&
+        typeof api.getClickId === "function" &&
+        typeof api.getReferralCode === "function" &&
+        typeof api.attachAttribution === "function" &&
+        typeof api.track === "function" &&
+        typeof api.setConsent === "function" &&
+        typeof api.getConsent === "function" &&
+        typeof api.setupBanner === "function";
+}
+function sdkUrl(platform) {
+    return new URL(`/sdk/${platform}.js`, SDK_ORIGIN).toString();
+}
+function findScript(url) {
+    const expected = new URL(url);
+    return Array.from(document.scripts).find((script) => {
+        if (!script.src)
+            return false;
+        try {
+            const actual = new URL(script.src, document.baseURI);
+            return actual.origin === expected.origin && actual.pathname === expected.pathname;
+        }
+        catch {
+            return false;
+        }
+    });
+}
+/** Loads the matching browser SDK and returns its common typed global API. */
+export function Rezfiliate(platform) {
+    if (typeof window === "undefined" || typeof document === "undefined") {
+        return Promise.reject(new Error("Rezfiliate can only run in a browser."));
+    }
+    const existingApi = window.Rezfiliate;
+    if (existingApi?.platform && existingApi.platform !== platform) {
+        return Promise.reject(new Error(`The ${existingApi.platform} Rezfiliate SDK is already loaded on this page.`));
+    }
+    if (isApi(existingApi, platform))
+        return Promise.resolve(existingApi);
+    const url = sdkUrl(platform);
+    const cached = pendingLoads.get(url);
+    if (cached)
+        return cached;
+    const loading = new Promise((resolve, reject) => {
+        let script = findScript(url);
+        const isNewScript = !script;
+        if (!script) {
+            script = document.createElement("script");
+            script.src = url;
+            script.async = true;
+            script.dataset.rezfiliatePlatform = platform;
+        }
+        const timeout = window.setTimeout(() => {
+            cleanup();
+            reject(new Error(`Timed out loading the Rezfiliate ${platform} SDK.`));
+        }, 20000);
+        const cleanup = () => {
+            window.clearTimeout(timeout);
+            script?.removeEventListener("load", onLoad);
+            script?.removeEventListener("error", onError);
+        };
+        const onLoad = () => {
+            cleanup();
+            const api = window.Rezfiliate;
+            if (!isApi(api, platform)) {
+                reject(new Error(`The Rezfiliate ${platform} SDK loaded without its expected API.`));
+                return;
+            }
+            resolve(api);
+        };
+        const onError = () => {
+            cleanup();
+            reject(new Error(`Could not load the Rezfiliate ${platform} SDK from ${url}.`));
+        };
+        script.addEventListener("load", onLoad, { once: true });
+        script.addEventListener("error", onError, { once: true });
+        if (isNewScript)
+            document.head.appendChild(script);
+    });
+    pendingLoads.set(url, loading);
+    loading.catch(() => pendingLoads.delete(url));
+    return loading;
+}

package/package.json

@@ -1,6 +1,29 @@
 {
   "name": "@rezfiliate/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.2",
+  "description": "Typed browser loader and API for Rezfiliate storefront SDKs",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}