@lucra/sdk 0.1.0

package/dist/generated/types.gen.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export {};

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+import { LucraApi } from "./generated/sdk.gen.js";
+import type { Problem } from "./generated/types.gen.js";
+export type * from "./generated/types.gen.js";
+export type { LucraAppearance, LucraComponent } from "./types.js";
+export type LucraOptions = {
+    /** Act for a client account (`acct_…`) or roster creator (`crtr_…`); or use `lucra.as(account)`. */
+    account?: string;
+    baseUrl?: string;
+};
+/** A failed request: Lucra's problem, with its stable `code` and, when there's a next step, how to `fix` it. */
+export declare class LucraError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly fix?: string;
+    readonly requestId?: string;
+    readonly retryable: boolean;
+    readonly errors: Problem["errors"];
+    constructor(problem: Partial<Problem>, status: number);
+}
+/**
+ * Server-side client, with an API key or an OAuth access token a member granted your app; keep either on your server.
+ * Every method throws a LucraError on failure and resolves to
+ * `{ data, response }`; send `headers: { "Idempotency-Key": … }` on a write you may retry.
+ *
+ *   const lucra = new Lucra(process.env.LUCRA_API_KEY)
+ *   const { data: creator } = await lucra.creators.create({ body: { email: "sam@example.com" } })
+ *   const { data: embed } = await lucra.as(creator.id).embeds.create({ body: { components: ["onboarding"] } })
+ */
+export declare class Lucra extends LucraApi {
+    private readonly apiKey;
+    private readonly options;
+    constructor(apiKey: string, options?: LucraOptions);
+    /** The same client, acting for a brand (`acct_…`) or roster creator (`crtr_…`). */
+    as(account: string): Lucra;
+}
+type Page<T> = {
+    data: {
+        data: T[];
+        nextCursor: string | null;
+    };
+};
+/** Every item of a list, fetching pages as you go: `for await (const creator of paginate((o) => lucra.creators.list(o)))`. */
+export declare function paginate<T, Options extends {
+    query?: object;
+}>(list: (options: Options) => Promise<Page<T>>, options?: NoInfer<Options>): AsyncGenerator<T>;

package/dist/index.js

@@ -0,0 +1,62 @@
+import { createClient, createConfig } from "./generated/client/index.js";
+import { LucraApi } from "./generated/sdk.gen.js";
+import { LUCRA_API_VERSION } from "./version.js";
+/** A failed request: Lucra's problem, with its stable `code` and, when there's a next step, how to `fix` it. */
+export class LucraError extends Error {
+    status;
+    code;
+    fix;
+    requestId;
+    retryable;
+    errors;
+    constructor(problem, status) {
+        super(problem.detail ?? `Lucra returned ${status}.`);
+        this.name = "LucraError";
+        this.status = problem.status ?? status;
+        this.code = problem.code ?? "unknown";
+        this.fix = problem.fix;
+        this.requestId = problem.requestId;
+        this.retryable = problem.retryable ?? false;
+        this.errors = problem.errors ?? [];
+    }
+}
+/**
+ * Server-side client, with an API key or an OAuth access token a member granted your app; keep either on your server.
+ * Every method throws a LucraError on failure and resolves to
+ * `{ data, response }`; send `headers: { "Idempotency-Key": … }` on a write you may retry.
+ *
+ *   const lucra = new Lucra(process.env.LUCRA_API_KEY)
+ *   const { data: creator } = await lucra.creators.create({ body: { email: "sam@example.com" } })
+ *   const { data: embed } = await lucra.as(creator.id).embeds.create({ body: { components: ["onboarding"] } })
+ */
+export class Lucra extends LucraApi {
+    apiKey;
+    options;
+    constructor(apiKey, options = {}) {
+        const client = createClient(createConfig({
+            baseUrl: options.baseUrl ?? "https://api.onlucra.com",
+            auth: apiKey,
+            throwOnError: true,
+            headers: { "Lucra-Version": LUCRA_API_VERSION, ...(options.account ? { "Lucra-Account": options.account } : {}) },
+        }));
+        // A network error or abort has no failed response: it's rethrown as it is.
+        client.interceptors.error.use((error, response) => !response || response.ok ? error
+            : new LucraError(error && typeof error === "object" ? error : {}, response.status));
+        super({ client });
+        this.apiKey = apiKey;
+        this.options = options;
+    }
+    /** The same client, acting for a brand (`acct_…`) or roster creator (`crtr_…`). */
+    as(account) {
+        return new Lucra(this.apiKey, { ...this.options, account });
+    }
+}
+/** Every item of a list, fetching pages as you go: `for await (const creator of paginate((o) => lucra.creators.list(o)))`. */
+export async function* paginate(list, options = {}) {
+    let cursor;
+    do {
+        const { data } = await list({ ...options, query: { ...options.query, cursor } });
+        yield* data.data;
+        cursor = data.nextCursor ?? undefined;
+    } while (cursor);
+}

package/dist/react.d.ts

@@ -0,0 +1,28 @@
+import { type CSSProperties } from "react";
+import { loadLucra, type LucraEmbed, type LucraEventDetail, type LoadLucraOptions } from "./embed.js";
+import type { LucraAppearance } from "./types.js";
+export type { LucraAppearance, LucraComponent, LucraObjectEvent } from "./types.js";
+export type { LucraEventDetail } from "./embed.js";
+/** Pass the result of loadLucra(...) once, above every Lucra component. */
+export declare function LucraProvider({ lucra, children }: {
+    lucra: LucraEmbed;
+    children: React.ReactNode;
+}): import("react").JSX.Element;
+export { loadLucra, type LoadLucraOptions };
+export type LucraComponentProps = {
+    appearance?: LucraAppearance;
+    className?: string;
+    style?: CSSProperties;
+    onReady?: (detail: LucraEventDetail) => void;
+    onChange?: (detail: LucraEventDetail) => void;
+    onComplete?: (detail: LucraEventDetail) => void;
+    onError?: (detail: LucraEventDetail) => void;
+    onClose?: (detail: LucraEventDetail) => void;
+};
+export declare const LucraOnboarding: (props: LucraComponentProps) => import("react").JSX.Element;
+export declare const LucraCreatorPrograms: (props: LucraComponentProps) => import("react").JSX.Element;
+export declare const LucraWallet: (props: LucraComponentProps) => import("react").JSX.Element;
+export declare const LucraPrograms: (props: LucraComponentProps) => import("react").JSX.Element;
+export declare const LucraPayments: (props: LucraComponentProps) => import("react").JSX.Element;
+export declare const LucraAds: (props: LucraComponentProps) => import("react").JSX.Element;
+export declare const LucraMessages: (props: LucraComponentProps) => import("react").JSX.Element;

package/dist/react.js

@@ -0,0 +1,51 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useContext, useEffect, useRef } from "react";
+import { loadLucra } from "./embed.js";
+const LucraContext = createContext(null);
+/** Pass the result of loadLucra(...) once, above every Lucra component. */
+export function LucraProvider({ lucra, children }) {
+    return _jsx(LucraContext.Provider, { value: lucra, children: children });
+}
+export { loadLucra };
+function useLucraComponent(component, props) {
+    const lucra = useContext(LucraContext);
+    const element = useRef(null);
+    const handlers = useRef(props);
+    handlers.current = props;
+    const appearance = JSON.stringify(props.appearance ?? {});
+    const mounted = useRef(null);
+    useEffect(() => {
+        if (!lucra || !element.current)
+            return;
+        const target = element.current;
+        mounted.current = lucra.mount(component, target, { appearance: handlers.current.appearance });
+        const forward = (event) => {
+            const detail = event.detail;
+            const name = event.type.slice("lucra:".length);
+            const key = `on${name[0]?.toUpperCase()}${name.slice(1)}`;
+            const handler = handlers.current[key];
+            if (typeof handler === "function")
+                handler(detail);
+        };
+        const types = ["ready", "change", "complete", "error", "close"].map((type) => `lucra:${type}`);
+        types.forEach((type) => target.addEventListener(type, forward));
+        return () => {
+            types.forEach((type) => target.removeEventListener(type, forward));
+            mounted.current?.unmount();
+            mounted.current = null;
+        };
+    }, [lucra, component]);
+    useEffect(() => {
+        mounted.current?.update(JSON.parse(appearance));
+    }, [appearance]);
+    if (!lucra)
+        throw new Error("Wrap Lucra components in <LucraProvider lucra={loadLucra(...)}>.");
+    return _jsx("div", { ref: element, className: props.className, style: props.style });
+}
+export const LucraOnboarding = (props) => useLucraComponent("onboarding", props);
+export const LucraCreatorPrograms = (props) => useLucraComponent("creator_programs", props);
+export const LucraWallet = (props) => useLucraComponent("wallet", props);
+export const LucraPrograms = (props) => useLucraComponent("programs", props);
+export const LucraPayments = (props) => useLucraComponent("payments", props);
+export const LucraAds = (props) => useLucraComponent("ads", props);
+export const LucraMessages = (props) => useLucraComponent("messages", props);

package/dist/types.d.ts

@@ -0,0 +1,13 @@
+/** The Lucra UI an embed can show: seven components, each a whole job. */
+export type LucraComponent = "onboarding" | "messages" | "creator_programs" | "wallet" | "programs" | "payments" | "ads";
+/** What a component reports with change or complete, alongside the step. */
+export type LucraObjectEvent = "application.created" | "submission.created" | "withdrawal.created" | "profile.updated" | "program.created" | "program.updated" | "application.approved" | "application.rejected" | "submission.approved" | "submission.revision_requested" | "submission.rejected" | "payment.created" | "campaign.created" | "campaign.launched" | "campaign.paused" | "message.sent";
+/** Components look like Lucra's app; pick the theme, your accent color (#rrggbb) and the corner radius. */
+export type LucraAppearance = {
+    theme?: "light" | "dark" | "auto";
+    colors?: {
+        primary?: string;
+    };
+    /** Corner radius in px, 0–24. */
+    radius?: number;
+};

package/dist/types.js

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

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const LUCRA_API_VERSION = "2026-10-01";

package/dist/version.js

@@ -0,0 +1,2 @@
+// Generated by npm run reference:generate in lucra-backend. Do not edit.
+export const LUCRA_API_VERSION = "2026-10-01";

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@lucra/sdk",
+  "version": "0.1.0",
+  "description": "Lucra's server client and embeddable components.",
+  "license": "MIT",
+  "homepage": "https://www.onlucra.com/docs?page=api-introduction",
+  "keywords": [
+    "lucra",
+    "creator marketing",
+    "creator ads",
+    "ugc",
+    "api",
+    "sdk",
+    "typescript"
+  ],
+  "author": "On Lucra, Inc.",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./embed": {
+      "types": "./dist/embed.d.ts",
+      "default": "./dist/embed.js"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "default": "./dist/react.js"
+    }
+  },
+  "scripts": {
+    "generate": "openapi-ts",
+    "build": "rm -rf dist && tsc -p .",
+    "typecheck": "tsc -p . --noEmit",
+    "generate:check": "openapi-ts && git diff --quiet -- src/generated || (echo 'src/generated is stale: run npm run generate.' && exit 1)",
+    "prepublishOnly": "npm run generate:check && npm run build"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@hey-api/openapi-ts": "^0.99.0",
+    "@types/react": "^19.0.0",
+    "typescript": "^5.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}