@schematichq/schematic-typescript-node 1.6.1 → 1.6.3

package/dist/wasm/rulesengine_bg.wasm.d.ts

@@ -5,6 +5,7 @@ export const __wbg_rulesenginejs_free: (a: number, b: number) => void;
 export const alloc: (a: number) => number;
 export const checkFlag: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
 export const checkFlagCombined: (a: number, b: number) => number;
+export const checkFlagsCombined: (a: number, b: number) => number;
 export const dealloc: (a: number, b: number) => void;
 export const getCurrentMetricPeriodStartForCalendarMetricPeriod: (a: number) => bigint;
 export const getCurrentMetricPeriodStartForCompanyBillingSubscription: (a: number, b: number) => bigint;
@@ -15,6 +16,7 @@ export const getResultJsonLength: () => number;
 export const get_version_key_wasm: () => number;
 export const rulesenginejs_checkFlag: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number, number];
 export const rulesenginejs_checkFlagWithOptions: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => [number, number, number, number];
+export const rulesenginejs_checkFlags: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number, number];
 export const rulesenginejs_getVersionKey: (a: number) => [number, number];
 export const rulesenginejs_new: () => number;
 export const setCurrentTimeMillis: (a: bigint) => void;

package/dist/wrapper.d.ts

@@ -66,27 +66,40 @@ export interface SchematicOptions {
      */
     creditLeases?: CreditLeaseConfig;
 }
+/**
+ * Options for a single flag check.
+ *
+ * `creditCost`, `usage` and `eventUsage` are preflight inputs: they ask
+ * "would this action be allowed?" rather than "is it allowed now". They apply
+ * on every evaluation path, forwarded to the WASM rules engine's
+ * `checkFlagWithOptions` when the flag is evaluated locally (DataStream) and
+ * sent as the request body's `preflight` when it is evaluated over the REST
+ * API. The engine picks the most specific knob for each condition it
+ * evaluates. No reservation is issued; for lease-backed gating use `check()`.
+ */
 export interface CheckFlagOptions {
     /** Default value to return on error. Can be a boolean or a function returning a boolean. If not provided, uses configured flag defaults */
     defaultValue?: boolean | (() => boolean);
     /** The maximum time to wait for a response in milliseconds */
     timeoutMs?: number;
     /**
-     * Preflight inputs forwarded to the WASM rules engine's
-     * `checkFlagWithOptions`. The engine picks the most specific knob for each
-     * condition it evaluates. Only applied when the flag is evaluated locally
-     * (DataStream); the REST fallback path does not support preflight and
-     * ignores these. No reservation is issued — for lease-backed gating use
-     * `check()` instead.
+     * Pre-computed cost of the action, keyed by credit id. Highest precedence
+     * for credit-balance gates. A cost of zero means the action is free, not
+     * that the input is absent.
      */
-    /** Pre-computed per-credit-id cost. Highest precedence for credit-balance gates. */
     creditCost?: Record<string, number>;
-    /** Single integer quantity applied to whatever numeric condition is being evaluated. */
+    /**
+     * Quantity applied to whatever numeric condition is being evaluated. Zero
+     * has no effect. Both the REST request body and the local (WASM) engine
+     * take an integer, so a fraction rounds up rather than letting the check
+     * pass on less usage than the action is about to record.
+     */
     usage?: number;
     /**
      * Simulated quantity scoped to a specific event subtype. Preferred over
      * `usage` when the subtype is known. Deliberately singular: one check
-     * preflights one action.
+     * preflights one action. `quantity` rounds up the same way `usage` does,
+     * and zero has no effect.
      */
     eventUsage?: {
         eventSubtype: string;
@@ -149,6 +162,8 @@ export declare class SchematicClient extends BaseClient {
     private prewarmResolveTimeoutMs;
     private creditLeaseMode?;
     private serverReservationTTL;
+    private closing;
+    private readonly pendingPrewarms;
     /**
      * Creates a new instance of the SchematicClient
      * @param opts - Configuration options for the client
@@ -222,6 +237,11 @@ export declare class SchematicClient extends BaseClient {
      * are still drawing on — doing so would refund the grant server-side and
      * pull the balance out from under them. Shared leases reclaim themselves:
      * they expire (client- and server-side) or are fully consumed.
+     *
+     * Lease work already in flight is waited out before the release, so an
+     * acquire that lands mid-shutdown is one the release can see. The wait and
+     * the release share one `SHUTDOWN_DRAIN_TIMEOUT_MS` budget, so close()
+     * stays bounded however slow the store or the wire is.
      * @returns Promise that resolves when everything has been stopped
      */
     close(): Promise<void>;
@@ -239,10 +259,10 @@ export declare class SchematicClient extends BaseClient {
      */
     prewarm(evalCtx: api.CheckFlagRequestBody, creditTypeIds: string[]): Promise<void>;
     /**
-     * Like `resolveCompanyId` but actively fetches the company over the
-     * datastream when only secondary keys are supplied, warming the cache as a
-     * side effect. Returns the resolved id, or undefined if the company never
-     * surfaced within `prewarmResolveTimeoutMs`.
+     * Like `resolveCompanyId` but, on a cache miss, actively fetches the
+     * company over the datastream, warming the cache as a side effect. Returns
+     * the resolved id, the `comp_`-prefixed id the keys carry if the company
+     * never surfaced within `prewarmResolveTimeoutMs`, or undefined.
      *
      * `identify` does not push a company into the datastream cache —  companies
      * are only streamed in response to a request. So we call `getCompany`
@@ -269,9 +289,8 @@ export declare class SchematicClient extends BaseClient {
      * through to a plain flag check and returns `{allowed: value}` with no
      * reservation, byte-compatible with `checkFlag` semantics. The caller's
      * preflight (`usage` / `eventSubtype`) is still threaded through the plain
-     * check, so any client-side evaluation path (datastream, replicator)
-     * gates on the post-call balance — just without a reservation. Only the
-     * REST fallback ignores preflight.
+     * check, so every evaluation path (datastream, replicator, REST) gates on
+     * the post-call balance — just without a reservation.
      */
     check(evalCtx: api.CheckFlagRequestBody, key: string, options?: CheckOptions): Promise<CheckResult>;
     /**
@@ -301,6 +320,14 @@ export declare class SchematicClient extends BaseClient {
      * event — across pods and process restarts, not just within one process.
      */
     trackWithReservation(reservation: Reservation | undefined, actualQuantity: number, options?: TrackWithReservationOptions): Promise<void>;
+    /**
+     * The Schematic company id for an evaluation context, resolved in the
+     * server's order: every supplied key/value pair is an ordinary entity key
+     * and gets looked up first; only when nothing matches is a value read as
+     * the company's own id, by its `comp_` prefix rather than by the name of
+     * the key it sits under. An account is free to define a key called `id`
+     * holding its own identifier, so the name alone settles nothing.
+     */
     private resolveCompanyId;
     /**
      * Send a non-blocking event to create or update companies and users.
@@ -317,6 +344,13 @@ export declare class SchematicClient extends BaseClient {
      * @throws Will log error if event enqueueing fails
      */
     track(body: api.EventBodyTrack, options?: TrackOptions): Promise<void>;
+    /**
+     * Enqueue a track event, optimistically bumping the cached company metric
+     * with it unless `updateMetrics` says not to. The bump is a local
+     * prediction of what the stream will push back, so it belongs only to an
+     * event that records usage the server has not already counted.
+     */
+    private emitTrack;
     /**
      * Sets the default value for a specific feature flag
      * @param flag - The feature flag identifier

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@schematichq/schematic-typescript-node",
-    "version": "1.6.1",
+    "version": "1.6.3",
     "private": false,
     "repository": {
         "type": "git",
@@ -59,7 +59,7 @@
     },
     "resolutions": {
         "sharp": "^0.35.4",
-        "undici": "7.29.0"
+        "undici": "7.29.1"
     },
     "packageManager": "yarn@1.22.22",
     "engines": {
@@ -69,7 +69,7 @@
     "license": "MIT",
     "resolutions": {
         "sharp": "^0.35.4",
-        "undici": "7.29.0"
+        "undici": "7.29.1"
     },
     "files": [
         "dist/**/*.js",