Convert SAP Annotations for OData V2 into Capabilities (#72)

.vscode/extensions.json

@@ -1,12 +1,11 @@
 {
-    "recommendations": [
-        "bierner.github-markdown-preview",
-        "dbaeumer.vscode-eslint",
-        "eg2.vscode-npm-script",
-        "esbenp.prettier-vscode",
-        "hbenl.vscode-mocha-test-adapter",
-        "hbenl.vscode-test-explorer",
-        "redhat.vscode-xml",
-        "streetsidesoftware.code-spell-checker"
-    ]
+  "recommendations": [
+    "bierner.github-markdown-preview",
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "hbenl.vscode-mocha-test-adapter",
+    "hbenl.vscode-test-explorer",
+    "redhat.vscode-xml",
+    "streetsidesoftware.code-spell-checker"
+  ]
 }

.vscode/settings.json

@@ -17,6 +17,8 @@
   "cSpell.words": [
     "annotatable",
     "csdl",
+    "Edmx",
+    "Insertable",
     "odata",
     "onclosetag",
     "onopentag",

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.7.0 2022-10-20
+
+### Added
+
+- `xml2json`: accept some [SAP Annotations for OData Version 2.0](https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md) and turn them into [Capabilities](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Capabilities.V1.md)
+
 ## 0.6.0 2022-08-31
 
 ### Changed

lib/xml2json.js

@@ -549,6 +549,11 @@ module.exports.xml2json = function (
           "EntityType",
           "IncludeInServiceDocument",
         ]);
+        setCapabilities(current.containerChild, node, [
+          "creatable",
+          "updatable",
+          "deletable",
+        ]);
         current.container[node.attributes.Name.value] = current.containerChild;
         annotatable.target = current.containerChild;
         const bindings = preV4.entitySet[node.attributes.Name.value];
@@ -1835,6 +1840,61 @@ module.exports.xml2json = function (
     }
   }
 
+  /**
+   * Set attributes from an XML node
+   * @param {Object} target The object to fill
+   * @param {Object} node The XML node
+   * @param {Array} convert An array of attribute names to convert
+   */
+  const SAP_V2_URI = "http://www.sap.com/Protocols/SAPData";
+  const CAPABILITIES_URI =
+    "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Capabilities.V1.json";
+  const CAPABILITIES = {
+    creatable: {
+      attrValue: "false",
+      term: "InsertRestrictions",
+      value: { Insertable: false },
+    },
+    updatable: {
+      attrValue: "false",
+      term: "UpdateRestrictions",
+      value: { Updatable: false },
+    },
+    deletable: {
+      attrValue: "false",
+      term: "DeleteRestrictions",
+      value: { Deletable: false },
+    },
+  };
+  function setCapabilities(target, node, convert) {
+    if (result.$Version > "2.0") return;
+    let includeCapabilities = false;
+    const attributes = Object.values(node.attributes);
+    for (const name of convert) {
+      const attribute = attributes.find(
+        (a) => a.local === name && a.uri === SAP_V2_URI
+      );
+      const anno = CAPABILITIES[name];
+      if (!attribute || !anno || attribute.value !== anno.attrValue) continue;
+      includeCapabilities = true;
+      target[`@Capabilities.${anno.term}`] = anno.value;
+    }
+
+    if (includeCapabilities) {
+      if (!result.$Reference) result.$Reference = {};
+      if (!result.$Reference[CAPABILITIES_URI]) {
+        result.$Reference[CAPABILITIES_URI] = {
+          $Include: [
+            {
+              $Namespace: "Org.OData.Capabilities.V1",
+              $Alias: "Capabilities",
+            },
+          ],
+        };
+      }
+    }
+  }
+
   /**
    * Construct OData namespace from XML namespace URI
    * @param {string} uri The XML namespace name