@sap/ux-specification 1.136.11 → 1.136.12

package/dist/specification/src/ftfs/parser/model/ArrayAggregation.d.ts

@@ -0,0 +1,49 @@
+import type { PageData } from './types';
+import { AggregationType } from './types';
+import type { JSONSchema4 } from 'json-schema';
+import type { PageEditAggregationData } from './ObjectAggregation';
+import { ObjectAggregation } from './ObjectAggregation';
+import type { PageConfig, PageType, Parser } from '@sap/ux-specification-types';
+/**
+ * Represents an aggregation for array object.
+ */
+export declare class ArrayAggregation extends ObjectAggregation {
+    readonly type = AggregationType.Array;
+    /**
+     * Creates an instance of `ArrayAggregation`.
+     *
+     * @param data Optional aggregation data object used to initialize properties.
+     * @param schema Optional JSON schema fragment associated with this aggregation.
+     */
+    constructor(data?: PageEditAggregationData, schema?: JSONSchema4);
+    /**
+     * Method adds aggregation object.
+     * Overwritten to modify array's children.
+     *
+     * @param name Name of aggregation.
+     * @param aggregation Aggregation to add.
+     * @param path Array of path to aggregation.
+     * @param order Order index.
+     * @returns Added aggregation.
+     */
+    addAggregation(name: string, aggregation: ObjectAggregation, path: Parser.PropertyPath, order?: number): ObjectAggregation;
+    /**
+     * Public method which recursively updates aggregation's properties with values from passed data object.
+     * Overwritten to update children aggregations depending on data.
+     *
+     * @param data Data which should be used for value population.
+     * @param page Page config data.
+     * @param pageType Page type.
+     * @param path Aggregation path.
+     */
+    updatePropertiesValues(data: PageData | undefined, page: PageConfig, pageType: PageType, path: Parser.PropertyPath): void;
+    /**
+     * Private method resolves primary property of aggregation.
+     * Logic is that we look for certain properties like 'id', 'key', etc. If those properties do not exist, then we take first string property.
+     *
+     * @param aggregation Aggregation to add.
+     * @returns Property name.
+     */
+    private getPrimaryKey;
+}
+//# sourceMappingURL=ArrayAggregation.d.ts.map

package/dist/specification/src/ftfs/parser/model/ArrayAggregation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArrayAggregation.d.ts","sourceRoot":"","sources":["../../../../../../src/ftfs/parser/model/ArrayAggregation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAEH,eAAe,EAIlB,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAEhF;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,iBAAiB;IACnD,SAAgB,IAAI,yBAAyB;IAE7C;;;;;OAKG;gBACS,IAAI,CAAC,EAAE,uBAAuB,EAAE,MAAM,CAAC,EAAE,WAAW;IAYhE;;;;;;;;;OASG;IACI,cAAc,CACjB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,iBAAiB,EAC9B,IAAI,EAAE,MAAM,CAAC,YAAY,EACzB,KAAK,CAAC,EAAE,MAAM,GACf,iBAAiB;IAiBpB;;;;;;;;OAQG;IACI,sBAAsB,CACzB,IAAI,EAAE,QAAQ,GAAG,SAAS,EAC1B,IAAI,EAAE,UAAU,EAChB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,MAAM,CAAC,YAAY,GAC1B,IAAI;IAyBP;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;CAqBxB"}

package/dist/specification/src/ftfs/parser/model/ArrayAggregation.js

@@ -0,0 +1,122 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArrayAggregation = void 0;
+const types_1 = require("./types");
+const i18next_1 = __importDefault(require("i18next"));
+const ObjectAggregation_1 = require("./ObjectAggregation");
+/**
+ * Represents an aggregation for array object.
+ */
+class ArrayAggregation extends ObjectAggregation_1.ObjectAggregation {
+    /**
+     * Creates an instance of `ArrayAggregation`.
+     *
+     * @param data Optional aggregation data object used to initialize properties.
+     * @param schema Optional JSON schema fragment associated with this aggregation.
+     */
+    constructor(data, schema) {
+        super(data, schema);
+        this.type = types_1.AggregationType.Array;
+        this.schemaCreationForms = [
+            {
+                name: types_1.AggregationCreationForm.Generic,
+                kind: types_1.SCHEMA_CREATION_FORM,
+                title: 'PAGE_EDITOR_OUTLINE_ADD_GENERIC_TITLE',
+                disabled: false
+            }
+        ];
+    }
+    /**
+     * Method adds aggregation object.
+     * Overwritten to modify array's children.
+     *
+     * @param name Name of aggregation.
+     * @param aggregation Aggregation to add.
+     * @param path Array of path to aggregation.
+     * @param order Order index.
+     * @returns Added aggregation.
+     */
+    addAggregation(name, aggregation, path, order) {
+        super.addAggregation(name, aggregation, path, order);
+        // Array items are sortable and deletable
+        this.sortableList = true;
+        aggregation.sortableItem = types_1.SortingOptions.Enabled;
+        aggregation.actions = [types_1.AggregationActions.Delete];
+        // Set main title
+        if (aggregation.schema && !aggregation.schema.title) {
+            // Apply custom title as node label for array element
+            aggregation.schema.title = i18next_1.default.t('PAGE_EDITOR_OUTLINE_ARRAY_ITEM', {
+                name: Number.parseInt(name, 10) + 1
+            });
+        }
+        aggregation.custom = true;
+        return aggregation;
+    }
+    /**
+     * Public method which recursively updates aggregation's properties with values from passed data object.
+     * Overwritten to update children aggregations depending on data.
+     *
+     * @param data Data which should be used for value population.
+     * @param page Page config data.
+     * @param pageType Page type.
+     * @param path Aggregation path.
+     */
+    updatePropertiesValues(data, page, pageType, path) {
+        // Base update
+        super.updatePropertiesValues(data, page, pageType, path);
+        if (!Array.isArray(data)) {
+            return;
+        }
+        // Update 'additionalText' property for child aggregations
+        for (let i = 0; i < data.length; i++) {
+            const aggregation = this.aggregations[i];
+            if (!aggregation) {
+                continue;
+            }
+            let additionalText;
+            if (this.isAtomic) {
+                additionalText = data[i];
+            }
+            else {
+                const primaryKey = this.getPrimaryKey(aggregation);
+                additionalText = primaryKey ? data[i][primaryKey] : undefined;
+            }
+            if (typeof additionalText !== 'object') {
+                aggregation.additionalText = additionalText;
+            }
+        }
+    }
+    /**
+     * Private method resolves primary property of aggregation.
+     * Logic is that we look for certain properties like 'id', 'key', etc. If those properties do not exist, then we take first string property.
+     *
+     * @param aggregation Aggregation to add.
+     * @returns Property name.
+     */
+    getPrimaryKey(aggregation) {
+        // Get additional text for item array
+        // Start with predefined most common properties
+        const primaryProperties = ['id', 'title', 'key', 'name'];
+        const schemaProperties = aggregation.schema ? aggregation.schema.properties || {} : {};
+        let primaryProperty;
+        for (const property of primaryProperties) {
+            if (property in schemaProperties) {
+                primaryProperty = property;
+                break;
+            }
+        }
+        // No match, then use very first string property
+        for (const property in schemaProperties) {
+            if (schemaProperties[property].type === 'string') {
+                primaryProperty = property;
+                break;
+            }
+        }
+        return primaryProperty;
+    }
+}
+exports.ArrayAggregation = ArrayAggregation;
+//# sourceMappingURL=ArrayAggregation.js.map

package/dist/specification/src/ftfs/parser/model/ArrayAggregation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArrayAggregation.js","sourceRoot":"","sources":["../../../../../../src/ftfs/parser/model/ArrayAggregation.ts"],"names":[],"mappings":";;;;;;AACA,mCAMiB;AAEjB,sDAA8B;AAE9B,2DAAwD;AAGxD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,qCAAiB;IAGnD;;;;;OAKG;IACH,YAAY,IAA8B,EAAE,MAAoB;QAC5D,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QATR,SAAI,GAAG,uBAAe,CAAC,KAAK,CAAC;QAUzC,IAAI,CAAC,mBAAmB,GAAG;YACvB;gBACI,IAAI,EAAE,+BAAuB,CAAC,OAAO;gBACrC,IAAI,EAAE,4BAAoB;gBAC1B,KAAK,EAAE,uCAAuC;gBAC9C,QAAQ,EAAE,KAAK;aAClB;SACJ,CAAC;IACN,CAAC;IAED;;;;;;;;;OASG;IACI,cAAc,CACjB,IAAY,EACZ,WAA8B,EAC9B,IAAyB,EACzB,KAAc;QAEd,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACrD,yCAAyC;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,WAAW,CAAC,YAAY,GAAG,sBAAc,CAAC,OAAO,CAAC;QAClD,WAAW,CAAC,OAAO,GAAG,CAAC,0BAAkB,CAAC,MAAM,CAAC,CAAC;QAClD,iBAAiB;QACjB,IAAI,WAAW,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAClD,qDAAqD;YACrD,WAAW,CAAC,MAAM,CAAC,KAAK,GAAG,iBAAO,CAAC,CAAC,CAAC,gCAAgC,EAAE;gBACnE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC;aACtC,CAAC,CAAC;QACP,CAAC;QACD,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC;QAC1B,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;;;;;;;OAQG;IACI,sBAAsB,CACzB,IAA0B,EAC1B,IAAgB,EAChB,QAAkB,EAClB,IAAyB;QAEzB,cAAc;QACd,KAAK,CAAC,sBAAsB,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,OAAO;QACX,CAAC;QACD,0DAA0D;QAC1D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACnC,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACzC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,SAAS;YACb,CAAC;YACD,IAAI,cAAc,CAAC;YACnB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAChB,cAAc,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACJ,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;gBACnD,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,CAAC;YACD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACrC,WAAW,CAAC,cAAc,GAAG,cAAc,CAAC;YAChD,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,aAAa,CAAC,WAA8B;QAChD,qCAAqC;QACrC,+CAA+C;QAC/C,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACzD,MAAM,gBAAgB,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvF,IAAI,eAAmC,CAAC;QACxC,KAAK,MAAM,QAAQ,IAAI,iBAAiB,EAAE,CAAC;YACvC,IAAI,QAAQ,IAAI,gBAAgB,EAAE,CAAC;gBAC/B,eAAe,GAAG,QAAQ,CAAC;gBAC3B,MAAM;YACV,CAAC;QACL,CAAC;QACD,gDAAgD;QAChD,KAAK,MAAM,QAAQ,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC/C,eAAe,GAAG,QAAQ,CAAC;gBAC3B,MAAM;YACV,CAAC;QACL,CAAC;QACD,OAAO,eAAe,CAAC;IAC3B,CAAC;CACJ;AAxHD,4CAwHC"}

package/dist/specification/src/ftfs/parser/model/NodeProperty.d.ts

@@ -0,0 +1,38 @@
+import type { JSONSchema4 } from 'json-schema';
+import type { Location, SettingOption, PropertyMessage } from './types';
+import { ValidationState } from './types';
+import type { ArtifactType } from '@sap/ux-specification-types';
+export interface PageProperties {
+    [key: string]: NodeProperty;
+}
+/**
+ * Represents a configurable aggregation property in the page editing model.
+ * `NodeProperty` wraps schema-based metadata for a property and stores
+ * runtime values, validation state, messages, and UI-related options.
+ */
+export declare class NodeProperty implements SettingOption {
+    schema: JSONSchema4;
+    value?: unknown;
+    pattern?: string;
+    freeText?: boolean;
+    disabled?: boolean;
+    state?: ValidationState;
+    description?: string;
+    required?: boolean;
+    isAtomic?: boolean;
+    i18nClassification?: string;
+    name: string;
+    displayName?: string;
+    artifactType?: ArtifactType;
+    minimum?: number;
+    messages?: PropertyMessage[];
+    locations?: Location[];
+    /**
+     * Creates an instance of `NodeProperty`.
+     *
+     * @param schema JSON Schema fragment associated with this property.
+     * @param displayName Display name of the property.
+     */
+    constructor(schema: JSONSchema4, displayName: string);
+}
+//# sourceMappingURL=NodeProperty.d.ts.map

package/dist/specification/src/ftfs/parser/model/NodeProperty.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeProperty.d.ts","sourceRoot":"","sources":["../../../../../../src/ftfs/parser/model/NodeProperty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEhE,MAAM,WAAW,cAAc;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC;CAC/B;AAED;;;;GAIG;AACH,qBAAa,YAAa,YAAW,aAAa;IACvC,MAAM,EAAE,WAAW,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IAIjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,eAAe,CAAyB;IAEhD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAE7B,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IAE9B;;;;;OAKG;gBACS,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM;CAKvD"}

package/dist/specification/src/ftfs/parser/model/NodeProperty.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeProperty = void 0;
+const types_1 = require("./types");
+/**
+ * Represents a configurable aggregation property in the page editing model.
+ * `NodeProperty` wraps schema-based metadata for a property and stores
+ * runtime values, validation state, messages, and UI-related options.
+ */
+class NodeProperty {
+    /**
+     * Creates an instance of `NodeProperty`.
+     *
+     * @param schema JSON Schema fragment associated with this property.
+     * @param displayName Display name of the property.
+     */
+    constructor(schema, displayName) {
+        this.state = types_1.ValidationState.Valid;
+        // Use copy - it allows to make changes in schema if we need.
+        this.schema = structuredClone(schema);
+        this.name = displayName;
+    }
+}
+exports.NodeProperty = NodeProperty;
+//# sourceMappingURL=NodeProperty.js.map

package/dist/specification/src/ftfs/parser/model/NodeProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeProperty.js","sourceRoot":"","sources":["../../../../../../src/ftfs/parser/model/NodeProperty.ts"],"names":[],"mappings":";;;AAEA,mCAA0C;AAO1C;;;;GAIG;AACH,MAAa,YAAY;IA8BrB;;;;;OAKG;IACH,YAAY,MAAmB,EAAE,WAAmB;QA3B7C,UAAK,GAAqB,uBAAe,CAAC,KAAK,CAAC;QA4BnD,6DAA6D;QAC7D,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;IAC5B,CAAC;CACJ;AAzCD,oCAyCC"}

package/dist/specification/src/ftfs/parser/model/ObjectAggregation.d.ts

@@ -0,0 +1,339 @@
+import type { PageData, CreationFormOptions, AggregationCreationForm, PendingChange, SupportedAggregationActions, ModelParserParams, PageAnnotations, PropertyMessage, Location, UINode, AllowedMoveRange } from './types';
+import { AggregationActions, AggregationType, AggregationSortBy, SortingOptions, ValidationState } from './types';
+import type { JSONSchema4 } from 'json-schema';
+import { NodeProperty, type PageProperties } from './NodeProperty';
+import type { I18nBundle } from '@sap-ux/i18n';
+import type { ArtifactType, PageConfig, PageType, Parser } from '@sap/ux-specification-types';
+export interface PageAggregations {
+    [key: string]: ObjectAggregation;
+}
+export interface PageEditAggregationData {
+    aggregations: PageAggregations;
+    properties: PageProperties;
+    additionalProperties?: ObjectAggregation;
+    propertiesVariants?: Array<PageProperties>;
+}
+export interface AggregationVariant {
+    properties: PageProperties;
+    aggregations: PageAggregations;
+}
+export type SpecificationKey = {
+    name: string;
+    value: string;
+};
+export type SpecificationKeysTag = Array<SpecificationKey>;
+interface AggregationUnion {
+    name: string;
+    originalNames: string[];
+}
+export declare const CUSTOM_EXTENSION_ANCHOR_PROPERTIES: string[];
+/**
+ * Represents an aggregation for objects.
+ */
+export declare class ObjectAggregation implements Parser.TreeAggregation {
+    path: Parser.PropertyPath;
+    aggregations: PageAggregations;
+    properties: PageProperties;
+    additionalProperties?: ObjectAggregation;
+    variants: Array<AggregationVariant>;
+    childClass?: typeof ObjectAggregation;
+    additionalText?: string;
+    locations?: Location[];
+    actions?: SupportedAggregationActions;
+    inactive?: boolean;
+    schema?: JSONSchema4;
+    annotationCreationForms: CreationFormOptions[];
+    allowedAnnotationCreationForms?: AggregationCreationForm[];
+    schemaCreationForms: CreationFormOptions[];
+    formSchema?: ObjectAggregation;
+    sortableList?: boolean;
+    sortableItem?: SortingOptions;
+    sortableReadonlyTooltip?: string;
+    sortableConfigOnly?: boolean;
+    order?: number;
+    description?: string;
+    i18nKey?: string;
+    state?: ValidationState;
+    messages?: PropertyMessage[];
+    value: unknown;
+    readonly type: AggregationType;
+    readonly parent?: ObjectAggregation;
+    custom: boolean;
+    isViewNode?: boolean;
+    isTable: boolean;
+    pattern?: string;
+    name?: string;
+    union?: AggregationUnion;
+    sortableCollection?: string;
+    annotationNodeId?: number[];
+    dropUINodes?: Record<string, boolean>;
+    pending?: PendingChange;
+    hidden?: boolean;
+    artifactType?: ArtifactType;
+    virtual?: boolean;
+    icon?: string;
+    isAtomic?: boolean;
+    /**
+     * Creates an instance of `ObjectAggregation`.
+     *
+     * @param data Optional aggregation data object used to initialize properties.
+     * @param schema Optional JSON schema fragment associated with this aggregation.
+     */
+    constructor(data?: PageEditAggregationData, schema?: JSONSchema4);
+    /**
+     * Method adds aggregation object.
+     *
+     * @param name Name of aggregation.
+     * @param aggregation Aggregation to add.
+     * @param path Array of path to aggregation.
+     * @param order Order index.
+     * @param overwrite Overwrite existing aggregation.
+     * @returns Added aggregation.
+     */
+    addAggregation(name: string, aggregation: ObjectAggregation, path: Parser.PropertyPath, order?: number, overwrite?: boolean): ObjectAggregation;
+    /**
+     * Method adds property object.
+     *
+     * @param name Name of property.
+     * @param schema Schema object of property.
+     * @returns Instance of new property.
+     */
+    addProperty(name: string, schema: JSONSchema4): NodeProperty;
+    /**
+     * Public method returns display name of aggregation.
+     * Is used as display name in outline.
+     *
+     * @param i18nBundle I18n translation entries which should be looked up if display value persists.
+     * @returns Display name of aggregation with applied i18n.
+     */
+    getDisplayName(i18nBundle?: I18nBundle): string;
+    /**
+     * Retrieves the supported aggregation actions for this instance.
+     *
+     * @returns A list of supported aggregation actions.
+     */
+    getSupportedActions(): SupportedAggregationActions;
+    /**
+     * Public method that returns keys from schema for an aggregation object.
+     *
+     * @returns Array of keys.
+     */
+    getKeys(): SpecificationKeysTag | undefined;
+    /**
+     * Method returns value of passed schema key.
+     *
+     * @param name Name to search.
+     * @returns Value for passed key's name.
+     */
+    getValueOfSchemaKey(name: string): string | undefined;
+    /**
+     * Public method that returns technical name for an aggregation object.
+     * Currently it is used to display in tooltip.
+     *
+     * @returns technical name.
+     */
+    getTechnicalName(): string | undefined;
+    /**
+     * Protected method returns display name of aggregation without applying i18n translation.
+     *
+     * @returns Display name of aggregation.
+     */
+    protected getRawDisplayName(): string;
+    /**
+     * Method formats text for display.
+     * Trim is used to avoid whitespaces.
+     *
+     * @param text Text to format.
+     * @returns Formatted text.
+     */
+    private formatTextForDisplay;
+    /**
+     * Method updates value of aggregatipn properties and child aggregations.
+     *
+     * @param data Data which should be used for value population.
+     */
+    private updateValues;
+    /**
+     * Public method which recursively updates aggregation's properties with values from passed data object.
+     *
+     * @param data Data which should be used for value population.
+     * @param page Page config data.
+     * @param pageType Page type.
+     * @param path Aggregation path.
+     * @param annotations Page annotations.
+     * @param parser Model parser parameters.
+     */
+    updatePropertiesValues(data: PageData | undefined, page: PageConfig, pageType: PageType, path: Parser.PropertyPath, annotations?: PageAnnotations, parser?: ModelParserParams<ObjectAggregation>): void;
+    /**
+     * Method which called when properties and aggregation data was applied and updated.
+     */
+    protected onPropertiesUpdated(): void;
+    /**
+     * Refreshes internal data based on latest annotation node data.
+     *
+     * @param annotations Page annotations.
+     */
+    updateAnnotationData(annotations: PageAnnotations | undefined): void;
+    /**
+     * Method checks if annotation contains allowedSubnodeTypes
+     * and sets disabled param for add action button.
+     *
+     * @param annotations Page annotations.
+     * @param uiNode Annotation node.
+     */
+    private setAllowedParents;
+    /**
+     * Refreshes node locations based on the annotation node data.
+     *
+     * @param annotations All page annotation nodes.
+     * @param currentUINode Current annotation node.
+     */
+    protected updateLocations(annotations: PageAnnotations | undefined, currentUINode?: UINode): void;
+    /**
+     * Method provides creation options based on its related annotation node.
+     *
+     * @param annotations Page annotations.
+     * @returns Array of creation forms.
+     */
+    protected getNativeNodeCreationForms(annotations: PageAnnotations | undefined): CreationFormOptions[];
+    /**
+     * Method provides default creation options, when no matching annotation node exists.
+     *
+     * @param annotations Page annotations.
+     * @returns Array of creation forms.
+     */
+    getDefaultNativeCreationForms(annotations: PageAnnotations): CreationFormOptions[];
+    /**
+     * Method recursively searches for parent with 'annotationNodeId' and returns 'annotationNodeId' as current context.
+     *
+     * @returns Annotation node id.
+     */
+    getParentAnnotationNodeId(): number[] | undefined;
+    /**
+     * Method get valid object of properties.
+     * There can be case when aggregation can have several variants of property combination - we are returning currently valid, depending on entered values.
+     *
+     * @returns Object of properties.
+     */
+    getProperties(): PageProperties;
+    /**
+     * Method returns copy of ObjectAggregation object.
+     *
+     * @param type Type of aggregation.
+     * @returns Copy of ObjectAggregation.
+     */
+    getCopy(type?: typeof ObjectAggregation): ObjectAggregation;
+    /**
+     * Recursive method to use for copying aggregations objects.
+     *
+     * @param aggregation Original aggregation for copy.
+     * @param type Type of aggregation.
+     */
+    private createAggregations;
+    /**
+     * Method sorts aggregation by 'order' property.
+     *
+     * @param name1 Aggregation name.
+     * @param name2 Aggregation name.
+     * @returns Sort result.
+     */
+    private aggregationOrderSorter;
+    /**
+     * Method returns array of ordered aggregation keys/names.
+     *
+     * @param viewNodesOnly Return only aggregations for view.
+     * @param sortBy Sorting type. Currently aggregations can be sorted by 'ViewNode' to move visible nodes to top.
+     * @returns Array of aggregations keys/names.
+     */
+    getAggregationKeys(viewNodesOnly?: boolean, sortBy?: AggregationSortBy): Array<string>;
+    /**
+     * Aggregation key sorter by view node.
+     * Sorter also sorts by aggregation key in scope of save view node group.
+     *
+     * @param key1 First aggregation key.
+     * @param key2 Second aggregation key.
+     * @returns Sorter result.
+     */
+    private getViewNodeSorter;
+    /**
+     * Method updates path recursively.
+     *
+     * @param aggregation Aggregation to update.
+     * @param path Current path.
+     */
+    private updatePath;
+    /**
+     * Set method to store path of aggregation.
+     *
+     * @param path Path array.
+     */
+    protected setPath(path: Parser.PropertyPath): void;
+    /**
+     * Method returns maximal order by looping through all properties.
+     *
+     * @returns Maximal property order index.
+     */
+    getMaxOrder(): number;
+    /**
+     * Method enables union handling by adding setting union name and passing original name of aggregation.
+     *
+     * @param name Union name for aggregation.
+     * @param originalName Original name of aggregation.
+     */
+    addUnionName(name: string, originalName: string): void;
+    /**
+     * Protected method which returns name with additional formatting if it is unnecessary.
+     * Default logic does not apply any additional formatting, but it allows to overwrite such method and provide additional logic specific to each aggregation.
+     *
+     * @returns Name of aggregation.
+     */
+    protected getFormattedName(): string | undefined;
+    /**
+     * Method returns associated annotation UI Node for aggregation.
+     *
+     * @param annotations Annotations data.
+     * @returns Associated annotation UI Node.
+     */
+    private getCurrentUINode;
+    /**
+     * Method handles readonly annotation node by disabling actions and DnD.
+     *
+     * @param readonlyTooltip Tooltip text for readonly mode.
+     */
+    protected applyReadonlyAnnotationNode(readonlyTooltip?: string): void;
+    /**
+     * Method removes passed action from visible actions.
+     *
+     * @param action Action to remove.
+     */
+    protected removeAction(action: AggregationActions): void;
+    /**
+     * Method returns allowed drop ranges for passed source aggregation.
+     *
+     * @param source Source aggregation.
+     * @returns Allowed drop ranges for passed source aggregation.
+     */
+    getAllowedDropRange(source: ObjectAggregation): AllowedMoveRange[] | undefined;
+    /**
+     * Method returns whether aggregation node has macros metadata.
+     *
+     * @returns Whether aggregation node is macros node.
+     */
+    isMacrosNode(): boolean;
+    /**
+     * Method converts property to aggregation.
+     *
+     * @param key Property key/index in object.
+     * @param path Aggregation path.
+     */
+    private convertAtomicPropertyToAggregation;
+    /**
+     * Method handles atomic aggregation by converting properties to aggregation.
+     *
+     * @param data Aggregation source data.
+     * @param path Aggregation path.
+     */
+    private handleAtomicObject;
+}
+export {};
+//# sourceMappingURL=ObjectAggregation.d.ts.map

package/dist/specification/src/ftfs/parser/model/ObjectAggregation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectAggregation.d.ts","sourceRoot":"","sources":["../../../../../../src/ftfs/parser/model/ObjectAggregation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,QAAQ,EACR,mBAAmB,EACnB,uBAAuB,EACvB,aAAa,EACb,2BAA2B,EAC3B,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,QAAQ,EACR,MAAM,EACN,gBAAgB,EACnB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,iBAAiB,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAClH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAG9F,MAAM,WAAW,gBAAgB;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACpC,YAAY,EAAE,gBAAgB,CAAC;IAC/B,UAAU,EAAE,cAAc,CAAC;IAC3B,oBAAoB,CAAC,EAAE,iBAAiB,CAAC;IACzC,kBAAkB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,kBAAkB;IAC/B,UAAU,EAAE,cAAc,CAAC;IAC3B,YAAY,EAAE,gBAAgB,CAAC;CAClC;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAU3D,UAAU,gBAAgB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,EAAE,CAAC;CAC3B;AAOD,eAAO,MAAM,kCAAkC,UAA6B,CAAC;AAE7E;;GAEG;AACH,qBAAa,iBAAkB,YAAW,MAAM,CAAC,eAAe;IAErD,IAAI,EAAE,MAAM,CAAC,YAAY,CAAM;IAE/B,YAAY,EAAE,gBAAgB,CAAM;IACpC,UAAU,EAAE,cAAc,CAAM;IAChC,oBAAoB,CAAC,EAAE,iBAAiB,CAAC;IAEzC,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAM;IAEzC,UAAU,CAAC,EAAE,OAAO,iBAAiB,CAAC;IAEtC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,2BAA2B,CAAC;IAEtC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB,uBAAuB,EAAE,mBAAmB,EAAE,CAAM;IACpD,8BAA8B,CAAC,EAAE,uBAAuB,EAAE,CAAM;IAChE,mBAAmB,EAAE,mBAAmB,EAAE,CAAM;IAChD,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAE/B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,cAAc,CAAC;IAC9B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,eAAe,CAAyB;IAChD,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,KAAK,EAAE,OAAO,CAAC;IAEtB,SAAgB,IAAI,EAAE,eAAe,CAA0B;IAE/D,SAAgB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAEpC,MAAM,UAAS;IAEf,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,OAAO,UAAS;IAEhB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEtC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;OAKG;gBACS,IAAI,CAAC,EAAE,uBAAuB,EAAE,MAAM,CAAC,EAAE,WAAW;IAUhE;;;;;;;;;OASG;IACI,cAAc,CACjB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,iBAAiB,EAC9B,IAAI,EAAE,MAAM,CAAC,YAAY,EACzB,KAAK,CAAC,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,OAAO,GACpB,iBAAiB;IA6BpB;;;;;;OAMG;IACI,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,YAAY;IAUnE;;;;;;OAMG;IACI,cAAc,CAAC,UAAU,GAAE,UAAe,GAAG,MAAM;IA6B1D;;;;OAIG;IACI,mBAAmB,IAAI,2BAA2B;IAQzD;;;;OAIG;IACI,OAAO,IAAI,oBAAoB,GAAG,SAAS;IAQlD;;;;;OAKG;IACI,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAK5D;;;;;OAKG;IACI,gBAAgB,IAAI,MAAM,GAAG,SAAS;IAI7C;;;;OAIG;IACH,SAAS,CAAC,iBAAiB,IAAI,MAAM;IAUrC;;;;;;OAMG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAepB;;;;;;;;;OASG;IACI,sBAAsB,CACzB,IAAI,EAAE,QAAQ,GAAG,SAAS,EAC1B,IAAI,EAAE,UAAU,EAChB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,MAAM,CAAC,YAAY,EACzB,WAAW,CAAC,EAAE,eAAe,EAC7B,MAAM,CAAC,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,GAC9C,IAAI;IA0BP;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,IAAI;IAIrC;;;;OAIG;IACI,oBAAoB,CAAC,WAAW,EAAE,eAAe,GAAG,SAAS,GAAG,IAAI;IAkB3E;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IAMzB;;;;;OAKG;IACH,SAAS,CAAC,eAAe,CAAC,WAAW,EAAE,eAAe,GAAG,SAAS,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;IAqBjG;;;;;OAKG;IACH,SAAS,CAAC,0BAA0B,CAAC,WAAW,EAAE,eAAe,GAAG,SAAS,GAAG,mBAAmB,EAAE;IAYrG;;;;;OAKG;IAEI,6BAA6B,CAAC,WAAW,EAAE,eAAe,GAAG,mBAAmB,EAAE;IAIzF;;;;OAIG;IACI,yBAAyB,IAAI,MAAM,EAAE,GAAG,SAAS;IAUxD;;;;;OAKG;IACI,aAAa,IAAI,cAAc;IAItC;;;;;OAKG;IACI,OAAO,CAAC,IAAI,GAAE,OAAO,iBAAqC,GAAG,iBAAiB;IAcrF;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAgB1B;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IAU9B;;;;;;OAMG;IACI,kBAAkB,CAAC,aAAa,UAAQ,EAAE,MAAM,CAAC,EAAE,iBAAiB,GAAG,KAAK,CAAC,MAAM,CAAC;IA6B3F;;;;;;;OAOG;IACH,OAAO,CAAC,iBAAiB;IAuBzB;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IASlB;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,GAAG,IAAI;IAIlD;;;;OAIG;IACI,WAAW,IAAI,MAAM;IAW5B;;;;;OAKG;IACI,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;IAW7D;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,MAAM,GAAG,SAAS;IAIhD;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAgBxB;;;;OAIG;IACH,SAAS,CAAC,2BAA2B,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI;IAyCrE;;;;OAIG;IACH,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI;IASxD;;;;;OAKG;IAEI,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,GAAG,gBAAgB,EAAE,GAAG,SAAS;IAIrF;;;;OAIG;IACI,YAAY,IAAI,OAAO;IAI9B;;;;;OAKG;IACH,OAAO,CAAC,kCAAkC;IAU1C;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;CAgB7B"}