@sap-ux/odata-service-writer 0.9.8 → 0.11.0

package/dist/data/annotations.d.ts

@@ -0,0 +1,11 @@
+import { NamespaceAlias, OdataService } from '../types';
+/**
+ * Returns the namespaces parsed from the specified metadata and annotations.
+ *
+ * @param {Partial<OdataService>} service - an odata service where at least metadata and annotations properties are defined
+ * @param {string} service.metadata - OData service metadata xml
+ * @param {string} service.annotations - OData service annotations xml
+ * @returns A reference to the namspaces array
+ */
+export declare function getAnnotationNamespaces({ metadata, annotations }: Partial<OdataService>): NamespaceAlias[];
+//# sourceMappingURL=annotations.d.ts.map

package/dist/data/annotations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../../src/data/annotations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExD;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,cAAc,EAAE,CAmB1G"}

package/dist/data/annotations.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAnnotationNamespaces = void 0;
+const fast_xml_parser_1 = require("fast-xml-parser");
+const i18n_1 = require("../i18n");
+/**
+ * Returns the namespaces parsed from the specified metadata and annotations.
+ *
+ * @param {Partial<OdataService>} service - an odata service where at least metadata and annotations properties are defined
+ * @param {string} service.metadata - OData service metadata xml
+ * @param {string} service.annotations - OData service annotations xml
+ * @returns A reference to the namspaces array
+ */
+function getAnnotationNamespaces({ metadata, annotations }) {
+    // Enhance service with annotations namespaces
+    const schemaNamespaces = metadata ? getNamespaces(metadata) : [];
+    if (annotations === null || annotations === void 0 ? void 0 : annotations.xml) {
+        // Parse once
+        const annotationsJson = xmlToJson(annotations.xml);
+        return schemaNamespaces.map((schema) => {
+            // Check if alias exists in backend annotation file, if so use it
+            const annotationAlias = annotations.xml && schema.namespace ? getAliasFromAnnotation(annotationsJson, schema.namespace) : '';
+            if (annotationAlias) {
+                schema.alias = annotationAlias;
+            }
+            return schema;
+        });
+    }
+    return schemaNamespaces;
+}
+exports.getAnnotationNamespaces = getAnnotationNamespaces;
+/**
+ * Convert specified xml string to JSON.
+ *
+ * @param xml - the schema to parse
+ * @returns parsed object representation of passed XML
+ */
+function xmlToJson(xml) {
+    const options = {
+        attributeNamePrefix: '',
+        ignoreAttributes: false,
+        ignoreNameSpace: true,
+        parseAttributeValue: true
+    };
+    try {
+        const parser = new fast_xml_parser_1.XMLParser(options);
+        return parser.parse(xml, true);
+    }
+    catch (error) {
+        throw new Error((0, i18n_1.t)('error.unparseableXML', { error }));
+    }
+}
+/**
+ * Gets all the schema namespaces and their aliases from the provided metadata.
+ *
+ * @param metadata - odata service metadata
+ * @returns Array of namespaces and their aliases
+ */
+function getNamespaces(metadata) {
+    var _a, _b;
+    const jsonMetadata = xmlToJson(metadata);
+    let schema = (_b = (_a = jsonMetadata['edmx:Edmx']) === null || _a === void 0 ? void 0 : _a['edmx:DataServices']) === null || _b === void 0 ? void 0 : _b['Schema'];
+    if (!schema) {
+        return [];
+    }
+    // Can be array or single item
+    if (!Array.isArray(schema)) {
+        schema = [schema];
+    }
+    return schema.map((item) => {
+        return {
+            namespace: item.Namespace,
+            alias: item.Alias || ''
+        };
+    });
+}
+/**
+ * Gets namespace aliases from the specified annotations xml.
+ *
+ * @param annotations - annotations definition as json
+ * @param namespace - the namespace to search
+ * @returns An alias for the specified namespace or empty string
+ */
+function getAliasFromAnnotation(annotations, namespace) {
+    var _a, _b;
+    let references = (_a = annotations['edmx:Edmx']) === null || _a === void 0 ? void 0 : _a['edmx:Reference'];
+    // Can be array or single item
+    if (!Array.isArray(references)) {
+        references = [references];
+    }
+    const annoNamespace = references.find((ref) => { var _a, _b; return ((_a = ref['edmx:Include']) === null || _a === void 0 ? void 0 : _a['Namespace']) === namespace && ((_b = ref['edmx:Include']) === null || _b === void 0 ? void 0 : _b['Alias']); });
+    return annoNamespace ? (_b = annoNamespace['edmx:Include']) === null || _b === void 0 ? void 0 : _b['Alias'] : '';
+}
+//# sourceMappingURL=annotations.js.map

package/dist/data/annotations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotations.js","sourceRoot":"","sources":["../../src/data/annotations.ts"],"names":[],"mappings":";;;AAAA,qDAA4C;AAC5C,kCAA4B;AAG5B;;;;;;;GAOG;AACH,SAAgB,uBAAuB,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAyB;IACpF,8CAA8C;IAC9C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAEjE,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,EAAE;QAClB,aAAa;QACb,MAAM,eAAe,GAAW,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAE3D,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAsB,EAAE,EAAE;YACnD,iEAAiE;YACjE,MAAM,eAAe,GACjB,WAAW,CAAC,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,eAAe,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACzG,IAAI,eAAe,EAAE;gBACjB,MAAM,CAAC,KAAK,GAAG,eAAe,CAAC;aAClC;YACD,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;KACN;IACD,OAAO,gBAAgB,CAAC;AAC5B,CAAC;AAnBD,0DAmBC;AAED;;;;;GAKG;AACH,SAAS,SAAS,CAAC,GAAW;IAC1B,MAAM,OAAO,GAAG;QACZ,mBAAmB,EAAE,EAAE;QACvB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,IAAI;QACrB,mBAAmB,EAAE,IAAI;KAC5B,CAAC;IAEF,IAAI;QACA,MAAM,MAAM,GAAG,IAAI,2BAAS,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;KAClC;IAAC,OAAO,KAAK,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,IAAA,QAAC,EAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;KACzD;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,QAAgB;;IACnC,MAAM,YAAY,GAAW,SAAS,CAAC,QAAQ,CAAC,CAAC;IACjD,IAAI,MAAM,GAAG,MAAA,MAAA,YAAY,CAAC,WAAW,CAAC,0CAAG,mBAAmB,CAAC,0CAAG,QAAQ,CAAC,CAAC;IAE1E,IAAI,CAAC,MAAM,EAAE;QACT,OAAO,EAAE,CAAC;KACb;IAED,8BAA8B;IAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACxB,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;KACrB;IAED,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACvB,OAAO;YACH,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;SAC1B,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;GAMG;AACH,SAAS,sBAAsB,CAAC,WAAmB,EAAE,SAAiB;;IAClE,IAAI,UAAU,GAAG,MAAA,WAAW,CAAC,WAAW,CAAC,0CAAG,gBAAgB,CAAC,CAAC;IAE9D,8BAA8B;IAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;QAC5B,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC;KAC7B;IAED,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,CACjC,CAAC,GAAG,EAAE,EAAE,eAAC,OAAA,CAAA,MAAA,GAAG,CAAC,cAAc,CAAC,0CAAG,WAAW,CAAC,MAAK,SAAS,KAAI,MAAA,GAAG,CAAC,cAAc,CAAC,0CAAG,OAAO,CAAC,CAAA,CAAA,EAAA,CAC9F,CAAC;IACF,OAAO,aAAa,CAAC,CAAC,CAAC,MAAA,aAAa,CAAC,cAAc,CAAC,0CAAG,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACzE,CAAC"}

package/dist/data/defaults.d.ts

@@ -3,7 +3,7 @@ import { OdataService } from '../types';
  * Enhances the provided OData service object with path, name and model information.
  * Directly modifies the passed object reference.
  *
- * @param {OdataService} data - the OData service object
+ * @param {OdataService} service - the OData service object
  */
-export declare function enhanceData(data: OdataService): void;
+export declare function enhanceData(service: OdataService): void;
 //# sourceMappingURL=defaults.d.ts.map

package/dist/data/defaults.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../src/data/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAGxC;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,CA4BpD"}
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../src/data/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAGxC;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,CA6BvD"}

package/dist/data/defaults.js

@@ -6,35 +6,35 @@ const constants_1 = require("./constants");
  * Enhances the provided OData service object with path, name and model information.
  * Directly modifies the passed object reference.
  *
- * @param {OdataService} data - the OData service object
+ * @param {OdataService} service - the OData service object
  */
-function enhanceData(data) {
+function enhanceData(service) {
     var _a;
     // Set default path
-    if (data.path === undefined) {
-        data.path = '/';
+    if (service.path === undefined) {
+        service.path = '/';
     }
-    else if (data.path.substring(data.path.length - 1) !== '/') {
-        data.path = data.path + '/';
+    else if (service.path.substring(service.path.length - 1) !== '/') {
+        service.path = service.path + '/';
     }
-    if (data.name === undefined) {
-        data.name = constants_1.DEFAULT_DATASOURCE_NAME;
+    if (service.name === undefined) {
+        service.name = constants_1.DEFAULT_DATASOURCE_NAME;
     }
-    if (data.model === undefined) {
-        data.model = ''; // Default UI5 model
+    if (service.model === undefined) {
+        service.model = ''; // Default UI5 model
     }
     // enhance preview settings with service configuration
-    data.previewSettings = data.previewSettings || {};
-    data.previewSettings.path =
-        data.previewSettings.path || `/${((_a = data.path) === null || _a === void 0 ? void 0 : _a.split('/').filter((s) => s !== '')[0]) || ''}`;
-    data.previewSettings.url = data.previewSettings.url || data.url || 'http://localhost';
-    if (data.client && !data.previewSettings.client) {
-        data.previewSettings.client = data.client;
+    service.previewSettings = service.previewSettings || {};
+    service.previewSettings.path =
+        service.previewSettings.path || `/${((_a = service.path) === null || _a === void 0 ? void 0 : _a.split('/').filter((s) => s !== '')[0]) || ''}`;
+    service.previewSettings.url = service.previewSettings.url || service.url || 'http://localhost';
+    if (service.client && !service.previewSettings.client) {
+        service.previewSettings.client = service.client;
     }
-    if (data.destination && !data.previewSettings.destination) {
-        data.previewSettings.destination = data.destination.name;
-        if (data.destination.instance) {
-            data.previewSettings.destinationInstance = data.destination.instance;
+    if (service.destination && !service.previewSettings.destination) {
+        service.previewSettings.destination = service.destination.name;
+        if (service.destination.instance) {
+            service.previewSettings.destinationInstance = service.destination.instance;
         }
     }
 }

package/dist/data/defaults.js.map

@@ -1 +1 @@
-{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../src/data/defaults.ts"],"names":[],"mappings":";;;AACA,2CAAsD;AAEtD;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,IAAkB;;IAC1C,mBAAmB;IACnB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QACzB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;KACnB;SAAM,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;QAC1D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;KAC/B;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QACzB,IAAI,CAAC,IAAI,GAAG,mCAAuB,CAAC;KACvC;IACD,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;QAC1B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,oBAAoB;KACxC;IACD,sDAAsD;IACtD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,EAAE,CAAC;IAClD,IAAI,CAAC,eAAe,CAAC,IAAI;QACrB,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,IAAI,CAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAI,EAAE,EAAE,CAAC;IACtG,IAAI,CAAC,eAAe,CAAC,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,kBAAkB,CAAC;IACtF,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;QAC7C,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;KAC7C;IACD,IAAI,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE;QACvD,IAAI,CAAC,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QACzD,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE;YAC3B,IAAI,CAAC,eAAe,CAAC,mBAAmB,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC;SACxE;KACJ;AACL,CAAC;AA5BD,kCA4BC"}
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../src/data/defaults.ts"],"names":[],"mappings":";;;AACA,2CAAsD;AAEtD;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,OAAqB;;IAC7C,mBAAmB;IACnB,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;QAC5B,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC;KACtB;SAAM,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;QAChE,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC;KACrC;IAED,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;QAC5B,OAAO,CAAC,IAAI,GAAG,mCAAuB,CAAC;KAC1C;IACD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE;QAC7B,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,oBAAoB;KAC3C;IAED,sDAAsD;IACtD,OAAO,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,EAAE,CAAC;IACxD,OAAO,CAAC,eAAe,CAAC,IAAI;QACxB,OAAO,CAAC,eAAe,CAAC,IAAI,IAAI,IAAI,CAAA,MAAA,OAAO,CAAC,IAAI,0CAAE,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAI,EAAE,EAAE,CAAC;IAC5G,OAAO,CAAC,eAAe,CAAC,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,IAAI,kBAAkB,CAAC;IAC/F,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE;QACnD,OAAO,CAAC,eAAe,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;KACnD;IACD,IAAI,OAAO,CAAC,WAAW,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,EAAE;QAC7D,OAAO,CAAC,eAAe,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;QAC/D,IAAI,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE;YAC9B,OAAO,CAAC,eAAe,CAAC,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC;SAC9E;KACJ;AACL,CAAC;AA7BD,kCA6BC"}

package/dist/data/index.d.ts

@@ -1,2 +1,3 @@
 export * from './defaults';
+export * from './annotations';
 //# sourceMappingURL=index.d.ts.map

package/dist/data/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC"}

package/dist/data/index.js

@@ -11,4 +11,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./defaults"), exports);
+__exportStar(require("./annotations"), exports);
 //# sourceMappingURL=index.js.map

package/dist/data/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAA2B;AAC3B,gDAA8B"}

package/dist/i18n.d.ts

@@ -1,9 +1,14 @@
 import { TOptions } from 'i18next';
+/**
+ * Initialize i18next with the translations for this module.
+ */
 export declare function initI18n(): Promise<void>;
 /**
- * @param key
- * @param options
- * @returns {string}
+ * Helper function facading the call call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
  */
 export declare function t(key: string, options?: TOptions): string;
 //# sourceMappingURL=i18n.d.ts.map

package/dist/i18n.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"i18n.d.ts","sourceRoot":"","sources":["../src/i18n.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAK5C,wBAAsB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAY9C;AAED;;;;GAIG;AACH,wBAAgB,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,MAAM,CAEzD"}
+{"version":3,"file":"i18n.d.ts","sourceRoot":"","sources":["../src/i18n.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAK5C;;GAEG;AACH,wBAAsB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAY9C;AAED;;;;;;GAMG;AACH,wBAAgB,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,MAAM,CAEzD"}

package/dist/i18n.js

@@ -16,6 +16,9 @@ exports.t = exports.initI18n = void 0;
 const i18next_1 = __importDefault(require("i18next"));
 const odata_service_writer_i18n_json_1 = __importDefault(require("./translations/odata-service-writer.i18n.json"));
 const NS = 'odata-service-writer';
+/**
+ * Initialize i18next with the translations for this module.
+ */
 function initI18n() {
     return __awaiter(this, void 0, void 0, function* () {
         yield i18next_1.default.init({
@@ -33,9 +36,11 @@ function initI18n() {
 }
 exports.initI18n = initI18n;
 /**
- * @param key
- * @param options
- * @returns {string}
+ * Helper function facading the call call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
  */
 function t(key, options) {
     return i18next_1.default.t(key, options);

package/dist/i18n.js.map

@@ -1 +1 @@
-{"version":3,"file":"i18n.js","sourceRoot":"","sources":["../src/i18n.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,sDAA4C;AAC5C,mHAAyE;AAEzE,MAAM,EAAE,GAAG,sBAAsB,CAAC;AAElC,SAAsB,QAAQ;;QAC1B,MAAM,iBAAO,CAAC,IAAI,CAAC;YACf,SAAS,EAAE;gBACP,EAAE,EAAE;oBACA,CAAC,EAAE,CAAC,EAAE,wCAAY;iBACrB;aACJ;YACD,GAAG,EAAE,IAAI;YACT,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,EAAE;YACb,EAAE,EAAE,CAAC,EAAE,CAAC;SACX,CAAC,CAAC;IACP,CAAC;CAAA;AAZD,4BAYC;AAED;;;;GAIG;AACH,SAAgB,CAAC,CAAC,GAAW,EAAE,OAAkB;IAC7C,OAAO,iBAAO,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC;AAFD,cAEC;AAED,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"i18n.js","sourceRoot":"","sources":["../src/i18n.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,sDAA4C;AAC5C,mHAAyE;AAEzE,MAAM,EAAE,GAAG,sBAAsB,CAAC;AAElC;;GAEG;AACH,SAAsB,QAAQ;;QAC1B,MAAM,iBAAO,CAAC,IAAI,CAAC;YACf,SAAS,EAAE;gBACP,EAAE,EAAE;oBACA,CAAC,EAAE,CAAC,EAAE,wCAAY;iBACrB;aACJ;YACD,GAAG,EAAE,IAAI;YACT,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,EAAE;YACb,EAAE,EAAE,CAAC,EAAE,CAAC;SACX,CAAC,CAAC;IACP,CAAC;CAAA;AAZD,4BAYC;AAED;;;;;;GAMG;AACH,SAAgB,CAAC,CAAC,GAAW,EAAE,OAAkB;IAC7C,OAAO,iBAAO,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC;AAFD,cAEC;AAED,QAAQ,EAAE,CAAC"}

package/dist/index.d.ts

@@ -5,11 +5,11 @@ import { OdataService, OdataVersion } from './types';
  *
  *
  * @param {string} basePath - the root path of an existing UI5 application
- * @param {OdataService} data - the OData service instance
+ * @param {OdataService} service - the OData service instance
  * @param {Editor} [fs] - the memfs editor instance
  * @throws {Error} - if required UI5 project files are not found
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
-declare function generate(basePath: string, data: OdataService, fs?: Editor): Promise<Editor>;
+declare function generate(basePath: string, service: OdataService, fs?: Editor): Promise<Editor>;
 export { generate, OdataVersion, OdataService };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,MAAM,EAAE,MAAM,eAAe,CAAC;AAO/C,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAiBrD;;;;;;;;;GASG;AACH,iBAAe,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAsF1F;AAED,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,MAAM,EAAE,MAAM,eAAe,CAAC;AAM/C,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAiBrD;;;;;;;;;GASG;AACH,iBAAe,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA0F7F;AAED,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC"}

package/dist/index.js

@@ -41,19 +41,19 @@ function validateBasePath(basePath, fs) {
  *
  *
  * @param {string} basePath - the root path of an existing UI5 application
- * @param {OdataService} data - the OData service instance
+ * @param {OdataService} service - the OData service instance
  * @param {Editor} [fs] - the memfs editor instance
  * @throws {Error} - if required UI5 project files are not found
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
-function generate(basePath, data, fs) {
+function generate(basePath, service, fs) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         if (!fs) {
             fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
         }
         validateBasePath(basePath, fs);
-        (0, data_1.enhanceData)(data);
+        (0, data_1.enhanceData)(service);
         // merge content into existing files
         const templateRoot = (0, path_1.join)(__dirname, '..', 'templates');
         const extRoot = (0, path_1.join)(templateRoot, 'extend');
@@ -68,18 +68,17 @@ function generate(basePath, data, fs) {
             throw new Error((0, i18n_1.t)('error.requiredProjectPropertyNotFound', { property: `'${appProp}'.id`, path: manifestPath }));
         }
         const manifestJsonExt = fs.read((0, path_1.join)(extRoot, `manifest.json`));
-        fs.extendJSON(manifestPath, JSON.parse((0, ejs_1.render)(manifestJsonExt, data)));
+        fs.extendJSON(manifestPath, JSON.parse((0, ejs_1.render)(manifestJsonExt, service)));
         // ui5.yaml
         const ui5ConfigPath = (0, path_1.join)(basePath, 'ui5.yaml');
         const ui5Config = yield ui5_config_1.UI5Config.newInstance(fs.read(ui5ConfigPath));
-        ui5Config.addFioriToolsProxydMiddleware({ backend: [data.previewSettings], ui5: {} });
-        ui5Config.addFioriToolsAppReloadMiddleware();
+        ui5Config.addBackendToFioriToolsProxydMiddleware(service.previewSettings);
         // ui5-local.yaml
         const ui5LocalConfigPath = (0, path_1.join)(basePath, 'ui5-local.yaml');
         const ui5LocalConfig = yield ui5_config_1.UI5Config.newInstance(fs.read(ui5LocalConfigPath));
-        ui5LocalConfig.addFioriToolsProxydMiddleware({ backend: [data.previewSettings] });
+        ui5LocalConfig.addFioriToolsProxydMiddleware({ backend: [service.previewSettings] });
         // Add mockserver entries
-        if (data.metadata) {
+        if (service.metadata) {
             // package.json updates
             const mockDevDeps = {
                 devDependencies: {
@@ -92,26 +91,25 @@ function generate(basePath, data, fs) {
             const packageJson = JSON.parse(fs.read(packagePath));
             packageJson.ui5.dependencies.push('@sap/ux-ui5-fe-mockserver-middleware');
             fs.writeJSON(packagePath, packageJson);
-            // ui5-mock.yaml
-            fs.copyTpl((0, path_1.join)(templateRoot, 'add', 'ui5-mock.yaml'), (0, path_1.join)(basePath, 'ui5-mock.yaml'), Object.assign(data, { appid }));
-            const ui5MockConfigPath = (0, path_1.join)(basePath, 'ui5-mock.yaml');
-            const ui5MockConfig = yield ui5_config_1.UI5Config.newInstance(fs.read(ui5MockConfigPath));
-            ui5MockConfig.addFioriToolsProxydMiddleware({ backend: [data.previewSettings], ui5: {} });
-            ui5MockConfig.addMockServerMiddleware(data.path);
-            ui5MockConfig.addFioriToolsAppReloadMiddleware();
+            // copy existing `ui5.yaml` as starting point for ui5-mock.yaml
+            const ui5MockConfig = yield ui5_config_1.UI5Config.newInstance(ui5Config.toString());
+            ui5MockConfig.addMockServerMiddleware(service.path);
             fs.write((0, path_1.join)(basePath, 'ui5-mock.yaml'), ui5MockConfig.toString());
             // also add mockserver middleware to ui5-local.yaml
-            ui5LocalConfig.addMockServerMiddleware(data.path);
+            ui5LocalConfig.addMockServerMiddleware(service.path);
             // create local copy of metadata and annotations
-            fs.write((0, path_1.join)(basePath, 'webapp', 'localService', 'metadata.xml'), (0, prettify_xml_1.default)(data.metadata, { indent: 4 }));
+            fs.write((0, path_1.join)(basePath, 'webapp', 'localService', 'metadata.xml'), (0, prettify_xml_1.default)(service.metadata, { indent: 4 }));
+            // Adds local annotations to datasources section of manifest.json and writes the annotations file
+            if (service.localAnnotationsName) {
+                const namespaces = (0, data_1.getAnnotationNamespaces)(service);
+                fs.copyTpl((0, path_1.join)(templateRoot, 'add', 'annotation.xml'), (0, path_1.join)(basePath, 'webapp', 'annotations', `${service.localAnnotationsName}.xml`), Object.assign(Object.assign({}, service), { namespaces }));
+            }
         }
-        // also add the reload middleware
-        ui5LocalConfig.addFioriToolsAppReloadMiddleware();
         // write yamls to disk
         fs.write(ui5ConfigPath, ui5Config.toString());
         fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
-        if ((_b = data.annotations) === null || _b === void 0 ? void 0 : _b.xml) {
-            fs.write((0, path_1.join)(basePath, 'webapp', 'localService', `${data.annotations.technicalName}.xml`), (0, prettify_xml_1.default)(data.annotations.xml, { indent: 4 }));
+        if ((_b = service.annotations) === null || _b === void 0 ? void 0 : _b.xml) {
+            fs.write((0, path_1.join)(basePath, 'webapp', 'localService', `${service.annotations.technicalName}.xml`), (0, prettify_xml_1.default)(service.annotations.xml, { indent: 4 }));
         }
         return fs;
     });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+BAA4B;AAC5B,mCAAiD;AACjD,iDAA+C;AAC/C,6BAA6B;AAC7B,mDAA6D;AAC7D,gEAAuC;AAEvC,iCAAqC;AACrC,iCAA2B;AAC3B,mCAAqD;AAmHlC,6FAnHI,oBAAY,OAmHJ;AAjH/B;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,QAAgB,EAAE,EAAU;IAClD,CAAC,IAAA,WAAI,EAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,IAAA,WAAI,EAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,CAAC,EAAE,IAAA,WAAI,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAC3G,CAAC,IAAI,EAAE,EAAE;QACL,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,IAAA,QAAC,EAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;SACrE;IACL,CAAC,CACJ,CAAC;AACN,CAAC;AACD;;;;;;;;;GASG;AACH,SAAe,QAAQ,CAAC,QAAgB,EAAE,IAAkB,EAAE,EAAW;;;QACrE,IAAI,CAAC,EAAE,EAAE;YACL,EAAE,GAAG,IAAA,sBAAM,EAAC,IAAA,eAAa,GAAE,CAAC,CAAC;SAChC;QACD,gBAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC/B,IAAA,kBAAW,EAAC,IAAI,CAAC,CAAC;QAElB,oCAAoC;QACpC,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QACxD,MAAM,OAAO,GAAG,IAAA,WAAI,EAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAE7C,gBAAgB;QAChB,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;QAC/D,uBAAuB;QACvB,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC3C,MAAM,OAAO,GAAG,SAAS,CAAC;QAC1B,MAAM,KAAK,GAAG,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,OAAO,CAAC,0CAAE,EAAE,CAAC;QACtC,wDAAwD;QACxD,IAAI,CAAC,KAAK,EAAE;YACR,MAAM,IAAI,KAAK,CACX,IAAA,QAAC,EAAC,uCAAuC,EAAE,EAAE,QAAQ,EAAE,IAAI,OAAO,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAClG,CAAC;SACL;QAED,MAAM,eAAe,GAAG,EAAE,CAAC,IAAI,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;QAChE,EAAE,CAAC,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,IAAA,YAAM,EAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAEvE,WAAW;QACX,MAAM,aAAa,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,MAAM,sBAAS,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QACtE,SAAS,CAAC,6BAA6B,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,eAA+B,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;QACtG,SAAS,CAAC,gCAAgC,EAAE,CAAC;QAE7C,iBAAiB;QACjB,MAAM,kBAAkB,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,MAAM,sBAAS,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;QAChF,cAAc,CAAC,6BAA6B,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,eAA+B,CAAC,EAAE,CAAC,CAAC;QAElG,yBAAyB;QACzB,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,uBAAuB;YACvB,MAAM,WAAW,GAAG;gBAChB,eAAe,EAAE;oBACb,sCAAsC,EAAE,GAAG;iBAC9C;aACJ,CAAC;YACF,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YACnD,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACxC,qFAAqF;YACrF,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;YACrD,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;YAC1E,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAEvC,gBAAgB;YAChB,EAAE,CAAC,OAAO,CACN,IAAA,WAAI,EAAC,YAAY,EAAE,KAAK,EAAE,eAAe,CAAC,EAC1C,IAAA,WAAI,EAAC,QAAQ,EAAE,eAAe,CAAC,EAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CACjC,CAAC;YACF,MAAM,iBAAiB,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;YAC1D,MAAM,aAAa,GAAG,MAAM,sBAAS,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAC9E,aAAa,CAAC,6BAA6B,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,eAA+B,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;YAC1G,aAAa,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjD,aAAa,CAAC,gCAAgC,EAAE,CAAC;YACjD,EAAE,CAAC,KAAK,CAAC,IAAA,WAAI,EAAC,QAAQ,EAAE,eAAe,CAAC,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;YAEpE,mDAAmD;YACnD,cAAc,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAElD,gDAAgD;YAChD,EAAE,CAAC,KAAK,CAAC,IAAA,WAAI,EAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,cAAc,CAAC,EAAE,IAAA,sBAAW,EAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;SACjH;QAED,iCAAiC;QACjC,cAAc,CAAC,gCAAgC,EAAE,CAAC;QAClD,sBAAsB;QACtB,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9C,EAAE,CAAC,KAAK,CAAC,kBAAkB,EAAE,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC;QAExD,IAAI,MAAA,IAAI,CAAC,WAAW,0CAAE,GAAG,EAAE;YACvB,EAAE,CAAC,KAAK,CACJ,IAAA,WAAI,EAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,MAAM,CAAC,EACjF,IAAA,sBAAW,EAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CACnD,CAAC;SACL;QACD,OAAO,EAAE,CAAC;;CACb;AAEQ,4BAAQ"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+BAA4B;AAC5B,mCAAiD;AACjD,iDAA+C;AAC/C,6BAA6B;AAC7B,mDAA6D;AAC7D,gEAAuC;AACvC,iCAA8D;AAC9D,iCAA2B;AAC3B,mCAAqD;AAuHlC,6FAvHI,oBAAY,OAuHJ;AArH/B;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,QAAgB,EAAE,EAAU;IAClD,CAAC,IAAA,WAAI,EAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,IAAA,WAAI,EAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,CAAC,EAAE,IAAA,WAAI,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAC3G,CAAC,IAAI,EAAE,EAAE;QACL,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,IAAA,QAAC,EAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;SACrE;IACL,CAAC,CACJ,CAAC;AACN,CAAC;AACD;;;;;;;;;GASG;AACH,SAAe,QAAQ,CAAC,QAAgB,EAAE,OAAqB,EAAE,EAAW;;;QAExE,IAAI,CAAC,EAAE,EAAE;YACL,EAAE,GAAG,IAAA,sBAAM,EAAC,IAAA,eAAa,GAAE,CAAC,CAAC;SAChC;QACD,gBAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC/B,IAAA,kBAAW,EAAC,OAAO,CAAC,CAAC;QAErB,oCAAoC;QACpC,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QACxD,MAAM,OAAO,GAAG,IAAA,WAAI,EAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAE7C,gBAAgB;QAChB,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;QAC/D,uBAAuB;QACvB,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC3C,MAAM,OAAO,GAAG,SAAS,CAAC;QAC1B,MAAM,KAAK,GAAG,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,OAAO,CAAC,0CAAE,EAAE,CAAC;QACtC,wDAAwD;QACxD,IAAI,CAAC,KAAK,EAAE;YACR,MAAM,IAAI,KAAK,CACX,IAAA,QAAC,EAAC,uCAAuC,EAAE,EAAE,QAAQ,EAAE,IAAI,OAAO,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAClG,CAAC;SACL;QAED,MAAM,eAAe,GAAG,EAAE,CAAC,IAAI,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;QAChE,EAAE,CAAC,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,IAAA,YAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QAE1E,WAAW;QACX,MAAM,aAAa,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,MAAM,sBAAS,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QACtE,SAAS,CAAC,sCAAsC,CAAC,OAAO,CAAC,eAA+B,CAAC,CAAC;QAE1F,iBAAiB;QACjB,MAAM,kBAAkB,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,MAAM,sBAAS,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;QAChF,cAAc,CAAC,6BAA6B,CAAC,EAAE,OAAO,EAAE,CAAC,OAAO,CAAC,eAA+B,CAAC,EAAE,CAAC,CAAC;QAErG,yBAAyB;QACzB,IAAI,OAAO,CAAC,QAAQ,EAAE;YAClB,uBAAuB;YACvB,MAAM,WAAW,GAAG;gBAChB,eAAe,EAAE;oBACb,sCAAsC,EAAE,GAAG;iBAC9C;aACJ,CAAC;YACF,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YACnD,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACxC,qFAAqF;YACrF,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;YACrD,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;YAC1E,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAEvC,+DAA+D;YAC/D,MAAM,aAAa,GAAG,MAAM,sBAAS,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;YACxE,aAAa,CAAC,uBAAuB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACpD,EAAE,CAAC,KAAK,CAAC,IAAA,WAAI,EAAC,QAAQ,EAAE,eAAe,CAAC,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;YAEpE,mDAAmD;YACnD,cAAc,CAAC,uBAAuB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAErD,gDAAgD;YAChD,EAAE,CAAC,KAAK,CACJ,IAAA,WAAI,EAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,cAAc,CAAC,EACxD,IAAA,sBAAW,EAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAC/C,CAAC;YAEF,iGAAiG;YACjG,IAAI,OAAO,CAAC,oBAAoB,EAAE;gBAC9B,MAAM,UAAU,GAAG,IAAA,8BAAuB,EAAC,OAAO,CAAC,CAAC;gBACpD,EAAE,CAAC,OAAO,CACN,IAAA,WAAI,EAAC,YAAY,EAAE,KAAK,EAAE,gBAAgB,CAAC,EAC3C,IAAA,WAAI,EAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,oBAAoB,MAAM,CAAC,kCACzE,OAAO,KAAE,UAAU,IAC3B,CAAC;aACL;SACJ;QAED,sBAAsB;QACtB,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9C,EAAE,CAAC,KAAK,CAAC,kBAAkB,EAAE,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC;QAExD,IAAI,MAAA,OAAO,CAAC,WAAW,0CAAE,GAAG,EAAE;YAC1B,EAAE,CAAC,KAAK,CACJ,IAAA,WAAI,EAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,MAAM,CAAC,EACpF,IAAA,sBAAW,EAAC,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CACtD,CAAC;SACL;QAED,OAAO,EAAE,CAAC;;CACb;AAEQ,4BAAQ"}

package/dist/translations/odata-service-writer.i18n.json

@@ -1,6 +1,7 @@
 {
     "error": {
         "requiredProjectFileNotFound": "Invalid project structure. Cannot find required file {{-path}}",
-        "requiredProjectPropertyNotFound": "Required project property: {{-property}} was not found in file: {{-path}}"
+        "requiredProjectPropertyNotFound": "Required project property: {{-property}} was not found in file: {{-path}}",
+        "unparseableXML": "Unparseable XML was specified: {{-error}}"
     }
 }

package/dist/types.d.ts

@@ -3,6 +3,10 @@ export declare enum OdataVersion {
     v2 = "2",
     v4 = "4"
 }
+export interface NamespaceAlias {
+    namespace: string;
+    alias: string;
+}
 export interface OdataService {
     url?: string;
     client?: string;
@@ -19,6 +23,7 @@ export interface OdataService {
         technicalName: string;
         xml: string;
     };
+    localAnnotationsName?: string;
     previewSettings?: Partial<ProxyBackend>;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,oBAAY,YAAY;IACpB,EAAE,MAAM;IACR,EAAE,MAAM;CACX;AACD,MAAM,WAAW,YAAY;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE;QACV,aAAa,EAAE,MAAM,CAAC;QACtB,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;IACF,eAAe,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;CAC3C"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,oBAAY,YAAY;IACpB,EAAE,MAAM;IACR,EAAE,MAAM;CACX;AAED,MAAM,WAAW,cAAc;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE;QACV,aAAa,EAAE,MAAM,CAAC;QACtB,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;IACF,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;CAC3C"}

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AACA,IAAY,YAGX;AAHD,WAAY,YAAY;IACpB,wBAAQ,CAAA;IACR,wBAAQ,CAAA;AACZ,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA,IAAY,YAGX;AAHD,WAAY,YAAY;IACpB,wBAAQ,CAAA;IACR,wBAAQ,CAAA;AACZ,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB"}

package/package.json

@@ -1,43 +1,45 @@
 {
-	"name": "@sap-ux/odata-service-writer",
-	"version": "0.9.8",
-	"license": "Apache-2.0",
-	"main": "dist/index.js",
-	"files": [
-		"LICENSE",
-		"dist",
-		"templates"
-	],
-	"dependencies": {
-		"ejs": "3.1.6",
-		"i18next": "20.3.2",
-		"mem-fs": "2.1.0",
-		"mem-fs-editor": "9.0.0",
-		"@sap-ux/ui5-config": "0.10.3",
-		"prettify-xml": "1.2.0"
-	},
-	"devDependencies": {
-		"@types/ejs": "3.1.0",
-		"@types/fs-extra": "9.0.13",
-		"@types/mem-fs-editor": "7.0.0",
-		"fs-extra": "10.0.0",
-		"lodash": "4.17.21"
-	},
-	"engines": {
-		"pnpm": ">=6.0.2",
-		"node": ">=12.22.5 < 13.0.0 || >= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0"
-	},
-	"scripts": {
-		"build": "pnpm clean && tsc",
-		"clean": "rimraf dist test/test-output coverage",
-		"format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
-		"lint": "eslint . --ext .ts",
-		"lint:fix": "eslint . --ext .ts --fix",
-		"test": "jest --ci --forceExit --detectOpenHandles --colors",
-		"test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
-		"test:local": "node -r ts-node/register test/index.ts",
-		"watch": "tsc --watch",
-		"link": "pnpm link --global",
-		"unlink": "pnpm unlink --global"
-	}
-}
+  "name": "@sap-ux/odata-service-writer",
+  "version": "0.11.0",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "templates"
+  ],
+  "dependencies": {
+    "ejs": "3.1.6",
+    "i18next": "20.3.2",
+    "mem-fs": "2.1.0",
+    "mem-fs-editor": "9.0.0",
+    "@sap-ux/ui5-config": "0.11.1",
+    "prettify-xml": "1.2.0",
+    "fast-xml-parser": "4.0.1"
+  },
+  "devDependencies": {
+    "@types/ejs": "3.1.0",
+    "@types/fs-extra": "9.0.13",
+    "@types/mem-fs-editor": "7.0.0",
+    "fs-extra": "10.0.0",
+    "lodash": "4.17.21"
+  },
+  "engines": {
+    "pnpm": ">=6.26.1",
+    "node": ">=12.22.5 < 13.0.0 || >= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0"
+  },
+  "scripts": {
+    "build": "pnpm clean && tsc",
+    "clean": "rimraf dist test/test-output coverage",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "test:local": "node -r ts-node/register test/index.ts",
+    "watch": "tsc --watch",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  },
+  "readme": "# @sap-ux/odata-service-writer\n\nWrites the odata service related file updates to an existing UI5 project specified by the base path.\n\n\n## Installation\nNpm\n`npm install --save @sap-ux/odata-service-writer`\n\nYarn\n`yarn add @sap-ux/odata-service-writer`\n\nPnpm\n`pnpm add @sap-ux/odata-service-writer`\n\n## Usage\n\n```Typescript\nimport { OdataVersion, OdataService, generate } from '@sap-ux/odata-service-writer';\nimport { create, Editor } from 'mem-fs-editor';\nimport { create as createStorage } from 'mem-fs';\n\n...\n\nfs = create(createStorage()); // Or use fs from Yeoman\n\n const config:  OdataService = {\n            url: 'http://localhost',\n            path: '/sap/odata/testme',\n            version: OdataVersion.v4,\n            destination: {\n                name: 'test'\n            }\n        };\nconst testDir = '/tmp';\n\nawait generate(testDir, config, fs);\n        \n```\n\n## Keywords\nSAP Fiori Freestyle\n"
+}

package/templates/add/annotation.xml

@@ -0,0 +1,18 @@
+<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="<%= (version === '2') ? '1.0' : '4.0'%>">
+    <edmx:Reference Uri="https://sap.github.io/odata-vocabularies/vocabularies/Common.xml">
+        <edmx:Include Namespace="com.sap.vocabularies.Common.v1" Alias="Common"/>
+    </edmx:Reference>
+    <edmx:Reference Uri="https://sap.github.io/odata-vocabularies/vocabularies/UI.xml">
+        <edmx:Include Namespace="com.sap.vocabularies.UI.v1" Alias="UI"/>
+    </edmx:Reference>
+    <edmx:Reference Uri="https://sap.github.io/odata-vocabularies/vocabularies/Communication.xml">
+        <edmx:Include Namespace="com.sap.vocabularies.Communication.v1" Alias="Communication"/>
+    </edmx:Reference>
+    <edmx:Reference Uri="<%- path %>$metadata"><% namespaces.forEach(function(namespace){ %>
+        <edmx:Include Namespace="<%- namespace.namespace %>"<% if (namespace.alias) { %> Alias="<%- namespace.alias %>"<% } %>/><% }); %>
+    </edmx:Reference>
+    <edmx:DataServices>
+        <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="local">
+        </Schema>
+    </edmx:DataServices>
+</edmx:Edmx>

package/templates/extend/manifest.json

@@ -6,7 +6,8 @@
                 "type": "OData",
                 "settings": {
                     "annotations": [<%if (locals.annotations && annotations.technicalName) {%>
-                       "<%- annotations.technicalName %>"<% } %>
+                        "<%- annotations.technicalName %>"<% if (locals.localAnnotationsName) {%>,<%}%><% } %><% if (locals.localAnnotationsName) { %>
+                        "<%- localAnnotationsName %>"<% } %>
                     ],
                     "localUri": "localService/metadata.xml"<%if (version === '4') {%>,
                     "odataVersion": "4.0"<% } %><%if (version === '2') {%>,
@@ -19,7 +20,14 @@
                 "settings": {
                     "localUri": "localService/<%- annotations.technicalName %>.xml"
                 }
-            }<% } %>
+            }<% } %><% if (locals.localAnnotationsName) { %>,
+            "<%- localAnnotationsName %>": {
+                "type": "ODataAnnotation",
+                "uri": "annotations/<%- localAnnotationsName %>.xml",
+                "settings": {
+                    "localUri": "annotations/<%- localAnnotationsName %>.xml"
+                }
+            } <% } %>
         }
     },
     "sap.ui5": {

package/CHANGELOG.md

@@ -1,74 +0,0 @@
-# @sap-ux/odata-service-writer
-
-## 0.9.8
-
-### Patch Changes
-
--   ccff534: Add inline schema in ui5\*.yaml files for yaml-language-server
-
-## 0.9.7
-
-### Patch Changes
-
--   b7ee596: port tool-suite change - add delay to appreload middleware
--   Updated dependencies [b7ee596]
-    -   @sap-ux/ui5-config@0.10.3
-
-## 0.9.6
-
-### Patch Changes
-
--   8de261b: Update npm dep and devDeps
--   Updated dependencies [8de261b]
-    -   @sap-ux/ui5-config@0.10.2
-
-## 0.9.5
-
-### Patch Changes
-
--   a7670a0: Update ui5 verison handling for ui5.yaml. Allow setting view name in basic template, enhancements to yaml lib.
--   Updated dependencies [a7670a0]
-    -   @sap-ux/ui5-config@0.10.1
-
-## 0.9.4
-
-### Patch Changes
-
--   d37c8bd: Added support for selecting a custom view name for Fiori freestyle - Basic template
--   Updated dependencies [d37c8bd]
-    -   @sap-ux/ui5-config@0.10.0
-
-## 0.9.3
-
-### Patch Changes
-
--   6888c5b: Add Readme for modules, add deploy script FF template, engines.node update to lts and small clean-up
--   Updated dependencies [6888c5b]
-    -   @sap-ux/ui5-config@0.9.3
-
-## 0.9.2
-
-### Patch Changes
-
--   a16d4e7: fix versions in modules for patch instead of minor
--   Updated dependencies [a16d4e7]
-    -   @sap-ux/ui5-config@0.9.2
-
-## 0.10.0
-
-### Minor Changes
-
--   cd119ea: Fix missing client in fiori proxy config #138
-
-### Patch Changes
-
--   Updated dependencies [cd119ea]
-    -   @sap-ux/ui5-config@0.10.0
-
-## 0.9.1
-
-### Patch Changes
-
--   f6e1223: Dummy update to test changesets and pipeline
--   Updated dependencies [f6e1223]
-    -   @sap-ux/ui5-config@0.9.1