@antelopejs/interface-dms 0.5.11 → 0.5.12

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v0.5.12
+
+[compare changes](https://github.com/AntelopeJS/dms/compare/interface-v0.5.11...v0.5.12)
+
+### 🚀 Enhancements
+
+- **actions:** Let a button download a file with the user's session ([#246](https://github.com/AntelopeJS/dms/pull/246))
+
+### 🏡 Chore
+
+- **release:** @antelopejs/dms v0.7.16 ([05bb8bba](https://github.com/AntelopeJS/dms/commit/05bb8bba))
+
+### ❤️ Contributors
+
+- Antony Rizzitelli <rizzitelli.antony@pm.me>
+
 ## v0.5.11
 
 [compare changes](https://github.com/AntelopeJS/dms/compare/interface-v0.5.10...v0.5.11)

package/dist/base/types/action-target.d.ts

@@ -61,6 +61,27 @@ export interface SidePanelTargetOptions {
      */
     notFound?: SidePanelNotFoundTexts;
 }
+/**
+ * A `download` action target: the file is fetched with the user's session and
+ * saved, the page left as it is.
+ */
+export interface DownloadActionTarget {
+    type: "download";
+    /**
+     * The file to fetch, with the user's session: takes the same `{field}` and
+     * page URL tokens (`{{params.X}}`, `{{query.X}}`) as a `page` target, a
+     * query pair whose token the page has no value for being left out.
+     * @example "/api/lang/translations/export?workspace={{query.workspace}}&locale={{query.locale}}"
+     */
+    url: string;
+    /**
+     * The saved file's name, same tokens (written as they are, not encoded).
+     * Else, or while a token is left without a value, the server's
+     * `Content-Disposition` name, else the URL's last path segment.
+     * @example "{{query.locale}}.json"
+     */
+    filename?: string;
+}
 export type ActionTarget = {
     type: "drawer";
     component: Component;
@@ -103,7 +124,7 @@ export type ActionTarget = {
     /** Takes the same `{field}` and page URL tokens as a `page` target. */
     url: string;
     newTab?: boolean;
-} | {
+} | DownloadActionTarget | {
     type: "quickAction";
     /**
      * Key of the quick action to run: `category:id`, or the bare id when no
@@ -178,7 +199,7 @@ export type ActionTargetSerialized = {
     type: "external";
     url: string;
     newTab?: boolean;
-} | {
+} | DownloadActionTarget | {
     type: "quickAction";
     /**
      * Key of the quick action to run: `category:id`, or the bare id when no

package/dist/base/types/row-action.d.ts

@@ -127,8 +127,8 @@ export interface CustomRowAction<T extends Record<string, unknown> = Record<stri
     /**
      * Offers the action on the selection bar, for the selected rows: an `api`
      * or `exportJob` target receives their `ids` as a repeated query parameter
-     * (`?ids=a&ids=b`), a page or external URL too, a drawer or modal
-     * component a `selection` prop. With `{ allMatching: true }`, "Select all
+     * (`?ids=a&ids=b`), a page, external or download URL too, a drawer or
+     * modal component a `selection` prop. With `{ allMatching: true }`, "Select all
      * N matching" sends `allMatching=true` and the table's filters and search
      * instead. A fixed confirmation receives `{ count }`.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/interface-dms",
-  "version": "0.5.11",
+  "version": "0.5.12",
   "description": "Public AntelopeJS interfaces of the DMS: pages, components, permissions, tenancy, auth, notifications and HTML rendering.",
   "keywords": [
     "antelopejs",