feat: add custom property to Action

Author: wojtek-krysiak

src/backend/actions/action.interface.ts

@@ -624,12 +624,21 @@ export interface Action <T extends ActionResponse> {
 
   /**
    * Defines the variant of the action. based on that it will receive given color.
+   * @new in version v3.3
    */
   variant?: VariantType;
 
   /**
    * Action can be nested. If you give here another action name - it will be nested under it.
    * If parent action doesn't exists - it will be nested under name in the parent.
+   * @deprecated in version v3.3
    */
   parent?: string;
+
+  /**
+   * Any custom properties you want to pass down to {@link ActionJSON}. They have to
+   * be stringified.
+   * @new in version v3.3
+   */
+  custom?: Record<string, any>;
 }

src/backend/decorators/action/action-decorator.ts

@@ -318,6 +318,10 @@ class ActionDecorator {
     return this.action.parent || null
   }
 
+  custom(): Record<string, any> {
+    return this.action.custom || {}
+  }
+
   hasHandler(): boolean {
     return !!this.action.handler
   }
@@ -347,6 +351,7 @@ class ActionDecorator {
       variant: this.variant(),
       parent: this.parent(),
       hasHandler: this.hasHandler(),
+      custom: this.custom(),
     }
   }
 }

src/frontend/components/spec/action-json.factory.ts

@@ -14,4 +14,5 @@ factory.define<ActionJSON>('ActionJSON', Object, {
   variant: 'default',
   parent: null,
   hasHandler: true,
+  custom: {},
 })

src/frontend/interfaces/action/action-json.interface.ts

@@ -75,4 +75,10 @@ export interface ActionJSON {
    * @new in version 3.3
    */
   hasHandler: boolean;
+
+  /**
+   * Any custom options passed from the {@link Action} configuration.
+   * @new in version 3.3
+   */
+  custom: Record<string, any>;
 }