@coldsmirk/abacus-core 0.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Venus
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,375 @@
+# @coldsmirk/abacus-core
+
+Framework-agnostic [ZEN expression](https://gorules.io/docs/rules-engine/expression-language/) engine for the frontend. Compile, evaluate, and type-analyze ZEN expressions on top of the [GoRules ZEN](https://github.com/gorules/zen) WebAssembly engine. Pure TypeScript — no React, no DOM, no UI framework.
+
+Part of [abacus](https://github.com/coldsmirk/abacus). To edit expressions in an editor, add [`@coldsmirk/abacus-codemirror`](https://www.npmjs.com/package/@coldsmirk/abacus-codemirror) (any framework) or [`@coldsmirk/abacus-react`](https://www.npmjs.com/package/@coldsmirk/abacus-react) (a ready-made `<ExpressionInput>`).
+
+## What you get
+
+- **Evaluate** ZEN expressions against a data context, sync or async.
+- **Compile** a structured, UI-authored condition tree into a single ZEN boolean expression, and **select** a matching branch by priority.
+- **Type-analyze** an expression against a variable-context type tree — the inferred type of every span, autocomplete metadata, and positioned diagnostics that power an editor.
+- **Localize** all editor-produced text through a typed, extensible message catalog.
+- **Strong typing** end to end, dual ESM / CJS, and a single lazily-loaded WebAssembly engine instance.
+
+## Install
+
+```bash
+pnpm add @coldsmirk/abacus-core
+```
+
+The ZEN WebAssembly engine (`@gorules/zen-engine-wasm`) is a regular dependency and installs automatically. Node.js >= 22; browsers need ES2023 support (Chrome/Edge 111+, Safari 16.2+, Firefox 115+) — the bundles ship untranspiled.
+
+## Quick start
+
+```ts
+import { evaluate, evaluateUnary, loadEngine } from "@coldsmirk/abacus-core";
+
+// The engine loads on first use; await it (or any async helper) once up front.
+await loadEngine();
+
+// A standard expression evaluates to any value.
+await evaluate("amount * 1.2", { amount: 100 });        // 120
+
+// A unary (test) expression is a boolean condition whose implicit subject is `$`.
+await evaluateUnary("$ > 1000", { $: 1500 });           // true
+```
+
+## Core concepts
+
+### Standard vs unary expressions
+
+ZEN has two expression flavours, selected throughout this package by a `mode: "standard" | "unary"`:
+
+- **standard** — computes a value of any type, e.g. `amount * 1.2`, `customer.name`, `upper(code)`.
+- **unary** — a boolean _test_ against an implicit subject `$`, e.g. `$ > 1000`, `$ in ['BJ', 'SH']`. Used for conditions.
+
+### The engine loads once, lazily
+
+The multi-megabyte WebAssembly binary is fetched on first use via a dynamic `import()`, then cached as a single frozen instance for the lifetime of the page. Every helper comes in two forms:
+
+- **async** (`evaluate`, `analyzeTypes`, …) — loads the engine on demand, then runs. Safe to call any time.
+- **sync** (`evaluateSync`, `analyzeTypesSync`, …) — run immediately, but throw `ExpressionNotReadyError` if the engine has not loaded yet. Use them only behind a readiness check (`isEngineReady()`) or after `await loadEngine()`. They exist for hot paths like an editor's per-keystroke type-checking, where awaiting a promise each call is not an option.
+
+```ts
+import { evaluateSync, isEngineReady, loadEngine } from "@coldsmirk/abacus-core";
+
+await loadEngine();
+if (isEngineReady()) {
+  evaluateSync<number>("a + b", { a: 1, b: 2 });        // 3
+}
+```
+
+## Evaluating expressions
+
+```ts
+function evaluate<T = unknown>(expression: string, context?: ExpressionContext): Promise<T>;
+function evaluateSync<T = unknown>(expression: string, context?: ExpressionContext): T;
+function evaluateUnary(expression: string, context?: ExpressionContext): Promise<boolean>;
+function evaluateUnarySync(expression: string, context?: ExpressionContext): boolean;
+```
+
+`ExpressionContext` is just `Record<string, unknown>` — the object property paths in the expression resolve against. `evaluate("customer.age", { customer: { age: 30 } })` → `30`.
+
+The `T` type parameter on `evaluate` / `evaluateSync` is an **unchecked assertion** — the value is returned as `T` with no runtime validation, since a ZEN result type depends on the expression and context. Prefer the `unknown` default and narrow at the call site, or pass `T` only when you are sure.
+
+A failed evaluation throws `ExpressionError` carrying the offending `expression` and the original cause:
+
+```ts
+import { ExpressionError, evaluate } from "@coldsmirk/abacus-core";
+
+try {
+  await evaluate("amount > ");                          // malformed
+} catch (error) {
+  if (error instanceof ExpressionError) {
+    error.expression;                                   // "amount > "
+    error.cause;                                        // the underlying engine error
+  }
+}
+```
+
+## Engine lifecycle
+
+```ts
+function loadEngine(): Promise<ExpressionEngine>;        // load once; concurrent callers share the promise
+function isEngineReady(): boolean;                       // has it finished loading?
+function getEngineSync(): ExpressionEngine;              // the instance, or throws ExpressionNotReadyError
+function getEngineError(): ExpressionError | null;       // the last load failure, if any
+function configureEngine(options: LoadEngineOptions): void;
+function resetEngine(): void;
+```
+
+`loadEngine()` is idempotent: the first call starts the load, and concurrent or later calls share the same in-flight promise (and then the resolved instance). A **failed** load is not cached — the rejected promise is dropped (the error is latched on `getEngineError()` for inspection) so a later `loadEngine()` retries from scratch. This is the clear-and-reload retry primitive after a transient failure.
+
+`ExpressionEngine` is the low-level synchronous instance returned by `loadEngine()` / `getEngineSync()`. Most apps use the top-level helpers above instead of calling its methods directly, but it is exported for advanced use:
+
+```ts
+interface ExpressionEngine {
+  evaluate: <T = unknown>(expression: string, context?: ExpressionContext) => T;
+  evaluateUnary: (expression: string, context?: ExpressionContext) => boolean;
+  validate: (expression: string) => unknown;            // ZEN's raw diagnostic payload (null when valid)
+  validateUnary: (expression: string) => unknown;
+  getCompletions: () => unknown;                         // ZEN's raw completion metadata
+  analyze: (variables: ExpressionType, source: string, unary: boolean) => ExpressionAnalysis;
+  satisfies: (actual: ExpressionType, expected: ExpressionType) => boolean;
+  isReady: () => boolean;
+}
+```
+
+### Hosting the WebAssembly binary
+
+In a normal browser app, the engine resolves its co-located `.wasm` through the GoRules package's own `import.meta.url`, which bundlers (Vite, webpack, Rspack) rewrite to a served asset URL — **no configuration needed**.
+
+For environments where that automatic resolution does not work — a non-browser or non-DOM host (Node, SSR, a Web Worker) or CDN-hosted wasm — supply the binary explicitly via `configureEngine({ wasmInput })` **before** the first load. `wasmInput` accepts whatever the wasm initializer accepts (a URL, `Response`, `ArrayBuffer`, bytes, …):
+
+```ts
+import { configureEngine, loadEngine } from "@coldsmirk/abacus-core";
+
+configureEngine({ wasmInput: await fetch("https://cdn.example.com/zen.wasm").then(r => r.arrayBuffer()) });
+await loadEngine();
+```
+
+`configureEngine()` throws if called after the engine has started loading. `resetEngine()` drops the loaded engine, the cached type context, the latched error, and the configured input — mainly for tests, but also the way to re-`configureEngine()` after a load.
+
+## Type analysis & intelligence
+
+These functions power editors: completion, hover types, and diagnostics. They all accept a **variable-context type tree** of type `ExpressionType` describing the shape of the data the expression runs against.
+
+### The `ExpressionType` shape
+
+```ts
+type ExpressionType =
+  | "Any" | "Null" | "Bool" | "String" | "Number" | "Date"   // primitive kinds
+  | { Const: string }                                         // a literal constant
+  | { Enum: [string | undefined, string[]] }                  // a named enum + its members
+  | { Array: ExpressionType }                                 // a homogeneous array
+  | { Object: Record<string, ExpressionType> };               // a nested object
+```
+
+Example — a form context with a number, a string, and a nested object:
+
+```ts
+const variables: ExpressionType = {
+  Object: {
+    amount: "Number",
+    status: "String",
+    customer: { Object: { name: "String", since: "Date" } },
+    tags: { Array: "String" },
+  },
+};
+```
+
+### Functions
+
+```ts
+function analyzeTypes(variables: ExpressionType, source: string, mode: ExpressionMode): Promise<ExpressionAnalysis>;
+function getDiagnostics(expression: string, mode: ExpressionMode): Promise<ExpressionDiagnostic | null>;
+function getCompletionItems(): Promise<ExpressionCompletion[]>;
+function satisfiesType(actual: ExpressionType, expected: ExpressionType): Promise<boolean>;
+// ...each has a *Sync twin with the same signature (minus the Promise).
+```
+
+```ts
+import { analyzeTypes, getDiagnostics, satisfiesType } from "@coldsmirk/abacus-core";
+
+const analysis = await analyzeTypes(variables, "amount > 1000", "standard");
+analysis.rootKind;          // the context type (the variables object)
+analysis.spans[0].kind;     // "Bool" — spans[0] is the whole-expression result type
+
+await getDiagnostics("amount >", "standard");           // → positioned diagnostic, or null when valid
+await satisfiesType("Number", "Number");                // → true (is `actual` assignable to `expected`?)
+```
+
+The result shapes:
+
+```ts
+interface ExpressionAnalysis {
+  rootKind: ExpressionType;          // the context type
+  spans: ExpressionTypeSpan[];       // per-span inferred types; spans[0] is the whole-expression result
+}
+interface ExpressionTypeSpan {
+  error: string | null;              // a type error attached to this span, if any
+  kind: ExpressionType;              // the inferred type of this span
+  nodeKind: string;                  // the syntax-node kind
+  span: [number, number];            // [from, to] character offsets
+}
+interface ExpressionDiagnostic {
+  from: number;                      // start offset
+  to: number;                        // end offset
+  message: string;                   // human-readable message
+  source: string;                    // origin label, e.g. "Parser error" (localized)
+}
+interface ExpressionCompletion {
+  type: "function" | "method" | "variable";
+  label: string;                     // the name to insert
+  detail: string;                    // signature, e.g. "(value: string) -> number"
+  info: string;                      // description (localized)
+  boost: number | null;             // sort weight
+  methodFor: string | null;         // for methods, the type-kind they attach to, e.g. "Date"
+}
+```
+
+> Building an editor? You usually do not call these directly — `@coldsmirk/abacus-codemirror` and `@coldsmirk/abacus-react` wire them into CodeMirror for you.
+
+## Compiling conditions
+
+A common need is to let users author conditions in a UI (field / operator / value rows, AND/OR groups, prioritized branches) and turn that structure into a ZEN expression. This package models that structure and compiles it — without depending on any editor.
+
+### The condition model
+
+```ts
+interface FieldConditionInput {                 // a field/operator/value triple
+  kind: "field";
+  subject: string;                              // an identifier path, e.g. "amount" or "customer.age"
+  operator: ConditionOperator;
+  value: unknown;
+}
+interface ExpressionConditionInput {            // a raw ZEN expression, passed through
+  kind: "expression";
+  expression: string;
+}
+type ConditionInput = FieldConditionInput | ExpressionConditionInput;
+
+interface ConditionGroupInput {                 // conditions combined with AND
+  conditions: readonly ConditionInput[];
+}
+interface ConditionBranchInput {                // a branch guarded by groups combined with OR
+  id: string;
+  priority: number;                             // lower number = higher priority
+  isDefault?: boolean;
+  conditionGroups?: readonly ConditionGroupInput[];
+}
+```
+
+### Operators
+
+`ConditionOperator` is derived from the runtime constant `CONDITION_OPERATORS`, so validators and condition UIs can build their allow-list from one source of truth. Each maps to ZEN as follows:
+
+| Operator                    | ZEN output                                                                                     |
+| --------------------------- | ---------------------------------------------------------------------------------------------- |
+| `eq` / `ne`                 | `subject == value` / `subject != value`                                                        |
+| `gt` / `gte` / `lt` / `lte` | `subject > value` (and `>=`, `<`, `<=`)                                                        |
+| `contains` / `not_contains` | `contains(subject, value)` / `not contains(subject, value)`                                    |
+| `starts_with` / `ends_with` | `startsWith(subject, value)` / `endsWith(subject, value)`                                      |
+| `in` / `not_in`             | `subject in [..]` / `not (subject in [..])` (a scalar value is wrapped to a one-element array) |
+| `is_empty` / `is_not_empty` | a typed emptiness test (null / blank string / empty array) and its negation                    |
+
+### Compiling and selecting
+
+```ts
+function compileCondition(condition: ConditionInput): string | null;
+function compileGroup(group: ConditionGroupInput): string | null;       // conditions joined with AND
+function compileBranch(branch: ConditionBranchInput): string | null;    // groups joined with OR
+function selectBranch(branches: readonly ConditionBranchInput[], context: ExpressionContext): Promise<BranchSelection>;
+function selectBranchWith(
+  branches: readonly ConditionBranchInput[],
+  context: ExpressionContext,
+  engine: Pick<ExpressionEngine, "evaluate" | "validate">,
+): BranchSelection;                                                      // synchronous; bring your own loaded engine
+```
+
+```ts
+import { compileCondition, selectBranch } from "@coldsmirk/abacus-core";
+
+compileCondition({ kind: "field", subject: "amount", operator: "gt", value: 1000 });
+// → "amount > 1000"
+
+const branches = [
+  { id: "default", priority: 99, isDefault: true },
+  { id: "vip", priority: 1, conditionGroups: [{ conditions: [
+    { kind: "field", subject: "amount", operator: "gt", value: 1000 },
+  ] }] },
+];
+await selectBranch(branches, { amount: 1500 });        // { branchId: "vip", matched: true }
+await selectBranch(branches, { amount: 10 });          // { branchId: "default", matched: false }
+```
+
+`selectBranch` tests non-default branches in ascending `priority` order and returns the first whose compiled expression evaluates to `true`; otherwise it falls back to the default branch (or a `null` id if there is none). A branch whose expression throws at runtime (e.g. comparing a missing field) is treated as _not matching_ rather than propagating — so a missing value degrades to the default branch instead of crashing. In development (`NODE_ENV !== "production"`) a non-default branch that compiles to nothing — a mistyped subject, an unrepresentable value — logs a `console.warn`, since it can never match and would otherwise only show up as "always falls through to default".
+
+```ts
+type BranchSelection =
+  | { matched: true; branchId: string }                 // a non-default branch matched
+  | { matched: false; branchId: string | null };        // default fallback, or null if none
+```
+
+### Safety: subjects, values, and escaping
+
+The compiler is designed not to become an expression-injection sink:
+
+- A **subject** is emitted verbatim, so it must be a plain identifier path (`amount`, `user.age`, `items[0]`) whose segments are not ZEN reserved words (`and`, `or`, `not`, `in`, `true`, `false`, `null`). Anything else (`len(secret)`, `a or b`, a bare `true`, …) makes the condition compile to `null` and be dropped.
+- A **value** is serialized to a ZEN literal via `toZenLiteral`, never interpolated as code. Strings are quoted _raw_ (ZEN honours no backslash escapes) by picking a delimiter the value does not contain; a value that cannot be represented (an object, a string containing both quote styles, a non-finite number) makes the condition degrade to `null`.
+
+```ts
+function toZenLiteral(value: unknown): string;          // throws if the value has no faithful ZEN representation
+
+toZenLiteral("active");          // "'active'"
+toZenLiteral("it's");            // "\"it's\""   (switches delimiter)
+toZenLiteral(1500);              // "1500"
+toZenLiteral(["BJ", "SH"]);      // "['BJ', 'SH']"
+toZenLiteral(null);              // "null"
+```
+
+`compileCondition` / `compileGroup` / `compileBranch` return `null` (rather than throwing) whenever a part cannot be represented, so an incomplete or invalid condition simply drops out instead of producing broken ZEN.
+
+## Localization
+
+Every piece of editor-produced text — built-in descriptions, diagnostic origin labels, and type-check prose — flows through a single typed catalog, so you can switch language or override individual strings in one place. (The engine's own raw error bodies, identifiers, and type signatures are never translated.)
+
+```ts
+interface ExpressionMessages {
+  sourceLabel: (type?: string) => string;               // diagnostic origin, e.g. "parserError" → "Parser error"
+  completionInfo: (englishInfo: string) => string;      // translate a built-in's English description
+  typeCheckSource: string;                              // the source label on type-check diagnostics
+  expectedBoolean: (actualType: string) => string;      // warning for a non-boolean unary result
+  expectedType: (expectedType: string, actualType: string) => string;  // expected-type-mismatch warning
+}
+```
+
+```ts
+import { configureExpressionMessages } from "@coldsmirk/abacus-core";
+
+configureExpressionMessages({ locale: "zh-CN" });                       // switch to a built-in locale
+configureExpressionMessages({ messages: { typeCheckSource: "Validation" } });  // override individual strings
+```
+
+The catalog is **process-global and last-write-wins** — there is one active catalog per runtime, so configure it once at startup. Built-in catalogs `enMessages` (the default) and `zhCNMessages` are exported. `getExpressionMessages()` returns the active one.
+
+To add a language the library does not ship, register a full catalog under a key, then select it like any built-in — built-in and custom locales share one registry, so there is no privileged path:
+
+```ts
+import { configureExpressionMessages, enMessages, registerExpressionLocale } from "@coldsmirk/abacus-core";
+
+registerExpressionLocale("ja-JP", {
+  ...enMessages,
+  typeCheckSource: "型チェック",
+  // ...override the rest
+});
+configureExpressionMessages({ locale: "ja-JP" });
+```
+
+> `@coldsmirk/abacus-react` re-exports `configureExpressionMessages` / `registerExpressionLocale` and also exposes `locale` / `messages` on `ExpressionConfigProvider` for convenience.
+
+## Errors
+
+```ts
+class ExpressionError extends Error {                    // engine load / evaluation failure
+  readonly expression?: string;                          // the offending expression, if any
+  // `cause` carries the original failure
+}
+class ExpressionNotReadyError extends ExpressionError {  // a *Sync helper called before the engine loaded
+}
+```
+
+## API reference
+
+- **Evaluate** — `evaluate`, `evaluateSync`, `evaluateUnary`, `evaluateUnarySync`
+- **Engine lifecycle** — `loadEngine`, `isEngineReady`, `getEngineSync`, `getEngineError`, `configureEngine`, `resetEngine`
+- **Type analysis** — `analyzeTypes` / `analyzeTypesSync`, `getDiagnostics` / `getDiagnosticsSync`, `getCompletionItems` / `getCompletionItemsSync`, `satisfiesType` / `satisfiesTypeSync`
+- **Conditions** — `compileCondition`, `compileGroup`, `compileBranch`, `selectBranch`, `selectBranchWith`, `toZenLiteral`, `CONDITION_OPERATORS`
+- **Localization** — `configureExpressionMessages`, `registerExpressionLocale`, `getExpressionMessages`, `enMessages`, `zhCNMessages`
+- **Errors** — `ExpressionError`, `ExpressionNotReadyError`
+- **Types** — `ExpressionType`, `ExpressionMode`, `ExpressionContext`, `ExpressionEngine`, `LoadEngineOptions`, `ExpressionAnalysis`, `ExpressionTypeSpan`, `ExpressionCompletion`, `ExpressionDiagnostic`, `ExpressionMessages`, `ExpressionLocale`, `BuiltInExpressionLocale`, `ConfigureMessagesOptions`, `ConditionInput`, `FieldConditionInput`, `ExpressionConditionInput`, `ConditionGroupInput`, `ConditionBranchInput`, `ConditionOperator`, `BranchSelection`
+
+## License
+
+Apache-2.0