@schematichq/schematic-react 1.9.0 → 1.10.0

package/README.md

@@ -280,6 +280,43 @@ const CreditMeter = () => {
 
 While `creditId` is `undefined`, the hook reports the client's loading state and a balance of `0`.
 
+### Credit spend policies
+
+To show the spend limits that bind the current company and user, use the `useSchematicCreditSpendPolicies` hook. It updates over the DataStream, so a policy edited or deleted in the dashboard reaches the component without a refetch:
+
+```tsx
+import { useSchematicCreditSpendPolicies } from "@schematichq/schematic-react";
+
+const SpendLimits = () => {
+    const { policies, isLoading } = useSchematicCreditSpendPolicies();
+
+    if (isLoading) {
+        return <div>Loading…</div>;
+    }
+
+    return (
+        <ul>
+            {policies.map((policy) => (
+                <li key={policy.id}>
+                    {policy.kind === "window" && policy.window
+                        ? `${policy.scope} limit: ${policy.consumed} of ${policy.limit} credits used this ${policy.window.unit}`
+                        : `${policy.scope} limit: ${policy.limit} credits per request`}
+                </li>
+            ))}
+        </ul>
+    );
+};
+```
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `policies` | `CreditSpendPolicies` | Company-scope policies first, then the user's own; empty when none bind |
+| `isLoading` | `boolean` | `true` while the policies are still loading and nothing has arrived yet |
+
+A `per_draw` policy caps a single draw. A `window` policy caps what can be spent in one period: `consumed` is what the current period has spent, `resetsAt` is when the period ends, and `window` names the period. Each new spend sends an updated `consumed`. Once `resetsAt` has passed, read `consumed` as `0` until the next update arrives.
+
+The policies are advisory for display: the server and the flag check enforce them.
+
 ## Fallback Behavior
 
 The SDK includes built-in fallback behavior you can use to ensure your application continues to function even when unable to reach Schematic (e.g., during service disruptions or network issues).

package/dist/schematic-react.cjs.js

@@ -51,6 +51,7 @@ __export(index_exports, {
   useSchematic: () => useSchematic,
   useSchematicContext: () => useSchematicContext,
   useSchematicCreditBalance: () => useSchematicCreditBalance,
+  useSchematicCreditSpendPolicies: () => useSchematicCreditSpendPolicies,
   useSchematicEntitlement: () => useSchematicEntitlement,
   useSchematicEvents: () => useSchematicEvents,
   useSchematicFlag: () => useSchematicFlag,
@@ -65,7 +66,7 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// node_modules/.pnpm/@schematichq+schematic-js@1.9.0/node_modules/@schematichq/schematic-js/dist/schematic.esm.js
+// node_modules/.pnpm/@schematichq+schematic-js@1.10.0/node_modules/@schematichq/schematic-js/dist/schematic.esm.js
 var __create2 = Object.create;
 var __defProp2 = Object.defineProperty;
 var __getOwnPropDesc2 = Object.getOwnPropertyDescriptor;
@@ -1061,6 +1062,43 @@ function DatastreamCompanyPlanFromJSONTyped(json, ignoreDiscriminator) {
     trialStatus: json["trial_status"] == null ? void 0 : TrialStatusFromJSON(json["trial_status"])
   };
 }
+function CreditSpendPolicyScopeFromJSON(json) {
+  return CreditSpendPolicyScopeFromJSONTyped(json, false);
+}
+function CreditSpendPolicyScopeFromJSONTyped(json, ignoreDiscriminator) {
+  return json;
+}
+function CreditSpendWindowFromJSON(json) {
+  return CreditSpendWindowFromJSONTyped(json, false);
+}
+function CreditSpendWindowFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    count: json["count"],
+    unit: json["unit"]
+  };
+}
+function CreditSpendPolicyFromJSON(json) {
+  return CreditSpendPolicyFromJSONTyped(json, false);
+}
+function CreditSpendPolicyFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    consumed: json["consumed"] == null ? void 0 : json["consumed"],
+    creditId: json["credit_id"],
+    id: json["id"],
+    kind: json["kind"],
+    label: json["label"] == null ? void 0 : json["label"],
+    limit: json["limit"],
+    resetsAt: json["resets_at"] == null ? void 0 : new Date(json["resets_at"]),
+    scope: CreditSpendPolicyScopeFromJSON(json["scope"]),
+    window: json["window"] == null ? void 0 : CreditSpendWindowFromJSON(json["window"])
+  };
+}
 function CheckFlagsResponseDataFromJSON(json) {
   return CheckFlagsResponseDataFromJSONTyped(json, false);
 }
@@ -1070,6 +1108,9 @@ function CheckFlagsResponseDataFromJSONTyped(json, ignoreDiscriminator) {
   }
   return {
     creditBalances: json["credit_balances"] == null ? void 0 : mapValues(json["credit_balances"], CompanyCreditBalanceFromJSON),
+    creditSpendPolicies: json["credit_spend_policies"].map(
+      CreditSpendPolicyFromJSON
+    ),
     flags: json["flags"].map(CheckFlagResponseDataFromJSON),
     plan: json["plan"] == null ? void 0 : DatastreamCompanyPlanFromJSON(json["plan"])
   };
@@ -1198,7 +1239,55 @@ var CreditBalancesFromJSON = (json) => {
   }
   return balances;
 };
-var cacheVersion = "7b920cf4";
+var CreditSpendPoliciesFromJSON = (json) => {
+  if (!Array.isArray(json)) {
+    return [];
+  }
+  const policies = [];
+  for (const raw of json) {
+    if (raw == null || typeof raw !== "object") continue;
+    const id = raw.id;
+    const creditId = raw.credit_id ?? raw.creditId;
+    const kind = raw.kind;
+    const scope = raw.scope;
+    const limit = raw.limit;
+    if (typeof id !== "string" || typeof creditId !== "string" || typeof kind !== "string" || typeof scope !== "string" || typeof limit !== "number") {
+      continue;
+    }
+    const policy = {
+      id,
+      creditId,
+      kind,
+      scope,
+      limit,
+      consumed: typeof raw.consumed === "number" ? raw.consumed : 0
+    };
+    if (typeof raw.label === "string") {
+      policy.label = raw.label;
+    }
+    const window2 = raw.window;
+    if (window2 != null && typeof window2 === "object" && typeof window2.unit === "string" && typeof window2.count === "number") {
+      policy.window = { unit: window2.unit, count: window2.count };
+    }
+    const resetsAt = raw.resets_at ?? raw.resetsAt;
+    if (typeof resetsAt === "string" || resetsAt instanceof Date) {
+      const parsed = new Date(resetsAt);
+      if (!Number.isNaN(parsed.getTime())) {
+        policy.resetsAt = parsed;
+      }
+    }
+    policies.push(policy);
+  }
+  return policies;
+};
+var creditSpendPoliciesEqual = (a, b) => {
+  if (a.length !== b.length) return false;
+  return a.every((x, i) => {
+    const y = b[i];
+    return x.id === y.id && x.creditId === y.creditId && x.kind === y.kind && x.scope === y.scope && x.label === y.label && x.limit === y.limit && x.consumed === y.consumed && x.resetsAt?.getTime() === y.resetsAt?.getTime() && x.window?.unit === y.window?.unit && x.window?.count === y.window?.count;
+  });
+};
+var cacheVersion = "35d92bc6";
 function contextString(context) {
   const sortedContext = Object.keys(context).reduce((acc, key) => {
     const sortedKeys = Object.keys(
@@ -1213,7 +1302,7 @@ function contextString(context) {
   }, {});
   return JSON.stringify(sortedContext);
 }
-var version = "1.9.0";
+var version = "1.10.0";
 var SINGLETON = {};
 var models_exports = {};
 __export2(models_exports, {
@@ -2380,6 +2469,7 @@ var flagStateCachePrefix = "schematicCache";
 var flagStateCacheMaxContexts = 10;
 var flagStateCacheDefaultMaxAgeMs = 7 * 24 * 60 * 60 * 1e3;
 var emptyCreditBalances = Object.freeze({});
+var emptyCreditSpendPolicies = [];
 var Schematic = class {
   _additionalHeaders = {};
   apiKey;
@@ -2397,6 +2487,7 @@ var Schematic = class {
   isPendingListeners = /* @__PURE__ */ new Set();
   planListeners = /* @__PURE__ */ new Set();
   creditBalanceListeners = /* @__PURE__ */ new Set();
+  creditSpendPolicyListeners = /* @__PURE__ */ new Set();
   storage;
   persistFlagState = true;
   flagStateCacheKey;
@@ -2407,6 +2498,7 @@ var Schematic = class {
   featureUsageEventMap = {};
   planChecks = {};
   creditBalances = {};
+  creditSpendPolicies = {};
   webSocketUrl = "wss://api.schematichq.com";
   webSocketConnectionTimeout = 1e4;
   webSocketReconnect = true;
@@ -2799,6 +2891,19 @@ var Schematic = class {
           this.notifyCreditBalanceListeners(merged);
         }
       }
+      if (message.credit_spend_policies !== void 0 && message.credit_spend_policies !== null) {
+        const contextStr = contextString(context);
+        const next = CreditSpendPoliciesFromJSON(message.credit_spend_policies);
+        const previous = this.creditSpendPolicies[contextStr] ?? [];
+        if (!creditSpendPoliciesEqual(previous, next)) {
+          this.creditSpendPolicies[contextStr] = next;
+          this.debug(
+            `WebSocket credit spend policy update received. Notifying listeners`,
+            { creditSpendPolicies: next }
+          );
+          this.notifyCreditSpendPolicyListeners(next);
+        }
+      }
       this.persistContextToCache(contextString(context));
       this.flushContextDependentEventQueue();
       this.setIsPending(false);
@@ -3300,10 +3405,19 @@ var Schematic = class {
           this.creditBalances[contextStr] = balances;
         }
       }
+      let revivedCreditSpendPolicies;
+      if (entry.creditSpendPolicies !== void 0 && entry.creditSpendPolicies !== null) {
+        const policies = CreditSpendPoliciesFromJSON(entry.creditSpendPolicies);
+        if (policies.length > 0) {
+          revivedCreditSpendPolicies = policies;
+          this.creditSpendPolicies[contextStr] = policies;
+        }
+      }
       fresh[contextStr] = {
         checks: revivedChecks,
         plan: revivedPlan,
         creditBalances: revivedCreditBalances,
+        creditSpendPolicies: revivedCreditSpendPolicies,
         updatedAt: entry.updatedAt
       };
       contextsLoaded += 1;
@@ -3317,7 +3431,8 @@ var Schematic = class {
     const checksForContext = this.checks[contextStr];
     const planForContext = this.planChecks[contextStr];
     const creditBalancesForContext = this.creditBalances[contextStr];
-    if (checksForContext === void 0 && planForContext === void 0 && creditBalancesForContext === void 0) {
+    const creditSpendPoliciesForContext = this.creditSpendPolicies[contextStr];
+    if (checksForContext === void 0 && planForContext === void 0 && creditBalancesForContext === void 0 && creditSpendPoliciesForContext === void 0) {
       return;
     }
     if (this.cachedFlagState === null) {
@@ -3336,6 +3451,7 @@ var Schematic = class {
       checks: cleanChecks,
       plan: planForContext,
       creditBalances: creditBalancesForContext,
+      creditSpendPolicies: creditSpendPoliciesForContext,
       updatedAt: Date.now()
     };
     const entries = Object.entries(this.cachedFlagState.contexts);
@@ -3352,6 +3468,9 @@ var Schematic = class {
       for (const key of Object.keys(this.creditBalances)) {
         if (!survivorKeys.has(key)) delete this.creditBalances[key];
       }
+      for (const key of Object.keys(this.creditSpendPolicies)) {
+        if (!survivorKeys.has(key)) delete this.creditSpendPolicies[key];
+      }
       this.cachedFlagState = {
         version: cacheVersion,
         contexts: Object.fromEntries(survivors)
@@ -3946,6 +4065,18 @@ var Schematic = class {
     const contextStr = contextString(this.context);
     return this.creditBalances[contextStr]?.[creditId];
   };
+  /** Get every credit spend policy binding the current context, company-scope first */
+  getCreditSpendPolicies = () => {
+    const contextStr = contextString(this.context);
+    return this.creditSpendPolicies[contextStr] ?? emptyCreditSpendPolicies;
+  };
+  /** Get the spend policies binding a single credit type in the current context */
+  getCreditSpendPoliciesForCredit = (creditId) => {
+    const policies = this.getCreditSpendPolicies().filter(
+      (policy) => policy.creditId === creditId
+    );
+    return policies.length > 0 ? policies : emptyCreditSpendPolicies;
+  };
   // flag checks state
   getFlagCheck = (flagKey) => {
     const contextStr = contextString(this.context);
@@ -4012,6 +4143,13 @@ var Schematic = class {
       this.creditBalanceListeners.delete(listener);
     };
   };
+  /** Register an event listener that will be notified with the context's credit spend policies whenever the set changes */
+  addCreditSpendPolicyListener = (listener) => {
+    this.creditSpendPolicyListeners.add(listener);
+    return () => {
+      this.creditSpendPolicyListeners.delete(listener);
+    };
+  };
   notifyFlagCheckListeners = (flagKey, check) => {
     const listeners = this.flagCheckListeners?.[flagKey] ?? [];
     if (listeners.size > 0) {
@@ -4075,6 +4213,16 @@ var Schematic = class {
       });
     });
   };
+  notifyCreditSpendPolicyListeners = (value) => {
+    const listeners = this.creditSpendPolicyListeners ?? [];
+    listeners.forEach((listener) => {
+      if (listener.length > 0) {
+        listener(value);
+        return;
+      }
+      listener();
+    });
+  };
   notifyCreditBalanceListeners = (value) => {
     const listeners = this.creditBalanceListeners ?? [];
     if (listeners.size > 0) {
@@ -5091,7 +5239,7 @@ function staticSource(data) {
 }
 
 // src/version.ts
-var version2 = "1.9.0";
+var version2 = "1.10.0";
 
 // src/context/schematic.tsx
 var import_jsx_runtime4 = require("react/jsx-runtime");
@@ -5184,6 +5332,7 @@ var useSchematic = () => {
 
 // src/hooks/schematic.ts
 var import_react6 = require("react");
+var emptyPolicies = [];
 var useSchematicClient = (opts) => {
   const schematic = useSchematic();
   const { client } = opts ?? {};
@@ -5299,6 +5448,34 @@ var useSchematicCreditBalance = (creditId, opts) => {
     [balance, isPending]
   );
 };
+var useSchematicCreditSpendPolicies = (opts) => {
+  const client = useSchematicClient(opts);
+  const subscribe = (0, import_react6.useCallback)(
+    (callback) => client.addCreditSpendPolicyListener(callback),
+    [client]
+  );
+  const policies = (0, import_react6.useSyncExternalStore)(
+    subscribe,
+    () => client.getCreditSpendPolicies(),
+    () => emptyPolicies
+  );
+  const isPendingSubscribe = (0, import_react6.useCallback)(
+    (callback) => client.addIsPendingListener(callback),
+    [client]
+  );
+  const isPending = (0, import_react6.useSyncExternalStore)(
+    isPendingSubscribe,
+    () => client.getIsPending(),
+    () => true
+  );
+  return (0, import_react6.useMemo)(
+    () => ({
+      policies,
+      isLoading: policies.length === 0 && isPending
+    }),
+    [policies, isPending]
+  );
+};
 var useSchematicIsPending = (opts) => {
   const client = useSchematicClient(opts);
   const subscribe = (0, import_react6.useCallback)(

package/dist/schematic-react.d.ts

@@ -593,6 +593,12 @@ declare interface CheckFlagsResponseData {
     creditBalances?: {
         [key: string]: CompanyCreditBalance;
     };
+    /**
+     * Credit spend policies binding the evaluated company and user; empty when none bind. Each response carries the whole set, so replace any previously received set with it. Advisory: the flag values do not reflect them, since a check names no draw amount
+     * @type {Array<CreditSpendPolicy>}
+     * @memberof CheckFlagsResponseData
+     */
+    creditSpendPolicies: Array<CreditSpendPolicy_2>;
     /**
      *
      * @type {Array<CheckFlagResponseData>}
@@ -946,6 +952,153 @@ declare const CreditBalancesFromJSON: (json: any) => CreditBalances;
 
 declare type CreditBalancesListenerFn = (value: CreditBalances) => void;
 
+/** Every spend policy binding the current context, company-scope first */
+export declare type CreditSpendPolicies = CreditSpendPolicy[];
+
+/** Compare two policy sets by value, so an unchanged restream skips the notify. */
+declare const creditSpendPoliciesEqual: (a: CreditSpendPolicies, b: CreditSpendPolicies) => boolean;
+
+declare const CreditSpendPoliciesFromJSON: (json: any) => CreditSpendPolicies;
+
+declare type CreditSpendPoliciesListenerFn = (value: CreditSpendPolicies) => void;
+
+/** One limit on spending a credit */
+export declare type CreditSpendPolicy = {
+    id: string;
+    creditId: string;
+    kind: CreditSpendPolicyKind;
+    scope: CreditSpendPolicyScope;
+    label?: string;
+    /** The ceiling, in credits */
+    limit: number;
+    /** How much of the limit is already spent in the current period; 0 for per_draw */
+    consumed: number;
+    /** For windowed kinds, when the current period ends and consumed no longer applies */
+    resetsAt?: Date;
+    /** Set for windowed kinds only */
+    window?: CreditSpendWindow;
+};
+
+/**
+ *
+ * @export
+ * @interface CreditSpendPolicy
+ */
+declare interface CreditSpendPolicy_2 {
+    /**
+     * How much of the limit is already spent in the current period
+     * @type {number}
+     * @memberof CreditSpendPolicy
+     */
+    consumed?: number;
+    /**
+     * The credit the policy limits
+     * @type {string}
+     * @memberof CreditSpendPolicy
+     */
+    creditId: string;
+    /**
+     * The ID of the policy
+     * @type {string}
+     * @memberof CreditSpendPolicy
+     */
+    id: string;
+    /**
+     * How the limit is applied
+     * @type {string}
+     * @memberof CreditSpendPolicy
+     */
+    kind: string;
+    /**
+     * The name the account gave the policy
+     * @type {string}
+     * @memberof CreditSpendPolicy
+     */
+    label?: string | null;
+    /**
+     * The ceiling, in credits
+     * @type {number}
+     * @memberof CreditSpendPolicy
+     */
+    limit: number;
+    /**
+     * For a windowed limit, when the current period ends and consumed no longer applies
+     * @type {Date}
+     * @memberof CreditSpendPolicy
+     */
+    resetsAt?: Date | null;
+    /**
+     * Whether the policy limits the company or one user
+     * @type {CreditSpendPolicyScope}
+     * @memberof CreditSpendPolicy
+     */
+    scope: CreditSpendPolicyScope_2;
+    /**
+     * For a windowed limit, the period it accumulates over
+     * @type {CreditSpendWindow}
+     * @memberof CreditSpendPolicy
+     */
+    window?: CreditSpendWindow_2;
+}
+
+/** How a spend policy applies its limit. Unknown kinds are carried, not dropped:
+ * the server may ship a kind this SDK version predates. */
+export declare type CreditSpendPolicyKind = "per_draw" | "window" | (string & {});
+
+declare type CreditSpendPolicyListenerFn = CreditSpendPoliciesListenerFn | EmptyListenerFn;
+
+/** Whether a spend policy limits the company or one user */
+export declare type CreditSpendPolicyScope = "company" | "user" | (string & {});
+
+/**
+ *
+ * @export
+ */
+declare const CreditSpendPolicyScope_2: {
+    readonly Company: "company";
+    readonly User: "user";
+    readonly Group: "group";
+};
+
+declare type CreditSpendPolicyScope_2 = (typeof CreditSpendPolicyScope_2)[keyof typeof CreditSpendPolicyScope_2];
+
+/** The period a windowed spend policy accumulates over */
+export declare type CreditSpendWindow = {
+    unit: string;
+    count: 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 CreditSpendWindow
+ */
+declare interface CreditSpendWindow_2 {
+    /**
+     * How many units make up one period
+     * @type {number}
+     * @memberof CreditSpendWindow
+     */
+    count: number;
+    /**
+     * The period the limit accumulates over
+     * @type {string}
+     * @memberof CreditSpendWindow
+     */
+    unit: string;
+}
+
 /**
  *
  * @export
@@ -1463,6 +1616,7 @@ export declare class Schematic {
     private isPendingListeners;
     private planListeners;
     private creditBalanceListeners;
+    private creditSpendPolicyListeners;
     private storage;
     private persistFlagState;
     private flagStateCacheKey;
@@ -1473,6 +1627,7 @@ export declare class Schematic {
     private featureUsageEventMap;
     private planChecks;
     private creditBalances;
+    private creditSpendPolicies;
     private webSocketUrl;
     private webSocketConnectionTimeout;
     private webSocketReconnect;
@@ -1691,6 +1846,10 @@ export declare class Schematic {
     getCreditBalances: () => CreditBalances;
     /** Get the company's lease-aware balance for a single credit type in the current context */
     getCreditBalance: (creditId: string) => CreditBalance | undefined;
+    /** Get every credit spend policy binding the current context, company-scope first */
+    getCreditSpendPolicies: () => CreditSpendPolicies;
+    /** Get the spend policies binding a single credit type in the current context */
+    getCreditSpendPoliciesForCredit: (creditId: string) => CreditSpendPolicies;
     getFlagCheck: (flagKey: string) => CheckFlagReturn | undefined;
     getFlagValue: (flagKey: string) => boolean | undefined;
     /** Register an event listener that will be notified with the boolean value for a given flag when this value changes */
@@ -1700,11 +1859,14 @@ export declare class Schematic {
     addPlanListener: (listener: PlanListenerFn) => () => void;
     /** Register an event listener that will be notified with the company's credit balances (keyed by credit ID) whenever they change */
     addCreditBalanceListener: (listener: CreditBalanceListenerFn) => () => void;
+    /** Register an event listener that will be notified with the context's credit spend policies whenever the set changes */
+    addCreditSpendPolicyListener: (listener: CreditSpendPolicyListenerFn) => () => void;
     private notifyFlagCheckListeners;
     /** Add or update a CheckFlagReturn in the featureUsageEventMap */
     private updateFeatureUsageEventMap;
     private notifyFlagValueListeners;
     private notifyPlanListeners;
+    private notifyCreditSpendPolicyListeners;
     private notifyCreditBalanceListeners;
 }
 
@@ -1752,6 +1914,14 @@ export declare type SchematicCreditBalance = {
     isLoading: boolean;
 };
 
+/** The credit spend policies binding the current context, plus a loading flag */
+export declare type SchematicCreditSpendPolicies = {
+    /** Company-scope policies first, then the actor's own; empty when none bind */
+    policies: SchematicJS.CreditSpendPolicies;
+    /** True while the policies are still loading and nothing has arrived yet */
+    isLoading: boolean;
+};
+
 export declare interface SchematicHookOpts {
     client?: SchematicJS.Schematic;
 }
@@ -1822,6 +1992,15 @@ declare namespace SchematicJS {
         CreditBalances,
         CreditBalancesFromJSON,
         CreditBalancesListenerFn,
+        CreditSpendPolicies,
+        creditSpendPoliciesEqual,
+        CreditSpendPoliciesFromJSON,
+        CreditSpendPoliciesListenerFn,
+        CreditSpendPolicy,
+        CreditSpendPolicyKind,
+        CreditSpendPolicyListenerFn,
+        CreditSpendPolicyScope,
+        CreditSpendWindow,
         DEFAULT_INVOICE_QUERY,
         Discount,
         EmptyListenerFn,
@@ -2206,6 +2385,11 @@ export declare const useSchematicContext: (opts?: SchematicHookOpts) => {
  */
 export declare const useSchematicCreditBalance: (creditId: string | undefined, opts?: SchematicHookOpts) => SchematicCreditBalance;
 
+/** Every credit spend policy binding the current context, company-scope first.
+ * Streams over the websocket, so an edit in the dashboard lands here without a
+ * refetch. */
+export declare const useSchematicCreditSpendPolicies: (opts?: SchematicHookOpts) => SchematicCreditSpendPolicies;
+
 export declare const useSchematicEntitlement: (key: string, opts?: UseSchematicFlagOpts) => SchematicJS.CheckFlagReturn;
 
 export declare const useSchematicEvents: (opts?: SchematicHookOpts) => {

package/dist/schematic-react.esm.js

@@ -1,4 +1,4 @@
-// node_modules/.pnpm/@schematichq+schematic-js@1.9.0/node_modules/@schematichq/schematic-js/dist/schematic.esm.js
+// node_modules/.pnpm/@schematichq+schematic-js@1.10.0/node_modules/@schematichq/schematic-js/dist/schematic.esm.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -994,6 +994,43 @@ function DatastreamCompanyPlanFromJSONTyped(json, ignoreDiscriminator) {
     trialStatus: json["trial_status"] == null ? void 0 : TrialStatusFromJSON(json["trial_status"])
   };
 }
+function CreditSpendPolicyScopeFromJSON(json) {
+  return CreditSpendPolicyScopeFromJSONTyped(json, false);
+}
+function CreditSpendPolicyScopeFromJSONTyped(json, ignoreDiscriminator) {
+  return json;
+}
+function CreditSpendWindowFromJSON(json) {
+  return CreditSpendWindowFromJSONTyped(json, false);
+}
+function CreditSpendWindowFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    count: json["count"],
+    unit: json["unit"]
+  };
+}
+function CreditSpendPolicyFromJSON(json) {
+  return CreditSpendPolicyFromJSONTyped(json, false);
+}
+function CreditSpendPolicyFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    consumed: json["consumed"] == null ? void 0 : json["consumed"],
+    creditId: json["credit_id"],
+    id: json["id"],
+    kind: json["kind"],
+    label: json["label"] == null ? void 0 : json["label"],
+    limit: json["limit"],
+    resetsAt: json["resets_at"] == null ? void 0 : new Date(json["resets_at"]),
+    scope: CreditSpendPolicyScopeFromJSON(json["scope"]),
+    window: json["window"] == null ? void 0 : CreditSpendWindowFromJSON(json["window"])
+  };
+}
 function CheckFlagsResponseDataFromJSON(json) {
   return CheckFlagsResponseDataFromJSONTyped(json, false);
 }
@@ -1003,6 +1040,9 @@ function CheckFlagsResponseDataFromJSONTyped(json, ignoreDiscriminator) {
   }
   return {
     creditBalances: json["credit_balances"] == null ? void 0 : mapValues(json["credit_balances"], CompanyCreditBalanceFromJSON),
+    creditSpendPolicies: json["credit_spend_policies"].map(
+      CreditSpendPolicyFromJSON
+    ),
     flags: json["flags"].map(CheckFlagResponseDataFromJSON),
     plan: json["plan"] == null ? void 0 : DatastreamCompanyPlanFromJSON(json["plan"])
   };
@@ -1131,7 +1171,55 @@ var CreditBalancesFromJSON = (json) => {
   }
   return balances;
 };
-var cacheVersion = "7b920cf4";
+var CreditSpendPoliciesFromJSON = (json) => {
+  if (!Array.isArray(json)) {
+    return [];
+  }
+  const policies = [];
+  for (const raw of json) {
+    if (raw == null || typeof raw !== "object") continue;
+    const id = raw.id;
+    const creditId = raw.credit_id ?? raw.creditId;
+    const kind = raw.kind;
+    const scope = raw.scope;
+    const limit = raw.limit;
+    if (typeof id !== "string" || typeof creditId !== "string" || typeof kind !== "string" || typeof scope !== "string" || typeof limit !== "number") {
+      continue;
+    }
+    const policy = {
+      id,
+      creditId,
+      kind,
+      scope,
+      limit,
+      consumed: typeof raw.consumed === "number" ? raw.consumed : 0
+    };
+    if (typeof raw.label === "string") {
+      policy.label = raw.label;
+    }
+    const window2 = raw.window;
+    if (window2 != null && typeof window2 === "object" && typeof window2.unit === "string" && typeof window2.count === "number") {
+      policy.window = { unit: window2.unit, count: window2.count };
+    }
+    const resetsAt = raw.resets_at ?? raw.resetsAt;
+    if (typeof resetsAt === "string" || resetsAt instanceof Date) {
+      const parsed = new Date(resetsAt);
+      if (!Number.isNaN(parsed.getTime())) {
+        policy.resetsAt = parsed;
+      }
+    }
+    policies.push(policy);
+  }
+  return policies;
+};
+var creditSpendPoliciesEqual = (a, b) => {
+  if (a.length !== b.length) return false;
+  return a.every((x, i) => {
+    const y = b[i];
+    return x.id === y.id && x.creditId === y.creditId && x.kind === y.kind && x.scope === y.scope && x.label === y.label && x.limit === y.limit && x.consumed === y.consumed && x.resetsAt?.getTime() === y.resetsAt?.getTime() && x.window?.unit === y.window?.unit && x.window?.count === y.window?.count;
+  });
+};
+var cacheVersion = "35d92bc6";
 function contextString(context) {
   const sortedContext = Object.keys(context).reduce((acc, key) => {
     const sortedKeys = Object.keys(
@@ -1146,7 +1234,7 @@ function contextString(context) {
   }, {});
   return JSON.stringify(sortedContext);
 }
-var version = "1.9.0";
+var version = "1.10.0";
 var SINGLETON = {};
 var models_exports = {};
 __export(models_exports, {
@@ -2313,6 +2401,7 @@ var flagStateCachePrefix = "schematicCache";
 var flagStateCacheMaxContexts = 10;
 var flagStateCacheDefaultMaxAgeMs = 7 * 24 * 60 * 60 * 1e3;
 var emptyCreditBalances = Object.freeze({});
+var emptyCreditSpendPolicies = [];
 var Schematic = class {
   _additionalHeaders = {};
   apiKey;
@@ -2330,6 +2419,7 @@ var Schematic = class {
   isPendingListeners = /* @__PURE__ */ new Set();
   planListeners = /* @__PURE__ */ new Set();
   creditBalanceListeners = /* @__PURE__ */ new Set();
+  creditSpendPolicyListeners = /* @__PURE__ */ new Set();
   storage;
   persistFlagState = true;
   flagStateCacheKey;
@@ -2340,6 +2430,7 @@ var Schematic = class {
   featureUsageEventMap = {};
   planChecks = {};
   creditBalances = {};
+  creditSpendPolicies = {};
   webSocketUrl = "wss://api.schematichq.com";
   webSocketConnectionTimeout = 1e4;
   webSocketReconnect = true;
@@ -2732,6 +2823,19 @@ var Schematic = class {
           this.notifyCreditBalanceListeners(merged);
         }
       }
+      if (message.credit_spend_policies !== void 0 && message.credit_spend_policies !== null) {
+        const contextStr = contextString(context);
+        const next = CreditSpendPoliciesFromJSON(message.credit_spend_policies);
+        const previous = this.creditSpendPolicies[contextStr] ?? [];
+        if (!creditSpendPoliciesEqual(previous, next)) {
+          this.creditSpendPolicies[contextStr] = next;
+          this.debug(
+            `WebSocket credit spend policy update received. Notifying listeners`,
+            { creditSpendPolicies: next }
+          );
+          this.notifyCreditSpendPolicyListeners(next);
+        }
+      }
       this.persistContextToCache(contextString(context));
       this.flushContextDependentEventQueue();
       this.setIsPending(false);
@@ -3233,10 +3337,19 @@ var Schematic = class {
           this.creditBalances[contextStr] = balances;
         }
       }
+      let revivedCreditSpendPolicies;
+      if (entry.creditSpendPolicies !== void 0 && entry.creditSpendPolicies !== null) {
+        const policies = CreditSpendPoliciesFromJSON(entry.creditSpendPolicies);
+        if (policies.length > 0) {
+          revivedCreditSpendPolicies = policies;
+          this.creditSpendPolicies[contextStr] = policies;
+        }
+      }
       fresh[contextStr] = {
         checks: revivedChecks,
         plan: revivedPlan,
         creditBalances: revivedCreditBalances,
+        creditSpendPolicies: revivedCreditSpendPolicies,
         updatedAt: entry.updatedAt
       };
       contextsLoaded += 1;
@@ -3250,7 +3363,8 @@ var Schematic = class {
     const checksForContext = this.checks[contextStr];
     const planForContext = this.planChecks[contextStr];
     const creditBalancesForContext = this.creditBalances[contextStr];
-    if (checksForContext === void 0 && planForContext === void 0 && creditBalancesForContext === void 0) {
+    const creditSpendPoliciesForContext = this.creditSpendPolicies[contextStr];
+    if (checksForContext === void 0 && planForContext === void 0 && creditBalancesForContext === void 0 && creditSpendPoliciesForContext === void 0) {
       return;
     }
     if (this.cachedFlagState === null) {
@@ -3269,6 +3383,7 @@ var Schematic = class {
       checks: cleanChecks,
       plan: planForContext,
       creditBalances: creditBalancesForContext,
+      creditSpendPolicies: creditSpendPoliciesForContext,
       updatedAt: Date.now()
     };
     const entries = Object.entries(this.cachedFlagState.contexts);
@@ -3285,6 +3400,9 @@ var Schematic = class {
       for (const key of Object.keys(this.creditBalances)) {
         if (!survivorKeys.has(key)) delete this.creditBalances[key];
       }
+      for (const key of Object.keys(this.creditSpendPolicies)) {
+        if (!survivorKeys.has(key)) delete this.creditSpendPolicies[key];
+      }
       this.cachedFlagState = {
         version: cacheVersion,
         contexts: Object.fromEntries(survivors)
@@ -3879,6 +3997,18 @@ var Schematic = class {
     const contextStr = contextString(this.context);
     return this.creditBalances[contextStr]?.[creditId];
   };
+  /** Get every credit spend policy binding the current context, company-scope first */
+  getCreditSpendPolicies = () => {
+    const contextStr = contextString(this.context);
+    return this.creditSpendPolicies[contextStr] ?? emptyCreditSpendPolicies;
+  };
+  /** Get the spend policies binding a single credit type in the current context */
+  getCreditSpendPoliciesForCredit = (creditId) => {
+    const policies = this.getCreditSpendPolicies().filter(
+      (policy) => policy.creditId === creditId
+    );
+    return policies.length > 0 ? policies : emptyCreditSpendPolicies;
+  };
   // flag checks state
   getFlagCheck = (flagKey) => {
     const contextStr = contextString(this.context);
@@ -3945,6 +4075,13 @@ var Schematic = class {
       this.creditBalanceListeners.delete(listener);
     };
   };
+  /** Register an event listener that will be notified with the context's credit spend policies whenever the set changes */
+  addCreditSpendPolicyListener = (listener) => {
+    this.creditSpendPolicyListeners.add(listener);
+    return () => {
+      this.creditSpendPolicyListeners.delete(listener);
+    };
+  };
   notifyFlagCheckListeners = (flagKey, check) => {
     const listeners = this.flagCheckListeners?.[flagKey] ?? [];
     if (listeners.size > 0) {
@@ -4008,6 +4145,16 @@ var Schematic = class {
       });
     });
   };
+  notifyCreditSpendPolicyListeners = (value) => {
+    const listeners = this.creditSpendPolicyListeners ?? [];
+    listeners.forEach((listener) => {
+      if (listener.length > 0) {
+        listener(value);
+        return;
+      }
+      listener();
+    });
+  };
   notifyCreditBalanceListeners = (value) => {
     const listeners = this.creditBalanceListeners ?? [];
     if (listeners.size > 0) {
@@ -5030,7 +5177,7 @@ function staticSource(data) {
 }
 
 // src/version.ts
-var version2 = "1.9.0";
+var version2 = "1.10.0";
 
 // src/context/schematic.tsx
 import { jsx as jsx4 } from "react/jsx-runtime";
@@ -5123,6 +5270,7 @@ var useSchematic = () => {
 
 // src/hooks/schematic.ts
 import { useMemo as useMemo6, useSyncExternalStore as useSyncExternalStore2, useCallback as useCallback2 } from "react";
+var emptyPolicies = [];
 var useSchematicClient = (opts) => {
   const schematic = useSchematic();
   const { client } = opts ?? {};
@@ -5238,6 +5386,34 @@ var useSchematicCreditBalance = (creditId, opts) => {
     [balance, isPending]
   );
 };
+var useSchematicCreditSpendPolicies = (opts) => {
+  const client = useSchematicClient(opts);
+  const subscribe = useCallback2(
+    (callback) => client.addCreditSpendPolicyListener(callback),
+    [client]
+  );
+  const policies = useSyncExternalStore2(
+    subscribe,
+    () => client.getCreditSpendPolicies(),
+    () => emptyPolicies
+  );
+  const isPendingSubscribe = useCallback2(
+    (callback) => client.addIsPendingListener(callback),
+    [client]
+  );
+  const isPending = useSyncExternalStore2(
+    isPendingSubscribe,
+    () => client.getIsPending(),
+    () => true
+  );
+  return useMemo6(
+    () => ({
+      policies,
+      isLoading: policies.length === 0 && isPending
+    }),
+    [policies, isPending]
+  );
+};
 var useSchematicIsPending = (opts) => {
   const client = useSchematicClient(opts);
   const subscribe = useCallback2(
@@ -5269,6 +5445,7 @@ export {
   useSchematic,
   useSchematicContext,
   useSchematicCreditBalance,
+  useSchematicCreditSpendPolicies,
   useSchematicEntitlement,
   useSchematicEvents,
   useSchematicFlag,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schematichq/schematic-react",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "main": "dist/schematic-react.cjs.js",
   "module": "dist/schematic-react.esm.js",
   "types": "dist/schematic-react.d.ts",
@@ -34,7 +34,7 @@
   "devDependencies": {
     "@eslint/js": "^10.0.1",
     "@microsoft/api-extractor": "^7.59.2",
-    "@schematichq/schematic-js": "^1.9.0",
+    "@schematichq/schematic-js": "^1.10.0",
     "@testing-library/dom": "^10.4.2",
     "@testing-library/jest-dom": "^7.0.1",
     "@testing-library/react": "^16.3.3",