@sap/cds-dk 8.5.0 → 8.5.1

package/CHANGELOG.md

@@ -3,9 +3,20 @@
 
 All notable changes to this project will be documented in this file.
 
-This project adheres to [Semantic Versioning](http://semver.org/).
+This project adheres to [Semantic Versioning](https://semver.org/).
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/).
+The format is based on [Keep a Changelog](https://keepachangelog.com/).
+
+## Version 8.5.1 - 2024-12-05
+
+### Added
+
+- `cds watch` now detects a TypeScript project and tries to run with `tsx` if this is installed locally or globally. Otherwise a warning message is emitted.  `CDS_TYPESCRIPT=false` can be used to opt out of this behavior.
+
+### Fixed
+
+- `cds add html5-repo` adds an `index.html` as `welcomePage` to the `xs-app.json`, if available.
+- `cds build` now logs existing plugin build messages if a BuildError is thrown.
 
 ## Version 8.5.0 - 2024-11-26
 
@@ -30,6 +41,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 - `cds import` throws proper error message if Annotation element doesn't have Term attribute.
 - `cds add approuter` no longer enforces Node.js 22, which is not supporter by current `@sap/approuter` version 17. The previous Node.js version 20 is used again.
+- `cds add -p` with custom options now works if the entry was not in the `package.json` beforehand.
 - `cds add http` works for actions without parameters.
 - `cds add workzone` includes the `updateManifestJson` task on initial generation.
 - `cds build --ws` no longer creates migration tables in shared database or wrong workspace.

package/bin/cds.js

@@ -1,5 +1,8 @@
 #!/usr/bin/env node
 
+const path = require('node:path')
+const { sep } = { path }
+const fs = require('node:fs')
 
 const cli = {
 
@@ -25,9 +28,6 @@ const cli = {
   },
 
   async exec (cmd = process.argv[2], ...argv) {
-    const path = require('node:path')
-    const fs = require('node:fs')
-
     if (!argv.length) argv = process.argv.slice(3)
     if (!cmd) cmd = process.stdin.isTTY ? 'help' : 'compile'
     if (cmd in this.Shortcuts) cmd = process.argv[2] = this.Shortcuts[cmd]
@@ -66,7 +66,10 @@ const cli = {
             const p = argv[argv.indexOf('-p') + 1] || argv[argv.indexOf('--package') + 1]
             console.log(`running with --package, adding dependency ${p}`)
             await require('../lib/util/command').spawnCommand(`npm`, ['add', p], { cwd: cds.root })
+            delete require.cache[require.resolve(path.join(cds.root,'./package.json'))]
           }
+          cds.env.plugins = cds.env.for('cds').plugins // reload plugin env
+          cds.add = require('../lib/init/add')
           await cds.plugins
           for (const [, Plugin] of cds.add.registered) {
             const all = Object.entries((new Plugin).options())
@@ -86,13 +89,8 @@ const cli = {
 
         if (args[1]?.['resolve-bindings']) await _resolveBindings({ silent: cmd === 'env' })
 
-        // warn users if they are using cds instead of cds-ts in a TypeScript project
-        const tsconfig = path.join(cds.root ?? '.', 'tsconfig.json')
-        if (!process.env.CDS_TYPESCRIPT && cds.cli?.command === 'serve' && fs.existsSync(tsconfig)) {
-          // cds.root may for some subcommands not point to the correct directory (e.g. cds w where users can pass a project directory)
-          // showing the full detected path should give the user an idea whether this info is relevant for them
-          console.error(`Detected ${tsconfig}. If this is a TypeScript project, consider running commands using 'cds-ts' instead of 'cds'.\n`)
-        }
+        _prepareTsIfNeeded(cds)
+
         return await task.apply(this, args)
       }
     } catch (e) {
@@ -231,24 +229,6 @@ function _dieForUnknownCommand(cmd) {
   throw msg;
 }
 
-function _require (id,o) {
-  try { var resolved = require.resolve(id,o) } catch(e){ DEBUG?.(`[cds] - Command not found: ${id}`); return }
-  DEBUG?.(`[cds] - Command resolved: ${resolved}`)
-  return require (resolved)
-}
-
-const { sep } = require ('path')
-if (process[Symbol.for('ts-node.register.instance')])
-  process.env.CDS_TYPESCRIPT = 'ts-node'
-else if (process._preload_modules?.some(m => m?.includes(`${sep}tsx${sep}`)))
-  process.env.CDS_TYPESCRIPT = 'tsx'
-
-module.exports = Object.assign ((..._) => cli.exec(..._), cli)
-
-if (!module.parent)  module.exports()
-
-
-
 function getCommands() {
   const fs = require('node:fs');
   const path = require('node:path');
@@ -267,4 +247,45 @@ function getCommands() {
   return Array.from(result).sort()
 }
 
+function _require (id,o) {
+  try { var resolved = require.resolve(id,o) } catch(e){ DEBUG?.(`[cds] - Command not found: ${id}`); return }
+  DEBUG?.(`[cds] - Command resolved: ${resolved}`)
+  return require (resolved)
+}
+
+module.exports = Object.assign ((..._) => cli.exec(..._), cli)
+if (!module.parent)  module.exports()
+
+// check for an already loaded TS runner
+if (process[Symbol.for('ts-node.register.instance')])
+  process.env.CDS_TYPESCRIPT = 'ts-node'
+else if (process._preload_modules?.some(m => m?.includes(`${sep}tsx${sep}`)))
+  process.env.CDS_TYPESCRIPT = 'tsx'
+
+/**
+ * Load tsx if needed in a TS project. Warn users if this fails.
+ */
+function _prepareTsIfNeeded(cds) {
+  const tsconfig = path.join(cds.root ?? '.', 'tsconfig.json')
+  if (cds.cli?.command === 'serve' && fs.existsSync(tsconfig)) { // for `cds serve` started directly or through watch
+    if (/\b(0|no|false)\b/.test(process.env.CDS_TYPESCRIPT))  // opt-out switch to run JS code in a TS project
+      return delete process.env.CDS_TYPESCRIPT
+
+    if (!process.env.CDS_TYPESCRIPT ) {
+      try {
+        cds._localOrGlobal('tsx/cjs') // cjs is needed as we are in CJS code
+        console.log(`Detected ${path.relative(cds.root, tsconfig)}. Running with tsx.\n`)
+        process.env.CDS_TYPESCRIPT = 'tsx'
+      }
+      catch (e) {
+        if (e.code !== 'MODULE_NOT_FOUND') throw e
+        // cds.root may for some subcommands not point to the correct directory (e.g. cds w where users can pass a project directory)
+        // showing the full detected path should give the user an idea whether this info is relevant for them
+        console.error(`Detected ${tsconfig}. If this is a TypeScript project, consider running commands using 'cds-ts' or 'cds-tsx' instead of 'cds'.\n`)
+      }
+    }
+  }
+
+}
+
 /* eslint no-console:off */

package/bin/repl.js

@@ -42,13 +42,59 @@ async function repl (_, options={}) {
   const ctx={}
 
   repl.defineCommand ('run', {
-    help: 'Runs a cds server in the given CAP project folder, which can be a module name like @capire/bookshop.',
+    help: 'Runs a cds server from a given CAP project folder, or module name like @capire/bookshop.',
     async action (project) {
       // await cds.exec ('--project', project, '--port', '0')
       await cds.test (project)
-      console.log ('Following are made avaliable as global variables:')
-      console.log ('- cds.services:', Object.keys(cds.services)); Object.assign (repl.context, cds.services)
-      console.log ('- cds.entities:', Object.keys(cds.entities)); Object.assign (repl.context, cds.entities)
+
+      const GREEN = '\x1b[32m', RESET = '\x1b[0m'
+      console.log ('------------------------------------------------------------')
+      console.log ('Following are made available as repl globals:')
+      console.log()
+      let ntt = _export ('entities')
+      let srv = _export ('services')
+      console.log()
+      console.log('Simply type e.g.', GREEN+ntt+RESET, 'or', GREEN+srv+RESET, 'in the prompt to use the respective objects.')
+      console.log()
+      this.displayPrompt()
+
+      function _export (cds_property) {
+        let exports = cds[cds_property], first
+        console.log (`from cds.${cds_property}: {`)
+        for (let each in exports) {
+          if (each.includes('.')) continue
+          repl.context[each] = exports [each]
+          console.log (`  ${GREEN}${each}${RESET},`)
+          first ??= each
+        }
+        console.log (`}`)
+        return first
+      }
+    },
+  })
+
+  repl.defineCommand ('inspect', {
+    help: 'Sets options for util.inspect, e.g. `.inspect .depth=1`.',
+    async action (_args) {
+      const args = _args.split(' '), subjects={}, options = {}, defaults = inspect.defaultOptions
+      for (let each of args) {
+        // args of shape .<option>=<value> set inspect options
+        if (each[0] === '.') each = eval(`options${each}`)
+        // others are subjects to inpsect with given options
+        else subjects[each ||= 'defaults'] = each === 'defaults' ? defaults : function _recurse (o,slug) {
+          const [ head,...tail ] = slug, x = o[head]
+          if (tail.length && x && typeof x === 'object') return _recurse (x,tail)
+          else return x
+        } (repl.context, each.split('.'))
+      }
+      // if no subjects were given, just set the options globally
+      if (!Object.keys(subjects).length) {
+        Object.assign (defaults, options)
+        console.log('\n', 'updated node:util.inspect.defaultOptions with:', options)
+      } else for (let [each,subject] of Object.entries(subjects))
+        console.log ('\n'+each+':', inspect (subject, options))
+      console.log()
+      this.displayPrompt()
     }
   })
 

package/bin/watch.js

@@ -82,7 +82,7 @@ async function watch ([cwd], {
   ...options
 }={}) {
   if (cwd && !cds.utils.exists(cwd)) try { // try module name like `@capire/bookshop`
-    cwd = require.resolve(cwd+'/package.json').slice(0,-13)
+    cwd = require.resolve(cwd+'/package.json', {paths:[ process.cwd() ]}).slice(0,-13)
   } catch (err) {
     throw `Error: No such folder or package: '${cwd}'`
   }

package/lib/build/buildTaskEngine.js

@@ -2,7 +2,7 @@ const fs = require('fs')
 const path = require('path')
 const cds = require('../cds'), { _log: log } = cds
 const { sortMessagesSeverityAware, deduplicateMessages, CompilationError } = cds.compiler
-const { relativePaths, BuildError, resolveRequiredSapModels, redactCredentials } = require('./util')
+const { relativePaths, BuildError, BuildMessage, resolveRequiredSapModels, redactCredentials } = require('./util')
 const { SEVERITIES, LOG_LEVELS } = require('./constants')
 const BuildTaskFactory = require('./buildTaskFactory')
 const InternalBuildPlugin = require('./provider/internalBuildPlugin')
@@ -187,8 +187,8 @@ class BuildTaskEngine {
         if (errors.length > 0) {
             const error = errors.find(e => e.constructor.name !== COMPILATION_ERROR)
             if (error) {
-                // throw original error, including BuildErrors
-                // for BuildErrors we do not merge other build messages that might exist in order to keep the original error intact
+                // throw original BuildError including existing BuildMessages
+                error.messages = this._sortMessagesUnique(pluginMessages.filter(m => m instanceof BuildMessage), error.messages)
                 throw error
             }
 

package/lib/cds.js

@@ -6,11 +6,19 @@ module.exports = Object.defineProperties (cds, {
   // for internal use in cds-dk only
   _log: { value: _local ('../bin/util/log'), configurable: true },
   _local: { value: _local, configurable: true },
+  _localOrGlobal: { value: id => _local(id, _npmRoot()), configurable: true },
 })
 
-function _local (id) {
+function _local (id, ...morePaths) {
   return require(require.resolve (id, {paths:[
     process.cwd(), // project-local module is preferred
-    __dirname      // otherwise from our own dependencies
+    __dirname,      // otherwise from our own dependencies
+    ...morePaths
   ]}))
 }
+
+function _npmRoot() {
+  try {
+    return require ('child_process').execSync('npm root -g').toString().trim()
+  } catch  { return '' }
+}

package/lib/init/constants.js

@@ -5,7 +5,7 @@ module.exports = {
     COMMAND_ADD: 'add',
 
     JAVA_LTS_VERSIONS: [17, 21],
-    MAVEN_ARCHETYPE_VERSION: '3.4.1',
+    MAVEN_ARCHETYPE_VERSION: '3.5.0',
 
     OPTIONS: Object.freeze({
         COMPLETION: 'completion',

package/lib/init/merge.js

@@ -153,7 +153,7 @@ async function _mergeYAML(into, from, project, semantics = {}) {
     relationships?.forEach(relationship => {
         const [entry] = relationship.into
         const [insertEntry] = relationship.insert
-        const hash = insertEntry + ' -> ' + entry
+        const hash = JSON.stringify(insertEntry) + ' -> ' + JSON.stringify(entry)
         entryMap.set(hash, undefined)
     })
 

package/lib/init/projectReader.js

@@ -167,6 +167,7 @@ module.exports = new class ProjectReader {
             appUIPaths: () => (fs.readdirSync(path.resolve(cds.root, cds.env.folders.app))).filter(e =>
                 isdir(join(cds.root, cds.env.folders.app, e)) && isApp(e)
             ),
+            hasIndexHtml: () => {},
             appPath: () => env.folders.app,
             appVersion: () => appVersion,
             jdkVersion: () => jdkVersion,

package/lib/init/template/html5-repo/files/xs-app.json.hbs

@@ -1,4 +1,5 @@
 {
+  {{#hasIndexHtml}}"welcomeFile": "/index.html",{{/hasIndexHtml}}
   "authenticationMethod": "route",
   "routes": [
     {

package/lib/init/template/html5-repo/index.js

@@ -3,6 +3,7 @@ const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
 const { srv4, html5RepoHost, html5Runtime, appDeployer, approuter, mtxSidecar4 } = require('../../registries/mta')
 const { odataApi } = require('../../registries/xs-app')
+const { exists } = require('../../../cds').utils
 
 module.exports = class Html5RepoTemplate extends require('../../plugin') {
 
@@ -53,6 +54,7 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
 
         await Promise.all(apps.map(async ({app}) => {
             project.app = app
+            project.hasIndexHtml = exists(join(appPath, app, 'webapp/index.html'))
             const additions = [odataApi]
             await merge(__dirname, 'files/xs-app.json.hbs').into(join(appPath, app, 'xs-app.json'), { with: project, additions })
         }))

package/lib/init/template/nodejs/files/package.json.hbs

@@ -11,7 +11,7 @@
   },
   "devDependencies": {
     "@cap-js/sqlite": "^1",
-    "@cap-js/cds-types": "^0.7.0"
+    "@cap-js/cds-types": "^0.8.0"
   },
   "scripts": {
     "start": "cds-serve"

package/lib/init/template/typescript/files/package.json

@@ -1,6 +1,6 @@
 {
   "devDependencies": {
-    "@cap-js/cds-types": "^0.7.0",
+    "@cap-js/cds-types": "^0.8.0",
     "@types/node": "^22.0.0",
     "typescript": "^5"
   },

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@sap/cds-dk",
-  "version": "8.5.0",
+  "version": "8.5.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@sap/cds-dk",
-      "version": "8.5.0",
+      "version": "8.5.1",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "@cap-js/asyncapi": "^1.0.0",
@@ -54,7 +54,7 @@
       }
     },
     "node_modules/@cap-js/openapi": {
-      "version": "1.0.7",
+      "version": "1.1.0",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "pluralize": "^8.0.0"
@@ -109,10 +109,10 @@
       }
     },
     "node_modules/@eslint/config-array": {
-      "version": "0.19.0",
+      "version": "0.19.1",
       "license": "Apache-2.0",
       "dependencies": {
-        "@eslint/object-schema": "^2.1.4",
+        "@eslint/object-schema": "^2.1.5",
         "debug": "^4.3.1",
         "minimatch": "^3.1.2"
       },
@@ -121,8 +121,11 @@
       }
     },
     "node_modules/@eslint/core": {
-      "version": "0.9.0",
+      "version": "0.9.1",
       "license": "Apache-2.0",
+      "dependencies": {
+        "@types/json-schema": "^7.0.15"
+      },
       "engines": {
         "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
       }
@@ -149,21 +152,21 @@
       }
     },
     "node_modules/@eslint/js": {
-      "version": "9.15.0",
+      "version": "9.16.0",
       "license": "MIT",
       "engines": {
         "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
       }
     },
     "node_modules/@eslint/object-schema": {
-      "version": "2.1.4",
+      "version": "2.1.5",
       "license": "Apache-2.0",
       "engines": {
         "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
       }
     },
     "node_modules/@eslint/plugin-kit": {
-      "version": "0.2.3",
+      "version": "0.2.4",
       "license": "Apache-2.0",
       "dependencies": {
         "levn": "^0.4.1"
@@ -224,7 +227,7 @@
       }
     },
     "node_modules/@sap/cds": {
-      "version": "8.5.0",
+      "version": "8.5.1",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "@sap/cds-compiler": ">=5.1",
@@ -250,7 +253,7 @@
       }
     },
     "node_modules/@sap/cds-compiler": {
-      "version": "5.5.0",
+      "version": "5.5.2",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "antlr4": "4.9.3"
@@ -286,7 +289,7 @@
       }
     },
     "node_modules/@sap/cds-mtxs": {
-      "version": "2.4.0",
+      "version": "2.4.1",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "@sap/hdi-deploy": ">=4",
@@ -466,7 +469,7 @@
       "license": "MIT"
     },
     "node_modules/axios": {
-      "version": "1.7.8",
+      "version": "1.7.9",
       "license": "MIT",
       "dependencies": {
         "follow-redirects": "^1.15.6",
@@ -618,14 +621,13 @@
       }
     },
     "node_modules/call-bind": {
-      "version": "1.0.7",
+      "version": "1.0.8",
       "license": "MIT",
       "dependencies": {
+        "call-bind-apply-helpers": "^1.0.0",
         "es-define-property": "^1.0.0",
-        "es-errors": "^1.3.0",
-        "function-bind": "^1.1.2",
         "get-intrinsic": "^1.2.4",
-        "set-function-length": "^1.2.1"
+        "set-function-length": "^1.2.2"
       },
       "engines": {
         "node": ">= 0.4"
@@ -634,6 +636,17 @@
         "url": "https://github.com/sponsors/ljharb"
       }
     },
+    "node_modules/call-bind-apply-helpers": {
+      "version": "1.0.0",
+      "license": "MIT",
+      "dependencies": {
+        "es-errors": "^1.3.0",
+        "function-bind": "^1.1.2"
+      },
+      "engines": {
+        "node": ">= 0.4"
+      }
+    },
     "node_modules/callsites": {
       "version": "3.1.0",
       "license": "MIT",
@@ -826,7 +839,7 @@
       }
     },
     "node_modules/dotenv": {
-      "version": "16.4.5",
+      "version": "16.4.7",
       "license": "BSD-2-Clause",
       "engines": {
         "node": ">=12"
@@ -886,7 +899,7 @@
       }
     },
     "node_modules/eslint": {
-      "version": "9.15.0",
+      "version": "9.16.0",
       "license": "MIT",
       "dependencies": {
         "@eslint-community/eslint-utils": "^4.2.0",
@@ -894,7 +907,7 @@
         "@eslint/config-array": "^0.19.0",
         "@eslint/core": "^0.9.0",
         "@eslint/eslintrc": "^3.2.0",
-        "@eslint/js": "9.15.0",
+        "@eslint/js": "9.16.0",
         "@eslint/plugin-kit": "^0.2.3",
         "@humanfs/node": "^0.16.6",
         "@humanwhocodes/module-importer": "^1.0.1",
@@ -1031,7 +1044,7 @@
       }
     },
     "node_modules/express": {
-      "version": "4.21.1",
+      "version": "4.21.2",
       "license": "MIT",
       "dependencies": {
         "accepts": "~1.3.8",
@@ -1053,7 +1066,7 @@
         "methods": "~1.1.2",
         "on-finished": "2.4.1",
         "parseurl": "~1.3.3",
-        "path-to-regexp": "0.1.10",
+        "path-to-regexp": "0.1.12",
         "proxy-addr": "~2.0.7",
         "qs": "6.13.0",
         "range-parser": "~1.2.1",
@@ -1068,6 +1081,10 @@
       },
       "engines": {
         "node": ">= 0.10.0"
+      },
+      "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/express"
       }
     },
     "node_modules/express/node_modules/debug": {
@@ -1287,10 +1304,10 @@
       }
     },
     "node_modules/gopd": {
-      "version": "1.0.1",
+      "version": "1.2.0",
       "license": "MIT",
-      "dependencies": {
-        "get-intrinsic": "^1.1.3"
+      "engines": {
+        "node": ">= 0.4"
       },
       "funding": {
         "url": "https://github.com/sponsors/ljharb"
@@ -1333,8 +1350,11 @@
       }
     },
     "node_modules/has-proto": {
-      "version": "1.0.3",
+      "version": "1.1.0",
       "license": "MIT",
+      "dependencies": {
+        "call-bind": "^1.0.7"
+      },
       "engines": {
         "node": ">= 0.4"
       },
@@ -1343,7 +1363,7 @@
       }
     },
     "node_modules/has-symbols": {
-      "version": "1.0.3",
+      "version": "1.1.0",
       "license": "MIT",
       "engines": {
         "node": ">= 0.4"
@@ -1363,7 +1383,7 @@
       }
     },
     "node_modules/hdb": {
-      "version": "0.19.10",
+      "version": "0.19.11",
       "license": "Apache-2.0",
       "dependencies": {
         "iconv-lite": "^0.4.18"
@@ -1800,7 +1820,7 @@
       }
     },
     "node_modules/path-to-regexp": {
-      "version": "0.1.10",
+      "version": "0.1.12",
       "license": "MIT"
     },
     "node_modules/picomatch": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-dk",
-  "version": "8.5.0",
+  "version": "8.5.1",
   "description": "Command line client and development toolkit for the SAP Cloud Application Programming Model",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [