@objectstack/formula 4.0.4

package/.turbo/turbo-build.log

@@ -0,0 +1,22 @@
+
+> @objectstack/formula@4.0.4 build /home/runner/work/framework/framework/packages/formula
+> tsup --config ../../tsup.config.ts
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Using tsup config: /home/runner/work/framework/framework/tsup.config.ts
+CLI Target: es2020
+CLI Cleaning output folder
+ESM Build start
+CJS Build start
+ESM dist/index.mjs     8.51 KB
+ESM dist/index.mjs.map 22.93 KB
+ESM ⚡️ Build success in 83ms
+CJS dist/index.js     9.93 KB
+CJS dist/index.js.map 23.80 KB
+CJS ⚡️ Build success in 85ms
+DTS Build start
+DTS ⚡️ Build success in 2326ms
+DTS dist/index.d.mts 9.36 KB
+DTS dist/index.d.ts  9.36 KB

package/LICENSE

@@ -0,0 +1,202 @@
+                                 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 ObjectStack
+
+   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,9 @@
+# @objectstack/formula
+
+Canonical expression engine for ObjectStack.
+
+- **Dialect: `cel`** — [Common Expression Language](https://github.com/google/cel-spec) via [`@marcbachmann/cel-js`](https://github.com/marcbachmann/cel-js). Used for formulas, predicates (`condition` / `criteria` / `visible`), and seed dynamic values.
+- **Dialect: `js`** — sandboxed L2 hook bodies (delegated).
+- **Dialect: `cron`** — job schedules (delegated).
+
+See `content/docs/concepts/north-star.mdx` §8 "No private expression DSL" and `ROADMAP.md` M9.

package/dist/index.d.mts

@@ -0,0 +1,240 @@
+import { Expression, ExpressionInput } from '@objectstack/spec';
+import { Environment } from '@marcbachmann/cel-js';
+
+/**
+ * @objectstack/formula — public types
+ *
+ * The expression engine surface is intentionally minimal:
+ *
+ *  - {@link EvalContext}: input passed by call sites (hooks, seed loader, views).
+ *  - {@link EvalResult}: discriminated union — never throws to the caller.
+ *  - {@link DialectEngine}: contract any dialect (cel, js, cron) implements.
+ *
+ * The shape is shared across `cel`, `js` and `cron` so the kernel can route
+ * any persisted `Expression` to the correct engine without conditional logic.
+ */
+
+/**
+ * Runtime context for evaluating an expression.
+ *
+ * Every field is optional — call sites populate only what they have. The CEL
+ * engine binds `record`, `previous`, `input`, `os` directly as top-level
+ * variables when present.
+ */
+interface EvalContext {
+    /** Logical "now" snapshot — pinned per evaluation run for determinism. */
+    now?: Date;
+    /** Current authenticated subject (hook / action / view contexts). */
+    user?: {
+        id: string;
+        role?: string;
+        email?: string;
+        [key: string]: unknown;
+    };
+    /** Current organization (multi-tenant context). */
+    org?: {
+        id: string;
+        tier?: string;
+        [key: string]: unknown;
+    };
+    /** Deployment environment marker. */
+    env?: 'prod' | 'dev' | 'test' | string;
+    /** Record-shaped data: target row, hook record, view row, etc. */
+    record?: Record<string, unknown>;
+    /** Previous record state for update hooks. */
+    previous?: Record<string, unknown>;
+    /** Action / flow input payload. */
+    input?: Record<string, unknown>;
+    /**
+     * Optional kernel API for `os.exists / os.count / os.lookup`.
+     * Implemented opportunistically by call sites that have a query engine.
+     */
+    api?: {
+        exists?: (object: string, predicate: Expression) => boolean;
+        count?: (object: string, predicate: Expression) => number;
+        lookup?: (object: string, id: string) => Record<string, unknown> | null;
+    };
+    /** Free-form bag for niche call sites; merged onto the variable scope. */
+    extra?: Record<string, unknown>;
+}
+/** Result of a single evaluation. Never throws; callers branch on `ok`. */
+type EvalResult<T = unknown> = {
+    ok: true;
+    value: T;
+} | {
+    ok: false;
+    error: EvalError;
+};
+/** Structured error so AI callers can self-correct. */
+interface EvalError {
+    /**
+     * - `parse`     source string failed to parse to AST
+     * - `type`      static type-check failed
+     * - `runtime`   evaluation threw (division by zero, missing field, …)
+     * - `bounds`    exceeded execution limits (AST size, depth, …)
+     * - `dialect`   no engine registered for `expression.dialect`
+     */
+    kind: 'parse' | 'type' | 'runtime' | 'bounds' | 'dialect';
+    message: string;
+    /** Source position when known. */
+    pos?: {
+        start: number;
+        end: number;
+    };
+}
+/** Contract every dialect engine implements. */
+interface DialectEngine {
+    /** Dialect identifier — must match `Expression.dialect`. */
+    readonly dialect: string;
+    /**
+     * Parse + type-check + emit AST. Source-only — `expression.ast` is what
+     * actually gets persisted in `objectstack.json`.
+     */
+    compile(source: string): EvalResult<unknown>;
+    /** Evaluate a fully-resolved expression in the given context. */
+    evaluate<T = unknown>(expr: Expression, ctx: EvalContext): EvalResult<T>;
+}
+
+/**
+ * Dialect-pluggable Expression engine registry.
+ *
+ * Replaces the per-call-site `compileFormula` / `evaluateFormula` direct
+ * imports of the deleted custom engine. Call sites now ask the registry to
+ * dispatch by `expression.dialect`.
+ *
+ * Stub dialects (`js`, `cron`) are registered at module load with explicit
+ * `dialect`-error responses so call sites get a clear message instead of
+ * silent `undefined` (the old engine's anti-pattern).
+ */
+
+/** Register or replace a dialect engine. */
+declare function register(engine: DialectEngine): void;
+/** Look up a dialect engine without dispatching. */
+declare function getEngine(dialect: string): DialectEngine | undefined;
+/** Whether a dialect has a real (non-stub) implementation registered. */
+declare function hasDialect(dialect: string): boolean;
+/**
+ * The unified evaluation entry point. Replaces the old direct calls to
+ * `evaluateFormula` from the deleted custom engine.
+ */
+declare const ExpressionEngine: {
+    register: typeof register;
+    getEngine: typeof getEngine;
+    hasDialect: typeof hasDialect;
+    /**
+     * Compile-only — parse + type-check, returning the engine-native AST. Used
+     * by `objectstack compile` to normalize source into AST in artifacts.
+     */
+    compile(expr: Expression): EvalResult<unknown>;
+    /**
+     * Evaluate an expression in the given context. Never throws — branch on
+     * `result.ok`. Errors carry a `kind` for caller-side classification.
+     */
+    evaluate<T = unknown>(expr: Expression, ctx: EvalContext): EvalResult<T>;
+};
+
+/**
+ * CEL dialect engine — wraps `@marcbachmann/cel-js` with the ObjectStack
+ * stdlib, bounded execution limits, and result coercion.
+ *
+ * Why a thin wrapper:
+ *
+ *  - cel-js returns `BigInt` for ints. The kernel and CRM expect plain
+ *    numbers, so we coerce at the boundary.
+ *  - cel-js parses dotted names as receiver-typed methods; we register
+ *    `now()`, `today()`, `daysFromNow()` as bare functions and let `os.*`
+ *    refer to context data only (see {@link buildScope}).
+ *  - Bounds (`maxAstNodes`, `maxDepth`, …) are enforced spec-wide so
+ *    third-party plugins can't ship runaway predicates.
+ */
+
+/**
+ * Default execution bounds. Picked conservatively — every metadata-authored
+ * expression we've seen is well under these. If you hit them, the expression
+ * is too complex for ObjectStack and should be moved to a hook (`dialect: js`).
+ */
+declare const DEFAULT_LIMITS: {
+    readonly maxAstNodes: 256;
+    readonly maxDepth: 32;
+    readonly maxListElements: 64;
+    readonly maxMapEntries: 64;
+    readonly maxCallArguments: 16;
+};
+declare const celEngine: DialectEngine;
+
+/**
+ * ObjectStack standard CEL function library.
+ *
+ * Registered into the per-evaluation `Environment` by the CEL engine. All
+ * functions are pure given a pinned `now` — that determinism is what makes
+ * `objectstack build` artifacts byte-stable across runs.
+ *
+ * Function naming intentionally avoids the `os.` prefix because cel-js binds
+ * dotted names to receiver types. Instead, the `os` namespace in CEL holds
+ * *data* (`os.user`, `os.org`, `os.env`) supplied by the caller's
+ * {@link EvalContext}.
+ */
+
+/**
+ * Register the ObjectStack standard library into a CEL environment.
+ *
+ * The `now` resolver is closed over so each call uses the pinned
+ * `EvalContext.now` (or wall-clock fallback). Implementations are kept tiny
+ * and dependency-free — they're the contract surface for AI authors and must
+ * stay legible.
+ */
+declare function registerStdLib(env: Environment, now: () => Date): Environment;
+/**
+ * Build the variable scope for a single evaluation. Absent fields are simply
+ * not bound — CEL macros (`has(record.foo)`) handle missing-key safely.
+ */
+declare function buildScope(ctx: EvalContext): Record<string, unknown>;
+
+/**
+ * Seed-value resolver.
+ *
+ * `Dataset.records` accepts {@link SeedValue} = primitive | Expression | array
+ * | object — install-time resolution walks the tree and replaces any
+ * Expression node with its evaluated result. This is what makes
+ * `close_date: cel\`now() + duration("P30D")\`` resolve to *the customer's*
+ * "today + 30 days" instead of the developer's compile-time clock.
+ */
+
+type SeedPrimitive = string | number | boolean | null | Date;
+type SeedValue = SeedPrimitive | Expression | SeedValue[] | {
+    [key: string]: SeedValue;
+};
+/**
+ * Recursively resolve a SeedValue. Records that contain Expression leaves are
+ * evaluated with `ctx`; other values are passed through unchanged.
+ *
+ * Returns the first failure encountered. Callers (seed loader) typically
+ * abort the whole record on failure rather than silently writing partial data.
+ */
+declare function resolveSeed(value: SeedValue, ctx: EvalContext): EvalResult<unknown>;
+/**
+ * Resolve a single record (object of fields), pinning `ctx.now` so all
+ * expressions within see one logical clock.
+ */
+declare function resolveSeedRecord(record: Record<string, SeedValue>, ctx: EvalContext): EvalResult<Record<string, unknown>>;
+
+/**
+ * Normalize an {@link ExpressionInput} (string shorthand OR full envelope) into
+ * a fully-resolved {@link Expression} carrying both `source` and `ast`.
+ *
+ * Returns an EvalResult so the caller can render a structured compile error
+ * pointing at the offending metadata path.
+ */
+declare function normalizeExpression(input: ExpressionInput): EvalResult<Expression>;
+/**
+ * Walk an arbitrary JSON tree and normalize every embedded Expression in
+ * place. Used by the build pipeline to traverse the assembled metadata
+ * artifact. Returns the first error encountered (paired with the dotted path
+ * for diagnostics) or `null` when fully clean.
+ */
+declare function normalizeExpressionTree(root: unknown, path?: string[]): {
+    path: string;
+    error: EvalError;
+} | null;
+
+export { DEFAULT_LIMITS, type DialectEngine, type EvalContext, type EvalError, type EvalResult, ExpressionEngine, type SeedPrimitive, type SeedValue, buildScope, celEngine, getEngine, hasDialect, normalizeExpression, normalizeExpressionTree, register, registerStdLib, resolveSeed, resolveSeedRecord };