@nanobpm/bojtos-react 0.8.0 → 0.9.0

package/dist/useBojtos.d.ts

@@ -1,4 +1,4 @@
-import { type ActivateInstruction, type AgentResult, type DispatchOptions, type EngineVariant, type FormResult, type JobHandler, type ProcessInstanceSearchQueryResult, type ResourceResult, type RoundResult, type Snapshot, type UserTaskSearchQueryResult, type VariableSearchQueryResult, type WasmEvent, type WasmSource } from "@nanobpm/bojtos-kit";
+import { type ActivateInstruction, type AgentResult, type DispatchOptions, type EngineReadModel, type EngineVariant, type FormResult, type JobHandler, type ProcessInstanceSearchQueryResult, type ResourceResult, type RoundResult, type Snapshot, type UserTaskSearchQueryResult, type VariableSearchQueryResult, type WasmEvent, type WasmSource } from "@nanobpm/bojtos-kit";
 /** Lifecycle of the in-browser engine load. */
 export type BojtosPhase = "loading" | "ready" | "error";
 export interface UseBojtosOptions {
@@ -202,6 +202,15 @@ export interface ReadModelBojtosControls extends BojtosControls {
      * engine is ready.
      */
     getResourceByKey(resourceKey: string): ResourceResult | null;
+    /**
+     * This session's engine read-model handle as `@nanobpm/engine-testkit`'s
+     * structural `EngineReadModel` port — feed it straight to `assertThatInstance`
+     * / `assertThatUserTask`. Returns `null` until the engine is ready (or on a
+     * lean-variant hook). Like the other read queries it is a pull projection: the
+     * handle reads live engine state on each call, so re-read it (keyed on
+     * {@link readModelVersion}) rather than caching its results.
+     */
+    readModel(): EngineReadModel | null;
     /**
      * A monotonically increasing counter bumped after every command / worker round
      * (and on deploy / reset). It is the reactivity signal for the pull read

package/dist/useBojtos.js

@@ -223,6 +223,7 @@ export function useBojtos({ bpmn, wasm, maxEvents, variant, }) {
     const searchVariables = useCallback((filterJson) => selectReadModel(readModelRef.current, (rm) => rm.searchVariables(filterJson)), []);
     const getFormByKey = useCallback((formKey) => selectReadModel(readModelRef.current, (rm) => rm.getFormByKey(formKey)), []);
     const getResourceByKey = useCallback((resourceKey) => selectReadModel(readModelRef.current, (rm) => rm.getResourceByKey(resourceKey)), []);
+    const readModel = useCallback(() => selectReadModel(readModelRef.current, (rm) => rm.readModel()), []);
     return {
         phase,
         error,
@@ -254,6 +255,7 @@ export function useBojtos({ bpmn, wasm, maxEvents, variant, }) {
         searchVariables,
         getFormByKey,
         getResourceByKey,
+        readModel,
         readModelVersion,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nanobpm/bojtos-react",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "React binding for the Bojtos in-browser BPMN demo framework (ADR 0043): the useBojtos hook (owns the engine session + reactive snapshot/event state) and the <BpmnRuntimeView> live token/incident diagram. Built on @nanobpm/bojtos-kit; the console test-run panel is its first consumer.",
   "type": "module",
   "license": "Apache-2.0",
@@ -24,6 +24,9 @@
     "src"
   ],
   "sideEffects": false,
+  "engines": {
+    "node": ">=22.6"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "typecheck": "tsc -p tsconfig.json --noEmit",
@@ -32,7 +35,7 @@
     "test:ci": "node --experimental-strip-types --test test/*.test.ts"
   },
   "dependencies": {
-    "@nanobpm/bojtos-kit": "^0.8.0"
+    "@nanobpm/bojtos-kit": "^0.9.0"
   },
   "peerDependencies": {
     "bpmn-js": ">=17",

package/src/useBojtos.ts

@@ -7,6 +7,7 @@ import {
   type DispatchOptions,
   dispatchRound,
   dispatchWorkers,
+  type EngineReadModel,
   type EngineVariant,
   type FormResult,
   type JobHandler,
@@ -262,6 +263,15 @@ export interface ReadModelBojtosControls extends BojtosControls {
    * engine is ready.
    */
   getResourceByKey(resourceKey: string): ResourceResult | null;
+  /**
+   * This session's engine read-model handle as `@nanobpm/engine-testkit`'s
+   * structural `EngineReadModel` port — feed it straight to `assertThatInstance`
+   * / `assertThatUserTask`. Returns `null` until the engine is ready (or on a
+   * lean-variant hook). Like the other read queries it is a pull projection: the
+   * handle reads live engine state on each call, so re-read it (keyed on
+   * {@link readModelVersion}) rather than caching its results.
+   */
+  readModel(): EngineReadModel | null;
   /**
    * A monotonically increasing counter bumped after every command / worker round
    * (and on deploy / reset). It is the reactivity signal for the pull read
@@ -685,6 +695,10 @@ export function useBojtos({
       ),
     [],
   );
+  const readModel = useCallback(
+    () => selectReadModel(readModelRef.current, (rm) => rm.readModel()),
+    [],
+  );
 
   return {
     phase,
@@ -717,6 +731,7 @@ export function useBojtos({
     searchVariables,
     getFormByKey,
     getResourceByKey,
+    readModel,
     readModelVersion,
   };
 }