@sap/cds 8.4.2 → 8.5.0

package/CHANGELOG.md

@@ -4,6 +4,38 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 8.5.0 - 2024-11-25
+
+### Added
+
+- New `cds.i18n` module used consistently for both, UI labels and runtime messages.
+- Enhanced `cds.validate` to support open intervals for: `@assert.range:[(0),(Infinity)]` -> `0 < x < ∞`
+- `package.json` validation and suggestions for messaging services.
+- `cds.log()`: Detect binding to SAP Cloud Logging via user provided service. The user provided service must have tag `cloud-logging`.
+- Support for function parameters via query component (example: `GET /foo?bar=baz` instead of `GET /foo(bar='baz')`)
+- Experimental support for programmatic draft actions `srv.new(MyEntity, data)`, `srv.cancel(MyEntity.drafts, keys)`, `srv.edit(MyEntity, data)` and `srv.save(MyEntity.drafts, keys)`
+
+### Changed
+
+- `cds-deploy` script has a non-zero exit code on deployment failure
+- Properties of type `cds.Binary` in URLs as well as request payload are converted to `Buffer`s.
+  Properties of type `cds.LargeBinary` in request payload are converted to `Readable`s.
+  Previously, both were provided as Base64-encoded strings.
+  This change can be deactivated via `cds.env.features.base64_binaries = true`, which is set by default for profile `attic`.
+
+### Fixed
+
+- `cds.validate` should not delete readonly keys from `req.data`
+- `cds.validate` should not reject imported associations
+- Readonly fields must not be set when creating draft entities
+- Validation of mandatory properties caused streams to be rejected for new OData adapter
+- `cds.log` with null parameters and JSON format
+- `cds.compile.to.sql` proper replacement for sqlite session variables in java projects
+- `cds.compile.to.serviceinfo` ignores only the `endpoints` property for unknown protocols
+- `Preference-Applied` header is returned in OData adapter if requested
+- No location header is returned on OData update requests if `minimal` preference is set
+- Handling of invalid requests for views with parameters
+
 ## Version 8.4.2 - 2024-11-13
 
 ### Fixed
@@ -29,8 +61,9 @@
 
 ### Changed
 
+- Internal API `srv.endpoints` now always is an array of endpoint objects, an empty one if the service is not served to any protocol.
+- Property `.cmd` of `cds.ql.Query` (and subclasses thereof) is deprecated → use `.kind` instead
 - For remote service calls to OData v2 services, less conversions are performed on the returned data
-- Internal API `srv.endpoints` now always is an array of endpoint objects, an empty one if the service is not served to any protocol
 
 ### Fixed
 
@@ -215,6 +248,7 @@
 - Allow programmatic operations on draft-enabled entities (`NEW`, `CREATE`, `UPDATE`, `DELETE`)
 
 ### Removed
+
 - Allow deviating response types for `$batch`, e. g. input `multipart` and output `json`
 
 ## Version 8.0.2 - 2024-07-09

package/_i18n/messages.properties

@@ -0,0 +1,99 @@
+400 = Bad Request
+401 = Unauthorized
+403 = Forbidden
+404 = Not Found
+405 = Method Not Allowed
+406 = Not Acceptable
+407 = Proxy Authentication Required
+408 = Request Timeout
+409 = Conflict
+410 = Gone
+411 = Length Required
+412 = Precondition Failed
+413 = Payload Too Large
+414 = URI Too Long
+415 = Unsupported Media Type
+416 = Range Not Satisfiable
+417 = Expectation Failed
+422 = Unprocessable Content
+424 = Failed Dependency
+428 = Precondition Required
+429 = Too Many Requests
+431 = Request Header Fields Too Large
+451 = Unavailable For Legal Reasons
+500 = Internal Server Error
+501 = The server does not support the functionality required to fulfill the request
+502 = Bad Gateway
+503 = Service Unavailable
+504 = Gateway Timeout
+
+MULTIPLE_ERRORS = Multiple errors occurred. Please see the details for more information.
+
+# -------------------------------------------------------------------------------------------------
+# all texts below are subject to change!
+# -------------------------------------------------------------------------------------------------
+
+# fragments
+ENTITY = entity
+TYPE = type
+FUNCTION = function
+ACTION = action
+
+# assert
+ASSERT_VALID_ELEMENT = Element is not valid
+ASSERT_RANGE = Value {0} is not in specified range [{1}, {2}]
+ASSERT_FORMAT = Value "{0}" is not in specified format "{1}"
+ASSERT_DATA_TYPE = Value {0} is not a valid {1}
+ASSERT_ARRAY = Value must be an array
+ASSERT_ENUM = Value {0} is invalid according to enum declaration {{1}}
+ASSERT_NOT_NULL = Value is required
+ASSERT_TARGET = "Value doesn't exist"
+
+# db
+NO_DATABASE_CONNECTION = No database connection
+ENTITY_ALREADY_EXISTS = Entity already exists
+ENTITY_LOCKED = Entity locked
+UNIQUE_CONSTRAINT_VIOLATION = Unique constraint violation
+FK_CONSTRAINT_VIOLATION = Foreign key constraint violation
+
+# remote
+INVALID_CONTENT_TYPE_ONLY_JSON = Invalid content type. Only "application/json" is supported.
+
+# access control
+INSERTABLE = insertable
+READABLE = readable
+UPDATABLE = updatable
+DELETABLE = deletable
+ENTITY_IS_INSERT_ONLY = Entity "{0}" is insert-only
+ENTITY_IS_READ_ONLY = Entity "{0}" is read-only
+ENTITY_IS_NOT_CRUD = Entity "{0}" is not {1}
+ENTITY_IS_NOT_CRUD_VIA_NAVIGATION = Entity "{0}" is not {1} via navigation "{2}"
+ENTITY_IS_AUTOEXPOSED = Entity "{0}" is not explicitly exposed as part of the service
+ENTITY_IS_AUTOEXPOSE_READONLY = Entity "{0}" is explicitly exposed as readonly
+EXPAND_IS_RESTRICTED = Navigation property "{0}" is not allowed for expand operation
+
+# rest protocol adapter
+INVALID_RESOURCE = "{0}" is not a valid resource
+INVALID_PARAMETER = "{0}" is not a valid parameter
+INVALID_PARAMETER_VALUE_TYPE = Parameter value for "{0}" must be of type "{1}"
+INVALID_OPERATION_FOR_ENTITY = Entity "{0}" has no {1} "{2}"
+NO_MATCHING_RESOURCE = The server has not found a resource matching the requested URI
+INVALID_POST = POST is only allowed on resource collections and actions
+INVALID_PUT = PUT is only allowed on a specific resource
+INVALID_PATCH = PATCH is only allowed on a specific resource
+INVALID_DELETE = DELETE is only supported on a specific resource
+CRUD_VIA_NAVIGATION_NOT_SUPPORTED = CRUD via navigations is not yet supported
+
+# OData protocol adapter
+BATCH_TOO_MANY_REQ = Batch request contains too many requests
+
+# draft
+DRAFT_ALREADY_EXISTS = A draft for this entity already exists
+DRAFT_NOT_EXISTING = No draft for this entity exists
+DRAFT_LOCKED_BY_ANOTHER_USER = The entity is locked by user "{0}"
+DRAFT_MODIFICATION_ONLY_VIA_ROOT = A draft-enabled entity can only be modified via its root entity
+ACTIVE_MODIFICATION_VIA_DRAFT = Active entities cannot be modified via draft request
+DRAFT_ACTIVE_DELETE_FORBIDDEN_DRAFT_EXISTS = Entity cannot be deleted because a draft exists
+
+# singleton
+SINGLETON_NOT_NULLABLE = The singleton entity is not nullable

package/bin/serve.js

@@ -135,7 +135,7 @@ module.exports = exports = Object.assign ( serve, {
 `})
 
 
-const cds = require('../lib'), { exists, isfile, local, path, _redacted } = cds.utils
+const cds = require('../lib'), { exists, isfile, local, redacted, path } = cds.utils
 const COLORS = process.stdout.isTTY && !process.env.NO_COLOR || process.env.FORCE_COLOR
 
 /* eslint-disable no-console */
@@ -287,7 +287,7 @@ function _prepare_logging () { // NOSONAR
 
   // print information about each connected service
   cds.on ('connect', ({name,kind,options:{use,credentials,impl}})=>{
-    LOG.info (`connect to ${name} > ${use||kind||impl}`, credentials ? _redacted(credentials) : '')
+    LOG.info (`connect to ${name} > ${use||kind||impl}`, credentials ? redacted(credentials) : '')
   })
 
   // print information about each provided service

package/lib/compile/cdsc.js

@@ -61,7 +61,7 @@ const _options = {for: Object.assign (_options4, {
     })
   },
 
-  sql (_o, _env, _conf = cds.requires.db || cds.requires.kinds.sql) {
+  sql (_o, _env, _conf = cds.requires.db) {
     // REVISIT: compiler requires to only provide assertIntegrityType if defined
     if (_o?._4sql) return _o
     const o = _options4 ({ ..._env||cds.env.sql, ..._o, _4sql: true }, {
@@ -73,12 +73,17 @@ const _options = {for: Object.assign (_options4, {
     })
 
     if (!o.sqlDialect) {
-      let dialect = _conf.dialect || _conf.kind
+      let conf = _conf || cds.requires.kinds.sql
+      let dialect = conf.dialect || conf.kind
       if (dialect) o.sqlDialect = dialect
     }
 
-    const legacy = '@sap/cds/libx/_runtime/' // includes legacy sqlite and hana
-    if (_conf.impl.includes(legacy)) {
+    const _using_legacy_db = (()=>{
+      if (_conf?.impl) return _conf.impl.includes('@sap/cds/libx/_runtime/')
+      if (cds.requires.kinds.sqlite.impl === '@cap-js/sqlite') return false
+      else try { return require('sqlite3', { paths:[cds.root] }) } catch {/* ignore */}
+    })()
+    if (_using_legacy_db) {
       o.betterSqliteSessionVariables = false
       o.fewerLocalizedViews = false
     }

package/lib/compile/to/srvinfo.js

@@ -46,15 +46,15 @@ module.exports = (model, options={}) => {
     // make a fake runtime object for the service, adding a `definition` property
     if (!service.definition)  Object.defineProperty(service, 'definition', { value: service, enumerable: false })
     const endpoints = cds.service.protocols.endpoints4(service).map?.(e => Object.assign({}, e, { path: _url4(e.path) }))
-    if (!endpoints || !endpoints.length) return
-    
     return {
       name: service.name,
-      urlPath: endpoints[0].path, // legacy
       destination: 'srv-api', // the name to register in xs-app.json
-      endpoints,
       runtime: 'Node.js',
       location: service.$location,
+      ...endpoints?.[0] && {
+        urlPath: endpoints[0].path, // legacy
+        endpoints
+      }
     }
   }
 

package/lib/core/entities.js

@@ -54,6 +54,7 @@ class Association extends type {
   set foreignKeys(k) { this.set('foreignKeys', k) }
   get foreignKeys() {
     const keys = this.keys; if (!keys) return this.foreignKeys = undefined
+    if (!Object.keys(keys).length) return this.foreignKeys = null
     const foreignKeys = new LinkedDefinitions
     for (const k of keys) {
       const el = k.ref.reduce((target,n)=> target.elements[n], this._target)

package/lib/core/types.js

@@ -28,7 +28,7 @@ Object.assign (protos, types.hana = {
 	'cds.hana.CHAR': new classes.String,
 	'cds.hana.CLOB': new classes.LargeString,
 	'cds.hana.NCHAR': new classes.String,
-	'cds.hana.BINARY': new classes.String,
+	'cds.hana.BINARY': new classes.Binary,
 	'cds.hana.ST_POINT': new classes.type,
 	'cds.hana.ST_GEOMETRY': new classes.type,
 })

package/lib/dbs/cds-deploy.js

@@ -410,4 +410,7 @@ if (!module.parent) (async function CLI () {
   } finally {
     await db?.disconnect?.()
   }
-})().catch(console.error)
+})().catch((e) => {
+  console.error(e)
+  process.exitCode = 1
+})

package/lib/env/defaults.js

@@ -18,6 +18,7 @@ const defaults = module.exports = {
       pre_compile_edmxs: false,
       odata_new_adapter: false,
       odata_new_parser: false,
+      base64_binaries: true
     },
     requires: {
       kinds: {
@@ -133,12 +134,9 @@ const defaults = module.exports = {
 
   i18n: {
     file: 'i18n', // file basename w/o extension
-    folders: ['_i18n', 'i18n', 'assets/i18n'],
-    for_sqlite: ['de', 'fr'],
-    for_sql: ['de', 'fr'],
-    languages: 'all', // or array.  'all': whatever language files are found next to models
+    folders: [ '_i18n', 'i18n' ],
+    languages: 'all', // or ['en','de',...]
     default_language: 'en',
-    fallback_bundle: '',
     preserved_locales: [
       // IMPORTANT: Never, never modify this list, as that would break existing projects !!!!
       // Projects can and have to override if they want something different.
@@ -150,7 +148,10 @@ const defaults = module.exports = {
       'zh_CN',
       'zh_HK',
       'zh_TW'
-    ]
+    ],
+    /** @deprecated */ for_sqlite: ['de', 'fr'],
+    /** @deprecated */ for_sql: ['de', 'fr'],
+    /** @deprecated */ fallback_bundle: '',
   },
 
   odata: {

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

@@ -125,7 +125,7 @@ module.exports = {
               type: 'string'
             },
             folders: {
-              description: 'Define the list of folders containing language files. Defaults are \'_i18n/\', \'i18n/\', and \'assets/i18n/\'. First valid entry wins.',
+              description: 'Define the list of folders containing language files. Defaults are \'_i18n/\', and \'i18n/\'. First valid entry wins.',
               default: [],
               $ref: '#/$defs/foldersStringArray'
             }
@@ -134,7 +134,7 @@ module.exports = {
         requires: {
           type: 'object',
           default: {},
-          description: 'List CDS dependencies to databases and services within the requires section.',
+          description: 'Define all required services.',
           additionalProperties: true,
           properties: {
             auth: {
@@ -198,10 +198,10 @@ module.exports = {
               oneOf: [
                 {
                   type: 'string',
-                  description: 'Use standard database-specific settings via shortcut.',
+                  description: 'Settings for the primary database (shortcut).',
                   anyOf: [
                     {
-                      $ref: '#/$defs/databaseType'
+                      $ref: '#/$defs/databaseKind'
                     },
                     {
                       minLength: 1
@@ -210,7 +210,7 @@ module.exports = {
                 },
                 {
                   type: 'object',
-                  description: 'Use custom database-specific settings.',
+                  description: 'Settings for the primary database.',
                   default: {},
                   additionalProperties: true,
                   patternProperties: {
@@ -221,10 +221,10 @@ module.exports = {
                   properties: {
                     kind: {
                       type: 'string',
-                      description: 'Define the kind of dependency.',
+                      description: 'Service kind',
                       anyOf: [
                         {
-                          $ref: '#/$defs/databaseType'
+                          $ref: '#/$defs/databaseKind'
                         },
                         {
                           minLength: 1
@@ -327,11 +327,74 @@ module.exports = {
               type: 'boolean',
               description: 'Shortcut to enable feature toggles.'
             },
+            messaging: {
+              oneOf: [
+                {
+                  type: 'string',
+                  description: 'Settings for the primary messaging service (shortcut).',
+                  anyOf: [
+                    {
+                      $ref: '#/$defs/messagingKind'
+                    },
+                    {
+                      minLength: 1
+                    }
+                  ]
+                },
+                {
+                  type: 'object',
+                  description: 'Settings for the primary messaging service.',
+                  default: {},
+                  additionalProperties: true,
+                  patternProperties: {
+                    '\\[.+\\]': {
+                      $ref: '#/$defs/cdsRoot/properties/requires/properties/messaging'
+                    }
+                  },
+                  properties: {
+                    kind: {
+                      type: 'string',
+                      description: 'Service kind',
+                      anyOf: [
+                        {
+                          $ref: '#/$defs/messagingKind'
+                        },
+                        {
+                          minLength: 1
+                        }
+                      ]
+                    },
+                    credentials: {
+                      type: 'object',
+                      description: 'You can explicitly configure credentials, but this is overruled by VCAP_SERVICES if a matching entry is found therein.',
+                      additionalProperties: true,
+                      properties: {
+                        database: {
+                          type: 'string',
+                          format: 'uri-reference'
+                        }
+                      }
+                    },
+                    vcap: {
+                      type: 'object',
+                      description: 'Optional: Used to select an entry in VCAP_SERVICES.',
+                      additionalProperties: true,
+                      properties: {
+                        name: {
+                          type: 'string',
+                          minLength: 1
+                        }
+                      }
+                    }
+                  }
+                }
+              ]
+            },
             'cds.xt.ModelProviderService': {
               description: 'Configure if/how the ModelProviderService serves model variants that may include tenant-specific extensions and/or feature-toggled aspects.',
               oneOf: [
                 {
-                  $ref: '#/$defs/serviceActivation'
+                  type: 'boolean'
                 },
                 {
                   $ref: '#/$defs/servicePresetSidecar'
@@ -359,7 +422,7 @@ module.exports = {
               description: 'Configure if/how the ExtensibilityService allows to add and activate tenant-specific extensions at runtime.',
               oneOf: [
                 {
-                  $ref: '#/$defs/serviceActivation'
+                  type: 'boolean'
                 },
                 {
                   $ref: '#/$defs/extensionRestrictions'
@@ -370,7 +433,7 @@ module.exports = {
               description: 'Configure if/how the DeploymentService handles subscribe, unsubscribe, and upgrade events for single tenants and single apps/micro-services.',
               oneOf: [
                 {
-                  $ref: '#/$defs/serviceActivation'
+                  type: 'boolean'
                 },
                 {
                   $ref: '#/$defs/servicePresetSidecar'
@@ -419,10 +482,10 @@ module.exports = {
               ]
             },
             'cds.xt.SaasProvisioningService': {
-              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.',
+              description: 'Out-of-the-box integration with SAP BTP SaaS Provisioning service.',
               oneOf: [
                 {
-                  $ref: '#/$defs/serviceActivation'
+                  type: 'boolean'
                 },
                 {
                   type: 'object',
@@ -452,6 +515,24 @@ module.exports = {
                   }
                 }
               ]
+            },
+            'cds.xt.SmsProvisioningService': {
+              description: 'Out-of-the-box integration with SAP BTP Subscription Management service.',
+              oneOf: [
+                {
+                  type: 'boolean'
+                },
+                {
+                  type: 'object',
+                  description: 'SmsProvisioningService configuration options.',
+                  additionalProperties: true,
+                  patternProperties: {
+                    '\\[.+\\]': {
+                      $ref: '#/$defs/cdsRoot/properties/requires/properties/cds.xt.SmsProvisioningService'
+                    }
+                  }
+                }
+              ]
             }
           },
           patternProperties: {
@@ -474,7 +555,7 @@ module.exports = {
                       $ref: '#/$defs/authType'
                     },
                     {
-                      $ref: '#/$defs/databaseType'
+                      $ref: '#/$defs/databaseKind'
                     },
                     {
                       $ref: '#/$defs/serviceType'
@@ -491,13 +572,13 @@ module.exports = {
                   properties: {
                     kind: {
                       type: 'string',
-                      description: 'Kind of dependency.',
+                      description: 'Service kind',
                       anyOf: [
                         {
                           $ref: '#/$defs/authType'
                         },
                         {
-                          $ref: '#/$defs/databaseType'
+                          $ref: '#/$defs/databaseKind'
                         },
                         {
                           $ref: '#/$defs/serviceType'
@@ -508,7 +589,7 @@ module.exports = {
                       ]
                     },
                     model: {
-                      description: 'Assigned model. Interpreted like Node.js \'requires\' logic.',
+                      description: 'A relative path to the model definition.',
                       $ref: '#/$defs/foldersStringArray'
                     }
                   }
@@ -655,7 +736,7 @@ module.exports = {
       }
     },
 
-    databaseType: {
+    databaseKind: {
       default: 'sqlite',
       enum: [
         'hana',
@@ -669,6 +750,28 @@ module.exports = {
       ]
     },
 
+    messagingKind: {
+      default: 'local-messaging',
+      enum: [
+        'file-based-messaging',
+        'enterprise-messaging',
+        'enterprise-messaging-shared',
+        'event-broker',
+        'redis-messaging',
+        'local-messaging',
+        'composite-messaging'
+      ],
+      enumDescriptions: [
+        'File-based messaging',
+        'SAP Event Mesh',
+        'SAP Event Mesh (shared)',
+        'SAP Cloud Application Event Hub',
+        'Redis messaging',
+        'Local messaging',
+        'Composite messaging'
+      ]
+    },
+
     foldersStringArray: {
       oneOf: [
         {
@@ -687,8 +790,7 @@ module.exports = {
     },
 
     serviceActivation: {
-      type: 'boolean',
-      description: 'De-/Activate this service.'
+      type: 'boolean'
     },
 
     servicePresetSidecar: {
@@ -702,7 +804,7 @@ module.exports = {
 
     extensionRestrictions: {
       type: 'object',
-      description: 'Extension restrictions',
+      description: 'Extensibility settings',
       additionalProperties: false,
       properties: {
         'element-prefix': {
@@ -731,7 +833,7 @@ module.exports = {
             properties: {
               for: {
                 type: 'array',
-                description: 'Restriction applies to these namespaces.',
+                description: 'Restriction applies to these services.',
                 uniqueItems: true,
                 items: {
                   type: 'string'
@@ -766,8 +868,16 @@ module.exports = {
               },
               'new-entities': {
                 type: 'integer',
-                description: 'Number of entities to be added at most',
+                description: 'Number of entities to be added at most.',
                 minimum: 1
+              },
+              'annotations': {
+                type: 'array',
+                description: 'Annotations that are allowed for entities, services and fields.',
+                uniqueItems: true,
+                items: {
+                  type: 'string'
+                }
               }
             }
           }