@sap/ux-ui5-tooling 1.20.3 → 1.21.0

package/dist/preview-middleware/dist/client/adp/quick-actions/load.js

@@ -0,0 +1,46 @@
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  function __ui5_require_async(path) {
+    return new Promise(function (resolve, reject) {
+      sap.ui.require([path], function (module) {
+        if (!(module && module.__esModule)) {
+          module = module === null || !(typeof module === "object" && path.endsWith("/library")) ? {
+            default: module
+          } : module;
+          Object.defineProperty(module, "__esModule", {
+            value: true
+          });
+        }
+        resolve(module);
+      }, function (err) {
+        reject(err);
+      });
+    });
+  }
+  /**
+   * Loads the appropriate Quick Action registries for the given application type.
+   *
+   * @param appType - Application type.
+   * @returns Quick Action registries.
+   */
+  async function loadDefinitions(appType) {
+    if (appType === 'fe-v2') {
+      const FEV2QuickActionRegistry = (await __ui5_require_async('open/ux/preview/client/adp/quick-actions/fe-v2/registry')).default;
+      return [new FEV2QuickActionRegistry()];
+    }
+    if (appType === 'fe-v4') {
+      const FEV4QuickActionRegistry = (await __ui5_require_async('open/ux/preview/client/adp/quick-actions/fe-v4/registry')).default;
+      return [new FEV4QuickActionRegistry()];
+    }
+    return [];
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.loadDefinitions = loadDefinitions;
+  return __exports;
+});
+//# sourceMappingURL=load.js.map

package/dist/preview-middleware/dist/client/adp/quick-actions/load.ts

@@ -0,0 +1,23 @@
+import type { QuickActionDefinitionRegistry } from '../../cpe/quick-actions/registry';
+import type { ApplicationType } from '../../utils/application';
+
+/**
+ * Loads the appropriate Quick Action registries for the given application type.
+ *
+ * @param appType - Application type.
+ * @returns Quick Action registries.
+ */
+export async function loadDefinitions(appType: ApplicationType): Promise<QuickActionDefinitionRegistry<string>[]> {
+    if (appType === 'fe-v2') {
+        const FEV2QuickActionRegistry = (await import('open/ux/preview/client/adp/quick-actions/fe-v2/registry'))
+            .default;
+
+        return [new FEV2QuickActionRegistry()];
+    }
+    if (appType === 'fe-v4') {
+        const FEV4QuickActionRegistry = (await import('open/ux/preview/client/adp/quick-actions/fe-v4/registry'))
+            .default;
+        return [new FEV4QuickActionRegistry()];
+    }
+    return [];
+}

package/dist/preview-middleware/dist/client/adp/quick-actions/quick-action-base.js

@@ -0,0 +1,64 @@
+"use strict";
+
+sap.ui.define(["./dialog-enablement-validator"], function (___dialog_enablement_validator) {
+  "use strict";
+
+  const DIALOG_ENABLEMENT_VALIDATOR = ___dialog_enablement_validator["DIALOG_ENABLEMENT_VALIDATOR"];
+  /**
+   * Base class for all  quick actions.
+   */
+  class QuickActionDefinitionBase {
+    get id() {
+      return `${this.context.key}-${this.type}`;
+    }
+    getTelemetryIdentifier(update = false) {
+      if (update === true) {
+        this.telemetryIdentifier = new Date().toISOString();
+      }
+      return this.telemetryIdentifier;
+    }
+    get quickActionSteps() {
+      return this.enablementValidators.find(item => item === DIALOG_ENABLEMENT_VALIDATOR) ? 2 : 1;
+    }
+
+    /**
+     * Quick Actions tooltip.
+     */
+    get tooltip() {
+      if (this.validationResult) {
+        const validationErrors = this.validationResult.filter(result => result?.type === 'error');
+        if (validationErrors.length > 0) {
+          const error = validationErrors[0];
+          return error.message;
+        }
+      }
+      return undefined;
+    }
+    get isDisabled() {
+      if (this.validationResult === undefined) {
+        return false;
+      }
+      const validationErrors = this.validationResult.filter(result => result?.type === 'error');
+      return validationErrors.length > 0;
+    }
+    get textKey() {
+      return this.defaultTextKey;
+    }
+    constructor(type, kind, defaultTextKey, context, enablementValidators = []) {
+      this.type = type;
+      this.kind = kind;
+      this.defaultTextKey = defaultTextKey;
+      this.context = context;
+      this.enablementValidators = enablementValidators;
+    }
+    async runEnablementValidators() {
+      this.validationResult = await Promise.all(this.enablementValidators.map(async validator => await validator.run()));
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.QuickActionDefinitionBase = QuickActionDefinitionBase;
+  return __exports;
+});
+//# sourceMappingURL=quick-action-base.js.map

package/dist/preview-middleware/dist/client/adp/quick-actions/quick-action-base.ts

@@ -0,0 +1,71 @@
+import type { QuickActionContext } from '../../cpe/quick-actions/quick-action-definition';
+
+import { EnablementValidator, EnablementValidatorError, EnablementValidatorResult } from './enablement-validator';
+import { DIALOG_ENABLEMENT_VALIDATOR } from './dialog-enablement-validator';
+
+/**
+ * Base class for all  quick actions.
+ */
+export abstract class QuickActionDefinitionBase<T extends string> {
+    private telemetryIdentifier: string;
+
+    public get id(): string {
+        return `${this.context.key}-${this.type}`;
+    }
+
+    public getTelemetryIdentifier(update = false) {
+        if (update === true) {
+            this.telemetryIdentifier = new Date().toISOString();
+        }
+        return this.telemetryIdentifier;
+    }
+
+    public get quickActionSteps(): number {
+        return this.enablementValidators.find((item) => item === DIALOG_ENABLEMENT_VALIDATOR) 
+            ? 2
+            : 1;
+    }
+    
+    /**
+     * Quick Actions tooltip.
+     */
+    public get tooltip(): string | undefined {
+        if (this.validationResult) {
+            const validationErrors = this.validationResult.filter(
+                (result): result is EnablementValidatorError => result?.type === 'error'
+            );
+            if (validationErrors.length > 0) {
+                const error = validationErrors[0];
+                return error.message;
+            }
+        }
+        return undefined;
+    }
+
+    protected validationResult: EnablementValidatorResult[] | undefined;
+    protected get isDisabled(): boolean {
+        if (this.validationResult === undefined) {
+            return false;
+        }
+        const validationErrors = this.validationResult.filter((result) => result?.type === 'error');
+        return validationErrors.length > 0;
+    }
+
+    protected get textKey(): string {
+        return this.defaultTextKey;
+    }
+
+    constructor(
+        public readonly type: string,
+        public readonly kind: T,
+        protected readonly defaultTextKey: string,
+        protected readonly context: QuickActionContext,
+        protected readonly enablementValidators: EnablementValidator[] = []
+    ) {}
+
+    async runEnablementValidators(): Promise<void> {
+        this.validationResult = await Promise.all(
+            this.enablementValidators.map(async (validator) => await validator.run())
+        );
+    }
+}

package/dist/preview-middleware/dist/client/adp/quick-actions/simple-quick-action-base.js

@@ -0,0 +1,44 @@
+"use strict";
+
+sap.ui.define(["open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../../cpe/quick-actions/utils", "./quick-action-base"], function (___sap_ux_private_control_property_editor_common, ____cpe_quick_actions_utils, ___quick_action_base) {
+  "use strict";
+
+  const SIMPLE_QUICK_ACTION_KIND = ___sap_ux_private_control_property_editor_common["SIMPLE_QUICK_ACTION_KIND"];
+  const getRelevantControlFromActivePage = ____cpe_quick_actions_utils["getRelevantControlFromActivePage"];
+  const QuickActionDefinitionBase = ___quick_action_base["QuickActionDefinitionBase"];
+  /**
+   * Base class for all simple quick actions.
+   */
+  class SimpleQuickActionDefinitionBase extends QuickActionDefinitionBase {
+    get isApplicable() {
+      return this.control !== undefined;
+    }
+    constructor(type, controlTypes, defaultTextKey, context, enablementValidators = []) {
+      super(type, SIMPLE_QUICK_ACTION_KIND, defaultTextKey, context, enablementValidators);
+      this.type = type;
+      this.controlTypes = controlTypes;
+      this.defaultTextKey = defaultTextKey;
+      this.context = context;
+      this.enablementValidators = enablementValidators;
+    }
+    initialize() {
+      this.control = getRelevantControlFromActivePage(this.context.controlIndex, this.context.view, this.controlTypes)[0];
+      return Promise.resolve();
+    }
+    getActionObject() {
+      return {
+        kind: SIMPLE_QUICK_ACTION_KIND,
+        id: this.id,
+        enabled: !this.isDisabled,
+        tooltip: this.tooltip,
+        title: this.context.resourceBundle.getText(this.textKey)
+      };
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.SimpleQuickActionDefinitionBase = SimpleQuickActionDefinitionBase;
+  return __exports;
+});
+//# sourceMappingURL=simple-quick-action-base.js.map

package/dist/preview-middleware/dist/client/adp/quick-actions/simple-quick-action-base.ts

@@ -0,0 +1,51 @@
+import type UI5Element from 'sap/ui/core/Element';
+
+import type { SimpleQuickAction } from '@sap-ux-private/control-property-editor-common';
+import { SIMPLE_QUICK_ACTION_KIND } from '@sap-ux-private/control-property-editor-common';
+
+import { getRelevantControlFromActivePage } from '../../cpe/quick-actions/utils';
+import type { QuickActionContext } from '../../cpe/quick-actions/quick-action-definition';
+import type { EnablementValidator } from './enablement-validator';
+import { QuickActionDefinitionBase } from './quick-action-base';
+
+/**
+ * Base class for all simple quick actions.
+ */
+export abstract class SimpleQuickActionDefinitionBase<
+    T extends UI5Element = UI5Element
+> extends QuickActionDefinitionBase<typeof SIMPLE_QUICK_ACTION_KIND> {
+    public get isApplicable(): boolean {
+        return this.control !== undefined;
+    }
+
+    protected control: T | undefined;
+
+    constructor(
+        public readonly type: string,
+        protected readonly controlTypes: string[],
+        protected readonly defaultTextKey: string,
+        protected readonly context: QuickActionContext,
+        protected readonly enablementValidators: EnablementValidator[] = []
+    ) {
+        super(type, SIMPLE_QUICK_ACTION_KIND, defaultTextKey, context, enablementValidators);
+    }
+
+    initialize(): Promise<void> {
+        this.control = getRelevantControlFromActivePage<T>(
+            this.context.controlIndex,
+            this.context.view,
+            this.controlTypes
+        )[0];
+        return Promise.resolve();
+    }
+
+    getActionObject(): SimpleQuickAction {
+        return {
+            kind: SIMPLE_QUICK_ACTION_KIND,
+            id: this.id,
+            enabled: !this.isDisabled,
+            tooltip: this.tooltip,
+            title: this.context.resourceBundle.getText(this.textKey)
+        };
+    }
+}

package/dist/preview-middleware/dist/client/adp/quick-actions/supported-ui5versions.md

@@ -0,0 +1,40 @@
+# Supported UI5 Versions for Quick Actions in Adaptation Projects Based on Fiori Elements Applications with OData V2 and OData V4
+
+|                     Quick Action                   | OData Version | Page Type** | 1.71| 1.84| 1.96|1.108|1.120|1.124|1.127|1.130|1.131|>=1.132.0|>=1.135.0|
+|----------------------------------------------------|---------------|-------------|-----|-----|-----|-----|-----|-----|-----|-----|-----|---------|---------|
+| Add Controller to Page                             |      V2       | LR, ALP, OP |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+|                                                    |      V4       | LR, ALP, OP |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+| Add Header Field                                   |      V2       |          OP |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+|                                                    |      V4       |          OP |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+| Add Custom Section                                 |      V2       |          OP |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+|                                                    |      V4       |          OP |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+| Add Custom Page Action                             |      V2       | LR, ALP, OP |     |     |     |     |     |     |     |  x  |  x  |    x    |    x    |
+|                                                    |      V4       | LR, ALP, OP |     |     |     |     |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+| Add Custom Table Action                            |      V2       | LR, ALP, OP |     |     |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+|                                                    |      V4       | LR, ALP, OP |     |     |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+| Add Custom Table Column                            |      V2       | LR, ALP, OP |     |     |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+|                                                    |      V4       | LR, ALP, OP |     |     |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+| Change Table Columns                               |      V2       | LR, ALP, OP |     |     |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+|                                                    |      V4       | LR, ALP, OP |     |     |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+| Enable/Disable "Clear" Button                      |      V2       | LR, ALP     |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+|                                                    |      V4       | LR, ALP     |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |  x  |    x    |    x    |
+| Enable Semantic Date Range*                        |      V2       | LR, ALP     |     |     |  x  |  x  |  x  |     |     |  x  |  x  |    x    |    x    |
+|                                                    |      V4       | LR, ALP     |     |     |     |     |     |     |     |  x  |  x  |    x    |    x    |
+| Enable Table Filtering for Page Variants*          |      V2       | LR, ALP     |     |     |  x  |  x  |  x  |     |     |  x  |  x  |    x    |    x    |
+|                                                    |      V4       | LR, ALP     |     |     |     |     |     |     |     |     |  x  |    x    |    x    |
+| Add Local Annotation File*                         |      V2       | LR, ALP, OP |     |     |     |     |     |     |     |     |     |    x    |    x    |
+|                                                    |      V4       | LR, ALP, OP |     |     |     |     |     |     |     |     |     |    x    |    x    |
+| Enable Empty Row Mode for Tables*                  |      V2       |          OP |     |     |     |     |     |     |     |  x  |  x  |    x    |    x    |
+|                                                    |      V4       |          OP |     |     |     |     |     |     |     |     |  x  |    x    |    x    |
+| Enable Variant Management in Tables and Charts*    |      V2       | LR, ALP     |     |     |  x  |  x  |  x  |     |     |  x  |  x  |    x    |    x    |
+|                                                    |      V4       | LR, ALP, OP |     |     |     |     |     |     |     |     |  x  |    x    |    x    |
+| Enable Variant Management in Tables*               |      V2       |          OP |     |     |  x  |  x  |  x  |     |     |  x  |  x  |    x    |    x    |
+|                                                    |      V4       |             |     |     |     |     |     |     |     |     |     |         |         |
+| Add Subpage*                                       |      V2       | LR, ALP, OP |     |     |  x  |  x  |  x  |     |     |  x  |  x  |    x    |    x    |
+|                                                    |      V4       | LR, ALP, OP |     |     |     |     |     |     |     |     |     |         |    x    |
+
+
+*Actions resulting in manifest changes are not available for adaptation projects built for OData v2 applications using outdated array page structure in manifest.json.
+
+** Meaning of Page Type abbreviation: LR - List Report, ALP - Analytical List Page, OP - Object Page
+