@sap-ux/adp-tooling 0.1.0 → 0.1.2

package/dist/preview/adp-preview.d.ts

@@ -2,13 +2,14 @@ import type { ToolsLogger } from '@sap-ux/logger';
 import type { AdpPreviewConfig, DescriptorVariant } from '../types';
 import type { NextFunction, Request, Response } from 'express';
 import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
-import type { Resource } from '@ui5/fs';
+import type { ReaderCollection } from '@ui5/fs';
 import type { UI5FlexLayer } from '@sap-ux/project-access';
 /**
  * Instance of an adaptation project handling requests and data transformation.
  */
 export declare class AdpPreview {
     private readonly config;
+    private readonly project;
     private readonly logger;
     /**
      * Merged descriptor variant with reference app manifest
@@ -28,17 +29,17 @@ export declare class AdpPreview {
      * Constructor taking the config and a logger as input.
      *
      * @param config adp config
+     * @param project reference to the root of the project
      * @param logger logger instance
      */
-    constructor(config: AdpPreviewConfig, logger: ToolsLogger);
+    constructor(config: AdpPreviewConfig, project: ReaderCollection, logger: ToolsLogger);
     /**
      * Fetch all required configurations from the backend and initialize all configurations.
      *
      * @param descriptorVariant descriptor variant from the project
-     * @param files all relevant project files (e.g. webapp content)
      * @returns the UI5 flex layer for which editing is enabled
      */
-    init(descriptorVariant: DescriptorVariant, files: Resource[]): Promise<UI5FlexLayer>;
+    init(descriptorVariant: DescriptorVariant): Promise<UI5FlexLayer>;
     /**
      * Proxy for the merged application manifest.json and blocking of preload files.
      *
@@ -46,6 +47,6 @@ export declare class AdpPreview {
      * @param res outgoing response object
      * @param next next middleware that is to be called if the request cannot be handled
      */
-    proxy(req: Request, res: Response, next: NextFunction): void;
+    proxy(req: Request, res: Response, next: NextFunction): Promise<void>;
 }
 //# sourceMappingURL=adp-preview.d.ts.map

package/dist/preview/adp-preview.js

@@ -33,8 +33,7 @@ class AdpPreview {
     get resources() {
         if (this.mergedDescriptor) {
             const resources = {
-                [this.mergedDescriptor.name]: this.mergedDescriptor.url,
-                [this.mergedDescriptor.manifest['sap.app'].id]: this.mergedDescriptor.url
+                [this.mergedDescriptor.name]: this.mergedDescriptor.url
             };
             this.mergedDescriptor.asyncHints.libs.forEach((lib) => {
                 var _a;
@@ -52,24 +51,26 @@ class AdpPreview {
      * Constructor taking the config and a logger as input.
      *
      * @param config adp config
+     * @param project reference to the root of the project
      * @param logger logger instance
      */
-    constructor(config, logger) {
+    constructor(config, project, logger) {
         this.config = config;
+        this.project = project;
         this.logger = logger;
     }
     /**
      * Fetch all required configurations from the backend and initialize all configurations.
      *
      * @param descriptorVariant descriptor variant from the project
-     * @param files all relevant project files (e.g. webapp content)
      * @returns the UI5 flex layer for which editing is enabled
      */
-    init(descriptorVariant, files) {
+    init(descriptorVariant) {
         return __awaiter(this, void 0, void 0, function* () {
             const provider = yield (0, service_1.createProvider)(this.config, this.logger);
             const lrep = provider.getLayeredRepository();
             const zip = new yazl_1.ZipFile();
+            const files = yield this.project.byGlob('**/*.*');
             for (const file of files) {
                 zip.addBuffer(yield file.getBuffer(), file.getPath().substring(1));
             }
@@ -88,16 +89,24 @@ class AdpPreview {
      * @param next next middleware that is to be called if the request cannot be handled
      */
     proxy(req, res, next) {
-        if (req.path.endsWith('manifest.json')) {
-            res.status(200);
-            res.send(JSON.stringify(this.descriptor.manifest, undefined, 2));
-        }
-        else if (req.path.endsWith('Component-preload.js')) {
-            res.status(404).send();
-        }
-        else {
-            next();
-        }
+        return __awaiter(this, void 0, void 0, function* () {
+            if (req.path === '/manifest.json') {
+                res.status(200);
+                res.send(JSON.stringify(this.descriptor.manifest, undefined, 2));
+            }
+            else if (req.path === '/Component-preload.js') {
+                res.status(404).send();
+            }
+            else {
+                const files = yield this.project.byGlob(req.path);
+                if (files.length === 1) {
+                    res.status(200).send(yield files[0].getString());
+                }
+                else {
+                    next();
+                }
+            }
+        });
     }
 }
 exports.AdpPreview = AdpPreview;

package/package.json

@@ -9,12 +9,13 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aadp-tooling"
   },
-  "version": "0.1.0",
+  "version": "0.1.2",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
   "files": [
     "LICENSE",
+    "templates",
     "dist",
     "ui5.yaml",
     "bin",
@@ -46,7 +47,7 @@
     "nock": "13.2.1",
     "rimraf": "5.0.1",
     "supertest": "6.3.2",
-    "@sap-ux/project-access": "1.10.1"
+    "@sap-ux/project-access": "1.11.0"
   },
   "engines": {
     "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",

package/templates/gitignore.tmpl

@@ -0,0 +1,5 @@
+node_modules/
+dist/
+.tmp
+.env
+*.zip

package/templates/package.json

@@ -0,0 +1,23 @@
+{
+    "name": "<%= package.name %>",
+    "version": "0.1.0",
+    "private": true,
+    "description": "<%= package.description %>",
+    "keywords": [
+        "ui5",
+        "openui5",
+        "sapui5"
+    ],
+    "dependencies": {},
+    "devDependencies": {
+        "@sap-ux/backend-proxy-middleware": "^0.6.61",
+        "@sap-ux/preview-middleware": "^0.3.1",
+        "@sap-ux/ui5-proxy-middleware": "^1.1.31",
+        "@ui5/cli": "^3.3.2"
+    },
+    "scripts": {
+        "build": "ui5 build --clean-dest",
+        "start": "ui5 serve --open /test/flp.html#app-preview",
+        "editor": "ui5 serve --open /test/flp.html?fiori-tools-rta-mode=forAdaptation#app-preview"
+    }
+}

package/templates/ui5.yaml

@@ -0,0 +1,6 @@
+# yaml-language-server: $schema=https://sap.github.io/ui5-tooling/schema/ui5.yaml.json
+
+specVersion: "3.0"
+metadata:
+  name: <%- app.id %>
+type: application

package/templates/webapp/i18n/i18n.properties

@@ -0,0 +1,6 @@
+# This is the resource bundle for <%- app.id %>
+
+#Texts for manifest.json
+
+#XTIT: Application name
+<%- app.id %>_sap.app.title=<%- app.title %>

package/templates/webapp/manifest.appdescr_variant

@@ -0,0 +1,29 @@
+{
+  "fileName": "manifest",
+  "layer": "<%- app.layer %>",
+  "fileType": "appdescr_variant",
+  "reference": "<%- app.reference %>",
+  "id": "<%- app.id %>",
+  "namespace": "apps/<%- app.reference %>/appVariants/<%- app.id %>/",
+  "version": "0.1.0",
+  "content": [
+    {
+      "changeType": "appdescr_app_setTitle",
+      "content": {},
+      "texts": {
+        "i18n": "i18n/i18n.properties"
+      }
+    },
+    {
+      "changeType": "appdescr_ui5_addNewModelEnhanceWith",
+      "content": {
+        "modelId": "i18n",
+        "bundleUrl": "i18n/i18n.properties",
+        "supportedLocales": [
+          ""
+        ],
+        "fallbackLocale": ""
+      }
+    }
+  ]
+}