@schematichq/schematic-typescript-node 1.5.0 → 1.5.2

package/dist/credits/check.d.ts

@@ -26,15 +26,19 @@ export interface CreditCheckDeps {
  * Drives a single `client.check` with `usage` set.
  *
  * Steps:
- *   1. Resolve the matching credit-balance condition on the flag to get
- *      `creditId` + `consumptionRate`.
+ *   1. Probe the engine once (real balance, no preflight, no substitution) and
+ *      read the matched plan entitlement. If it isn't credit-metered
+ *      (`valueType != credit` — boolean/override grant, numeric allocation,
+ *      unlimited, or not entitled) there's nothing to lease: defer to the plain
+ *      check. Otherwise `creditId` + `consumptionRate` + `eventSubtype` come
+ *      straight off the entitlement — no structural flag scan.
  *   2. Acquire (or reuse) a lease for `(company, creditId)`.
  *   3. Try to reserve `quantity × consumptionRate` from the lease.
  *   4. Run the WASM rules engine against a substituted company snapshot
  *      (`credit_balances[creditId] = lease.localRemaining` *before* the
- *      reservation we just made was debited), plus `event_usage` options so
- *      the engine evaluates the post-call balance. The reservation we made
- *      in step 3 only sticks if the engine says allowed.
+ *      reservation we just made was debited), gating with `credit_cost` so the
+ *      engine evaluates the post-call balance. The reservation we made in step 3
+ *      only sticks if the engine says allowed.
  */
 export declare function checkWithLease(deps: CreditCheckDeps, key: string, evalCtx: api.CheckFlagRequestBody, options: CheckOptions, fallback: () => Promise<CheckResult>): Promise<CheckResult>;
 /**

package/dist/credits/types.d.ts

@@ -150,15 +150,17 @@ export interface CheckResult {
     /**
      * Entitlement payload from the check.
      *
-     * NOTE: `entitlement.creditRemaining` (and `creditTotal` / `creditUsed`) is
-     * NOT lease-aware and must not be used as a user-facing balance when credit
-     * leases are enabled. The WASM derives those fields from the company's
-     * server `creditBalances`, which a lease distorts: a plain `checkFlag` sees
-     * the balance net of the whole lease tranche (reads low/~0), and a
-     * lease-bearing `check()` sees the substituted *tranche-local* balance, not
-     * the company total. For any "credits remaining" display use
-     * `client.getCreditBalance(...).settled` (`B − spent`), which speaks the
-     * server's `remaining`/`reserved`/`settled` vocabulary.
+     * For a credit-metered feature the entitlement carries the lease-aware
+     * three-way split the server computes: `creditRemaining` (drawable now, open
+     * lease holds excluded), `creditReserved` (the open lease's unspent hold),
+     * and `creditSettled` (`creditRemaining + creditReserved` = the balance net
+     * of actual consumption). Bind a user-facing "credits remaining" counter to
+     * `creditSettled` — it's invariant to in-flight lease holds, so it doesn't
+     * dip mid-call the way the raw server balance does.
+     *
+     * These come from the company's resolved entitlement, so the lease-balance
+     * substitution a lease-bearing `check()` applies for gating does NOT distort
+     * them — the same values surface whether or not `usage` was passed.
      */
     entitlement?: api.RulesengineFeatureEntitlement;
     /** Flag key checked. */

package/dist/datastream/merge.d.ts

@@ -11,7 +11,7 @@ export declare function deepCopyUser(u: Schematic.RulesengineUser): Schematic.Ru
  * Partials don't carry refreshed entitlements, so when their derived fields
  * change in another part of the company we sync them here to match server
  * behavior:
- *   - creditRemaining ← credit_balances[credit_id]
+ *   - creditRemaining ← credit_balances[credit_id] (or credit_lease_balance[credit_id].remaining)
  *   - usage ← metric value matching (eventName, metricPeriod, monthReset)
  * Both are skipped when the partial also sends entitlements wholesale.
  *