@object-ui/core 17.3.0 → 17.6.0

package/dist/actions/ActionRunner.d.ts

@@ -5,9 +5,24 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { ActionInput as SpecActionInput } from '@objectstack/spec/ui';
-import { ExpressionEvaluator } from '../evaluator/ExpressionEvaluator';
-import { type UndoableOperation } from './UndoManager';
+/**
+ * @object-ui/core - Action Runner
+ *
+ * Executes actions defined in ActionSchema and EventHandler.
+ *
+ * Dispatches every `@objectstack/spec` `ActionType` — `script`, `url`, `modal`,
+ * `flow`, `api`, `form` — plus the one declared renderer-local alias,
+ * `navigation` (see `ObjectUiLocalActionType`). The table that does it is typed
+ * against that vocabulary, so this list cannot go stale the way the old comment
+ * had (it still claimed five types after `form` shipped).
+ *
+ * Features: conditional execution, confirmation, toast notifications,
+ * redirect handling, action chaining, custom handler registration.
+ */
+import type { UIActionSchema } from '@object-ui/types';
+import type { Action as SpecActionInput } from '@objectstack/spec/ui';
+import { ExpressionEvaluator } from '../evaluator/ExpressionEvaluator.js';
+import { type UndoableOperation } from './UndoManager.js';
 export interface ActionResult {
     success: boolean;
     data?: any;
@@ -61,6 +76,30 @@ export interface ApiConfig {
 /**
  * Action definition accepted by the runner.
  * Compatible with both UIActionSchema (spec v2.0.1) and legacy crud.ts ActionSchema.
+ *
+ * ── CLOSED since objectstack#4075 step 3 ──────────────────────────────────────
+ *
+ * This interface used to end with `[key: string]: any`, so it accepted any key
+ * of any type: deleting `execute` from it produced ZERO compile errors, a typo
+ * (`targt`, `exectue`) type-checked, and a tombstoned key sailed through to a
+ * runner that then silently did nothing — the objectstack#2169 "Mark Done does
+ * nothing" shape. The index signature is gone. Every key this type accepts is
+ * now written down below, and `tsc` rejects the rest at any site that AUTHORS an
+ * action literal in code.
+ *
+ * What it does NOT reach, and what still covers that: stored `sys_metadata` rows
+ * are rehydrated UNPARSED (objectstack#3903), so authored metadata arrives at
+ * `runner.execute()` as a plain object the compiler never saw. The dev-mode
+ * `warnOnUnknownActionKeys` shim from step 1 therefore STAYS — it is not
+ * redundant with the closed type, it is the other half of the same surface, and
+ * the two halves catch disjoint populations (code-authored literals vs. stored
+ * rows).
+ *
+ * {@link ActionContext} keeps ITS index signature, deliberately. It is a runtime
+ * data bag whose keys are genuinely open (`data`, `record`, `pageVariables`,
+ * `user`, plus whatever a host passes); this is a declared metadata contract
+ * mirroring `@objectstack/spec`'s `ActionSchema`. Open key set on a data bag is
+ * correct; open key set on a contract is the bug above.
  */
 export interface ActionDef {
     /** Action type identifier — a `RunnableActionType` (the spec's six plus the
@@ -77,19 +116,65 @@ export interface ActionDef {
     name?: string;
     /** Display label */
     label?: string;
-    /** Confirmation text — shows a confirm dialog before executing */
+    /**
+     * Human description of the action, shown as the param-collection dialog's
+     * subtitle (`useConsoleActionRuntime` reads it beside `label`).
+     *
+     * objectui vocabulary, not spec: `@objectstack/spec`'s `ActionSchema` has no
+     * `description`, so this derives from `@object-ui/types`' renderer view of an
+     * action (`UIActionSchema`, `ui-action.ts`) — the same "authorable for a
+     * declared surface" source `check:action-forward-parity` derives its owed set
+     * from, which is why that gate already requires all four action renderers to
+     * forward this key (objectui#4192: `action:menu`'s dialog titled itself
+     * "Action parameters" instead of naming the action).
+     *
+     * Promoted by step 3 (objectstack#4075): the key was authorable, forwarded
+     * and read, but `ActionDef` never declared it, so it reached its reader only
+     * through `[key: string]: any`. Deleting the index signature is what surfaced
+     * it — the two TS2353s the deletion produced repo-wide were both this key.
+     */
+    description?: UIActionSchema['description'];
+    /**
+     * Confirmation text — shows a confirm dialog before executing. The ONE
+     * confirm spelling: `@objectstack/spec`'s action surface and the
+     * TranslationBundle key (`{ns}.objects.{obj}._actions.{name}.confirmText`)
+     * both stand on it.
+     */
     confirmText?: string;
-    /** Structured confirmation (from crud.ts) */
-    confirm?: {
-        title?: string;
-        message?: string;
-        confirmText?: string;
-        cancelText?: string;
-    };
-    /** Condition expression — if falsy, skip action */
-    condition?: string;
-    /** Disabled expression — if truthy, skip action */
-    disabled?: string | boolean;
+    /**
+     * RETIRED (objectui#4314): the structured confirm object used to sit here
+     * and its `message` OUTRANKED `confirmText` — untranslated, since no bundle
+     * key exists for it. `?: never` so constructing an action with it is a tsc
+     * error rather than a silently-ignored key; the authorable twin
+     * (`@object-ui/types` `crud.ts`) carries the same tombstone.
+     * @deprecated Retired — author `confirmText` instead.
+     */
+    confirm?: never;
+    /**
+     * Condition predicate — the action executes only while it holds.
+     *
+     * A boolean, a bare CEL string, a `${…}` template, or the normalized
+     * `{ dialect, source }` envelope `objectstack build` emits. Declared and
+     * FALSE skips the action; not declared at all (absent / empty predicate)
+     * executes. `boolean` is spelled out here because the execution gate now
+     * honours `condition: false` as the verdict it plainly is (objectui#3872) —
+     * the same widening `disabled` already carries below.
+     */
+    condition?: string | boolean;
+    /**
+     * Disabled predicate — the control renders inert while it holds.
+     *
+     * Same three arms as {@link ActionDef.visible}, derived from the same spec
+     * field, because the 2026-08-06 maintainer ruling on objectstack#4075 gave
+     * both keys ONE shape: `boolean | string(CEL) | { dialect, source }` —
+     * "boolean = 条件的退化形字面量,string = CEL 简写,信封 = 完整形". The
+     * envelope arm arrived in `@objectstack/spec` 17.0.0-rc.6 (objectstack#5970,
+     * PR objectstack#6450); until then this was a hand-written `string | boolean`
+     * that could not describe the envelope, which is why `DeclaredActionsBar`
+     * read it through an `(action as any).disabled` cast. Derived, not restated,
+     * so the two keys cannot drift apart again.
+     */
+    disabled?: SpecActionInput['disabled'];
     /**
      * API endpoint (string URL or complex config).
      *
@@ -121,6 +206,19 @@ export interface ActionDef {
      * today (objectstack#4075 step 2).
      */
     navigate?: any;
+    /** `navigation` alias: the target URL. `executeNavigation` resolves
+     *  `to || target || redirect`, so a flat spec-style `target` also works. */
+    to?: string;
+    /** `navigation` alias: force the external-URL treatment that the scheme
+     *  heuristic would otherwise decide. */
+    external?: boolean;
+    /** `navigation` alias: open in a new tab. The first-class spec switch is
+     *  `openIn: 'new-tab'`, which WINS over this one — prefer it in new metadata.
+     *  Unrelated to the retired `params.newTab` read (objectui#4097). */
+    newTab?: boolean;
+    /** `navigation` alias: replace the current history entry instead of pushing
+     *  a new one. No `ActionSchema` counterpart in any spelling. */
+    replace?: boolean;
     /** onClick callback (legacy) */
     onClick?: () => void | Promise<void>;
     /** Whether to reload data after success */
@@ -213,16 +311,23 @@ export interface ActionDef {
     /**
      * Visibility predicate, evaluated against the runner's context.
      *
-     * The `boolean` arm is objectui's own, deliberately wider than the spec:
-     * `ActionSchema.visible` admits only a CEL string or a `{ dialect, source }`
-     * envelope, while `ActionEngine.getActionsForLocation` also honours a literal
-     * `visible: true` / `false` (pinned by `ActionEngine.visibility.test.ts`).
-     * Declared rather than left to the index signature so the tolerance is
-     * auditable instead of invisible — but it IS a dialect, and objectstack#4075
-     * step 3 has to decide whether the spec adopts the boolean or objectui drops
-     * it. Do not widen this further.
-     */
-    visible?: SpecActionInput['visible'] | boolean;
+     * Three arms — `boolean | string(CEL) | { dialect, source }` — and all three
+     * now come from the spec. Step 2 had to write `SpecActionInput['visible'] |
+     * boolean` because the literal `visible: true` / `false` that
+     * `ActionEngine.getActionsForLocation` honours (pinned by
+     * `ActionEngine.visibility.test.ts`) was objectui tolerance the spec did not
+     * share, and it left the open question step 3 was blocked on: does the spec
+     * adopt the boolean, or does objectui drop it?
+     *
+     * The maintainer ruled ADOPT on 2026-08-06 (objectstack#4075): "统一形状,
+     * spec 采纳 —— `visible` / `disabled` 两键在 spec 侧统一收敛为
+     * `boolean | string(CEL) | {dialect, source}`(boolean = 条件的退化形字面量,
+     * string = CEL 简写,信封 = 完整形)". `@objectstack/spec` 17.0.0-rc.6 carries
+     * it (objectstack#5970, PR objectstack#6450), so the local `| boolean` is no
+     * longer a tolerance to declare — it is part of the derived type, and adding
+     * it back would restate a spec arm rather than widen anything.
+     */
+    visible?: SpecActionInput['visible'];
     /** System permissions the caller must ALL hold for the action to be offered
      *  (ADR-0066 D4 UI half — the server enforces the source of truth). */
     requiredPermissions?: SpecActionInput['requiredPermissions'];
@@ -268,8 +373,6 @@ export interface ActionDef {
      * remains available to a HOST passing it explicitly.
      */
     bulkEnabled?: SpecActionInput['bulkEnabled'];
-    /** Any additional properties */
-    [key: string]: any;
 }
 /**
  * A handler registered with {@link ActionRunner} — the client-side action
@@ -286,6 +389,29 @@ export type ActionRunnerHandler = (action: ActionDef, context: ActionContext) =>
 /**
  * Confirmation handler — replaces window.confirm.
  * Consumers can provide an async implementation (e.g., Shadcn AlertDialog).
+ *
+ * `options` is LIVE, and its producer is not in this file — searching the
+ * runner alone will tell you otherwise. The only call site here passes one
+ * argument (the structured `confirm` arm that used to forward a bag was
+ * retired, objectui#4314), so a runner-scoped sweep reads this parameter as
+ * declared-but-never-produced and files it for removal. That has already
+ * happened once: objectui#5205, ruled KEEP on 2026-08-22.
+ *
+ * The producer bypasses the runner entirely. `handleDeleteView` in
+ * `packages/app-shell/src/views/ObjectView.tsx` — the admin "delete saved
+ * view" confirmation — invokes a `ConfirmationHandler` with all three fields
+ * populated and localized (`console.objectView.deleteViewTitle` / `.delete` /
+ * `.cancel`), and `app-shell`'s `ActionConfirmDialog.tsx` renders them in
+ * place of its generic `actionConfirm.*` fallbacks. Line numbers are left out
+ * on purpose: #5205's pointer had already drifted by the time it was executed.
+ *
+ * So re-measure across the repo, not this package: grep for two-argument
+ * calls of `ConfirmationHandler`-typed values (`confirmHandler(`, `onConfirm(`)
+ * in `app-shell` as well as here. Dropping `options` costs that dialog its
+ * title and both button labels, and narrows a published `.d.ts` against the
+ * natural `(message, options) => …` spelling — which TypeScript rejects
+ * against a one-parameter target unless the second parameter is written
+ * optional.
  */
 export type ConfirmationHandler = (message: string, options?: {
     title?: string;
@@ -351,6 +477,31 @@ export interface ResultDialogSpec {
  * cleanup purposes (the action already succeeded).
  */
 export type ResultDialogHandler = (spec: ResultDialogSpec, data: unknown, action?: ActionDef) => Promise<void>;
+/**
+ * One entry of a param's option list, as the RESOLVED param carries it.
+ *
+ * `label` / `value` are the two keys this layer itself reads and rewrites (i18n
+ * translation of the label, value matching). Everything else an option declares
+ * rides along in the catch-all and reaches the widgets untouched: per-option
+ * `visibleWhen` (the CEL predicate `resolveVisibleOptions()` filters on —
+ * ADR-0058 / #2284), `color`, `icon`, `disabled`.
+ *
+ * The catch-all is deliberate rather than a closed key list (objectui#3559).
+ * A field's option vocabulary is owned by the field metadata (`@objectstack/spec`'s
+ * `SelectOptionSchema`) and read by the option widgets; a param's option list is
+ * only a CONDUIT between the two. When this type restated that vocabulary as
+ * `{ label, value }`, the resolver dutifully rebuilt every inherited option to
+ * match and a field's `visibleWhen` stopped narrowing the dialog's list — the
+ * same field metadata behaving two ways on two surfaces. Naming the two keys
+ * this layer uses and passing the rest through is what keeps that from
+ * recurring; it is NOT an invitation to author new resolved-only option keys
+ * (the spec's schema is the authoring gate, and it is `.strict()`).
+ */
+export type ActionParamOption = {
+    label: string;
+    value: string;
+    [key: string]: unknown;
+};
 /**
  * ActionParam definition accepted by the runner.
  * Compatible with @objectstack/spec ActionParam.
@@ -373,10 +524,7 @@ export interface ActionParamDef {
     label: string;
     type: string;
     required?: boolean;
-    options?: Array<{
-        label: string;
-        value: string;
-    }>;
+    options?: ActionParamOption[];
     defaultValue?: unknown;
     helpText?: string;
     placeholder?: string;
@@ -486,6 +634,30 @@ export declare class ActionRunner {
      * Post-execution: emit toast notifications, handle chaining, callbacks.
      */
     private handlePostExecution;
+    /**
+     * Perform the `ActionSchema.onSuccess` hop for an action that just succeeded.
+     *
+     * **The router is the app's own.** `navigationHandler` is the seam every
+     * navigator in this file already goes through, and the console wires it to
+     * react-router's `navigate` — so `openIn: 'self'` is a real SPA route hop,
+     * in place, immune to popup blocking. No `window.location` / `window.open`
+     * mechanism is introduced here; the no-handler fallback is the same
+     * `result.redirect` hand-off `navigateTo` already uses.
+     *
+     * **No default is written here.** `openIn` is a materialised
+     * `.default('self')` in the spec, so parse output always carries a resolved
+     * member; this reads the ONE member that changes the branch and leaves the
+     * other implicit. A `?? 'self'` would be a second source of truth for a
+     * default the producer already resolved.
+     *
+     * **The two `openIn` spellings never cross.** This reads
+     * `onSuccess.openIn` (`'self' | 'newTab'`) and nothing else — never the
+     * top-level `type: 'url'` switch, which spells its new-tab member
+     * `'new-tab'`. Spec refuses each crossover spelling with a keyed error; a
+     * renderer that accepted either would be a second, looser contract than the
+     * one authors are validated against.
+     */
+    private navigateOnSuccess;
     /**
      * Execute script action — evaluates client-side expression via ExpressionEvaluator.
      * Supports ${} template expressions referencing data, record, user context.
@@ -543,6 +715,37 @@ export declare class ActionRunner {
      * through to `executeActionSchema` and silently no-opped (the "Log Time does
      * nothing" report). The current record id is forwarded as `?recordId=` for
      * hosts that support it; the form route ignores unknown query params.
+     *
+     * ## An id never travels without its object (objectui#4292)
+     *
+     * `?recordId=` names an id and nothing else, so the consumer has to pick an
+     * object to resolve it against, and the only one it can pick is the FormView's
+     * own target object (`/forms/:name` does exactly that since objectui#4278).
+     * That is right whenever the action fired from a record OF that object, and
+     * nothing here used to check that it did: `target: 'showcase_task.edit'` on an
+     * Account record header is publishable metadata, and with per-table integer
+     * keys `GET /data/showcase_task/42` cheerfully answers for Account 42. Before
+     * #4278 the damage stopped at a duplicate insert; now that the route honours
+     * the param, the same mis-scoped action PATCHes a different object's record
+     * with no error anywhere. So the id is forwarded only when the two objects
+     * MATCH, and the object identity rides along as the consumer's second half of
+     * the check ({@link FORM_RECORD_OBJECT_PARAM}).
+     *
+     * The three outcomes, and why the third preserves rather than refuses:
+     *
+     *  - **match** — forward `?recordId=&recordObject=`. The #4278 edit path,
+     *    plus the identity the consumer re-checks against its own view metadata;
+     *  - **mismatch** — forward NEITHER, i.e. the bare `/forms/:name`. A "log
+     *    time" action fired from a Task at another object's create view is not a
+     *    broken edit, it is a CREATE that happens to be launched from a record —
+     *    which is exactly what this route did before #4278 taught it to read the
+     *    param. Refusing here would break a shape that works;
+     *  - **not comparable** — either end unknown ⇒ forward as before. A host that
+     *    publishes no `objectName`, or an unqualified target name, gives this
+     *    runner nothing to compare; tightening on absent information would turn
+     *    working edit flows into creates on every such host. The guard only ever
+     *    fires on information it actually has, and the consumer half applies the
+     *    same rule to a missing `recordObject`.
      */
     private executeForm;
     /**
@@ -556,6 +759,35 @@ export declare class ActionRunner {
      * drift apart again. Prefer `type: 'url'` + `openIn` in new metadata.
      */
     private executeNavigation;
+    /**
+     * Assemble the request body for the runner's OWN `executeAPI` — the path taken
+     * when no host registered an `api` handler.
+     *
+     * `bodyExtra` is merged LAST, which is the spec's documented semantics for the
+     * key ("Static request-body fields for a `type:'api'` action, merged last
+     * (overrides user params)") and what the console's `apiHandler` already does on
+     * both of its branches. Before objectstack#6837 this path read `action.params`
+     * alone and never looked at `bodyExtra` at all, so an action whose payload lives
+     * entirely in `bodyExtra` — the shape the ADR-0087 conversion produces from an
+     * old object-form `params` page — POSTed an empty body here.
+     *
+     * `params` contributes only in its DEPRECATED non-array form (the compat window
+     * #5777 opened; see `warnOnDeprecatedObjectParams`). An ARRAY `params` is a
+     * parameter DEFINITION list, not a payload: it reaches this method unconsumed
+     * only when no `paramCollectionHandler` is mounted, and POSTing the definitions
+     * as the request body was never a payload any endpoint wanted. It now falls
+     * through to the context record like an absent `params` does.
+     *
+     * `bodyShape` then decides how that payload is WRAPPED, and the wrap covers the
+     * collected payload ONLY — `bodyExtra` stays at the top level. That is the
+     * spec's own wording for the key ("`{ wrap: 'data' }` nests the user-collected
+     * params under that key, while `recordIdParam` and other top-level keys stay
+     * flat") and what both console read-sites already do, so the key means one
+     * thing on every path that honours it. Until objectstack#6938 this path did not
+     * read it at all: the console `apiHandler` wrapped and the runner's own fallback
+     * did not, so the same action changed body shape with the host it ran under.
+     */
+    private buildApiRequestBody;
     /**
      * Execute API action — supports both simple string endpoint and complex ApiConfig.
      */
@@ -609,3 +841,21 @@ export declare class ActionRunner {
  * Convenience function to execute a single action with a one-off runner.
  */
 export declare function executeAction(action: ActionDef, context?: ActionContext): Promise<ActionResult>;
+/** The `ActionSchema.onSuccess` block, as the pinned spec declares it. */
+export interface OnSuccessNavigation {
+    navigate: string;
+    /** `'self' | 'newTab'` — read as data, so an off-contract value cannot widen the branch. */
+    openIn?: unknown;
+}
+/**
+ * Is this `onSuccess` the SPEC's navigation block, or this runner's older
+ * chained-callback channel (`ActionDef | ActionDef[]`)?
+ *
+ * The test IS the spec's declaration: a non-array object carrying a STRING
+ * `navigate`. Nothing else can produce that shape — the spec object is strict
+ * with `navigate: z.string()` required, and on a callback `ActionDef`,
+ * `navigate` is the deprecated nested navigation ENVELOPE that
+ * `executeNavigation` reads `to`/`target`/`redirect` off, so a bare string
+ * there has never been runnable.
+ */
+export declare function readOnSuccessNavigation(value: unknown): OnSuccessNavigation | null;