@sap/cds 6.4.1 → 6.5.0

package/CHANGELOG.md

@@ -4,24 +4,59 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 6.5.0 - 2023-01-27
+
+### Added
+
+- New aspect `sap.common.TextsAspect` in common.cds
+- New syntax for collection bound entities
+
+### Changed
+
+- Successive calls to `SELECT.where()` wraps existing clause in brackets if it contains `or`. E.g.
+   ```js
+   SELECT.from `X` .where `x` .or `y` .where `z` 
+   //> SELECT from X where (x or y) and z`
+   ```
+- `cds build` for HANA now adds an `engines.node` version to the generated `db/package.json`. This will help in the future when runtime environments change their default to some version higher than the one supported by `@sap/hdi-deploy`.
+- `cds build` checks the consistency of built-in models for java projects. An error is logged if some model files could not successfully be resolved indicating that a required npm module might be missing.
+- Status code of draft actions are set in respective handler instead of protocol adapter
+- `cds deploy --dry` no longer loads the `sqlite3` module by mistake. This fixes a regression when building Java projects. As a side effect a file with the name `undefined` was created in the project root folder. 
+- Internal representation of pseudo roles `internal-user` and `system-user`
+
+### Fixed
+
+- Resolve i18n folders from the root directory
+- Types for `cds.test`
+- Types for `srv.send`
+- Optimized Search: Search queries for localized entities will now use default values, if no localized data is found in the corresponding localized tables on SAP HANA. Correct aliasing by search queries with navigation.
+- Resolution of `type of` references during minify in bootstrap
+- Generation of odata-v2 URL in case of select=* in `urlify()`
+- Build resets changed `cds.env` and `cds.root` when finished
+- Expand error when using infix filters
+- CDS configuration schema validation for `@sap/cds-mtxs`
+- Typings for QL API
+- Return types of asynchronous service API
+
 ## Version 6.4.1 - 2022-01-16
 
 ### Fixed
 
 - `cds build` correctly creates a `resources.tgz` file for MTXS projects on Windows
-- `cds.deploy` for HANA now doesn't try to search for a globally installed `@sap/hdi-deploy` if there's no `npm` installed, e.g. on a Node.js server without `npm`.
+- `cds.deploy` for HANA now doesn't try to search for a globally installed `@sap/hdi-deploy` if there's no `npm` installed, e.g. on a Node.js server without `npm`
 - Signature for `cds.ql.UPSERT`
 - Signature for `<srv>.delete().where()`
 - Signature for `SELECT.alias`
 - `UPSERT` requests for SQLite if only keys are provided
-- `cds.test` doesn't log database resets with `autoReset` enabled any more.
-- The `cds.deploy` output for HANA is now correctly formatted in Kibana.
+- `cds.test` doesn't log database resets with `autoReset` enabled any more
+- The `cds.deploy` output for HANA is now correctly formatted in Kibana
 - SAP HANA stored procedures containing implicit selects
 - Shorthand configuration for `graphql` in `cds.env.protocols`
 - If `cds.env.protocols` is set, `cds.requires.middlewares` is automatically turned on
 - `cds.context` middleware is split to initial handling of request correlation and user propagation
 - fix view resolving and managed data for UPSERT
 - `cds.linked` supports polymorphic self links like in: `action foo( self: [many] $self, ...)`
+- Error with `@odata.draft.enabled` and `@restrict`
 
 ## Version 6.4.0 - 2022-12-15
 
@@ -33,11 +68,12 @@
 - `persistent-outbox`: Support for parallel processing with option `parallel: true` as well as pluggable processor functions through `service.outbox.process` (beta)
 - `cds version` now also lists packages with `@cap-js/` prefix from dependencies
 - `cds.context.http` is now available for webhook-based requests
-- `cds build` for HANA migration tables now only saves model entities annotated with `@cds.persistence.journal` as `last-dev` version.
+- `cds build` for SAP HANA migration tables now only saves model entities annotated with `@cds.persistence.journal` as `last-dev` version.
 - `cds deploy` now uses the `VCAP_SERVICES` environment variable (if set), and skips `cf` operations in this case
 
 ### Changed
 
+- Added several missing signatures in CQN types that are now in accordance with the current documentation.
 - `.columns(…)` of both `cql.SELECT` and `cql.INSERT` give improved code completion when paired when appropriate type definitions are present
 - Status code of error messages caused by empty `not null` fields is changed from `400` to `500` on database layer. Note, that as result the error message `Value is required` in production will be replaced by `Internal server error` in the HTTP response.
 - Underscores in environment variables can now be escaped by two `__` to set keys in `cds.env`.  For example, use `CDS_FEATURES_WITH__MOCKS=...` to set `features.with_mocks`.  Note that previously, this ended up as  `features: { with_: { mocks:... }}`, so in rare cases, it might yield unexpected results.
@@ -68,6 +104,7 @@
 - Quoting of keys typed as `cds.String` in error targets. Error targets are a relative resource path to correlate error
 messages with the corresponding text input filed in the UI in an OData HTTP error response body for errors, warnings,
 and info messages. For example:
+- Error with `GET` on `actions`
 
 ```diff
 HTTP/1.1 400 Bad Request
@@ -88,8 +125,8 @@ Content-Length: 145
 ```
 
 - Application crash if batched Uri uses invalid percent encoding
-- `cds build` for HANA no longer produces `hdbtabledata` for csv files that refer to non-existing entities. This can be the case for imported content packages that bring csv files for entities that are not used in the application model.
-- `cds build` for HANA now gives precedence for csv files from application layer. This is important for imported content packages that bring csv files that shall be overwritten in the application layer.
+- `cds build` for SAP HANA no longer produces `hdbtabledata` for csv files that refer to non-existing entities. This can be the case for imported content packages that bring csv files for entities that are not used in the application model.
+- `cds build` for SAP HANA now gives precedence for csv files from application layer. This is important for imported content packages that bring csv files that shall be overwritten in the application layer.
 - `cds build` for Java no longer adds the service `cds.xt.MTXServices` to the application model.
 - `cds build` no longer fails when creating large resource TAR archives for MTXS projects.
 

package/apis/cqn.d.ts

@@ -1,3 +1,5 @@
+import { entity } from "./csn"
+
 export type Query = SELECT | INSERT | UPDATE | DELETE | CREATE | DROP | UPSERT
 export type ParsedExpr = expr & { _:string }
 
@@ -5,6 +7,7 @@ export type SELECT = {SELECT:{
 	distinct?: true
 	one? : boolean
 	from : source
+	mixin?: {[key:string]: expr}
 	columns? : column_expr[]
 	excluding? : string[]
 	where? : predicate
@@ -12,18 +15,23 @@ export type SELECT = {SELECT:{
 	groupBy? : expr[]
 	orderBy? : ordering_term[]
 	limit?: { rows:val, offset:val }
+	forUpdate?: { wait: number }
+	forShareLock?: { wait: number }
+	search?: _xpr
+	count?: boolean
 }}
 
 export type INSERT = {INSERT:{
-	into : name
+	into : name | ref
 	entries : any[]
 	columns : string[]
 	values : any[]
 	rows : any[]
+	as : SELECT
 }}
 
 export type UPSERT = {UPSERT:{
-	into : name
+	into : name | ref
 	entries : any[]
 	columns : string[]
 	values : any[]
@@ -42,11 +50,14 @@ export type DELETE = {DELETE:{
 }}
 
 export type CREATE = {CREATE:{
-	entity : name
+	entity : entity | name
+	as: SELECT
 }}
 
 export type DROP = {DROP:{
 	entity : name
+	table: ref
+	view: ref
 }}
 
 type name = string

package/apis/ql.d.ts

@@ -152,7 +152,7 @@ export class SELECT<T> extends ConstructedQuery {
 	//   & ((...expr : string[]) => this)
 	//   & ((predicate:object) => this)
 
-	SELECT : CQN.SELECT
+	SELECT : CQN.SELECT["SELECT"]
 }
 
 
@@ -209,7 +209,7 @@ export class INSERT<T> extends ConstructedQuery {
 	columns (...col: string[]) : this
 	values (... val: any[]) : this
 	rows (... row: any[]) : this
-	INSERT : CQN.INSERT
+	INSERT : CQN.INSERT["INSERT"]
 }
 
 
@@ -229,7 +229,7 @@ export class UPSERT<T> extends ConstructedQuery {
 	columns (...col: string[]) : this
 	values (... val: any[]) : this
 	rows (... row: any[]) : this
-	UPSERT : CQN.UPSERT
+	UPSERT : CQN.UPSERT["UPSERT"]
 }
 
 
@@ -243,7 +243,7 @@ export class DELETE<T> extends ConstructedQuery {
 	where (...expr : any[]) : this
 	and (predicate:object) : this
 	and (...expr : any[]) : this
-	DELETE : CQN.DELETE
+	DELETE : CQN.DELETE["DELETE"]
 }
 
 export class UPDATE<T> extends ConstructedQuery {
@@ -264,15 +264,15 @@ export class UPDATE<T> extends ConstructedQuery {
 	where (...expr : any[]) : this
 	and (predicate:object) : this
 	and (...expr : any[]) : this
-	UPDATE : CQN.UPDATE
+	UPDATE : CQN.UPDATE["UPDATE"]
 }
 
 export class CREATE<T> extends ConstructedQuery {
 	static entity (entity : Definition | string) : CREATE<any>
-	CREATE : CQN.CREATE
+	CREATE : CQN.CREATE["CREATE"]
 }
 
 export class DROP<T> extends ConstructedQuery {
 	static entity (entity : Definition | string) : DROP<any>
-	DROP : CQN.DROP
-}
+	DROP : CQN.DROP["DROP"]
+}

package/apis/services.d.ts

@@ -1,4 +1,4 @@
-import { SELECT, INSERT, UPDATE, DELETE, Query, ConstructedQuery } from './ql'
+import { SELECT, INSERT, UPDATE, DELETE, Query, ConstructedQuery, UPSERT } from './ql'
 import { Projection, Proxy, Awaitable } from './ql'
 import { ArrayConstructable } from './internal/inference'
 import { LinkedModel, Definition, Definitions } from './reflect'
@@ -31,8 +31,8 @@ export class QueryAPI {
   }
 
   /**
- * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
- */
+   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
+   */
   upsert: {
     <T extends ArrayConstructable<any>>(data: T): UPSERT<T>
     <T>(data: object | object[]): UPSERT<T>
@@ -49,25 +49,11 @@ export class QueryAPI {
   /**
    * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
    */
-  // as delete is the only one of the CRUD methods from QueryAPI
-  // that is extended in Service, we have to add the second signature down there
-  // (TS error 2425)
-  delete<T>(entity: Definition | string, key?: any): DELETE<T>
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
-   */
-  run(query: ConstructedQuery | ConstructedQuery[]): Promise<ResultSet | any>
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
-   */
-  run(query: Query): Promise<ResultSet | any>
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run-sql)
-   */
-  run(query: string, args?: any[] | object): Promise<ResultSet | any>
+  run: {
+    (query: ConstructedQuery | ConstructedQuery[]): Promise<ResultSet | any>
+    (query: Query): Promise<ResultSet | any>
+    (query: string, args?: any[] | object): Promise<ResultSet | any>
+  }
 
   /**
    * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
@@ -77,17 +63,15 @@ export class QueryAPI {
   /**
    * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-stream)
    */
-  stream(column: string): {
-    from(entity: Definition | string): {
-      where(filter: any): ReadableStream
+  stream: {
+    (column: string): {
+      from(entity: Definition | string): {
+        where(filter: any): ReadableStream
+      }
     }
+    (query: Query): Promise<ReadableStream>
   }
 
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-stream)
-   */
-  stream(query: Query): Promise<ReadableStream>
-
   /**
    * Starts or joins a transaction
    * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-tx)
@@ -156,68 +140,51 @@ export class Service extends QueryAPI {
    * Constructs and emits an asynchronous event.
    * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-emit)
    */
-  emit(details: { event: Events; data?: object; headers?: object }): Promise<this>
-
-  /**
-   * Constructs and emits an asynchronous event.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-emit)
-   */
-  emit(event: Events, data?: object, headers?: object): Promise<this>
+  emit: {
+    <T = any>(details: { event: Events; data?: object; headers?: object }): Promise<T>
+    <T = any>(event: Events, data?: object, headers?: object): Promise<T>
+  }
 
   /**
    * Constructs and sends a synchronous request.
    * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srvsend--method-path-data-headers--results-)
    */
-  send(event: Events, path: string, data?: object, headers?: object): Promise<this>
-
-  /**
-   * Constructs and sends a synchronous request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srvsend---method-path--query--event-data-headers---results-)
-   */
-  send(details: { event: Events; data?: object; headers?: object }): Promise<this>
-
-  /**
-   * Constructs and sends a synchronous request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srvsend---method-path--query--event-data-headers---results-)
-   */
-  send(details: { query: ConstructedQuery; data?: object; headers?: object }): Promise<this>
-
-  /**
-   * Constructs and sends a synchronous request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srvsend---method-path--query--event-data-headers---results-)
-   */
-  send(details: { method: Event; path: string; data?: object; headers?: object }): Promise<this>
+  send: {
+    <T = any>(event: Events, path: string, data?: object, headers?: object): Promise<T>
+    <T = any>(event: Events, data?: object, headers?: object): Promise<T>
+    <T = any>(details: { event: Events; data?: object; headers?: object }): Promise<T>
+    <T = any>(details: { query: ConstructedQuery; data?: object; headers?: object }): Promise<T>
+    <T = any>(details: { method: Event; path: string; data?: object; headers?: object }): Promise<T>
+  }
 
   /**
    * Constructs and sends a GET request.
    * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
    */
-  get(entityOrPath: Target, data?: object): Promise<this>
+  get<T = any>(entityOrPath: Target, data?: object): Promise<T>
   /**
    * Constructs and sends a POST request.
    * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
    */
-  post(entityOrPath: Target, data?: object): Promise<this>
+  post<T = any>(entityOrPath: Target, data?: object): Promise<T>
   /**
    * Constructs and sends a PUT request.
    * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
    */
-  put(entityOrPath: Target, data?: object): Promise<this>
+  put<T = any>(entityOrPath: Target, data?: object): Promise<T>
   /**
    * Constructs and sends a PATCH request.
    * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
    */
-  patch(entityOrPath: Target, data?: object): Promise<this>
+  patch<T = any>(entityOrPath: Target, data?: object): Promise<T>
   /**
    * Constructs and sends a DELETE request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
    */
-  delete(entityOrPath: Target, data?: object): DELETE<T>
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
-   */
-  delete<T extends ArrayConstructable<any>>(entity: T, key?: any): DELETE<T>
-  delete<T>(entity: Definition | string, key?: any): DELETE<T>
+  delete: {
+    (entityOrPath: Target, data?: object): DELETE<T>
+    <T extends ArrayConstructable<any>>(entity: T, key?: any): DELETE<T>
+    <T>(entity: Definition | string, key?: any): DELETE<T>
+  }
 
   // The central method to dispatch events
   dispatch(msg: EventMessage): Promise<any>

package/apis/test.d.ts

@@ -57,5 +57,12 @@ declare class Test extends Axios {
 export = cds
 
 declare class cds {
+  /**
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-test?q=cds.test#run)
+   */
   test(projectDir: string): Test;
+  /**
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-test?q=cds.test#run-2)
+   */
+  test(command: string, ...args: string[]): Test;
 }

package/bin/build/buildTaskEngine.js

@@ -2,7 +2,7 @@ const fs = require('fs')
 const path = require('path')
 const cds = require('./cds'), { log } = cds.exec
 const { sortMessagesSeverityAware, deduplicateMessages, CompilationError } = require('@sap/cds-compiler')
-const { relativePaths, BuildError, BuildMessage, resolveRequiredSapModels, hasJavaNature } = require('./util')
+const { relativePaths, BuildError, BuildMessage, resolveRequiredSapModels } = require('./util')
 const { OUTPUT_MODE_DEFAULT, SEVERITIES, LOG_LEVELS, LOG_MODULE_NAMES, CDS_MODEL_EXCLUDE_LIST } = require('./constants')
 const BuildTaskProviderFactory = require('./buildTaskProviderFactory')
 const BuildTaskHandlerInternal = require('./provider/buildTaskHandlerInternal')
@@ -41,16 +41,13 @@ class BuildTaskEngine {
             buildOptions.target = path.resolve(buildOptions.root, cds.env.build.target)
         }
 
-        // Java projects don't have node modules installed on project root level
-        if (!hasJavaNature([buildOptions.root])) {
-            // validate required @sap namespace models - log only
-            const { unresolved, missing } = BuildTaskEngine._resolveRequiredSapServices(tasks)
-            if (unresolved.length > 0) {
-                messages.push(new BuildMessage(`Required CDS service models [${unresolved.join(', ')}] cannot be resolved. Make sure to install the missing npm modules.`))
-            }
-            if (missing.length > 0) {
-                messages.push(new BuildMessage(`Required CDS service models [${missing.join(', ')}] are missing in custom build tasks. Make sure to add the missing models.`))
-            }
+        // validate required @sap namespace models - log only
+        const { unresolved, missing } = BuildTaskEngine._resolveRequiredSapServices(tasks)
+        if (unresolved.length > 0) {
+            messages.push(new BuildMessage(`Required CDS service models [${unresolved.join(', ')}] cannot be resolved. Make sure to install the missing npm modules.`))
+        }
+        if (missing.length > 0) {
+            messages.push(new BuildMessage(`Required CDS service models [${missing.join(', ')}] are missing in custom build tasks. Make sure to add the missing models.`))
         }
 
         // create build task handlers
@@ -337,7 +334,7 @@ class BuildTaskEngine {
     }
 
     /**
-     * Returns a sorted and flatend list of all messages extracted from the given errors.
+     * Returns a sorted and flattened list of all messages extracted from the given errors.
      * @param {Array<Error>} errors
      */
     static _getErrorMessages(errors) {

package/bin/build/buildTaskHandler.js

@@ -3,7 +3,7 @@ const fs = require('fs').promises
 const cds = require('./cds')
 
 const { BUILD_OPTION_OUTPUT_MODE, OUTPUT_MODE_DEFAULT, OUTPUT_MODE_RESULT_ONLY, SEVERITY_INFO, SEVERITY_WARNING, SEVERITY_ERROR, OVERRIDE_METHOD_MSG } = require('./constants')
-const { hasOptionValue, getProperty, relativePaths, BuildMessage } = require('./util')
+const { hasOptionValue, getProperty, relativePaths, copy, BuildMessage } = require('./util')
 
 /**
  * The build task handler creates the build output for a dedicated build task. It is uniquely identified
@@ -157,7 +157,7 @@ class BuildTaskHandler {
                         if (fs.cp) { // Node.js >= 16.7
                             return fs.cp(src, dest, { recursive: true })
                         }
-                        return this._copy(src, dest)
+                        return copy(src, dest)
                     }
                     return dest
                 }
@@ -184,7 +184,7 @@ class BuildTaskHandler {
     async model() {
         const files = this._resolveModel()
         if (!files || files.length === 0) {
-            this._logger.log("no model found, skip build")
+            this._logger.log("no CDS model found")
             return null
         }
         this._logger._debug && this._logger.debug(`model: ${relativePaths(this._buildOptions.root, files).join(", ")}`)
@@ -237,16 +237,5 @@ class BuildTaskHandler {
         }
         return getProperty(this._buildOptions, qualifiedName)
     }
-
-    // Asynchronously copies the entire content from src to dest.
-    async _copy(src, dest) {
-        if ((await fs.stat(src)).isDirectory()) {
-            const entries = await fs.readdir(src)
-            return Promise.all(entries.map(async each => this._copy(path.join(src, each), path.join(dest, each))))
-        } else {
-            await fs.mkdir(path.dirname(dest), { recursive: true })
-            return fs.copyFile(src, dest)
-        }
-    }
 }
 module.exports = BuildTaskHandler

package/bin/build/index.js

@@ -13,7 +13,7 @@ module.exports = Object.assign(build,
 /**
  * New modular build.
  *
- * @param {object} options - commmand options as defined by build command.
+ * @param {object} options - command options as defined by build command.
  */
 async function build(options = {}) {
     const projectPath = path.resolve(options.project || '.')
@@ -22,6 +22,7 @@ async function build(options = {}) {
     }
 
     const cds = require('./cds')
+    const cdsEnv = cds.env, cdsRoot = cds.root
     if (projectPath !== process.cwd()) {
         const env = cds.env.for('cds', projectPath);
         cds.env = env // REVISIT: not good / fragile
@@ -31,17 +32,22 @@ async function build(options = {}) {
     const buildOptions = _mergeCliOptions({ root: projectPath }, options)
     const buildTaskFactory = new BuildTaskFactory(logger)
     const buildTaskEngine = new BuildTaskEngine(logger)
+    let buildResult
 
     try {
         const tasks = await buildTaskFactory.getTasks(buildOptions)
-        return buildTaskEngine.processTasks(tasks, buildOptions)
+        buildResult = await buildTaskEngine.processTasks(tasks, buildOptions)
     } catch (e) {
         // cds CLI layer logs if invoked from CLI
         if (!buildOptions.cli) {
             buildTaskEngine._logMessages(buildOptions, [e])
         }
         throw e
+    } finally {
+        cds.root = cdsRoot
+        cds.env = cdsEnv
     }
+    return buildResult
 }
 
 function _mergeCliOptions(buildOptions, options) {

package/bin/build/provider/buildTaskProviderInternal.js

@@ -191,6 +191,14 @@ class BuildTaskProviderInternal extends BuildTaskProvider {
         }
         this.logger.debug("determining mtx version of nodejs project")
 
+        // preserve order of creation
+        if (BuildTaskProviderInternal._isMtxExtension()) {
+            this.logger.debug("Streamlined MTX extension app")
+            return {
+                for: BUILD_TASK_MTX_EXTENSION
+            }
+        }
+
         if (isStreamlinedMtx()) {
             if (cds.env.requires["cds.xt.ModelProviderService"]?.kind === "rest") { // "cds.xt.ModelProviderService": "from-sidecar"
                 this.logger.debug("Nodejs Streamlined MTX app with sidecar")
@@ -220,13 +228,6 @@ class BuildTaskProviderInternal extends BuildTaskProvider {
             }
         }
 
-        if (BuildTaskProviderInternal._isMtxExtension()) {
-            this.logger.debug("Streamlined MTX extension app")
-            return {
-                for: BUILD_TASK_MTX_EXTENSION
-            }
-        }
-
         if (cds.env.requires.multitenancy) {
             this.logger.debug("Nodejs Classic MTX app without sidecar")
             return {

package/bin/build/provider/hana/template/package.json

@@ -3,6 +3,9 @@
   "dependencies": {
     "@sap/hdi-deploy": "^4"
   },
+  "engines": {
+    "node": "^14 || ^16 || ^18"
+  },
   "scripts": {
     "start": "node node_modules/@sap/hdi-deploy/deploy.js"
   }

package/bin/build/provider/mtx/resourcesTarBuilder.js

@@ -21,12 +21,21 @@ class ResourcesTarBuilder {
             this.handler.pushMessage("No deployment resources found - skip resources.tgz", WARNING)
             return
         }
-        await this.writeTarFile(resources, root, path.join(dest, DEFAULT_TAR_NAME))
+        await this.writeTarFile(path.join(dest, DEFAULT_TAR_NAME), root, resources)
     }
 
-    async writeTarFile(resources, root, tarFile) {
+    /**
+     * Creates a TAR file at the given absolute tarPath. An optional resources list holds the files and folders 
+     * that will be added to the TAR. Paths are relative to the passed root directory. If omitted, the entire 
+     * root directory contents will be added. 
+     * @param {*} tarFile Absolute TAR file name.
+     * @param {*} root The root directory the passed resources are relative to.
+     * @param {*} resources Optional list of absolute or relative resource paths - relative to the given root directory. 
+     * If omitted all resources contained in the root directory are added to the TAR file.
+     */
+    async writeTarFile(tarFile, root, resources) {
         const { tar } = require('../../../../lib').utils
-        await tar.czfd(tarFile, root, resources) // REVISIT: tar.czfd was created for this case only -> it ensures the target's dir exists
+        await tar.czfd(tarFile, root, resources)
         this.handler.pushFile(tarFile)
     }