@acorex-platform/framework-shared 0.0.1

package/core/src/lib/core/actions.types.d.ts

@@ -0,0 +1,724 @@
+import type { AXStyleColorType } from './shims.types';
+import { AXPSystemAction, AXPSystemActionType } from './core.types';
+export declare const AXPSystemActions: Readonly<{
+    readonly View: {
+        readonly key: AXPSystemActionType.View;
+        readonly title: string;
+        readonly icon: "fa-light fa-eye";
+        readonly color: "primary";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Create: {
+        readonly key: AXPSystemActionType.Create;
+        readonly title: string;
+        readonly icon: "fa-light fa-plus";
+        readonly color: "primary";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Edit: {
+        readonly key: AXPSystemActionType.Update;
+        readonly title: string;
+        readonly icon: "fa-light fa-pen";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Delete: {
+        readonly key: AXPSystemActionType.Delete;
+        readonly title: string;
+        readonly icon: "fa-light fa-trash";
+        readonly color: "danger";
+        readonly critical: true;
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Approve: {
+        readonly key: AXPSystemActionType.Approve;
+        readonly title: string;
+        readonly icon: "fa-light fa-circle-check";
+        readonly color: "success";
+        readonly critical: true;
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Submit: {
+        readonly key: AXPSystemActionType.Submit;
+        readonly title: string;
+        readonly icon: "fa-light fa-paper-plane";
+        readonly color: "primary";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Reject: {
+        readonly key: AXPSystemActionType.Reject;
+        readonly title: string;
+        readonly icon: "fa-light fa-ban";
+        readonly color: "danger";
+        readonly critical: true;
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Export: {
+        readonly key: AXPSystemActionType.Export;
+        readonly title: string;
+        readonly icon: "fa-light fa-download";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Import: {
+        readonly key: AXPSystemActionType.Import;
+        readonly title: string;
+        readonly icon: "fa-light fa-upload";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Print: {
+        readonly key: AXPSystemActionType.Print;
+        readonly title: string;
+        readonly icon: "fa-light fa-print";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Duplicate: {
+        readonly key: AXPSystemActionType.Duplicate;
+        readonly title: string;
+        readonly icon: "fa-light fa-clone";
+        readonly color: "warning";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Archive: {
+        readonly key: AXPSystemActionType.Archive;
+        readonly title: string;
+        readonly icon: "fa-light fa-box-archive";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Restore: {
+        readonly key: AXPSystemActionType.Restore;
+        readonly title: string;
+        readonly icon: "fa-light fa-arrow-rotate-left";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Assign: {
+        readonly key: AXPSystemActionType.Assign;
+        readonly title: string;
+        readonly icon: "fa-light fa-user-plus";
+        readonly color: "primary";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Lock: {
+        readonly key: AXPSystemActionType.Lock;
+        readonly title: string;
+        readonly icon: "fa-light fa-lock";
+        readonly color: "warning";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Unlock: {
+        readonly key: AXPSystemActionType.Unlock;
+        readonly title: string;
+        readonly icon: "fa-light fa-unlock";
+        readonly color: "success";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Share: {
+        readonly key: AXPSystemActionType.Share;
+        readonly title: string;
+        readonly icon: "fa-light fa-share-nodes";
+        readonly color: "info";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Configure: {
+        readonly key: AXPSystemActionType.Configure;
+        readonly title: string;
+        readonly icon: "fa-light fa-sliders";
+        readonly color: "primary";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Reorder: {
+        readonly key: AXPSystemActionType.Reorder;
+        readonly title: string;
+        readonly icon: "fa-light fa-arrow-down-up-across-line";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Preview: {
+        readonly key: AXPSystemActionType.Preview;
+        readonly title: string;
+        readonly icon: "fa-light fa-magnifying-glass";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Publish: {
+        readonly key: AXPSystemActionType.Publish;
+        readonly title: string;
+        readonly icon: "fa-light fa-globe";
+        readonly color: "success";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Unpublish: {
+        readonly key: AXPSystemActionType.Unpublish;
+        readonly title: string;
+        readonly icon: "fa-light fa-globe-slash";
+        readonly color: "danger";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Upload: {
+        readonly key: AXPSystemActionType.Upload;
+        readonly title: string;
+        readonly icon: "fa-light fa-upload";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Download: {
+        readonly key: AXPSystemActionType.Download;
+        readonly title: string;
+        readonly icon: "fa-light fa-download";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Copy: {
+        readonly key: AXPSystemActionType.Copy;
+        readonly title: string;
+        readonly icon: "fa-light fa-copy";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Move: {
+        readonly key: AXPSystemActionType.Move;
+        readonly title: string;
+        readonly icon: "fa-light fa-arrow-right-arrow-left";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Rename: {
+        readonly key: AXPSystemActionType.Rename;
+        readonly title: string;
+        readonly icon: "fa-light fa-pen";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Manage: {
+        readonly key: AXPSystemActionType.Manage;
+        readonly title: string;
+        readonly icon: "fa-light fa-gear";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Info: {
+        readonly key: AXPSystemActionType.Info;
+        readonly title: string;
+        readonly icon: "fa-light fa-info";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Confirm: {
+        readonly key: AXPSystemActionType.Confirm;
+        readonly title: string;
+        readonly icon: "fa-light fa-check";
+        readonly color: "success";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Design: {
+        readonly key: AXPSystemActionType.Design;
+        readonly title: string;
+        readonly icon: "fa-light fa-paintbrush";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly VersionHistory: {
+        readonly key: AXPSystemActionType.VersionHistory;
+        readonly title: string;
+        readonly icon: "fa-light fa-history";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Compare: {
+        readonly key: AXPSystemActionType.Compare;
+        readonly title: string;
+        readonly icon: "fa-light fa-code-compare";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Comments: {
+        readonly key: AXPSystemActionType.Comments;
+        readonly title: string;
+        readonly icon: "fa-light fa-comments";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Sign: {
+        readonly key: AXPSystemActionType.Sign;
+        readonly title: string;
+        readonly icon: "fa-light fa-signature";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Setup: {
+        readonly key: AXPSystemActionType.Setup;
+        readonly title: string;
+        readonly icon: "fa-light fa-cog";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Send: {
+        readonly key: AXPSystemActionType.Send;
+        readonly title: string;
+        readonly icon: "fa-light fa-envelope";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Report: {
+        readonly key: AXPSystemActionType.Report;
+        readonly title: string;
+        readonly icon: "fa-light fa-chart-line";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Sent: {
+        readonly key: AXPSystemActionType.Sent;
+        readonly title: string;
+        readonly icon: "fa-light fa-paper-plane";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Review: {
+        readonly key: AXPSystemActionType.Review;
+        readonly title: string;
+        readonly icon: "fa-light fa-eye";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Generate: {
+        readonly key: AXPSystemActionType.Generate;
+        readonly title: string;
+        readonly icon: "fa-light fa-wand-magic-sparkles";
+        readonly color: "primary";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Refresh: {
+        readonly key: AXPSystemActionType.Refresh;
+        readonly title: string;
+        readonly icon: "fa-light fa-arrows-rotate";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Reload: {
+        readonly key: AXPSystemActionType.Reload;
+        readonly title: string;
+        readonly icon: "fa-light fa-arrows-rotate";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Search: {
+        readonly key: AXPSystemActionType.Search;
+        readonly title: string;
+        readonly icon: "fa-light fa-magnifying-glass";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Filter: {
+        readonly key: AXPSystemActionType.Filter;
+        readonly title: string;
+        readonly icon: "fa-light fa-filter";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Sort: {
+        readonly key: AXPSystemActionType.Sort;
+        readonly title: string;
+        readonly icon: "fa-light fa-arrow-down-up-across-line";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Start: {
+        readonly key: AXPSystemActionType.Start;
+        readonly title: string;
+        readonly icon: "fa-light fa-play";
+        readonly color: "success";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Stop: {
+        readonly key: AXPSystemActionType.Stop;
+        readonly title: string;
+        readonly icon: "fa-light fa-stop";
+        readonly color: "danger";
+        readonly critical: true;
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Pause: {
+        readonly key: AXPSystemActionType.Pause;
+        readonly title: string;
+        readonly icon: "fa-light fa-pause";
+        readonly color: "warning";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Cancel: {
+        readonly key: AXPSystemActionType.Cancel;
+        readonly title: string;
+        readonly icon: "fa-light fa-xmark";
+        readonly critical: true;
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Close: {
+        readonly key: AXPSystemActionType.Close;
+        readonly title: string;
+        readonly icon: "fa-light fa-xmark";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Complete: {
+        readonly key: AXPSystemActionType.Complete;
+        readonly title: string;
+        readonly icon: "fa-light fa-check";
+        readonly color: "success";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Save: {
+        readonly key: AXPSystemActionType.Save;
+        readonly title: string;
+        readonly icon: "fa-light fa-floppy-disk";
+        readonly color: "primary";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly SaveAs: {
+        readonly key: AXPSystemActionType.SaveAs;
+        readonly title: string;
+        readonly icon: "fa-light fa-floppy-disk";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Sync: {
+        readonly key: AXPSystemActionType.Sync;
+        readonly title: string;
+        readonly icon: "fa-light fa-arrows-rotate";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Reset: {
+        readonly key: AXPSystemActionType.Reset;
+        readonly title: string;
+        readonly icon: "fa-light fa-arrow-rotate-left";
+        readonly color: "warning";
+        readonly critical: true;
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Clear: {
+        readonly key: AXPSystemActionType.Clear;
+        readonly title: string;
+        readonly icon: "fa-light fa-eraser";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+    readonly Distribution: {
+        readonly key: AXPSystemActionType.Distribution;
+        readonly title: string;
+        readonly icon: "fa-light fa-share-nodes";
+        readonly color: "default";
+        readonly descriptions: {
+            readonly title: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
+}>;
+export declare function getSystemActions(type: AXPSystemActionType): AXPSystemAction;
+/**
+ * Resolves the visual appearance (color and icon) for entity actions.
+ */
+export declare function resolveActionLook(actionType: string): {
+    color: AXStyleColorType;
+    icon: string;
+};
+/**
+ * Resolves the title, description, icon and color for button actions.
+ */
+export declare function getActionButton(actionType: string): {
+    name: string;
+    title: string;
+    description: string;
+    icon: string;
+    color: string;
+};
+//# sourceMappingURL=actions.types.d.ts.map