@schematichq/schematic-react 1.6.0 → 1.7.0

package/README.md

@@ -165,6 +165,40 @@ const MyComponent = () => {
 
 These values refresh with each flag check. For a balance that also updates on the credit partials arriving between checks, pass `creditId` to [`useSchematicCreditBalance`](#credit-balances) instead.
 
+### Usage warnings
+
+If a usage warning is configured on the entitlement, the hook returns it as `warningTiers`, so you can warn a customer before they hit the limit rather than after:
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `warningTiers` | `WarningTier[] \| undefined` | The usage warning thresholds configured on the entitlement, each a `{ key, value }` pair in the entitlement's usage units. `undefined` when none are configured |
+| `softLimit` | `number \| undefined` | For usage-based pricing, the soft limit for overage charges or the next tier boundary |
+
+The dashboard writes a single tier under the key `default`.
+
+```tsx
+import { useSchematicEntitlement } from "@schematichq/schematic-react";
+import { Feature, ApproachingLimit } from "./components";
+
+const MyComponent = () => {
+    const { featureUsage, warningTiers } =
+        useSchematicEntitlement("my-flag-key");
+
+    const warning = warningTiers?.find((tier) => tier.key === "default");
+    const approachingLimit =
+        typeof featureUsage === "number" &&
+        typeof warning?.value === "number" &&
+        featureUsage >= warning.value;
+
+    return (
+        <>
+            {approachingLimit && <ApproachingLimit limit={warning.value} />}
+            <Feature />
+        </>
+    );
+};
+```
+
 ### Company plan information
 
 To access the current company's plan and trial status, you can use the `useSchematicPlan` hook:

package/dist/schematic-react.cjs.js

@@ -61,7 +61,7 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// node_modules/.pnpm/@schematichq+schematic-js@1.7.0/node_modules/@schematichq/schematic-js/dist/schematic.esm.js
+// node_modules/.pnpm/@schematichq+schematic-js@1.8.0/node_modules/@schematichq/schematic-js/dist/schematic.esm.js
 var __create2 = Object.create;
 var __defProp2 = Object.defineProperty;
 var __getOwnPropDesc2 = Object.getOwnPropertyDescriptor;
@@ -1166,7 +1166,8 @@ var CheckFlagReturnFromJSON = (json) => {
     ruleType: ruleType == null ? void 0 : ruleType,
     softLimit: entitlement?.softLimit == null ? void 0 : entitlement.softLimit,
     userId: userId == null ? void 0 : userId,
-    value
+    value,
+    warningTiers: entitlement?.warningTiers == null ? void 0 : entitlement.warningTiers
   };
 };
 var CheckPlanReturnFromJSON = (json) => {
@@ -1193,7 +1194,7 @@ var CreditBalancesFromJSON = (json) => {
   }
   return balances;
 };
-var cacheVersion = "bb56e75d";
+var cacheVersion = "7b920cf4";
 function contextString(context) {
   const sortedContext = Object.keys(context).reduce((acc, key) => {
     const sortedKeys = Object.keys(
@@ -1208,13 +1209,17 @@ function contextString(context) {
   }, {});
   return JSON.stringify(sortedContext);
 }
-var version = "1.7.0";
+var version = "1.8.0";
 var models_exports = {};
 __export2(models_exports, {
   ApiErrorFromJSON: () => ApiErrorFromJSON,
   ApiErrorFromJSONTyped: () => ApiErrorFromJSONTyped,
   ApiErrorToJSON: () => ApiErrorToJSON,
   ApiErrorToJSONTyped: () => ApiErrorToJSONTyped,
+  CompanyDiscountResponseDataFromJSON: () => CompanyDiscountResponseDataFromJSON,
+  CompanyDiscountResponseDataFromJSONTyped: () => CompanyDiscountResponseDataFromJSONTyped,
+  CompanyDiscountResponseDataToJSON: () => CompanyDiscountResponseDataToJSON,
+  CompanyDiscountResponseDataToJSONTyped: () => CompanyDiscountResponseDataToJSONTyped,
   CompanyInvoiceResponseDataFromJSON: () => CompanyInvoiceResponseDataFromJSON,
   CompanyInvoiceResponseDataFromJSONTyped: () => CompanyInvoiceResponseDataFromJSONTyped,
   CompanyInvoiceResponseDataToJSON: () => CompanyInvoiceResponseDataToJSON,
@@ -1223,6 +1228,10 @@ __export2(models_exports, {
   CompanyInvoicesResponseDataFromJSONTyped: () => CompanyInvoicesResponseDataFromJSONTyped,
   CompanyInvoicesResponseDataToJSON: () => CompanyInvoicesResponseDataToJSON,
   CompanyInvoicesResponseDataToJSONTyped: () => CompanyInvoicesResponseDataToJSONTyped,
+  CompanyUpcomingInvoiceResponseDataFromJSON: () => CompanyUpcomingInvoiceResponseDataFromJSON,
+  CompanyUpcomingInvoiceResponseDataFromJSONTyped: () => CompanyUpcomingInvoiceResponseDataFromJSONTyped,
+  CompanyUpcomingInvoiceResponseDataToJSON: () => CompanyUpcomingInvoiceResponseDataToJSON,
+  CompanyUpcomingInvoiceResponseDataToJSONTyped: () => CompanyUpcomingInvoiceResponseDataToJSONTyped,
   GetCompanyInvoicesParamsFromJSON: () => GetCompanyInvoicesParamsFromJSON,
   GetCompanyInvoicesParamsFromJSONTyped: () => GetCompanyInvoicesParamsFromJSONTyped,
   GetCompanyInvoicesParamsToJSON: () => GetCompanyInvoicesParamsToJSON,
@@ -1231,16 +1240,23 @@ __export2(models_exports, {
   GetCompanyInvoicesResponseFromJSONTyped: () => GetCompanyInvoicesResponseFromJSONTyped,
   GetCompanyInvoicesResponseToJSON: () => GetCompanyInvoicesResponseToJSON,
   GetCompanyInvoicesResponseToJSONTyped: () => GetCompanyInvoicesResponseToJSONTyped,
+  GetCompanyUpcomingInvoiceResponseFromJSON: () => GetCompanyUpcomingInvoiceResponseFromJSON,
+  GetCompanyUpcomingInvoiceResponseFromJSONTyped: () => GetCompanyUpcomingInvoiceResponseFromJSONTyped,
+  GetCompanyUpcomingInvoiceResponseToJSON: () => GetCompanyUpcomingInvoiceResponseToJSON,
+  GetCompanyUpcomingInvoiceResponseToJSONTyped: () => GetCompanyUpcomingInvoiceResponseToJSONTyped,
   InvoiceStatus: () => InvoiceStatus,
   InvoiceStatusFromJSON: () => InvoiceStatusFromJSON,
   InvoiceStatusFromJSONTyped: () => InvoiceStatusFromJSONTyped,
   InvoiceStatusToJSON: () => InvoiceStatusToJSON,
   InvoiceStatusToJSONTyped: () => InvoiceStatusToJSONTyped,
   instanceOfApiError: () => instanceOfApiError,
+  instanceOfCompanyDiscountResponseData: () => instanceOfCompanyDiscountResponseData,
   instanceOfCompanyInvoiceResponseData: () => instanceOfCompanyInvoiceResponseData,
   instanceOfCompanyInvoicesResponseData: () => instanceOfCompanyInvoicesResponseData,
+  instanceOfCompanyUpcomingInvoiceResponseData: () => instanceOfCompanyUpcomingInvoiceResponseData,
   instanceOfGetCompanyInvoicesParams: () => instanceOfGetCompanyInvoicesParams,
   instanceOfGetCompanyInvoicesResponse: () => instanceOfGetCompanyInvoicesResponse,
+  instanceOfGetCompanyUpcomingInvoiceResponse: () => instanceOfGetCompanyUpcomingInvoiceResponse,
   instanceOfInvoiceStatus: () => instanceOfInvoiceStatus
 });
 function instanceOfApiError(value) {
@@ -1269,6 +1285,46 @@ function ApiErrorToJSONTyped(value, ignoreDiscriminator = false) {
     error: value["error"]
   };
 }
+function instanceOfCompanyDiscountResponseData(value) {
+  if (!("couponName" in value) || value["couponName"] === void 0)
+    return false;
+  if (!("duration" in value) || value["duration"] === void 0) return false;
+  return true;
+}
+function CompanyDiscountResponseDataFromJSON(json) {
+  return CompanyDiscountResponseDataFromJSONTyped(json, false);
+}
+function CompanyDiscountResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    amountOff: json["amount_off"] == null ? void 0 : json["amount_off"],
+    couponName: json["coupon_name"],
+    currency: json["currency"] == null ? void 0 : json["currency"],
+    customerFacingCode: json["customer_facing_code"] == null ? void 0 : json["customer_facing_code"],
+    duration: json["duration"],
+    durationInMonths: json["duration_in_months"] == null ? void 0 : json["duration_in_months"],
+    percentOff: json["percent_off"] == null ? void 0 : json["percent_off"]
+  };
+}
+function CompanyDiscountResponseDataToJSON(json) {
+  return CompanyDiscountResponseDataToJSONTyped(json, false);
+}
+function CompanyDiscountResponseDataToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    amount_off: value["amountOff"],
+    coupon_name: value["couponName"],
+    currency: value["currency"],
+    customer_facing_code: value["customerFacingCode"],
+    duration: value["duration"],
+    duration_in_months: value["durationInMonths"],
+    percent_off: value["percentOff"]
+  };
+}
 var InvoiceStatus = {
   Draft: "draft",
   Open: "open",
@@ -1372,6 +1428,55 @@ function CompanyInvoicesResponseDataToJSONTyped(value, ignoreDiscriminator = fal
     )
   };
 }
+function instanceOfCompanyUpcomingInvoiceResponseData(value) {
+  if (!("amountDue" in value) || value["amountDue"] === void 0) return false;
+  if (!("currency" in value) || value["currency"] === void 0) return false;
+  if (!("customerBalanceApplied" in value) || value["customerBalanceApplied"] === void 0)
+    return false;
+  if (!("customerBalanceRemaining" in value) || value["customerBalanceRemaining"] === void 0)
+    return false;
+  if (!("discounts" in value) || value["discounts"] === void 0) return false;
+  if (!("subtotal" in value) || value["subtotal"] === void 0) return false;
+  return true;
+}
+function CompanyUpcomingInvoiceResponseDataFromJSON(json) {
+  return CompanyUpcomingInvoiceResponseDataFromJSONTyped(json, false);
+}
+function CompanyUpcomingInvoiceResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    amountDue: json["amount_due"],
+    currency: json["currency"],
+    customerBalanceApplied: json["customer_balance_applied"],
+    customerBalanceRemaining: json["customer_balance_remaining"],
+    discounts: json["discounts"].map(
+      CompanyDiscountResponseDataFromJSON
+    ),
+    dueDate: json["due_date"] == null ? void 0 : new Date(json["due_date"]),
+    subtotal: json["subtotal"]
+  };
+}
+function CompanyUpcomingInvoiceResponseDataToJSON(json) {
+  return CompanyUpcomingInvoiceResponseDataToJSONTyped(json, false);
+}
+function CompanyUpcomingInvoiceResponseDataToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    amount_due: value["amountDue"],
+    currency: value["currency"],
+    customer_balance_applied: value["customerBalanceApplied"],
+    customer_balance_remaining: value["customerBalanceRemaining"],
+    discounts: value["discounts"].map(
+      CompanyDiscountResponseDataToJSON
+    ),
+    due_date: value["dueDate"] == null ? void 0 : value["dueDate"].toISOString(),
+    subtotal: value["subtotal"]
+  };
+}
 function instanceOfGetCompanyInvoicesParams(value) {
   return true;
 }
@@ -1430,6 +1535,35 @@ function GetCompanyInvoicesResponseToJSONTyped(value, ignoreDiscriminator = fals
     params: GetCompanyInvoicesParamsToJSON(value["params"])
   };
 }
+function instanceOfGetCompanyUpcomingInvoiceResponse(value) {
+  if (!("data" in value) || value["data"] === void 0) return false;
+  if (!("params" in value) || value["params"] === void 0) return false;
+  return true;
+}
+function GetCompanyUpcomingInvoiceResponseFromJSON(json) {
+  return GetCompanyUpcomingInvoiceResponseFromJSONTyped(json, false);
+}
+function GetCompanyUpcomingInvoiceResponseFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    data: CompanyUpcomingInvoiceResponseDataFromJSON(json["data"]),
+    params: json["params"]
+  };
+}
+function GetCompanyUpcomingInvoiceResponseToJSON(json) {
+  return GetCompanyUpcomingInvoiceResponseToJSONTyped(json, false);
+}
+function GetCompanyUpcomingInvoiceResponseToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    data: CompanyUpcomingInvoiceResponseDataToJSON(value["data"]),
+    params: value["params"]
+  };
+}
 var DEFAULT_INVOICE_QUERY = {};
 function normalizeInvoiceQuery(query) {
   const { includePending, ...rest } = query;
@@ -1645,6 +1779,11 @@ var SchematicSession = class {
         throw new SchematicApiError(status, path, rejected);
       }
     }
+    if (options.noContentOn?.includes(response.status) === true) {
+      await discardBody(response);
+      await stillOurs();
+      return void 0;
+    }
     const parsed = await readBody(response);
     await stillOurs();
     if (!response.ok) {
@@ -1737,6 +1876,18 @@ var SchematicBillingClient = class {
       return { invoices: decoded.invoices, count: decoded.count };
     });
   }
+  fetchUpcomingInvoice() {
+    const path = "/company/upcoming-invoice";
+    return this.session.request(path, { noContentOn: [204] }).then((body) => {
+      if (body === void 0) {
+        return null;
+      }
+      if (body === null || typeof body !== "object" || !("data" in body)) {
+        throw new Error(`Malformed response from ${path}`);
+      }
+      return GetCompanyUpcomingInvoiceResponseFromJSON(body).data;
+    });
+  }
 };
 var anonymousIdKey = "schematicId";
 var flagStateCachePrefix = "schematicCache";
@@ -4313,7 +4464,7 @@ function staticSource(data) {
 }
 
 // src/version.ts
-var version2 = "1.6.0";
+var version2 = "1.7.0";
 
 // src/context/schematic.tsx
 var import_jsx_runtime4 = require("react/jsx-runtime");

package/dist/schematic-react.d.ts

@@ -34,7 +34,7 @@ declare type BaseSchematicProviderProps = Omit<SchematicJS.SchematicOptions, "cl
      */
     session?: SessionInput;
     /** A billing client; schematic-js supplies one when omitted. */
-    billingClient?: BillingClient;
+    billingClient?: BillingProviderClient;
     /**
      * Prefetched billing data, so the first render is complete (SSR). Rows
      * stamped with their session paint on the first render only if `session`
@@ -53,6 +53,12 @@ declare namespace billingApi {
         ApiErrorToJSON,
         ApiErrorToJSONTyped,
         ApiError,
+        instanceOfCompanyDiscountResponseData,
+        CompanyDiscountResponseDataFromJSON,
+        CompanyDiscountResponseDataFromJSONTyped,
+        CompanyDiscountResponseDataToJSON,
+        CompanyDiscountResponseDataToJSONTyped,
+        CompanyDiscountResponseData,
         instanceOfCompanyInvoiceResponseData,
         CompanyInvoiceResponseDataFromJSON,
         CompanyInvoiceResponseDataFromJSONTyped,
@@ -65,6 +71,12 @@ declare namespace billingApi {
         CompanyInvoicesResponseDataToJSON,
         CompanyInvoicesResponseDataToJSONTyped,
         CompanyInvoicesResponseData,
+        instanceOfCompanyUpcomingInvoiceResponseData,
+        CompanyUpcomingInvoiceResponseDataFromJSON,
+        CompanyUpcomingInvoiceResponseDataFromJSONTyped,
+        CompanyUpcomingInvoiceResponseDataToJSON,
+        CompanyUpcomingInvoiceResponseDataToJSONTyped,
+        CompanyUpcomingInvoiceResponseData,
         instanceOfGetCompanyInvoicesParams,
         GetCompanyInvoicesParamsFromJSON,
         GetCompanyInvoicesParamsFromJSONTyped,
@@ -77,6 +89,12 @@ declare namespace billingApi {
         GetCompanyInvoicesResponseToJSON,
         GetCompanyInvoicesResponseToJSONTyped,
         GetCompanyInvoicesResponse,
+        instanceOfGetCompanyUpcomingInvoiceResponse,
+        GetCompanyUpcomingInvoiceResponseFromJSON,
+        GetCompanyUpcomingInvoiceResponseFromJSONTyped,
+        GetCompanyUpcomingInvoiceResponseToJSON,
+        GetCompanyUpcomingInvoiceResponseToJSONTyped,
+        GetCompanyUpcomingInvoiceResponse,
         instanceOfInvoiceStatus,
         InvoiceStatusFromJSON,
         InvoiceStatusFromJSONTyped,
@@ -91,8 +109,10 @@ declare namespace billingApi {
  * rest of what `hydrate` serves — and the checkout calls that change them
  * join this interface as their endpoints ship.
  */
-export declare interface BillingClient {
+declare interface BillingClient {
     fetchInvoices(params: InvoicesRequest): Promise<InvoicesResult>;
+    /** `null` when the company has no next bill. */
+    fetchUpcomingInvoice(): Promise<UpcomingInvoice | null>;
     readonly sessionStatus: SessionStatus;
     readonly sessionKey: string | undefined;
     setSession(session: SessionInput): void;
@@ -125,7 +145,7 @@ declare interface BillingDataProviderDataProps {
     data: BillingData;
     /** Simulated loading / failure per resource; wins over `data`. */
     status?: BillingDataStatus;
-    onRefetch?: (name: BillingResourceName) => void;
+    onRefetch?: (name: BillingResourceName_2) => void;
     onLoadMoreInvoices?: (query: InvoiceQuery) => void;
     children?: React_2.ReactNode;
 }
@@ -146,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>(name: K, params: BillingResourceParams[K], listener: () => void): () => void;
-    handle<K extends BillingResourceName>(name: K, params: BillingResourceParams[K]): ResourceHandle<BillingResources[K]>;
+    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]>;
     /** Never rejects: a failure lands on the resource's `error`. */
     loadMoreInvoices: (query: InvoiceQuery) => Promise<void>;
     invalidateAll: () => void;
@@ -155,24 +175,39 @@ export declare interface BillingDataSource {
 
 /** Per-resource status overrides, for fixtures that simulate loading and failure. */
 export declare type BillingDataStatus = {
-    [K in BillingResourceName]?: {
+    [K in BillingResourceName_2]?: {
         isPending?: boolean;
         error?: Error;
     };
 };
 
 declare interface BillingPrefetchOptions {
-    names?: BillingResourceName[];
+    /**
+     * The resources the page renders, and no default: each one is a request
+     * on the server — the upcoming invoice is a live provider preview — and
+     * the list grows with every element, so a page names what it needs rather
+     * than paying for everything.
+     */
+    names: BillingResourceName[];
     /** The invoice query to prefetch for; the element must ask the same one. */
     invoices?: InvoiceQuery;
 }
 
 /**
- * Provides the billing hooks from a `BillingStore` over a `BillingClient`.
+ * Provides the billing hooks from a `BillingStore` over a `BillingProviderClient`.
  * Rendered by `SchematicProvider`; usable on its own with a client.
  */
 export declare function BillingProvider({ billingClient, children, initialData, locale, onMissingString, session, strings, translate, }: BillingProviderProps): React_2.JSX.Element;
 
+/**
+ * What `BillingProvider` asks of its client: the session it reads under, and
+ * the fetch behind each resource above. schematic-js's `SchematicBillingClient`
+ * satisfies it, and so does a host's own client that implements only this
+ * 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">;
+
 declare interface BillingProviderDataProps {
     /**
      * Required: this provider does not build one, and without it every hook
@@ -180,7 +215,7 @@ declare interface BillingProviderDataProps {
      * `SchematicProvider` constructs one from its publishable key and renders
      * this underneath, which is the usual path.
      */
-    billingClient?: BillingClient;
+    billingClient?: BillingProviderClient;
     /**
      * Read once, at mount. A prefetch stamped with its session paints on the
      * first render only if `session` is stated on that render; under
@@ -210,13 +245,19 @@ declare interface BillingProviderDataProps {
  */
 export declare type BillingProviderProps = BillingProviderDataProps & SchematicI18nConfig;
 
-export declare type BillingResourceName = keyof BillingResources;
+declare type BillingResourceName = keyof BillingResources;
+
+/** The resources this package serves; a key of schematic-js's contract. */
+declare type BillingResourceName_2 = "invoices";
 
 /** `Record<string, never>` marks a singleton; anything else is keyed. */
-export declare interface BillingResourceParams {
+declare interface BillingResourceParams {
     invoices: InvoiceQuery;
+    upcomingInvoice: Record<string, never>;
 }
 
+declare type BillingResourceParams_2 = Pick<BillingResourceParams, BillingResourceName_2>;
+
 /**
  * Nothing in the store, the hooks, or the resource keys may be addressed by
  * company or user id: users and companies are many-to-many, and a token names
@@ -224,11 +265,19 @@ export declare interface BillingResourceParams {
  * 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.
  */
-export declare interface BillingResources {
+declare interface BillingResources {
     /** `GET /company/invoices?limit&offset&include_pending`. */
     invoices: InvoicePage;
+    /**
+     * `GET /company/upcoming-invoice`. `null` is a loaded value — the company
+     * has no next bill, which the endpoint reports as a 204 — so only
+     * `undefined` means the resource has not loaded.
+     */
+    upcomingInvoice: UpcomingInvoice | null;
 }
 
+declare type BillingResources_2 = Pick<BillingResources, BillingResourceName_2>;
+
 declare type BooleanListenerFn = (value: boolean) => void;
 
 /**
@@ -397,6 +446,8 @@ export declare type CheckFlagReturn = {
     userId?: string;
     /** A boolean flag check result; for feature entitlements, this represents whether further consumption of the feature is permitted */
     value: boolean;
+    /** Customer-defined usage warning thresholds configured on this entitlement */
+    warningTiers?: WarningTier[];
 };
 
 declare const CheckFlagReturnFromJSON: (json: any) => CheckFlagReturn;
@@ -507,6 +558,67 @@ export declare interface CompanyCreditBalance {
     settled: number;
 }
 
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CompanyDiscountResponseData
+ */
+declare interface CompanyDiscountResponseData {
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyDiscountResponseData
+     */
+    amountOff?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyDiscountResponseData
+     */
+    couponName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyDiscountResponseData
+     */
+    currency?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyDiscountResponseData
+     */
+    customerFacingCode?: string | null;
+    /**
+     * Provider vocabulary: once, repeating, or forever.
+     * @type {string}
+     * @memberof CompanyDiscountResponseData
+     */
+    duration: string;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyDiscountResponseData
+     */
+    durationInMonths?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyDiscountResponseData
+     */
+    percentOff?: number | null;
+}
+
 /**
  *
  * @export
@@ -557,6 +669,56 @@ declare interface CompanyInvoiceResponseData {
     url?: string | null;
 }
 
+/**
+ *
+ * @export
+ * @interface CompanyUpcomingInvoiceResponseData
+ */
+declare interface CompanyUpcomingInvoiceResponseData {
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyUpcomingInvoiceResponseData
+     */
+    amountDue: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyUpcomingInvoiceResponseData
+     */
+    currency: string;
+    /**
+     * How much of the company's existing balance this invoice consumes.
+     * @type {number}
+     * @memberof CompanyUpcomingInvoiceResponseData
+     */
+    customerBalanceApplied: number;
+    /**
+     * Balance left over after this invoice.
+     * @type {number}
+     * @memberof CompanyUpcomingInvoiceResponseData
+     */
+    customerBalanceRemaining: number;
+    /**
+     * Only active discounts that reduce the bill.
+     * @type {Array<CompanyDiscountResponseData>}
+     * @memberof CompanyUpcomingInvoiceResponseData
+     */
+    discounts: Array<CompanyDiscountResponseData>;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyUpcomingInvoiceResponseData
+     */
+    dueDate?: Date | null;
+    /**
+     * Amount before discounts and tax.
+     * @type {number}
+     * @memberof CompanyUpcomingInvoiceResponseData
+     */
+    subtotal: number;
+}
+
 /** A company's lease-aware balance for a single credit type */
 export declare type CreditBalance = {
     /** Spendable balance including any open lease hold (remaining + reserved); the number to display to end users */
@@ -612,6 +774,8 @@ declare function DatastreamCompanyPlanFromJSON(json: any): DatastreamCompanyPlan
 
 export declare const DEFAULT_INVOICE_QUERY: InvoiceQuery;
 
+declare type Discount = CompanyDiscountResponseData;
+
 declare type EmptyListenerFn = () => void;
 
 /**
@@ -879,7 +1043,7 @@ declare interface FeatureEntitlement {
  * Server prefetch for a provider's `initialData`. A resource that fails is
  * left out rather than thrown, so one of them cannot block a page.
  */
-declare function fetchBillingData(client: BillingClient, options?: BillingPrefetchOptions): Promise<BillingData>;
+declare function fetchBillingData(client: BillingClient, options: BillingPrefetchOptions): Promise<BillingData>;
 
 declare type FlagCheckListenerFn = CheckFlagReturnListenerFn | EmptyListenerFn;
 
@@ -989,6 +1153,14 @@ declare type PlanListenerFn = CheckPlanReturnListenerFn | EmptyListenerFn;
 declare interface RequestOptions {
     method?: string;
     body?: unknown;
+    /**
+     * Success statuses that carry no body — a 204 for a resource that is
+     * legitimately absent. The request resolves `undefined` for them, which
+     * is distinct from a body that parsed to `null`. A 401 is never one — the
+     * refresh and retry run first, and only what comes back from that is
+     * judged.
+     */
+    noContentOn?: number[];
 }
 
 export declare interface ResourceHandle<T> extends ResourceState<T> {
@@ -1318,6 +1490,7 @@ declare class SchematicBillingClient implements BillingClient {
     setSession(session: SessionInput): void;
     onSessionChange(listener: (event: SessionEvent) => void): () => void;
     fetchInvoices(params: InvoicesRequest): Promise<InvoicesResult>;
+    fetchUpcomingInvoice(): Promise<UpcomingInvoice | null>;
 }
 
 /** Context for checking flags and sending events */
@@ -1399,13 +1572,16 @@ declare namespace SchematicJS {
         CheckPlanReturnFromJSON,
         CheckPlanReturnListenerFn,
         CompanyCreditBalance,
+        CompanyDiscountResponseData,
         CompanyInvoiceResponseData,
+        CompanyUpcomingInvoiceResponseData,
         CreditBalance,
         CreditBalanceListenerFn,
         CreditBalances,
         CreditBalancesFromJSON,
         CreditBalancesListenerFn,
         DEFAULT_INVOICE_QUERY,
+        Discount,
         EmptyListenerFn,
         Event_2 as Event,
         EventBody,
@@ -1440,11 +1616,14 @@ declare namespace SchematicJS {
         SessionInput,
         SessionOptions,
         SessionStatus,
+        SINGLETON,
         StoragePersister,
         TOKEN_CACHE_SIZE,
         Traits,
         TrialStatus,
-        UsagePeriod
+        UpcomingInvoice,
+        UsagePeriod,
+        WarningTier
     }
 }
 
@@ -1617,6 +1796,9 @@ declare interface SessionOptions {
 
 export declare type SessionStatus = "pending" | "active" | "ended";
 
+/** The params of every singleton resource. */
+declare const SINGLETON: Record<string, never>;
+
 /** Optional type for implementing custom client-side storage */
 export declare type StoragePersister = {
     setItem(key: string, value: any): void;
@@ -1674,6 +1856,8 @@ export declare const TrialStatus: {
 
 export declare type TrialStatus = (typeof TrialStatus)[keyof typeof TrialStatus];
 
+declare type UpcomingInvoice = CompanyUpcomingInvoiceResponseData;
+
 export declare enum UsagePeriod {
     ALL_TIME = "all_time",
     CURRENT_DAY = "current_day",
@@ -1760,7 +1944,7 @@ export declare function useSchematicTranslate(): Translate | undefined;
  * @export
  * @interface WarningTier
  */
-declare interface WarningTier {
+export declare interface WarningTier {
     /**
      * A customer-defined identifier for the warning tier
      * @type {string}

package/dist/schematic-react.esm.js

@@ -1,4 +1,4 @@
-// node_modules/.pnpm/@schematichq+schematic-js@1.7.0/node_modules/@schematichq/schematic-js/dist/schematic.esm.js
+// node_modules/.pnpm/@schematichq+schematic-js@1.8.0/node_modules/@schematichq/schematic-js/dist/schematic.esm.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -1103,7 +1103,8 @@ var CheckFlagReturnFromJSON = (json) => {
     ruleType: ruleType == null ? void 0 : ruleType,
     softLimit: entitlement?.softLimit == null ? void 0 : entitlement.softLimit,
     userId: userId == null ? void 0 : userId,
-    value
+    value,
+    warningTiers: entitlement?.warningTiers == null ? void 0 : entitlement.warningTiers
   };
 };
 var CheckPlanReturnFromJSON = (json) => {
@@ -1130,7 +1131,7 @@ var CreditBalancesFromJSON = (json) => {
   }
   return balances;
 };
-var cacheVersion = "bb56e75d";
+var cacheVersion = "7b920cf4";
 function contextString(context) {
   const sortedContext = Object.keys(context).reduce((acc, key) => {
     const sortedKeys = Object.keys(
@@ -1145,13 +1146,17 @@ function contextString(context) {
   }, {});
   return JSON.stringify(sortedContext);
 }
-var version = "1.7.0";
+var version = "1.8.0";
 var models_exports = {};
 __export(models_exports, {
   ApiErrorFromJSON: () => ApiErrorFromJSON,
   ApiErrorFromJSONTyped: () => ApiErrorFromJSONTyped,
   ApiErrorToJSON: () => ApiErrorToJSON,
   ApiErrorToJSONTyped: () => ApiErrorToJSONTyped,
+  CompanyDiscountResponseDataFromJSON: () => CompanyDiscountResponseDataFromJSON,
+  CompanyDiscountResponseDataFromJSONTyped: () => CompanyDiscountResponseDataFromJSONTyped,
+  CompanyDiscountResponseDataToJSON: () => CompanyDiscountResponseDataToJSON,
+  CompanyDiscountResponseDataToJSONTyped: () => CompanyDiscountResponseDataToJSONTyped,
   CompanyInvoiceResponseDataFromJSON: () => CompanyInvoiceResponseDataFromJSON,
   CompanyInvoiceResponseDataFromJSONTyped: () => CompanyInvoiceResponseDataFromJSONTyped,
   CompanyInvoiceResponseDataToJSON: () => CompanyInvoiceResponseDataToJSON,
@@ -1160,6 +1165,10 @@ __export(models_exports, {
   CompanyInvoicesResponseDataFromJSONTyped: () => CompanyInvoicesResponseDataFromJSONTyped,
   CompanyInvoicesResponseDataToJSON: () => CompanyInvoicesResponseDataToJSON,
   CompanyInvoicesResponseDataToJSONTyped: () => CompanyInvoicesResponseDataToJSONTyped,
+  CompanyUpcomingInvoiceResponseDataFromJSON: () => CompanyUpcomingInvoiceResponseDataFromJSON,
+  CompanyUpcomingInvoiceResponseDataFromJSONTyped: () => CompanyUpcomingInvoiceResponseDataFromJSONTyped,
+  CompanyUpcomingInvoiceResponseDataToJSON: () => CompanyUpcomingInvoiceResponseDataToJSON,
+  CompanyUpcomingInvoiceResponseDataToJSONTyped: () => CompanyUpcomingInvoiceResponseDataToJSONTyped,
   GetCompanyInvoicesParamsFromJSON: () => GetCompanyInvoicesParamsFromJSON,
   GetCompanyInvoicesParamsFromJSONTyped: () => GetCompanyInvoicesParamsFromJSONTyped,
   GetCompanyInvoicesParamsToJSON: () => GetCompanyInvoicesParamsToJSON,
@@ -1168,16 +1177,23 @@ __export(models_exports, {
   GetCompanyInvoicesResponseFromJSONTyped: () => GetCompanyInvoicesResponseFromJSONTyped,
   GetCompanyInvoicesResponseToJSON: () => GetCompanyInvoicesResponseToJSON,
   GetCompanyInvoicesResponseToJSONTyped: () => GetCompanyInvoicesResponseToJSONTyped,
+  GetCompanyUpcomingInvoiceResponseFromJSON: () => GetCompanyUpcomingInvoiceResponseFromJSON,
+  GetCompanyUpcomingInvoiceResponseFromJSONTyped: () => GetCompanyUpcomingInvoiceResponseFromJSONTyped,
+  GetCompanyUpcomingInvoiceResponseToJSON: () => GetCompanyUpcomingInvoiceResponseToJSON,
+  GetCompanyUpcomingInvoiceResponseToJSONTyped: () => GetCompanyUpcomingInvoiceResponseToJSONTyped,
   InvoiceStatus: () => InvoiceStatus,
   InvoiceStatusFromJSON: () => InvoiceStatusFromJSON,
   InvoiceStatusFromJSONTyped: () => InvoiceStatusFromJSONTyped,
   InvoiceStatusToJSON: () => InvoiceStatusToJSON,
   InvoiceStatusToJSONTyped: () => InvoiceStatusToJSONTyped,
   instanceOfApiError: () => instanceOfApiError,
+  instanceOfCompanyDiscountResponseData: () => instanceOfCompanyDiscountResponseData,
   instanceOfCompanyInvoiceResponseData: () => instanceOfCompanyInvoiceResponseData,
   instanceOfCompanyInvoicesResponseData: () => instanceOfCompanyInvoicesResponseData,
+  instanceOfCompanyUpcomingInvoiceResponseData: () => instanceOfCompanyUpcomingInvoiceResponseData,
   instanceOfGetCompanyInvoicesParams: () => instanceOfGetCompanyInvoicesParams,
   instanceOfGetCompanyInvoicesResponse: () => instanceOfGetCompanyInvoicesResponse,
+  instanceOfGetCompanyUpcomingInvoiceResponse: () => instanceOfGetCompanyUpcomingInvoiceResponse,
   instanceOfInvoiceStatus: () => instanceOfInvoiceStatus
 });
 function instanceOfApiError(value) {
@@ -1206,6 +1222,46 @@ function ApiErrorToJSONTyped(value, ignoreDiscriminator = false) {
     error: value["error"]
   };
 }
+function instanceOfCompanyDiscountResponseData(value) {
+  if (!("couponName" in value) || value["couponName"] === void 0)
+    return false;
+  if (!("duration" in value) || value["duration"] === void 0) return false;
+  return true;
+}
+function CompanyDiscountResponseDataFromJSON(json) {
+  return CompanyDiscountResponseDataFromJSONTyped(json, false);
+}
+function CompanyDiscountResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    amountOff: json["amount_off"] == null ? void 0 : json["amount_off"],
+    couponName: json["coupon_name"],
+    currency: json["currency"] == null ? void 0 : json["currency"],
+    customerFacingCode: json["customer_facing_code"] == null ? void 0 : json["customer_facing_code"],
+    duration: json["duration"],
+    durationInMonths: json["duration_in_months"] == null ? void 0 : json["duration_in_months"],
+    percentOff: json["percent_off"] == null ? void 0 : json["percent_off"]
+  };
+}
+function CompanyDiscountResponseDataToJSON(json) {
+  return CompanyDiscountResponseDataToJSONTyped(json, false);
+}
+function CompanyDiscountResponseDataToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    amount_off: value["amountOff"],
+    coupon_name: value["couponName"],
+    currency: value["currency"],
+    customer_facing_code: value["customerFacingCode"],
+    duration: value["duration"],
+    duration_in_months: value["durationInMonths"],
+    percent_off: value["percentOff"]
+  };
+}
 var InvoiceStatus = {
   Draft: "draft",
   Open: "open",
@@ -1309,6 +1365,55 @@ function CompanyInvoicesResponseDataToJSONTyped(value, ignoreDiscriminator = fal
     )
   };
 }
+function instanceOfCompanyUpcomingInvoiceResponseData(value) {
+  if (!("amountDue" in value) || value["amountDue"] === void 0) return false;
+  if (!("currency" in value) || value["currency"] === void 0) return false;
+  if (!("customerBalanceApplied" in value) || value["customerBalanceApplied"] === void 0)
+    return false;
+  if (!("customerBalanceRemaining" in value) || value["customerBalanceRemaining"] === void 0)
+    return false;
+  if (!("discounts" in value) || value["discounts"] === void 0) return false;
+  if (!("subtotal" in value) || value["subtotal"] === void 0) return false;
+  return true;
+}
+function CompanyUpcomingInvoiceResponseDataFromJSON(json) {
+  return CompanyUpcomingInvoiceResponseDataFromJSONTyped(json, false);
+}
+function CompanyUpcomingInvoiceResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    amountDue: json["amount_due"],
+    currency: json["currency"],
+    customerBalanceApplied: json["customer_balance_applied"],
+    customerBalanceRemaining: json["customer_balance_remaining"],
+    discounts: json["discounts"].map(
+      CompanyDiscountResponseDataFromJSON
+    ),
+    dueDate: json["due_date"] == null ? void 0 : new Date(json["due_date"]),
+    subtotal: json["subtotal"]
+  };
+}
+function CompanyUpcomingInvoiceResponseDataToJSON(json) {
+  return CompanyUpcomingInvoiceResponseDataToJSONTyped(json, false);
+}
+function CompanyUpcomingInvoiceResponseDataToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    amount_due: value["amountDue"],
+    currency: value["currency"],
+    customer_balance_applied: value["customerBalanceApplied"],
+    customer_balance_remaining: value["customerBalanceRemaining"],
+    discounts: value["discounts"].map(
+      CompanyDiscountResponseDataToJSON
+    ),
+    due_date: value["dueDate"] == null ? void 0 : value["dueDate"].toISOString(),
+    subtotal: value["subtotal"]
+  };
+}
 function instanceOfGetCompanyInvoicesParams(value) {
   return true;
 }
@@ -1367,6 +1472,35 @@ function GetCompanyInvoicesResponseToJSONTyped(value, ignoreDiscriminator = fals
     params: GetCompanyInvoicesParamsToJSON(value["params"])
   };
 }
+function instanceOfGetCompanyUpcomingInvoiceResponse(value) {
+  if (!("data" in value) || value["data"] === void 0) return false;
+  if (!("params" in value) || value["params"] === void 0) return false;
+  return true;
+}
+function GetCompanyUpcomingInvoiceResponseFromJSON(json) {
+  return GetCompanyUpcomingInvoiceResponseFromJSONTyped(json, false);
+}
+function GetCompanyUpcomingInvoiceResponseFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    data: CompanyUpcomingInvoiceResponseDataFromJSON(json["data"]),
+    params: json["params"]
+  };
+}
+function GetCompanyUpcomingInvoiceResponseToJSON(json) {
+  return GetCompanyUpcomingInvoiceResponseToJSONTyped(json, false);
+}
+function GetCompanyUpcomingInvoiceResponseToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    data: CompanyUpcomingInvoiceResponseDataToJSON(value["data"]),
+    params: value["params"]
+  };
+}
 var DEFAULT_INVOICE_QUERY = {};
 function normalizeInvoiceQuery(query) {
   const { includePending, ...rest } = query;
@@ -1582,6 +1716,11 @@ var SchematicSession = class {
         throw new SchematicApiError(status, path, rejected);
       }
     }
+    if (options.noContentOn?.includes(response.status) === true) {
+      await discardBody(response);
+      await stillOurs();
+      return void 0;
+    }
     const parsed = await readBody(response);
     await stillOurs();
     if (!response.ok) {
@@ -1674,6 +1813,18 @@ var SchematicBillingClient = class {
       return { invoices: decoded.invoices, count: decoded.count };
     });
   }
+  fetchUpcomingInvoice() {
+    const path = "/company/upcoming-invoice";
+    return this.session.request(path, { noContentOn: [204] }).then((body) => {
+      if (body === void 0) {
+        return null;
+      }
+      if (body === null || typeof body !== "object" || !("data" in body)) {
+        throw new Error(`Malformed response from ${path}`);
+      }
+      return GetCompanyUpcomingInvoiceResponseFromJSON(body).data;
+    });
+  }
 };
 var anonymousIdKey = "schematicId";
 var flagStateCachePrefix = "schematicCache";
@@ -4250,7 +4401,7 @@ function staticSource(data) {
 }
 
 // src/version.ts
-var version2 = "1.6.0";
+var version2 = "1.7.0";
 
 // src/context/schematic.tsx
 import { jsx as jsx4 } from "react/jsx-runtime";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schematichq/schematic-react",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "main": "dist/schematic-react.cjs.js",
   "module": "dist/schematic-react.esm.js",
   "types": "dist/schematic-react.d.ts",
@@ -34,24 +34,24 @@
   "devDependencies": {
     "@eslint/js": "^10.0.1",
     "@microsoft/api-extractor": "^7.59.1",
-    "@schematichq/schematic-js": "^1.7.0",
-    "@testing-library/dom": "^10.4.1",
+    "@schematichq/schematic-js": "^1.8.0",
+    "@testing-library/dom": "^10.4.2",
     "@testing-library/jest-dom": "^7.0.1",
     "@testing-library/react": "^16.3.3",
-    "@types/react": "^19.2.18",
+    "@types/react": "^19.3.0",
     "@vitest/browser": "^5.0.0",
     "esbuild": "^0.28.2",
-    "eslint": "^10.10.0",
+    "eslint": "^10.11.0",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.1.1",
     "globals": "^17.12.0",
-    "happy-dom": "^20.14.0",
+    "happy-dom": "^20.14.5",
     "husky": "^9.1.7",
-    "jsdom": "^30.0.1",
-    "prettier": "^3.9.6",
-    "react": "^19.2.8",
-    "react-dom": "^19.2.8",
+    "jsdom": "^30.1.0",
+    "prettier": "^3.9.8",
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0",
     "typescript": "^6.0.3",
     "typescript-eslint": "^8.70.0",
     "vitest": "^5.0.0"