@stackup-fi/sdk 1.0.11 → 1.0.13

package/README.md

@@ -1,15 +1,38 @@
-# stackup
+# @stackup-fi/sdk
 
-To install dependencies:
+Official TypeScript SDK for Stackup Pay.
+
+## Installation
 
 ```bash
-bun install
+npm install @stackup-fi/sdk
 ```
 
-To run:
+## Usage
 
-```bash
-bun run index.ts
+```typescript
+import { createStackup } from "@stackup-fi/sdk";
+
+const { client } = createStackup({
+  accessToken: process.env.STACKUP_SECRET_KEY,
+});
+
+// Create a product
+const product = await client.product.create({
+  payoutWalletAddress: "0xd4E5aA212d7b9CD781E0708B5A3764c949E4Ce95",
+  chain: "8453",
+  currency: "USDC",
+  amount: 29.99,
+});
+
+// Create a checkout session
+const checkout = await client.checkout.session.create({
+  items: [{ product: product.data.id }],
+});
+
+console.log(checkout.data.url);
 ```
 
-This project was created using `bun init` in bun v1.3.3. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+## API Reference
+
+See [stackup.finance/docs](https://stackup.finance/docs) for full documentation.

package/dist/checkout/checkout.d.ts

@@ -0,0 +1,15 @@
+import type { CheckoutEventMap, CheckoutEvent, CheckoutOptions } from "./types.js";
+export declare class StackupCheckout {
+    private sessionId;
+    private options?;
+    private iframe;
+    private container;
+    private listeners;
+    private origin;
+    constructor(sessionId: string, options?: CheckoutOptions | undefined);
+    mount(selector: string | HTMLElement): void;
+    unmount(): void;
+    on<E extends CheckoutEvent>(event: E, callback: (data: CheckoutEventMap[E]) => void): () => void;
+    private buildUrl;
+    private handleMessage;
+}

package/dist/checkout/checkout.js

@@ -0,0 +1,72 @@
+export class StackupCheckout {
+    sessionId;
+    options;
+    iframe = null;
+    container = null;
+    listeners = new Map();
+    origin;
+    constructor(sessionId, options) {
+        this.sessionId = sessionId;
+        this.options = options;
+        this.origin = options?.baseUrl ?? window.location.origin;
+    }
+    mount(selector) {
+        if (this.iframe)
+            throw new Error("Already mounted. Call unmount() first.");
+        this.container =
+            typeof selector === "string"
+                ? document.querySelector(selector)
+                : selector;
+        if (!this.container)
+            throw new Error("Container not found");
+        this.iframe = document.createElement("iframe");
+        this.iframe.src = this.buildUrl();
+        console.log("iframe", this.iframe.src);
+        this.iframe.style.cssText = "border:none;width:100%;min-height:400px;";
+        this.iframe.allow = "clipboard-write";
+        this.iframe.addEventListener("error", () => {
+            this.listeners
+                .get("error")
+                ?.forEach((cb) => cb({ message: "Failed to load checkout" }));
+        });
+        window.addEventListener("message", this.handleMessage);
+        this.container.appendChild(this.iframe);
+    }
+    unmount() {
+        if (!this.iframe)
+            return;
+        window.removeEventListener("message", this.handleMessage);
+        this.iframe.remove();
+        this.iframe = null;
+        this.container = null;
+        this.listeners.clear();
+    }
+    on(event, callback) {
+        if (!this.listeners.has(event))
+            this.listeners.set(event, new Set());
+        this.listeners.get(event).add(callback);
+        return () => this.listeners.get(event)?.delete(callback);
+    }
+    buildUrl() {
+        const url = new URL(`/c/${this.sessionId}`, this.origin);
+        url.searchParams.set("embedded", "1");
+        url.searchParams.set("origin", window.location.origin);
+        if (this.options?.theme) {
+            url.searchParams.set("theme", JSON.stringify(this.options.theme));
+        }
+        return url.toString();
+    }
+    handleMessage = (event) => {
+        if (event.origin !== this.origin)
+            return;
+        if (event.source !== this.iframe?.contentWindow)
+            return;
+        const { type, data } = event.data ?? {};
+        if (!type || !this.listeners.has(type))
+            return;
+        this.listeners.get(type)?.forEach((cb) => cb(data));
+        if (type === "resize" && this.iframe && data?.height) {
+            this.iframe.style.height = `${data.height}px`;
+        }
+    };
+}

package/dist/checkout/index.d.ts

@@ -0,0 +1,5 @@
+export type { CheckoutOptions, CheckoutTheme, CheckoutEventMap, CheckoutEvent, CompleteEvent, ErrorEvent, CancelledEvent, ResizeEvent, } from "./types.js";
+export { StackupCheckout } from "./checkout.js";
+import type { CheckoutOptions } from "./types.js";
+import { StackupCheckout } from "./checkout.js";
+export declare function loadStackupCheckout(sessionId: string, options?: CheckoutOptions): StackupCheckout;

package/dist/checkout/index.js

@@ -0,0 +1,5 @@
+export { StackupCheckout } from "./checkout.js";
+import { StackupCheckout } from "./checkout.js";
+export function loadStackupCheckout(sessionId, options) {
+    return new StackupCheckout(sessionId, options);
+}

package/dist/checkout/types.d.ts

@@ -0,0 +1,31 @@
+export interface CheckoutTheme {
+    primary?: string;
+    background?: string;
+    radius?: "none" | "sm" | "md" | "lg" | "full";
+    font?: string;
+}
+export interface CheckoutOptions {
+    baseUrl?: string;
+    theme?: Partial<CheckoutTheme>;
+}
+export interface CompleteEvent {
+    sessionId: string;
+    transactionHash: string;
+}
+export interface ErrorEvent {
+    message: string;
+}
+export interface CancelledEvent {
+    reason: "user_rejected";
+}
+export interface ResizeEvent {
+    height: number;
+}
+export type CheckoutEventMap = {
+    ready: undefined;
+    complete: CompleteEvent;
+    error: ErrorEvent;
+    cancelled: CancelledEvent;
+    resize: ResizeEvent;
+};
+export type CheckoutEvent = keyof CheckoutEventMap;

package/dist/checkout/types.js

@@ -0,0 +1 @@
+export {};

package/dist/index.js

@@ -6,7 +6,7 @@ export function createStackup(options) {
         headers: {
             Authorization: `Bearer ${options.accessToken}`,
         },
-        baseUrl: options.baseUrl ?? "https://api.stackup.finance",
+        baseUrl: options.baseUrl ?? process.env.STACKUP_BASE_URL ?? "https://api.stackup.finance",
     });
     return {
         client,

package/dist/notify/notify.d.ts

@@ -1,4 +1,3 @@
-import { type CheckArgs, type CheckResult, type WebhookArgs } from "./types.js";
+import { type WebhookArgs } from "./types.js";
 export * from "./types.js";
-export declare function notify(args: CheckArgs): Promise<CheckResult>;
-export declare function notify(args: WebhookArgs): (req: Request) => Promise<Response>;
+export declare function notify(config: WebhookArgs): (req: Request) => Promise<Response>;

package/dist/notify/notify.js

@@ -1,28 +1,7 @@
-import { createClient } from "../v1/gen/client/client.gen.js";
-import { StackupClient } from "../v1/gen/sdk.gen.js";
 import { verifyTimestamp } from "./util.js";
 export * from "./types.js";
 const DEFAULT_TOLERANCE = 300; // 5 minutes
-export function notify(args) {
-    if (args.mode === "check")
-        return check(args);
-    return webhook(args);
-}
-async function check(args) {
-    const client = new StackupClient({
-        client: createClient({
-            baseUrl: args.baseUrl ?? "https://api.stackup.finance",
-            headers: {
-                Authorization: `Bearer ${args.accessToken}`,
-            },
-        }),
-    });
-    return client.customer.check({
-        customerID: args.customerID,
-        productID: args.productID,
-    });
-}
-function webhook(config) {
+export function notify(config) {
     const tolerance = config.tolerance ?? DEFAULT_TOLERANCE;
     return async (req) => {
         const timestamp = req.headers.get("x-webhook-timestamp");

package/dist/notify/types.d.ts

@@ -1,7 +1,5 @@
 type Address = `0x${string}`;
 type Hex = `0x${string}`;
-import type { CustomerCheckErrors, CustomerCheckResponses } from "../v1/gen/types.gen.js";
-import type { RequestResult } from "../v1/gen/client/types.gen.js";
 type Prettify<T> = {
     [K in keyof T]: Prettify<T[K]>;
 } & {};
@@ -26,20 +24,11 @@ export type WebhookEvent = Prettify<{
         payment: Payment;
     };
 }>;
-export interface CheckArgs {
-    mode: "check";
-    accessToken: string;
-    customerID: string;
-    productID: string;
-    baseUrl?: string;
-}
 export interface WebhookArgs {
-    mode: "webhook";
     secret: string;
     tolerance?: number;
     handler: WebhookHandler;
 }
-export type CheckResult = RequestResult<CustomerCheckResponses, CustomerCheckErrors, false>;
 export type WebhookHandler = (event: WebhookEvent) => Promise<void>;
 export declare class WebhookError extends Error {
     code: "invalid_signature" | "invalid_timestamp" | "invalid_payload";

package/dist/v1/gen/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import { type Client, type Options as Options2, type TDataShape } from "./client/index.js";
-import type { CheckoutSessionCreateErrors, CheckoutSessionCreateResponses, CustomerCheckErrors, CustomerCheckResponses, CustomerCreateErrors, CustomerCreateResponses, CustomerDeleteErrors, CustomerDeleteResponses, CustomerGetErrors, CustomerGetResponses, CustomerListResponses, CustomerUpdateErrors, CustomerUpdateResponses, ProductCreateErrors, ProductCreateResponses, ProductDeleteErrors, ProductDeleteResponses, ProductGetErrors, ProductGetResponses, ProductListResponses, ProductUpdateErrors, ProductUpdateResponses } from "./types.gen.js";
+import type { CheckoutSessionCreateErrors, CheckoutSessionCreateResponseForType, CustomerCheckErrors, CustomerCheckResponses, CustomerCreateErrors, CustomerCreateResponses, CustomerDeleteErrors, CustomerDeleteResponses, CustomerGetErrors, CustomerGetResponses, CustomerListResponses, CustomerUpdateErrors, CustomerUpdateResponses, ProductCreateErrors, ProductCreateResponses, ProductDeleteErrors, ProductDeleteResponses, ProductGetErrors, ProductGetResponses, ProductListResponses, ProductUpdateErrors, ProductUpdateResponses } from "./types.gen.js";
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -86,15 +86,10 @@ export declare class Product extends HeyApiClient {
      * Create a new product
      */
     create<ThrowOnError extends boolean = false>(parameters?: {
-        id?: string;
         payoutWalletAddress?: string;
         chain?: "1" | "8453";
         currency?: "USDC";
         amount?: number;
-        supply?: number | null;
-        name?: string;
-        description?: string | null;
-        tokens?: Array<string> | null;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProductCreateResponses, ProductCreateErrors, ThrowOnError, "fields">;
     /**
      * List products
@@ -147,57 +142,23 @@ export declare class Session extends HeyApiClient {
     /**
      * Create checkout session
      *
-     * Generate a checkout session URL for one or more products. Customer is optional - if not provided, a customer will be created from the buyer's wallet address at payment time.
+     * Generate a checkout session URL for one or more products.
      *
      * ```ts
      * const session = await client.checkout.session.create({
-     * items: [
-     * { product: "prd_01ABC123", qty: 1 },
-     * { product: "prd_01DEF456", qty: 2 },
-     * ],
-     * customer: "cus_01DEF456", // optional
-     * theme: {
-     * primary: { light: "#7c3aed", dark: "#a78bfa" },
-     * background: { light: "#ffffff", dark: "#0b1220" },
-     * radius: "lg",
-     * }
+     * items: [{ product: "prd_01ABC123" }],
      * });
      * console.log(session.url);
      * ```
      */
-    create<ThrowOnError extends boolean = false>(parameters?: {
+    create<T extends "hosted" | "embedded" | undefined = undefined, ThrowOnError extends boolean = false>(parameters?: {
+        type?: T;
         items?: Array<{
             product: string;
-            mode?: "required" | "optional" | "pick";
-            quantity?: number;
-            default?: boolean;
-            editable?: boolean;
-            max?: number | null;
-            group?: string | null;
         }>;
-        customer?: string | null;
-        theme?: {
-            primary?: string | {
-                light: string;
-                dark: string;
-            };
-            background?: string | {
-                light: string;
-                dark: string;
-            };
-            radius?: "none" | "sm" | "md" | "lg" | "full";
-            font?: {
-                family?: string;
-                scale?: string;
-            };
-            logo?: string | {
-                light: string;
-                dark: string;
-            };
-            favicon?: string;
-            css?: string;
-        } | null;
-    }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<CheckoutSessionCreateResponses, CheckoutSessionCreateErrors, ThrowOnError, "fields">;
+    }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<{
+        200: CheckoutSessionCreateResponseForType<T>;
+    }, CheckoutSessionCreateErrors, ThrowOnError, "fields">;
 }
 export declare class Checkout extends HeyApiClient {
     private _session?;

package/dist/v1/gen/sdk.gen.js

@@ -140,15 +140,10 @@ export class Product extends HeyApiClient {
         const params = buildClientParams([parameters], [
             {
                 args: [
-                    { in: "body", key: "id" },
                     { in: "body", key: "payoutWalletAddress" },
                     { in: "body", key: "chain" },
                     { in: "body", key: "currency" },
                     { in: "body", key: "amount" },
-                    { in: "body", key: "supply" },
-                    { in: "body", key: "name" },
-                    { in: "body", key: "description" },
-                    { in: "body", key: "tokens" },
                 ],
             },
         ]);
@@ -250,20 +245,11 @@ export class Session extends HeyApiClient {
     /**
      * Create checkout session
      *
-     * Generate a checkout session URL for one or more products. Customer is optional - if not provided, a customer will be created from the buyer's wallet address at payment time.
+     * Generate a checkout session URL for one or more products.
      *
      * ```ts
      * const session = await client.checkout.session.create({
-     * items: [
-     * { product: "prd_01ABC123", qty: 1 },
-     * { product: "prd_01DEF456", qty: 2 },
-     * ],
-     * customer: "cus_01DEF456", // optional
-     * theme: {
-     * primary: { light: "#7c3aed", dark: "#a78bfa" },
-     * background: { light: "#ffffff", dark: "#0b1220" },
-     * radius: "lg",
-     * }
+     * items: [{ product: "prd_01ABC123" }],
      * });
      * console.log(session.url);
      * ```
@@ -272,9 +258,8 @@ export class Session extends HeyApiClient {
         const params = buildClientParams([parameters], [
             {
                 args: [
+                    { in: "body", key: "type" },
                     { in: "body", key: "items" },
-                    { in: "body", key: "customer" },
-                    { in: "body", key: "theme" },
                 ],
             },
         ]);

package/dist/v1/gen/types.gen.d.ts

@@ -193,7 +193,6 @@ export type CustomerCheckResponses = {
 export type CustomerCheckResponse = CustomerCheckResponses[keyof CustomerCheckResponses];
 export type ProductCreateData = {
     body?: {
-        id?: string;
         /**
          * Ethereum address for payouts
          */
@@ -201,10 +200,6 @@ export type ProductCreateData = {
         chain: "1" | "8453";
         currency: "USDC";
         amount: number;
-        supply?: number | null;
-        name?: string;
-        description?: string | null;
-        tokens?: Array<string> | null;
     };
     path?: never;
     query?: never;
@@ -433,37 +428,10 @@ export type ProductUpdateResponses = {
 export type ProductUpdateResponse = ProductUpdateResponses[keyof ProductUpdateResponses];
 export type CheckoutSessionCreateData = {
     body?: {
+        type?: "hosted" | "embedded";
         items: Array<{
             product: string;
-            mode?: "required" | "optional" | "pick";
-            quantity?: number;
-            default?: boolean;
-            editable?: boolean;
-            max?: number | null;
-            group?: string | null;
         }>;
-        customer?: string | null;
-        theme?: {
-            primary?: string | {
-                light: string;
-                dark: string;
-            };
-            background?: string | {
-                light: string;
-                dark: string;
-            };
-            radius?: "none" | "sm" | "md" | "lg" | "full";
-            font?: {
-                family?: string;
-                scale?: string;
-            };
-            logo?: string | {
-                light: string;
-                dark: string;
-            };
-            favicon?: string;
-            css?: string;
-        } | null;
     };
     path?: never;
     query?: never;
@@ -486,7 +454,19 @@ export type CheckoutSessionCreateResponses = {
      */
     200: {
         id: string;
+        type: "hosted";
         url: string;
+    } | {
+        id: string;
+        type: "embedded";
     };
 };
 export type CheckoutSessionCreateResponse = CheckoutSessionCreateResponses[keyof CheckoutSessionCreateResponses];
+export type CheckoutSessionCreateResponseForType<T extends "hosted" | "embedded" | undefined> = T extends "embedded" ? {
+    id: string;
+    type: "embedded";
+} : {
+    id: string;
+    type: "hosted";
+    url: string;
+};

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@stackup-fi/sdk",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "module": "index.ts",
   "type": "module",
   "exports": {
     ".": {
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
+    },
+    "./checkout": {
+      "import": "./dist/checkout/index.js",
+      "types": "./dist/checkout/index.d.ts"
     }
   },
   "scripts": {