@panneau/actions 5.0.0-alpha.1 → 5.0.0-alpha.3

package/README.md

@@ -5,7 +5,12 @@ Runs the actions of lists and forms: parameters in a dialog, the action through
 ```tsx
 import { useQueryClient } from '@tanstack/react-query';
 
-import { ActionRunnerProvider, ActionRuns, useActionRunner } from '@panneau/actions';
+import {
+    ActionRunnerProvider,
+    ActionRuns,
+    useActionPreview,
+    useActionRunner,
+} from '@panneau/actions';
 import { createRestAdapter } from '@panneau/data';
 import { invalidateActionResult } from '@panneau/data/query';
 import { ListView } from '@panneau/lists';
@@ -33,6 +38,7 @@ function App() {
 
 function Pages() {
     const runAction = useActionRunner('pages');
+    const previewAction = useActionPreview('pages');
     return (
         <ListView
             list={list}
@@ -40,14 +46,15 @@ function Pages() {
             columns={columns}
             actions={actions}
             onAction={runAction}
+            previewAction={previewAction}
         />
     );
 }
 ```
 
-| Export             | Content                                                                                                                                               |
-| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `@panneau/actions` | `ActionRunnerProvider`, `useActionRunner()`, `ActionRuns` and `useActionRuns()`, the dialogs (`ParametersDialog`, `ResultsDialog`), and their helpers |
+| Export             | Content                                                                                                                                                                     |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `@panneau/actions` | `ActionRunnerProvider`, `useActionRunner()`, `useActionPreview()`, `ActionRuns` and `useActionRuns()`, the dialogs (`ParametersDialog`, `ResultsDialog`), and their helpers |
 
 ## What the runner does
 
@@ -62,6 +69,8 @@ function Pages() {
 - **`link` actions** go to their `url` (with `{id}`) or `route`, through `onNavigate`.
 - **`client` actions** render the handler that their `component` names: one of `clientActions`, or of the plugins of `PanneauProvider` (`definePlugin({ actions: { 'share-dialog': ShareDialog } })`). It gets `ClientActionProps`, and ends with `onDone(result?)` or `onCancel()`.
 
+**Dry runs.** `useActionPreview(resource)` is a list's `previewAction`. For an action that declares `dryRun`, on every item matching a query ("Select all N items"), it asks the backend what the action would do without running it (`"dryRun": true`), so that the list's confirmation says how many items will really be skipped: the list only knows the abilities of the current page. `previewAction(adapter, resource, target)` does the same outside of React.
+
 The function resolves with what happened (`{ status: 'done', result }`, `{ status: 'queued', run }` or `{ status: 'navigated', to }`), with `false` when the user cancelled the parameters (a list then keeps its selection), and rejects when the action failed (a list then shows it in a toast).
 
 ## The adapter

package/dist/ActionRunner.css

@@ -1,13 +1,13 @@
-.panneau-parameters-i1oaps {
+.panneau-action-runner-parameters {
     margin: 0;
 }
 
-.panneau-summary-tEkW4i {
+.panneau-action-runner-summary {
     margin: 0 0 var(--panneau-space-3);
     color: var(--panneau-color-text-muted);
 }
 
-.panneau-results-vlBNo6 {
+.panneau-action-runner-results {
     display: grid;
     gap: var(--panneau-space-2);
     margin: 0;
@@ -15,7 +15,7 @@
     list-style: none;
 }
 
-.panneau-result-XImXXf {
+.panneau-action-runner-result {
     display: flex;
     flex-wrap: wrap;
     align-items: center;
@@ -24,16 +24,16 @@
     border-bottom: var(--panneau-border-width) solid var(--panneau-color-border);
 }
 
-.panneau-resultItem-52NJiR {
+.panneau-action-runner-result-item {
     font-weight: var(--panneau-font-weight-medium);
 }
 
-.panneau-resultReason-p8tmL2 {
+.panneau-action-runner-result-reason {
     flex: 1 1 12rem;
     color: var(--panneau-color-text-muted);
 }
 
-.panneau-runs-jyhVY9 {
+.panneau-action-runner-runs {
     display: grid;
     gap: var(--panneau-space-3);
     margin: 0;
@@ -41,36 +41,36 @@
     list-style: none;
 }
 
-.panneau-run-WVS47T {
+.panneau-action-runner-run {
     display: grid;
     grid-template-columns: 1fr auto;
     align-items: center;
     gap: var(--panneau-space-1) var(--panneau-space-2);
 }
 
-.panneau-runLabel-fBJsOE {
+.panneau-action-runner-run-label {
     font-weight: var(--panneau-font-weight-medium);
 }
 
-.panneau-runStatus-sbRCO7 {
+.panneau-action-runner-run-status {
     font-size: var(--panneau-font-size-sm);
     color: var(--panneau-color-text-muted);
 }
 
-.panneau-progress-iJJ5Sw {
+.panneau-action-runner-progress {
     grid-column: 1 / -1;
     display: grid;
     gap: var(--panneau-space-1);
 }
 
-.panneau-track-QAzi12 {
+.panneau-action-runner-track {
     height: 0.375rem;
     overflow: hidden;
     background: var(--panneau-color-surface-sunken);
     border-radius: var(--panneau-radius-full);
 }
 
-.panneau-fill-IPxBGq {
+.panneau-action-runner-fill {
     height: 100%;
     background: var(--panneau-color-accent);
     border-radius: inherit;
@@ -78,7 +78,7 @@
 }
 
 @media (prefers-reduced-motion: reduce) {
-    .panneau-fill-IPxBGq {
+    .panneau-action-runner-fill {
         transition: none;
     }
 }

package/dist/ActionRunner.module.js

@@ -1,18 +1,18 @@
 import "./ActionRunner.css";
 //#region src/ActionRunner.module.css
-var parameters = "panneau-parameters-i1oaps";
-var summary = "panneau-summary-tEkW4i";
-var results = "panneau-results-vlBNo6";
-var result = "panneau-result-XImXXf";
-var resultItem = "panneau-resultItem-52NJiR";
-var resultReason = "panneau-resultReason-p8tmL2";
-var runs = "panneau-runs-jyhVY9";
-var run = "panneau-run-WVS47T";
-var runLabel = "panneau-runLabel-fBJsOE";
-var runStatus = "panneau-runStatus-sbRCO7";
-var progress = "panneau-progress-iJJ5Sw";
-var track = "panneau-track-QAzi12";
-var fill = "panneau-fill-IPxBGq";
+var parameters = "panneau-action-runner-parameters";
+var summary = "panneau-action-runner-summary";
+var results = "panneau-action-runner-results";
+var result = "panneau-action-runner-result";
+var resultItem = "panneau-action-runner-result-item";
+var resultReason = "panneau-action-runner-result-reason";
+var runs = "panneau-action-runner-runs";
+var run = "panneau-action-runner-run";
+var runLabel = "panneau-action-runner-run-label";
+var runStatus = "panneau-action-runner-run-status";
+var progress = "panneau-action-runner-progress";
+var track = "panneau-action-runner-track";
+var fill = "panneau-action-runner-fill";
 var ActionRunner_module_default = {
 	parameters,
 	summary,

package/dist/index.d.ts

@@ -3,7 +3,8 @@ export { ActionRuns, type ActionRunsProps } from './ActionRuns';
 export { ParametersDialog, type ParametersDialogProps } from './ParametersDialog';
 export { ResultsDialog, type ResultsDialogProps } from './ResultsDialog';
 export { describeItemResult, describeResult } from './describe';
+export { type ActionPreview, canPreviewAction, previewAction } from './preview';
 export { buildActionRequest, getLinkTarget, getResultCounts } from './request';
 export type { ActionAdapter, ActionDownload, ActionOutcome, ActionResultContext, ActionTarget, ClientActionHandler, ClientActionProps, FollowedRun, } from './types';
-export { useActionRunner, useActionRuns } from './useActionRunner';
+export { useActionPreview, useActionRunner, useActionRuns } from './useActionRunner';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,KAAK,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAC9F,OAAO,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC/E,YAAY,EACR,aAAa,EACb,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,WAAW,GACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,KAAK,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAC9F,OAAO,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,KAAK,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC/E,YAAY,EACR,aAAa,EACb,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,WAAW,GACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -4,5 +4,6 @@ import { describeItemResult, describeResult } from "./describe.js";
 import { ResultsDialog } from "./ResultsDialog.js";
 import { ActionRunnerProvider } from "./ActionRunnerProvider.js";
 import { ActionRuns } from "./ActionRuns.js";
-import { useActionRunner, useActionRuns } from "./useActionRunner.js";
-export { ActionRunnerProvider, ActionRuns, ParametersDialog, ResultsDialog, buildActionRequest, describeItemResult, describeResult, getLinkTarget, getResultCounts, useActionRunner, useActionRuns };
+import { canPreviewAction, previewAction } from "./preview.js";
+import { useActionPreview, useActionRunner, useActionRuns } from "./useActionRunner.js";
+export { ActionRunnerProvider, ActionRuns, ParametersDialog, ResultsDialog, buildActionRequest, canPreviewAction, describeItemResult, describeResult, getLinkTarget, getResultCounts, previewAction, useActionPreview, useActionRunner, useActionRuns };

package/dist/preview.d.ts

@@ -0,0 +1,21 @@
+import type { ActionAdapter, ActionTarget } from './types';
+/** What a dry run of an action told: how many items it would apply to, and skip. */
+export interface ActionPreview {
+    succeeded: number;
+    skipped: number;
+}
+/**
+ * Whether the backend can say what an action would do before it runs: a `server` action with
+ * `dryRun`, on every item matching a query. Selected ids need no dry run, since the list knows
+ * their abilities.
+ */
+export declare function canPreviewAction(target: ActionTarget): boolean;
+/**
+ * Asks the backend what an action would do on a query selection, without running it (a dry run,
+ * `"dryRun": true` in the request), and resolves with the counts of its summary, or with `null`
+ * for an action that can't be previewed (`canPreviewAction()`).
+ */
+export declare function previewAction(adapter: Pick<ActionAdapter, 'runAction'>, resource: string, target: ActionTarget, options?: {
+    signal?: AbortSignal;
+}): Promise<ActionPreview | null>;
+//# sourceMappingURL=preview.d.ts.map

package/dist/preview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preview.d.ts","sourceRoot":"","sources":["../src/preview.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE3D,oFAAoF;AACpF,MAAM,WAAW,aAAa;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAQ9D;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAC/B,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,EACzC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,WAAW,CAAA;CAAO,GACvC,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAc/B"}

package/dist/preview.js

@@ -0,0 +1,30 @@
+//#region src/preview.ts
+/**
+* Whether the backend can say what an action would do before it runs: a `server` action with
+* `dryRun`, on every item matching a query. Selected ids need no dry run, since the list knows
+* their abilities.
+*/
+function canPreviewAction(target) {
+	const { action, selection } = target;
+	return action.dryRun === true && action.kind === "server" && selection !== void 0 && "query" in selection;
+}
+/**
+* Asks the backend what an action would do on a query selection, without running it (a dry run,
+* `"dryRun": true` in the request), and resolves with the counts of its summary, or with `null`
+* for an action that can't be previewed (`canPreviewAction()`).
+*/
+async function previewAction(adapter, resource, target, options = {}) {
+	if (!canPreviewAction(target)) return null;
+	const summary = (await adapter.runAction(resource, target.action.id, {
+		selection: target.selection,
+		dryRun: true
+	}, options)).result?.summary;
+	return summary !== void 0 ? {
+		succeeded: summary.succeeded,
+		skipped: summary.skipped
+	} : null;
+}
+//#endregion
+export { canPreviewAction, previewAction };
+
+//# sourceMappingURL=preview.js.map

package/dist/preview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preview.js","names":[],"sources":["../src/preview.ts"],"sourcesContent":["import type { ActionAdapter, ActionTarget } from './types';\n\n/** What a dry run of an action told: how many items it would apply to, and skip. */\nexport interface ActionPreview {\n    succeeded: number;\n    skipped: number;\n}\n\n/**\n * Whether the backend can say what an action would do before it runs: a `server` action with\n * `dryRun`, on every item matching a query. Selected ids need no dry run, since the list knows\n * their abilities.\n */\nexport function canPreviewAction(target: ActionTarget): boolean {\n    const { action, selection } = target;\n    return (\n        action.dryRun === true &&\n        action.kind === 'server' &&\n        selection !== undefined &&\n        'query' in selection\n    );\n}\n\n/**\n * Asks the backend what an action would do on a query selection, without running it (a dry run,\n * `\"dryRun\": true` in the request), and resolves with the counts of its summary, or with `null`\n * for an action that can't be previewed (`canPreviewAction()`).\n */\nexport async function previewAction(\n    adapter: Pick<ActionAdapter, 'runAction'>,\n    resource: string,\n    target: ActionTarget,\n    options: { signal?: AbortSignal } = {},\n): Promise<ActionPreview | null> {\n    if (!canPreviewAction(target)) {\n        return null;\n    }\n    const response = await adapter.runAction(\n        resource,\n        target.action.id,\n        { selection: target.selection, dryRun: true },\n        options,\n    );\n    const summary = response.result?.summary;\n    return summary !== undefined\n        ? { succeeded: summary.succeeded, skipped: summary.skipped }\n        : null;\n}\n"],"mappings":";;;;;;AAaA,SAAgB,iBAAiB,QAA+B;CAC5D,MAAM,EAAE,QAAQ,cAAc;CAC9B,OACI,OAAO,WAAW,QAClB,OAAO,SAAS,YAChB,cAAc,KAAA,KACd,WAAW;AAEnB;;;;;;AAOA,eAAsB,cAClB,SACA,UACA,QACA,UAAoC,CAAC,GACR;CAC7B,IAAI,CAAC,iBAAiB,MAAM,GACxB,OAAO;CAQX,MAAM,WAAU,MANO,QAAQ,UAC3B,UACA,OAAO,OAAO,IACd;EAAE,WAAW,OAAO;EAAW,QAAQ;CAAK,GAC5C,OACJ,EAAA,CACyB,QAAQ;CACjC,OAAO,YAAY,KAAA,IACb;EAAE,WAAW,QAAQ;EAAW,SAAS,QAAQ;CAAQ,IACzD;AACV"}

package/dist/useActionRunner.d.ts

@@ -1,3 +1,4 @@
+import { type ActionPreview } from './preview';
 import type { ActionOutcome, ActionTarget, FollowedRun } from './types';
 /**
  * Runs the actions of a resource through the closest `ActionRunnerProvider`. The function takes a
@@ -12,6 +13,15 @@ import type { ActionOutcome, ActionTarget, FollowedRun } from './types';
  * user cancelled its parameters (a list then keeps its selection), and rejects when it failed.
  */
 export declare function useActionRunner(resource: string): (target: ActionTarget) => Promise<ActionOutcome | false>;
+/**
+ * Asks the backend how many items of a query selection an action would skip, before the list
+ * confirms it (a dry run, for actions with `dryRun`). It is the `previewAction` of a list:
+ *
+ * ```tsx
+ * <ListView onAction={useActionRunner('pages')} previewAction={useActionPreview('pages')} … />
+ * ```
+ */
+export declare function useActionPreview(resource: string): (target: ActionTarget) => Promise<ActionPreview | null>;
 /** The queued runs of the closest `ActionRunnerProvider`, to cancel or dismiss them. */
 export declare function useActionRuns(): {
     runs: readonly FollowedRun[];

package/dist/useActionRunner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useActionRunner.d.ts","sourceRoot":"","sources":["../src/useActionRunner.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAExE;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAC3B,QAAQ,EAAE,MAAM,GACjB,CAAC,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,aAAa,GAAG,KAAK,CAAC,CAM1D;AAED,wFAAwF;AACxF,wBAAgB,aAAa,IAAI;IAC7B,IAAI,EAAE,SAAS,WAAW,EAAE,CAAC;IAC7B,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACjC,CAMA"}
+{"version":3,"file":"useActionRunner.d.ts","sourceRoot":"","sources":["../src/useActionRunner.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,WAAW,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAExE;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAC3B,QAAQ,EAAE,MAAM,GACjB,CAAC,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,aAAa,GAAG,KAAK,CAAC,CAM1D;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC5B,QAAQ,EAAE,MAAM,GACjB,CAAC,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAMzD;AAED,wFAAwF;AACxF,wBAAgB,aAAa,IAAI;IAC7B,IAAI,EAAE,SAAS,WAAW,EAAE,CAAC;IAC7B,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACjC,CAMA"}

package/dist/useActionRunner.js

@@ -1,4 +1,5 @@
 import { ActionRunnerContext } from "./context.js";
+import { previewAction } from "./preview.js";
 import { use } from "react";
 //#region src/useActionRunner.ts
 /**
@@ -18,6 +19,19 @@ function useActionRunner(resource) {
 	if (context === null) throw new Error("useActionRunner() must be used inside <ActionRunnerProvider>.");
 	return (target) => context.run(resource, target);
 }
+/**
+* Asks the backend how many items of a query selection an action would skip, before the list
+* confirms it (a dry run, for actions with `dryRun`). It is the `previewAction` of a list:
+*
+* ```tsx
+* <ListView onAction={useActionRunner('pages')} previewAction={useActionPreview('pages')} … />
+* ```
+*/
+function useActionPreview(resource) {
+	const context = use(ActionRunnerContext);
+	if (context === null) throw new Error("useActionPreview() must be used inside <ActionRunnerProvider>.");
+	return (target) => previewAction(context.adapter, resource, target);
+}
 /** The queued runs of the closest `ActionRunnerProvider`, to cancel or dismiss them. */
 function useActionRuns() {
 	const context = use(ActionRunnerContext);
@@ -29,6 +43,6 @@ function useActionRuns() {
 	};
 }
 //#endregion
-export { useActionRunner, useActionRuns };
+export { useActionPreview, useActionRunner, useActionRuns };
 
 //# sourceMappingURL=useActionRunner.js.map

package/dist/useActionRunner.js.map

@@ -1 +1 @@
-{"version":3,"file":"useActionRunner.js","names":[],"sources":["../src/useActionRunner.ts"],"sourcesContent":["import { use } from 'react';\n\nimport { ActionRunnerContext } from './context';\nimport type { ActionOutcome, ActionTarget, FollowedRun } from './types';\n\n/**\n * Runs the actions of a resource through the closest `ActionRunnerProvider`. The function takes a\n * list's `ListActionEvent`, so it is the `onAction` of a list:\n *\n * ```tsx\n * const runAction = useActionRunner('pages');\n * <ListView list={list} items={items} actions={actions} onAction={runAction} />\n * ```\n *\n * It resolves once the action has run, has been queued or has navigated, with `false` when the\n * user cancelled its parameters (a list then keeps its selection), and rejects when it failed.\n */\nexport function useActionRunner(\n    resource: string,\n): (target: ActionTarget) => Promise<ActionOutcome | false> {\n    const context = use(ActionRunnerContext);\n    if (context === null) {\n        throw new Error('useActionRunner() must be used inside <ActionRunnerProvider>.');\n    }\n    return (target) => context.run(resource, target);\n}\n\n/** The queued runs of the closest `ActionRunnerProvider`, to cancel or dismiss them. */\nexport function useActionRuns(): {\n    runs: readonly FollowedRun[];\n    cancel: (id: string) => Promise<void>;\n    dismiss: (id: string) => void;\n} {\n    const context = use(ActionRunnerContext);\n    if (context === null) {\n        throw new Error('useActionRuns() must be used inside <ActionRunnerProvider>.');\n    }\n    return { runs: context.runs, cancel: context.cancelRun, dismiss: context.dismissRun };\n}\n"],"mappings":";;;;;;;;;;;;;;;AAiBA,SAAgB,gBACZ,UACwD;CACxD,MAAM,UAAU,IAAI,mBAAmB;CACvC,IAAI,YAAY,MACZ,MAAM,IAAI,MAAM,+DAA+D;CAEnF,QAAQ,WAAW,QAAQ,IAAI,UAAU,MAAM;AACnD;;AAGA,SAAgB,gBAId;CACE,MAAM,UAAU,IAAI,mBAAmB;CACvC,IAAI,YAAY,MACZ,MAAM,IAAI,MAAM,6DAA6D;CAEjF,OAAO;EAAE,MAAM,QAAQ;EAAM,QAAQ,QAAQ;EAAW,SAAS,QAAQ;CAAW;AACxF"}
+{"version":3,"file":"useActionRunner.js","names":[],"sources":["../src/useActionRunner.ts"],"sourcesContent":["import { use } from 'react';\n\nimport { ActionRunnerContext } from './context';\nimport { type ActionPreview, previewAction } from './preview';\nimport type { ActionOutcome, ActionTarget, FollowedRun } from './types';\n\n/**\n * Runs the actions of a resource through the closest `ActionRunnerProvider`. The function takes a\n * list's `ListActionEvent`, so it is the `onAction` of a list:\n *\n * ```tsx\n * const runAction = useActionRunner('pages');\n * <ListView list={list} items={items} actions={actions} onAction={runAction} />\n * ```\n *\n * It resolves once the action has run, has been queued or has navigated, with `false` when the\n * user cancelled its parameters (a list then keeps its selection), and rejects when it failed.\n */\nexport function useActionRunner(\n    resource: string,\n): (target: ActionTarget) => Promise<ActionOutcome | false> {\n    const context = use(ActionRunnerContext);\n    if (context === null) {\n        throw new Error('useActionRunner() must be used inside <ActionRunnerProvider>.');\n    }\n    return (target) => context.run(resource, target);\n}\n\n/**\n * Asks the backend how many items of a query selection an action would skip, before the list\n * confirms it (a dry run, for actions with `dryRun`). It is the `previewAction` of a list:\n *\n * ```tsx\n * <ListView onAction={useActionRunner('pages')} previewAction={useActionPreview('pages')} … />\n * ```\n */\nexport function useActionPreview(\n    resource: string,\n): (target: ActionTarget) => Promise<ActionPreview | null> {\n    const context = use(ActionRunnerContext);\n    if (context === null) {\n        throw new Error('useActionPreview() must be used inside <ActionRunnerProvider>.');\n    }\n    return (target) => previewAction(context.adapter, resource, target);\n}\n\n/** The queued runs of the closest `ActionRunnerProvider`, to cancel or dismiss them. */\nexport function useActionRuns(): {\n    runs: readonly FollowedRun[];\n    cancel: (id: string) => Promise<void>;\n    dismiss: (id: string) => void;\n} {\n    const context = use(ActionRunnerContext);\n    if (context === null) {\n        throw new Error('useActionRuns() must be used inside <ActionRunnerProvider>.');\n    }\n    return { runs: context.runs, cancel: context.cancelRun, dismiss: context.dismissRun };\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAkBA,SAAgB,gBACZ,UACwD;CACxD,MAAM,UAAU,IAAI,mBAAmB;CACvC,IAAI,YAAY,MACZ,MAAM,IAAI,MAAM,+DAA+D;CAEnF,QAAQ,WAAW,QAAQ,IAAI,UAAU,MAAM;AACnD;;;;;;;;;AAUA,SAAgB,iBACZ,UACuD;CACvD,MAAM,UAAU,IAAI,mBAAmB;CACvC,IAAI,YAAY,MACZ,MAAM,IAAI,MAAM,gEAAgE;CAEpF,QAAQ,WAAW,cAAc,QAAQ,SAAS,UAAU,MAAM;AACtE;;AAGA,SAAgB,gBAId;CACE,MAAM,UAAU,IAAI,mBAAmB;CACvC,IAAI,YAAY,MACZ,MAAM,IAAI,MAAM,6DAA6D;CAEjF,OAAO;EAAE,MAAM,QAAQ;EAAM,QAAQ,QAAQ;EAAW,SAAS,QAAQ;CAAW;AACxF"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@panneau/actions",
-    "version": "5.0.0-alpha.1",
+    "version": "5.0.0-alpha.3",
     "description": "Runs the actions of lists and forms: parameters in a dialog, the action through a data adapter, its result, and queued runs.",
     "type": "module",
     "license": "MIT",
@@ -37,15 +37,15 @@
         "react-intl": "^12.0.0"
     },
     "dependencies": {
-        "@panneau/core": "5.0.0-alpha.1",
-        "@panneau/data": "5.0.0-alpha.1",
-        "@panneau/forms": "5.0.0-alpha.1",
-        "@panneau/intl": "5.0.0-alpha.1",
-        "@panneau/protocol": "5.0.0-alpha.1",
-        "@panneau/ui": "5.0.0-alpha.1",
+        "@panneau/core": "5.0.0-alpha.3",
+        "@panneau/data": "5.0.0-alpha.3",
+        "@panneau/forms": "5.0.0-alpha.3",
+        "@panneau/intl": "5.0.0-alpha.3",
+        "@panneau/protocol": "5.0.0-alpha.3",
+        "@panneau/ui": "5.0.0-alpha.3",
         "lucide-react": "^1.57.0"
     },
     "devDependencies": {
-        "@panneau/lists": "5.0.0-alpha.1"
+        "@panneau/lists": "5.0.0-alpha.3"
     }
 }