@base316/react 0.1.0 → 0.2.0

package/dist/src/useCollection.d.ts

@@ -0,0 +1,79 @@
+import type { CollectionRecord, CollectionSchema, FieldValue, RecordFilterInput } from "@base316/sdk";
+/**
+ * One collection: its shape, its rows, and how to change them.
+ *
+ * The headless half of every data component. `DataTable`, `RecordForm` and
+ * `RecordDetail` are markup over this, and an application with its own design
+ * system calls it directly and writes its own — which is the escape hatch that
+ * stops a component library from being forked the first time somebody wants a
+ * different table.
+ *
+ * What it does that is worth not rewriting:
+ *
+ * - loads the schema before the rows, because nothing can render a column
+ *   without knowing the field types;
+ * - keeps filters, sort, search and paging in one place, so they compose
+ *   instead of fighting;
+ * - refetches after a write, so a saved row appears where it belongs rather
+ *   than where it was;
+ * - keeps per-field errors from the server, so a form can put each message
+ *   under the input that caused it.
+ */
+export interface UseCollectionOptions {
+    /** Applied on top of whatever the UI sets. For a fixed view of one tenant's data. */
+    filters?: RecordFilterInput[];
+    sort?: {
+        field: string;
+        direction?: "asc" | "desc";
+    };
+    limit?: number;
+    /**
+     * Load one record instead of a page.
+     *
+     * Fetched by id rather than filtered for. `id` is not a schema field, so a
+     * filter naming it is dropped on the server and the caller quietly gets the
+     * first page instead — which works until the record is not on it.
+     */
+    recordId?: string;
+    /**
+     * Which tenant to read and write as.
+     *
+     * Only needed when somebody belongs to several organizations. A user in one
+     * is scoped to it automatically.
+     */
+    tenant?: string;
+}
+export interface UseCollectionResult {
+    /** Null until loaded. */
+    schema: CollectionSchema | null;
+    records: CollectionRecord[];
+    loading: boolean;
+    /** Set when the collection could not be read at all — missing, or forbidden. */
+    error: string | null;
+    /** Total matching rows, for "1–25 of 340". */
+    total: number;
+    /** Whether a further page exists. */
+    hasMore: boolean;
+    /** Whether this viewer may create, edit and delete. False until the schema loads. */
+    canWrite: boolean;
+    search: string;
+    setSearch: (search: string) => void;
+    filters: RecordFilterInput[];
+    setFilters: (filters: RecordFilterInput[]) => void;
+    sort: {
+        field: string;
+        direction?: "asc" | "desc";
+    } | null;
+    /** Ascending, then descending, then off — the order a table header cycles. */
+    toggleSort: (field: string) => void;
+    loadMore: () => void;
+    reload: () => void;
+    /** Per-field messages from the last rejected write. */
+    fieldErrors: Record<string, string>;
+    saving: boolean;
+    create: (fields: Record<string, FieldValue>) => Promise<CollectionRecord | null>;
+    update: (id: string, fields: Record<string, FieldValue>) => Promise<CollectionRecord | null>;
+    remove: (id: string) => Promise<boolean>;
+}
+export declare function useCollection(collection: string, options?: UseCollectionOptions): UseCollectionResult;
+//# sourceMappingURL=useCollection.d.ts.map

package/dist/src/useCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCollection.d.ts","sourceRoot":"","sources":["../../src/useCollection.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACX,gBAAgB,EAChB,gBAAgB,EAChB,UAAU,EACV,iBAAiB,EACjB,MAAM,cAAc,CAAC;AAKtB;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,MAAM,WAAW,oBAAoB;IACpC,qFAAqF;IACrF,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC9B,IAAI,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;KAAE,CAAC;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IACnC,yBAAyB;IACzB,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAChC,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,gFAAgF;IAChF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,OAAO,EAAE,OAAO,CAAC;IACjB,qFAAqF;IACrF,QAAQ,EAAE,OAAO,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAC7B,UAAU,EAAE,CAAC,OAAO,EAAE,iBAAiB,EAAE,KAAK,IAAI,CAAC;IACnD,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC3D,8EAA8E;IAC9E,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAEpC,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,MAAM,EAAE,MAAM,IAAI,CAAC;IAEnB,uDAAuD;IACvD,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IACjF,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAC7F,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CACzC;AAYD,wBAAgB,aAAa,CAC5B,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,oBAAyB,GAChC,mBAAmB,CAiTrB"}

package/dist/src/usePaymentLink.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Watch a payment link until it is paid.
+ *
+ * For the merchant's *screen*, not their server. A webhook tells a backend that
+ * a walk-up customer paid; it cannot tell the tablet propped on the counter with
+ * the QR code on it. This is what flips that screen over.
+ *
+ * A poll rather than a socket, matching the rest of the platform: there is no
+ * streaming endpoint, and a poll is what survives a tablet sleeping and a phone
+ * hopping between wifi and cellular mid-payment.
+ *
+ * Use it with the token you got back from `invoices.createPaymentLink` on your
+ * server. Polling stops on its own once the invoice settles, so a forgotten
+ * component does not keep asking for ever.
+ */
+export type PaymentLinkStatus = {
+    state: "loading";
+} | {
+    state: "payable";
+    number: string;
+    due: string;
+    currency: string;
+} | {
+    state: "settled";
+    number: string;
+}
+/** Unknown, expired, or withdrawn — the API does not say which. */
+ | {
+    state: "invalid";
+};
+export declare function usePaymentLink({ token, environmentId, intervalMs, onPaid, }: {
+    token: string;
+    environmentId: string;
+    /**
+     * How often to ask. The default is chosen against the thing being waited for
+     * — somebody tapping a phone a metre away — rather than against server load.
+     */
+    intervalMs?: number;
+    onPaid?: () => void;
+}): PaymentLinkStatus;
+//# sourceMappingURL=usePaymentLink.d.ts.map

package/dist/src/usePaymentLink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePaymentLink.d.ts","sourceRoot":"","sources":["../../src/usePaymentLink.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,MAAM,iBAAiB,GAC1B;IAAE,KAAK,EAAE,SAAS,CAAA;CAAE,GACpB;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACnE;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE;AACtC,mEAAmE;GACjE;IAAE,KAAK,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB,wBAAgB,cAAc,CAAC,EAC9B,KAAK,EACL,aAAa,EACb,UAAiB,EACjB,MAAM,GACN,EAAE;IACF,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;CACpB,GAAG,iBAAiB,CA+EpB"}

package/dist/src/usePlans.d.ts

@@ -0,0 +1,66 @@
+import type { PublicPlan } from "@base316/sdk";
+/**
+ * The plans, and what happens when somebody picks one — without any markup.
+ *
+ * This is the escape hatch that keeps a component library from being forked.
+ * `PricingTable` is a few dozen lines of JSX over this hook; an application
+ * with its own design system calls the hook directly, renders whatever it
+ * likes, and still gets the part that is easy to get wrong:
+ *
+ * - which plan the signed-in user is actually on,
+ * - whether picking one should prorate in place or collect a card,
+ * - resolving the customer from the session rather than trusting the browser.
+ *
+ * The rule the whole library follows: logic lives in a hook, presentation
+ * lives in a component, and the component is thin enough to be worth
+ * replacing. Fusing the two is what forces a fork the first time somebody
+ * wants a different table.
+ */
+/** What picking a plan did. Returned so a custom UI can respond in kind. */
+export type SelectPlanOutcome = {
+    status: "changed";
+    planVersionId: string;
+} | {
+    status: "checkout";
+    url: string;
+} | {
+    status: "needs-sign-in";
+} | {
+    status: "failed";
+    reason: string;
+};
+export interface UsePlansOptions {
+    /**
+     * Override the plan shown as current.
+     *
+     * Discovered from the signed-in user's subscription when omitted.
+     */
+    currentPlanVersionId?: string | null;
+    /**
+     * Where a checkout URL should send the browser.
+     *
+     * Defaults to navigating. Pass `false` to keep `selectPlan` free of side
+     * effects and handle the URL from the outcome — a modal checkout, a native
+     * shell, or a test.
+     */
+    navigate?: boolean | ((url: string) => void);
+}
+export interface UsePlansResult {
+    /** Null until loaded. Empty means nothing is published yet. */
+    plans: PublicPlan[] | null;
+    loading: boolean;
+    /** True when the catalog could not be read at all. */
+    error: boolean;
+    /** The plan the viewer is on, discovered or supplied. */
+    currentPlanVersionId: string | null;
+    /** The plan version currently being acted on, for a pending state. */
+    busyPlanVersionId: string | null;
+    /** Why the last selection failed, if it did. Cleared on the next attempt. */
+    lastError: string | null;
+    /** Whether there is a session to bill. */
+    signedIn: boolean;
+    selectPlan: (plan: PublicPlan) => Promise<SelectPlanOutcome>;
+    reload: () => void;
+}
+export declare function usePlans(options?: UsePlansOptions): UsePlansResult;
+//# sourceMappingURL=usePlans.d.ts.map

package/dist/src/usePlans.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePlans.d.ts","sourceRoot":"","sources":["../../src/usePlans.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAK/C;;;;;;;;;;;;;;;;GAgBG;AAEH,4EAA4E;AAC5E,MAAM,MAAM,iBAAiB,GAC1B;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,GAC5C;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GACnC;IAAE,MAAM,EAAE,eAAe,CAAA;CAAE,GAC3B;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAExC,MAAM,WAAW,eAAe;IAC/B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,cAAc;IAC9B,+DAA+D;IAC/D,KAAK,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,sDAAsD;IACtD,KAAK,EAAE,OAAO,CAAC;IACf,yDAAyD;IACzD,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,sEAAsE;IACtE,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,6EAA6E;IAC7E,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,0CAA0C;IAC1C,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC7D,MAAM,EAAE,MAAM,IAAI,CAAC;CACnB;AAaD,wBAAgB,QAAQ,CAAC,OAAO,GAAE,eAAoB,GAAG,cAAc,CAyItE"}

package/package.json

@@ -1,52 +1,60 @@
 {
   "name": "@base316/react",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Drop-in React components for Base316 authentication and billing.",
-  "sideEffects": false,
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.ts",
-  "dependencies": {
-    "@base316/sdk": "0.1.0"
-  },
-  "devDependencies": {
-    "@types/react": "19.2.18",
-    "react": "19.2.8",
-    "tsup": "^8.5.0",
-    "typescript": "7.0.2",
-    "vitest": "^5.0.0",
-    "@repo/tsconfig": "0.0.0"
-  },
-  "peerDependencies": {
-    "react": ">=18"
-  },
+  "homepage": "https://base316.com",
+  "bugs": "https://github.com/ThinkfleetAI/base316/issues",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ThinkfleetAI/base316.git",
     "directory": "packages/react"
   },
-  "homepage": "https://base316.com",
-  "bugs": "https://github.com/ThinkfleetAI/base316/issues",
+  "files": [
+    "LICENSE",
+    "CHANGELOG.md",
+    "README.md",
+    "dist"
+  ],
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
   "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
-    }
+    },
+    "./manifest.json": "./dist/manifest.json"
   },
-  "files": [
-    "LICENSE",
-    "README.md",
-    "dist"
-  ],
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@base316/sdk": "0.2.0"
+  },
+  "devDependencies": {
+    "@testing-library/dom": "^10.4.2",
+    "@testing-library/react": "^16.3.3",
+    "@testing-library/user-event": "^14.6.7",
+    "@types/react": "19.2.18",
+    "jsdom": "^30.0.1",
+    "react": "19.2.8",
+    "react-dom": "19.2.8",
+    "tsup": "^8.5.0",
+    "tsx": "^4.23.13",
+    "typescript": "7.0.2",
+    "vitest": "^5.0.0",
+    "@repo/tsconfig": "0.0.0"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
   "scripts": {
-    "build": "tsup && tsc -p tsconfig.build.json",
+    "build": "tsup && tsc -p tsconfig.build.json && tsx scripts/emit-manifest.ts",
     "clean": "git clean -xdf .cache .turbo dist node_modules",
-    "test": "vitest run --passWithNoTests",
+    "test": "vitest run",
     "type-check": "tsc --noEmit"
   }
 }