Registry / ai-ml / picorules-compiler-js-core

picorules-compiler-js-core

library1.1.1jsnpmunverified

Pure JavaScript/TypeScript compiler and runtime evaluator for the Picorules clinical decision support language. Compiles ruleblocks to optimized SQL (Oracle, SQL Server, PostgreSQL) or evaluates directly in JavaScript for single-patient use (browser, Node.js, edge). v1.1.1 – production-ready, zero runtime dependencies (Zod only for input validation), full type safety, tree-shakeable ESM/CJS, 406 tests. Unique: dual execution mode (SQL batch vs in-memory), pluggable data adapters (EADV built-in), automatic cross-ruleblock dependency resolution.

ai-ml database web-framework data serialization

npm install picorules-compiler-js-core

package ↗

INSTALL

IMPORT

SIG · PICORULES-COMPILER

picorules-compiler-js-core

ai-mljavascriptv1.1.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

compile

✓ import { compile } from 'picorules-compiler-js-core'

✗ const { compile } = require('picorules-compiler-js-core')

ESM-only since v1.0; use dynamic import for CJS.

parse

✓ import { parse } from 'picorules-compiler-js-core'

✗ import parse from 'picorules-compiler-js-core'

Named export, not default.

evaluate

✓ import { evaluate } from 'picorules-compiler-js-core'

✗ import { evaluate } from 'picorules-compiler-js-core/evaluate'

All exports from package root; no subpath exports.

EadvDataAdapter

✓ import { EadvDataAdapter } from 'picorules-compiler-js-core'

✗ import { EADVDataAdapter } from 'picorules-compiler-js-core'

Case-sensitive: 'Eadv' not 'EADV'.

Dialect

✓ import { Dialect } from 'picorules-compiler-js-core'

✗ import Dialect from 'picorules-compiler-js-core'

Named enum export.

evaluateAll

✓ import { evaluateAll } from 'picorules-compiler-js-core'

✗ import { evaluateAll } from 'picorules-compiler-js-core/runtime'

Available from root index.

Parses a Picorules ruleblock, loads EADV patient data, and evaluates the rule in JavaScript (no SQL required).

import { parse, evaluate, EadvDataAdapter } from 'picorules-compiler-js-core'; const prbSource = ` #define_ruleblock(cd_obesity, { description: "BMI assessment", is_active: 2 }); ht => eadv.obs_height.val.lastdv(); wt => eadv.obs_weight.val.lastdv(); bmi : { ht_val!? and wt_val!? => round(wt_val / power(ht_val / 100, 2), 1) }; is_obese : { bmi > 30 => 1 }, { => 0 }; `; const parsed = parse([{ name: 'cd_obesity', text: prbSource, isActive: true }]); const adapter = new EadvDataAdapter([ { eid: 1, att: 'obs_height', dt: '2024-06-01', val: 170 }, { eid: 1, att: 'obs_weight', dt: '2024-06-01', val: 95 }, ]); const result = evaluate(parsed[0], adapter); console.log(result); // { ht_val: 170, ht_dt: Date, wt_val: 95, wt_dt: Date, bmi: 32.9, is_obese: 1 }

Debug

Known issues

breakingv1.1.0 changed the `compile` return type: `.sql` is now an array of strings indexed by ruleblock order, not an object keyed by ruleblock name.

fix

Access result.sql[index] instead of result.sql[ruleblockName].

affects: <1.1.0

breakingv1.0 required Node.js >= 14; v1.1+ requires Node.js >= 16 due to ES2021 features.

fix

Upgrade Node.js to >= 16.

affects: >=1.1.0

deprecatedThe `evaluate` function's second parameter `adapter` formerly accepted plain objects; now requires an `EadvDataAdapter` instance.

fix

Wrap data with `new EadvDataAdapter(data)` before passing to `evaluate`.

affects: <1.1.0

gotchaRuleblock names must be unique; duplicate names cause silent overwrite.

fix

Ensure each ruleblock has a distinct `name` field.

affects: all

gotchaThe `evaluate` mode does NOT support all SQL dialects; it only works with EADV data adapter. For other data sources, compile to SQL and execute externally.

fix

Use `compile()` for non-EADV databases.

affects: all

gotchaTypeScript users: `Dialect` enum values are strings; ensure you use `Dialect.ORACLE`, not raw strings like `'oracle'`.

fix

Always import and use the `Dialect` enum.

affects: all

Errors

Common errors & fixes

TypeError: Cannot read properties of undefined (reading 'lastdv')

Data adapter not properly initialized or empty data array.

fix

Ensure EadvDataAdapter receives an array of EADV observations. At minimum: [{ eid: 1, att: 'some_att', dt: '2024-01-01', val: 123 }]

Error: Ruleblock 'X' imports unknown symbol 'Y'

Cross-ruleblock reference to a symbol that does not exist in any parsed ruleblock.

fix

Check that all referenced ruleblocks are included in the array passed to `parse()` and that spelling matches.

SyntaxError: Unexpected token '#' in JSON at position 0

Mistakenly tried to parse a `.prb` file as JSON instead of raw text.

fix

Read the .prb file as a string (e.g., using fs.readFileSync) and pass the text to `parse()`.

Module not found: Error: Can't resolve 'picorules-compiler-js-core' in '/path'

Package not installed or import path incorrect in bundler environment.

fix

Run `npm install picorules-compiler-js-core`. Ensure your bundler resolves ESM (set `"type": "module"` in package.json or use `.mjs` extension).

Upgrade

Version history

1.1.1latest on npm

Audit

Dependencies

zodrequiredInput validation for ruleblock sources and options

Agent activity

5 hits · last 30 days

node

Resources

packagehttps://www.npmjs.com/package/picorules-compiler-js-core ↗