@object-ui/core 17.2.0 → 17.5.0

package/README.md

@@ -58,6 +58,35 @@ const userName = scope.get('user.name') // 'John'
 const isAdmin = scope.evaluate('${user.role === "admin"}') // true
 ```
 
+### Server Action Dispatch (`createServerActionHandler`)
+
+`ActionSchema.body` (L1 expression / L2 sandboxed JS) executes **server-side**
+— `POST /api/v1/actions/{object}/{action}` → the runtime sandbox. The client
+dispatches; it never interprets a body. Build the dispatch handler with the
+factory and register it — core stays opinion-free about auth, origin and
+object scope, which are injected:
+
+```typescript
+import { createServerActionHandler } from '@object-ui/core'
+
+const script = createServerActionHandler({
+  fetch: myAuthenticatedFetch,          // your auth wrapper (Bearer/cookies/...)
+  baseUrl: 'https://api.example.com',   // '' or omitted = same-origin
+  resolveObject: () => currentObject,   // fallback when the action has no objectName
+  onRefresh: () => refetchData(),       // called per the action's refreshAfter
+})
+
+// Registered handlers beat the built-in executors:
+runner.registerHandler('script', script)
+// (React hosts: <ActionProvider handlers={{ script }} ... />)
+```
+
+The factory owns the protocol so consumers cannot drift on it: name-based
+action identity (ADR-0110), the record-id resolution dance (`_rowRecord`,
+`recordIdField`, selection fallback, aggregate `_selectedIds`), a re-entrancy
+guard, and the `/actions` response-envelope rule (`interpretActionResponse` /
+`readActionPayload`, also exported).
+
 ### System Views (`defineView`)
 
 Schemas authored in source code are part of the product contract and must
@@ -112,21 +141,11 @@ This allows the core types and logic to be used in:
 
 ## API Reference
 
-See [full documentation](https://objectui.org/api/core) for detailed API reference.
-
-<!-- release-metadata:v3.3.0 -->
-
-## Compatibility
-
-- **Node.js:** ≥ 18
-- **TypeScript:** ≥ 5.0 (strict mode)
-- **`@objectstack/spec`:** ^3.3.0
-- **`@objectstack/client`:** ^3.3.0
-- **Tailwind CSS:** ≥ 3.4 (for packages with UI)
+See [full documentation](https://objectui.org/docs/api) for detailed API reference.
 
 ## Links
 
-- 📚 [Documentation](https://www.objectui.org/docs/core)
+- 📚 [Documentation](https://www.objectui.org/docs/guide/architecture)
 - 📦 [npm package](https://www.npmjs.com/package/@object-ui/core)
 - 📝 [Changelog](./CHANGELOG.md)
 - 🐛 [Report an issue](https://github.com/objectstack-ai/objectui/issues)

package/dist/actions/ActionEngine.d.ts

@@ -8,9 +8,8 @@
 /**
  * @object-ui/core - Action Engine
  *
- * Declarative action dispatch engine. Manages action registration,
- * event-to-action mapping, location-based filtering, keyboard shortcuts,
- * and bulk operation support.
+ * Declarative action engine. Manages action registration, location-based
+ * filtering, keyboard shortcuts, and bulk operation support.
  *
  * Replaces callback-based patterns with a schema-driven pipeline:
  *   ActionSchema[] → ActionEngine → ActionRunner → ActionResult
@@ -37,15 +36,6 @@ export interface RegisteredAction {
     /** Priority for ordering (lower = first) */
     priority?: number;
 }
-/** Event-to-action mapping */
-export interface ActionMapping {
-    /** Event name (e.g., 'row:click', 'toolbar:save', 'keyboard:ctrl+s') */
-    event: string;
-    /** Action name to execute */
-    actionName: string;
-    /** Optional condition expression */
-    condition?: string;
-}
 /** Keyboard shortcut handler */
 export interface ShortcutBinding {
     /** Key combination (e.g., 'ctrl+s', 'meta+k', 'shift+n') */
@@ -53,9 +43,35 @@ export interface ShortcutBinding {
     /** Action name to trigger */
     actionName: string;
 }
+/**
+ * Registration + filtering + execution for declared actions.
+ *
+ * Entry points are by NAME (`executeAction`), by LOCATION
+ * (`getActionsForLocation`), by SHORTCUT (`handleShortcut`) and in BULK
+ * (`executeBulk`). There is deliberately no entry point by arbitrary EVENT
+ * name: this class used to carry a second, parallel one — `addMapping()`
+ * registered `{ event, actionName, condition }` triples into a private
+ * `mappings` array and `dispatch(event)` ran every triple matching an event
+ * string. It was retired under enforce-or-remove (objectui#3368) because it
+ * was a public export of `@object-ui/core` with zero production callers: in
+ * its whole lifetime nothing ever registered a mapping, so `dispatch()` had
+ * no reachable caller either, and its four call sites were all in this
+ * class's own test file.
+ *
+ * Its condition gate had drifted three ways from the `visible` contract
+ * `getActionsForLocation` below implements — it entered on a raw truthy check
+ * (so `condition: false` dispatched anyway), typed `condition` as `string`
+ * only (so a `{ dialect: 'cel', source }` envelope could not reach the
+ * canonical engine), and evaluated without `throwOnError` (so a throwing
+ * predicate failed OPEN, the opposite of `visible`'s fail-closed posture).
+ * All three were retired WITH the path rather than fixed on it: aligning the
+ * contract of an API nobody calls only widens behaviour nobody uses. If an
+ * event-keyed entry point is ever genuinely needed, it must be built on the
+ * shared predicate definitions (`hasDeclaredPredicate` + `toPredicateInput`)
+ * that the surviving gate below already uses, not on a fourth spelling.
+ */
 export declare class ActionEngine {
     private actions;
-    private mappings;
     private shortcuts;
     private normalizedShortcutMap;
     private runner;
@@ -92,29 +108,37 @@ export declare class ActionEngine {
     registerActions(actions: ActionDef[]): void;
     /** Unregister an action by name */
     unregisterAction(name: string): void;
-    /** Add an event-to-action mapping */
-    addMapping(mapping: ActionMapping): void;
     /**
      * Get actions available at a specific location, sorted by priority.
      *
      * Filtering applied (in order):
      *   1. `locations.includes(location)` — location/region match
      *   2. `action.visible` — evaluated against the runner's current context
-     *      ({ record, recordId, objectName, user, … }). Missing or `true`
-     *      passes; any other value is coerced to boolean. Evaluator errors
-     *      hide the action (fail-closed) rather than throwing — this matches
-     *      the contract used by every individual action renderer
-     *      (`action-button`, `action-menu`, `action-bar`, …) so the same
-     *      action behaves identically whether surfaced via the engine or
-     *      consumed standalone.
+     *      ({ record, recordId, objectName, user, … }) whenever a gate is
+     *      DECLARED, which is asked through core's one definition
+     *      `hasDeclaredPredicate` (objectui#3850's ruling, adopted here by
+     *      objectui#3957). No gate — absent, `''`, blank predicate text in either
+     *      spelling, an envelope with no evaluable `source`, or a value that is
+     *      not a predicate at all — means visible. Evaluator errors hide the
+     *      action (fail-closed) rather than throwing — this matches the contract
+     *      used by every individual action renderer (`action-button`,
+     *      `action-menu`, `action-bar`, …) so the same action behaves identically
+     *      whether surfaced via the engine or consumed standalone, which is now
+     *      true of the gate in front of the verdict as well as the verdict
+     *      (objectui#3314: one value, one answer, whichever entry reads it).
      *
-     *   Predicate normalization matches `@object-ui/react`'s `toPredicateInput`:
+     *   Predicate normalization goes through the shared `toPredicateInput`
+     *   (`@object-ui/core`'s canonical helper — semantically identical to
+     *   `@object-ui/react`'s renderer-side twin, pinned by a parity test):
      *   raw strings (`'record.foo == true'`) are wrapped as `${...}` so they
-     *   evaluate as expressions, not as truthy string literals. Spec-style
-     *   `{ dialect, source }` envelopes are unwrapped to their `source`.
-     *   Without this, every per-action renderer (which already calls
-     *   `toPredicateInput`) and the engine path would disagree on the same
-     *   `visible:` predicate.
+     *   evaluate as expressions, not as truthy string literals, and a spec-style
+     *   `{ dialect: 'cel', source }` envelope is passed through INTACT so
+     *   `evaluateCondition` routes it to the canonical `@objectstack/formula`
+     *   engine (#2661). Unwrapping the envelope here — as this method used to —
+     *   dropped the dialect and silently demoted every CEL predicate to the
+     *   legacy JS evaluator, so the same `visible:` reached a different verdict
+     *   via the engine than via a renderer (#3314): CEL faults on `null < null`
+     *   and fail-closed hides, JS quietly returns `false`.
      */
     getActionsForLocation(location: ActionLocation): ActionDef[];
     /** Get actions that support bulk operations */
@@ -125,8 +149,6 @@ export declare class ActionEngine {
     getAction(name: string): ActionDef | undefined;
     /** Execute an action by name */
     executeAction(name: string, contextOverride?: Partial<ActionContext>): Promise<ActionResult>;
-    /** Dispatch an event — finds mapped actions and executes them */
-    dispatch(event: string, contextOverride?: Partial<ActionContext>): Promise<ActionResult[]>;
     /** Handle a keyboard shortcut event — returns true if handled */
     handleShortcut(keys: string, contextOverride?: Partial<ActionContext>): Promise<ActionResult | null>;
     /** Execute a bulk operation on multiple records */
@@ -141,6 +163,6 @@ export declare class ActionEngine {
     }>;
     /** Update the action context */
     updateContext(context: Partial<ActionContext>): void;
-    /** Clear all registered actions and mappings */
+    /** Clear all registered actions and shortcuts */
     clear(): void;
 }

package/dist/actions/ActionEngine.js

@@ -8,14 +8,15 @@
 /**
  * @object-ui/core - Action Engine
  *
- * Declarative action dispatch engine. Manages action registration,
- * event-to-action mapping, location-based filtering, keyboard shortcuts,
- * and bulk operation support.
+ * Declarative action engine. Manages action registration, location-based
+ * filtering, keyboard shortcuts, and bulk operation support.
  *
  * Replaces callback-based patterns with a schema-driven pipeline:
  *   ActionSchema[] → ActionEngine → ActionRunner → ActionResult
  */
 import { ActionRunner } from './ActionRunner';
+import { toPredicateInput } from '../evaluator/predicateInput.js';
+import { hasDeclaredPredicate } from '../evaluator/declaredPredicate.js';
 export { ACTION_LOCATIONS } from '@object-ui/types';
 /** Normalize a shortcut string for comparison (lowercase, trimmed, sorted parts) */
 function normalizeShortcut(keys) {
@@ -42,6 +43,33 @@ function warnHiddenPredicate(name, raw, err) {
         `Predicate: ${src}. Action predicates evaluate against { record, recordId, objectName, user, os.user, … }; ` +
         `use \`record.<field>\` (not a bare field).`);
 }
+/**
+ * Registration + filtering + execution for declared actions.
+ *
+ * Entry points are by NAME (`executeAction`), by LOCATION
+ * (`getActionsForLocation`), by SHORTCUT (`handleShortcut`) and in BULK
+ * (`executeBulk`). There is deliberately no entry point by arbitrary EVENT
+ * name: this class used to carry a second, parallel one — `addMapping()`
+ * registered `{ event, actionName, condition }` triples into a private
+ * `mappings` array and `dispatch(event)` ran every triple matching an event
+ * string. It was retired under enforce-or-remove (objectui#3368) because it
+ * was a public export of `@object-ui/core` with zero production callers: in
+ * its whole lifetime nothing ever registered a mapping, so `dispatch()` had
+ * no reachable caller either, and its four call sites were all in this
+ * class's own test file.
+ *
+ * Its condition gate had drifted three ways from the `visible` contract
+ * `getActionsForLocation` below implements — it entered on a raw truthy check
+ * (so `condition: false` dispatched anyway), typed `condition` as `string`
+ * only (so a `{ dialect: 'cel', source }` envelope could not reach the
+ * canonical engine), and evaluated without `throwOnError` (so a throwing
+ * predicate failed OPEN, the opposite of `visible`'s fail-closed posture).
+ * All three were retired WITH the path rather than fixed on it: aligning the
+ * contract of an API nobody calls only widens behaviour nobody uses. If an
+ * event-keyed entry point is ever genuinely needed, it must be built on the
+ * shared predicate definitions (`hasDeclaredPredicate` + `toPredicateInput`)
+ * that the surviving gate below already uses, not on a fourth spelling.
+ */
 export class ActionEngine {
     /**
      * @param contextOrRunner Either an initial `ActionContext` (constructs a
@@ -59,12 +87,6 @@ export class ActionEngine {
             writable: true,
             value: new Map()
         });
-        Object.defineProperty(this, "mappings", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: []
-        });
         Object.defineProperty(this, "shortcuts", {
             enumerable: true,
             configurable: true,
@@ -139,11 +161,6 @@ export class ActionEngine {
         }
         this.actions.delete(name);
         this.shortcuts = this.shortcuts.filter(s => s.actionName !== name);
-        this.mappings = this.mappings.filter(m => m.actionName !== name);
-    }
-    /** Add an event-to-action mapping */
-    addMapping(mapping) {
-        this.mappings.push(mapping);
     }
     /**
      * Get actions available at a specific location, sorted by priority.
@@ -151,21 +168,31 @@ export class ActionEngine {
      * Filtering applied (in order):
      *   1. `locations.includes(location)` — location/region match
      *   2. `action.visible` — evaluated against the runner's current context
-     *      ({ record, recordId, objectName, user, … }). Missing or `true`
-     *      passes; any other value is coerced to boolean. Evaluator errors
-     *      hide the action (fail-closed) rather than throwing — this matches
-     *      the contract used by every individual action renderer
-     *      (`action-button`, `action-menu`, `action-bar`, …) so the same
-     *      action behaves identically whether surfaced via the engine or
-     *      consumed standalone.
+     *      ({ record, recordId, objectName, user, … }) whenever a gate is
+     *      DECLARED, which is asked through core's one definition
+     *      `hasDeclaredPredicate` (objectui#3850's ruling, adopted here by
+     *      objectui#3957). No gate — absent, `''`, blank predicate text in either
+     *      spelling, an envelope with no evaluable `source`, or a value that is
+     *      not a predicate at all — means visible. Evaluator errors hide the
+     *      action (fail-closed) rather than throwing — this matches the contract
+     *      used by every individual action renderer (`action-button`,
+     *      `action-menu`, `action-bar`, …) so the same action behaves identically
+     *      whether surfaced via the engine or consumed standalone, which is now
+     *      true of the gate in front of the verdict as well as the verdict
+     *      (objectui#3314: one value, one answer, whichever entry reads it).
      *
-     *   Predicate normalization matches `@object-ui/react`'s `toPredicateInput`:
+     *   Predicate normalization goes through the shared `toPredicateInput`
+     *   (`@object-ui/core`'s canonical helper — semantically identical to
+     *   `@object-ui/react`'s renderer-side twin, pinned by a parity test):
      *   raw strings (`'record.foo == true'`) are wrapped as `${...}` so they
-     *   evaluate as expressions, not as truthy string literals. Spec-style
-     *   `{ dialect, source }` envelopes are unwrapped to their `source`.
-     *   Without this, every per-action renderer (which already calls
-     *   `toPredicateInput`) and the engine path would disagree on the same
-     *   `visible:` predicate.
+     *   evaluate as expressions, not as truthy string literals, and a spec-style
+     *   `{ dialect: 'cel', source }` envelope is passed through INTACT so
+     *   `evaluateCondition` routes it to the canonical `@objectstack/formula`
+     *   engine (#2661). Unwrapping the envelope here — as this method used to —
+     *   dropped the dialect and silently demoted every CEL predicate to the
+     *   legacy JS evaluator, so the same `visible:` reached a different verdict
+     *   via the engine than via a renderer (#3314): CEL faults on `null < null`
+     *   and fail-closed hides, JS quietly returns `false`.
      */
     getActionsForLocation(location) {
         const evaluator = this.runner.getEvaluator();
@@ -188,30 +215,45 @@ export class ActionEngine {
         })
             .filter(ra => {
             const raw = ra.action.visible;
-            if (raw == null || raw === '' || raw === true)
+            // Ask "is a `visible` gate DECLARED?" through the repo's ONE definition
+            // (`evaluator/declaredPredicate.ts`, objectui#3850's ruling), which is
+            // what the renderers, `SchemaRenderer` and `ActionRunner`'s execution
+            // gates ask. This filter used to answer it with a range of its own —
+            // three empty spellings folded by hand (`null` / `''` / an envelope with
+            // an empty `source`) and everything else coerced with `Boolean(raw)` —
+            // and it was the LAST consumer to do so, so the same value got two
+            // answers depending on which entry read it: `visible: 0` / `NaN` hid the
+            // action here and showed it on the renderer face, and `visible: '   '`
+            // hid it here because the normalizer wraps a blank string into `'${   }'`
+            // whose verdict is falsy. That is the shape objectui#3314's invariant
+            // forbids, and it is fixed by deleting a range, not by adding one
+            // (objectui#3957). A value that is not a predicate, or a predicate that
+            // says nothing, must not be the reason an action is hidden from
+            // everyone — the same fail-open posture `ActionRunner` already committed
+            // to for `disabled` (`catch { isDisabled = false }`).
+            //
+            // Booleans need no branch of their own: they are DECLARED (`visible:
+            // false` is a verdict, objectui#3812) and `evaluateCondition`
+            // short-circuits them.
+            if (!hasDeclaredPredicate(raw))
                 return true;
-            if (raw === false)
-                return false;
-            let expr;
-            if (typeof raw === 'string') {
-                expr = `\${${raw}}`;
-            }
-            else if (typeof raw === 'object' && typeof raw.source === 'string') {
-                const src = raw.source;
-                if (!src)
-                    return true;
-                expr = `\${${src}}`;
-            }
-            else {
-                expr = Boolean(raw);
-            }
+            // #3314 — one shared normalization, not two. Hand-rolling the envelope
+            // unwrap here is what dropped `dialect: 'cel'` and demoted the
+            // predicate to the legacy JS engine; `toPredicateInput` keeps the
+            // envelope so `evaluateCondition` can route it to `@objectstack/formula`
+            // (the engine the server enforces with), exactly as the renderers do.
+            // Declared ⇒ the normalizer left something to evaluate, so there is no
+            // `undefined` case left to handle here.
+            const expr = toPredicateInput(raw);
             try {
                 // `throwOnError: true` is required for fail-closed semantics: the
                 // evaluator's default behavior swallows expression errors and
                 // returns the raw template string, which `Boolean(string)` then
                 // coerces to `true` — silently leaking actions whose preconditions
                 // failed (e.g. `ctx` undefined). Surface the error so our catch
-                // below can hide the action.
+                // below can hide the action. It is equally load-bearing on the CEL
+                // path, where the canonical helper fails SOFT to visible/enabled
+                // unless the caller opts in.
                 return evaluator.evaluateCondition(expr, { throwOnError: true });
             }
             catch (err) {
@@ -255,26 +297,6 @@ export class ActionEngine {
         }
         return this.runner.execute(registered.action);
     }
-    /** Dispatch an event — finds mapped actions and executes them */
-    async dispatch(event, contextOverride) {
-        const matchingMappings = this.mappings.filter(m => m.event === event);
-        if (matchingMappings.length === 0) {
-            return [];
-        }
-        const results = [];
-        for (const mapping of matchingMappings) {
-            // Check condition if present
-            if (mapping.condition) {
-                const evaluator = this.runner.getEvaluator();
-                const shouldRun = evaluator.evaluateCondition(mapping.condition);
-                if (!shouldRun)
-                    continue;
-            }
-            const result = await this.executeAction(mapping.actionName, contextOverride);
-            results.push(result);
-        }
-        return results;
-    }
     /** Handle a keyboard shortcut event — returns true if handled */
     async handleShortcut(keys, contextOverride) {
         const actionName = this.normalizedShortcutMap.get(normalizeShortcut(keys));
@@ -334,10 +356,9 @@ export class ActionEngine {
     updateContext(context) {
         this.runner.updateContext(context);
     }
-    /** Clear all registered actions and mappings */
+    /** Clear all registered actions and shortcuts */
     clear() {
         this.actions.clear();
-        this.mappings = [];
         this.shortcuts = [];
         this.normalizedShortcutMap.clear();
     }