@sap/cds-dk 9.7.2 → 9.8.0

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@sap/cds-dk",
-  "version": "9.7.2",
+  "version": "9.8.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@sap/cds-dk",
-      "version": "9.7.2",
+      "version": "9.8.0",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "@cap-js/asyncapi": "^1.0.0",
@@ -77,20 +77,28 @@
       }
     },
     "node_modules/@eslint/js": {
-      "version": "9.39.2",
-      "integrity": "sha512-q1mjIoW1VX4IvSocvM/vbTiveKC4k9eLrajNEuSsmjymSDEbpGddtpfOoN7YGAqBK3NG+uqo8ia4PDTt8buCYA==",
+      "version": "10.0.1",
+      "integrity": "sha512-zeR9k5pd4gxjZ0abRoIaxdc7I3nDktoXZk2qOv9gCNWx3mVwEn32VRhyLaRsDiJjTs0xq/T8mfPtyuXu7GWBcA==",
       "license": "MIT",
       "peer": true,
       "engines": {
-        "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
+        "node": "^20.19.0 || ^22.13.0 || >=24"
       },
       "funding": {
         "url": "https://eslint.org/donate"
+      },
+      "peerDependencies": {
+        "eslint": "^10.0.0"
+      },
+      "peerDependenciesMeta": {
+        "eslint": {
+          "optional": true
+        }
       }
     },
     "node_modules/@sap/cds": {
-      "version": "9.7.1",
-      "integrity": "sha512-DCMCB3FiQoWVeHQulSFbZMkmuoW0z6tJRP85Xv2Bd2Cl2J2I4+LQD1GKDiUXrlJXm0CtKsFQcrsxcQmUeO5uXw==",
+      "version": "9.8.0",
+      "integrity": "sha512-Tiax/4R/y1dJJsl53VjMKe5VM0FtxLwG4BOPuLVnJhCawMxMlebXM+jlIFkrXhUL2bVet0uUdjAH/Dq4uVwVOg==",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "@sap/cds-compiler": "^6.4",
@@ -106,7 +114,7 @@
         "node": ">=20"
       },
       "peerDependencies": {
-        "@eslint/js": "^9",
+        "@eslint/js": "^9 || ^10",
         "tar": "^7.5.6"
       },
       "peerDependenciesMeta": {
@@ -116,8 +124,8 @@
       }
     },
     "node_modules/@sap/cds-compiler": {
-      "version": "6.7.3",
-      "integrity": "sha512-MlKvr3b7meSD4UsMr/u5eXUS0q226MyHg/+x5xKOxxdqhh1yGGnJD0lj0USqo4S3rggFfCSgWypTAjD7VLZdUw==",
+      "version": "6.8.0",
+      "integrity": "sha512-yRoTZcH8DFiP4PcEuIHe42YAaNt51V736+6RRr+U4nbO91sz36L8be2djcE8n760t8IbqLxzZ/UkATiL0fjRmA==",
       "license": "SEE LICENSE IN LICENSE",
       "bin": {
         "cdsc": "bin/cdsc.js",
@@ -129,16 +137,16 @@
       }
     },
     "node_modules/@sap/cds-fiori": {
-      "version": "2.2.0",
-      "integrity": "sha512-NnvpmU40Eez5Q3SkyCCLRuBd1XUjk7N+pbXcIPIkKw4rwvqR2/FbjNveRzc8mcrLcQA3/5b/CXYsafDoozUhng==",
+      "version": "2.3.0",
+      "integrity": "sha512-6oWov+DSpFrSTgxXR0dZhak6aZ/IVRZvaHERMi0EgSTzIJdlvZlpw3Kf18ePMcTrRrtEXwD4RIjKt8pbs0g2Hg==",
       "license": "SEE LICENSE IN LICENSE",
       "peerDependencies": {
         "@sap/cds": ">=8"
       }
     },
     "node_modules/@sap/cds-mtxs": {
-      "version": "3.7.1",
-      "integrity": "sha512-yMsD6C4UAPozvm4TNUojAFYYC13au45hamr+S7cXT7K9ufYl7zzLGQ3Z/bE91D57z0IfryCXMsxk437P3cEJuA==",
+      "version": "3.8.0",
+      "integrity": "sha512-8P/CKQbdbKH/1ZmgrRWiReXFb9MjLf/TjEH/MrbiJEGWCIv/bTKL6nNb0BIcBa7HQhekVqapa/cwx241NEnAVQ==",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "@sap/hdi-deploy": "^5"
@@ -251,8 +259,8 @@
       "license": "MIT"
     },
     "node_modules/axios": {
-      "version": "1.13.5",
-      "integrity": "sha512-cz4ur7Vb0xS4/KUN0tPWe44eqxrIu31me+fbang3ijiNscE129POzipJJA6zniq2C/Z6sJCjMimjS8Lc/GAs8Q==",
+      "version": "1.13.6",
+      "integrity": "sha512-ChTCHMouEe2kn713WHbQGcuYrr6fXTBiu460OTwWrWob16g1bXn4vtz07Ope7ewMozJAnEquLk5lWQWtBig9DQ==",
       "license": "MIT",
       "dependencies": {
         "follow-redirects": "^1.15.11",
@@ -1283,6 +1291,7 @@
     "node_modules/prebuild-install": {
       "version": "7.1.3",
       "integrity": "sha512-8Mf2cbV7x1cXPUILADGI3wuhfqWvtiLA1iclTDbFRZkgRQS0NqsPZphna9V+HyTEadheuPmjaJMsbzKQFOzLug==",
+      "deprecated": "No longer maintained. Please contact the author of the relevant native addon; alternatives are available.",
       "license": "MIT",
       "optional": true,
       "dependencies": {
@@ -1324,8 +1333,8 @@
       "license": "MIT"
     },
     "node_modules/pump": {
-      "version": "3.0.3",
-      "integrity": "sha512-todwxLMY7/heScKmntwQG8CXVkWUOdYxIvY2s0VWAAMh/nd8SoYiRaKjlr7+iCs984f2P8zvrfWcDDYVb73NfA==",
+      "version": "3.0.4",
+      "integrity": "sha512-VS7sjc6KR7e1ukRFhQSY5LM2uBWAUPiOPa/A3mkKmiMwSmRFUITt0xuj+/lesgnCv+dPIEYlkzrcyXgquIHMcA==",
       "license": "MIT",
       "optional": true,
       "dependencies": {
@@ -1334,8 +1343,8 @@
       }
     },
     "node_modules/qs": {
-      "version": "6.14.2",
-      "integrity": "sha512-V/yCWTTF7VJ9hIh18Ugr2zhJMP01MY7c5kh4J870L7imm6/DIzBsNLTXzMwUA3yZ5b/KBqLx8Kp3uRvd7xSe3Q==",
+      "version": "6.15.0",
+      "integrity": "sha512-mAZTtNCeetKMH+pSjrb76NAM8V9a05I9aBZOHztWy/UqcJdQYNsf59vrRKWnojAT9Y+GbIvoTBC++CPHqpDBhQ==",
       "license": "BSD-3-Clause",
       "dependencies": {
         "side-channel": "^1.1.0"
@@ -1439,8 +1448,8 @@
       "license": "MIT"
     },
     "node_modules/sax": {
-      "version": "1.4.4",
-      "integrity": "sha512-1n3r/tGXO6b6VXMdFT54SHzT9ytu9yr7TaELowdYpMqY/Ao7EnlQGmAQ1+RatX7Tkkdm6hONI2owqNx2aZj5Sw==",
+      "version": "1.5.0",
+      "integrity": "sha512-21IYA3Q5cQf089Z6tgaUTr7lDAyzoTPx5HRtbhsME8Udispad8dC/+sziTNugOEx54ilvatQ9YCzl4KQLPcRHA==",
       "license": "BlueOak-1.0.0",
       "engines": {
         "node": ">=11.0.0"

package/package.json

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

package/lib/build/buildTaskEngine.js

@@ -1,377 +0,0 @@
-// @ts-check
-const fs = require('node:fs')
-const path = require('node:path')
-const { inspect } = require('node:util')
-// @ts-expect-error - _log not declared in cds-types
-const cds = require('../cds'), { _log: log } = cds
-const { sortMessagesSeverityAware, deduplicateMessages, CompilationError } = cds.compiler
-const { relativePaths, BuildError, BuildMessage, resolveRequiredSapModels } = require('./util')
-const { SEVERITIES, SEVERITY_ERROR, LOG_LEVELS } = require('./constants')
-const BuildTaskFactory = require('./buildTaskFactory')
-const InternalBuildPlugin = require('./provider/internalBuildPlugin')
-const COMPILATION_ERROR = 'CompilationError'
-const COMPILE_MESSAGE = 'CompileMessage'
-const DEBUG = cds.debug('cli|build')
-const LOG_LIMIT = 30
-
-class BuildTaskEngine {
-
-    /**
-     * @param {import('../build').BuildOptions} options - command options
-     */
-    constructor(options) {
-        this._taskFactory = new BuildTaskFactory(options)
-    }
-    get taskFactory() {
-        return this._taskFactory
-    }
-    get options() {
-        return this.taskFactory.options
-    }
-
-    async processTasks(tasks) {
-        const startTime = Date.now()
-
-        tasks ??= await this.taskFactory.getTasks()
-        console.log(`building project with`, inspect({
-            versions: { cds: cds.version, compiler: cds.compiler.version(), dk: require('../../package.json').version },
-            target: cds.env.build.target,
-            tasks: tasks.map(({ _uses, ...task }) => task),
-            ...(!this.options.clean && { clean: this.options.clean }),
-        }, { depth: 11, colors: cds.utils.colors.enabled, compact: 3, breakLength: 250 }))
-
-        // validate required @sap namespace models - log only
-        const unresolved = BuildTaskEngine._resolveRequiredSapServices(tasks)
-        if (unresolved.length > 0) {
-            throw new BuildError(`Required CDS models [${unresolved.join(', ')}] cannot be resolved. Run the 'npm install' command to install up-to-date versions of the missing packages.`)
-        }
-
-        // create build plugins
-        const plugins = []
-        tasks.forEach((task) => {
-            if (task) {
-                const plugin = this._createPlugin(task)
-                plugins.push(plugin)
-            }
-        })
-
-        try {
-            await this._executePrepare(plugins)
-            await this._executeCleanBuildTasks(plugins)
-
-            // throwing Exception in case of compilation errors
-            const buildResult = await this._executeBuildTasks(plugins)
-
-            await this._writeGenerationLog(plugins)
-            this._logOutput(plugins)
-            this._logMessages(BuildTaskEngine._getMessages(plugins))
-            this._logTimer(startTime, Date.now())
-
-            return buildResult
-        } catch (error) {
-            this._logOutput(plugins)
-            throw error
-        }
-    }
-
-    /**
-     * Plugin#prepare has been deprecated and was never part of the public API.
-     * Currently only used by internal FioriBuildPlugin.
-     * @deprecated
-     * @private
-     * @param {*} plugins
-     * @returns
-     */
-    async _executePrepare(plugins) {
-        const pluginGroups = new Map()
-
-        // group plugins by type
-        plugins.forEach(plugin => {
-            pluginGroups.has(plugin.task.for) ? pluginGroups.get(plugin.task.for).push(plugin) : pluginGroups.set(plugin.task.for, [plugin])
-        })
-
-        const promises = []
-        for (let pluginGroup of pluginGroups.values()) {
-            promises.push(this._doPrepare(pluginGroup))
-        }
-        return Promise.all(promises)
-    }
-
-    /**
-     * @deprecated
-     * @private
-     * @param {*} pluginGroup
-     */
-    async _doPrepare(pluginGroup) {
-        for (let plugin of pluginGroup) {
-            // prepare has been deprecated
-            if (plugin instanceof InternalBuildPlugin) {
-                DEBUG?.(`preparing, plugin [${plugin.constructor.name}], src [${relativePaths(cds.root, plugin.task.src)}]`)
-                const result = await plugin.prepare()
-                if (result === false) {
-                    break
-                }
-            }
-        }
-    }
-
-    /** @private */
-    async _executeCleanBuildTasks(plugins) {
-        if (this.options.clean) {
-            // clean entire build staging folder once
-            if (cds.env.build.target !== '.') {
-                const target = path.resolve(cds.root, cds.env.build.target)
-                DEBUG?.(`cleaning staging folder ${target}`)
-                await fs.promises.rm(target, { force: true, recursive: true })
-            }
-
-            const results = await Promise.allSettled(plugins.map((plugin) => {
-                DEBUG?.(`cleaning, plugin [${plugin.constructor.name}], src [${relativePaths(cds.root, plugin.task.src)}]`)
-                return plugin.clean()
-            }))
-            // check for errors and throw exception
-            this._resolveHandlerResponse(results)
-        }
-    }
-
-    /** @private */
-    async _executeBuildTasks(plugins) {
-        // sort plugins based on priority in
-        plugins = plugins.sort((a, b) => {
-            return a.priority === b.priority ? 0 : a.priority > b.priority ? -1 : 1
-        })
-        // group plugins with same priority in order to execute in parallel
-        const buildPipeline = plugins.reduce((acc, plugin) => {
-            if (acc.length === 0) {
-                acc.push([plugin])
-            } else {
-                const currGroup = acc[acc.length - 1]
-                if (currGroup[0].priority === plugin.priority) {
-                    currGroup.push(plugin)
-                } else {
-                    acc.push([plugin])
-                }
-            }
-            return acc
-        }, [])
-
-        const results = await this._executePipeline(buildPipeline)
-
-        // check for errors and throw exception - return results otherwise including any compiler and build status messages
-        return this._resolveHandlerResponse(results, BuildTaskEngine._getMessages(plugins))
-    }
-
-    /** @private */
-    async _executePipeline(pipeline) {
-        let allResults = []
-        for (const group of pipeline) {
-            const results = await Promise.allSettled(group.map((plugin) => {
-                DEBUG?.(`building, plugin [${plugin.constructor.name}], src [${relativePaths(cds.root, plugin.task.src)}]`)
-                return plugin.build()
-                    .then(pluginResult => {
-                        return Promise.resolve({
-                            task: plugin.task,
-                            result: pluginResult,
-                            messages: this._sortMessagesUnique(plugin.messages)
-                        })
-                    })
-            }))
-            allResults = allResults.concat(results)
-        }
-        return allResults
-    }
-
-    /** @private */
-    _resolveHandlerResponse(results, pluginMessages = []) {
-        /** @type {(BuildError | Error)[]}*/
-        const errors = []
-        const resolvedResults = results.reduce((acc, r) => {
-            if (r.status === 'fulfilled') {
-                acc.push(r.value)
-            }
-            if (r.status === 'rejected' && r.reason) {
-                errors.push(r.reason)
-            }
-            return acc
-        }, [])
-
-        if (errors.length > 0) {
-            const error = errors.find(e => e.constructor.name !== COMPILATION_ERROR)
-            if (error) {
-                // throw original BuildError including existing BuildMessages
-                if (!(error instanceof BuildError)) {
-                    throw error
-                }
-                error.messages = error.messages?.map(m => typeof m === 'string' ? new BuildMessage(m, SEVERITY_ERROR) : m)
-                error.messages = this._sortMessagesUnique(pluginMessages.filter(m => m instanceof BuildMessage), error.messages)
-                throw error
-            }
-
-            // propagate existing CompilationErrors
-            // merge all existing compilation messages into a single CompilationError
-            // compiler warning and info messages are returned as plugin messages
-            const compileErrors = errors.filter(e => e.constructor.name === COMPILATION_ERROR)
-            const compileMessages = pluginMessages.filter(message => message.constructor.name === COMPILE_MESSAGE)
-            if (compileErrors.length) {
-                throw new CompilationError(this._sortMessagesUnique(BuildTaskEngine._getErrorMessages(compileErrors), compileMessages))
-            }
-        }
-        return resolvedResults
-    }
-
-    /** @private */
-    _createPlugin(task) {
-        const plugin = this.taskFactory.createPlugin(task)
-        plugin.init()
-
-        if (!(plugin instanceof InternalBuildPlugin) && plugin.priority >= 0 && plugin.priority <= 512) {
-            throw new Error(
-                `Invalid priority value for ${plugin.constructor.name}.
-The valid priority value range for custom plugins is -1024..-1 and 512..1024.
-Range 0..512 is blocked for internal plugins.
-The higher the value the earlier the plugin is run.`
-            )
-        }
-
-        this._logTaskHandler(plugin)
-        return plugin
-    }
-
-    /** @private */
-    _logOutput(plugins) {
-        // log all generated files
-        const files = BuildTaskEngine._getOutput(plugins)
-        if (files.length > 0) {
-            const term = require('../util/term')
-            if (!process.env.DEBUG && files.length > LOG_LIMIT) {
-                const length = files.length
-                files.length = LOG_LIMIT
-                files.push(`... ${length - files.length} more. Run with DEBUG=build to show all files.`)
-            }
-            console.log(`done > wrote output to:\n   ${term.dim(files.join("\n   "))}\n`)
-        }
-    }
-
-    /** @private */
-    async _writeGenerationLog(plugins) {
-        const outputFile = cds.env.build.outputfile || process.env.GENERATION_LOG
-        if (outputFile) {
-            const files = BuildTaskEngine._getOutput(plugins)
-            console.log(`writing generation log to [${outputFile}]\n`)
-            try {
-                await fs.promises.mkdir(path.dirname(outputFile), { recursive: true })
-                await fs.promises.writeFile(outputFile, files.join('\n'))
-            } catch (error) {
-                console.error(`failed to write generation log`)
-                console.error(error.stack || error)
-            }
-        }
-    }
-
-    /** @private */
-    static _getOutput(plugins) {
-        const files = plugins.reduce((acc, plugin) => acc.concat(plugin.files), []).sort()
-        return files.map(file => {
-            if (path.isAbsolute(cds.env.build.target)) {
-                return file
-            }
-            return path.relative(cds.root, file)
-        })
-    }
-
-    /** @private */
-    _logTimer(start, end) {
-        console.log(`build completed in ${end - start} ms`)
-    }
-
-    /** @private */
-    _logTaskHandler(plugin) {
-        DEBUG?.(`plugin ${plugin.constructor.name}`)
-        DEBUG?.(`details src [${relativePaths(cds.root, plugin.task.src)}], dest [${relativePaths(cds.root, plugin.task.dest)}], options [${JSON.stringify(plugin.task.options)}]`)
-    }
-
-    /** @private */
-    _logMessages(messages) {
-        if (messages.length > 0) {
-            const options = {
-                log: console.log,
-                "log-level": this._getLogLevel() // ensures that for tests the correct cds.env is used
-            }
-            deduplicateMessages(messages)
-            sortMessagesSeverityAware(messages)
-            log(messages, options)
-        }
-    }
-
-    /** @private */
-    static _resolveRequiredSapServices(tasks) {
-        const taskModelPaths = tasks.reduce((acc, task) => {
-            const model = task.options?.model
-            if (model) {
-                if (Array.isArray(model)) {
-                    model.forEach(m => acc.add(m))
-                } else {
-                    acc.add(model)
-                }
-            }
-            return acc
-        }, new Set())
-
-        return resolveRequiredSapModels([...taskModelPaths])
-    }
-
-    /**
-     * Returns a sorted and flattened list of all messages extracted from the given errors.
-     * @private
-     * @param {(string | BuildError)[]} errors
-     */
-    static _getErrorMessages(errors) {
-        let messages = []
-        // flatten all compile messages in order to filter duplicates and sort later on
-        errors.forEach(error => {
-            if (typeof error !== 'string' && Array.isArray(error.errors) && error.errors.length > 0) {
-                messages = messages.concat(this._getErrorMessages(error.errors))
-            } else {
-                messages.push(error)
-            }
-        })
-        return messages
-    }
-
-    /**
-     * Returns compiler messages and validation messages issued by plugins.
-     * @param {Array} plugins
-     */
-    static _getMessages(plugins) {
-        return plugins.reduce((acc, plugin) => acc.concat(plugin.messages), [])
-    }
-
-    /**
-     * Sort and filter the given errors of type CompileMessage or BuildMessage according to their severity and location,
-     * but leave any other errors untouched as part of the result array.<br>
-     * The log level ('command line' or 'cds.env' option) is used to filter the given messages.
-     * @private
-     * @param  {...{[key:string]: any, severity?: import('./constants').Severity}} messages
-     */
-    _sortMessagesUnique(...messages) {
-        const logLevelIdx = LOG_LEVELS.indexOf(this._getLogLevel())
-        // flatten
-        messages = messages.reduce((acc, m) => acc.concat(m), [])
-        // filter according to log-level
-        const filteredMessages = messages.filter(message => message && (!message.severity || logLevelIdx >= SEVERITIES.indexOf(message.severity)))
-        // remove duplicates
-        // @ts-expect-error - formally expects CompileMessage, but actually, an .severity is the only expected property
-        deduplicateMessages(filteredMessages)
-        // sort
-        // @ts-expect-error - see above
-        return sortMessagesSeverityAware(filteredMessages)
-    }
-
-    /**
-     * Return user defined log level or default value 'warn'
-     */
-    _getLogLevel() {
-        return this.options["log-level"] || cds.env["log-level"]
-    }
-}
-module.exports = BuildTaskEngine