@object-ui/core 17.2.0 → 17.5.0

package/dist/actions/actionKeys.d.ts

@@ -6,26 +6,46 @@
  * LICENSE file in the root directory of this source tree.
  */
 /**
- * What an action is allowed to carry — objectstack#4075 step 1.
+ * What an action is allowed to carry — objectstack#4075, all three steps.
  *
- * `ActionDef` ends with `[key: string]: any`, so it accepts any key of any type.
- * Concretely (objectui#2990): deleting `ActionDef.execute` produced ZERO compile
- * errors even though the field had just been removed, and stale metadata still
- * authoring `execute: 'markDone'` type-checks today. The same deletion against
- * `@object-ui/types`' `ActionSchema` — which has no index signature — correctly
- * produced `TS2353` at the authoring site. One of the two readers can catch a
- * retired key; the other is structurally incapable.
+ * `ActionDef` used to end with `[key: string]: any`, so it accepted any key of
+ * any type. Concretely (objectui#2990): deleting `ActionDef.execute` produced
+ * ZERO compile errors even though the field had just been removed, and stale
+ * metadata authoring `execute: 'markDone'` type-checked. The same deletion
+ * against `@object-ui/types`' `ActionSchema` — which has no index signature —
+ * correctly produced `TS2353` at the authoring site. One of the two readers
+ * could catch a retired key; the other was structurally incapable.
  *
- * That asymmetry is the issue. An open key set on a DECLARED METADATA CONTRACT
+ * That asymmetry was the issue. An open key set on a DECLARED METADATA CONTRACT
  * is what lets a typo (`targt`, `exectue`) and a tombstoned key (`execute`) both
  * sail through to a runner that then silently does nothing — the #2169 "Mark
  * Done does nothing" shape.
  *
- * This module is step 1 of the staged narrowing: it makes the key set VISIBLE
- * and warns on anything outside it, without changing a single type. Nothing
- * breaks, and an invisible failure becomes an audible one. Steps 2 and 3 —
- * promoting the legitimate keys to explicit optional fields, then removing the
- * index signature — are what finally let `tsc` catch typos and retired keys.
+ * This module was step 1 of the staged narrowing: make the key set VISIBLE and
+ * warn on anything outside it, without changing a single type. Step 2 promoted
+ * the legitimate keys to explicit optional fields; **step 3 removed the index
+ * signature**, so `tsc` now rejects a typo or a retired key outright.
+ *
+ * ── Why this module SURVIVES step 3 ──────────────────────────────────────────
+ * Step 1 wrote that the dev-mode warning "can retire" once the index signature
+ * came down. Step 3 measured that and kept it, because the two mechanisms cover
+ * DISJOINT populations rather than the same one twice:
+ *
+ *   - `tsc` sees action literals AUTHORED IN CODE. It rejects an unknown key at
+ *     the construction site, which is the strongest possible signal — but only
+ *     for actions that exist as TypeScript.
+ *   - the warning below sees actions that arrive as DATA. objectstack#3903
+ *     established that stored `sys_metadata` rows are rehydrated UNPARSED, so
+ *     authored metadata reaches `runner.execute()` as a plain object no
+ *     compiler ever looked at. That is the population `execute: 'markDone'`
+ *     actually lives in, and no type can reach it.
+ *
+ * Retiring the warning would therefore have re-opened the runtime half of the
+ * gap while closing the compile-time half — which is why `executeScript`'s
+ * rename-prescription branch also survives, for the same rows and the same
+ * reason. What DID retire with the index signature is the inverted pin in
+ * `actionKeys.pin.test.ts` that asserted the signature was still there; it now
+ * asserts the opposite, which was always its stated completion condition.
  *
  * The lists are pinned by `__tests__/actionKeys.pin.test.ts`, which re-derives
  * each one from its actual source. A hand-maintained list that drifts from the
@@ -66,8 +86,22 @@
  * deprecating them toward a spelling that does not exist would be worse than
  * leaving them declared.
  *
- * Step 3 remains: remove the index signature, at which point `tsc` catches both
- * typos and retired keys and the dev-mode warning below can retire with it.
+ * ── What step 3 found the first two steps had missed ─────────────────────────
+ * Deleting the index signature is the only thing that can name the keys still
+ * hiding behind it, and it named five, in two groups:
+ *
+ * `to` / `external` / `newTab` / `replace` — the `navigation` alias's own
+ * spelling. Step 1 had already ruled these legitimate and listed them below in
+ * {@link NAVIGATION_ALIAS_KEYS}, but step 2's scope was the SPEC-owned keys, so
+ * they were declared as data and never as fields; `executeNavigation` read them
+ * through the index signature. Promoted, and deliberately not `@deprecated` —
+ * step 2's acceptance ruled on exactly that point.
+ *
+ * `description` — objectui vocabulary from `@object-ui/types`' renderer view of
+ * an action, forwarded by all four action renderers (`check:action-forward-parity`
+ * requires it) and read by the param-collection dialog for its subtitle
+ * (objectui#4192). Authorable, forwarded, read — and undeclared. These were the
+ * only two `TS2353`s the deletion produced across the whole workspace.
  */
 /**
  * Every property `ActionDef` declares, in declaration order.
@@ -76,7 +110,7 @@
  * `keyof ActionDef` cannot substitute for this list: the index signature widens
  * it to `string | number`, which is precisely the problem being worked around.
  */
-export declare const ACTION_DEF_KEYS: readonly ["type", "actionType", "name", "label", "confirmText", "confirm", "condition", "disabled", "api", "endpoint", "method", "navigate", "onClick", "reload", "close", "redirect", "toast", "successMessage", "errorMessage", "refreshAfter", "undoable", "params", "actionParams", "resultDialog", "target", "body", "openIn", "modal", "chain", "chainMode", "onSuccess", "onFailure", "opensInNewTab", "newTabUrl", "locations", "visible", "requiredPermissions", "icon", "variant", "order", "component", "objectName", "ai", "aria", "bodyExtra", "bodyShape", "mode", "recordIdField", "recordIdParam", "requiresFeature", "shortcut", "bulkEnabled"];
+export declare const ACTION_DEF_KEYS: readonly ["type", "actionType", "name", "label", "description", "confirmText", "confirm", "condition", "disabled", "api", "endpoint", "method", "navigate", "to", "external", "newTab", "replace", "onClick", "reload", "close", "redirect", "toast", "successMessage", "errorMessage", "refreshAfter", "undoable", "params", "actionParams", "resultDialog", "target", "body", "openIn", "modal", "chain", "chainMode", "onSuccess", "onFailure", "opensInNewTab", "newTabUrl", "locations", "visible", "requiredPermissions", "icon", "variant", "order", "component", "objectName", "ai", "aria", "bodyExtra", "bodyShape", "mode", "recordIdField", "recordIdParam", "requiresFeature", "shortcut", "bulkEnabled"];
 /**
  * Every property `@objectstack/spec`'s `ActionSchema` declares.
  *
@@ -91,7 +125,7 @@ export declare const ACTION_DEF_KEYS: readonly ["type", "actionType", "name", "l
  * test and wrong in shipped code — `@object-ui/types` made the same call for
  * `ActionComponent`. The pin test does the walk and fails the day this drifts.
  */
-export declare const SPEC_ACTION_KEYS: readonly ["ai", "aria", "body", "bodyExtra", "bodyShape", "bulkEnabled", "component", "confirmText", "disabled", "errorMessage", "execute", "icon", "label", "locations", "method", "mode", "name", "newTabUrl", "objectName", "openIn", "opensInNewTab", "order", "params", "recordIdField", "recordIdParam", "refreshAfter", "requiredPermissions", "requiresFeature", "resultDialog", "shortcut", "successMessage", "target", "type", "undoable", "variant", "visible"];
+export declare const SPEC_ACTION_KEYS: readonly ["_lock", "_lockDocsUrl", "_lockReason", "_lockSource", "_packageId", "_packageVersion", "_provenance", "ai", "aria", "body", "bodyExtra", "bodyShape", "bulkEnabled", "component", "confirmText", "description", "disabled", "errorMessage", "execute", "icon", "label", "locations", "method", "mode", "name", "newTabUrl", "objectName", "openIn", "opensInNewTab", "order", "params", "recordIdField", "recordIdParam", "refreshAfter", "requiredPermissions", "requiresFeature", "resultDialog", "shortcut", "successMessage", "target", "type", "undoable", "variant", "visible"];
 /**
  * The `navigation` alias's own spelling of a target, read off the action itself
  * when no nested `navigate` object is present (`ActionRunner.executeNavigation`).
@@ -111,8 +145,15 @@ export declare const NAVIGATION_ALIAS_KEYS: readonly ["to", "external", "newTab"
  * Warned about separately from unknown keys, and more loudly: an unknown key is
  * probably a typo, while a retired key is metadata that used to work. That
  * distinction is why `executeScript` carries a runtime branch returning the
- * rename prescription — a branch that exists solely to compensate for the index
- * signature, and that can retire with it in step 3.
+ * rename prescription.
+ *
+ * Step 1 expected that branch to retire with the index signature. It does not,
+ * and the reason is the one in this module's header: `tsc` closed the
+ * code-authored half of the gap, while `execute: 'markDone'` lives in stored
+ * rows that reach the runner UNPARSED (objectstack#3903). The branch reads the
+ * key off an untyped view of the action precisely so that `ActionDef` can go on
+ * NOT declaring it — declaring it to make the read compile would re-legitimize
+ * a tombstone the spec keeps only in order to reject it by name.
  */
 export declare const RETIRED_ACTION_KEYS: Readonly<Record<string, string>>;
 /** Every key an action may legitimately carry today. */
@@ -133,3 +174,38 @@ export declare function resetActionKeyWarnings(): void;
  * down, this is the audible half.
  */
 export declare function warnOnUnknownActionKeys(action: object | null | undefined, where?: string): void;
+/**
+ * Does this action carry the DEPRECATED object-form `params` — a static request
+ * payload written under the key that means "parameter definitions"?
+ *
+ * The discriminator is `Array.isArray` and the type guard is `api`, mirroring
+ * `@objectstack/spec`'s `inline-action-api-params-to-body-extra` conversion
+ * (ADR-0087 D2) key for key. Contract parity with the producer is the point: the
+ * conversion rewrites exactly this shape to `bodyExtra` at load, so the runner
+ * must recognize exactly the same shape as "the thing that got rewritten".
+ *
+ * The `api` guard is also what keeps the deprecation out of objectstack#6828's
+ * territory — object-form `params` on a `type: 'url'` action is a THIRD meaning
+ * (`interpolateTarget`'s `${param.X}` scope, `executeUrl`'s `params.newTab`) and
+ * `bodyExtra` is NOT its replacement. Do not widen this guard without that
+ * ruling.
+ */
+export declare function hasDeprecatedObjectParams(action: object | null | undefined): boolean;
+/**
+ * Dev-mode only: name the object-form `params` that `@objectstack/spec` 17 already
+ * refuses at the authoring door, and prescribe `bodyExtra`.
+ *
+ * This is the audible half of the compat window the maintainer's 2026-08-06
+ * ruling on objectstack#5777 ordered (direction A — a separate key, no same-name
+ * union): the runner keeps READING a non-array `params` as the static payload for
+ * one version window, says so, and the arm is deleted at 18. The loud half lives
+ * at the producer, where it belongs — spec's `params` field refuses the object
+ * form outright with a message naming `bodyExtra`, and the ADR-0087 conversion
+ * rewrites sources that still carry it. So a warning is the correct severity
+ * HERE: by the time metadata reaches this runner the producer has already had its
+ * say, and what is left to catch is a host composing an ActionDef in code.
+ *
+ * Dev-only and warn-once, matching {@link warnOnUnknownActionKeys} — a warning
+ * that floods a production console is a warning that gets muted.
+ */
+export declare function warnOnDeprecatedObjectParams(action: object | null | undefined, where?: string): void;

package/dist/actions/actionKeys.js

@@ -6,26 +6,46 @@
  * LICENSE file in the root directory of this source tree.
  */
 /**
- * What an action is allowed to carry — objectstack#4075 step 1.
+ * What an action is allowed to carry — objectstack#4075, all three steps.
  *
- * `ActionDef` ends with `[key: string]: any`, so it accepts any key of any type.
- * Concretely (objectui#2990): deleting `ActionDef.execute` produced ZERO compile
- * errors even though the field had just been removed, and stale metadata still
- * authoring `execute: 'markDone'` type-checks today. The same deletion against
- * `@object-ui/types`' `ActionSchema` — which has no index signature — correctly
- * produced `TS2353` at the authoring site. One of the two readers can catch a
- * retired key; the other is structurally incapable.
+ * `ActionDef` used to end with `[key: string]: any`, so it accepted any key of
+ * any type. Concretely (objectui#2990): deleting `ActionDef.execute` produced
+ * ZERO compile errors even though the field had just been removed, and stale
+ * metadata authoring `execute: 'markDone'` type-checked. The same deletion
+ * against `@object-ui/types`' `ActionSchema` — which has no index signature —
+ * correctly produced `TS2353` at the authoring site. One of the two readers
+ * could catch a retired key; the other was structurally incapable.
  *
- * That asymmetry is the issue. An open key set on a DECLARED METADATA CONTRACT
+ * That asymmetry was the issue. An open key set on a DECLARED METADATA CONTRACT
  * is what lets a typo (`targt`, `exectue`) and a tombstoned key (`execute`) both
  * sail through to a runner that then silently does nothing — the #2169 "Mark
  * Done does nothing" shape.
  *
- * This module is step 1 of the staged narrowing: it makes the key set VISIBLE
- * and warns on anything outside it, without changing a single type. Nothing
- * breaks, and an invisible failure becomes an audible one. Steps 2 and 3 —
- * promoting the legitimate keys to explicit optional fields, then removing the
- * index signature — are what finally let `tsc` catch typos and retired keys.
+ * This module was step 1 of the staged narrowing: make the key set VISIBLE and
+ * warn on anything outside it, without changing a single type. Step 2 promoted
+ * the legitimate keys to explicit optional fields; **step 3 removed the index
+ * signature**, so `tsc` now rejects a typo or a retired key outright.
+ *
+ * ── Why this module SURVIVES step 3 ──────────────────────────────────────────
+ * Step 1 wrote that the dev-mode warning "can retire" once the index signature
+ * came down. Step 3 measured that and kept it, because the two mechanisms cover
+ * DISJOINT populations rather than the same one twice:
+ *
+ *   - `tsc` sees action literals AUTHORED IN CODE. It rejects an unknown key at
+ *     the construction site, which is the strongest possible signal — but only
+ *     for actions that exist as TypeScript.
+ *   - the warning below sees actions that arrive as DATA. objectstack#3903
+ *     established that stored `sys_metadata` rows are rehydrated UNPARSED, so
+ *     authored metadata reaches `runner.execute()` as a plain object no
+ *     compiler ever looked at. That is the population `execute: 'markDone'`
+ *     actually lives in, and no type can reach it.
+ *
+ * Retiring the warning would therefore have re-opened the runtime half of the
+ * gap while closing the compile-time half — which is why `executeScript`'s
+ * rename-prescription branch also survives, for the same rows and the same
+ * reason. What DID retire with the index signature is the inverted pin in
+ * `actionKeys.pin.test.ts` that asserted the signature was still there; it now
+ * asserts the opposite, which was always its stated completion condition.
  *
  * The lists are pinned by `__tests__/actionKeys.pin.test.ts`, which re-derives
  * each one from its actual source. A hand-maintained list that drifts from the
@@ -66,8 +86,22 @@
  * deprecating them toward a spelling that does not exist would be worse than
  * leaving them declared.
  *
- * Step 3 remains: remove the index signature, at which point `tsc` catches both
- * typos and retired keys and the dev-mode warning below can retire with it.
+ * ── What step 3 found the first two steps had missed ─────────────────────────
+ * Deleting the index signature is the only thing that can name the keys still
+ * hiding behind it, and it named five, in two groups:
+ *
+ * `to` / `external` / `newTab` / `replace` — the `navigation` alias's own
+ * spelling. Step 1 had already ruled these legitimate and listed them below in
+ * {@link NAVIGATION_ALIAS_KEYS}, but step 2's scope was the SPEC-owned keys, so
+ * they were declared as data and never as fields; `executeNavigation` read them
+ * through the index signature. Promoted, and deliberately not `@deprecated` —
+ * step 2's acceptance ruled on exactly that point.
+ *
+ * `description` — objectui vocabulary from `@object-ui/types`' renderer view of
+ * an action, forwarded by all four action renderers (`check:action-forward-parity`
+ * requires it) and read by the param-collection dialog for its subtitle
+ * (objectui#4192). Authorable, forwarded, read — and undeclared. These were the
+ * only two `TS2353`s the deletion produced across the whole workspace.
  */
 /**
  * Every property `ActionDef` declares, in declaration order.
@@ -81,6 +115,10 @@ export const ACTION_DEF_KEYS = [
     'actionType',
     'name',
     'label',
+    // Promoted by step 3 — objectui vocabulary (`@object-ui/types`' renderer view
+    // of an action), forwarded by all four action renderers and read by the
+    // param-collection dialog, but never declared on `ActionDef`.
+    'description',
     'confirmText',
     'confirm',
     'condition',
@@ -89,6 +127,14 @@ export const ACTION_DEF_KEYS = [
     'endpoint',
     'method',
     'navigate',
+    // The `navigation` alias's own spelling, promoted to real fields by step 3.
+    // Listed a second time in `NAVIGATION_ALIAS_KEYS` below, which keeps the
+    // separate fact that these four are objectui dialect with a spec-adoption
+    // tripwire; this list is only "what the interface declares".
+    'to',
+    'external',
+    'newTab',
+    'replace',
     'onClick',
     'reload',
     'close',
@@ -150,6 +196,17 @@ export const ACTION_DEF_KEYS = [
  * `ActionComponent`. The pin test does the walk and fails the day this drifts.
  */
 export const SPEC_ACTION_KEYS = [
+    // The package-lock / provenance envelope, added to `ActionSchema` in spec
+    // 17.0.0-rc.2. Not authorable action vocabulary — it is stamped on a record
+    // that came from an installed package — but it IS declared by the schema, so
+    // an action carrying it must not be reported as having unknown keys.
+    '_lock',
+    '_lockDocsUrl',
+    '_lockReason',
+    '_lockSource',
+    '_packageId',
+    '_packageVersion',
+    '_provenance',
     'ai',
     'aria',
     'body',
@@ -158,6 +215,15 @@ export const SPEC_ACTION_KEYS = [
     'bulkEnabled',
     'component',
     'confirmText',
+    // Added to `ActionSchema` in @objectstack/spec 17.0.0-rc.6. Listed here purely
+    // because this array's contract is "every property the spec's `ActionSchema`
+    // declares" — restating the spec, not adopting a feature. `ActionDef` does NOT
+    // declare `description` and is not changed: whether the runner or any renderer
+    // should READ it is a separate question, and `actionKeys.pin.test.ts`'s
+    // `ActionDef` half stays green without it. What this entry buys is that an
+    // action carrying a `description` is no longer reported as having an unknown
+    // key, which is the only thing the inventory is consulted for.
+    'description',
     'disabled',
     'errorMessage',
     'execute',
@@ -206,8 +272,15 @@ export const NAVIGATION_ALIAS_KEYS = ['to', 'external', 'newTab', 'replace'];
  * Warned about separately from unknown keys, and more loudly: an unknown key is
  * probably a typo, while a retired key is metadata that used to work. That
  * distinction is why `executeScript` carries a runtime branch returning the
- * rename prescription — a branch that exists solely to compensate for the index
- * signature, and that can retire with it in step 3.
+ * rename prescription.
+ *
+ * Step 1 expected that branch to retire with the index signature. It does not,
+ * and the reason is the one in this module's header: `tsc` closed the
+ * code-authored half of the gap, while `execute: 'markDone'` lives in stored
+ * rows that reach the runner UNPARSED (objectstack#3903). The branch reads the
+ * key off an untyped view of the action precisely so that `ActionDef` can go on
+ * NOT declaring it — declaring it to make the read compile would re-legitimize
+ * a tombstone the spec keeps only in order to reject it by name.
  */
 export const RETIRED_ACTION_KEYS = {
     execute: '`execute` was removed in @objectstack/spec 17 (#3855) — rename the key to `target`. ' +
@@ -281,3 +354,80 @@ export function warnOnUnknownActionKeys(action, where = 'ActionRunner') {
         '(packages/core/src/actions/actionKeys.ts). Warned rather than rejected because `ActionDef` ' +
         'still carries `[key: string]: any`, so the compiler cannot see this (objectstack#4075).');
 }
+/**
+ * Keys a HOST stashes into an action's `params` for the runner's own plumbing,
+ * rather than an author writing them there as a request payload.
+ *
+ * {@link warnOnDeprecatedObjectParams} has to tell "the author put the payload in
+ * `params`" (the shape objectstack#5777 retires) apart from "a host stashed row
+ * context there" (a shape the runner itself asks for, and that is not going
+ * away). `DeclaredActionsBar` dispatches `params: { _rowRecord: record }`,
+ * `RelatedRecordActionsBridge` does the same, and `ObjectGrid` adds
+ * `_selectedIds`; the api handler lifts `recordId` out of the field values
+ * before it updates. Warning on those would fire on nearly every declared-action
+ * click and prescribe `bodyExtra`, which is the wrong home for all of them.
+ *
+ * The `_` prefix is the existing convention for the stash — `recordId` is its one
+ * unprefixed member, so it is listed rather than inferred.
+ */
+const HOST_STASHED_PARAM_KEYS = new Set(['recordId']);
+const isAuthoredParamKey = (key) => !key.startsWith('_') && !HOST_STASHED_PARAM_KEYS.has(key);
+/**
+ * Does this action carry the DEPRECATED object-form `params` — a static request
+ * payload written under the key that means "parameter definitions"?
+ *
+ * The discriminator is `Array.isArray` and the type guard is `api`, mirroring
+ * `@objectstack/spec`'s `inline-action-api-params-to-body-extra` conversion
+ * (ADR-0087 D2) key for key. Contract parity with the producer is the point: the
+ * conversion rewrites exactly this shape to `bodyExtra` at load, so the runner
+ * must recognize exactly the same shape as "the thing that got rewritten".
+ *
+ * The `api` guard is also what keeps the deprecation out of objectstack#6828's
+ * territory — object-form `params` on a `type: 'url'` action is a THIRD meaning
+ * (`interpolateTarget`'s `${param.X}` scope, `executeUrl`'s `params.newTab`) and
+ * `bodyExtra` is NOT its replacement. Do not widen this guard without that
+ * ruling.
+ */
+export function hasDeprecatedObjectParams(action) {
+    if (!action || typeof action !== 'object')
+        return false;
+    const { type, actionType, params } = action;
+    if ((type ?? actionType) !== 'api')
+        return false;
+    if (!params || typeof params !== 'object' || Array.isArray(params))
+        return false;
+    return Object.keys(params).some(isAuthoredParamKey);
+}
+/**
+ * Dev-mode only: name the object-form `params` that `@objectstack/spec` 17 already
+ * refuses at the authoring door, and prescribe `bodyExtra`.
+ *
+ * This is the audible half of the compat window the maintainer's 2026-08-06
+ * ruling on objectstack#5777 ordered (direction A — a separate key, no same-name
+ * union): the runner keeps READING a non-array `params` as the static payload for
+ * one version window, says so, and the arm is deleted at 18. The loud half lives
+ * at the producer, where it belongs — spec's `params` field refuses the object
+ * form outright with a message naming `bodyExtra`, and the ADR-0087 conversion
+ * rewrites sources that still carry it. So a warning is the correct severity
+ * HERE: by the time metadata reaches this runner the producer has already had its
+ * say, and what is left to catch is a host composing an ActionDef in code.
+ *
+ * Dev-only and warn-once, matching {@link warnOnUnknownActionKeys} — a warning
+ * that floods a production console is a warning that gets muted.
+ */
+export function warnOnDeprecatedObjectParams(action, where = 'ActionRunner') {
+    if (!isDev())
+        return;
+    if (!hasDeprecatedObjectParams(action))
+        return;
+    const name = action?.name ?? '(unnamed)';
+    const memo = `deprecated-object-params:${String(name)}`;
+    if (warned.has(memo))
+        return;
+    warned.add(memo);
+    console.warn(`[${where}] action "${String(name)}" carries a static request payload in \`params\`. ` +
+        '`params` is the parameter DEFINITION array (fields collected from the user before the ' +
+        'action runs), never a payload map — put the payload in `bodyExtra` instead ' +
+        '(objectstack#5777). Still read as the payload for one version window; the arm is ' +
+        'removed at 18. `bodyExtra` is merged LAST, so it overrides anything left here.');
+}

package/dist/actions/actionResponse.d.ts

@@ -0,0 +1,42 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export interface ActionResponseOutcome {
+    ok: boolean;
+    /** Human-readable failure text. Always a string when `ok` is false. */
+    error?: string;
+    /**
+     * The ACTION ENVELOPE (`body.data`) — `{ success, data }`. Kept as-is
+     * because `ActionResult.data` has always carried this level and
+     * `resultDialog` field paths in the wild may compensate for it; see the
+     * note in {@link readActionPayload}.
+     */
+    envelope?: unknown;
+    /** What the handler actually returned (`body.data.data`). */
+    payload?: unknown;
+}
+/**
+ * The handler's own return value — one level deeper than the action envelope.
+ *
+ * `body.data` is `{ success, data }`; the handler's value is `body.data.data`.
+ * Reading the shallower level is why an action returning `{ redirectUrl }` was
+ * silently ignored: `body.data.redirectUrl` is never set by anything, because
+ * that level is constructed by the server and only ever holds `success`/`data`.
+ */
+export declare function readActionPayload(envelope: unknown): unknown;
+/** The pre-objectstack#3962 inner envelope, detected narrowly. */
+export declare function isLegacyActionEnvelope(v: unknown): boolean;
+/**
+ * Classify an `/actions` response. `label` names the action for the fallback
+ * message (e.g. `Action "log_call" failed`).
+ *
+ * `json` is the parsed body, or `null` when it could not be parsed.
+ */
+export declare function interpretActionResponse(res: {
+    ok: boolean;
+    status: number;
+}, json: any, label: string): ActionResponseOutcome;

package/dist/actions/actionResponse.js

@@ -0,0 +1,104 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * The ONE place a `POST /api/v1/actions/...` response is interpreted.
+ *
+ * This existed twice — `useConsoleActionRuntime.serverActionHandler` and
+ * `RecordDetailView`'s copy of the same handler — and the two drifted, which is
+ * the whole reason objectstack#3913 was filed against the console: one copy
+ * learned to inspect the inner envelope and the other did not, so a failed
+ * action fired a green "completed" toast on every list/page surface. Two copies
+ * of a subtle envelope rule is a bug generator; this is the rule, once.
+ *
+ * Moved from `@object-ui/app-shell` (`utils/actionResponse`) into core by
+ * objectui#2904: `createServerActionHandler` — the dispatch every consumer
+ * registers as its `script` handler — lives here and must apply the rule, so
+ * the rule lives beside it.
+ *
+ * ## The legacy envelope was DOUBLE, and that was the trap (pre-objectstack#3962)
+ *
+ * ```
+ * {                          ← transport envelope
+ *   success: true,
+ *   data: {                  ← action envelope
+ *     success: true,
+ *     data: { … }            ← what the handler actually returned
+ *   }
+ * }
+ * ```
+ *
+ * Unlike `/api/v1/<anything-else>`, which wraps ONCE, `/actions` wraps twice —
+ * the route's own `{success, data}` sits inside the dispatcher's. Reading one
+ * level (the natural instinct, and what the other handlers correctly do) lands
+ * on the action envelope, not the payload.
+ *
+ * ## Failure has three shapes, and `res.ok` alone catches only one
+ *
+ * - **dispatch failure** — 404 no such action, 403 denied, 400 wrong action
+ *   type, 503 unavailable, 500 the handler crashed. `res.ok` is false.
+ * - **business rejection** — the handler ran and said no. HTTP **200** with
+ *   `data.success === false`. `res.ok` is TRUE; only the inner envelope shows
+ *   it. This is the one that got missed.
+ * - **transport-level `success: false`** — the outer envelope reporting a
+ *   failure directly.
+ */
+import { actionErrorDetail } from './actionErrorDetail';
+/**
+ * The handler's own return value — one level deeper than the action envelope.
+ *
+ * `body.data` is `{ success, data }`; the handler's value is `body.data.data`.
+ * Reading the shallower level is why an action returning `{ redirectUrl }` was
+ * silently ignored: `body.data.redirectUrl` is never set by anything, because
+ * that level is constructed by the server and only ever holds `success`/`data`.
+ */
+export function readActionPayload(envelope) {
+    // objectstack#3962 servers single-wrap: `body.data` IS the handler value,
+    // so most of the time this is the identity function. Only the exact LEGACY
+    // action envelope (pre-#3962: a boolean `success` and no keys beyond the
+    // envelope's own) is unwrapped one more level — a handler value that
+    // merely contains a `success` key passes through untouched.
+    if (isLegacyActionEnvelope(envelope)) {
+        return envelope.data;
+    }
+    return envelope;
+}
+const LEGACY_ENVELOPE_KEYS = new Set(['success', 'data', 'error', 'code', 'fields']);
+/** The pre-objectstack#3962 inner envelope, detected narrowly. */
+export function isLegacyActionEnvelope(v) {
+    return !!v && typeof v === 'object' && !Array.isArray(v)
+        && typeof v.success === 'boolean'
+        && Object.keys(v).every((k) => LEGACY_ENVELOPE_KEYS.has(k));
+}
+/**
+ * Classify an `/actions` response. `label` names the action for the fallback
+ * message (e.g. `Action "log_call" failed`).
+ *
+ * `json` is the parsed body, or `null` when it could not be parsed.
+ */
+export function interpretActionResponse(res, json, label) {
+    const envelope = json?.data;
+    // Pre-#3962 servers reported a rejection as HTTP 200 with the inner
+    // `{success:false, error}`; current servers answer a real status, which
+    // `res.ok` catches first. Detected narrowly so a handler value that merely
+    // contains `success: false` is not misread as a failure.
+    const innerFailed = isLegacyActionEnvelope(envelope) && envelope.success === false;
+    if (!res.ok || (json && json.success === false) || innerFailed) {
+        // A business rejection carries its message on the INNER envelope; a
+        // dispatch failure carries it on the outer one (as a nested
+        // `{message, code}` object, which `actionErrorDetail` resolves to a
+        // string — handing that object to `toast.error()` as a React child
+        // crashes the page, React #31).
+        return {
+            ok: false,
+            error: innerFailed
+                ? actionErrorDetail(envelope, `${label} failed`)
+                : actionErrorDetail(json, `${label} failed (HTTP ${res.status})`),
+        };
+    }
+    return { ok: true, envelope, payload: readActionPayload(envelope) };
+}

package/dist/actions/index.d.ts

@@ -11,3 +11,6 @@ export * from './actionKeys.js';
 export * from './TransactionManager.js';
 export * from './UndoManager.js';
 export * from './bulkFastPath.js';
+export * from './actionErrorDetail.js';
+export * from './actionResponse.js';
+export * from './serverActionHandler.js';

package/dist/actions/index.js

@@ -11,3 +11,6 @@ export * from './actionKeys.js';
 export * from './TransactionManager.js';
 export * from './UndoManager.js';
 export * from './bulkFastPath.js';
+export * from './actionErrorDetail.js';
+export * from './actionResponse.js';
+export * from './serverActionHandler.js';