@sap/ux-specification 1.120.8 → 1.120.10

package/dist/specification/scripts/macros/schema.js

@@ -0,0 +1,256 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSchema = void 0;
+const ux_specification_types_1 = require("@sap/ux-specification-types");
+const ux_specification_types_2 = require("@sap/ux-specification-types");
+const types_1 = require("./types");
+const corrections_1 = require("./corrections");
+const common_1 = require("../../src/sync/common");
+/**
+ * Method checks if passed type is atomic type like 'boolean', 'string', 'number', etc.
+ * @param {string} type Type to check.
+ * @returns {boolean} Is atomic type.
+ */
+function isAtomicType(type) {
+    return ['string', 'number', 'integer', 'boolean', 'object', 'array', 'null', 'any'].includes(type);
+}
+/**
+ * Method returns base/skeleton schema.
+ * @returns {SchemaDefinition} JSON schema.
+ */
+function getRootSchema() {
+    const hiddenProperty = { type: 'string', hidden: true };
+    return {
+        type: 'object',
+        metadata: {
+            namespaces: []
+        },
+        properties: {
+            $filePath: hiddenProperty,
+            $schema: hiddenProperty
+        },
+        additionalProperties: false,
+        definitions: {},
+        $schema: 'http://json-schema.org/draft-07/schema#'
+    };
+}
+/**
+ * Method formats description text before storing it into schema.
+ * Currently method removes HTML markup from text.
+ * @param {string} [description] Description to format.
+ * @returns {string} Formatted description.
+ */
+function formatDescription(description) {
+    if (description) {
+        // Replace combination of HTML break and new line with single line
+        description = description.replace(/<br\/>\n/g, '\n');
+        // Replace remaining separate HTML break with new line
+        description = description.replace(/<br\/>/g, '\n');
+        // Remove HTML markup
+        return description.replace(/<[^>]*>?/g, '');
+    }
+    return '';
+}
+/**
+ * Method prepares schema definition object.
+ * @param {MacrosPropertyType} metadataType Metadata property type.
+ * @param {string} [description] Description of definition.
+ * @param {string} defaultAggreation Default aggregation.
+ * @returns {SchemaDefinition} JSON schema for definition.
+ */
+function prepareDefinition(metadataType, description, defaultAggreation) {
+    if (description) {
+        // Remove html markup from description
+        description = formatDescription(description);
+    }
+    const definition = {
+        description,
+        isViewNode: true,
+        type: 'object',
+        properties: {},
+        additionalProperties: false,
+        metadata: {
+            path: [],
+            type: metadataType
+        }
+    };
+    if (defaultAggreation) {
+        definition.metadata.defaultAggregation = defaultAggreation;
+    }
+    return definition;
+}
+/**
+ * Method prepares schema object for passed type.
+ * @param {string} type Type of target property or object.
+ * @returns {SchemaDefinition} JSON schema.
+ */
+function getSchemaForType(type) {
+    const schema = {};
+    if (isAtomicType(type)) {
+        schema.type = type;
+    }
+    else {
+        schema.$ref = `#/definitions/${type}`;
+    }
+    return schema;
+}
+/**
+ * Method prepares schema object for passed types.
+ * @param {string | string[]} [type] Type(s) of target property or object.
+ * @param {UI5PropertyType[]} [types] Types of target property or object.
+ * @returns {SchemaDefinition} JSON schema.
+ */
+function getTypes(type, propertyTypes) {
+    let result = [];
+    if (type) {
+        result = Array.isArray(type) ? type : type.split('|').map((subType) => subType.trim());
+    }
+    else if (propertyTypes) {
+        result = propertyTypes.map((propertyType) => propertyType.value);
+    }
+    return result.map((propertyType) => {
+        return getSchemaForType(propertyType);
+    });
+}
+/**
+ * Method prepares schema property object for passed generic property.
+ * @param {UI5Property} property SAPUI5 property.
+ * @param {MacrosPropertyType} metadataType Metadata property type.
+ * @param {string} [type] Type of target property or object.
+ * @param {UI5PropertyType[]} [types] Types of target property or object.
+ * @returns {SchemaDefinition} JSON schema.
+ */
+function prepareSchemaProperty(property, metadataType, type, types) {
+    const schemaTypes = getTypes(type, types);
+    // modify bindable number property type by adding another type (string) with binding syntax pattern
+    if (type === 'number' && 'bindable' in property && property.bindable) {
+        schemaTypes.push({
+            type: 'string',
+            pattern: "^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$"
+        });
+    }
+    const isViewNode = schemaTypes.some((schemaType) => !!schemaType.$ref);
+    // Define result
+    const propertySchema = schemaTypes.length === 1
+        ? { ...schemaTypes[0] }
+        : {
+            anyOf: schemaTypes
+        };
+    propertySchema.description = formatDescription(property.description);
+    propertySchema['artifactType'] = ux_specification_types_1.ArtifactType.XMLProperty;
+    if (isViewNode) {
+        propertySchema.description = property.name;
+        propertySchema.isViewNode = true;
+    }
+    propertySchema.metadata = {
+        type: metadataType
+    };
+    return propertySchema;
+}
+/**
+ * Method returns allowed values for passed ui5 property.
+ * @param {UI5Property} property SAPUI5 property.
+ * @returns {string[] | undefined} Array of allowed values.
+ */
+function getAllowedValues(property) {
+    if (property.allowedValues) {
+        return property.allowedValues;
+    }
+    return property['ui5-metadata']?.['sap.fe']?.allowedValues;
+}
+/**
+ * Method prepares schema object for passed SAPUI5 property.
+ * @param {UI5Property} property SAPUI5 property.
+ * @returns {SchemaDefinition} JSON schema.
+ */
+function prepareProperty(property) {
+    const propertySchema = prepareSchemaProperty(property, ux_specification_types_2.MacrosPropertyType.Property, property.type, property.types);
+    const allowedValues = getAllowedValues(property);
+    if (allowedValues && propertySchema.type === 'string') {
+        (0, common_1.addEnumToSchema)(allowedValues, propertySchema);
+    }
+    return propertySchema;
+}
+/**
+ * Method prepares schema object for passed SAPUI5 event.
+ * @param {UI5Property} property SAPUI5 event.
+ * @returns {SchemaDefinition} JSON schema.
+ */
+function prepareEvent(property) {
+    return prepareSchemaProperty(property, ux_specification_types_2.MacrosPropertyType.Event, 'string');
+}
+/**
+ * Method prepares schema object for passed SAPUI5 aggregation.
+ * @param {UI5Property} property SAPUI5 aggregation.
+ * @returns {SchemaDefinition} JSON schema.
+ */
+function prepareAggregations(aggregation) {
+    const schemaTypes = getTypes(aggregation.type);
+    return {
+        type: 'object',
+        additionalProperties: schemaTypes.length ? schemaTypes[0] : { anyOf: schemaTypes },
+        isViewNode: true,
+        metadata: {
+            path: [],
+            type: ux_specification_types_2.MacrosPropertyType.Aggregation
+        }
+    };
+}
+/**
+ * Method applies available macros namespaces for storing inside root schema metadata.
+ * @param {MacrosAPI} api SAPUI5 "sap.fe.macros" api.
+ * @param {SchemaDefinition} schema JSON schema for "sap.fe.macros" api.
+ */
+function applyNamespaces(api, schema) {
+    for (const symbol of api.symbols) {
+        if (symbol.kind === types_1.SYMBOL_KIND_NAMESPACE && symbol.name.startsWith('sap.fe.macros')) {
+            schema.metadata.namespaces.push(symbol.name);
+        }
+    }
+}
+/**
+ * Method generates generic schema for passed "sap.fe.macros" api.
+ * @param {MacrosAPI} api SAPUI5 "sap.fe.macros" api.
+ * @returns {SchemaDefinition} JSON schema for "sap.fe.macros" api.
+ */
+function generateSchema(api) {
+    // Apply corrections for macros API - there is some missing information in api.json
+    (0, corrections_1.applyCorrections)(api);
+    const schema = getRootSchema();
+    const { definitions } = schema;
+    // Handle classes
+    const classSymbols = api.symbols.filter((symbol) => symbol.kind === types_1.SYMBOL_KIND_CLASS);
+    for (const symbol of classSymbols) {
+        const definition = prepareDefinition(ux_specification_types_2.MacrosPropertyType.Control, symbol.description, symbol[types_1.CLASS_SYMBOL_METADATA_PROPERTY]?.defaultAggregation);
+        definitions[symbol.name] = definition;
+        const events = symbol.events || [];
+        const { properties = [], aggregations = [] } = symbol[types_1.CLASS_SYMBOL_METADATA_PROPERTY] || {};
+        // Handle properties
+        for (const property of properties) {
+            definition.properties[property.name] = prepareProperty(property);
+        }
+        // Handle aggregations
+        for (const aggregation of aggregations) {
+            definition.properties[aggregation.name] = prepareAggregations(aggregation);
+        }
+        // Handle events
+        for (const event of events) {
+            definition.properties[event.name] = prepareEvent(event);
+        }
+    }
+    // Handle namespaces
+    applyNamespaces(api, schema);
+    // Handle typedefs
+    const typedefSymbols = api.symbols.filter((symbol) => symbol.kind === types_1.SYMBOL_KIND_TYPEDEF);
+    for (const symbol of typedefSymbols) {
+        const definition = prepareDefinition(ux_specification_types_2.MacrosPropertyType.Control, symbol.description, symbol[types_1.CLASS_SYMBOL_METADATA_PROPERTY]?.defaultAggregation);
+        definitions[symbol.name] = definition;
+        const properties = symbol.properties || [];
+        for (const property of properties) {
+            definition.properties[property.name] = prepareProperty(property);
+        }
+    }
+    return schema;
+}
+exports.generateSchema = generateSchema;
+//# sourceMappingURL=schema.js.map

package/dist/specification/scripts/macros/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../scripts/macros/schema.ts"],"names":[],"mappings":";;;AACA,wEAA2D;AAC3D,wEAAiE;AAWjE,mCAAwH;AACxH,+CAAiD;AAEjD,kDAAwD;AAExD;;;;GAIG;AACH,SAAS,YAAY,CAAC,IAAY;IAC9B,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACvG,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa;IAClB,MAAM,cAAc,GAAqB,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAC1E,OAAO;QACH,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE;YACN,UAAU,EAAE,EAAE;SACjB;QACD,UAAU,EAAE;YACR,SAAS,EAAE,cAAc;YACzB,OAAO,EAAE,cAAc;SAC1B;QACD,oBAAoB,EAAE,KAAK;QAC3B,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,yCAAyC;KACrD,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,WAAoB;IAC3C,IAAI,WAAW,EAAE,CAAC;QACd,kEAAkE;QAClE,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACrD,sDAAsD;QACtD,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QACnD,qBAAqB;QACrB,OAAO,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,EAAE,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAS,iBAAiB,CACtB,YAAgC,EAChC,WAAoB,EACpB,iBAA0B;IAE1B,IAAI,WAAW,EAAE,CAAC;QACd,sCAAsC;QACtC,WAAW,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IACD,MAAM,UAAU,GAAG;QACf,WAAW;QACX,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,EAAE;QACd,oBAAoB,EAAE,KAAK;QAC3B,QAAQ,EAAE;YACN,IAAI,EAAE,EAAE;YACR,IAAI,EAAE,YAAY;SACrB;KACgB,CAAC;IACtB,IAAI,iBAAiB,EAAE,CAAC;QACpB,UAAU,CAAC,QAAQ,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;IAC/D,CAAC;IACD,OAAO,UAAU,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,IAAY;IAClC,MAAM,MAAM,GAAqB,EAAE,CAAC;IACpC,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACrB,MAAM,CAAC,IAAI,GAAG,IAA2B,CAAC;IAC9C,CAAC;SAAM,CAAC;QACJ,MAAM,CAAC,IAAI,GAAG,iBAAiB,IAAI,EAAE,CAAC;IAC1C,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,SAAS,QAAQ,CAAC,IAAwB,EAAE,aAAiC;IACzE,IAAI,MAAM,GAAa,EAAE,CAAC;IAC1B,IAAI,IAAI,EAAE,CAAC;QACP,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACnG,CAAC;SAAM,IAAI,aAAa,EAAE,CAAC;QACvB,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,YAA6B,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,YAAoB,EAAE,EAAE;QACvC,OAAO,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,qBAAqB,CAC1B,QAA4B,EAC5B,YAAgC,EAChC,IAAa,EACb,KAAyB;IAEzB,MAAM,WAAW,GAAuB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC9D,mGAAmG;IACnG,IAAI,IAAI,KAAK,QAAQ,IAAI,UAAU,IAAI,QAAQ,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACnE,WAAW,CAAC,IAAI,CAAC;YACb,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,8CAA8C;SAC1D,CAAC,CAAC;IACP,CAAC;IACD,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACvE,gBAAgB;IAChB,MAAM,cAAc,GAChB,WAAW,CAAC,MAAM,KAAK,CAAC;QACpB,CAAC,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE;QACvB,CAAC,CAAC;YACI,KAAK,EAAE,WAAW;SACrB,CAAC;IACZ,cAAc,CAAC,WAAW,GAAG,iBAAiB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACrE,cAAc,CAAC,cAAc,CAAC,GAAG,qCAAY,CAAC,WAAW,CAAC;IAC1D,IAAI,UAAU,EAAE,CAAC;QACb,cAAc,CAAC,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC3C,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;IACrC,CAAC;IACD,cAAc,CAAC,QAAQ,GAAG;QACtB,IAAI,EAAE,YAAY;KACrB,CAAC;IACF,OAAO,cAAc,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,QAAqB;IAC3C,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;QACzB,OAAO,QAAQ,CAAC,aAAa,CAAC;IAClC,CAAC;IACD,OAAO,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,QAAqB;IAC1C,MAAM,cAAc,GAAG,qBAAqB,CAAC,QAAQ,EAAE,2CAAkB,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnH,MAAM,aAAa,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACjD,IAAI,aAAa,IAAI,cAAc,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpD,IAAA,wBAAe,EAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,cAAc,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAC,QAAkB;IACpC,OAAO,qBAAqB,CAAC,QAAQ,EAAE,2CAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAC/E,CAAC;AAED;;;;GAIG;AACH,SAAS,mBAAmB,CAAC,WAA2B;IACpD,MAAM,WAAW,GAAuB,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACnE,OAAO;QACH,IAAI,EAAE,QAAQ;QACd,oBAAoB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE;QAClF,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE;YACN,IAAI,EAAE,EAAE;YACR,IAAI,EAAE,2CAAkB,CAAC,WAAW;SACvC;KACJ,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,GAAc,EAAE,MAAwB;IAC7D,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QAC/B,IAAI,MAAM,CAAC,IAAI,KAAK,6BAAqB,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YACnF,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,GAAc;IACzC,mFAAmF;IACnF,IAAA,8BAAgB,EAAC,GAAG,CAAC,CAAC;IACtB,MAAM,MAAM,GAAG,aAAa,EAAE,CAAC;IAC/B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IAC/B,iBAAiB;IACjB,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,yBAAiB,CAAkB,CAAC;IACxG,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE,CAAC;QAChC,MAAM,UAAU,GAAG,iBAAiB,CAChC,2CAAkB,CAAC,OAAO,EAC1B,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,sCAA8B,CAAC,EAAE,kBAAkB,CAC7D,CAAC;QACF,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;QACtC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;QACnC,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,YAAY,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC,sCAA8B,CAAC,IAAI,EAAE,CAAC;QAC5F,oBAAoB;QACpB,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAChC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;QACrE,CAAC;QACD,sBAAsB;QACtB,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;YACrC,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAC/E,CAAC;QACD,gBAAgB;QAChB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;IACD,oBAAoB;IACpB,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC7B,kBAAkB;IAClB,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,2BAAmB,CAAoB,CAAC;IAC9G,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,iBAAiB,CAChC,2CAAkB,CAAC,OAAO,EAC1B,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,sCAA8B,CAAC,EAAE,kBAAkB,CAC7D,CAAC;QACF,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;QACtC,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;QAC3C,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAChC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;QACrE,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AA/CD,wCA+CC"}

package/dist/specification/scripts/macros/types.d.ts

@@ -0,0 +1,87 @@
+export declare const SYMBOL_KIND_NAMESPACE = "namespace";
+export declare const SYMBOL_KIND_CLASS = "class";
+export declare const SYMBOL_KIND_TYPEDEF = "typedef";
+export declare const CLASS_SYMBOL_METADATA_PROPERTY = "ui5-metadata";
+export type SYMBOL_KIND = typeof SYMBOL_KIND_NAMESPACE | typeof SYMBOL_KIND_CLASS | typeof SYMBOL_KIND_TYPEDEF;
+export interface MacrosAPI {
+    symbols: UI5Symbol[];
+}
+export declare enum UI5Visibility {
+    public = "public",
+    restricted = "restricted",
+    hidden = "hidden"
+}
+export interface BaseSymbol {
+    name: string;
+    basename: string;
+    resource: string;
+    module: string;
+    static: boolean;
+    visibility: UI5Visibility;
+    description: string;
+    displayName: string;
+    title: string;
+    subTitle: string;
+    defaultAggreation?: string;
+}
+export type UI5Symbol = NamespaceSymbol | ClassSymbol | TypedefSymbol;
+export interface NamespaceSymbol extends BaseSymbol {
+    kind: typeof SYMBOL_KIND_NAMESPACE;
+    export: string;
+    nodes: [];
+}
+export interface ClassSymbol extends BaseSymbol {
+    kind: typeof SYMBOL_KIND_CLASS;
+    since?: string;
+    events?: UI5Event[];
+    [CLASS_SYMBOL_METADATA_PROPERTY]?: SymbolMetadata;
+}
+export interface TypedefSymbol extends BaseSymbol {
+    kind: typeof SYMBOL_KIND_TYPEDEF;
+    properties: UI5Property[];
+    aggregations?: UI5Aggregation[];
+}
+export interface SymbolMetadata {
+    stereotype: string;
+    properties: UI5Property[];
+    aggregations: UI5Aggregation[];
+    defaultAggregation?: string;
+}
+export interface UI5PropertyGeneric {
+    name: string;
+    description: string;
+    visibility: UI5Visibility;
+}
+export interface UI5PropertyCore extends UI5PropertyGeneric {
+    methods: string[];
+}
+export interface UI5Event {
+    name: string;
+    description: string;
+    visibility: UI5Visibility;
+}
+export interface UI5PropertyType {
+    value: string;
+}
+export interface SapFeMetadata {
+    allowedValues?: string[];
+}
+export interface UI5Metadata {
+    'sap.fe': SapFeMetadata;
+}
+export interface UI5Property extends UI5PropertyCore {
+    bindable?: boolean;
+    group: string;
+    defaultValue: unknown;
+    type?: string;
+    types?: UI5PropertyType[];
+    allowedValues?: string[];
+    'ui5-metadata'?: UI5Metadata;
+}
+export interface UI5Aggregation extends UI5PropertyCore {
+    singularName: string;
+    cardinality: string;
+    linkEnabled: true;
+    type: string | string[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/specification/scripts/macros/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../scripts/macros/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,cAAc,CAAC;AACjD,eAAO,MAAM,iBAAiB,UAAU,CAAC;AACzC,eAAO,MAAM,mBAAmB,YAAY,CAAC;AAE7C,eAAO,MAAM,8BAA8B,iBAAiB,CAAC;AAE7D,MAAM,MAAM,WAAW,GAAG,OAAO,qBAAqB,GAAG,OAAO,iBAAiB,GAAG,OAAO,mBAAmB,CAAC;AAE/G,MAAM,WAAW,SAAS;IACtB,OAAO,EAAE,SAAS,EAAE,CAAC;CACxB;AAED,oBAAY,aAAa;IACrB,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,MAAM,WAAW;CACpB;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,aAAa,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,WAAW,GAAG,aAAa,CAAC;AAEtE,MAAM,WAAW,eAAgB,SAAQ,UAAU;IAC/C,IAAI,EAAE,OAAO,qBAAqB,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,EAAE,CAAC;CACb;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC3C,IAAI,EAAE,OAAO,iBAAiB,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IACpB,CAAC,8BAA8B,CAAC,CAAC,EAAE,cAAc,CAAC;CACrD;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C,IAAI,EAAE,OAAO,mBAAmB,CAAC;IACjC,UAAU,EAAE,WAAW,EAAE,CAAC;IAC1B,YAAY,CAAC,EAAE,cAAc,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,cAAc;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,WAAW,EAAE,CAAC;IAC1B,YAAY,EAAE,cAAc,EAAE,CAAC;IAC/B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,aAAa,CAAC;CAC7B;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACvD,OAAO,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,aAAa,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC1B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IACxB,QAAQ,EAAE,aAAa,CAAC;CAC3B;AAED,MAAM,WAAW,WAAY,SAAQ,eAAe;IAChD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,eAAe,EAAE,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE,WAAW,CAAC;CAChC;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC3B"}

package/dist/specification/scripts/macros/types.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UI5Visibility = exports.CLASS_SYMBOL_METADATA_PROPERTY = exports.SYMBOL_KIND_TYPEDEF = exports.SYMBOL_KIND_CLASS = exports.SYMBOL_KIND_NAMESPACE = void 0;
+exports.SYMBOL_KIND_NAMESPACE = 'namespace';
+exports.SYMBOL_KIND_CLASS = 'class';
+exports.SYMBOL_KIND_TYPEDEF = 'typedef';
+exports.CLASS_SYMBOL_METADATA_PROPERTY = 'ui5-metadata';
+var UI5Visibility;
+(function (UI5Visibility) {
+    UI5Visibility["public"] = "public";
+    UI5Visibility["restricted"] = "restricted";
+    UI5Visibility["hidden"] = "hidden";
+})(UI5Visibility || (exports.UI5Visibility = UI5Visibility = {}));
+//# sourceMappingURL=types.js.map

package/dist/specification/scripts/macros/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../scripts/macros/types.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG,WAAW,CAAC;AACpC,QAAA,iBAAiB,GAAG,OAAO,CAAC;AAC5B,QAAA,mBAAmB,GAAG,SAAS,CAAC;AAEhC,QAAA,8BAA8B,GAAG,cAAc,CAAC;AAQ7D,IAAY,aAIX;AAJD,WAAY,aAAa;IACrB,kCAAiB,CAAA;IACjB,0CAAyB,CAAA;IACzB,kCAAiB,CAAA;AACrB,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB"}

package/dist/specification/scripts/spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=spec.d.ts.map

package/dist/specification/scripts/spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec.d.ts","sourceRoot":"","sources":["../../../scripts/spec.ts"],"names":[],"mappings":""}

package/dist/specification/scripts/spec.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const path_1 = require("path");
+const project_1 = require("../src/project");
+const src_1 = require("../src");
+var ExecutionMode;
+(function (ExecutionMode) {
+    ExecutionMode["Import"] = "import";
+})(ExecutionMode || (ExecutionMode = {}));
+/**
+ * Write a single file
+ * @param path - file path
+ * @param content - file content
+ */
+async function write(path, content) {
+    return new Promise((resolve, reject) => {
+        (0, fs_1.writeFile)(path, content, { encoding: 'utf8' }, (err) => {
+            if (err) {
+                reject(err);
+            }
+            else {
+                resolve();
+            }
+        });
+    });
+}
+/**
+ * Write files, create target directory if not exists
+ * @param directory - target directory
+ * @param files - list of files with name and content
+ */
+async function writeFiles(directory, files) {
+    for (const file of files) {
+        const path = (0, path_1.join)(directory, file.dataSourceUri);
+        const targetDir = (0, path_1.dirname)(path);
+        if (!(await (0, project_1.isDirectory)(targetDir))) {
+            (0, fs_1.mkdirSync)(targetDir, { recursive: true });
+        }
+        await write((0, path_1.join)(directory, file.dataSourceUri), file.fileContent);
+    }
+}
+/**
+ * Format the resulting files as string
+ * @param files - list of files as {dataSourceUri: string, fileContent: string}
+ */
+const formatterFileContent = (files) => files.reduce((result, file) => result + `\nFile: '${file.dataSourceUri}':\n${file.fileContent}`, '');
+/**
+ * Get config and schemas from project
+ * @param projectRoot - root of the project where package.json is located
+ */
+async function importFiles(projectRoot, outputPath) {
+    const { annotations, manifest, changes: flex } = await (0, project_1.getProject)(projectRoot);
+    let resultString = '';
+    const files = await (0, src_1.importProject)({
+        annotations,
+        manifest,
+        flex
+    });
+    if (outputPath) {
+        writeFiles(outputPath, files);
+        resultString = `Files written to '${outputPath}'`;
+    }
+    else {
+        resultString = formatterFileContent(files);
+    }
+    return resultString;
+}
+/**
+ * Parse the command line parameters
+ * @param args - content of process.argv
+ */
+async function getParameters(args) {
+    if (process.argv.length > 3) {
+        const [mode, projectRoot, ...commandArgs] = args.slice(2);
+        if (mode !== "import" /* ExecutionMode.Import */) {
+            throw Error(`Unkown mode: '${mode}'. Please use '${"import" /* ExecutionMode.Import */}'`);
+        }
+        if (!(await (0, project_1.isDirectory)(projectRoot))) {
+            throw Error(`Directory '${projectRoot}' doesn't exist.`);
+        }
+        const outputPath = commandArgs.find((arg) => arg.toLowerCase().startsWith('--output='))?.substring(9);
+        return {
+            mode: "import" /* ExecutionMode.Import */,
+            projectRoot,
+            outputPath
+        };
+    }
+    throw Error(`Usage: ${(0, path_1.basename)(args[0])} ${(0, path_1.basename)(args[1])} import <PROJECT_ROOT_PATH> [--output=<PATH>]`);
+}
+/**
+ * Run the required execution mode, e.g. import a project
+ * @param argv - command line arguments as string array
+ */
+async function run(argv) {
+    const parameters = await getParameters(argv);
+    switch (parameters.mode) {
+        case "import" /* ExecutionMode.Import */: {
+            const result = await importFiles(parameters.projectRoot, parameters.outputPath);
+            console.log(result);
+            break;
+        }
+        default: {
+            break;
+        }
+    }
+}
+/**
+ * Usage through command line
+ * node spec.js import <PROJECT_ROOT_PATH> [--output=<PATH>]
+ */
+run(process.argv).catch((e) => console.error(e.message));
+//# sourceMappingURL=spec.js.map

package/dist/specification/scripts/spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec.js","sourceRoot":"","sources":["../../../scripts/spec.ts"],"names":[],"mappings":";;AAAA,2BAA0C;AAC1C,+BAA+C;AAC/C,4CAAyD;AAEzD,gCAAuC;AAOvC,IAAW,aAEV;AAFD,WAAW,aAAa;IACpB,kCAAiB,CAAA;AACrB,CAAC,EAFU,aAAa,KAAb,aAAa,QAEvB;AAED;;;;GAIG;AACH,KAAK,UAAU,KAAK,CAAC,IAAY,EAAE,OAAe;IAC9C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAQ,EAAE;QACzC,IAAA,cAAS,EAAC,IAAI,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,EAAQ,EAAE;YACzD,IAAI,GAAG,EAAE,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACJ,OAAO,EAAE,CAAC;YACd,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,UAAU,CAAC,SAAiB,EAAE,KAAa;IACtD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,CAAC,MAAM,IAAA,qBAAW,EAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAClC,IAAA,cAAS,EAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,KAAK,CAAC,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACvE,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAU,EAAE,CACnD,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,GAAG,YAAY,IAAI,CAAC,aAAa,OAAO,IAAI,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;AAEzG;;;GAGG;AACH,KAAK,UAAU,WAAW,CAAC,WAAmB,EAAE,UAAmB;IAC/D,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,IAAA,oBAAU,EAAC,WAAW,CAAC,CAAC;IAC/E,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAa,EAAC;QAC9B,WAAW;QACX,QAAQ;QACR,IAAI;KACP,CAAC,CAAC;IACH,IAAI,UAAU,EAAE,CAAC;QACb,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAC9B,YAAY,GAAG,qBAAqB,UAAU,GAAG,CAAC;IACtD,CAAC;SAAM,CAAC;QACJ,YAAY,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,YAAY,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,aAAa,CAAC,IAAc;IACvC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1D,IAAI,IAAI,wCAAyB,EAAE,CAAC;YAChC,MAAM,KAAK,CAAC,iBAAiB,IAAI,kBAAkB,mCAAoB,GAAG,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,IAAA,qBAAW,EAAC,WAAW,CAAC,CAAC,EAAE,CAAC;YACpC,MAAM,KAAK,CAAC,cAAc,WAAW,kBAAkB,CAAC,CAAC;QAC7D,CAAC;QACD,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QACtG,OAAO;YACH,IAAI,qCAAsB;YAC1B,WAAW;YACX,UAAU;SACb,CAAC;IACN,CAAC;IACD,MAAM,KAAK,CAAC,UAAU,IAAA,eAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAA,eAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,+CAA+C,CAAC,CAAC;AACjH,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,GAAG,CAAC,IAAc;IAC7B,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7C,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;QACtB,wCAAyB,CAAC,CAAC,CAAC;YACxB,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;YAChF,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM;QACV,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACN,MAAM;QACV,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC"}

package/dist/specification/scripts/to-json-schema.d.ts

@@ -0,0 +1,11 @@
+import { FioriElementsVersion } from '@sap/ux-specification-types';
+export type Schema = {
+    [name: string]: object;
+};
+/**
+ * Convert interfaces to json schema
+ * @param path - path to interfaces
+ * @param files - file names, filename must match the main symbol (interface) in the content of the file
+ */
+export declare function convertInterfaces(path: string, files: string[], version: FioriElementsVersion): Schema[];
+//# sourceMappingURL=to-json-schema.d.ts.map

package/dist/specification/scripts/to-json-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-json-schema.d.ts","sourceRoot":"","sources":["../../../scripts/to-json-schema.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAGnE,MAAM,MAAM,MAAM,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AA2BhD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,GAAG,MAAM,EAAE,CA4BxG"}