@cap-js/ord 1.3.0 → 1.3.1

package/README.md

@@ -145,6 +145,24 @@ cds compile <path to srv folder> --to ord [-o] [destinationFilePath]
 
 You can find more information, such as how to customize the ORD Document, in this [document](./docs/ord.md).
 
+## How to setup dev environment and run xmpl locally
+
+1. **Install dependency**
+    ```sh
+    npm i
+    ```
+2. **Run xmpl application**
+
+    ```sh
+    cd xmpl/
+
+    # watch xmpl application
+    cds watch
+
+    # build resources files
+    cds build --for ord
+    ```
+
 ## Support, Feedback, Contributing
 
 This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/ord/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).

package/lib/build.js

@@ -1,6 +1,7 @@
 const cds = require("@sap/cds");
 const cds_dk = require("@sap/cds-dk");
-const { path } = cds.utils;
+const path = require("path");
+const _ = require("lodash");
 const { ord, getMetadata } = require("./index");
 const { BUILD_DEFAULT_PATH, ORD_SERVICE_NAME, ORD_DOCUMENT_FILE_NAME } = require("./constants");
 
@@ -17,16 +18,14 @@ module.exports = class OrdBuildPlugin extends cds_dk.build.Plugin {
                 continue;
             }
 
-            const subDir = path.join(this.task.dest, resource.ordId);
-
             for (const resourceDefinition of resource.resourceDefinitions) {
                 const url = resourceDefinition.url;
-                const fileName = url.split("/").pop();
+                const fileName = path.join(resource.ordId, url.split("/").pop());
                 try {
                     const { _, response } = await getMetadata(url, model); // eslint-disable-line no-unused-vars
                     promises.push(
                         this.write(response)
-                            .to(path.join(subDir, fileName))
+                            .to(fileName.replace(/:/g, "_"))
                             .catch((err) => {
                                 console.log("Error", `Failed to write file ${fileName}: ${err.message}`);
                             }),
@@ -38,15 +37,48 @@ module.exports = class OrdBuildPlugin extends cds_dk.build.Plugin {
         }
     }
 
+    postProcess(ordDocument) {
+        const clonedOrdDocument = _.cloneDeep(ordDocument);
+        const _updateResourceUrls = (resources) => {
+            for (const resource of resources || []) {
+                if (resource.resourceDefinitions) {
+                    for (const resourceDefinition of resource.resourceDefinitions) {
+                        let url = resourceDefinition.url;
+                        url = this._createRelativePath(url);
+                        resourceDefinition.url = url;
+                    }
+                }
+            }
+        };
+
+        _updateResourceUrls(clonedOrdDocument.apiResources);
+        _updateResourceUrls(clonedOrdDocument.eventResources);
+
+        return clonedOrdDocument;
+    }
+
+    _createRelativePath(url) {
+        let relative = url.split("/ord/v1").pop();
+        if (relative.startsWith("/")) relative = relative.slice(1);
+        relative = relative.replace(/:/g, "_");
+        return path.join(...relative.split("/"));
+    }
+
     async build() {
         const model = await this.model();
         const ordDocument = ord(model);
+        const postProcessedOrdDocument = this.postProcess(ordDocument);
 
         const promises = [];
-        promises.push(this.write(ordDocument).to(ORD_DOCUMENT_FILE_NAME));
+        promises.push(this.write(postProcessedOrdDocument).to(ORD_DOCUMENT_FILE_NAME));
 
-        await this._writeResourcesFiles(ordDocument.apiResources, model, promises);
-        await this._writeResourcesFiles(ordDocument.eventResources, model, promises);
+        if (ordDocument.apiResources && ordDocument.apiResources.length > 0) {
+            await this._writeResourcesFiles(ordDocument.apiResources, model, promises);
+        }
+
+        if (ordDocument.eventResources && ordDocument.eventResources.length > 0) {
+            await this._writeResourcesFiles(ordDocument.eventResources, model, promises);
+        }
 
         return Promise.all(promises);
     }

package/package.json

@@ -1,13 +1,17 @@
 {
     "name": "@cap-js/ord",
-    "version": "1.3.0",
+    "version": "1.3.1",
     "description": "CAP Plugin for generating ORD document.",
     "repository": "cap-js/ord",
     "author": "SAP SE (https://www.sap.com)",
     "homepage": "https://cap.cloud.sap/",
     "license": "Apache-2.0",
+    "workspaces": [
+        "xmpl"
+    ],
     "main": "cds-plugin.js",
     "files": [
+        "cds-plugin.js",
         "lib",
         "data",
         "LICENSES"
@@ -24,8 +28,8 @@
         "prettier": "3.5.3"
     },
     "peerDependencies": {
-        "@sap/cds": "^8.1.1",
-        "@sap/cds-dk": "^8.9.3"
+        "@sap/cds": ">=9",
+        "@sap/cds-dk": ">=9"
     },
     "dependencies": {
         "@cap-js/asyncapi": "^1.0.3",