@sap/cds-dk 10.0.7 → 10.1.0

package/node_modules/@sap/cds-compiler/doc/IncompatibleChanges_v7.md

@@ -1,7 +1,7 @@
 # Incompatible Changes in CDS Compiler Version 7
 
 This document lists (potentially) incompatible changes
-which came with Compiler Version 7.
+which came with Compiler Version 7, including the fixes of Version 7.0.2.
 
 <!-- toc: start -->
 
@@ -17,15 +17,16 @@ which came with Compiler Version 7.
    1. [name-deprecated-$self](#name-deprecated-self)
    2. [String representation for expression-like annotation values](#string-representation-for-expression-like-annotation-values)
    3. [Default for structures](#default-for-structures)
-   4. [Default for arrays)](#default-for-arrays-ic-v7-33)
+   4. [Default for arrays](#default-for-arrays)
    5. [Extend builtin with type properties](#extend-builtin-with-type-properties)
-   6. [Key propagation](#key-propagation)
-   7. [Annotate with invalid target](#annotate-with-invalid-target)
-   8. [Duplicate element via extend with aspect](#duplicate-element-via-extend-with-aspect)
-   9. [Extend ... with definitions](#extend--with-definitions)
-   10. [Propagate value null](#propagate-value-null)
-   11. [Expression as UP TO value](#expression-as-up-to-value)
-   12. [Associations defined via backlink associations](#associations-defined-via-backlink-associations)
+   6. [Key propagation in projections](#key-propagation-in-projections)
+   7. [Key propagation for types](#key-propagation-for-types)
+   8. [Annotate with invalid target](#annotate-with-invalid-target)
+   9. [Duplicate element via extend with aspect](#duplicate-element-via-extend-with-aspect)
+   10. [Extend ... with definitions](#extend--with-definitions)
+   11. [Propagate value null](#propagate-value-null)
+   12. [Expression as UP TO value](#expression-as-up-to-value)
+   13. [Associations defined via backlink associations](#associations-defined-via-backlink-associations)
 6. [Changes in OData/EDM](#changes-in-odataedm)
    1. [Vocabulary change for Common.SideEffectsType](#vocabulary-change-for-commonsideeffectstype)
 7. [Changes in to.sql()](#changes-in-tosql)
@@ -53,7 +54,7 @@ Such changes always have a reason, and we don't introduce them "just for the sak
 | Default for structures              | 2   | low      |
 | Default for arrays                  | 2   | low      |
 | Extend builtin with type properties | 2   | very low |
-| Key propagation                     | 3   | low      |
+| Key propagation                     | 3+4 | medium   |
 | Sec-Annotate with invalid target    | 2   | high     |
 | Duplicate elem by extend w/ aspect  | 2   | low      |
 | Extend ... with definitions         | 4   | zero     |
@@ -136,7 +137,7 @@ It was ...
 
 The error could be downgraded with
 ```sh
-cdsc b51.<file> --warn syntax-unsupported-masked --deprecated downgradableErrors
+cdsc <file> --warn syntax-unsupported-masked --deprecated downgradableErrors
 ```
 
 In cds-compiler v7:  
@@ -195,7 +196,7 @@ entity E {
   a : Integer;
   b : Integer;
 }
-entity P as projection on E { a as x, b as y};
+entity P as projection on E { a as x, b as y };
 ```
 Resulting CSN:
 ```jsonc
@@ -334,9 +335,9 @@ the compiler throws configurable errors for these situations.
 Planned to make non-configurable in v8.
 
 
-### Key propagation
+### Key propagation in projections
 
-Before cds-compiler v7:  
+Before cds-compiler v7 or when the v7 option `v6KeyPropagation` is set with truthy value:  
 A view or projection inherits the key of the underlying base entity, if ...
 * no explicit key is set in the query
 * all key elements of the primary base entity are selected
@@ -346,25 +347,51 @@ A view or projection inherits the key of the underlying base entity, if ...
 (key = the entirety of the key elements)
 
 Essentially this means: we propagate the key only in situations
-where we are (almost) sure that the result is a valid key. "Almost", because
+where we are (almost) sure that the result is a valid key. This was the intention, but
 a path with a to-many association isn't recognized inside an expression.
 
 These rules are unnecessarily complex.
 
-In cds-compiler v7:  
+In cds-compiler v7 or when the v6.9 option `v7KeyPropagation` is set with truthy value:  
 Simplify rules: a view or projection inherits the key of the
 underlying base entity, if ...
 * no explicit key is set in the query
 * all key elements of the primary base entity and all key elements of joined
   entities are selected
 
-Note: second rule is very strict, as oftentimes not all key elements of the target need
+Note: second rule is very strict, as often not all key elements of the target need
 to be selected because they are tied to a key element of the source via the ON condition.
 In these situations no key is propagated and we basically have the same situation as before v7.
 
 This change means:
-we would propagate the key also in many situations where we are not sure the
-result is a valid key.
+we would propagate the key also in situations where we are not sure the
+result is a valid key, e.g. with a union query.
+
+
+### Key propagation for types
+
+An element of an entity can be key with implications for the compiler-calculated foreign keys
+of an association, SQL constraints in the OData protocol, ….
+
+Inconsistencies arise when a _sub element_ of an entity is declared to be a key,
+especially if structure flattening comes into play.
+Thus, the compiler issues a warning for `key` on a sub element, and for `key` inside a structured type.
+
+Before cds-compiler v7 or when the v7 option `v6KeyPropagation` is set with truthy value:  
+
+* an element in a structure type doesn't inherit the key of the underlying base element
+  if the structure type is a derived type (`type D: T`) or is defined via `projection on`,
+* an element in a structure type _does inherit_ the key of the underlying base element
+  if the structure type includes a structure.
+
+In cds-compiler v7 or when the v6.9 option `v7KeyPropagation` is set with truthy value:  
+
+* an element in a structure type _never inherits_ the key of an underlying base element.
+
+This way, key sub elements (with their inconsistencies) only arise
+with dubious user-provided element definitions, never for compiler-inferred elements.
+
+Users who use a type basically as include should consider using an aspect instead.
 
 
 ### Annotate with invalid target

package/node_modules/@sap/cds-compiler/lib/api/main.js

@@ -522,6 +522,16 @@ function sqlMigration( csn, options, messageFunctions, beforeImage ) {
     }, {}),
   };
 
+  // Sort before the loop below sets `@cds.persistence.skip=true`
+  // on unchanged artifacts as a `toSqlDdl` suppression hint; `sortViews`
+  // does not process non-persisted entities
+  const sortOrder = sortViews({ sql: {}, csn: afterImage });
+
+  const dependentsDict = {};
+  sortOrder.forEach(({ name, dependents }) => {
+    dependentsDict[name] = dependents;
+  });
+
   const markedSkipByUs = {};
   const cleanup = [];
   // Delete artifacts that are already present in csn
@@ -548,13 +558,6 @@ function sqlMigration( csn, options, messageFunctions, beforeImage ) {
     });
   }
 
-  const sortOrder = sortViews({ sql: {}, csn: afterImage });
-
-  const dependentsDict = {};
-  sortOrder.forEach(({ name, dependents }) => {
-    dependentsDict[name] = dependents;
-  });
-
   const stack = Object.keys(drops.creates);
   while (stack.length > 0) {
     const name = stack.pop();

package/node_modules/@sap/cds-compiler/lib/api/options.js

@@ -37,12 +37,15 @@ const publicOptionsNewAPI = [
   'magicVars', // deprecated, not removed in v3 as we have specific error messages for it
   'variableReplacements',
   'pre2134ReferentialConstraintNames',
+  'draftAdminDataConstraints',
   'betterSqliteSessionVariables',
   'decimal_affinity',
   'withHanaAssociations',
   'standardDatabaseFunctions',
   'booleanEquality',
   'dollarNowAsTimestamp',
+  'vectorEmbeddingDefaultModel',
+  'vectorEmbeddingHanaDefaultRemoteSource',
   // ODATA
   'odataOpenapiHints',
   'edm4OpenAPI',
@@ -68,6 +71,7 @@ const publicOptionsNewAPI = [
   // for.effective
   'resolveSimpleTypes',
   'resolveProjections',
+  'stringifyAnnoXpr',
   'remapOdataAnnotations',
   'keepLocalized',
   'effectiveServiceName',
@@ -190,6 +194,7 @@ module.exports = {
         booleanEquality: true,
         dollarNowAsTimestamp: false,
         decimal_affinity: 'real',
+        draftAdminDataConstraints: false,
       };
       const processed = translateOptions(options, defaultOptions, hardOptions, {}, [ 'sql-dialect-and-naming' ], 'to.sql');
 
@@ -204,6 +209,7 @@ module.exports = {
         withHanaAssociations: false,
         booleanEquality: true,
         dollarNowAsTimestamp: false,
+        draftAdminDataConstraints: false,
       };
       return translateOptions(options, defaultOptions, hardOptions, { sqlDialect: generateStringValidator([ 'hana' ]) }, undefined, 'to.hdi');
     },
@@ -241,7 +247,7 @@ module.exports = {
     effective: (options) => {
       const hardOptions = { addCdsPersistenceName: false, deriveAnalyticalAnnotations: false };
       const defaultOptions = {
-        sqlMapping: 'plain', resolveSimpleTypes: true, resolveProjections: true, remapOdataAnnotations: false, keepLocalized: false,
+        sqlMapping: 'plain', resolveSimpleTypes: true, resolveProjections: true, stringifyAnnoXpr: false, remapOdataAnnotations: false, keepLocalized: false,
       };
       const processed = translateOptions(options, defaultOptions, hardOptions, null, [ 'sql-dialect-and-naming', 'effectiveServiceName-and-type-resolution' ], 'for.effective');
 
@@ -251,7 +257,7 @@ module.exports = {
       const hardOptions = {
         sqlMapping: 'plain', resolveSimpleTypes: true, resolveProjections: true, keepLocalized: false, addCdsPersistenceName: true,
       };
-      const defaultOptions = { remapOdataAnnotations: true, deriveAnalyticalAnnotations: false };
+      const defaultOptions = { stringifyAnnoXpr: false, remapOdataAnnotations: true, deriveAnalyticalAnnotations: false };
       const processed = translateOptions(options, defaultOptions, hardOptions, null, [ 'sql-dialect-and-naming' ], 'for.effective');
 
       return Object.assign({}, processed);

package/node_modules/@sap/cds-compiler/lib/base/csnRefs.js

@@ -244,6 +244,7 @@ const referenceSemantics = {
   expand: { lexical: justDollar, dynamic: 'expand' },   // ...using baseEnv
   inline: { lexical: justDollar, dynamic: 'inline' },   // ...using baseEnv
   ref_where: { lexical: justDollar, dynamic: 'ref-target' }, // ...using baseEnv
+  from_where: { lexical: justDollar, dynamic: 'ref-target' }, // ...using baseEnv
   on: { lexical: justDollar, dynamic: 'query' }, // assoc defs, redirected to
   // there are also 'on_join' and 'on_mixin' with default semantics
   $calc: { lexical: justDollar, dynamic: 'query' }, // calculation for draft
@@ -770,7 +771,9 @@ function csnRefs( csn, universalReady ) {
       if (head.charAt(0) === '$') {
         if (head !== '$self' && head !== '$projection')
           return { scope: '$magic' };
-        const self = qcache && qcache.$queryNumber > 1 ? qcache._select : main;
+        // $self in filter of from -> TODO v8: disallow in core compiler?
+        const fcache = (refCtx === 'from_where' && qcache) ? qcache.$next : qcache;
+        const self = fcache && fcache.$queryNumber > 1 ? fcache._select : main;
         return resolvePath( path, self, null, '$self' );
       }
     }
@@ -1131,7 +1134,7 @@ function analyseCsnPath( csnPath, csn, resolve ) {
     else if (prop === 'where' && refCtx === 'ref') {
       if (resolve)
         baseEnv = resolve.ref_where( obj, baseRef, baseCtx, main, query, parent, baseEnv );
-      refCtx = 'ref_where';
+      refCtx = (baseCtx === 'from') ? 'from_where' : 'ref_where';
     }
     else if (prop === 'expand' || prop === 'inline') {
       if (obj.ref) {

package/node_modules/@sap/cds-compiler/lib/base/message-registry.js

@@ -154,6 +154,7 @@ const centralMessages = {
 
   'extend-repeated-intralayer': { severity: 'Warning' },
   'extend-unrelated-layer':     { severity: 'Info' },
+  'ext-unstable-order':         { severity: 'Warning' },
 
   'ext-duplicate-extend-type': { severity: 'Error' },
   'ext-duplicate-extend-type-unrelated-layer': { severity: 'Error', configurableFor: true },
@@ -232,6 +233,7 @@ const centralMessages = {
   'def-missing-virtual': { severity: 'Error', configurableFor: true },
   'def-expected-structured': { severity: 'Error', configurableFor: true },
   'def-unsupported-calc-elem': { severity: 'Error', configurableFor: true },
+  'def-unsupported-assoc': { severity: 'Warning' },
 
   'def-invalid-key-cardinality': { severity: 'Error' },
 
@@ -550,6 +552,7 @@ const centralMessageTexts = {
   'syntax-invalid-anno-struct': {
     std: 'Objects with properties $(PROP) and $(SIBLINGPROP) are reserved for expressions and can\'t be used as structures',
     xpr: 'Objects with $(PROP) as only property are reserved for expressions and can\'t be used as structures',
+    '...': 'Objects with $(PROP) as only property are reserved for appending arrays and can\'t be used as structures',
     '#': 'Objects with a property $(PROP) are reserved for enum values and can\'t be used as structures',
     ref: 'The value of property $(PROP) in structures must be a non-empty string',
   },
@@ -584,6 +587,7 @@ const centralMessageTexts = {
   },
   'syntax-unexpected-sql-clause': {
     std: 'Unexpected $(KEYWORD) clause for path filter',
+    one: '$(CODE) is supported only in standalone queries, not in CDS models',
   },
 
   // Syntax messages, CSN parser - default: Error  ------------------------------

package/node_modules/@sap/cds-compiler/lib/base/optionProcessor.js

@@ -303,6 +303,7 @@ optionProcessor.command('Q, toSql')
   .option('    --assert-integrity-type <type>', { valid: [ 'RT', 'DB' ], ignoreCase: true })
   .option('    --constraints-in-create-table')
   .option('    --pre2134ReferentialConstraintNames')
+  .option('    --draft-admin-data-constraints')
   .option('    --disable-hana-comments')
   .option('    --generated-by-comment')
   .option('    --better-sqlite-session-variables <bool>')
@@ -359,6 +360,9 @@ optionProcessor.command('Q, toSql')
                                     part of the "CREATE TABLE" statements rather than as separate
                                     "ALTER TABLE ADD CONSTRAINT" statements
    --pre2134ReferentialConstraintNames   Do not prefix the constraint identifier with "c__"
+   --draft-admin-data-constraints   Generate an "ON DELETE CASCADE" referential constraint on the
+                                    DraftAdministrativeData_DraftUUID foreign key of draft shadow
+                                    tables. Independent of assertIntegrity / assertIntegrityType.
    --disable-hana-comments    Disable rendering of doc comments as SAP HANA comments.
    --generated-by-comment     Enable rendering of the initial SQL comment for HDI-based artifacts
    --better-sqlite-session-variables <bool>
@@ -540,6 +544,7 @@ optionProcessor.command('forEffective')
   .option('-h, --help')
   .option('--resolve-simple-types <val>', { valid: [ 'true', 'false' ] } )
   .option('--resolve-projections <val>', { valid: [ 'true', 'false' ] } )
+  .option('--stringify-anno-xpr <val>', { valid: [ 'true', 'false' ] } )
   .option('--remap-odata-annotations <val>', { valid: [ 'true', 'false' ] } )
   .option('--keep-localized <val>', { valid: [ 'true', 'false' ] } )
   .option('--effective-service-name <name>')
@@ -559,6 +564,9 @@ optionProcessor.command('forEffective')
        --resolve-projections <val>       Resolve projections:
                                           true: (default) transform projections into ordinary views with SELECT
                                           false:          leave them as real projections
+       --stringify-anno-xpr <val>        Stringify annotation expressions:
+                                          true:           convert annotation expression nodes to CDL-like strings
+                                          false:(default) keep annotation expressions as structured CSN objects
        --remap-odata-annotations <val>   Remap OData annotations to ABAP annotations:
                                           true:           remap annotations
                                           false:(default) leave them as is
@@ -570,6 +578,7 @@ optionProcessor.command('forEffective')
 
 optionProcessor.command('forSeal')
   .option('-h, --help')
+  .option('--stringify-anno-xpr <val>', { valid: [ 'true', 'false' ] } )
   .option('--remap-odata-annotations <val>', { valid: [ 'true', 'false' ] } )
   .option('--derive-analytical-annotations <val>', { valid: [ 'true', 'false' ] })
   .positionalArgument('<files...>')
@@ -580,6 +589,9 @@ optionProcessor.command('forSeal')
 
   Options
    -h, --help                            Show this help text
+       --stringify-anno-xpr <val>        Stringify annotation expressions:
+                                          true:           convert annotation expression nodes to CDL-like strings
+                                          false:(default) keep annotation expressions as structured CSN objects
        --remap-odata-annotations <val>   Remap OData annotations to ABAP annotations:
                                           true: (default)   remap annotations
                                           false:            leave them as is

package/node_modules/@sap/cds-compiler/lib/checks/enricher.js

@@ -34,6 +34,7 @@ function enrichCsn( csn, options ) {
     target,
     includes: simpleRef,
     columns,
+    $backlink: () => undefined,
     '@': annotation,
   };
   let cleanupCallbacks = [];

package/node_modules/@sap/cds-compiler/lib/compiler/assert-consistency.js

@@ -284,15 +284,15 @@ function assertConsistency( model, stage ) {
         optional: [
           'quantifier', 'orderBy', 'limit', 'name', '$parens', 'kind',
           '_origin', '$contains', // TODO tmp, see TODO in getOriginRaw()
-          '_parent', '_main', '_leadingQuery', '_effectiveType', '$effectiveSeqNo', // in FROM
+          '_parent', '_main', '_effectiveType', '$effectiveSeqNo', // in FROM
           '$expand', '_$next', // parsing error: tableTerm with UNION on rhs.
         ],
       },
       select: {                   // sub query
         requires: [ 'op', 'location', 'from' ],
         optional: [
-          'name', '$parens', 'quantifier', 'mixin', 'excludingDict', 'columns', 'elements', '_deps',
-          '$calcDepElement',
+          'name', '$parens', 'quantifier', 'one', 'mixin', 'excludingDict', 'columns', 'elements',
+          '_deps', '$calcDepElement',
           'where', 'groupBy', 'having', 'orderBy', '$orderBy', 'limit', '$limit',
           '_origin', '_block', '$contains',
           '_projections', '_complexProjections',
@@ -311,7 +311,7 @@ function assertConsistency( model, stage ) {
           'on', '$parens', 'cardinality',
           'kind', 'name', '_block', '_parent', '_main', '_user',
           '$tableAliases', '_combined', '_joinParent', '$joinArgsIndex',
-          '_leadingQuery', '_$next', '_deps', '$expand',
+          '_$next', '_deps', '$expand',
         ],
       },
       ref: {
@@ -453,6 +453,7 @@ function assertConsistency( model, stage ) {
         optional: [
           'scope', 'variant', '_artifact', '_originalArtifact',
           '$inferred', '$parens', 'sort', 'nulls', '$syntax',
+          '$extended', '_block', '_outer', // for where/having
         ],
       },
       none: { optional: () => true }, // parse error
@@ -479,6 +480,7 @@ function assertConsistency( model, stage ) {
           'sort', 'nulls',      // if used in GROUP BY
           // `elements` of type is not put into cast, many will be cds.LargeString
           ...typeProperties,    // for CAST
+          '$extended', '_block', '_outer', // for where/having
         ],
       },
       query: { requires: [ 'query', 'location' ], optional: [ 'stored', '$parens' ] },
@@ -570,6 +572,7 @@ function assertConsistency( model, stage ) {
     virtual: { kind: true, test: locationVal() },
     key: { kind: true, test: locationVal(), also: [ null, undefined ] },
     notNull: { kind: true, test: locationVal() },
+    one: { kind: true, test: locationVal() },
     includes: {
       kind: true,
       test: isArray(),
@@ -659,19 +662,17 @@ function assertConsistency( model, stage ) {
         '_effectiveType', '$effectiveSeqNo', '$parens',
         '_deps', '$calcDepElement', '$expand', '$contains',
         // query specific
-        'where', 'columns', 'mixin', 'quantifier', 'offset',
+        'where', 'columns', 'mixin', 'quantifier', 'one', 'offset',
         'orderBy', '$orderBy', 'groupBy', 'excludingDict', 'having',
         '$limit', 'limit', '_status', '_origin',
         // via casts
         'enum',
       ],
     },
-    _leadingQuery: { kind: true, test: TODO },
     $replacement: { kind: true, test: TODO }, // for smart * in queries
     _origin: { kind: true, test: TODO },
     _calcOrigin: { kind: true, test: TODO },
     _columnParent: { kind: [ 'element', undefined ], test: TODO }, // column or * (wildcard)
-    _from: { kind: true, test: TODO }, // TODO: not necessary anymore ?
     // array of $tableAlias (or includes) for explicit and implicit redirection:
     _redirected: { kind: true, test: TODO },
     // ...array of table aliases for targets from orig to new

package/node_modules/@sap/cds-compiler/lib/compiler/checks.js

@@ -857,9 +857,9 @@ function check( model ) {
                  { '#': 'struct-expr', elemref: xpr } );
         }
         else if (xpr._artifact.target !== undefined &&
-            (!lastStep.where || lastStep.where.args?.length === 0 || isStored)) {
-          // Allow using an association _with non-empty filter_, but only for on-read
-          // calculated elements.
+            (!lastStep.where || isStored)) {
+          // Allow using an association _with a (possibly empty) filter_, but only
+          // for on-read calculated elements.
           // TODO: Also allow bare unmanaged association references and remove beta.
           const variant = (isStored && lastStep.where && 'assoc-stored') ||
             (isComposition( model, xpr._artifact ) && 'expr-comp') ||