@sap/cds-compiler 6.9.2 → 7.0.1

package/lib/gen/Dictionary.json

@@ -1741,10 +1741,18 @@
     },
     "PersonalData.IsPotentiallySensitive": {
       "AppliesTo": [
-        "Property"
+        "Property",
+        "EntityType"
       ],
       "Type": "Core.Tag"
     },
+    "PersonalData.RelatedDataCategoryID": {
+      "AppliesTo": [
+        "Property",
+        "EntityType"
+      ],
+      "Type": "Collection(Edm.String)"
+    },
     "Repeatability.DeleteWithClientIDSupported": {
       "AppliesTo": [
         "EntityContainer"
@@ -3434,7 +3442,6 @@
       "$kind": "ComplexType",
       "Properties": {
         "Discretionary": "Edm.Boolean",
-        "EffectTypes": "Common.EffectType",
         "SourceEntities": "Collection(Edm.NavigationPropertyPath)",
         "SourceEvents": "Collection(Edm.String)",
         "SourceProperties": "Collection(Edm.PropertyPath)",
@@ -4235,6 +4242,10 @@
             "Type": "String",
             "Value": "ContractRelatedID"
           },
+          "DataCategoryID": {
+            "Type": "String",
+            "Value": "DataCategoryID"
+          },
           "DataControllerID": {
             "Type": "String",
             "Value": "DataControllerID"
@@ -4255,6 +4266,10 @@
             "Type": "String",
             "Value": "EndOfRetentionDate"
           },
+          "IsBlockedIndicator": {
+            "Type": "String",
+            "Value": "IsBlockedIndicator"
+          },
           "LegalEntityID": {
             "Type": "String",
             "Value": "LegalEntityID"

package/lib/json/from-csn.js

@@ -117,7 +117,7 @@
 
 const { dictAdd } = require('../compiler/dictionaries');
 const { quotedLiteralPatterns } = require('../compiler/builtins');
-const { exprProperties } = require('../base/builtins');
+const { exprProperties, primaryExprProperties } = require('../base/builtins');
 const { CompilerAssertion } = require('../base/error');
 const { Location } = require('../base/location');
 const { XsnSource } = require('../compiler/xsn-model');
@@ -499,9 +499,9 @@ const schema = compileSchema( {
   '#': {
     noPrefix: true,             // schema spec for '#', not for '#whatever'
     type: symbol,
-    // Note: We emit a warning if '#' is used in enums.  Because the compiler
-    // can generate CSN like this, we need to be able to parse it.
-    inKind: [ '$column', 'enum' ],
+    // Note: currently, we allow `#` in enum symbol definitions (→ also via CSN),
+    // the compiler just emits a warning ref-unexpected-enum
+    inKind: [ '$column', 'enum' ], // TODO v8: delete 'enum'
     xorException: 'val',        // see xorGroup :expr
     // see also extra handling for 'element' in extension, see definition()
   },
@@ -656,14 +656,14 @@ const schema = compileSchema( {
       '-expr': { // '-expr' and '-' must not exist top-level
         prop: '@‹anno›',
         type: object,
-        optional: [
-          '=', '#', 'xpr', 'ref', 'val', 'list',
-          'literal', 'func', 'args', 'param',
-          'cast',
+        optional: [             // exprProperties + '=' - 'SELECT' - 'SET'
+          '=',
+          'ref', 'xpr', 'list', 'val', '#', 'func',
+          'param', 'literal', 'args', 'cast',
         ],
         schema: {
           '=': {
-            type: renameTo( '$tokenTexts', stringOrBool ),
+            type: renameTo( '$tokenTexts', stringOrTrue ),
             xorGroups: null, // reset xorGroup; allow '=' for all :expr
           },
         },
@@ -678,10 +678,6 @@ const schema = compileSchema( {
     type: boolOrNull,
     inKind: [ 'element', '$column' ],
   },
-  masked: {
-    type: masked,
-    inKind: [ 'element' ],
-  },
   notNull: {
     type: boolOrNull,
     inKind: [ 'element', 'param', 'type' ], // TODO: $column  - or if so: in 'cast'?
@@ -703,6 +699,7 @@ const schema = compileSchema( {
   },
   includes: {
     arrayOf: stringRef,
+    type: includeRefs,
     inKind: [ 'entity', 'type', 'aspect', 'event', 'extend' ],
   },
   returns: {
@@ -768,6 +765,11 @@ const schema = compileSchema( {
   $generated: {
     type: string,
   },
+  $postponeIncludes: {          // elements to be added before applying include
+    arrayOf: natnum,
+    type: postponeIncludes,     // values stored with `includes` references
+    inKind: [ 'entity', 'type', 'aspect', 'event' ], // not 'extend' yet
+  },
   $: {
     noPrefix: false,            // just '$' is no CSN property
     type: ignore,
@@ -1132,6 +1134,44 @@ function returnsDefinition( def, spec, xsn, csn ) {
   return definition( def, spec, xsn, csn, '' );
 }
 
+function includeRefs( def, spec, xsn, csn ) {
+  const array = arrayOf( stringRef )( def, spec, xsn, csn );
+  if (array && Array.isArray( csn.$postponeIncludes )) {
+    array.forEach( ( ref, idx ) => {
+      const postpone = csn.$postponeIncludes[idx];
+      ref.$postponeInclude = (Number.isSafeInteger( postpone ) && postpone >= 0 )
+        ? postpone
+        : 0;
+    } );
+  }
+  return array;
+}
+
+function postponeIncludes( array, spec, xsn, csn ) {
+  if (!isArray( array ) || !array.length)
+    return;
+  let noElems = (!csn.elements || typeof csn.elements !== 'object')
+    ? 0
+    : Object.values( csn.elements )
+      .reduce( ( acc, elem ) => (elem?.kind === 'extend' ? acc : acc + 1), 0 );
+  let noIncludes = csn.includes?.length || 0;
+  const { prop } = spec;
+  for (const num of array) {
+    ++virtualLine;
+    if (--noIncludes === -1) {
+      error( 'syntax-invalid-special', location(true), { '#': 'long', prop } );
+    }
+    else if (noIncludes < -1) {
+      ignore( num );    // no further item check after syntax-invalid-special#long
+    }
+    else if (natnum( num, spec ) && (noElems -= num) < 0) {
+      error( 'syntax-invalid-special', location(true), { '#': 'sum', prop } );
+      noIncludes = -1;
+    }
+  }
+  ++virtualLine;
+}
+
 // Temporary function as long as the message below is not a hard error
 function elementsDict( def, spec, xsn ) {
   const elements = dictionaryOf( definition )( def, spec );
@@ -1319,11 +1359,11 @@ function string( val, spec ) {
   return ignore( val );
 }
 
-function stringOrBool( val, spec ) {
-  if (typeof val === 'string' && val || typeof val === 'boolean')
-    return val;
+function stringOrTrue( val, spec ) {
+  if (typeof val === 'string' && val || val === true)
+    return true;
   error( 'syntax-expecting-string', location(true),
-         { '#': spec.msgVariant || 'or-bool', prop: spec.msgProp } );
+         { '#': spec.msgVariant || 'or-true', prop: spec.msgProp } );
   return ignore( val );
 }
 
@@ -1331,8 +1371,7 @@ function stringVal( val, spec ) {
   if (typeof val === 'string' && val)
     //  XSN TODO: do not require literal
     return { val, literal: 'string', location: location() };
-  error( 'syntax-expecting-string', location(true), { prop: spec.msgProp },
-         'Expecting non-empty string for property $(PROP)' );
+  error( 'syntax-expecting-string', location(true), { prop: spec.msgProp } );
   return ignore( val );
 }
 
@@ -1451,33 +1490,11 @@ function annoValue( val, spec ) {
     }
     return retval;
   }
-  else if (typeof val['='] === 'string' || val['='] === true) {
-    // An object with `=` is an expression if and only if:
-    //  - there is exactly one property ('=')
-    //  - there is at least one other expression property (e.g. "xpr")
-    const valKeys = Object.keys( val );
-    if (valKeys.length === 1 && typeof val['='] === 'string') {
-      ++virtualLine;
-      const r = refSplit( val['='], '=' ); // i.e. no extra `variant` stuff
-      ++virtualLine;
-      return r;
-    }
-    else if (exprProperties.some( prop => val[prop] !== undefined )) {
-      const s = schema['@'].schema['-expr'];
-      const r = { location: location() };
-      Object.assign( r, object( val, s ) );
-      return r;
-    }
-    // fallthrough -> unchecked structure
-  }
-  if (typeof val['#'] === 'string') {
-    if (Object.keys( val ).length === 1) {
-      ++virtualLine;
-      const xsn = { location: location() };
-      symbol( val['#'], schema['#'], xsn );
-      ++virtualLine;
-      return xsn;
-    }
+  else if (primaryExprProperties.some( prop => val[prop] !== undefined )) {
+    const s = schema['@'].schema['-expr'];
+    const r = object( val, s );
+    r.$tokenTexts = true;       // property `=` might not be present
+    return r;
   }
   else if (val['...'] !== undefined && Object.keys( val ).length === 1) {
     // TODO: only if not nested - see error above
@@ -1495,8 +1512,11 @@ function annoValue( val, spec ) {
   }
   const r = { struct: Object.create(null), literal: 'struct', location: location() };
   ++virtualLine;
+  // Here, we do not really care whether the anno value is an unchecked reference
+  // or a structure with a `=` property → just check the `=` value to be a string
   for (const name of Object.keys( val )) {
-    r.struct[name] = annotation( val[name], schema['@'], null, val, name );
+    if (name !== '=' || string( val[name], schema['='] ))
+      r.struct[name] = annotation( val[name], schema['@'], null, val, name );
     ++virtualLine;
   }
   return r;
@@ -1770,11 +1790,6 @@ function duplicateExcluding( name, loc ) {
   error( 'syntax-duplicate-excluding', loc, { '#': 'csn', name, prop: 'excluding[]' } );
 }
 
-function masked( val, spec ) {
-  message( 'syntax-unsupported-masked', location(), { '#': 'csn', prop: 'masked' } );
-  return boolOrNull( val, spec );
-}
-
 function setOp( val, spec ) { // UNION, ...
   // similar to string(), but without literal
   return string( val, spec ) && { val, location: location() };

package/lib/json/to-csn.js

@@ -13,7 +13,7 @@
 
 const { locationString } = require('../base/messages');
 const { isBetaEnabled } = require('../base/specialOptions');
-const { pathName } = require('../compiler/utils');
+const { pathName, hasSpecialPathItemProp } = require('../compiler/utils');
 const { CompilerAssertion } = require('../base/error');
 
 const compilerVersion = require('../../package.json').version;
@@ -60,7 +60,6 @@ const transformers = {
   virtual: value,
   key: value,
   unique: value,
-  masked: value,
   params,
   // early expression / query properties -------------------------------------
   op: o => ((o.val !== 'SELECT' && o.val !== '$query') ? o.val : undefined),
@@ -96,7 +95,7 @@ const transformers = {
   foreignKeys,
   enum: enumDict,
   items,
-  includes: arrayOf( artifactRef ), // also entities
+  includes,
   // late expressions / query properties -------------------------------------
   mixin: insertOrderDict,       // only in queries with special handling
   columns,
@@ -275,7 +274,7 @@ function compactModel( model, options = model.options || {} ) {
                             (options.parseCdl ? 'parsed' : 'inferred');
   if (!options.testMode) {
     csn.meta = Object.assign( {}, model.meta, meta,
-                              { creator, compilerVersion, compilerCsnFlavor } );
+                              { creator, compilerCsnFlavor } );
     csn.$version = csnVersion;
   }
   else if (meta !== undefined) {
@@ -723,7 +722,7 @@ function definition( art, csn, _node, prop ) {
   }
 
   const c = standard( art );
-  // The XSN of actions in extensions do not contain a returns yet - TODO?
+  // The XSN of actions in extensions do not contain a returns yet - TODO: still?
   const elems = c.elements;
   if (elems && (prop === 'actions' || art.$syntax === 'returns')) {
     delete c.elements;
@@ -752,12 +751,12 @@ function queryOrigin( xsn ) {
 /**
  * Create $origin specification for `includes` of `art`.
  */
-function includesOrigin( includes, art ) {
-  const $origin = originRef( includes[0]._artifact );
-  if (includes.length === 1)
+function includesOrigin( refs, art ) {
+  const $origin = originRef( refs[0]._artifact );
+  if (refs.length === 1)
     return $origin;
   const result = { $origin };
-  for (const incl of includes.slice(1)) {
+  for (const incl of refs.slice(1)) {
     const aspect = incl._artifact;
     for (const prop in aspect) {
       if ((prop.charAt(0) === '@' || prop === 'doc') &&
@@ -1104,18 +1103,14 @@ function artifactRef( node, terse ) {
     : ref[0];
 }
 
+function includes( refs, csn ) {
+  csn.includes = refs.map( r => artifactRef( r, true ) );
+  if (gensrcFlavor && refs.some( r => r.$postponeInclude ))
+    csn.$postponeIncludes = refs.map( r => r.$postponeInclude ?? 0 );
+}
+
 function pathItem( item ) {
-  if (!item.args &&
-      !item.where &&
-      !item.groupBy &&
-      !item.having &&
-      !item.limit &&
-      !item.orderBy &&
-      !item.cardinality &&
-      !item.$extra &&
-      !item.$syntax)
-    return item.id;
-  return standard( item );
+  return (hasSpecialPathItemProp( item )) ? standard( item ) : item.id;
 }
 
 function args( node ) {
@@ -1140,9 +1135,7 @@ function anno( node ) {
   }
   if (node.$inferred && gensrcFlavor)
     return undefined;
-  if (node.$tokenTexts) // expressions in annotation values
-    return Object.assign({ '=': node.$tokenTexts }, expression( node ));
-  return value(node);
+  return annoValue( node );
 }
 
 function docComment( doc ) {
@@ -1152,6 +1145,16 @@ function docComment( doc ) {
   return undefined;
 }
 
+function annoValue( node ) {
+  if (!node.$tokenTexts)
+    return value( node );
+  const csn = expression( node ); // expressions in annotation values
+  return (!csn?.ref || gensrcFlavor || universalCsn ||
+          csn.cast || csn.param || csn.ref.some( id => typeof id !== 'string' ))
+    ? csn
+    : Object.assign({ '=': csn.ref.join( '.' ) }, csn );
+}
+
 function value( node ) {
   // "Short" value form, e.g. for annotation assignments
   if (!node)
@@ -1175,7 +1178,7 @@ function value( node ) {
   if (node.literal === 'enum')
     return enumValue( node );
   if (node.literal === 'array')
-    return node.val.map( value );
+    return node.val.map( annoValue );
   if (node.literal === 'token' && node.val === '...')
     return extra( { '...': !node.upTo || value( node.upTo ) } );
   if (node.literal !== 'struct')
@@ -1183,7 +1186,7 @@ function value( node ) {
     return node.name && !('val' in node) || node.val;
   const r = Object.create( dictionaryPrototype );
   for (const prop in node.struct)
-    r[prop] = value( node.struct[prop] );
+    r[prop] = annoValue( node.struct[prop] );
   return r;
 }
 

package/lib/language/textUtils.js

@@ -38,18 +38,6 @@ function isWhitespaceCharacterNoNewline( char ) {
   return whitespaceRegEx.test(char);
 }
 
-/**
- * Normalized CDL newlines to LF (\n).  CDL newlines also contain PS and other
- * characters, see cdlNewLineRegEx.
- *
- * @param {string} str
- * @return {string}
- */
-function normalizeNewLine( str ) {
-  // Note: cdlNewLineRegEx does not have `g`.
-  return str.replace(new RegExp(cdlNewLineRegEx, 'ug'), '\n');
-}
-
 /**
  * Normalizes the given number (as a string):
  *
@@ -69,6 +57,5 @@ module.exports = {
   isWhitespaceOrNewLineOnly,
   isWhitespaceCharacterNoNewline,
   cdlNewLineRegEx,
-  normalizeNewLine,
   normalizeNumberString,
 };

package/lib/main.d.ts

@@ -32,6 +32,18 @@ declare namespace compiler {
      * during compilation otherwise.
      */
     severities?: { [messageId: string]: MessageSeverity}
+    /**
+     * Downgrade the errors raised for `annotate` statements containing a
+     * security-relevant annotation (`@restrict`, `@requires`, `@ams`) but
+     * whose target does not exist.  Intended as a long-lived migration
+     * switch for projects that cannot fix all such statements at once.
+     *
+     * Explicit per-id entries in `severities` still take precedence over
+     * this option.
+     *
+     * @default false
+     */
+    noErrorForUnknownAnnotateTarget?: boolean
     /**
      * Dictionary of beta flag names.  This option allows fine-grained control
      * over which beta features should be enabled.
@@ -72,20 +84,6 @@ declare namespace compiler {
      * @default 'client'
      */
     csnFlavor?: string | 'client' | 'gensrc' | 'universal'
-    /**
-     * If set to false, backends will create localized convenience views for those views,
-     * that only have an association to a localized entity/view.  If set to true, views will
-     * only get a convenience view, if they themselves contain localized elements (i.e. either
-     * have simple projection on localized elements and CDL-casts to a localized element).
-     *
-     * If true, the OData backend will not set `$localized: true` markers for such cases.
-     *
-     * Does not work for backends to.hdi(), to.hdbcds() or to.sql() with `sqlDialect: 'hana'`,
-     * since in all those dialects, associations still exist in generated artifacts.
-     *
-     * @default true
-     */
-    fewerLocalizedViews?: boolean
   }
 
   /**
@@ -464,6 +462,26 @@ declare namespace compiler {
      * @default true (since v5)
      */
     betterSqliteSessionVariables?: boolean
+    /**
+     * @deprecated Use decimal_affinity instead. Will be removed in v7.
+     * Controls SQLite type affinity for decimal types (old boolean version).
+     * - true: Use REAL_DECIMAL types (real affinity)
+     * - false: Use DECIMAL types (numeric affinity)
+     *
+     * @since Before v3
+     */
+    sqliteRealAffinityForDecimal?: boolean
+    /**
+     * Controls SQLite type affinity for decimal types.
+     * - 'numeric': Use DECIMAL types (numeric affinity)
+     * - 'real': Use REAL_DECIMAL types (real affinity)
+     *
+     * Only affects SQLite dialect. Values are case-sensitive (must be lowercase).
+     *
+     * @default 'real'
+     * @since v6.9.0
+     */
+    decimal_affinity?: 'numeric' | 'real'
     /**
      * If set, operator `!=` will be treated as a boolean-logic operator,
      * instead of a three-valued operator, by rendering it as `IS DISTINCT FROM`
@@ -503,38 +521,6 @@ declare namespace compiler {
     dollarNowAsTimestamp?: boolean
   }
 
-  /**
-   * Options used by to.hdbcds()
-   */
-  export interface HdbcdsOptions extends Options {
-    /**
-     * The SQL naming mode decides how names are represented.
-     * Among others, this includes whether identifiers are quoted or not.
-     *
-     * - `plain`:
-     *   In this naming mode, dots are replaced by underscores.
-     *   Identifiers are always uppercased. If "smart-quoting" is used, they are also quoted
-         if they are also HDBCDS keywords.
-     * - `quoted`:
-     *   In this mode, all identifiers are quoted.  Dots are not replaced in table
-     *   and view names but are still replaced by underscores in element names.
-     *   Identifier casing is kept as specified in the source.
-     * - `hdbcds`:
-     *   This mode uses names that are compatible to SAP HANA CDS.
-     *   In this mode, all identifiers are quoted.  Dots are neither replaced in table
-     *   nor element names: Structured elements persist, contexts are nested.
-     *   Managed associations/compositions are left as-is.  No association-to-join-translation
-     *   is done.
-     *
-     * @default 'plain'
-     */
-    sqlMapping?: string | 'plain' | 'quoted' | 'hdbcds'
-    /**
-     * For to.hdbcds(), the SQL dialect is always set to 'hana'.
-     */
-    sqlDialect?: 'hana'
-  }
-
   /**
    * Options used by to.hdi() and to.hdi.migration()
    */
@@ -1306,21 +1292,10 @@ declare namespace compiler {
     }
 
     /**
-     * Renders the given CSN into HDBCDS artifacts.
-     *
-     * DEPRECATED! This backend is deprecated and will be removed with cds-compiler v7!
-     *
-     * @deprecated
-     * @returns A map of `{ '<artifactName>.hdbcds|hdbconstraint>': '<content>' }` entries.
+     * @deprecated to.hdbcds() has been removed. Use to.hdi() instead.
      */
-    function hdbcds(csn: CSN, options?: HdbcdsOptions): Record<string, string>;
+    function hdbcds(csn: CSN, options?: Options): Record<string, string>;
     namespace hdbcds {
-      /**
-       * Immutable list of SAP HANA CDS keywords, used for smart quoting in
-       * {@link to.hdbcds} with option `sqlMapping: 'plain'`.
-       *
-       * @deprecated
-       */
       const keywords: string[];
     }
 

package/lib/main.js

@@ -173,7 +173,7 @@ module.exports = {
       keywords: Object.freeze([ ...keywords.hana ] ),
     }),
     hdbcds: Object.assign((...args) => snapi.hdbcds(...args), {
-      keywords: Object.freeze([ ...keywords.hdbcds ] ),
+      keywords: Object.freeze([ ...keywords.hdbcds ]),
     }),
     edm: Object.assign((...args) => snapi.edm(...args), {
       all: (...args) => snapi.edm.all(...args),

package/lib/model/csnUtils.js

@@ -9,7 +9,7 @@ const {
   applyTransformationsOnDictionary,
   mergeTransformers,
 } = require('../transform/db/applyTransformations');
-const { isBuiltinType, isAnnotationExpression } = require('../base/builtins');
+const { isBuiltinType, isAnnotationExpression, primaryExprProperties } = require('../base/builtins');
 const { ModelError, CompilerAssertion } = require('../base/error');
 const { typeParameters } = require('../compiler/builtins');
 const { forEach } = require('../utils/objectUtils');
@@ -1474,13 +1474,14 @@ function pathName( ref ) {
  */
 function findAnnotationExpression( node, prop ) {
   let isExpr = false;
-  if (prop[0] === '@') {
-    transformExpression(node, prop, {
-      '=': (p) => {
-        isExpr ||= isAnnotationExpression(p);
-      },
-    });
-  }
+  const updateIsExpr = (p) => {
+    isExpr ||= isAnnotationExpression(p);
+  };
+  const xprTransformers = Object.fromEntries(primaryExprProperties.map( p => [ p, updateIsExpr ]));
+
+  if (prop[0] === '@')
+    transformExpression(node, prop, xprTransformers);
+
   return isExpr;
 }