fast-publicodes 0.0.0 → 1.1.0

package/native/index.d.cts

@@ -0,0 +1,69 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+
+/**
+ * Which binding artifact the generated loader actually loaded: `'native'` for
+ * a native addon, otherwise the `platformArchABI` of the WASI flavor. Every
+ * flavor napi-rs can build is listed, because `NAPI_RS_NATIVE_LIBRARY_PATH`
+ * can point the loader at a WASI artifact this package does not build itself.
+ */
+export declare const __napiBindingTarget: 'native' | 'wasm32-wasi' | 'wasm32-wasip1'
+
+/**
+ * The engine, taking rules, options and situations as JSON.
+ *
+ * Calls report the warnings they raised as `warnings`: the text of a warning not sent before,
+ * which takes the next index in the table the caller keeps, or the index of one already sent.
+ * `warningsReset` asks the caller to empty its table first.
+ */
+export declare class Engine {
+  /**
+   * `get_today` gives the date `durée` defaults to, as `dd/mm/yyyy`. Fails with the error as
+   * JSON `{ name, message, dottedName, warnings }`.
+   */
+  constructor(rules: string, options: string, getToday: () => string, getUnitKey?: ((arg: string) => UnitKeyReturn) | undefined | null)
+  /**
+   * Returns `{ accepted }`, the names the situation gains, or `{ error, situationReset,
+   * accepted }`.
+   */
+  setSituation(situation: string, keepPrevious: boolean, strict: boolean): 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
+   * index, after `unitsReset` asks the caller to empty its table; or `{ error }`. `text` is
+   * 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`.
+   */
+  evaluations(): unknown
+  /** The missing variables of the evaluation at `index` in `evaluations`. */
+  missingVariables(evaluations: unknown, index: number): object
+  /** Returns the warnings raised by building the engine. */
+  takeWarnings(): object
+  inversionFail(): boolean
+  resetCache(): void
+  shallowCopy(copyCache: boolean): Engine
+  /** The names of the public rules, in definition order. */
+  ruleNames(): Array<string>
+  /**
+   * 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
+}
+export type NativeEngine = Engine
+
+/** `parseExpression`: returns `{ expression }`, as JSON, or `{ error }`. */
+export declare function parseExpression(expression: string, dottedName: string): object
+
+/** A thrown value: an `Error` and its message, or another value, which the caller keeps. */
+export interface Thrown {
+  message?: string
+}

package/package.json

@@ -1 +1,65 @@
-{"name":"fast-publicodes","version":"0.0.0","description":"Placeholder for fast-publicodes","license":"MIT"}
+{
+  "name": "fast-publicodes",
+  "version": "1.1.0",
+  "description": "A drop-in replacement for publicodes, with the engine written in Rust.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/troopay/fast-publicodes.git"
+  },
+  "homepage": "https://github.com/troopay/fast-publicodes#readme",
+  "bugs": "https://github.com/troopay/fast-publicodes/issues",
+  "keywords": [
+    "publicodes",
+    "rules",
+    "engine",
+    "rust",
+    "webassembly"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "node": "./dist/index.js",
+      "default": "./dist/web.js"
+    }
+  },
+  "files": [
+    "dist",
+    "native",
+    "wasm"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "packageManager": "pnpm@10.33.0",
+  "napi": {
+    "binaryName": "fast-publicodes"
+  },
+  "scripts": {
+    "build": "pnpm build:native --release && pnpm build:wasm && pnpm build:ts",
+    "build:native": "napi build --platform --manifest-path crates/node/Cargo.toml --output-dir native --js index.cjs --dts index.d.cts",
+    "build:wasm": "cargo build -p fast-publicodes-wasm --target wasm32-unknown-unknown --profile wasm && wasm-bindgen --target web --out-dir wasm --out-name fast_publicodes target/wasm32-unknown-unknown/wasm/fast_publicodes_wasm.wasm",
+    "build:ts": "tsc -p tsconfig.build.json",
+    "lint": "cargo clippy --workspace --all-targets -- -D warnings && cargo fmt --check && biome check && tsc --noEmit",
+    "format": "cargo fmt && biome check --write",
+    "test": "vitest run",
+    "test:wasm": "FAST_PUBLICODES_TARGET=wasm vitest run",
+    "bench": "pnpm build:native --release && vitest bench --run --reporter=default"
+  },
+  "devDependencies": {
+    "@betagouv/aides-velo": "4.0.0",
+    "@biomejs/biome": "2.5.15",
+    "@incubateur-ademe/nosgestesclimat": "4.17.2",
+    "@napi-rs/cli": "3.10.8",
+    "@napi-rs/cross-toolchain": "1.0.3",
+    "@types/node": "22.20.5",
+    "modele-social": "11.1.0",
+    "publicodes": "1.10.4",
+    "typescript": "7.0.2",
+    "vitest": "5.0.3",
+    "yaml": "2.9.1"
+  }
+}

package/wasm/fast_publicodes.d.ts

@@ -0,0 +1,127 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The engine, taking rules, options and situations as JSON.
+ *
+ * Calls report the warnings they raised as `warnings`: the text of a warning not sent before,
+ * which takes the next index in the table the caller keeps, or the index of one already sent.
+ * `warningsReset` asks the caller to empty its table first.
+ */
+export class Engine {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * 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
+     * index, after `unitsReset` asks the caller to empty its table; or `{ error }`. `text` is
+     * JSON when `json`.
+     */
+    evaluate(text: string, json: boolean): object;
+    /**
+     * A handle on the expressions evaluated since the cache was last reset, for
+     * `missingVariables`.
+     */
+    evaluations(): EvaluationsHandle;
+    inversionFail(): boolean;
+    /**
+     * The missing variables of the evaluation at `index` in `evaluations`.
+     */
+    missingVariables(evaluations: EvaluationsHandle, index: number): object;
+    /**
+     * `get_today` gives the date `durée` defaults to, as `dd/mm/yyyy`. Fails with the error as
+     * JSON `{ name, message, dottedName, warnings }`.
+     */
+    constructor(rules: string, options: string, get_today: Function, get_unit_key?: Function | null);
+    resetCache(): void;
+    /**
+     * The names of the public rules, in definition order.
+     */
+    ruleNames(): string[];
+    /**
+     * Returns `{ rule }`, the rule node with its inferred type and the names of its suggestions,
+     * as JSON, or `{ error }`.
+     */
+    rule(name: string): object;
+    /**
+     * Returns `{ accepted }`, the names the situation gains, or `{ error, situationReset,
+     * accepted }`.
+     */
+    setSituation(situation: string, keep_previous: boolean, strict: boolean): object;
+    shallowCopy(copy_cache: boolean): Engine;
+    /**
+     * Returns the warnings raised by building the engine.
+     */
+    takeWarnings(): object;
+}
+
+/**
+ * The expressions evaluated since the cache was last reset, for `missingVariables`.
+ */
+export class EvaluationsHandle {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+/**
+ * `parseExpression`: returns `{ expression }`, as JSON, or `{ error }`.
+ */
+export function parseExpression(expression: string, dotted_name: string): object;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_engine_free: (a: number, b: number) => void;
+    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;
+    readonly engine_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly engine_resetCache: (a: number) => void;
+    readonly engine_rule: (a: number, b: number, c: number) => number;
+    readonly engine_ruleNames: (a: number, b: number) => void;
+    readonly engine_setSituation: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly engine_shallowCopy: (a: number, b: number) => number;
+    readonly engine_takeWarnings: (a: number) => number;
+    readonly parseExpression: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export: (a: number, b: number) => number;
+    readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export3: (a: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_export4: (a: number, b: number, c: number) => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;