@acorex/platform 20.3.0-next.6 → 20.3.0-next.8

package/core/index.d.ts

@@ -79,6 +79,98 @@ type AXPValueTransformerFunctions = {
 };
 declare function objectKeyValueTransforms(keyName: string): AXPValueTransformerFunctions;
 
+/**
+ * Additional suggested generic actions for future consideration:
+ *
+ * Data & Content Actions:
+ * - Search = 'search' - Search functionality
+ * - Filter = 'filter' - Apply filters
+ * - Sort = 'sort' - Sort data
+ * - Group = 'group' - Group data
+ * - Expand = 'expand' - Expand details
+ * - Collapse = 'collapse' - Collapse details
+ * - Pin = 'pin' - Pin to favorites
+ * - Bookmark = 'bookmark' - Bookmark item
+ * - Favorite = 'favorite' - Mark as favorite
+ * - Star = 'star' - Star rating
+ *
+ * Workflow Actions:
+ * - Start = 'start' - Start process/workflow
+ * - Stop = 'stop' - Stop process
+ * - Pause = 'pause' - Pause process
+ * - Resume = 'resume' - Resume process
+ * - Cancel = 'cancel' - Cancel operation
+ * - Complete = 'complete' - Mark as complete
+ * - Close = 'close' - Close item
+ * - Reopen = 'reopen' - Reopen closed item
+ * - Forward = 'forward' - Forward to next step
+ * - Back = 'back' - Go back
+ *
+ * Communication Actions:
+ * - Reply = 'reply' - Reply to message
+ * - Forward = 'forward' - Forward message
+ * - Notify = 'notify' - Send notification
+ * - Invite = 'invite' - Invite user
+ * - Join = 'join' - Join group/meeting
+ * - Leave = 'leave' - Leave group/meeting
+ *
+ * Security Actions:
+ * - Login = 'login' - User login
+ * - Logout = 'logout' - User logout
+ * - Block = 'block' - Block user/content
+ * - Unblock = 'unblock' - Unblock user/content
+ * - Ban = 'ban' - Ban user
+ * - Unban = 'unban' - Unban user
+ * - Verify = 'verify' - Verify identity
+ * - Authenticate = 'authenticate' - Authenticate
+ *
+ * File & Media Actions:
+ * - Open = 'open' - Open file
+ * - Save = 'save' - Save file
+ * - SaveAs = 'save-as' - Save as new file
+ * - Attach = 'attach' - Attach file
+ * - Detach = 'detach' - Detach file
+ * - Compress = 'compress' - Compress files
+ * - Extract = 'extract' - Extract archive
+ * - Convert = 'convert' - Convert format
+ * - Crop = 'crop' - Crop image
+ * - Resize = 'resize' - Resize image
+ *
+ * System Actions:
+ * - Sync = 'sync' - Synchronize data
+ * - Backup = 'backup' - Create backup
+ * - Restore = 'restore' - Restore from backup
+ * - Reset = 'reset' - Reset to defaults
+ * - Clear = 'clear' - Clear data
+ * - Optimize = 'optimize' - Optimize performance
+ * - Update = 'update' - Update system
+ * - Install = 'install' - Install component
+ * - Uninstall = 'uninstall' - Uninstall component
+ * - Enable = 'enable' - Enable feature
+ * - Disable = 'disable' - Disable feature
+ *
+ * Analytics & Monitoring:
+ * - Monitor = 'monitor' - Monitor activity
+ * - Track = 'track' - Track progress
+ * - Analyze = 'analyze' - Analyze data
+ * - Debug = 'debug' - Debug issue
+ * - Log = 'log' - View logs
+ * - Alert = 'alert' - Set alert
+ * - Dashboard = 'dashboard' - View dashboard
+ * - Metrics = 'metrics' - View metrics
+ *
+ * Collaboration Actions:
+ * - Collaborate = 'collaborate' - Start collaboration
+ * - Share = 'share' - Share content
+ * - Comment = 'comment' - Add comment
+ * - Like = 'like' - Like content
+ * - Follow = 'follow' - Follow user/content
+ * - Subscribe = 'subscribe' - Subscribe to updates
+ * - Unsubscribe = 'unsubscribe' - Unsubscribe
+ * - Rate = 'rate' - Rate content
+ * - Review = 'review' - Review content
+ * - Recommend = 'recommend' - Recommend content
+ */
 declare enum AXPSystemActionType {
     View = "view",
     Create = "create",
@@ -119,7 +211,24 @@ declare enum AXPSystemActionType {
     Send = "send",
     Report = "report",
     Sent = "sent",
-    Review = "review"
+    Review = "review",
+    Generate = "generate",
+    Refresh = "refresh",
+    Reload = "reload",
+    Search = "search",
+    Filter = "filter",
+    Sort = "sort",
+    Start = "start",
+    Stop = "stop",
+    Pause = "pause",
+    Cancel = "cancel",
+    Close = "close",
+    Complete = "complete",
+    Save = "save",
+    SaveAs = "save-as",
+    Sync = "sync",
+    Reset = "reset",
+    Clear = "clear"
 }
 interface AXPSystemAction {
     key: string;
@@ -618,6 +727,213 @@ declare const AXPSystemActions: Readonly<{
             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 button: 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 button: 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 button: 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 button: 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 button: 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 button: 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 button: 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 button: 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 button: 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 color: "danger";
+        readonly critical: true;
+        readonly descriptions: {
+            readonly button: 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 button: 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 button: 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 button: 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 button: 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 button: 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 button: 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 button: string;
+            readonly tooltip: string;
+            readonly permission: string;
+            readonly audit: string;
+        };
+    };
 }>;
 declare function getSystemActions(type: AXPSystemActionType): AXPSystemAction;
 /**
@@ -628,6 +944,19 @@ declare function resolveActionLook(actionType: string): {
     color: AXStyleColorType;
     icon: string;
 };
+/**
+ * Resolves the title, description, icon and color for button actions
+ * using the system actions from the core module.
+ * @param actionType
+ * @returns
+ */
+declare function getActionButton(actionType: string): {
+    name: string;
+    title: string;
+    description: string;
+    icon: string;
+    color: string;
+};
 
 interface AXPColumnQuery {
     name: string;
@@ -1409,5 +1738,5 @@ declare class AXPHookService {
     static ɵprov: i0.ɵɵInjectableDeclaration<AXPHookService>;
 }
 
-export { AXHighlightService, AXPActivityLogProvider, AXPActivityLogService, AXPAppStartUpProvider, AXPAppStartUpService, AXPBroadcastEventService, AXPComponentLogoConfig, AXPContentCheckerDirective, AXPContextChangeEvent, AXPContextStore, AXPCountdownPipe, AXPDataGenerator, AXPDataSourceDefinitionProviderService, AXPDblClickDirective, AXPDistributedEventListenerService, AXPElementDataDirective, AXPExportTemplateToken, AXPExpressionEvaluatorScopeProviderContext, AXPExpressionEvaluatorScopeProviderService, AXPExpressionEvaluatorService, AXPGridLayoutDirective, AXPHookService, AXPImageUrlLogoConfig, AXPPlatformScope, AXPSystemActionType, AXPSystemActions, AXP_ACTIVITY_LOG_PROVIDER, AXP_DATASOURCE_DEFINITION_PROVIDER, AXP_DISTRIBUTED_EVENT_LISTENER_PROVIDER, AXP_EXPRESSION_EVALUATOR_SCOPE_PROVIDER, applyFilterArray, applyPagination, applyQueryArray, applySortArray, applySystemActionDefault, cleanDeep, extractNestedFieldsWildcard, extractTextFromHtml, extractValue, getChangedPaths, getDetailedChanges, getEnumValues, getNestedKeys, getSmart, getSystemActions, objectKeyValueTransforms, resolveActionLook, resolvePlatformScopeKey, resolvePlatformScopeName, setSmart };
+export { AXHighlightService, AXPActivityLogProvider, AXPActivityLogService, AXPAppStartUpProvider, AXPAppStartUpService, AXPBroadcastEventService, AXPComponentLogoConfig, AXPContentCheckerDirective, AXPContextChangeEvent, AXPContextStore, AXPCountdownPipe, AXPDataGenerator, AXPDataSourceDefinitionProviderService, AXPDblClickDirective, AXPDistributedEventListenerService, AXPElementDataDirective, AXPExportTemplateToken, AXPExpressionEvaluatorScopeProviderContext, AXPExpressionEvaluatorScopeProviderService, AXPExpressionEvaluatorService, AXPGridLayoutDirective, AXPHookService, AXPImageUrlLogoConfig, AXPPlatformScope, AXPSystemActionType, AXPSystemActions, AXP_ACTIVITY_LOG_PROVIDER, AXP_DATASOURCE_DEFINITION_PROVIDER, AXP_DISTRIBUTED_EVENT_LISTENER_PROVIDER, AXP_EXPRESSION_EVALUATOR_SCOPE_PROVIDER, applyFilterArray, applyPagination, applyQueryArray, applySortArray, applySystemActionDefault, cleanDeep, extractNestedFieldsWildcard, extractTextFromHtml, extractValue, getActionButton, getChangedPaths, getDetailedChanges, getEnumValues, getNestedKeys, getSmart, getSystemActions, objectKeyValueTransforms, resolveActionLook, resolvePlatformScopeKey, resolvePlatformScopeName, setSmart };
 export type { AXPActionMenuItem, AXPActivityLog, AXPActivityLogChange, AXPApplicationUserReference, AXPBackButton, AXPBadge, AXPBreadcrumbItem, AXPCategorizedEntity, AXPCategorizedEntityDto, AXPCategoryEntity, AXPCategoryEntityWithItems, AXPColumnQuery, AXPContent, AXPContentDirection, AXPContentType, AXPContextData, AXPContextState, AXPDataSource, AXPDataSourceDataFieldDefinition, AXPDataSourceDefinition, AXPDataSourceDefinitionProvider, AXPDataType, AXPDistributedEventListenerProvider, AXPDistributedEventListenerProviderToken, AXPEntityReference, AXPEqualValidationRule, AXPExecuteCommand, AXPExecuteCommandResult, AXPExportCsvOptions, AXPExportExcelOptions, AXPExportOptions, AXPExportPdfOptions, AXPExportPrintOptions, AXPExpression, AXPExpressionEvaluatorScope, AXPExpressionEvaluatorScopeProvider, AXPExpressionEvaluatorScopeProviders, AXPFileListItem, AXPFileSource, AXPFileStatus, AXPFilterDefinition, AXPFilterLogic, AXPFilterOperation, AXPFilterQuery, AXPFlowDirection, AXPGridLayoutOptions, AXPGridPlacement, AXPLogoConfig, AXPMaxLengthValidationRule, AXPMetaData, AXPMinLengthValidationRule, AXPNavigateActionCommand, AXPNavigateActionOptions, AXPOptionsData, AXPPagedListResult, AXPPartialNested, AXPPlatformScopeKey, AXPQueryFetchResult, AXPQueryRequest, AXPReqexValidationRule, AXPRequiredValidationRule, AXPSortDefinition, AXPSortQuery, AXPStartUpTask, AXPStringValidationRules, AXPSystemAction, AXPUserReference, AXPValidationRule, AXPValidationRules, AXPValueTransformerFunction, AXPValueTransformerFunctions, AXPValueUnit, AXPValueUnits, AXPViewBlockDefinition, AXPViewDefinition, AXPViewFieldDefinition, AXPViewQuery, AXPWidgetTrigger, AXPWidgetTriggers };