@sap/cds 6.1.3 → 6.2.1

package/lib/env/cds-requires.js

@@ -2,9 +2,16 @@ const _runtime = '@sap/cds/libx/_runtime'
 
 exports = module.exports = {
 
+  middlewares: false,
+  "[middlewares]": {
+    middlewares: true
+  },
+
   db: undefined,
   messaging: undefined,
   multitenancy: undefined,
+  extensibility: undefined,
+  toggles: undefined,
 
   auth: {
     '[development]': { kind: 'mocked-auth' },
@@ -33,11 +40,16 @@ exports = module.exports = {
 
 const _authentication_strategies = {
 
-  "basic-auth": "mocked-auth",
+  "basic-auth": {
+    kind: 'basic-auth', // this is to override kind from cds.requires.auth
+    strategy: 'mock', // REVISIT: Can be removed when we switch to new auth middlewars
+    users: {},
+    tenants: {}
+  },
   "mocked-auth": {
-    strategy: 'mock',
+    kind: 'basic-auth',
     users: {
-      alice: { roles: ['admin'] },
+      alice: { roles: ['admin', 'cds.Subscriber'] },
       bob:   { roles: ['builder'] },
       carol: { tenant: 't1', roles: ['admin', 'cds.Subscriber', 'cds.ExtensionDeveloper', 'cds.UIFlexDeveloper'] },
       dave:  { tenant: 't1', roles: ['cds.Subscriber'], features: [] }, // user-specific features
@@ -52,15 +64,19 @@ const _authentication_strategies = {
     }
   },
   "jwt-auth": {
-    strategy: 'JWT',
+    strategy: 'JWT', // REVISIT: Can be removed when we switch to new auth middlewars
     vcap: { label: 'xsuaa' }
   },
+  "ias-auth": {
+    kind: 'ias-auth',
+    vcap: { label: 'identity' }
+  },
   "xsuaa": {
-    strategy: 'xsuaa',
+    strategy: 'xsuaa', // REVISIT: Can be removed when we switch to new auth middlewars
     vcap: { label: 'xsuaa' }
   },
   "dummy-auth": {
-    strategy: 'dummy',
+    strategy: 'dummy', // REVISIT: Can be removed when we switch to new auth middlewars
   },
 
 }
@@ -101,13 +117,18 @@ const _databases = {
   "sql": {
     '[development]': { kind: 'sqlite', credentials: { url: ':memory:' } },
     '[production]': { kind: 'hana' },
+    '[better-sqlite]': { kind: 'better-sqlite' },
   },
+  "better-sqlite": _compat_to_use({
+    credentials: { url: ":memory:" },
+    impl: "@sap/cds-sqlite",
+  }),
   "sql-mt": {
     '[development]': { kind: 'sqlite' },
     '[production]': { kind: 'hana-mt' },
   },
   "sqlite": _compat_to_use({
-    credentials: { url: 'sqlite.db' },
+    credentials: { url: 'db.sqlite' },
     impl: `${_runtime}/sqlite/Service.js`,
   }),
   "hana": _compat_to_use ({
@@ -191,56 +212,6 @@ const _messaging = {
 }
 
 
-const _mtx_services = {
-
-  "toggles": {
-    model: "@sap/cds/srv/mtx"
-  },
-  "cds.xt.ModelProviderService": {
-    model: "@sap/cds/srv/model-provider"
-  },
-  "cds.xt.ModelProviderService-in-sidecar": {
-    "[development]": { root: "../.." }, // sidecar is expected to reside in ./mtx/sidecar
-    "[production]": { root: "_main" },
-    "[prod]": { root: "_main" }, // for simulating production in local tests
-  },
-  "cds.xt.ModelProviderService-from-sidecar": {
-    kind: 'rest'
-  },
-
-  "multitenancy": {
-    model: "@sap/cds/srv/mtx",
-    kind: "saas-registry",
-  },
-  "cds.xt.SaasProvisioningService": {
-    model: "@sap/cds-mtxs/srv/cf/saas-provisioning-service",
-    kind: "saas-registry",
-  },
-  "cds.xt.DeploymentService": {
-    model: "@sap/cds-mtxs/srv/deployment-service",
-  },
-  "cds.xt.DeploymentService-in-sidecar": {
-  },
-  "cds.xt.DeploymentService-from-sidecar": {
-    kind: 'rest'
-  },
-
-  "extensions": {
-    model: "@sap/cds/srv/extensions",
-  },
-  "extensibility": {
-    model: [ "@sap/cds/srv/mtx", "@sap/cds/srv/extensions" ],
-    tenantCheckInterval: 10000
-  },
-  "cds.xt.ExtensibilityService": {
-    model: "@sap/cds/srv/extensibility-service"    
-  },
-  "uiflex": "extensibility", // REVISIT: temporary for compatibility with cds-mtxs tests -> eliminate "uiflex" later
-
-}
-
-
-
 const _platform_services = {
 
   "audit-log-service": {
@@ -265,13 +236,35 @@ const _platform_services = {
 
 }
 
+require = (id) => { // eslint-disable-line no-global-assign
+  try {
+    return module.require(id)
+  } catch(e) {
+    if (e.code !== 'MODULE_NOT_FOUND') throw e
+  }
+}
+
+// REVISIT: we should have a real modular plugin technique for cds.env
+// eslint-disable-next-line cds/no-missing-dependencies
+const _mtxs = require('@sap/cds-mtxs/lib/env-requires') || {
+  "toggles": {
+    model: "@sap/cds/srv/mtx"
+  },
+  "multitenancy": {
+    model: "@sap/cds/srv/mtx",
+    kind: "saas-registry",
+  },
+  "extensibility": {
+    model: "@sap/cds/srv/mtx",
+  },
+}
 
 exports.kinds = {
   ..._authentication_strategies,
   ..._databases,
   ..._services,
   ..._messaging,
-  ..._mtx_services,
+  ..._mtxs,
   ..._platform_services,
 }
 

package/lib/env/defaults.js

@@ -24,6 +24,7 @@ module.exports = {
     mocked_bindings: !production,
     // skip_unused: 'all',
     skip_unused: true,
+    deploy_data_onconflict: 'insert',
     one_model: true,
     localized: true,
     assert_integrity: false,

package/lib/env/schemas/cds-package.json

@@ -4,6 +4,10 @@
   "description": "This is a JSON schema representation of the CDS project configuration inside a project root level package.json",
   "type": "object",
   "properties": {
+    "extends": {
+      "description": "Name of the application that shall be extended",
+      "type": "string"
+    },
     "cds": {
       "$ref": "cdsJsonSchema://schemas/cds-rc.json"
     }

package/lib/env/schemas/cds-rc.json

@@ -7,26 +7,23 @@
   "properties": {
     "folders": {
       "type": "object",
-      "description": "Set folders if you don't want to use the defaults 'app', 'db', 'srv'.",
+      "description": "Only set folders if you don't want to use the defaults 'app/', 'db/', 'srv/'.",
       "additionalProperties": true,
       "properties": {
         "app": {
           "type": "string",
           "format": "uri-reference",
-          "default": "app",
-          "description": "Path for app folder."
+          "description": "Add a custom path for the app property, which becomes 'cds.roots'."
         },
         "db": {
           "type": "string",
           "format": "uri-reference",
-          "default": "db",
-          "description": "Path for db folder."
+          "description": "Add a custom path for the db property, which becomes 'cds.roots'."
         },
         "srv": {
           "type": "string",
           "format": "uri-reference",
-          "default": "srv",
-          "description": "Path for srv folder."
+          "description": "Add a custom path for the srv property, which becomes 'cds.roots'."
         }
       },
       "patternProperties": {
@@ -37,36 +34,38 @@
     },
     "build": {
       "type": "object",
-      "description": "CDS build settings.",
+      "description": "Customize CDS build settings.",
       "additionalProperties": true,
       "properties": {
         "target": {
           "type": "string",
-          "description": "The folder which contains generated build results. Defaults to 'gen'.",
-          "format": "uri-reference",
-          "default": "gen"
+          "description": "Specify the folder which contains generated build results. Defaults to './gen'.",
+          "format": "uri-reference"
         },
         "tasks": {
           "type": "array",
-          "description": "Controls which tasks cds build will execute on your project modules.",
+          "description": "Control which tasks 'cds build' will execute on your project modules. This is a typical task configuration: '\"tasks\": [{ \"for\": \"hana\"}];",
           "uniqueItems": true,
+          "default": [
+            {}
+          ],
           "items": {
             "type": "object",
             "additionalProperties": true,
             "properties": {
               "dest": {
                 "type": "string",
-                "description": "Destination folder for this build task relative to build target folder.",
+                "description": "Optional: Define the destination folder for this build task, relative to build target folder. \nFor example: Destination defined as 'custom' results in an output written to 'gen/custom'.",
                 "format": "uri-reference"
               },
               "src": {
                 "type": "string",
-                "description": "Source folder for this build task.",
+                "description": "Optional: Prefer defining 'cds.folders'. Use 'src' if you want it only to be valid for this specific build task, which excludes, for example, 'cds watch'.",
                 "format": "uri-reference"
               },
               "for": {
                 "type": "string",
-                "description": "Target technology for this build task.",
+                "description": "Define the target technology for this build task.",
                 "minLength": 1,
                 "enum": [
                   "nodejs",
@@ -81,7 +80,7 @@
               },
               "options": {
                 "type": "object",
-                "description": "Set target technology specific options for this build task.",
+                "description": "Optional: Set target technology specific options for this build task.",
                 "additionalProperties": true,
                 "properties": {
                   "model": {
@@ -96,50 +95,41 @@
     },
     "i18n": {
       "type": "object",
-      "description": "CDS translation settings.",
+      "description": "Customize CDS translation settings.",
       "additionalProperties": true,
       "properties": {
         "default_language": {
-          "type": "string",
-          "default": "en"
+          "type": "string"
         },
         "folders": {
-          "description": "List of language file folders. First valid entry wins.",
-          "default": [
-            "_i18n",
-            "i18n",
-            "assets/i18n"
-          ],
+          "description": "Define the list of folders containing language files. Defaults are '_i18n/', 'i18n/', and 'assets/i18n/'. First valid entry wins.",
+          "default": [],
           "$ref": "#/$defs/foldersStringArray"
         }
       }
     },
     "deploy": {
       "type": "object",
-      "description": "CDS deploy settings.",
+      "description": "Customize 'cds deploy' settings.",
       "additionalProperties": true,
       "properties": {
         "no_save": {
           "type": "boolean",
-          "description": "Do / don't update config in package.json.",
+          "description": "Do / don't update configuration in package.json.",
           "default": true
         }
       }
     },
-    "extends": {
-      "description": "Name of the application that shall be extended",
-      "type": "string"
-    },
     "requires": {
       "type": "object",
-      "description": "CDS Dependencies to databases and services can be configured by listing them within a requires section.",
+      "description": "List CDS dependencies to databases and services within the requires section.",
       "additionalProperties": true,
       "properties": {
         "auth": {
           "oneOf": [
             {
               "type": "string",
-              "description": "Auth-specific settings via shortcut.",
+              "description": "Use standard auth-specific settings via shortcut.",
               "anyOf": [
                 {
                   "$ref": "#/$defs/authType"
@@ -151,15 +141,13 @@
             },
             {
               "type": "object",
-              "description": "Authentication settings.",
-              "default": {
-                "kind": "mocked"
-              },
+              "description": "Use custom authentication settings.",
+              "default": {},
               "additionalProperties": true,
               "properties": {
                 "kind": {
                   "type": "string",
-                  "description": "Kind of dependency.",
+                  "description": "Define the kind of strategy.",
                   "anyOf": [
                     {
                       "$ref": "#/$defs/authType"
@@ -174,7 +162,7 @@
                 },
                 "credentials": {
                   "type": "object",
-                  "description": "Can be explicitly configured here, but will be overruled by VCAP_SERVICES if a matching entry is found therein.",
+                  "description": "You can explicitly configure credentials, but this is overruled by VCAP_SERVICES if a matching entry is found therein.",
                   "additionalProperties": true,
                   "properties": {
                     "database": {
@@ -191,7 +179,7 @@
           "oneOf": [
             {
               "type": "string",
-              "description": "Database specific settings via shortcut.",
+              "description": "Use standard database-specific settings via shortcut.",
               "anyOf": [
                 {
                   "$ref": "#/$defs/databaseType"
@@ -203,15 +191,13 @@
             },
             {
               "type": "object",
-              "description": "Database specific settings.",
-              "default": {
-                "kind": "sqlite"
-              },
+              "description": "Use custom database-specific settings.",
+              "default": {},
               "additionalProperties": true,
               "properties": {
                 "kind": {
                   "type": "string",
-                  "description": "Kind of dependency.",
+                  "description": "Define the kind of dependency.",
                   "anyOf": [
                     {
                       "$ref": "#/$defs/databaseType"
@@ -222,12 +208,12 @@
                   ]
                 },
                 "model": {
-                  "description": "Assigned model. Interpreted like Node.js 'requires' logic.",
+                  "description": "Define the assigned model. Interpreted like Node.js 'requires' logic.",
                   "$ref": "#/$defs/foldersStringArray"
                 },
                 "credentials": {
                   "type": "object",
-                  "description": "Can be explicitly configured here, but will be overruled by VCAP_SERVICES if a matching entry is found therein.",
+                  "description": "You can explicitly configure credentials, but this is overruled by VCAP_SERVICES if a matching entry is found therein.",
                   "additionalProperties": true,
                   "properties": {
                     "database": {
@@ -238,7 +224,7 @@
                 },
                 "vcap": {
                   "type": "object",
-                  "description": "Can optionally be used to select entry in VCAP_SERVICES.",
+                  "description": "Optional: Used to select an entry in VCAP_SERVICES.",
                   "additionalProperties": true,
                   "properties": {
                     "name": {
@@ -253,18 +239,18 @@
         },
         "multitenancy": {
           "type": "boolean",
-          "description": "Shortcut to enable multitenancy"
+          "description": "Shortcut to enable multitenancy."
         },
         "extensibility": {
           "type": "boolean",
-          "description": "Shortcut to enable extensibility"
+          "description": "Shortcut to enable extensibility."
         },
         "toggles": {
           "type": "boolean",
-          "description": "Shortcut to enable feature toggles"
+          "description": "Shortcut to enable feature toggles."
         },
         "cds.xt.ModelProviderService": {
-          "description": "Serves model variants, which may include tenant-specific extensions and/or feature-toggled aspects",
+          "description": "Configure if/how the ModelProviderService serves model variants that may include tenant-specific extensions and/or feature-toggled aspects.",
           "oneOf": [
             {
               "$ref": "#/$defs/serviceActivation"
@@ -279,7 +265,7 @@
               "properties": {
                 "root": {
                   "type": "string",
-                  "description": "A directory name, absolute or relative to the package.json’s location, specifying the location to search for models and resources to be served by the model provider services. Default is undefined, for embedded usage of model provider. In case of a sidecar, it refers to the main app’s model; usually '../..' during development, and '_main' in production",
+                  "description": "A directory name, absolute or relative to the package.json's location, specifying the location to search for models and resources to be served by the model provider services. Default is undefined, for embedded usage of model provider. In case of a sidecar, it refers to the main app's model; usually '../..' during development, and '_main' in production.",
                   "format": "uri-reference"
                 }
               }
@@ -287,7 +273,7 @@
           ]
         },
         "cds.xt.ExtensibilityService": {
-          "description": "Allows to add and activate tenant-specific extensions at runtime",
+          "description": "Configure if/how the ExtensibilityService allows to add and activate tenant-specific extensions at runtime.",
           "oneOf": [
             {
               "$ref": "#/$defs/serviceActivation"
@@ -298,7 +284,7 @@
           ]
         },
         "cds.xt.DeploymentService": {
-          "description": "Handles subscribe, unsubscribe, and upgrade events for single tenants and single apps / micro-services",
+          "description": "Configure if/how the DeploymentService handles subscribe, unsubscribe, and upgrade events for single tenants and single apps/micro-services.",
           "oneOf": [
             {
               "$ref": "#/$defs/serviceActivation"
@@ -309,7 +295,7 @@
           ]
         },
         "cds.xt.SaasProvisioningService": {
-          "description": "Facade for the DeploymentService to adapt to the API expected by SAP BTP’s SaaS Provisioning Service, hence providing out-of-the-box integration",
+          "description": "De-/Activate the facade for the DeploymentService to adapt to the API expected by SAP BTP’s SaaS Provisioning Service, hence providing out-of-the-box integration.",
           "oneOf": [
             {
               "$ref": "#/$defs/serviceActivation"
@@ -385,15 +371,15 @@
         },
         {
           "const": "odata",
-          "description": "Odata service"
+          "description": "OData service"
         },
         {
           "const": "odata-v2",
-          "description": "Odata service version 2"
+          "description": "OData service version 2"
         },
         {
           "const": "odata-v4",
-          "description": "Odata service version 4"
+          "description": "OData service version 4"
         },
         {
           "const": "rest",
@@ -428,18 +414,18 @@
     },
     "mockUsers": {
       "type": "object",
-      "description": "List of users for local usage",
+      "description": "List of users for local usage.",
       "properties": {
         "*": {
           "default": true,
           "oneOf": [
             {
               "const": true,
-              "description": "Allow other users than the ones specified"
+              "description": "Allow other users than the ones specified."
             },
             {
               "const": false,
-              "description": "Block other users than the ones specified"
+              "description": "Block other users than the ones specified."
             }
           ]
         }
@@ -447,11 +433,11 @@
       "patternProperties": {
         ".+": {
           "type": "object",
-          "additionalProperties": false,
+          "additionalProperties": true,
           "properties": {
             "roles": {
               "type": "array",
-              "description": "Roles of the user",
+              "description": "Roles of the user.",
               "uniqueItems": true,
               "items": {
                 "type": "string"
@@ -459,7 +445,7 @@
             },
             "features": {
               "type": "array",
-              "description": "Feature toggle values of the user",
+              "description": "Feature toggle values of the user.",
               "uniqueItems": true,
               "items": {
                 "type": "string"
@@ -467,11 +453,11 @@
             },
             "tenant": {
               "type": "string",
-              "description": "SaaS tenant of the user"
+              "description": "SaaS tenant of the user."
             },
-            "userAttributes": {
+            "attr": {
               "type": "object",
-              "description": "Additional user attributes",
+              "description": "Additional user attributes.",
               "patternProperties": {
                 ".+": {
                   "type": "string",
@@ -500,7 +486,7 @@
         },
         {
           "const": "hana-mt",
-          "description": "Multi-tenant SAP HANA Cloud"
+          "description": "Multitenant SAP HANA Cloud"
         },
         {
           "const": "sql",
@@ -508,7 +494,7 @@
         },
         {
           "const": "sql-mt",
-          "description": "File-based SQLite (development), Multi-tenant SAP HANA Cloud (production)"
+          "description": "File-based SQLite (development), Multitenant SAP HANA Cloud (production)"
         },
         {
           "const": "sqlite",
@@ -534,11 +520,11 @@
     },
     "serviceActivation": {
       "type": "boolean",
-      "description": "Activate or deactivate this service"
+      "description": "De-/Activate this service."
     },
     "servicePresetSidecar": {
       "type": "string",
-      "description": "'in-sidecar' preset provides defaults for usage in sidecars.\n'from-sidecar' preset is a shortcut for '{ kind: rest }'",
+      "description": "'in-sidecar' preset provides defaults for usage in sidecars.\n'from-sidecar' preset is a shortcut for '{ kind: rest }'.",
       "enum": [
         "in-sidecar",
         "from-sidecar"
@@ -551,7 +537,7 @@
       "properties": {
         "element-prefix": {
           "type": "array",
-          "description": "Field names must start with one of these strings",
+          "description": "Field names must start with one of these strings.",
           "uniqueItems": true,
           "items": {
             "type": "string"
@@ -559,7 +545,7 @@
         },
         "namespace-blocklist": {
           "type": "array",
-          "description": "Namespaces must not start with these strings",
+          "description": "Namespaces must not start with these strings.",
           "uniqueItems": true,
           "items": {
             "type": "string"
@@ -575,7 +561,7 @@
             "properties": {
               "for": {
                 "type": "array",
-                "description": "Restriction applies to these namespaces",
+                "description": "Restriction applies to these namespaces.",
                 "uniqueItems": true,
                 "items": {
                   "type": "string"
@@ -597,7 +583,7 @@
               },
               "new-fields": {
                 "type": "integer",
-                "description": "Number of fields to be added at most",
+                "description": "Number of fields to be added at most.",
                 "minimum": 1
               },
               "new-entities": {
@@ -611,4 +597,4 @@
       }
     }
   }
-}
+}

package/lib/i18n/localize.js

@@ -1,9 +1,9 @@
 const cds = require ('..')
 const {existsSync, readdirSync} = require ('fs')
-const {join,dirname,resolve,parse} = require ('path')
+const {join,dirname,resolve,parse,sep} = require ('path')
 
 const DEBUG = cds.debug('i18n')
-
+const _node_modules = sep + 'node_modules'
 
 module.exports = Object.assign (localize, {
   bundles4, folders4, folder4, bundle4
@@ -172,14 +172,25 @@ function folders4 (model) {
 function folder4 (loc) {
   // already cached from a former lookup?
   if (loc in folder4)  return folder4[loc]
-  // check whether a <loc>/_i18n extists
+  // check whether a <loc>/_i18n exists
   for (let i18n of cds.env.i18n.folders) {
     const f = join (loc, i18n)
     if (existsSync(f)) return folder4[loc] = f
   }
-  //> no --> search up the folder hierarchy
+  //> no --> search up the folder hierarchy up to cds.root, cds.home, or some .../node_modules/<package>
   let next = dirname(loc)
-  return folder4[loc] = !next || next === loc  ?  null  :  folder4(next)
+  if (next.includes(_node_modules)) {
+    if (next.endsWith(_node_modules)) return folder4[loc] = null
+  } else {
+    if (!(
+      next.startsWith(cds.root) ||
+      next.startsWith(cds.home) ||
+      cds.env.i18n.root && next.startsWith(cds.env.i18n.root)
+    )) return folder4[loc] = null
+  }
+  if (!next || next === loc) return folder4[loc] = null
+  // console.debug(next)
+  return folder4[loc] = folder4(next)
 }