@sap/cds-dk 6.8.2 → 7.0.0

package/bin/login.js

@@ -9,60 +9,63 @@ module.exports = Object.assign(login, {
 
     *cds login* [ <app-url> ]
 
-    Simplifies usage of multitenancy-related commands (e.g. *cds subscribe* and *cds push*)
-    by providing them with automatic authentication: fetches and saves authentication
-    tokens and provides relevant tokens to those commands. Alternatively saves username
-    for apps running locally.
+    Simplifies usage of multitenancy-related commands (e.g. *cds subscribe* and
+    *cds push*) by providing them with automatic authentication: fetches and
+    saves authentication tokens and provides relevant tokens to those commands.
+    Alternatively saves username for apps running locally.
 
-    Saves further settings for the current project (<app-url>, <tenant-subdomain>, and
-    URLs for passcodes and tokens).
+    Saves further settings for the current project (<app-url>,
+    <tenant-subdomain>, and URLs for passcodes and tokens).
 
     *Multiple targets*
 
-    When re-running this command with different app URLs and subdomains, previous
-    logins are not affected, allowing simultaneous logins to different API endpoints
-    on SAP Business Technology Platform, Cloud Foundry environment.
-    *cds extend* and *cds activate* will be authenticated according to the given target.
+    When re-running this command with different app URLs and subdomains,
+    previous logins are not affected, allowing simultaneous logins to different
+    API endpoints on SAP Business Technology Platform, Cloud Foundry
+    environment. *cds pull* and *cds push* will be authenticated according
+    to the given target.
 
-    If the Cloud-Foundry command-line client is installed, the SaaS-app URL <app-url>
-    may be omitted. In that case, suitable apps from the org and space you're currently
-    logged in to will be presented to determine <app-url>.
+    If the Cloud-Foundry command-line client is installed, the SaaS-app URL
+    <app-url> may be omitted. In that case, suitable apps from the org and space
+    you're currently logged in to will be presented to determine <app-url>.
 
     In case <app-url> does not start with a schema, 'https://' is assumed.
 
     *Token Expiration*
 
-    If a refresh token has been provided with the original token and the original
-    token has expired, it will be automatically renewed.
+    If a refresh token has been provided with the original token and the
+    original token has expired, it will be automatically renewed.
 
     *Storing Authentication Data*
 
-    Authentication data for all logins is saved by <app-url> and <tenant-subdomain> in the
-    desktop keyring (${(config.keyringDesignation)} on your platform) or, if requested, in config
-    file ${config.paths.auth}.
+    Authentication data for all logins is saved by <app-url> and
+    <tenant-subdomain> in the desktop keyring (${(config.keyringDesignation)} on
+    your platform) or, if requested, in config file ${config.paths.auth}.
 
-    To make use of keyring storage, the 'keytar' Node.js module must be installed.
-    A corresponding hint will be given in case the module is not found.
+    To make use of keyring storage, the 'keytar' Node.js module must be
+    installed. A corresponding hint will be given in case the module is not
+    found.
 
     Project settings are saved by project directory in config file
     ${config.paths.settings}.
 
-    Note that local storage of authentication data incurs a certain security risk:
-    a malicious locally-running application might be able to perform any action with
-    the SaaS app that you are authorized for with respect to your tenant.
+    Note that local storage of authentication data incurs a certain security
+    risk: a malicious locally-running application might be able to perform any
+    action with the SaaS app that you are authorized for with respect to your
+    tenant.
 
 # OPTIONS
 
     *-s* | *--subdomain* <tenant-subdomain>
 
-        The subdomain to log in to. By default, it's determined from project settings.
-        If no such setting is saved, the CF client is invoked to determine the respective subdomain.
+        The subdomain to log in to. By default, it's determined from project
+        settings. If no such setting is saved, the CF client is invoked to
+        determine the respective subdomain.
 
     *-d* | *--directory* <extension-project-directory>
 
         The extension-project folder (relevant for loading and saving settings).
-        If omitted, either an existing subdirectory named as the subdomain or the current
-        working directory will be used.
+        If omitted, the current working directory will be used.
 
     *-p* | *--passcode* <passcode>
 
@@ -70,65 +73,76 @@ module.exports = Object.assign(login, {
 
     *-u* | *--user* <name>[:[<password>]]
 
-        Username and optionally password for authentication with Basic Auth in test scenarios.
+        Username and optionally password for authentication with Basic Auth in
+        test scenarios.
 
-        When typing the colon but omitting <password>, the password is assumed empty.
-        When omitting both, password will be queried interactively.
+        When typing the colon but omitting <password>, the password is assumed
+        empty. When omitting both, password will be queried interactively.
 
-        For security reasons, username will only be saved for app URLs that look like localhost.
-        The same is true for an empty password. Non-empty passwords will never be saved.
-        If saved, a username will be associated with the project folder, not with the (potentially ambiguous) URL.
+        For security reasons, username will only be saved for app URLs that look
+        like localhost. In this case, the username will be associated with the
+        project folder, not with the (potentially ambiguous) URL.
+        An empty password will be saved under the same conditions as a username.
+        Non-empty passwords will never be saved. 
         
-        Note: Productive secrets should not be specified on a command line, since this might expose them to
-        unauthorized users on the same machine!
+        Note: Productive secrets should not be specified on a command line,
+        since this might expose them to unauthorized users on the same machine!
 
     *-c* | *--client* <clientid>[:<clientsecret>]
 
-        Client Credentials (Client ID and optionally Client Secret) for authentication.
-        If omitted, Client Secret will be queried interactively.
+        Client Credentials (Client ID and optionally Client Secret) for
+        authentication. If omitted, Client Secret will be queried interactively.
         
         Obtain the Client Credentials from the UAA binding of MTXS.
         
         Client Credentials will not be saved, only the resulting token.
         
-        Note: Productive secrets should not be specified on a command line, since this might expose them to
-        unauthorized users on the same machine!
+        Note: Productive secrets should not be specified on a command line,
+        since this might expose them to unauthorized users on the same machine!
 
     *-m* | *--mtls* <clientid>[:<key>]
 
-        Client Credentials (Client ID and optionally Client-Certificate Private Key in Base64 encoding)
-        for authentication. If omitted, Private Key will be queried interactively (avoid newline characters
-        when pasting it).
+        Client Credentials (Client ID and optionally Client-Certificate Private
+        Key in Base64 encoding) for authentication. If omitted, Private Key will
+        be queried interactively (avoid newline characters when pasting it).
         
         Obtain the Client Credentials from the UAA binding of MTXS.
         
         Client Credentials will not be saved, only the resulting token.
         
-        Note: Productive secrets should not be specified on a command line, since this might expose them to
-        unauthorized users on the same machine!
+        Note: Productive secrets should not be specified on a command line,
+        since this might expose them to unauthorized users on the same machine!
 
     *--plain*
 
-        Instead of saving authentication data for this login to the desktop keyring,
-        use plain-text storage, e.g. if you have not installed the 'keytar' module.
-        Note that this is not recommended as it decreases the level of security: at
-        least applications running as the current user can read the plain-text file,
-        whereas the keyring (depending on the platform) can be locked and unlocked on owner
-        request and may hide data saved by this command from other applications you run.
+        Instead of saving authentication data for this login to the desktop
+        keyring, use plain-text storage, e.g. if you have not installed the
+        'keytar' module.
+        
+        Note that this is not recommended as it decreases the level of security:
+        at least applications running as the current user can read the
+        plain-text file, whereas the keyring (depending on the platform) can be
+        locked and unlocked on owner request and may hide data saved by this
+        command from other applications you run.
 
-        Be aware that on SAP Business Application Studio, --plain is enforced since keyring
-        functionality is not supported. However, the underlying storage is encrypted.
+        Be aware that on SAP Business Application Studio, --plain is enforced,
+        since keyring functionality is not supported. However, the underlying
+        storage is encrypted.
 
-        During any login, potential pre-existing authentication data for the same
+        During login, potential pre-existing authentication data for the same
         target is deleted from the other, non-selected storage. This allows
         migrating authentication data from one storage to the other by running
         the present command without a passcode.
 
 # SEE ALSO
 
-    Supported commands: *cds subscribe*, *cds upgrade*, *cds pull*, *cds push*, and *cds unsubscribe*.
+    Supported commands: *cds subscribe*, *cds upgrade*, *cds pull*, *cds push*,
+    and *cds unsubscribe*.
+    
     *cds logout* to remove any authentication data.
-    https://cap.cloud.sap/docs/guides/extensibility/customization?q=mock#mock-users for information on suitable mock users.
+    
+    https://cap.cloud.sap/docs/guides/extensibility/customization#mock-users for
+    information on suitable mock users.
 
 `}});
 

package/bin/logout.js

@@ -8,16 +8,17 @@ module.exports = Object.assign(logout, {
 
     *cds logout* [ <extension-project-directory> ]
 
-    Removes authentication data saved locally by *cds login* for use by *cds extend*
-    and *cds activate*. In default mode, deletes only data for a specific app URL
-    and subdomain, optionally including relevant project settings.
+    Removes authentication data saved locally by *cds login* for use with
+    *cds pull* and *cds push*. In default mode, deletes only data for a
+    specific app URL and subdomain, optionally including relevant project
+    settings.
     
-    <app-url> and <tenant-subdomain> will be determined from project settings unless given
-    by options.
+    <app-url> and <tenant-subdomain> will be determined from project settings
+    unless given by options.
     
     Project settings will be loaded by reference to the given folder.
-    If omitted, the project setting are loaded from a subdirectory named as the subdomain
-    or the current working directory.
+    If omitted, the project setting are loaded from a subdirectory named as the
+    subdomain or the current working directory.
     
     To access keyring storage, the 'keytar' Node.js module must be installed.
     If this is not the case, existing keyring entries will not be detected and
@@ -28,11 +29,13 @@ module.exports = Object.assign(logout, {
 
     *-l* | *--url* <app-url>
     
-        The <app-url> to logout from. By default, it's determined from project settings.
+        The <app-url> to logout from. By default, it's determined from project
+        settings.
    
     *-s* | *--subdomain* <subdomain>
     
-        The subdomain to logout from. By default, it's determined from project settings.
+        The subdomain to logout from. By default, it's determined from project
+        settings.
 
     *--delete-settings*
     

package/bin/migrate.js

@@ -15,15 +15,20 @@ module.exports = Object.assign(migrate, {
 
     *-d* | *--directory* <extension-projects-directory>
 
-        Specify the target directory of your migrated extension projects. By default, the migrated extension projects will not be stored.
+        Specify the target directory of your migrated extension projects. By
+        default, the migrated extension projects will not be stored.
 
     *--tag* <tag>
 
-        Specify a default tag that is to be used to store the extension. If not specified "migrated" will be used.
+        Specify a default tag that is to be used to store the extension. If not
+        specified "migrated" will be used.
 
     *--tagRule* <tag rule>
 
-        Specify a regular expression that describes the mapping from file names to tags, e. g. "extension-(.*)\.cds" to map from "extension-123.cds" to tag "123". If the expression does not match, the default tag will be used.
+        Specify a regular expression that describes the mapping from file names
+        to tags, e. g. "extension-(.*)\.cds" to map from "extension-123.cds" to
+        tag "123". If the expression does not match, the default tag will be
+        used.
 
     *--force*
 
@@ -35,7 +40,8 @@ module.exports = Object.assign(migrate, {
 
     *--skip-verification
 
-        Skip verification step. Does not check for potential deployment differences.
+        Skip verification step. Does not check for potential deployment
+        differences.
 
     *--cleanup* (beta)
 

package/bin/pull.js

@@ -8,7 +8,8 @@ module.exports = Object.assign(pull, {
     *cds pull* [ [--from] <app url> ]
 
     Pull the base model for your SaaS app extension.
-    If the app URL is omitted, it is determined from the current user's active CDS or Cloud Foundry login.
+    If the app URL is omitted, it is determined from the current user's active
+    CDS or Cloud Foundry login.
 
     Authentication data will not be saved.
 
@@ -17,11 +18,13 @@ module.exports = Object.assign(pull, {
 
     *-d* | *--directory* <project-extension-directory>
 
-        Specify the target directory of your extension project. By default, the current working directory is used.
+        Specify the target directory of your extension project. By default, the
+        current working directory is used.
 
     *-s* | *--subdomain* <tenant-subdomain>
 
-        Specify your tenant's subdomain. By default, it's determined from the app URL.
+        Specify your tenant's subdomain. By default, it's determined from the
+        app URL.
 
     *-p* | *--passcode* <passcode>
 
@@ -29,7 +32,8 @@ module.exports = Object.assign(pull, {
 
     *-u* | *--user* <name>[:[<password>]]
 
-        Username and optionally password for authentication with Basic Auth in test scenarios.
+        Username and optionally password for authentication with Basic Auth in
+        test scenarios.
 
     *-c* | *--client* <clientid>[:<clientsecret>]
 
@@ -38,8 +42,11 @@ module.exports = Object.assign(pull, {
 # SEE ALSO
 
     *cds push* to push an extension to the SaaS app.
+    
     *cds login* for more information on authentication options.
-    *cds login* to save project settings and authentication data, simplifying multiple runs of this command.
+    
+    *cds login* to save project settings and authentication data, simplifying
+    multiple runs of this command.
 
 `});
 

package/bin/push.js

@@ -9,15 +9,16 @@ module.exports = Object.assign(push, {
 
     Push your extension to the SaaS app in order to enable or update it.
 
-    You may specify a project directory or a custom extension archive, either as a
-    local file or as a URL to download it from.
-    A download URL may contain Basic-Auth credentials as in 'https://user:pass@host'.
+    You may specify a project directory or a custom extension archive, either as
+    a local file or as a URL to download it from.
+    A download URL may contain Basic-Auth credentials as in
+    'https://user:pass@host'.
     
     By default, the current working directory is used as project directory.
     
-    Unless a custom archive is given, the extension project will be automatically built
-    in order to update the generated extension archive. This ensures the most recent
-    extension model is pushed.
+    Unless a custom archive is given, the extension project will be
+    automatically built in order to update the generated extension archive. This
+    ensures the most recent extension model is pushed.
 
     Any authentication data will not be saved.
 
@@ -26,7 +27,8 @@ module.exports = Object.assign(push, {
 
     *--to* <url>
 
-        Specify the URL of the extensible SaaS app. Determined from the current user's active
+        Specify the URL of the extensible SaaS app. Determined from the current
+        user's active
         CDS or Cloud Foundry login by default.
 
     *-s* | *--subdomain* <tenant-subdomain>
@@ -39,7 +41,8 @@ module.exports = Object.assign(push, {
 
     *-u* | *--user* <name>[:[<password>]]
 
-        Username and optionally password for authentication with Basic Auth in test scenarios.
+        Username and optionally password for authentication with Basic Auth in
+        test scenarios.
 
     *-c* | *--client* <clientid>[:<clientsecret>]
 
@@ -49,8 +52,11 @@ module.exports = Object.assign(push, {
 # SEE ALSO
 
     *cds pull* to get the CDS model of the SaaS app.
+    
     *cds login* for more information on authentication options.
-    *cds login* to save project settings and authentication data, simplifying multiple runs of this command.
+    
+    *cds login* to save project settings and authentication data, simplifying
+    multiple runs of this command.
 
 `});
 
@@ -68,11 +74,16 @@ async function push([projectFolder], options = {}) {
     delete options.client;
 
     let extArchive;
-    if (projectFolder && !isDir(projectFolder)) {
-        extArchive = projectFolder;
-        projectFolder = undefined;
+    if (projectFolder) {
+        if (isDir(projectFolder)) {
+            const cds = require('../lib/cds');
+            cds.root = projectFolder;
+            cds.env = cds.env.for('cds', projectFolder);
+        } else {
+            extArchive = projectFolder;
+            projectFolder = undefined;
+        }
     }
-
     const args = [{
         ...options,
         projectFolder,

package/bin/repl.js

@@ -44,6 +44,7 @@ function repl (_, options={}) {
     Reflect.defineProperty (cds,'env',{ value:cds.env, enumerable:false })
   }
 
+  inspect.defaultOptions.colors = true
   inspect.defaultOptions.depth = 11
   function _writer (o) {
     if (!o || typeof o !== 'object') return o

package/bin/run.js

@@ -0,0 +1,25 @@
+const serve = require ('./serve')
+module.exports = Object.assign (
+    cds_run, serve, {help: `
+# SYNOPSIS
+
+    *cds run* [<project>] [<options>]
+
+    Runs 'cds serve all' for the specified project. By default, <project> = cwd
+    is used.
+
+# OPTIONS
+
+    - see _cds help serve_
+
+# SEE ALSO
+
+    Actually, *cds run* is just a convenient shortcut for:
+    *cds serve* [--project <project>] [<options>] ...
+    Check out *cds serve --help* to learn more.
+
+`})
+
+function cds_run (projects, options) {
+    return serve (projects,{ project:true, ...options })
+}

package/bin/subscribe.js

@@ -10,31 +10,36 @@ module.exports = Object.assign(subscribe, {
 
     Subscribe a tenant to a multitenant SaaS app.
 
-    Running *cds subscribe* with a URL is intended for non-productive use only, including against
-    SaaS apps running on localhost with mock authentication.
+    Running *cds subscribe* with a URL is intended for non-productive use only,
+    including against SaaS apps running on localhost with mock authentication.
 
 # OPTIONS
 
     *-2* | *--to* <url>
 
-        Specify the URL of the SaaS app. Determined from the current user's active CDS or
-        Cloud Foundry login by default.
+        Specify the URL of the SaaS app. Determined from the current user's
+        active CDS or Cloud Foundry login by default.
 
     *-u* | *--user* <name>[:[<password>]]
 
-        Username and optionally password for authentication with Basic Auth in test scenarios.
-        Only relevant if <url> is given. May be omitted in case of dummy authentication.
+        Username and optionally password for authentication with Basic Auth in
+        test scenarios.
+        
+        Only relevant if <url> is given. May be omitted in case of dummy
+        authentication.
+        
         Tokens saved with *cds login* are not used for this command.
 
     *-l* | *--local*
 
-        Run a locally-installed @sap/cds-mtxs and connect to it instead of a URL. Ignore settings
-        saved with *cds login*.
+        Run a locally-installed @sap/cds-mtxs and connect to it instead of a
+        URL. Ignore settings saved with *cds login*.
 
 
 # SEE ALSO
 
     *cds login* for more information on authentication options.
+    
     *cds login* to save project settings and Basic-Auth data, simplifying multiple runs of this command.
 
 `});

package/bin/unsubscribe.js

@@ -10,30 +10,37 @@ module.exports = Object.assign(unsubscribe, {
 
     Unsubscribe a tenant from a multitenant SaaS app.
 
-    Running *cds unsubscribe* with a URL is intended for non-productive use only, including against
-    SaaS apps running on localhost with mock authentication.
+    Running *cds unsubscribe* with a URL is intended for non-productive use
+    only, including against SaaS apps running on localhost with mock
+    authentication.
 
 # OPTIONS
 
     *-f* | *--from* <url>
 
-        Specify the URL of the SaaS app. Determined from the current user's active CDS or
-        Cloud Foundry login by default.
+        Specify the URL of the SaaS app. Determined from the current user's
+        active CDS or Cloud Foundry login by default.
 
     *-u* | *--user* <name>[:[<password>]]
 
-        Username and optionally password for authentication with Basic Auth in test scenarios.
-        Only relevant if <url> is given. Tokens saved with *cds login* are not used for this command.
+        Username and optionally password for authentication with Basic Auth in
+        test scenarios.
+        
+        Only relevant if <url> is given. May be omitted in case of dummy
+        authentication.
+        
+        Tokens saved with *cds login* are not used for this command.
 
     *-l* | *--local*
 
-        Run a locally-installed @sap/cds-mtxs and connect to it instead of a URL. Ignore settings
-        saved with *cds login*.
+        Run a locally-installed @sap/cds-mtxs and connect to it instead of a
+        URL. Ignore settings saved with *cds login*.
 
 
 # SEE ALSO
 
     *cds login* for more information on authentication options.
+    
     *cds login* to save project settings and Basic-Auth data, simplifying multiple runs of this command.
 
 `});

package/bin/upgrade.js

@@ -8,33 +8,39 @@ module.exports = Object.assign(upgrade, {
 
     *cds upgrade* <tenant>
 
-    Upgrade a tenant subscribed to a multitenant SaaS app to its latest base model.
+    Upgrade a tenant subscribed to a multitenant SaaS app to its latest base
+    model.
 
-    Running *cds upgrade* with a URL is intended for non-productive use only, including against
-    SaaS apps running on localhost with mock authentication.
+    Running *cds upgrade* with a URL is intended for non-productive use only,
+    including against SaaS apps running on localhost with mock authentication.
 
 # OPTIONS
 
     *-a* | *--at* <url>
 
-        Specify the URL of the SaaS app. Determined from the current user's active CDS or
-        Cloud Foundry login by default.
+        Specify the URL of the SaaS app. Determined from the current user's
+        active CDS or Cloud Foundry login by default.
 
     *-u* | *--user* <name>[:[<password>]]
 
-        Username and optionally password for authentication with Basic Auth in test scenarios.
-        Only relevant if <url> is given. May be omitted in case of dummy authentication.
+        Username and optionally password for authentication with Basic Auth in
+        test scenarios.
+        
+        Only relevant if <url> is given. May be omitted in case of dummy
+        authentication.
+        
         Tokens saved with *cds login* are not used for this command.
 
     *-l* | *--local*
 
-        Run a locally-installed @sap/cds-mtxs and connect to it instead of a URL. Ignore settings
-        saved with *cds login*.
+        Run a locally-installed @sap/cds-mtxs and connect to it instead of a
+        URL. Ignore settings saved with *cds login*.
 
 
 # SEE ALSO
 
     *cds login* for more information on authentication options.
+    
     *cds login* to save project settings and Basic-Auth data, simplifying multiple runs of this command.
 
 `});

package/bin/util/log.js

@@ -0,0 +1,24 @@
+// sorts, filters, and writes compilation messages to console
+module.exports = (messages, options={}) => {
+  const { format } = require('../../lib/util/term')
+  const logLevel = options && options['log-level'] || require('../../lib').env.log.levels.cli || ''
+  const levels = {
+    debug: { Error:4, undefined:4, Warning:3, Info:2, Debug:1 },
+    info: { Error:4, undefined:4, Warning:3, Info:2 },
+    warn: { Error:4, undefined:4, Warning:3 },
+    error: { Error:4, undefined:4 },
+  } [logLevel.toLowerCase()] || { Error:4, undefined:4, Warning:3 }
+  const log = options.log || console.error
+
+  if (!Array.isArray (messages))  messages = [messages]
+  for (let m of messages.filter (m => m.severity in levels)) {
+    // show stack for resolution issues since there the requiring code location is in the stack
+    // check for standard Error classes, but not Error itself
+    const internalError = m.name === 'EvalError' || m.name === 'InternalError' || m.name === 'RangeError'
+    || m.name === 'ReferenceError' || m.name === 'SyntaxError' || m.name === 'TypeError'
+    || m.name === 'URIError'
+    const mf = format (m, m.severity, internalError, true)
+    log (mf)
+  }
+}
+/* eslint no-console:off */