@panneau/actions 4.1.1 → 5.0.0-alpha.1

package/dist/types.d.ts

@@ -0,0 +1,62 @@
+import type { ComponentType } from 'react';
+import type { DataAdapter } from '@panneau/data';
+import type { Action, ActionResult, ActionRun, ActionScope, RouteReference, Selection } from '@panneau/protocol';
+/**
+ * What the runner needs from a backend: the action methods of a `DataAdapter`. A product with its
+ * own API implements these, and nothing else. Without `cancelActionRun()`, runs can't be cancelled.
+ */
+export type ActionAdapter = Pick<DataAdapter, 'runAction' | 'getActionRun'> & Partial<Pick<DataAdapter, 'cancelActionRun'>>;
+/**
+ * An action to run, and what it applies to. A list's `ListActionEvent` is one, and so is
+ * `{ action, scope: 'item', item }` for the item of a form.
+ */
+export interface ActionTarget {
+    action: Action;
+    scope: ActionScope;
+    /** The item of an `item` action. */
+    item?: {
+        id: string;
+        [key: string]: unknown;
+    };
+    /** The selection of a `selection` action: ids, or every item matching a query. */
+    selection?: Selection;
+    /** How many items the action applies to. */
+    count?: number;
+}
+/** What running an action gave. A run that the user cancelled gives `false` instead. */
+export type ActionOutcome = {
+    status: 'done';
+    result: ActionResult;
+} | {
+    status: 'queued';
+    run: ActionRun;
+} | {
+    status: 'navigated';
+    to: string | RouteReference;
+};
+/** The download of an action result. */
+export type ActionDownload = NonNullable<ActionResult['download']>;
+/** Where a result was given: the resource and the action's target. */
+export interface ActionResultContext {
+    resource: string;
+    target: ActionTarget;
+}
+/** A queued run that the runner follows, until it is dismissed. */
+export interface FollowedRun {
+    run: ActionRun;
+    resource: string;
+    target: ActionTarget;
+}
+/** Props of the handler of a `client` action, which a plugin registers by the action's `component`. */
+export interface ClientActionProps {
+    action: Action;
+    resource: string;
+    target: ActionTarget;
+    /** Ends the action. With a result, the runner shows it as it shows the result of a server action. */
+    onDone: (result?: ActionResult) => void;
+    /** Ends the action without running it: a list keeps its selection. */
+    onCancel: () => void;
+}
+/** A handler of `client` actions. */
+export type ClientActionHandler = ComponentType<ClientActionProps>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EACR,MAAM,EACN,YAAY,EACZ,SAAS,EACT,WAAW,EACX,cAAc,EACd,SAAS,EACZ,MAAM,mBAAmB,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAAC,GACvE,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,WAAW,CAAC;IACnB,oCAAoC;IACpC,IAAI,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAC9C,kFAAkF;IAClF,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,wFAAwF;AACxF,MAAM,MAAM,aAAa,GACnB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,YAAY,CAAA;CAAE,GACxC;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,GAAG,EAAE,SAAS,CAAA;CAAE,GACpC;IAAE,MAAM,EAAE,WAAW,CAAC;IAAC,EAAE,EAAE,MAAM,GAAG,cAAc,CAAA;CAAE,CAAC;AAE3D,wCAAwC;AACxC,MAAM,MAAM,cAAc,GAAG,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC;AAEnE,sEAAsE;AACtE,MAAM,WAAW,mBAAmB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;CACxB;AAED,mEAAmE;AACnE,MAAM,WAAW,WAAW;IACxB,GAAG,EAAE,SAAS,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;CACxB;AAED,uGAAuG;AACvG,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,qGAAqG;IACrG,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;IACxC,sEAAsE;IACtE,QAAQ,EAAE,MAAM,IAAI,CAAC;CACxB;AAED,qCAAqC;AACrC,MAAM,MAAM,mBAAmB,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC"}

package/dist/useActionRunner.d.ts

@@ -0,0 +1,21 @@
+import type { ActionOutcome, ActionTarget, FollowedRun } from './types';
+/**
+ * Runs the actions of a resource through the closest `ActionRunnerProvider`. The function takes a
+ * list's `ListActionEvent`, so it is the `onAction` of a list:
+ *
+ * ```tsx
+ * const runAction = useActionRunner('pages');
+ * <ListView list={list} items={items} actions={actions} onAction={runAction} />
+ * ```
+ *
+ * It resolves once the action has run, has been queued or has navigated, with `false` when the
+ * 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>;
+/** The queued runs of the closest `ActionRunnerProvider`, to cancel or dismiss them. */
+export declare function useActionRuns(): {
+    runs: readonly FollowedRun[];
+    cancel: (id: string) => Promise<void>;
+    dismiss: (id: string) => void;
+};
+//# sourceMappingURL=useActionRunner.d.ts.map

package/dist/useActionRunner.d.ts.map

@@ -0,0 +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"}

package/dist/useActionRunner.js

@@ -0,0 +1,34 @@
+import { ActionRunnerContext } from "./context.js";
+import { use } from "react";
+//#region src/useActionRunner.ts
+/**
+* Runs the actions of a resource through the closest `ActionRunnerProvider`. The function takes a
+* list's `ListActionEvent`, so it is the `onAction` of a list:
+*
+* ```tsx
+* const runAction = useActionRunner('pages');
+* <ListView list={list} items={items} actions={actions} onAction={runAction} />
+* ```
+*
+* It resolves once the action has run, has been queued or has navigated, with `false` when the
+* user cancelled its parameters (a list then keeps its selection), and rejects when it failed.
+*/
+function useActionRunner(resource) {
+	const context = use(ActionRunnerContext);
+	if (context === null) throw new Error("useActionRunner() must be used inside <ActionRunnerProvider>.");
+	return (target) => context.run(resource, target);
+}
+/** The queued runs of the closest `ActionRunnerProvider`, to cancel or dismiss them. */
+function useActionRuns() {
+	const context = use(ActionRunnerContext);
+	if (context === null) throw new Error("useActionRuns() must be used inside <ActionRunnerProvider>.");
+	return {
+		runs: context.runs,
+		cancel: context.cancelRun,
+		dismiss: context.dismissRun
+	};
+}
+//#endregion
+export { useActionRunner, useActionRuns };
+
+//# sourceMappingURL=useActionRunner.js.map

package/dist/useActionRunner.js.map

@@ -0,0 +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"}

package/package.json

@@ -1,72 +1,51 @@
 {
     "name": "@panneau/actions",
-    "version": "4.1.1",
-    "description": "",
-    "keywords": [
-        "javascript"
-    ],
-    "homepage": "https://github.com/folkloreinc/panneau-js",
+    "version": "5.0.0-alpha.1",
+    "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",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/folkloreinc/panneau-js.git"
-    },
-    "license": "ISC",
-    "author": {
-        "name": "Folklore",
-        "email": "info@folklore.email"
+        "url": "git+https://github.com/folkloreinc/panneau-js.git",
+        "directory": "packages/actions"
     },
-    "contributors": [
-        {
-            "name": "David Mongeau-Petitpas",
-            "email": "dmp@folklore.email"
-        },
-        {
-            "name": "Nicolas Roy-Bourdages",
-            "email": "nrb@folklore.email"
-        }
-    ],
     "sideEffects": [
-        "**/*.css"
+        "*.css"
     ],
-    "type": "module",
     "exports": {
         ".": {
+            "@panneau/source": "./src/index.ts",
             "types": "./dist/index.d.ts",
             "default": "./dist/index.js"
-        }
+        },
+        "./package.json": "./package.json"
     },
-    "module": "dist/index.js",
-    "types": "dist/index.d.ts",
     "files": [
-        "dist",
-        "assets"
+        "dist"
     ],
     "scripts": {
-        "build": "../../scripts/prepare-package.sh --types",
-        "css": "../../scripts/build-packages-styles.js --pattern='@panneau/action-*' ./src/styles.css.ejs ./assets/css/styles.css",
-        "prepublishOnly": "npm run build"
-    },
-    "dependencies": {
-        "@babel/runtime": "^7.28.6",
-        "@panneau/action-delete": "^4.1.1",
-        "@panneau/action-duplicate": "^4.1.1",
-        "@panneau/action-edit": "^4.1.1",
-        "@panneau/action-import": "^4.1.1",
-        "@panneau/action-restore": "^4.1.1",
-        "@panneau/action-show": "^4.1.1",
-        "@panneau/action-upload": "^4.1.1",
-        "@panneau/core": "^4.1.1"
+        "build": "vite build && tsc -p tsconfig.build.json",
+        "typecheck": "tsc --noEmit",
+        "api": "tsc -p tsconfig.build.json && node ../../scripts/api-report.js"
     },
-    "devDependencies": {
-        "react": "^19.2.0",
-        "react-dom": "^19.0.0"
+    "publishConfig": {
+        "access": "public"
     },
     "peerDependencies": {
         "react": "^19.2.0",
-        "react-dom": "^19.0.0"
+        "react-aria-components": "^1.22.0",
+        "react-intl": "^12.0.0"
     },
-    "publishConfig": {
-        "access": "public"
+    "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",
+        "lucide-react": "^1.57.0"
     },
-    "gitHead": "28b394278cffa0c927989873dd4b3f184635ceff"
+    "devDependencies": {
+        "@panneau/lists": "5.0.0-alpha.1"
+    }
 }