@sap/ux-specification 1.90.5 → 1.90.9

package/dist/scripts/extractDocu.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/scripts/extractDocu.js

@@ -0,0 +1,311 @@
+"use strict";
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * This script extracts all existing documentation (i.e. descriptions) from the generic schemas of a certain OData version (V2 or V4).
+ * All descriptions are collected in an Excel sheet that you afterwards can find under dist/documentation: it is named Specificationv2.xslx or Specificationv4.xslx, depending on the chosen version.
+ * You can find one worksheet for each generic schema file.
+ *
+ * The script expects that you supply an argument --version with either v2 or v4.
+ * You can also start it from one of the debugger scripts named in launch.json: "Extract V2 documentation" or "Extract V4 documentation".
+ */
+const page_1 = require("../src/specification/common/page");
+const path_1 = require("path");
+const fs = __importStar(require("fs"));
+const excel = __importStar(require("excel4node"));
+/**
+ * Handles reference ($ref) within the schema, finds the corresponding definition
+ * @param schema - Object representing the whole generic schema
+ * @param reference - Content for the $ref property
+ * @param output - Array of descriptions with assigned hierarchy elements, all separated by ';' (csv like)
+ * @param definition - The current hierarchy element (list of path parts separated by ';')
+ */
+function dereference(schema, reference, output, definition, description) {
+    const currentDefinition = reference.split('#/definitions/')[1];
+    try {
+        parseSchema(schema, schema['definitions'][currentDefinition], output, definition, description);
+    }
+    catch (error) {
+        console.log(error);
+    }
+}
+/**
+ * Handles one property of a sub-schema
+ * @param schema - Object representing the whole generic schema
+ * @param subSchema - Object representing the current sub-structure of the schema
+ * @param property - Name of the property ithin the subSchema
+ * @param output  - Array of descriptions with assigned hierarchy elements, all separated by ';' (csv like)
+ * @param definition - The current hierarchy element (list of path parts separated by ';')
+ */
+function processElement(schema, subSchema, property, output, definition) {
+    if (['$schema', 'id', 'pages', 'home', 'custom', '1', '2', '3', '4', '5', '6', '7', '8', '9'].includes(property)) {
+        return;
+    }
+    const element = subSchema[property];
+    definition = definition ? definition + ';' + property : property;
+    if (property === 'columns') {
+        definition = definition + ';columnId';
+    }
+    if (property === 'sections') {
+        definition = definition + ';sectionId';
+    }
+    if (property === 'cards') {
+        definition = definition + ';cardKey';
+    }
+    if (element['description'] !== undefined) {
+        if (element['$ref'] !== undefined) {
+            dereference(schema, element['$ref'], output, definition, element['description']);
+            return;
+        }
+        else if (element['anyOf'] !== undefined) {
+            handleAnyOf(schema, element['anyOf'], output, definition, element['description']);
+            return;
+        }
+        if (element['type'] !== undefined && element['items']) {
+            const reference = element['items']['$ref'] || (element['items'][0] && element['items'][0]['$ref']);
+            if (reference) {
+                dereference(schema, reference, output, definition, element['description']);
+            }
+            else {
+                output.push(definition + ';' + `TYPE_${element['type']}` + ';' + element['description']);
+            }
+            return;
+        }
+        if (element['type'] !== undefined) {
+            output.push(definition + ';' + `TYPE_${element['type']}` + ';' + element['description']);
+        }
+    }
+    // Temporary as Description is not maintained for some properties - description should be added
+    if (!element['description'] && element['type'] !== undefined) {
+        output.push(definition + ';' + `TYPE_${element['type']}`);
+    }
+    if (element['$ref'] !== undefined) {
+        dereference(schema, element['$ref'], output, definition);
+    }
+    else {
+        parseSchema(schema, element, output, definition);
+    }
+}
+/**
+ * Special handing of anyOf elements of a JSON schema
+ * @param schema - Object representing the whole generic schema
+ * @param anyOfSchema - Object representing the current sub-structure of the schema
+ * @param output - Array of descriptions with assigned hierarchy elements, all separated by ';' (csv like)
+ * @param definition - The current hierarchy element (list of path parts separated by ';')
+ */
+function handleAnyOf(schema, anyOfSchema, output, definition, description) {
+    for (let index = 0; index < anyOfSchema.length; index++) {
+        const element = anyOfSchema[index];
+        if (Object.keys(element)[0] === '$ref') {
+            dereference(schema, element['$ref'], output, definition);
+        }
+        else {
+            parseSchema(schema, element, output, definition, description);
+        }
+    }
+}
+/**
+ * Parses a sub-structure of the schema
+ * @param schema - Object representing the whole generic schema
+ * @param subSchema - Object representing the current sub-structure of the schema
+ * @param output - Array of descriptions with assigned hierarchy elements, all separated by ';' (csv like)
+ * @param definition - The current hierarchy element (list of path parts separated by ';')
+ */
+function parseSchema(schema, subSchema, output, definition, description) {
+    if (Object.keys(subSchema) && Object.keys(subSchema)[0] === 'anyOf') {
+        handleAnyOf(schema, subSchema['anyOf'], output, definition);
+        return;
+    }
+    for (const property in subSchema['properties']) {
+        if (property === '$ref') {
+            dereference(schema, subSchema['properties']['$ref'], output, definition);
+        }
+        else if (property === 'anyOf') {
+            handleAnyOf(schema, subSchema['properties']['anyOf'], output, definition);
+        }
+        else {
+            processElement(schema, subSchema['properties'], property, output, definition);
+        }
+    }
+    for (const property in subSchema['patternProperties']) {
+        if (property === '$ref') {
+            dereference(schema, subSchema['patternProperties']['$ref'], output, definition);
+        }
+        else if (property === 'anyOf') {
+            handleAnyOf(schema, subSchema['patternProperties']['anyOf'], output, definition);
+        }
+        else {
+            processElement(schema, subSchema['patternProperties'], property, output, definition);
+        }
+    }
+    for (const property in subSchema['additionalProperties']) {
+        if (property === '$ref') {
+            dereference(schema, subSchema['additionalProperties']['$ref'], output, definition);
+        }
+        else if (property === 'anyOf') {
+            handleAnyOf(schema, subSchema['additionalProperties']['anyOf'], output, definition);
+        }
+        else {
+            processElement(schema, subSchema['additionalProperties'], property, output, definition);
+        }
+    }
+    if (subSchema['enum'] && description) {
+        output.push(definition + ';' + `TYPE_${[subSchema['enum'].join('|')]}` + ';' + description);
+    }
+    else if (subSchema['type'] && description) {
+        output.push(definition + ';' + `TYPE_${subSchema['type']}` + ';' + description);
+    }
+}
+/**
+ * Fills an excel4node workbook based on csv like information
+ * @param workbook - Excel workbook (excel4node format)
+ * @param output - Array of descriptions with assigned hierarchy elements, all separated by ';' (csv like)
+ * @param file - file name of the original schema
+ */
+function writeToExcel(workbook, output, file) {
+    //filter output to remove duplicated lines due to different table types (anyOf)
+    output = output.filter((e, i, a) => a.indexOf(e) === i);
+    const sheetName = file.split('.')[0];
+    const worksheet = workbook.addWorksheet(sheetName);
+    worksheet.headerFooter = { evenHeader: output[0] };
+    // Create a reusable style
+    const style = workbook.createStyle({
+        font: {
+            //color: '#800000',
+            size: 12
+        },
+        numberFormat: '$#,##0.00; ($#,##0.00); -'
+    });
+    for (let rowIndex = 1; rowIndex < output.length; rowIndex++) {
+        const element = output[rowIndex];
+        const cellArray = element.split(';');
+        for (let cellIndex = 0; cellIndex < cellArray.length; cellIndex++) {
+            const cell = cellArray[cellIndex];
+            worksheet
+                .cell(rowIndex, cellIndex + 1)
+                .string(cell)
+                .style(style);
+        }
+    }
+}
+function generateIxiaSoftFormat(output, file, version) {
+    //filter output to remove duplicated lines due to different table types (anyOf)
+    output = output.filter((e, i, a) => a.indexOf(e) === i);
+    let iXiaFormat = `<simpletable frame="all" relcolwidth="1* 1*" id="simpletable_uqj_klr_jlb">
+        <sthead>
+            <stentry> Settings </stentry>
+            <stentry> Description </stentry>
+        </sthead>
+    `;
+    const fileName = file.split('.')[0];
+    for (let rowIndex = 1; rowIndex < output.length; rowIndex++) {
+        const element = output[rowIndex];
+        const cellArray = element.split(';');
+        let setting = '{';
+        iXiaFormat = iXiaFormat + `\t<strow>\n`;
+        for (let cellIndex = 0; cellIndex < cellArray.length - 1; cellIndex++) {
+            let cell = cellArray[cellIndex];
+            if (['0', '1'].includes(cell)) {
+                cell = 'variantKey' + cell;
+            }
+            if (cellArray[cellIndex + 1].includes('TYPE')) {
+                setting = setting + `"${cell}": ${cellArray[cellIndex + 1].split('_')[1]}`;
+                let noOfOpeningBraces = setting.match(/{/g).length;
+                while (noOfOpeningBraces > 0) {
+                    setting = setting + '}';
+                    noOfOpeningBraces--;
+                }
+                iXiaFormat = iXiaFormat + `\t\t<stentry> ${setting} </stentry>\n`;
+            }
+            else {
+                setting = setting + `"${cell}": {`;
+            }
+        }
+        // add description to the table
+        iXiaFormat = iXiaFormat + `\t\t<stentry> ${cellArray[cellArray.length - 1]} </stentry>\n\t</strow>\n`;
+    }
+    iXiaFormat = iXiaFormat + `</simpletable>`;
+    const outDir = path_1.join('dist', 'documentation');
+    if (!fs.existsSync(outDir)) {
+        fs.mkdirSync(outDir);
+    }
+    const outFile = path_1.join(outDir, 'Specification' + version + fileName + '.txt');
+    fs.writeFile(outFile, iXiaFormat, (err) => {
+        if (err)
+            throw err;
+        console.log(`${outFile} was succesfully saved!`);
+    });
+}
+/**
+ * Writes an Excel workbook to a file in the dist/documentation folder.
+ * @param workbook - Excel workbook (excel4node format)
+ * @param version - OData version
+ */
+function writeToFile(workbook, version) {
+    const outDir = path_1.join('dist', 'documentation');
+    if (!fs.existsSync(outDir)) {
+        fs.mkdirSync(outDir);
+    }
+    const outFile = path_1.join(outDir, 'Specification' + version + '.xlsx');
+    workbook.write(outFile);
+}
+/********************** Main ***************************/
+function generateDocmentation() {
+    const myArgs = process.argv.slice(2);
+    let version;
+    let format;
+    myArgs.forEach((arg) => {
+        const value = arg.split('=')[1];
+        if (arg.includes('version')) {
+            version = value;
+        }
+        else if (arg.includes('format')) {
+            format = value;
+        }
+    });
+    let directoryPath = '';
+    switch (version) {
+        case page_1.FioriElementsVersion.v2:
+            directoryPath = path_1.join('schemas', 'v2');
+            break;
+        case page_1.FioriElementsVersion.v4:
+            directoryPath = path_1.join('schemas', 'v4');
+            break;
+        default:
+            console.log('Invalid version ' + version + '; processing stopped.');
+            break;
+    }
+    if (directoryPath.length > 0) {
+        const workbook = new excel.Workbook();
+        fs.readdir(directoryPath, function (err, files) {
+            if (err) {
+                return console.log(err);
+            }
+            files.forEach((file) => {
+                const filePath = path_1.join(directoryPath, file);
+                const output = [filePath];
+                const data = fs.readFileSync(filePath, 'utf8');
+                const schema = JSON.parse(data);
+                parseSchema(schema, schema, output);
+                //console.log(output);
+                if (format === 'excel') {
+                    writeToExcel(workbook, output, file);
+                }
+                if (format === 'iXiaSoft') {
+                    generateIxiaSoftFormat(output, file, version);
+                }
+            });
+            if (format === 'excel') {
+                writeToFile(workbook, version);
+            }
+        });
+    }
+}
+generateDocmentation();
+//# sourceMappingURL=extractDocu.js.map

package/dist/scripts/extractDocu.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractDocu.js","sourceRoot":"","sources":["../../scripts/extractDocu.ts"],"names":[],"mappings":";;;;;;;;;AAAA;;;;;;;GAOG;AACH,2DAAwE;AACxE,+BAA4B;AAC5B,uCAAyB;AACzB,kDAAoC;AAEpC;;;;;;GAMG;AACH,SAAS,WAAW,CAChB,MAAc,EACd,SAAiB,EACjB,MAAgB,EAChB,UAAmB,EACnB,WAAoB;IAEpB,MAAM,iBAAiB,GAAG,SAAS,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,IAAI;QACA,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;KAClG;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;KACtB;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,cAAc,CACnB,MAAc,EACd,SAAiB,EACjB,QAAgB,EAChB,MAAgB,EAChB,UAAmB;IAEnB,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QAC9G,OAAO;KACV;IACD,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;IACpC,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;IACjE,IAAI,QAAQ,KAAK,SAAS,EAAE;QACxB,UAAU,GAAG,UAAU,GAAG,WAAW,CAAC;KACzC;IACD,IAAI,QAAQ,KAAK,UAAU,EAAE;QACzB,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;KAC1C;IACD,IAAI,QAAQ,KAAK,OAAO,EAAE;QACtB,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;KACxC;IACD,IAAI,OAAO,CAAC,aAAa,CAAC,KAAK,SAAS,EAAE;QACtC,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;YAC/B,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;YACjF,OAAO;SACV;aAAM,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE;YACvC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;YAClF,OAAO;SACV;QACD,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YACnD,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YACnG,IAAI,SAAS,EAAE;gBACX,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;aAC9E;iBAAM;gBACH,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,GAAG,GAAG,QAAQ,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;aAC5F;YACD,OAAO;SACV;QACD,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;YAC/B,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,GAAG,GAAG,QAAQ,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;SAC5F;KACJ;IAED,+FAA+F;IAC/F,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;QAC1D,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,GAAG,GAAG,QAAQ,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;KAC7D;IACD,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;QAC/B,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;KAC5D;SAAM;QACH,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;KACpD;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAChB,MAAc,EACd,WAAqB,EACrB,MAAgB,EAChB,UAAmB,EACnB,WAAoB;IAEpB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QACrD,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;YACpC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SAC5D;aAAM;YACH,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;SACjE;KACJ;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAChB,MAAc,EACd,SAAiB,EACjB,MAAgB,EAChB,UAAmB,EACnB,WAAoB;IAEpB,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE;QACjE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QAC5D,OAAO;KACV;IACD,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,YAAY,CAAC,EAAE;QAC5C,IAAI,QAAQ,KAAK,MAAM,EAAE;YACrB,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SAC5E;aAAM,IAAI,QAAQ,KAAK,OAAO,EAAE;YAC7B,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SAC7E;aAAM;YACH,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SACjF;KACJ;IACD,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,mBAAmB,CAAC,EAAE;QACnD,IAAI,QAAQ,KAAK,MAAM,EAAE;YACrB,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SACnF;aAAM,IAAI,QAAQ,KAAK,OAAO,EAAE;YAC7B,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SACpF;aAAM;YACH,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,mBAAmB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SACxF;KACJ;IACD,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,sBAAsB,CAAC,EAAE;QACtD,IAAI,QAAQ,KAAK,MAAM,EAAE;YACrB,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,sBAAsB,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SACtF;aAAM,IAAI,QAAQ,KAAK,OAAO,EAAE;YAC7B,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,sBAAsB,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SACvF;aAAM;YACH,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,sBAAsB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;SAC3F;KACJ;IACD,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,WAAW,EAAE;QAClC,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,WAAW,CAAC,CAAC;KAC/F;SAAM,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,WAAW,EAAE;QACzC,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,GAAG,GAAG,QAAQ,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,GAAG,WAAW,CAAC,CAAC;KACnF;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,QAAa,EAAE,MAAgB,EAAE,IAAY;IAC/D,+EAA+E;IAC/E,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,MAAM,SAAS,GAAG,QAAQ,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACnD,SAAS,CAAC,YAAY,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IACnD,0BAA0B;IAC1B,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC;QAC/B,IAAI,EAAE;YACF,mBAAmB;YACnB,IAAI,EAAE,EAAE;SACX;QACD,YAAY,EAAE,2BAA2B;KAC5C,CAAC,CAAC;IACH,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;QACzD,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjC,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,KAAK,IAAI,SAAS,GAAG,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE;YAC/D,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;YAClC,SAAS;iBACJ,IAAI,CAAC,QAAQ,EAAE,SAAS,GAAG,CAAC,CAAC;iBAC7B,MAAM,CAAC,IAAI,CAAC;iBACZ,KAAK,CAAC,KAAK,CAAC,CAAC;SACrB;KACJ;AACL,CAAC;AAED,SAAS,sBAAsB,CAAC,MAAgB,EAAE,IAAY,EAAE,OAAe;IAC3E,+EAA+E;IAC/E,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,IAAI,UAAU,GAAG;;;;;KAKhB,CAAC;IACF,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;QACzD,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjC,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,OAAO,GAAG,GAAG,CAAC;QAClB,UAAU,GAAG,UAAU,GAAG,aAAa,CAAC;QACxC,KAAK,IAAI,SAAS,GAAG,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,SAAS,EAAE,EAAE;YACnE,IAAI,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC3B,IAAI,GAAG,YAAY,GAAG,IAAI,CAAC;aAC9B;YACD,IAAI,SAAS,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBAC3C,OAAO,GAAG,OAAO,GAAG,IAAI,IAAI,MAAM,SAAS,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3E,IAAI,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;gBACnD,OAAO,iBAAiB,GAAG,CAAC,EAAE;oBAC1B,OAAO,GAAG,OAAO,GAAG,GAAG,CAAC;oBACxB,iBAAiB,EAAE,CAAC;iBACvB;gBACD,UAAU,GAAG,UAAU,GAAG,iBAAiB,OAAO,eAAe,CAAC;aACrE;iBAAM;gBACH,OAAO,GAAG,OAAO,GAAG,IAAI,IAAI,MAAM,CAAC;aACtC;SACJ;QACD,+BAA+B;QAC/B,UAAU,GAAG,UAAU,GAAG,iBAAiB,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,2BAA2B,CAAC;KACzG;IACD,UAAU,GAAG,UAAU,GAAG,gBAAgB,CAAC;IAE3C,MAAM,MAAM,GAAG,WAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC7C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QACxB,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;KACxB;IACD,MAAM,OAAO,GAAG,WAAI,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC;IAC5E,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;QACtC,IAAI,GAAG;YAAE,MAAM,GAAG,CAAC;QACnB,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,yBAAyB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,QAAa,EAAE,OAAe;IAC/C,MAAM,MAAM,GAAG,WAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC7C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QACxB,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;KACxB;IACD,MAAM,OAAO,GAAG,WAAI,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC;IAClE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED,yDAAyD;AACzD,SAAS,oBAAoB;IACzB,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACrC,IAAI,OAAe,CAAC;IACpB,IAAI,MAAc,CAAC;IACnB,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;YACzB,OAAO,GAAG,KAAK,CAAC;SACnB;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC/B,MAAM,GAAG,KAAK,CAAC;SAClB;IACL,CAAC,CAAC,CAAC;IACH,IAAI,aAAa,GAAG,EAAE,CAAC;IACvB,QAAQ,OAAO,EAAE;QACb,KAAK,2BAAoB,CAAC,EAAE;YACxB,aAAa,GAAG,WAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM;QACV,KAAK,2BAAoB,CAAC,EAAE;YACxB,aAAa,GAAG,WAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM;QACV;YACI,OAAO,CAAC,GAAG,CAAC,kBAAkB,GAAG,OAAO,GAAG,uBAAuB,CAAC,CAAC;YACpE,MAAM;KACb;IACD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1B,MAAM,QAAQ,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACtC,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,UAAS,GAAG,EAAE,KAAK;YACzC,IAAI,GAAG,EAAE;gBACL,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;aAC3B;YACD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACnB,MAAM,QAAQ,GAAG,WAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;gBAC3C,MAAM,MAAM,GAAa,CAAC,QAAQ,CAAC,CAAC;gBACpC,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAChC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;gBACpC,sBAAsB;gBACtB,IAAI,MAAM,KAAK,OAAO,EAAE;oBACpB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;iBACxC;gBACD,IAAI,MAAM,KAAK,UAAU,EAAE;oBACvB,sBAAsB,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;iBACjD;YACL,CAAC,CAAC,CAAC;YACH,IAAI,MAAM,KAAK,OAAO,EAAE;gBACpB,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAClC;QACL,CAAC,CAAC,CAAC;KACN;AACL,CAAC;AAED,oBAAoB,EAAE,CAAC"}

package/dist/scripts/spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/scripts/spec.js

@@ -0,0 +1,114 @@
+"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) => {
+        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 = path_1.join(directory, file.dataSourceUri);
+        const targetDir = path_1.dirname(path);
+        if (!(await project_1.isDirectory(targetDir))) {
+            fs_1.mkdirSync(targetDir, { recursive: true });
+        }
+        await write(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 project_1.getProject(projectRoot);
+    let resultString = '';
+    const files = await 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) {
+    var _a;
+    if (process.argv.length > 3) {
+        const [mode, projectRoot, ...commandArgs] = args.slice(2);
+        if (mode !== "import" /* Import */) {
+            throw Error(`Unkown mode: '${mode}'. Please use '${"import" /* Import */}'`);
+        }
+        if (!(await project_1.isDirectory(projectRoot))) {
+            throw Error(`Directory '${projectRoot}' doesn't exist.`);
+        }
+        const outputPath = (_a = commandArgs.find((arg) => arg.toLowerCase().startsWith('--output='))) === null || _a === void 0 ? void 0 : _a.substring(9);
+        return {
+            mode: "import" /* Import */,
+            projectRoot,
+            outputPath
+        };
+    }
+    throw Error(`Usage: ${path_1.basename(args[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" /* 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/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;AACzD,gCAA6C;AAO7C,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,cAAS,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,EAAQ,EAAE;YACzD,IAAI,GAAG,EAAE;gBACL,MAAM,CAAC,GAAG,CAAC,CAAC;aACf;iBAAM;gBACH,OAAO,EAAE,CAAC;aACb;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;QACtB,MAAM,IAAI,GAAG,WAAI,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,cAAO,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,CAAC,MAAM,qBAAW,CAAC,SAAS,CAAC,CAAC,EAAE;YACjC,cAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;SAC7C;QACD,MAAM,KAAK,CAAC,WAAI,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;KACtE;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,oBAAU,CAAC,WAAW,CAAC,CAAC;IAC/E,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,MAAM,KAAK,GAAG,MAAM,mBAAa,CAAC;QAC9B,WAAW;QACX,QAAQ;QACR,IAAI;KACP,CAAC,CAAC;IACH,IAAI,UAAU,EAAE;QACZ,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAC9B,YAAY,GAAG,qBAAqB,UAAU,GAAG,CAAC;KACrD;SAAM;QACH,YAAY,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;KAC9C;IACD,OAAO,YAAY,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,aAAa,CAAC,IAAc;;IACvC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACzB,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1D,IAAI,IAAI,0BAAyB,EAAE;YAC/B,MAAM,KAAK,CAAC,iBAAiB,IAAI,kBAAkB,qBAAoB,GAAG,CAAC,CAAC;SAC/E;QACD,IAAI,CAAC,CAAC,MAAM,qBAAW,CAAC,WAAW,CAAC,CAAC,EAAE;YACnC,MAAM,KAAK,CAAC,cAAc,WAAW,kBAAkB,CAAC,CAAC;SAC5D;QACD,MAAM,UAAU,SAAG,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,0CAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QACtG,OAAO;YACH,IAAI,uBAAsB;YAC1B,WAAW;YACX,UAAU;SACb,CAAC;KACL;IACD,MAAM,KAAK,CAAC,UAAU,eAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,eAAQ,CAAC,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;QACrB,0BAAyB,CAAC,CAAC;YACvB,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;SACT;QACD,OAAO,CAAC,CAAC;YACL,MAAM;SACT;KACJ;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/scripts/to-json-schema.d.ts

@@ -0,0 +1,10 @@
+import { FioriElementsVersion } from '../src/specification/common';
+export declare 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[];