@formancy/expressions

中文文档
0.13.0发布于 2026/11/06Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 5786

CEL parse, type-check, compile and evaluate, with formancy's safety policy.

原始使用文档
文档目录3 节
  1. Why CEL, and why wrapped
  2. Two load-bearing decisions
  3. Use

@formancy/expressions

CEL for formancy forms: parse, type-check, compile and evaluate, with the safety policy that makes it safe to run author-written expressions on a server.

Why CEL, and why wrapped

Conditional logic and computed values are written in the Common Expression Language rather than a JavaScript subset. CEL cannot loop, cannot recurse and has no user-defined functions — termination is a property of the language, not of a sandbox somebody maintains. It is typed, so errors surface when an author saves. And its syntax tree names exactly which variables an expression reads, which is what lets the engine build a dependency graph and reject a cyclic form before it ever runs.

The CEL implementation is wrapped, never re-exported: exactly one file imports it. Swapping implementations is a one-file change rather than an ecosystem migration.

Two load-bearing decisions

referencedPaths must never miss a dependency. It is what the engine's dependency graph is built from, so a missed read means a field that silently stops recomputing. Comprehension iteration variables are scoped correctly, dynamic indices are coarsened to the whole collection, and over-reporting is preferred to under-reporting in every ambiguous case.

Cost is metered deterministically, never by a clock. Steps are charged for data reads, comprehension iterations and the size of collections an expression produces; values entering evaluation are bounded at the boundary. A wall-clock budget would let a submission pass in a browser and fail its replay on a busy server, which would break the one-engine guarantee.

A map is handed over as one the library can read. The library tells a map by value.constructor, so an object holding a member of its own by that name — a group or a row with a field keyed constructor — is handed to it as a Map, every member read out of it charged as any read is (0185). A map an expression writes still holds no constructor, prototype or __proto__: the library leaves them out of a literal.

Capabilities (now, today, random) arrive as frozen values. This package structurally cannot read a clock.

Use

import { compile, evaluate, captureCapabilities } from '@formancy/expressions'

const program = compile('country == "CH"', {
  kind: 'visible',
  variables: { country: 'dyn' },
})
if (!program.ok) throw new Error(program.error.message)

const outcome = evaluate(program.program, { country: 'CH' }, {
  capabilities: captureCapabilities({ now: Date.now, today: () => '2026-09-20', random: Math.random }),
})

Money is a decimal backed by scaled integers, and mixing it with plain numbers is a check-time error with a hint naming the fix — price * 0.19 is refused, price * dec("0.19") is exact.

A variable may be declared by member, { row: { amount: 'decimal', copies: 'int' } }, so that row.amount is checked as a decimal and a member nobody declared is refused. Such a variable is read one member at a time: row in a list, a map, a branch or as the result is refused as variable_read_whole (0231).

Docs: apps/docs (Concepts → Logic and expressions).

版本与发布记录

@formancy/expressions 共发布 13 个版本,首次发布于 2026/09/21;过去 12 个月发布了 13 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.13.0latest2026/11/0610 天前
0.12.02026/11/0115 天前
0.11.02026/10/3016 天前
0.10.02026/10/3017 天前
0.9.02026/10/3017 天前
0.8.02026/10/2918 天前

关于 @formancy/expressions 的常见问题

@formancy/expressions 是什么?

CEL parse, type-check, compile and evaluate, with formancy's safety policy.

如何安装 @formancy/expressions?

在项目目录运行 npm install @formancy/expressions,或使用 pnpm add / yarn add / bun add。

@formancy/expressions 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@formancy/expressions 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@formancy/expressions 可以商用吗?

@formancy/expressions 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@formancy/expressions 的下载量有多少?

根据 npm 官方下载统计,@formancy/expressions 在 2026/10/16 – 2026/11/14 这 30 天内被下载 5,786 次,日均约 193 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@formancy/expressions 还在维护吗?

最新版本 0.13.0 发布于 2026/11/06(10 天前);至今共发布 13 个版本,其中过去 12 个月发布了 13 个;首次发布于 2026/09/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。