@sap/cds-dk 4.8.2 → 4.9.2

package/lib/init/template/kibana-logging/index.js

@@ -0,0 +1,64 @@
+const cds = require('@sap/cds')
+const fs = require('fs');
+const path = require('path');
+
+const ProjectReader = require('../../util/projectReader');
+
+const TemplateBase = require('../templateBase');
+
+const { PROJECT_TYPE, } = require('../../constants');
+const { srvNode, srvJava, kibanaLogging } = require('../_merging/existences');
+
+module.exports = class KibanaTemplate extends TemplateBase {
+    constructor(projectPath, generator) {
+        super(projectPath, generator, __dirname);
+        this.projectReader = new ProjectReader(this);
+    }
+
+    async runMTAMerging() {
+        const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
+
+        if (!fs.existsSync(mtaYAMLPath)) {
+            console.warn(`Cannot add Kibana Logging as there is no 'mta.yaml' deploy descriptor in your project. Run 'cds add mta' to add it.`)
+            return;
+        }
+
+        const projectDescriptor = await this.projectReader.read(this.options);
+        const srv = projectDescriptor.cap.isNodejs ? srvNode : srvJava
+
+        await this.templateUtil.mergeYAML(
+            mtaYAMLPath,
+            `${__dirname}/files/mta.yaml.hbs`,
+            projectDescriptor,
+            {
+                existences: [srv, kibanaLogging],
+                relationships: [{
+                    in: srv,
+                    inKeyPath: ["requires"],
+                    into: "name",
+                    existences: [kibanaLogging],
+                    existenceKeyPath: ["name"],
+                }],
+            }
+        );
+    }
+
+    async run() {
+        const projectType = await this.getProjectType();
+        
+        switch (projectType) {
+            case PROJECT_TYPE.java:
+            default:
+                cds.error(`kibana-logging is not implemented for project type '${projectType}' yet`);
+                // TODO: implement
+                break;
+            case PROJECT_TYPE.nodejs: {
+                const projectDescriptor = await this.projectReader.read(this.options);
+                const cdsTemplateFile = projectDescriptor.cap.for ? 'cds.profile.package.json.hbs' : 'cds.package.json'
+                const cdsTemplatePath = path.join(__dirname, 'files', cdsTemplateFile)
+                await this.templateUtil.mergeJSON(path.join(this.projectPath, 'package.json'), cdsTemplatePath, projectDescriptor)
+            }
+        }        
+        await this.runMTAMerging()
+    }
+}

package/lib/init/template/mta/files/mta.yaml.hbs

@@ -9,12 +9,6 @@ build-parameters:
   before-all:
     - builder: custom
       commands:
-{{#cap.isNodejs}}
-        - npm ci
-{{/cap.isNodejs}}
-{{#cap.isJava}}
-        - npm install --production
-{{/cap.isJava}}
         - npx -p @sap/cds-dk cds build --production
 
 modules:
@@ -34,8 +28,9 @@ modules:
       SPRING_PROFILES_ACTIVE: cloud
     build-parameters:
       builder: custom
-      commands: [ mvn clean package ]
-      build-result: "target/*-exec.[wj]ar"
+      commands:
+        - mvn clean package -DskipTests=true
+      build-result: target/*-exec.jar
 {{/cap.isJava}}
     provides:
       - name: srv-api # required by consumers of CAP services (e.g. approuter)

package/lib/init/template/mta/index.js

@@ -1,4 +1,5 @@
-const path = require('path');
+const { existsSync } = require('fs');
+const { join } = require('path');
 const TemplateBase = require('../templateBase');
 const ProjectReader = require('../../util/projectReader');
 
@@ -10,13 +11,18 @@ module.exports = class MtaTemplate extends TemplateBase {
 
     async run() {
         const projectDescriptor = await this.projectReader.read();
-        if (!await this.fsUtil.pathExists(path.join(this.projectPath, 'mta.yaml'))) {
+        if (!existsSync(join(this.projectPath, 'mta.yaml'))) {
             await this.templateUtil.copyFiles('.', this.projectPath, projectDescriptor);
         }
 
         // Re-applying the merging part of `cds add xsuaa`, `cds add hana`, and `cds add mtx`, if necessary.
         // TODO: Find a generic solution for situation like these. Probably involves some restructuring in the
         // project reader, so that there's a logical mapping from hasX to XTemplate.
+        if (projectDescriptor.cap.hasApprouter) {
+            const ApprouterTemplate = require(`../approuter`)
+            const template = new ApprouterTemplate(this.projectPath, this.generator)
+            await template.runMTAMerging()
+        }
         if (projectDescriptor.cap.hasHana) {
             const HanaTemplate = require(`../hana`)
             const template = new HanaTemplate(this.projectPath, this.generator)

package/lib/init/template/mtx/files/cds.package.json

@@ -1,20 +1,8 @@
 {
   "cds": {
     "requires": {
-      "auth": {
-        "strategy": "JWT"
-      },
-      "db": {
-        "kind": { "#overwrite": "hana" },
-        "vcap": {
-          "label": "service-manager"
-        }
-      },
       "multitenancy": true
     },
-    "hana": {
-      "deploy-format": "hdbtable"
-    },
     "mtx": {
       "element-prefix": "Z_",
       "namespace-blocklist": [],

package/lib/init/template/mtx/files/cds.package.json.hbs

@@ -0,0 +1,14 @@
+{
+  "cds": {
+    "requires": {
+      "[{{cap.for}}]": {
+        "multitenancy": true
+      }
+    },
+    "mtx": {
+      "element-prefix": "Z_",
+      "namespace-blocklist": [],
+      "extension-allowlist": []
+    }
+  }
+}

package/lib/init/template/mtx/files/java/.cdsrc.json

@@ -0,0 +1,17 @@
+{
+  "build": {
+    "tasks": [
+      {
+        "for": "java-cf"
+      },
+      {
+        "for": "mtx",
+        "src": ".",
+        "dest": "mtx-sidecar"
+      },
+      {
+        "for": "hana"
+      }
+    ]
+  }
+}

package/lib/init/template/mtx/files/java/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "cap-mtx-sidecar",
+  "dependencies": {
+    "@sap/cds": "^5.4.3",
+    "@sap/cds-mtx": "^2.2.0",
+    "@sap/hdi-deploy": "^4.3.0",
+    "@sap/instance-manager": "^3.0.0",
+    "@sap/xssec": "^3",
+    "@sap/hana-client": "^2.8.16",
+    "express": "^4.17.1",
+    "passport": "^0.5.0"
+  },
+  "scripts": {
+    "start": "node server.js"
+  },
+  "engines": {
+    "node": ">=12.18"
+  },
+  "cds": {
+    "features": {
+      "kibana_formatter": true
+    },
+    "build": {
+      "tasks": [
+        {
+          "for": "hana"
+        },
+        {
+          "for": "java-cf"
+        }
+      ]
+    },
+    "requires": {
+      "auth": {
+        "kind": "xsuaa"
+      },
+      "db": {
+        "kind": "hana-mt"
+      },
+      "multitenancy": true
+    }
+  }
+}

package/lib/init/template/mtx/files/java/server.js

@@ -0,0 +1,30 @@
+const app = require('express')();
+const cds = require('@sap/cds');
+
+const main = async () => {
+	app.use(defaults.correlate);
+
+	await cds.connect.to('db');
+	const PORT = process.env.PORT || 4004;
+	await cds.mtx.in(app);
+
+	app.listen(PORT);
+}
+
+const defaults = {
+	get correlate() {
+		return (req, _, next) => {
+			if (!cds.context) cds.context = {}
+			const id = cds.context.id
+				|| req.headers['x-correlation-id'] || req.headers['x-correlationid']
+				|| req.headers['x-request-id'] || req.headers['x-vcap-request-id']
+				|| cds.utils.uuid()
+			cds.context.id = req.headers['x-correlation-id'] = id
+			if (!cds.context._) cds.context._ = {}
+			if (!cds.context._.req) cds.context._.req = req
+			next();
+		}
+	}
+}
+
+main();

package/lib/init/template/mtx/files/mta.yaml.hbs

@@ -11,7 +11,7 @@ modules:
     requires:
       - name: {{cap.appName}}-registry
 {{#cap.isJava}}
-      - name: sidecar
+      - name: mtx-sidecar
         properties:
           CDS_MULTITENANCY_SIDECAR_URL: ~{url}
 {{/cap.isJava}}
@@ -33,10 +33,10 @@ modules:
       memory: 256M
       disk-quota: 512M
     requires:
-      - name: bookshop-db
-      - name: bookshop-uaa
+      - name: {{cap.appName}}-db
+      - name: {{cap.appName}}-auth
     provides:
-      - name: sidecar
+      - name: mtx-sidecar
         properties:
           url: ${default-url}
 {{/cap.isJava}}
@@ -66,8 +66,8 @@ resources:
           onSubscription: ~{mtx-api/mtx-url}/mtx/v1/provisioning/tenant/{tenantId}
 {{/cap.isNodejs}}
 {{#cap.isJava}}
-          getDependencies: ~${srv-api/srv-url}/mt/v1.0/subscriptions/dependencies
-          onSubscription: ~${srv-api/srv-url}/mt/v1.0/subscriptions/tenants/{tenantId}
+          getDependencies: ~{srv-api/srv-url}/mt/v1.0/subscriptions/dependencies
+          onSubscription: ~{srv-api/srv-url}/mt/v1.0/subscriptions/tenants/{tenantId}
 {{/cap.isJava}}
           onSubscriptionAsync: false
           onUnSubscriptionAsync: false

package/lib/init/template/mtx/index.js

@@ -1,9 +1,14 @@
+const cds = require ('@sap/cds/lib'), { fs, path } = cds.utils
 const TemplateBase = require('../templateBase')
 const ProjectReader = require('../../util/projectReader')
-const { fse } = require('@sap/cds-foss')
-const path = require('path')
 const { OPTION_HANA, OPTION_XSUAA } = require('../../constants')
-const { srvNode, srvJava, saasRegistry, mtxSidecar, mtxAPI, srvAPI, hdiContainer, xsuaa } = require('../_merging/existences');
+
+const {
+    srvNode, srvJava, // Server
+    mtxSidecar, // Additional Modules
+    saasRegistry, xsuaa, // BTP Services
+    providedMtxAPI, srvAPI, providedMtxSidecarAPI, requiredMtxSidecarAPI // APIs
+} = require('../_merging/existences');
 
 module.exports = class MtxTemplate extends TemplateBase {
     constructor(projectPath, generator) {
@@ -19,36 +24,38 @@ module.exports = class MtxTemplate extends TemplateBase {
         const projectDescriptor = await this.projectReader.read()
 
         const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
-        if (!fse.existsSync(mtaYAMLPath)) {
-            console.warn(`There is no MTA file in your project. Run \`cds add mta\` to add an MTA file or create the MTX services yourself.`)
-            return;
-        }
+
+        if (!fs.existsSync(mtaYAMLPath)) return
 
         const mergingRules = projectDescriptor.cap.isNodejs ?
         {
-            existences: [srvNode, saasRegistry, mtxAPI, xsuaa],
+            existences: [srvNode, saasRegistry, providedMtxAPI, xsuaa],
             overwrites: [{
-                in: xsuaa.ref,
+                in: xsuaa,
                 keyPath: ["parameters", "config", "tenant-mode"],
                 replacement: "shared"
             }],
-            deletions: [hdiContainer],
             relationships: [{
-                in: srvNode.ref,
+                in: srvNode,
                 inKeyPath: ["requires"],
                 into: "name",
-                existences: [saasRegistry.ref],
+                existences: [saasRegistry],
                 existenceKeyPath: ["name"],
             }],
         }
         :
         {
-            existences: [srvJava, srvAPI, mtxSidecar, saasRegistry],
+            existences: [srvJava, srvAPI, mtxSidecar, xsuaa, saasRegistry, providedMtxSidecarAPI, requiredMtxSidecarAPI],
+            overwrites: [{
+                in: xsuaa,
+                keyPath: ["parameters", "config", "tenant-mode"],
+                replacement: "shared"
+            }],
             relationships: [{
-                in: srvJava.ref,
+                in: srvJava,
                 inKeyPath: ["requires"],
                 into: "name",
-                existences: [saasRegistry.ref, mtxSidecar.ref],
+                existences: [saasRegistry],
                 existenceKeyPath: ["name"],
             }],
         }
@@ -59,13 +66,18 @@ module.exports = class MtxTemplate extends TemplateBase {
             projectDescriptor,
             mergingRules
         )
+
+        if (projectDescriptor.cap.hasApprouter) {
+            const ApprouterTemplate = require(`../approuter`)
+            const template = new ApprouterTemplate(this.projectPath, this.generator)
+            await template.runMTAMerging()
+        }
     }
 
     async runXSSecurityMerging() {
         const projectDescriptor = await this.projectReader.read()
-        const mtxPath = projectDescriptor.cap.isJava ? 'mtx-sidecar' : ''
         await this.templateUtil.mergeJSON(
-            path.join(this.projectPath, mtxPath, 'xs-security.json'),
+            path.join(this.projectPath, 'xs-security.json'),
             path.join(__dirname, 'files', 'xs-security.json.hbs'),
             projectDescriptor,
             {
@@ -131,11 +143,18 @@ module.exports = class MtxTemplate extends TemplateBase {
     }
 
     async run() {
-        const projectDescriptor = await this.projectReader.read()
-        const mtxPath = projectDescriptor.cap.isJava ? 'mtx-sidecar' : ''
-        const packageJsonPath = path.join(this.projectPath, mtxPath, 'package.json')
-        await this.templateUtil.mergeJSON(packageJsonPath, path.join(__dirname, 'files', 'cds.package.json'))
-        await this.templateUtil.mergeJSON(packageJsonPath, path.join(__dirname, 'files', 'dependencies.package.json'))
+        const projectDescriptor = await this.projectReader.read(this.options)
+        if (projectDescriptor.cap.isNodejs) {
+            const packageJSONPath = path.join(this.projectPath, 'package.json')
+            const cdsTemplateFile = projectDescriptor.cap.for ? 'cds.package.json.hbs' : 'cds.package.json'
+            await this.templateUtil.mergeJSON(packageJSONPath, path.join(__dirname, 'files', cdsTemplateFile), projectDescriptor)
+            await this.templateUtil.mergeJSON(packageJSONPath, path.join(__dirname, 'files', 'dependencies.package.json'))
+            await this.templateUtil.sortDependencies(packageJSONPath)
+        } else {
+            const cdsrcJSONPath = path.join(this.projectPath, '.cdsrc.json')
+            await this.templateUtil.mergeJSON(cdsrcJSONPath, path.join(__dirname, 'files', 'java', '.cdsrc.json'))
+            await fs.copy(path.join(__dirname, 'files', 'java'), path.join(this.projectPath, 'mtx-sidecar'))
+        }
         await this.runXSSecurityMerging()
         await this.runMTAMerging()
     }

package/lib/init/template/templateBase.js

@@ -11,8 +11,11 @@ module.exports = class TemplateBase {
      * @constructor
      */
     constructor(projectPath, generator, dirName) {
-        this.projectPath = path.resolve(projectPath);
+        if (generator.options && generator.options.for && typeof generator.options.for !== 'string') {
+            throw new Error('The --for argument must not be empty.')
+        }
         this.options = generator.options || {};
+        this.projectPath = path.resolve(projectPath);
         this.fsUtil = generator.fsUtil;
         this.logger = generator.logger;
         this.generator = generator;

package/lib/init/template/xsuaa/files/cds.cdsrc.json

@@ -0,0 +1,7 @@
+{
+  "requires": {
+    "auth": {
+      "kind": "xsuaa"
+    }
+  }
+}

package/lib/init/template/xsuaa/files/cds.cdsrc.json.hbs

@@ -0,0 +1,9 @@
+{
+  "requires": {
+    "[{{cap.for}}]": {
+      "auth": {
+        "kind": "xsuaa"
+      }
+    }
+  }
+}

package/lib/init/template/xsuaa/files/cds.package.json

@@ -1,7 +1,7 @@
 {
   "cds": {
     "requires": {
-      "uaa": {
+      "auth": {
         "kind": "xsuaa"
       }
     }

package/lib/init/template/xsuaa/files/cds.package.json.hbs

@@ -0,0 +1,11 @@
+{
+  "cds": {
+    "requires": {
+      "[{{cap.for}}]": {
+        "auth": {
+          "kind": "xsuaa"
+        }
+      }
+    }
+  }
+}

package/lib/init/template/xsuaa/files/mta.yaml.hbs

@@ -3,10 +3,10 @@ modules:
   - name: {{cap.appName}}-srv
     type: {{cap.pLanguage}}
     requires:
-      - name: {{cap.appName}}-uaa
+      - name: {{cap.appName}}-auth
 
 resources:
-  - name: {{cap.appName}}-uaa{{#cap.isMultitenant}}-mt{{/cap.isMultitenant}}
+  - name: {{cap.appName}}-auth
     type: org.cloudfoundry.managed-service
     parameters:
       service: xsuaa

package/lib/init/template/xsuaa/index.js

@@ -1,8 +1,9 @@
+const fs = require('fs')
+const path = require('path')
 const TemplateBase = require('../templateBase')
 const ProjectReader = require('../../util/projectReader')
-const { fse } = require('@sap/cds-foss')
-const path = require('path')
-const { srvNode, srvJava, xsuaa } = require('../_merging/existences');
+const { srvNode, srvJava, xsuaa } = require('../_merging/existences')
+const { PROJECT_TYPE } = require('../../constants');
 
 module.exports = class XsuaaTemplate extends TemplateBase {
     constructor(projectPath, generator) {
@@ -12,12 +13,11 @@ module.exports = class XsuaaTemplate extends TemplateBase {
 
     async runMTAMerging() {
         const projectDescriptor = await this.projectReader.read(this.options)
-        const {projectPath} = this
+        const { projectPath } = this
+
         const mtaYAMLPath = path.join(projectPath, 'mta.yaml')
-        if (!fse.existsSync(mtaYAMLPath)) {
-            console.warn(`There is no MTA file in your project. Run \`cds add mta\` to add an MTA file or create the XSUAA services yourself.`)
-            return
-        }
+        if (!fs.existsSync(mtaYAMLPath)) return
+
         const srv = projectDescriptor.cap.isNodejs ? srvNode : srvJava
         await this.templateUtil.mergeYAML(
             mtaYAMLPath,
@@ -26,10 +26,10 @@ module.exports = class XsuaaTemplate extends TemplateBase {
             {
                 existences: [srv, xsuaa],
                 relationships: [{
-                    in: srv.ref,
+                    in: srv,
                     inKeyPath: ["requires"],
                     into: "name",
-                    existences: [xsuaa.ref],
+                    existences: [xsuaa],
                     existenceKeyPath: ["name"],
                 }],
             }
@@ -46,30 +46,46 @@ module.exports = class XsuaaTemplate extends TemplateBase {
     }
 
     async run() {
-        const {projectPath} = this
+        const { projectPath } = this
         const templatePath = path.join(__dirname, 'files')
-        const packageJSONPath = path.join(projectPath, 'package.json')
-        await this.templateUtil.mergeJSON(packageJSONPath, `${templatePath}/cds.package.json`)
-        await this.templateUtil.mergeJSON(packageJSONPath, `${templatePath}/dependencies.package.json`)
-        const xsSecurityPath = path.join(projectPath, 'xs-security.json')
+        const projectDescriptor = await this.projectReader.read(this.options)
+
+        const projectType = await this.getProjectType();
+        switch (projectType) {
+            case PROJECT_TYPE.java: {
+                const cdsrcJSONPath = path.join(projectPath, '.cdsrc.json')
+                const cdsTemplateFile = projectDescriptor.cap.for ? 'cds.cdsrc.json.hbs' : 'cds.cdsrc.json'
+                const cdsTemplatePath = path.join(templatePath, cdsTemplateFile)
+                await this.templateUtil.mergeJSON(cdsrcJSONPath, cdsTemplatePath, projectDescriptor)
+                break
+            }
+            case PROJECT_TYPE.nodejs: {
+                const packageJSONPath = path.join(projectPath, 'package.json')
+                const cdsTemplateFile = projectDescriptor.cap.for ? 'cds.package.json.hbs' : 'cds.package.json'
+                const cdsTemplatePath = path.join(templatePath, cdsTemplateFile)
+                await this.templateUtil.mergeJSON(packageJSONPath, cdsTemplatePath, projectDescriptor)
+                const dependenciesTemplatePath = path.join(templatePath, 'dependencies.package.json')
+                await this.templateUtil.mergeJSON(packageJSONPath, dependenciesTemplatePath)
+                break
+            }
+        }
         const cds = require('../../../../lib/compile')
         const xsuaa = await (async () => { try {
-            const models = await cds.load(`${projectPath}/srv`)
+            const models = await cds.load(path.join(projectPath, cds.env.folders.srv))
             return cds.compile.to.xsuaa(models)
         } catch (error) { /* ignore */ }
         })() || { scopes: [], attributes: [], 'role-templates': [] }
-        const projectDescriptor = await this.projectReader.read(this.options)
-        await this.fsUtil.writeJSON(xsSecurityPath, xsuaa)
-
-        // TODO: Get rid of this by auto-creating a merging definition from
-        // the current xs-security.json. This should also solve role-templates
-        // being thrown out
-        if (projectDescriptor.cap.isMultitenant) {
-            const MtxTemplate = require(`../mtx`)
-            const mtxTemplate = new MtxTemplate(this.projectPath, this.generator)
-            await mtxTemplate.runXSSecurityMerging()
-        }
 
+        const mergingSemantics = { existences: xsuaa.scopes.map(scope => ({
+            ref: scope.name,
+            keyPath: ["scopes"],
+            constraints: [{
+                comparisonKeyPath: ["name"],
+                value: scope.name
+            }],
+        }))}
+        const xsSecurityPath = path.join(projectPath, 'xs-security.json')
+        await this.templateUtil.mergeJSON(xsSecurityPath, xsuaa, projectDescriptor, mergingSemantics)
         await this.runMTAMerging()
     }
 }

package/lib/init/types.d.ts

@@ -69,20 +69,26 @@ export interface Logger {
  */
 export interface FsUtil {
   /**
-   * Copies a file or folder from given source to destination.
-   * @param source the source path
-   * @param destination the destination path
-   * @param options optional copy options
-   * @param skipFileLog do not log files if true
+   * Writes the given string into a file.
+   * @param filepath the absolute file path
+   * @param content the string to serialize to JSON
    */
-  copy(source: string, destination: string, options?: any, skipFileLog?: boolean): Promise<void>;
+  writeFile(filePath: string, content: string, skipLogFile?: boolean): Promise<void>;
 
   /**
-   * Checks if given path exists.
-   * @param filePath the absolute path
-   * @returns true if given path exists, otherwise false
+   * Writes the given object as JSON into a file.
+   * @param filepath the absolute file path
+   * @param object the object to serialize to JSON
    */
-  pathExists(filePath: string): Promise<boolean>;
+  writeJSON(filepath: string, object: any, options?: any): Promise<void>;
+
+  /**
+   * Writes YAML object
+   * @param filepath the absolute file path
+   * @param yaml the yaml object
+   * @param skipFileLog do not log files if true
+   */
+  writeYAML(filepath: string, yaml: any, skipFileLog?: boolean): Promise<void>;
 
   /**
    * Reads a file from given path.
@@ -95,23 +101,41 @@ export interface FsUtil {
   /**
    * Reads a JSON object from a file.
    * @param filePath the absolute file path
+   * @param projectDescriptor a project descriptor
    * @returns the file content as object
    */
-  readJSON(filePath: string): Promise<any>;
+  readJSON(filePath: string, projectDescriptor: any): Promise<any>;
 
   /**
-   * Writes the given string into a file.
-   * @param filepath the absolute file path
-   * @param content the string to serialize to JSON
+   * Reads a JSON object from a file.
+   * @param filePath the absolute file path
+   * @returns the file content as object
    */
-  writeFile(filePath: string, content: string, skipLogFile?: boolean): Promise<void>;
+  readJSONC(filePath: string): Promise<any>;
 
   /**
-   * Writes the given object as JSON into a file.
-   * @param filepath the absolute file path
-   * @param object the object to serialize to JSON
+   * Reads a JSON object from a file.
+   * @param filePath the absolute file path
+   * @param projectDescriptor a project descriptor
+   * @returns the file content as yaml object
    */
-  writeJSON(filepath: string, object: any, options?: any): Promise<void>;
+  readYAML(filePath: string, projectDescriptor: any): Promise<any>;
+
+  /**
+  * Copies a file or folder from given source to destination.
+  * @param source the source path
+  * @param destination the destination path
+  * @param options optional copy options
+  * @param skipFileLog do not log files if true
+  */
+  copy(source: string, destination: string, options?: any, skipFileLog?: boolean): Promise<void>;
+
+  /**
+   * Checks if given path exists.
+   * @param filePath the absolute path
+   * @returns true if given path exists, otherwise false
+   */
+  pathExists(filePath: string): Promise<boolean>;
 
   /*
   * Methods mapping to fs-extra