@schematichq/schematic-react 1.7.0 → 1.8.0

package/dist/schematic-react.cjs.js

@@ -36,6 +36,7 @@ __export(index_exports, {
   INVOICE_PAGE_SIZE: () => INVOICE_PAGE_SIZE,
   InvoiceStatus: () => InvoiceStatus,
   RuleType: () => RuleType,
+  SINGLETON: () => SINGLETON,
   Schematic: () => Schematic,
   SchematicI18nContext: () => SchematicI18nContext,
   SchematicI18nProvider: () => SchematicI18nProvider,
@@ -57,7 +58,8 @@ __export(index_exports, {
   useSchematicLocale: () => useSchematicLocale,
   useSchematicPlan: () => useSchematicPlan,
   useSchematicStrings: () => useSchematicStrings,
-  useSchematicTranslate: () => useSchematicTranslate
+  useSchematicTranslate: () => useSchematicTranslate,
+  useUpcomingInvoice: () => useUpcomingInvoice
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -1210,6 +1212,7 @@ function contextString(context) {
   return JSON.stringify(sortedContext);
 }
 var version = "1.8.0";
+var SINGLETON = {};
 var models_exports = {};
 __export2(models_exports, {
   ApiErrorFromJSON: () => ApiErrorFromJSON,
@@ -3996,33 +3999,40 @@ var BillingStore = class {
   constructor(_client, initialData = {}, options = {}) {
     this._client = _client;
     this._pageSize = options.pageSize ?? INVOICE_PAGE_SIZE;
+    const readiness = () => this._connected ? READINESS[this._client.sessionStatus] : "waiting";
     this.invoices = new KeyedResource(
       (query, current) => this._reloadWindow(
         query,
         Math.max(this._pageSize, current?.invoices.length ?? 0)
       ),
-      // Waiting until connected; then a session still pending stays
-      // pending, and one that has ended settles empty rather than recording
-      // the client's refusal as an error.
-      {
-        readiness: () => this._connected ? READINESS[this._client.sessionStatus] : "waiting"
-      }
+      { readiness }
     );
+    this.upcomingInvoice = new KeyedResource(
+      () => this._client.fetchUpcomingInvoice(),
+      { readiness }
+    );
+    const held = { key: initialData.sessionKey };
     if (initialData.invoices !== void 0) {
-      this._held = {
+      held.invoices = {
         // Normalized the way the hook normalizes, or the caller asking for
         // it fetches the same page again.
         params: normalizeInvoiceQuery2(
           initialData.params?.invoices ?? DEFAULT_INVOICE_QUERY
         ),
-        data: initialData.invoices,
-        key: initialData.sessionKey
+        data: initialData.invoices
       };
+    }
+    if (initialData.upcomingInvoice !== void 0) {
+      held.upcomingInvoice = initialData.upcomingInvoice;
+    }
+    if (held.invoices !== void 0 || held.upcomingInvoice !== void 0) {
+      this._held = held;
       this._settleSeed(claimFrom(options.session) ?? claimOf(this._client));
     }
   }
   _client;
   invoices;
+  upcomingInvoice;
   _pageSize;
   _unsubscribe;
   _connected = false;
@@ -4092,7 +4102,12 @@ var BillingStore = class {
     }
     this._held = void 0;
     if (verdict === "adopt") {
-      this.invoices.seed(held.params, held.data);
+      if (held.invoices !== void 0) {
+        this.invoices.seed(held.invoices.params, held.invoices.data);
+      }
+      if (held.upcomingInvoice !== void 0) {
+        this.upcomingInvoice.seed(SINGLETON, held.upcomingInvoice);
+      }
       this._seedKey = held.key;
       this._seeded = true;
     }
@@ -4194,7 +4209,10 @@ var BillingStore = class {
     return this._client.fetchInvoices({ ...query, limit, offset });
   }
 };
-var RESOURCE_NAMES = ["invoices"];
+var RESOURCE_NAMES = [
+  "invoices",
+  "upcomingInvoice"
+];
 
 // src/billing/context.tsx
 var import_react2 = require("react");
@@ -4345,6 +4363,9 @@ function useInvoices(query = DEFAULT_INVOICE_QUERY) {
   );
   return (0, import_react3.useMemo)(() => ({ ...handle, loadMore }), [handle, loadMore]);
 }
+function useUpcomingInvoice() {
+  return useBillingResource("upcomingInvoice", SINGLETON);
+}
 function useInvalidateBillingData() {
   return useBillingDataSource().invalidateAll;
 }
@@ -4464,7 +4485,7 @@ function staticSource(data) {
 }
 
 // src/version.ts
-var version2 = "1.7.0";
+var version2 = "1.8.0";
 
 // src/context/schematic.tsx
 var import_jsx_runtime4 = require("react/jsx-runtime");

package/dist/schematic-react.d.ts

@@ -127,9 +127,9 @@ declare type BillingClientOptions = SessionOptions;
  * non-default query is claimed rather than refetched by the element.
  */
 export declare type BillingData = {
-    [K in BillingResourceName]?: BillingResources[K];
+    [K in BillingResourceName_2]?: BillingResources_2[K];
 } & {
-    params?: Partial<BillingResourceParams>;
+    params?: Partial<BillingResourceParams_2>;
     /**
      * A prefetch outlives the render that made it — a cached page, a session
      * resolving to somebody else — so a store adopts it only for the session
@@ -145,7 +145,7 @@ declare interface BillingDataProviderDataProps {
     data: BillingData;
     /** Simulated loading / failure per resource; wins over `data`. */
     status?: BillingDataStatus;
-    onRefetch?: (name: BillingResourceName_2) => void;
+    onRefetch?: (name: BillingResourceName) => void;
     onLoadMoreInvoices?: (query: InvoiceQuery) => void;
     children?: React_2.ReactNode;
 }
@@ -166,8 +166,8 @@ export declare interface BillingDataSource {
      * Sources that hold one value per resource (fixtures, prefetch) serve it
      * for every parameter set.
      */
-    subscribe<K extends BillingResourceName_2>(name: K, params: BillingResourceParams_2[K], listener: () => void): () => void;
-    handle<K extends BillingResourceName_2>(name: K, params: BillingResourceParams_2[K]): ResourceHandle<BillingResources_2[K]>;
+    subscribe<K extends BillingResourceName>(name: K, params: BillingResourceParams[K], listener: () => void): () => void;
+    handle<K extends BillingResourceName>(name: K, params: BillingResourceParams[K]): ResourceHandle<BillingResources[K]>;
     /** Never rejects: a failure lands on the resource's `error`. */
     loadMoreInvoices: (query: InvoiceQuery) => Promise<void>;
     invalidateAll: () => void;
@@ -175,7 +175,7 @@ export declare interface BillingDataSource {
 
 /** Per-resource status overrides, for fixtures that simulate loading and failure. */
 export declare type BillingDataStatus = {
-    [K in BillingResourceName_2]?: {
+    [K in BillingResourceName]?: {
         isPending?: boolean;
         error?: Error;
     };
@@ -188,7 +188,7 @@ declare interface BillingPrefetchOptions {
      * the list grows with every element, so a page names what it needs rather
      * than paying for everything.
      */
-    names: BillingResourceName[];
+    names: BillingResourceName_2[];
     /** The invoice query to prefetch for; the element must ask the same one. */
     invoices?: InvoiceQuery;
 }
@@ -206,7 +206,7 @@ export declare function BillingProvider({ billingClient, children, initialData,
  * much. Named apart from schematic-js's `BillingClient`, which is the whole
  * interface; this is the part the hooks here call.
  */
-export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchInvoices">;
+export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchInvoices" | "fetchUpcomingInvoice">;
 
 declare interface BillingProviderDataProps {
     /**
@@ -245,18 +245,20 @@ declare interface BillingProviderDataProps {
  */
 export declare type BillingProviderProps = BillingProviderDataProps & SchematicI18nConfig;
 
-declare type BillingResourceName = keyof BillingResources;
-
 /** The resources this package serves; a key of schematic-js's contract. */
-declare type BillingResourceName_2 = "invoices";
+export declare type BillingResourceName = "invoices" | "upcomingInvoice";
+
+declare type BillingResourceName_2 = keyof BillingResources_2;
+
+export declare type BillingResourceParams = Pick<BillingResourceParams_2, BillingResourceName>;
 
 /** `Record<string, never>` marks a singleton; anything else is keyed. */
-declare interface BillingResourceParams {
+declare interface BillingResourceParams_2 {
     invoices: InvoiceQuery;
     upcomingInvoice: Record<string, never>;
 }
 
-declare type BillingResourceParams_2 = Pick<BillingResourceParams, BillingResourceName_2>;
+export declare type BillingResources = Pick<BillingResources_2, BillingResourceName>;
 
 /**
  * Nothing in the store, the hooks, or the resource keys may be addressed by
@@ -265,7 +267,7 @@ declare type BillingResourceParams_2 = Pick<BillingResourceParams, BillingResour
  * pair, as `sessionKey` writes it — and a store that keeps more than one
  * session's data keys it by that and serves only the active one.
  */
-declare interface BillingResources {
+declare interface BillingResources_2 {
     /** `GET /company/invoices?limit&offset&include_pending`. */
     invoices: InvoicePage;
     /**
@@ -276,8 +278,6 @@ declare interface BillingResources {
     upcomingInvoice: UpcomingInvoice | null;
 }
 
-declare type BillingResources_2 = Pick<BillingResources, BillingResourceName_2>;
-
 declare type BooleanListenerFn = (value: boolean) => void;
 
 /**
@@ -774,7 +774,7 @@ declare function DatastreamCompanyPlanFromJSON(json: any): DatastreamCompanyPlan
 
 export declare const DEFAULT_INVOICE_QUERY: InvoiceQuery;
 
-declare type Discount = CompanyDiscountResponseData;
+export declare type Discount = CompanyDiscountResponseData;
 
 declare type EmptyListenerFn = () => void;
 
@@ -1559,9 +1559,9 @@ declare namespace SchematicJS {
         BillingClientOptions,
         BillingData,
         BillingPrefetchOptions,
-        BillingResourceName,
-        BillingResourceParams,
-        BillingResources,
+        BillingResourceName_2 as BillingResourceName,
+        BillingResourceParams_2 as BillingResourceParams,
+        BillingResources_2 as BillingResources,
         BooleanListenerFn,
         CheckFlagResponseData,
         CheckFlagReturn,
@@ -1797,7 +1797,7 @@ declare interface SessionOptions {
 export declare type SessionStatus = "pending" | "active" | "ended";
 
 /** The params of every singleton resource. */
-declare const SINGLETON: Record<string, never>;
+export declare const SINGLETON: Record<string, never>;
 
 /** Optional type for implementing custom client-side storage */
 export declare type StoragePersister = {
@@ -1856,7 +1856,7 @@ export declare const TrialStatus: {
 
 export declare type TrialStatus = (typeof TrialStatus)[keyof typeof TrialStatus];
 
-declare type UpcomingInvoice = CompanyUpcomingInvoiceResponseData;
+export declare type UpcomingInvoice = CompanyUpcomingInvoiceResponseData;
 
 export declare enum UsagePeriod {
     ALL_TIME = "all_time",
@@ -1928,6 +1928,13 @@ export declare function useSchematicStrings(): StringOverrides | undefined;
 
 export declare function useSchematicTranslate(): Translate | undefined;
 
+/**
+ * The company's next bill. `data` is `null` when there is nothing to bill —
+ * no subscription, which the endpoint reports as a 204 — so an element can
+ * render an empty state; `data === undefined` is what means not loaded yet.
+ */
+export declare function useUpcomingInvoice(): ResourceHandle<UpcomingInvoice | null>;
+
 /**
  * Schematic API
  * Schematic API

package/dist/schematic-react.esm.js

@@ -1147,6 +1147,7 @@ function contextString(context) {
   return JSON.stringify(sortedContext);
 }
 var version = "1.8.0";
+var SINGLETON = {};
 var models_exports = {};
 __export(models_exports, {
   ApiErrorFromJSON: () => ApiErrorFromJSON,
@@ -3933,33 +3934,40 @@ var BillingStore = class {
   constructor(_client, initialData = {}, options = {}) {
     this._client = _client;
     this._pageSize = options.pageSize ?? INVOICE_PAGE_SIZE;
+    const readiness = () => this._connected ? READINESS[this._client.sessionStatus] : "waiting";
     this.invoices = new KeyedResource(
       (query, current) => this._reloadWindow(
         query,
         Math.max(this._pageSize, current?.invoices.length ?? 0)
       ),
-      // Waiting until connected; then a session still pending stays
-      // pending, and one that has ended settles empty rather than recording
-      // the client's refusal as an error.
-      {
-        readiness: () => this._connected ? READINESS[this._client.sessionStatus] : "waiting"
-      }
+      { readiness }
     );
+    this.upcomingInvoice = new KeyedResource(
+      () => this._client.fetchUpcomingInvoice(),
+      { readiness }
+    );
+    const held = { key: initialData.sessionKey };
     if (initialData.invoices !== void 0) {
-      this._held = {
+      held.invoices = {
         // Normalized the way the hook normalizes, or the caller asking for
         // it fetches the same page again.
         params: normalizeInvoiceQuery2(
           initialData.params?.invoices ?? DEFAULT_INVOICE_QUERY
         ),
-        data: initialData.invoices,
-        key: initialData.sessionKey
+        data: initialData.invoices
       };
+    }
+    if (initialData.upcomingInvoice !== void 0) {
+      held.upcomingInvoice = initialData.upcomingInvoice;
+    }
+    if (held.invoices !== void 0 || held.upcomingInvoice !== void 0) {
+      this._held = held;
       this._settleSeed(claimFrom(options.session) ?? claimOf(this._client));
     }
   }
   _client;
   invoices;
+  upcomingInvoice;
   _pageSize;
   _unsubscribe;
   _connected = false;
@@ -4029,7 +4037,12 @@ var BillingStore = class {
     }
     this._held = void 0;
     if (verdict === "adopt") {
-      this.invoices.seed(held.params, held.data);
+      if (held.invoices !== void 0) {
+        this.invoices.seed(held.invoices.params, held.invoices.data);
+      }
+      if (held.upcomingInvoice !== void 0) {
+        this.upcomingInvoice.seed(SINGLETON, held.upcomingInvoice);
+      }
       this._seedKey = held.key;
       this._seeded = true;
     }
@@ -4131,7 +4144,10 @@ var BillingStore = class {
     return this._client.fetchInvoices({ ...query, limit, offset });
   }
 };
-var RESOURCE_NAMES = ["invoices"];
+var RESOURCE_NAMES = [
+  "invoices",
+  "upcomingInvoice"
+];
 
 // src/billing/context.tsx
 import { createContext as createContext2, useContext as useContext2, useMemo as useMemo2 } from "react";
@@ -4282,6 +4298,9 @@ function useInvoices(query = DEFAULT_INVOICE_QUERY) {
   );
   return useMemo3(() => ({ ...handle, loadMore }), [handle, loadMore]);
 }
+function useUpcomingInvoice() {
+  return useBillingResource("upcomingInvoice", SINGLETON);
+}
 function useInvalidateBillingData() {
   return useBillingDataSource().invalidateAll;
 }
@@ -4401,7 +4420,7 @@ function staticSource(data) {
 }
 
 // src/version.ts
-var version2 = "1.7.0";
+var version2 = "1.8.0";
 
 // src/context/schematic.tsx
 import { jsx as jsx4 } from "react/jsx-runtime";
@@ -4625,6 +4644,7 @@ export {
   INVOICE_PAGE_SIZE,
   InvoiceStatus,
   RuleType,
+  SINGLETON,
   Schematic,
   SchematicI18nContext,
   SchematicI18nProvider,
@@ -4646,7 +4666,8 @@ export {
   useSchematicLocale,
   useSchematicPlan,
   useSchematicStrings,
-  useSchematicTranslate
+  useSchematicTranslate,
+  useUpcomingInvoice
 };
 /*! Bundled license information:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schematichq/schematic-react",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "main": "dist/schematic-react.cjs.js",
   "module": "dist/schematic-react.esm.js",
   "types": "dist/schematic-react.d.ts",