fast-publicodes 1.0.0 → 1.1.0

package/README.md

@@ -41,8 +41,8 @@ On the [modele-social](https://www.npmjs.com/package/modele-social) rules (`pnpm
 
 ## Limitations
 
-- **No AST.** `evaluate()` returns `nodeValue`, `unit` and `missingVariables` without `explanation`, and rules returned by `getRule()` and `getParsedRules()` carry their metadata without their node tree. `parsePublicodes`, `reduceAST`, `transformAST`, `traverseASTNode`, `utils.cyclicDependencies`, `utils.disambiguateReferenceNode` and `utils.updateReferencesMapsFromReferenceNode` are not provided, and `evaluate()` does not accept an AST node.
-- **No internal fields.** The members `publicodes` marks as internal (`context`, `baseContext`, `publicParsedRules`, `cache` and `evaluateNode`) do not exist.
+- **No AST.** `evaluate()` returns `nodeValue`, `unit` and `missingVariables` without `explanation`, and rules returned by `getRule()` and `getParsedRules()` carry their metadata without their node tree; their `suggestions` are opaque values that only `evaluate()` reads. `parsePublicodes`, `reduceAST`, `transformAST`, `traverseASTNode`, `utils.cyclicDependencies`, `utils.disambiguateReferenceNode` and `utils.updateReferencesMapsFromReferenceNode` are not provided, and `evaluate()` accepts no AST node other than these suggestions.
+- **Internal fields.** Of the members `publicodes` marks as internal, only `context.nodesTypes` exists, with the type inferred for each rule `getRule()` returns; `baseContext`, `publicParsedRules`, `cache`, `evaluateNode` and the rest of `context` do not.
 - **`undefined` inside rules.** A property of a rule set to `undefined` counts as absent, where `publicodes` reads some of them as an empty value.
 
 ## Development

package/dist/binding.d.ts

@@ -8,6 +8,7 @@ export interface Binding {
 export interface NativeEngine {
     setSituation(situation: string, keepPrevious: boolean, strict: boolean): object;
     evaluate(text: string, json: boolean): object;
+    evaluateSuggestion(rule: string, name: string): object;
     evaluations(): unknown;
     missingVariables(evaluations: unknown, index: number): object;
     takeWarnings(): object;

package/dist/engine.d.ts

@@ -1,10 +1,14 @@
-import type { EngineOptions, EvaluatedNode, ParsedRules, Possibility, PublicodesExpression, RawPublicodes, RuleNode, Situation } from "./types.js";
+import type { EngineOptions, EvaluatedNode, InferedType, ParsedRules, Possibility, PublicodesExpression, RawPublicodes, RuleNode, Situation } from "./types.js";
 export declare class Engine<RuleNames extends string = string> {
     private native;
     private logger;
     private publicSituation;
     private parsedRules;
     private rules;
+    /** `nodesTypes` alone, for the rule nodes `getRule()` returns. */
+    context: {
+        nodesTypes: WeakMap<RuleNode, InferedType>;
+    };
     private warningTexts;
     private unitKey;
     /** Results by evaluated value, until the cache is reset. */
@@ -21,6 +25,7 @@ export declare class Engine<RuleNames extends string = string> {
     private accept;
     getSituation(): Situation<RuleNames>;
     evaluate(value: PublicodesExpression): EvaluatedNode;
+    private evaluateNative;
     getRule(dottedName: RuleNames): RuleNode<RuleNames>;
     getParsedRules(): ParsedRules<RuleNames>;
     getPossibilitiesFor(dottedName: RuleNames, { filterNotApplicable }?: {

package/dist/engine.js

@@ -63,12 +63,18 @@ function createNative(rules, options, logger, unitKey) {
         throw fromNative(details);
     }
 }
+/** The rule and name of each suggestion `getRule()` returns, which any engine evaluates. */
+const suggestionSources = new WeakMap();
 export class Engine {
     native;
     logger;
     publicSituation = {};
     parsedRules;
     rules = new Map();
+    /** `nodesTypes` alone, for the rule nodes `getRule()` returns. */
+    context = {
+        nodesTypes: new WeakMap(),
+    };
     warningTexts = [];
     unitKey;
     /** Results by evaluated value, until the cache is reset. */
@@ -134,9 +140,7 @@ export class Engine {
         if (typeof value === "object" && value !== null && "nodeKind" in value) {
             throw new PublicodesError("EngineError", "fast-publicodes n'évalue pas les nœuds d'AST", {});
         }
-        const json = typeof value !== "string";
-        const text = json ? toJson(value) : value;
-        const result = this.native.evaluate(text, json);
+        const result = this.evaluateNative(value);
         this.logWarnings(result);
         this.unitKey?.rethrow();
         const { nodeValue, index, ...nativeUnit } = unwrap(result);
@@ -157,12 +161,31 @@ export class Engine {
         this.evaluations.set(value, evaluation);
         return evaluation;
     }
+    evaluateNative(value) {
+        const suggestion = typeof value === "object" ? suggestionSources.get(value) : undefined;
+        if (suggestion) {
+            return this.native.evaluateSuggestion(suggestion.rule, suggestion.name);
+        }
+        const json = typeof value !== "string";
+        const text = json ? toJson(value) : value;
+        return this.native.evaluate(text, json);
+    }
     getRule(dottedName) {
         let rule = this.rules.get(dottedName);
         if (!rule) {
             const result = this.native.rule(dottedName);
-            rule = JSON.parse(unwrap(result).rule);
+            const { node, type, suggestions } = JSON.parse(unwrap(result).rule);
+            rule = { ...node, suggestions: {} };
+            for (const name of suggestions) {
+                const suggestion = Object.freeze({});
+                suggestionSources.set(suggestion, { rule: dottedName, name });
+                rule.suggestions[name] = suggestion;
+            }
             this.rules.set(dottedName, rule);
+            this.context.nodesTypes.set(rule, {
+                isNullable: type.isNullable ?? undefined,
+                type: type.type ?? undefined,
+            });
         }
         return rule;
     }
@@ -212,6 +235,7 @@ export class Engine {
         copy.publicSituation = { ...this.publicSituation };
         copy.parsedRules = this.parsedRules;
         copy.rules = this.rules;
+        copy.context = this.context;
         copy.warningTexts = [...this.warningTexts];
         copy.unitKey = this.unitKey;
         copy.evaluations = copyCache ? new Map(this.evaluations) : new Map();

package/dist/types.d.ts

@@ -36,6 +36,8 @@ export interface RuleNode<Name extends string = string> {
     private: boolean;
     virtualRule: boolean;
     rawNode: Rule;
+    /** What `evaluate()` takes to evaluate each suggestion, as in the rule's context. */
+    suggestions: Record<string, Suggestion>;
     possibilities: {
         nodeKind: "une possibilité";
         type: "number" | "string" | "reference";
@@ -43,6 +45,13 @@ export interface RuleNode<Name extends string = string> {
         explanation: Possibility[];
     } | null;
 }
+/** A suggestion of a rule, which only `evaluate()` reads. */
+export type Suggestion = Readonly<Record<string, never>>;
+/** The type `publicodes` infers for a node. */
+export interface InferedType {
+    isNullable: boolean | undefined;
+    type: "number" | "string" | "boolean" | "date" | undefined;
+}
 export type ParsedRules<RuleNames extends string = string> = Record<RuleNames, RuleNode<RuleNames>>;
 export interface Logger {
     log(message: string): void;

package/native/index.cjs

@@ -89,8 +89,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-android-arm64')
         const bindingPackageVersion = require('fast-publicodes-android-arm64/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -105,8 +105,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-android-arm-eabi')
         const bindingPackageVersion = require('fast-publicodes-android-arm-eabi/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -126,8 +126,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-win32-x64-gnu')
           const bindingPackageVersion = require('fast-publicodes-win32-x64-gnu/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -142,8 +142,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-win32-x64-msvc')
           const bindingPackageVersion = require('fast-publicodes-win32-x64-msvc/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -159,8 +159,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-win32-ia32-msvc')
         const bindingPackageVersion = require('fast-publicodes-win32-ia32-msvc/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -175,8 +175,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-win32-arm64-msvc')
         const bindingPackageVersion = require('fast-publicodes-win32-arm64-msvc/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -194,8 +194,8 @@ function requireNative() {
     try {
       const binding = require('fast-publicodes-darwin-universal')
       const bindingPackageVersion = require('fast-publicodes-darwin-universal/package.json').version
-      if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-        throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+      if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+        throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
       }
       return binding
     } catch (e) {
@@ -210,8 +210,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-darwin-x64')
         const bindingPackageVersion = require('fast-publicodes-darwin-x64/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -226,8 +226,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-darwin-arm64')
         const bindingPackageVersion = require('fast-publicodes-darwin-arm64/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -246,8 +246,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-freebsd-x64')
         const bindingPackageVersion = require('fast-publicodes-freebsd-x64/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -262,8 +262,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-freebsd-arm64')
         const bindingPackageVersion = require('fast-publicodes-freebsd-arm64/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -283,8 +283,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-linux-x64-musl')
           const bindingPackageVersion = require('fast-publicodes-linux-x64-musl/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -299,8 +299,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-linux-x64-gnu')
           const bindingPackageVersion = require('fast-publicodes-linux-x64-gnu/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -317,8 +317,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-linux-arm64-musl')
           const bindingPackageVersion = require('fast-publicodes-linux-arm64-musl/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -333,8 +333,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-linux-arm64-gnu')
           const bindingPackageVersion = require('fast-publicodes-linux-arm64-gnu/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -351,8 +351,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-linux-arm-musleabihf')
           const bindingPackageVersion = require('fast-publicodes-linux-arm-musleabihf/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -367,8 +367,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-linux-arm-gnueabihf')
           const bindingPackageVersion = require('fast-publicodes-linux-arm-gnueabihf/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -385,8 +385,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-linux-loong64-musl')
           const bindingPackageVersion = require('fast-publicodes-linux-loong64-musl/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -401,8 +401,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-linux-loong64-gnu')
           const bindingPackageVersion = require('fast-publicodes-linux-loong64-gnu/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -419,8 +419,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-linux-riscv64-musl')
           const bindingPackageVersion = require('fast-publicodes-linux-riscv64-musl/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -435,8 +435,8 @@ function requireNative() {
         try {
           const binding = require('fast-publicodes-linux-riscv64-gnu')
           const bindingPackageVersion = require('fast-publicodes-linux-riscv64-gnu/package.json').version
-          if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -452,8 +452,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-linux-ppc64-gnu')
         const bindingPackageVersion = require('fast-publicodes-linux-ppc64-gnu/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -468,8 +468,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-linux-s390x-gnu')
         const bindingPackageVersion = require('fast-publicodes-linux-s390x-gnu/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -488,8 +488,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-openharmony-arm64')
         const bindingPackageVersion = require('fast-publicodes-openharmony-arm64/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -504,8 +504,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-openharmony-x64')
         const bindingPackageVersion = require('fast-publicodes-openharmony-x64/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -520,8 +520,8 @@ function requireNative() {
       try {
         const binding = require('fast-publicodes-openharmony-arm')
         const bindingPackageVersion = require('fast-publicodes-openharmony-arm/package.json').version
-        if (bindingPackageVersion !== '1.0.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -661,8 +661,8 @@ if (!nativeBinding || forceWasi) {
       if (!candidateFailed) {
         if (process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
           const bindingPackageVersion = require('fast-publicodes-wasm32-wasi/package.json').version
-          if (bindingPackageVersion !== '1.0.0') {
-            throw new Error(`WASI binding package version mismatch, expected 1.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0') {
+            throw new Error(`WASI binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
         }
         wasiBinding = require('fast-publicodes-wasm32-wasi')

package/native/index.d.cts

@@ -34,6 +34,8 @@ export declare class Engine {
    * JSON when `json`.
    */
   evaluate(text: string, json: boolean): object
+  /** `evaluate`, for `getRule(rule).suggestions[name]`. */
+  evaluateSuggestion(rule: string, name: string): object
   /**
    * A handle on the expressions evaluated since the cache was last reset, for
    * `missingVariables`.
@@ -48,7 +50,10 @@ export declare class Engine {
   shallowCopy(copyCache: boolean): Engine
   /** The names of the public rules, in definition order. */
   ruleNames(): Array<string>
-  /** Returns `{ rule }`, the rule node as JSON, or `{ error }`. */
+  /**
+   * Returns `{ rule }`, the rule node with its inferred type and the names of its suggestions,
+   * as JSON, or `{ error }`.
+   */
   rule(name: string): object
   /** Returns `{ possibilities }`, as JSON, or `{ error }`. */
   applicablePossibilities(name: string): object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-publicodes",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A drop-in replacement for publicodes, with the engine written in Rust.",
   "license": "MIT",
   "repository": {

package/wasm/fast_publicodes.d.ts

@@ -15,6 +15,10 @@ export class Engine {
      * Returns `{ possibilities }`, as JSON, or `{ error }`.
      */
     applicablePossibilities(name: string): object;
+    /**
+     * `evaluate`, for `getRule(rule).suggestions[name]`.
+     */
+    evaluateSuggestion(rule: string, name: string): object;
     /**
      * Returns `{ nodeValue, index }`, `index` locating it in `evaluations`, with `unit` the index
      * of its unit in the table the caller keeps, or `newUnit` when it is new and takes the next
@@ -43,7 +47,8 @@ export class Engine {
      */
     ruleNames(): string[];
     /**
-     * Returns `{ rule }`, the rule node as JSON, or `{ error }`.
+     * Returns `{ rule }`, the rule node with its inferred type and the names of its suggestions,
+     * as JSON, or `{ error }`.
      */
     rule(name: string): object;
     /**
@@ -80,6 +85,7 @@ export interface InitOutput {
     readonly __wbg_evaluationshandle_free: (a: number, b: number) => void;
     readonly engine_applicablePossibilities: (a: number, b: number, c: number) => number;
     readonly engine_evaluate: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly engine_evaluateSuggestion: (a: number, b: number, c: number, d: number, e: number) => number;
     readonly engine_evaluations: (a: number) => number;
     readonly engine_inversionFail: (a: number) => number;
     readonly engine_missingVariables: (a: number, b: number, c: number) => number;

package/wasm/fast_publicodes.js

@@ -35,6 +35,20 @@ export class Engine {
         const ret = wasm.engine_applicablePossibilities(this.__wbg_ptr, ptr0, len0);
         return takeObject(ret);
     }
+    /**
+     * `evaluate`, for `getRule(rule).suggestions[name]`.
+     * @param {string} rule
+     * @param {string} name
+     * @returns {object}
+     */
+    evaluateSuggestion(rule, name) {
+        const ptr0 = passStringToWasm0(rule, wasm.__wbindgen_export, wasm.__wbindgen_export2);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(name, wasm.__wbindgen_export, wasm.__wbindgen_export2);
+        const len1 = WASM_VECTOR_LEN;
+        const ret = wasm.engine_evaluateSuggestion(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+        return takeObject(ret);
+    }
     /**
      * Returns `{ nodeValue, index }`, `index` locating it in `evaluations`, with `unit` the index
      * of its unit in the table the caller keeps, or `newUnit` when it is new and takes the next
@@ -138,7 +152,8 @@ export class Engine {
         }
     }
     /**
-     * Returns `{ rule }`, the rule node as JSON, or `{ error }`.
+     * Returns `{ rule }`, the rule node with its inferred type and the names of its suggestions,
+     * as JSON, or `{ error }`.
      * @param {string} name
      * @returns {object}
      */

package/wasm/fast_publicodes_bg.wasm.d.ts

@@ -5,6 +5,7 @@ export const __wbg_engine_free: (a: number, b: number) => void;
 export const __wbg_evaluationshandle_free: (a: number, b: number) => void;
 export const engine_applicablePossibilities: (a: number, b: number, c: number) => number;
 export const engine_evaluate: (a: number, b: number, c: number, d: number, e: number) => void;
+export const engine_evaluateSuggestion: (a: number, b: number, c: number, d: number, e: number) => number;
 export const engine_evaluations: (a: number) => number;
 export const engine_inversionFail: (a: number) => number;
 export const engine_missingVariables: (a: number, b: number, c: number) => number;