@sap-ux/odata-entity-model 0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,50 @@
+# OData Entity Model
+
+Package containing metadata service, which allows to look up elements from entity data model of an OData service.
+
+## Installation
+Npm
+`npm install --save @sap-ux/odata-entity-model`
+
+Yarn
+`yarn add @sap-ux/odata-entity-model`
+
+Pnpm
+`pnpm add @sap-ux/odata-entity-model`
+
+## Usage
+
+1. Import the needed functions in your modules
+
+    ```typescript
+    import { MetadataService  } from '@sap-ux/odata-entity-model';
+    const metadataFileUri = 'testFileUri';
+    const metadataElements: MetadataElement[] = [
+        {
+            isAnnotatable: true,
+            kind: 'EntityType',
+            name: 'com.sap.gateway.default.iwbep.tea_busi.v0001.Department',
+            path: 'com.sap.gateway.default.iwbep.tea_busi.v0001.Department',
+            isCollectionValued: false,
+            isComplexType: false,
+            isEntityType: true,
+            content: [
+                {
+                    content: [],
+                    isAnnotatable: true,
+                    kind: 'Property',
+                    name: 'Sector',
+                    path: 'com.sap.gateway.default.iwbep.tea_busi.v0001.Department/Sector',
+                    isCollectionValued: false,
+                    isComplexType: false,
+                    isEntityType: false,
+                    edmPrimitiveType: 'Edm.String'
+                }
+            ]
+        }];
+    const metadata = new MetadataService({ ODataVersion: '4.0' });
+    metadata.import(metadataElements, metadataFileUri);
+    const pathBase = metadata.getMetadataElement('com.sap.gateway.default.iwbep.tea_busi.v0001.Department');
+```
+
+For usage examples see unit tests in `odata-entity-model/test`.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './metadata-service';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./metadata-service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC"}

package/dist/metadata-service.d.ts

@@ -0,0 +1,120 @@
+import type { TargetKind, Location, MetadataElement, Path, ODataVersionType, MetadataServiceOptions, MetadataElementVisitor, IMetadataService } from '@sap-ux/odata-annotation-core-types';
+/**
+ * Metadata service
+ */
+export declare class MetadataService implements IMetadataService {
+    /**
+     * Keeps all metadata based on file level (for invalidation when file changes)
+     */
+    private metadata;
+    /**
+     * Keeps all namespaces based on file level (for invalidation when file changes)
+     */
+    private namespaces;
+    /**
+     * Mapping of action names to set of overloads on file level (for invalidation when file changes)
+     */
+    private actionNames;
+    /**
+     * Map of relative to absolute uri
+     */
+    private uriMap;
+    /**
+     * Lookup metadata element by its path.
+     *
+     * @param path - need to exactly match path of metadata element (i.e. function/action segment needs to contain ())
+     * @returns Metadata element if it exists for the given path.
+     */
+    private lookup;
+    /**
+     *
+     * @param path element path
+     * @returns element location
+     */
+    private getMetadataElementLocationsInternal;
+    /**
+     * OData Version
+     *   '2.0': OData 2.0
+     *   '4.0': OData 4.0
+     *   '': not specified (e.g. for metadata generated from CDS sources)
+     */
+    readonly ODataVersion: ODataVersionType | '';
+    /**
+     * isCds
+     *   true: metadata are generated based on CDS sources
+     */
+    readonly isCds: boolean;
+    /**
+     * Metadata file URI.
+     */
+    fileUri: string;
+    /**
+     * Create new metadata service instance.
+     *
+     * @param options metadata service instance option
+     */
+    constructor(options?: MetadataServiceOptions);
+    /**
+     * Set map of uris from relative to absolute.
+     *
+     * @param uriMap A map where keys are relative URIs and values are their corresponding absolute URIs.
+     */
+    setUriMap(uriMap: Map<string, string>): void;
+    /**
+     * Import metadata.
+     *
+     * @param rootNodes Metadata elements.
+     * @param fileUri Metadata file URI.
+     *
+     * The metadata is cached and invalidated (on file change) based on file level
+     */
+    import(rootNodes: MetadataElement[], fileUri: string): void;
+    /**
+     * Traverses all metadata elements and calls the specified visitor function for each element.
+     *
+     * @param {MetadataElementVisitor} visitElement - A function that will be called for each metadata element during traversal.
+     * The function should accept a single argument, which is the metadata element being visited.
+     */
+    visitMetadataElements(visitElement: MetadataElementVisitor): void;
+    /**
+     * Returns namespaces representing metadata.
+     *
+     * @returns set of namespaces
+     */
+    getNamespaces(): Set<string>;
+    /**
+     * Returns all metadata root elements.
+     *
+     * @returns a map containing metadata root elements, where the keys are the paths and the values are the corresponding metadata elements.
+     */
+    getRootMetadataElements(): Map<Path, MetadataElement>;
+    /**
+     * Returns a specific metadata element specified by its path.
+     *
+     * @param path Path identifying the metadata element (conforming to EDMX, i.e. function/action segments can also be without ())
+     * @returns Metadata element
+     */
+    getMetadataElement(path: Path): MetadataElement | undefined;
+    /**
+     * Get Action or Function overloads by their top level name.
+     *
+     * @param topLevelName First segment represents action function name.
+     * @returns if first segment represents action function name (without signature).
+     */
+    private getActionFunctionOverloads;
+    /**
+     * Get OData target kinds for a metadata element.
+     *
+     * @param path Path identifying metadata element.
+     * @returns OData target kinds.
+     */
+    getEdmTargetKinds(path: Path): TargetKind[];
+    /**
+     * Get (LSP) Locations of metadata element.
+     *
+     * @param path - path identifying metadata element
+     * @returns Locations for the metadata element
+     */
+    getMetadataElementLocations(path: string): Location[];
+}
+//# sourceMappingURL=metadata-service.d.ts.map

package/dist/metadata-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata-service.d.ts","sourceRoot":"","sources":["../src/metadata-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,UAAU,EACV,QAAQ,EACR,eAAe,EAEf,IAAI,EACJ,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EACnB,MAAM,qCAAqC,CAAC;AA2F7C;;GAEG;AACH,qBAAa,eAAgB,YAAW,gBAAgB;IACpD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA0B;IAE1C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAqB;IAEvC;;OAEG;IACH,OAAO,CAAC,WAAW,CAA4B;IAE/C;;OAEG;IACH,OAAO,CAAC,MAAM,CAAsB;IAEpC;;;;;OAKG;IACH,OAAO,CAAC,MAAM;IAId;;;;OAIG;IACH,OAAO,CAAC,mCAAmC;IA4B3C;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,gBAAgB,GAAG,EAAE,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,OAAO,SAAM;IAEb;;;;OAIG;gBACS,OAAO,CAAC,EAAE,sBAAsB;IAM5C;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAI5C;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAc3D;;;;;OAKG;IACH,qBAAqB,CAAC,YAAY,EAAE,sBAAsB,GAAG,IAAI;IAMjE;;;;OAIG;IACH,aAAa,IAAI,GAAG,CAAC,MAAM,CAAC;IAI5B;;;;OAIG;IACH,uBAAuB,IAAI,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC;IAUrD;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,eAAe,GAAG,SAAS;IA0B3D;;;;;OAKG;IACH,OAAO,CAAC,0BAA0B;IAIlC;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,EAAE;IA0B3C;;;;;OAKG;IACH,2BAA2B,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,EAAE;CAkBxD"}

package/dist/metadata-service.js

@@ -0,0 +1,313 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataService = void 0;
+// OData conform target kinds for CDS kinds
+const targetKindsCds = {
+    service: ["EntityContainer" /* Edm.EntityContainer */],
+    entitySet: ["EntitySet" /* Edm.EntitySet */],
+    entity: ["EntityType" /* Edm.EntityType */, "EntitySet" /* Edm.EntitySet */],
+    view: ["EntityType" /* Edm.EntityType */, "EntitySet" /* Edm.EntitySet */],
+    aspect: ["ComplexType" /* Edm.ComplexType */, "EntityType" /* Edm.EntityType */, "EntitySet" /* Edm.EntitySet */],
+    element: ["Property" /* Edm.Property */],
+    action: ["Action" /* Edm.Action */, "ActionImport" /* Edm.ActionImport */],
+    function: ["Function" /* Edm.Function */, "FunctionImport" /* Edm.FunctionImport */],
+    actionImport: ["Action" /* Edm.Action */],
+    functionImport: ["FunctionImport" /* Edm.FunctionImport */],
+    param: ["Parameter" /* Edm.Parameter */],
+    type: ["TypeDefinition" /* Edm.TypeDefinition */, "Property" /* Edm.Property */, "Parameter" /* Edm.Parameter */]
+};
+const targetKindsMapCds = new Map(Object.entries(targetKindsCds));
+/**
+ * Extracts action/function name by removing the part enclosed in parentheses.
+ *
+ * @param name action/function name
+ * @returns extracted name
+ */
+function getActionName(name) {
+    var _a, _b;
+    const partsOpen = name.split('(');
+    const partsClose = name.split(')');
+    return partsOpen.length > 1 && partsClose.length > 1 ? ((_a = partsOpen.shift()) !== null && _a !== void 0 ? _a : '') + ((_b = partsClose.pop()) !== null && _b !== void 0 ? _b : '') : name;
+}
+/**
+ * Builds a lookup for metadata elements based on provided data.
+ *
+ * @param metadata - The map to store metadata elements, keyed by their paths.
+ * @param actionNames - The map to store action names and associated overload paths.
+ * @param namespaces - The set to store unique namespaces encountered during the process.
+ * @param metadataElements - The array of metadata elements to process and build the lookup.
+ */
+function buildMetadataElementLookup(metadata, actionNames, namespaces, metadataElements) {
+    for (const node of metadataElements) {
+        const namespace = getNamespace(node.path);
+        if (namespace) {
+            namespaces.add(namespace);
+        }
+        if (node.name.includes('(')) {
+            const actionName = getActionName(node.name);
+            let overloadPaths = actionNames.get(actionName);
+            if (!overloadPaths) {
+                overloadPaths = new Set();
+                actionNames.set(actionName, overloadPaths);
+            }
+            overloadPaths.add(node.name);
+        }
+        metadata.set(node.path, node);
+        if (node.content) {
+            buildMetadataElementLookup(metadata, actionNames, namespaces, node.content);
+        }
+    }
+}
+/**
+ * Returns the namespace of an element identified by its path.
+ *
+ * @param path - Path of an element
+ * @returns    - Namespace
+ */
+function getNamespace(path) {
+    let namespace = '';
+    const segments = path.split('/');
+    const firstSegment = segments[0] === '' ? segments[1] : segments[0];
+    if (firstSegment) {
+        // segment name for overloads can be <fqFunctionName>(<fqNamePar1>, <fqNamePar2>)
+        // each fqName can contain dots
+        const beforeFirstBracket = firstSegment.split('(')[0];
+        const parts = beforeFirstBracket.split('.');
+        parts.pop();
+        namespace = parts.join('.');
+    }
+    return namespace;
+}
+/**
+ * Metadata service
+ */
+class MetadataService {
+    /**
+     * Lookup metadata element by its path.
+     *
+     * @param path - need to exactly match path of metadata element (i.e. function/action segment needs to contain ())
+     * @returns Metadata element if it exists for the given path.
+     */
+    lookup(path) {
+        return this.metadata.get(path);
+    }
+    /**
+     *
+     * @param path element path
+     * @returns element location
+     */
+    getMetadataElementLocationsInternal(path) {
+        const locations = [];
+        const elements = [];
+        const mdElement = this.lookup(path);
+        if (mdElement) {
+            elements.push(mdElement);
+        }
+        else {
+            // action/function name? find all action/function overloads
+            const overloadPaths = this.actionNames.get(path);
+            if (overloadPaths) {
+                for (const overloadPath of overloadPaths) {
+                    const overloadElement = this.getMetadataElement(overloadPath);
+                    if (overloadElement) {
+                        elements.push(overloadElement);
+                    }
+                }
+            }
+        }
+        // build locations
+        for (const element of elements) {
+            if (element.location) {
+                locations.push(element.location);
+            }
+        }
+        return locations;
+    }
+    /**
+     * Create new metadata service instance.
+     *
+     * @param options metadata service instance option
+     */
+    constructor(options) {
+        var _a, _b;
+        /**
+         * Keeps all metadata based on file level (for invalidation when file changes)
+         */
+        this.metadata = new Map();
+        /**
+         * Keeps all namespaces based on file level (for invalidation when file changes)
+         */
+        this.namespaces = new Set();
+        /**
+         * Mapping of action names to set of overloads on file level (for invalidation when file changes)
+         */
+        this.actionNames = new Map();
+        /**
+         * Metadata file URI.
+         */
+        this.fileUri = '';
+        this.ODataVersion = (_a = options === null || options === void 0 ? void 0 : options.ODataVersion) !== null && _a !== void 0 ? _a : '';
+        this.isCds = (options === null || options === void 0 ? void 0 : options.isCds) !== undefined ? options.isCds : this.ODataVersion === '';
+        this.uriMap = (_b = options === null || options === void 0 ? void 0 : options.uriMap) !== null && _b !== void 0 ? _b : new Map();
+    }
+    /**
+     * Set map of uris from relative to absolute.
+     *
+     * @param uriMap A map where keys are relative URIs and values are their corresponding absolute URIs.
+     */
+    setUriMap(uriMap) {
+        this.uriMap = uriMap;
+    }
+    /**
+     * Import metadata.
+     *
+     * @param rootNodes Metadata elements.
+     * @param fileUri Metadata file URI.
+     *
+     * The metadata is cached and invalidated (on file change) based on file level
+     */
+    import(rootNodes, fileUri) {
+        // build map of all metadata elements contained in file
+        const metadataMap = new Map();
+        const actionNameMap = new Map();
+        const namespaceSet = new Set();
+        buildMetadataElementLookup(metadataMap, actionNameMap, namespaceSet, rootNodes);
+        this.fileUri = fileUri;
+        this.namespaces = namespaceSet;
+        this.actionNames = actionNameMap;
+        this.metadata = metadataMap;
+    }
+    /**
+     * Traverses all metadata elements and calls the specified visitor function for each element.
+     *
+     * @param {MetadataElementVisitor} visitElement - A function that will be called for each metadata element during traversal.
+     * The function should accept a single argument, which is the metadata element being visited.
+     */
+    visitMetadataElements(visitElement) {
+        for (const [, element] of this.metadata.entries()) {
+            visitElement(element);
+        }
+    }
+    /**
+     * Returns namespaces representing metadata.
+     *
+     * @returns set of namespaces
+     */
+    getNamespaces() {
+        return new Set([...this.namespaces]);
+    }
+    /**
+     * Returns all metadata root elements.
+     *
+     * @returns a map containing metadata root elements, where the keys are the paths and the values are the corresponding metadata elements.
+     */
+    getRootMetadataElements() {
+        const map = new Map();
+        for (const metadataElement of this.metadata.values()) {
+            if (metadataElement.path.indexOf('/') < 0) {
+                map.set(metadataElement.path, metadataElement);
+            }
+        }
+        return map;
+    }
+    /**
+     * Returns a specific metadata element specified by its path.
+     *
+     * @param path Path identifying the metadata element (conforming to EDMX, i.e. function/action segments can also be without ())
+     * @returns Metadata element
+     */
+    getMetadataElement(path) {
+        const element = this.lookup(path);
+        if (element) {
+            return element;
+        }
+        // check if first segment represents action function name (without signature)
+        const segments = path.split('/');
+        const topLevelName = segments.shift();
+        if (!topLevelName) {
+            return undefined;
+        }
+        const actionFunctionOverloads = this.getActionFunctionOverloads(topLevelName);
+        if (actionFunctionOverloads) {
+            const remainingSegments = segments.join('/');
+            for (const overloadName of actionFunctionOverloads) {
+                const newPath = overloadName + (remainingSegments ? '/' + remainingSegments : '');
+                const element = this.lookup(newPath);
+                if (element) {
+                    return element;
+                }
+            }
+        }
+        return undefined;
+    }
+    /**
+     * Get Action or Function overloads by their top level name.
+     *
+     * @param topLevelName First segment represents action function name.
+     * @returns if first segment represents action function name (without signature).
+     */
+    getActionFunctionOverloads(topLevelName) {
+        return this.actionNames.get(topLevelName);
+    }
+    /**
+     * Get OData target kinds for a metadata element.
+     *
+     * @param path Path identifying metadata element.
+     * @returns OData target kinds.
+     */
+    getEdmTargetKinds(path) {
+        var _a;
+        const element = this.getMetadataElement(path);
+        if (!element) {
+            return [];
+        }
+        const targetKinds = [];
+        if (this.isCds) {
+            targetKinds.push(...((_a = targetKindsMapCds.get(element.kind)) !== null && _a !== void 0 ? _a : []));
+            if (element.kind === 'element' && element.structuredType && element.isEntityType) {
+                // CDS elements pointing to an entity type can be annotated like a EDMX navigation property
+                targetKinds.unshift("NavigationProperty" /* Edm.NavigationProperty */);
+            }
+        }
+        else {
+            targetKinds.push(element.kind);
+            if (element.kind === "FunctionImport" /* Edm.FunctionImport */ && this.ODataVersion !== '4.0') {
+                // vocabulary and annotation files are defined based on OData v4, but are used to annotate both OData v2 and OData v4 metadata.
+                // OData v2 does not have 'Action' but only 'FunctionImport'. Map to 'Action' to support annotating 'FunctionImport' with terms targeting actions.
+                targetKinds.push("Action" /* Edm.Action */);
+            }
+        }
+        if (targetKinds.includes("EntitySet" /* Edm.EntitySet */) || element.isCollectionValued) {
+            targetKinds.push("Collection" /* Edm.Collection */);
+        }
+        return targetKinds;
+    }
+    /**
+     * Get (LSP) Locations of metadata element.
+     *
+     * @param path - path identifying metadata element
+     * @returns Locations for the metadata element
+     */
+    getMetadataElementLocations(path) {
+        const result = this.getMetadataElementLocationsInternal(path);
+        if (this.uriMap) {
+            // map locations of result to external uri
+            result.forEach((location) => {
+                var _a;
+                if (location.uri.indexOf('node_modules') > -1) {
+                    const values = [...this.uriMap.values()];
+                    const item = values.find((val) => val.endsWith(location.uri.replace(/\\/g, '/')));
+                    if (item) {
+                        location.uri = item;
+                    }
+                }
+                else {
+                    location.uri = (_a = this.uriMap.get(location.uri)) !== null && _a !== void 0 ? _a : location.uri;
+                }
+            });
+        }
+        return result;
+    }
+}
+exports.MetadataService = MetadataService;
+//# sourceMappingURL=metadata-service.js.map

package/dist/metadata-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata-service.js","sourceRoot":"","sources":["../src/metadata-service.ts"],"names":[],"mappings":";;;AAgBA,2CAA2C;AAC3C,MAAM,cAAc,GAAG;IACnB,OAAO,EAAE,6CAAqB;IAC9B,SAAS,EAAE,iCAAe;IAC1B,MAAM,EAAE,oEAA+B;IACvC,IAAI,EAAE,oEAA+B;IACrC,MAAM,EAAE,yGAAgD;IACxD,OAAO,EAAE,+BAAc;IACvB,MAAM,EAAE,kEAA8B;IACtC,QAAQ,EAAE,0EAAkC;IAC5C,YAAY,EAAE,2BAAY;IAC1B,cAAc,EAAE,2CAAoB;IACpC,KAAK,EAAE,iCAAe;IACtB,IAAI,EAAE,2GAAiD;CAC1D,CAAC;AACF,MAAM,iBAAiB,GAA0B,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;AAEzF;;;;;GAKG;AACH,SAAS,aAAa,CAAC,IAAU;;IAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAA,SAAS,CAAC,KAAK,EAAE,mCAAI,EAAE,CAAC,GAAG,CAAC,MAAA,UAAU,CAAC,GAAG,EAAE,mCAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACvH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,0BAA0B,CAC/B,QAAqB,EACrB,WAA0B,EAC1B,UAAuB,EACvB,gBAAmC;IAEnC,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE;QACjC,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,SAAS,EAAE;YACX,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SAC7B;QACD,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACzB,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,aAAa,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAChD,IAAI,CAAC,aAAa,EAAE;gBAChB,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;gBAClC,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;aAC9C;YACD,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAChC;QACD,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,OAAO,EAAE;YACd,0BAA0B,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;SAC/E;KACJ;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,IAAY;IAC9B,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,YAAY,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACpE,IAAI,YAAY,EAAE;QACd,iFAAiF;QACjF,+BAA+B;QAC/B,MAAM,kBAAkB,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5C,KAAK,CAAC,GAAG,EAAE,CAAC;QACZ,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KAC/B;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,MAAa,eAAe;IAqBxB;;;;;OAKG;IACK,MAAM,CAAC,IAAU;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACK,mCAAmC,CAAC,IAAY;QACpD,MAAM,SAAS,GAAe,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAsB,EAAE,CAAC;QACvC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,SAAS,EAAE;YACX,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC5B;aAAM;YACH,2DAA2D;YAE3D,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjD,IAAI,aAAa,EAAE;gBACf,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;oBACtC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;oBAC9D,IAAI,eAAe,EAAE;wBACjB,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;qBAClC;iBACJ;aACJ;SACJ;QACD,kBAAkB;QAClB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC5B,IAAI,OAAO,CAAC,QAAQ,EAAE;gBAClB,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;aACpC;SACJ;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAqBD;;;;OAIG;IACH,YAAY,OAAgC;;QAvF5C;;WAEG;QACK,aAAQ,GAAgB,IAAI,GAAG,EAAE,CAAC;QAE1C;;WAEG;QACK,eAAU,GAAG,IAAI,GAAG,EAAU,CAAC;QAEvC;;WAEG;QACK,gBAAW,GAAkB,IAAI,GAAG,EAAE,CAAC;QAgE/C;;WAEG;QACH,YAAO,GAAG,EAAE,CAAC;QAQT,IAAI,CAAC,YAAY,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,mCAAI,EAAE,CAAC;QAChD,IAAI,CAAC,KAAK,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,MAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;QACrF,IAAI,CAAC,MAAM,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,IAAI,GAAG,EAAE,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAA2B;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAA4B,EAAE,OAAe;QAChD,uDAAuD;QACvD,MAAM,WAAW,GAAgB,IAAI,GAAG,EAAE,CAAC;QAC3C,MAAM,aAAa,GAAkB,IAAI,GAAG,EAAE,CAAC;QAC/C,MAAM,YAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;QAE5C,0BAA0B,CAAC,WAAW,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;QAEhF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,aAAa,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,YAAoC;QACtD,KAAK,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE;YAC/C,YAAY,CAAC,OAAO,CAAC,CAAC;SACzB;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa;QACT,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,uBAAuB;QACnB,MAAM,GAAG,GAA+B,IAAI,GAAG,EAAE,CAAC;QAClD,KAAK,MAAM,eAAe,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;YAClD,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBACvC,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;aAClD;SACJ;QACD,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,IAAU;QACzB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,OAAO,EAAE;YACT,OAAO,OAAO,CAAC;SAClB;QACD,6EAA6E;QAC7E,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtC,IAAI,CAAC,YAAY,EAAE;YACf,OAAO,SAAS,CAAC;SACpB;QACD,MAAM,uBAAuB,GAAG,IAAI,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;QAC9E,IAAI,uBAAuB,EAAE;YACzB,MAAM,iBAAiB,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7C,KAAK,MAAM,YAAY,IAAI,uBAAuB,EAAE;gBAChD,MAAM,OAAO,GAAG,YAAY,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,GAAG,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBAClF,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACrC,IAAI,OAAO,EAAE;oBACT,OAAO,OAAO,CAAC;iBAClB;aACJ;SACJ;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACK,0BAA0B,CAAC,YAAoB;QACnD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,IAAU;;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,EAAE,CAAC;SACb;QACD,MAAM,WAAW,GAAiB,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,KAAK,EAAE;YACZ,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,MAAA,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC,CAAC,CAAC;YACjE,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,cAAc,IAAI,OAAO,CAAC,YAAY,EAAE;gBAC9E,2FAA2F;gBAC3F,WAAW,CAAC,OAAO,mDAAwB,CAAC;aAC/C;SACJ;aAAM;YACH,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC/B,IAAI,OAAO,CAAC,IAAI,8CAAuB,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,EAAE;gBACpE,+HAA+H;gBAC/H,kJAAkJ;gBAClJ,WAAW,CAAC,IAAI,2BAAY,CAAC;aAChC;SACJ;QACD,IAAI,WAAW,CAAC,QAAQ,iCAAe,IAAI,OAAO,CAAC,kBAAkB,EAAE;YACnE,WAAW,CAAC,IAAI,mCAAgB,CAAC;SACpC;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,2BAA2B,CAAC,IAAY;QACpC,MAAM,MAAM,GAAG,IAAI,CAAC,mCAAmC,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,IAAI,CAAC,MAAM,EAAE;YACb,0CAA0C;YAC1C,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;;gBACxB,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE;oBAC3C,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;oBACzC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;oBAClF,IAAI,IAAI,EAAE;wBACN,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC;qBACvB;iBACJ;qBAAM;oBACH,QAAQ,CAAC,GAAG,GAAG,MAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAI,QAAQ,CAAC,GAAG,CAAC;iBAChE;YACL,CAAC,CAAC,CAAC;SACN;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAnQD,0CAmQC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@sap-ux/odata-entity-model",
+  "version": "0.1.1",
+  "description": "OData model representation without annotations",
+  "main": "dist/index.js",
+  "author": "SAP SE",
+  "license": "Apache-2.0",
+  "private": false,
+  "files": [
+    "dist/**"
+  ],
+  "jestSonar": {
+    "reportPath": "reports/test/unit",
+    "reportFile": "test-report.xml"
+  },
+  "devDependencies": {
+    "npm-run-all": "4.1.5",
+    "typescript": "4.9.5",
+    "@sap-ux/odata-annotation-core-types": "0.1.1"
+  },
+  "eslint-formatter-multiple": {
+    "formatters": [
+      {
+        "name": "stylish",
+        "output": "console"
+      },
+      {
+        "name": "json",
+        "output": "file",
+        "path": "reports/lint/eslint.json"
+      },
+      {
+        "name": "checkstyle",
+        "output": "file",
+        "path": "reports/lint/eslint.checkstyle.xml"
+      }
+    ]
+  },
+  "scripts": {
+    "build": "npm-run-all clean && tsc --build ./tsconfig.build.json",
+    "clean:dist": "rimraf ./dist ./generators *.tsbuildinfo",
+    "clean": "rimraf ./reports",
+    "format:fix": "prettier --write --loglevel silent --ignore-path ../../../.prettierignore",
+    "format:fix:all": "prettier --write '**/*.{css,scss,html,js,json,ts,tsx,yaml,yml}' '!**/{out,dist,typings,node_modules}/**' '!**/*.{svg,png,xml}' --ignore-path ../../../.prettierignore",
+    "lint": "eslint . --ext .ts,.tsx",
+    "lint:summary": "eslint . --ext .ts,.tsx -f summary",
+    "lint:fix": "eslint --fix",
+    "lint:fix:all": "eslint . --ext .ts,.tsx --fix",
+    "lint:report": "eslint . --ext .ts,.tsx -f multiple ",
+    "test": "jest  --maxWorkers=1 --ci --forceExit --detectOpenHandles",
+    "watch": "tsc  --build ./ -watch"
+  }
+}