@sap/cds-dk 10.1.1 → 10.2.0

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

@@ -16,10 +16,10 @@ const tenant = lazyload('../transform/addTenantFields');
 const toSql = lazyload('../render/toSql');
 const toCdl = require('../render/toCdl');
 const sqlRenderUtils = lazyload('../render/utils/sql');
-const modelCompare = lazyload('../modelCompare/compare');
-const diffFilter = lazyload('../modelCompare/utils/filter');
-const sortViews = lazyload('../model/sortViews');
-const csnUtils = lazyload('../model/csnUtils');
+const modelCompare = lazyload('../transform/db/migration/diffModels');
+const diffFilter = lazyload('../transform/db/migration/filterDiff');
+const sortViews = lazyload('../base/sortViews');
+const csnUtils = lazyload('../base/csnUtils');
 const timetrace = lazyload('../utils/timetrace');
 const forRelationalDB = lazyload('../transform/forRelationalDB');
 const sqlUtils = lazyload('../render/utils/sql');
@@ -1164,8 +1164,11 @@ function publishCsnProcessor( processor, _name ) {
                                                   'CSN input had to be recompiled' );
       if (options.internalMsg || options.testMode)
         recompileMsg.error = err; // Attach original error;
-      if (options.testMode)  // Attach recompilation reason in testMode
-        recompileMsg.message += `\n   ↳ cause: ${ err.message }`;
+      if (options.testMode) {  // Attach recompilation reason in testMode
+        // Omit shuffle-dependent query-property enumeration to keep ref files stable.
+        const cause = err.message.replace( /(elements not available): .*/, '$1' );
+        recompileMsg.message += `\n   ↳ cause: ${ cause }`;
+      }
 
       const xsn = compiler.recompileX(csn, options);
       const recompiledCsn = toCsn.compactModel(xsn);

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

@@ -37,7 +37,7 @@ const publicOptionsNewAPI = [
   'magicVars', // deprecated, not removed in v3 as we have specific error messages for it
   'variableReplacements',
   'pre2134ReferentialConstraintNames',
-  'draftAdminDataConstraints',
+  'draft_admin_integrity',
   'betterSqliteSessionVariables',
   'decimal_affinity',
   'withHanaAssociations',
@@ -194,7 +194,7 @@ module.exports = {
         booleanEquality: true,
         dollarNowAsTimestamp: false,
         decimal_affinity: 'real',
-        draftAdminDataConstraints: false,
+        draft_admin_integrity: false,
       };
       const processed = translateOptions(options, defaultOptions, hardOptions, {}, [ 'sql-dialect-and-naming' ], 'to.sql');
 
@@ -209,7 +209,7 @@ module.exports = {
         withHanaAssociations: false,
         booleanEquality: true,
         dollarNowAsTimestamp: false,
-        draftAdminDataConstraints: false,
+        draft_admin_integrity: false,
       };
       return translateOptions(options, defaultOptions, hardOptions, { sqlDialect: generateStringValidator([ 'hana' ]) }, undefined, 'to.hdi');
     },

package/node_modules/@sap/cds-compiler/lib/{model → base}/csnUtils.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { csnRefs, implicitAs, pathId } = require('../base/csnRefs');
+const { csnRefs, implicitAs, pathId } = require('./csnRefs');
 const {
   transformExpression,
   transformAnnotationExpression,
@@ -10,11 +10,11 @@ const {
   mergeTransformers,
   isSimpleAnnoExprRef,
 } = require('../transform/db/applyTransformations');
-const { isBuiltinType, isAnnotationExpression, primaryExprProperties } = require('../base/builtins');
-const { ModelError, CompilerAssertion } = require('../base/error');
+const { isBuiltinType, isAnnotationExpression, primaryExprProperties } = require('./builtins');
+const { ModelError, CompilerAssertion } = require('./error');
 const { typeParameters } = require('../compiler/builtins');
 const { forEach } = require('../utils/objectUtils');
-const { cloneAnnotationValue } = require('../base/cloneCsn');
+const { cloneAnnotationValue } = require('./cloneCsn');
 
 // Low-level utility functions to work with compact CSN.
 
@@ -281,7 +281,7 @@ function getUtils( model, universalReady ) {
    * @param {string} name Absolute name of artifact
    */
   function getContextOfArtifact( name ) {
-    let lastDotIdx = name.lastIndexOf('.');
+    let lastDotIdx;
     while (model.definitions[name]) {
       if (model.definitions[name].kind === 'context' || model.definitions[name].kind === 'service')
         return name;

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

@@ -97,16 +97,20 @@ const centralMessages = {
   'ext-undefined-def-sec': { severity: 'Error', configurableFor: true }, // … annotate statement
   'ext-undefined-element': { severity: 'Warning' },
   'ext-undefined-key':     { severity: 'Warning' },
+  'ext-undefined-key-sec': { severity: 'Error', configurableFor: true },
   'ext-undefined-param':   { severity: 'Warning' },
   'ext-undefined-element-sec': { severity: 'Error', configurableFor: true }, // for security-relevant…
+  'extend-undefined': { severity: 'Error' },
   'ext-undefined-action-sec': { severity: 'Error', configurableFor: true }, // for security-relevant…
   'ext-undefined-param-sec': { severity: 'Error', configurableFor: true }, // … annotate statement
+  'ext-unexpected-builtin': { severity: 'Warning', errorFor: [ 'v8' ] },
   'ext-unexpected-type-property': { severity: 'Error', configurableFor: 'before_v8' },
   'ext-unexpected-returns': { severity: 'Warning' },
   'ext-unexpected-returns-sec': { severity: 'Error', configurableFor: true }, // … annotate statement
-  'anno-unexpected-ellipsis': { severity: 'Error', configurableFor: 'deprecated' }, // or ok?
+  'anno-unexpected-ellipsis': { severity: 'Error', configurableFor: 'deprecated_before_v8' },
   'anno-unexpected-localized-skip': { severity: 'Error', configurableFor: true },
 
+  'name-duplicate-artifact-exists': { severity: 'Warning', errorFor: [ 'v8' ] },
   'name-invalid-dollar-alias': { severity: 'Error', configurableFor: true },
   'name-deprecated-$self': { severity: 'Error' },
 
@@ -158,12 +162,15 @@ const centralMessages = {
 
   'ext-duplicate-extend-type': { severity: 'Error' },
   'ext-duplicate-extend-type-unrelated-layer': { severity: 'Error', configurableFor: true },
+  'ext-duplicate-includes': { severity: 'Warning' },
+  'ext-unstable-includes': { severity: 'Warning' },
 
   'param-default': { severity: 'Error' }, // not supported yet
 
   'query-ignoring-param-nullability': { severity: 'Info' },
   'query-expected-identifier': { severity: 'Error' },
   'query-invalid-identifier': { severity: 'Warning' },
+  'query-duplicate-reference': { severity: 'Warning' },
 
   'recalculated-localized': { severity: 'Info' }, // KEEP: Downgrade in lib/transform/translateAssocsToJoins.js
   'redirected-implicitly-ambiguous': { severity: 'Error', configurableFor: true }, // does not hurt us - TODO: ref-ambiguous-target
@@ -390,6 +397,10 @@ const centralMessageTexts = {
     std: 'Duplicate assignment with $(ANNO)',
     doc: 'Duplicate assignment with a doc comment',
   },
+  'anno-duplicate-equal': {
+    std: 'Duplicate assignment with $(ANNO) (values are equal)',
+    doc: 'Duplicate assignment with a doc comment (values are equal)',
+  },
   'anno-duplicate-same-file': {
     std: 'Duplicate assignment with $(ANNO), using last',
     doc: 'Duplicate assignment with a doc comment, using last',
@@ -427,6 +438,9 @@ const centralMessageTexts = {
     'flatten-fkey-gen': 'Duplicate definition of foreign key element $(NAME) for association $(ART)',
     'flatten-fkey-exists': 'Generated foreign key element $(NAME) for association $(ART) conflicts with existing element',
   },
+  'name-duplicate-artifact-exists': {
+    std: 'Artifact name can\'t be mapped to a SQL compliant identifier in naming mode $(PROP) because it conflicts with existing definition $(NAME)',
+  },
   'name-invalid-dollar-alias': {
     std: 'An alias name starting with $(NAME) might shadow a special variable; replace by another name',
     $tableAlias: 'A table alias name must not start with $(NAME); choose another name',
@@ -501,6 +515,7 @@ const centralMessageTexts = {
   'syntax-unexpected-ellipsis': {
     std: 'Unexpected array item $(CODE)',
     duplicate: 'Unexpected array item $(CODE) after previous $(CODE) without $(KEYWORD)',
+    definition: 'Unexpected array item $(CODE) in the annotation value on a definition',
     'csn-duplicate': 'Unexpected object with property $(PROP) after previous array item $(CODE)',
     'csn-nested': 'Unexpected object with property $(PROP) in nested array',
   },
@@ -1002,7 +1017,26 @@ const centralMessageTexts = {
     returns: 'The return value has no element $(NAME)',
     'enum-returns': 'The return value has no enum $(NAME)',
   },
-  'ext-undefined-key': 'Foreign key $(NAME) has not been found',
+  'def-unexpected-elements': 'Elements only exist in entities, types or typed constructs',
+  'anno-unexpected-elements': {
+    std: 'Elements only exist in entities, types or typed constructs',
+    entity: 'Elements of parameters can\'t be annotated if they use an entity as type',
+  },
+  'def-unexpected-enum': 'Enum symbols can only be defined for types or typed constructs',
+  'extend-type': 'Only structures or enum types can be extended with elements/enums',
+  // for extensions
+  'extend-undefined': {         // TODO: better id (and texts)
+    std: 'Artifact $(ART) does not have a member $(NAME) - nothing to extend',
+    element: 'Artifact $(ART) has no element or enum $(NAME) - nothing to extend',
+    returns: 'Artifact $(ART) has no element or enum $(NAME) - nothing to extend',
+    enum: 'Artifact $(ART) has no element or enum $(NAME) - nothing to extend',
+    'enum-returns': 'Artifact $(ART) has no element or enum $(NAME) - nothing to extend',
+  },
+  'ext-undefined-key': {
+    std: 'Foreign key $(NAME) has not been found',
+    dict: 'An unmanaged association has no foreign keys to annotate',
+  },
+  'ext-undefined-key-sec': 'Foreign key $(NAME) has not been found',
   'ext-undefined-action': {
     std: 'Action $(NAME) has not been found',
   },
@@ -1027,6 +1061,10 @@ const centralMessageTexts = {
     // function without `returns` can happen via CSN input! TODO: check in parser
     function: 'Unexpected $(KEYWORD) for function without return parameter',
   },
+  'ext-unexpected-element': {
+    std: 'Use $(CODE) when extending enums; $(NAMES) are certainly no enum symbols',
+    one: 'Use $(CODE) when extending enums; $(NAMES) is certainly no enum symbol',
+  },
 
   // annotation checks against their definition
   'anno-expecting-value': {
@@ -1096,8 +1134,9 @@ const centralMessageTexts = {
   'def-invalid-texts-aspect': {
     std: '$(ART) is not valid', // unused
     'no-aspect': '$(ART) must be an aspect with elements',
-    key: 'Element $(NAME) of $(ART) must be a key',
     missing: '$(ART) must have a direct element $(NAME)',
+    key: 'Element $(NAME) of $(ART) must be a key',
+    language: '$(ART) must not have an element $(NAME) when option $(OPTION) is set',
   },
   'def-invalid-element-type': {
     std: 'Element $(ELEMREF) of $(ART) must be of type $(TYPE)',
@@ -1170,7 +1209,7 @@ const centralMessageTexts = {
   },
   'ref-invalid-include': {
     std: 'An explicitly structured entity, type, aspect, or event is expected here',
-    bare : 'An aspect without elements is expected here',
+    bare : 'An aspect with just annotations is expected here',
     param: 'A type, entity, aspect or event without parameters is expected here',
   },
   'ref-invalid-type': {
@@ -1229,11 +1268,20 @@ const centralMessageTexts = {
   },
   'ext-unexpected-sql-clause': 'Artifact $(ART) can\'t be extended with a $(KEYWORD) clause, because it already exists',
   'extend-repeated-intralayer': 'Unstable element order due to repeated extensions in same layer',
-  'extend-unexpected-include': 'Can\'t extend $(META) with includes',
-
+  'extend-unexpected-include': {
+    std: 'Can\'t extend this artifact with any include',
+    service: 'Can\'t extend this service with any include',
+    context: 'Can\'t extend this context with any include',
+    action: 'Can\'t extend this action with any include',
+    function: 'Can\'t extend this function with any include',
+    annotation: 'Can\'t extend this annotation definition with any include',
+  },
   'ext-duplicate-same-file': 'Duplicate extension with $(PROP) in same file',
   'ext-duplicate-extend-type': 'Duplicate type extension for type $(TYPE)',
   'ext-duplicate-extend-type-unrelated-layer': 'Duplicate type extension for type $(TYPE)',
+  'ext-duplicate-includes': 'Some other extension also adds includes to $(TYPE); better combine this extension with it',
+  'ext-unstable-includes': 'Some other extension also adds includes to $(TYPE); they might be applied in different order on a different installation',
+
   'ext-invalid-type-property':  {
     std: 'Type property $(PROP) can only be extended',
     indirect: 'Type property $(PROP) can only be extended if directly provided at the definition',

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

@@ -303,7 +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('    --draft-admin-integrity', { optionName: 'draft_admin_integrity' })
   .option('    --disable-hana-comments')
   .option('    --generated-by-comment')
   .option('    --better-sqlite-session-variables <bool>')
@@ -360,9 +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.
+   --draft-admin-integrity    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>

package/node_modules/@sap/cds-compiler/lib/{model → base}/sortViews.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const { setDependencies } = require('./csnUtils');
-const { ModelError } = require('../base/error');
+const { ModelError } = require('./error');
 
 /**
  * @typedef {Object} Layers

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

@@ -1,7 +1,7 @@
 'use strict';
 
 // Only to be used with validator.js - a correct this value needs to be provided!
-const { forEachMemberRecursively } = require('../model/csnUtils');
+const { forEachMemberRecursively } = require('../base/csnUtils');
 
 /**
  * Asserts that there is no association usage outside of the specified service.

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

@@ -1,6 +1,6 @@
 'use strict';
 
-const { isPersistedOnDatabase } = require('../model/csnUtils.js');
+const { isPersistedOnDatabase } = require('../base/csnUtils.js');
 
 /**
  * Check that `cds.hana` types are not used - we don't support them for postgres

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

@@ -1,7 +1,7 @@
 'use strict';
 
 const { requireForeignKeyAccess } = require('../checks/onConditions');
-const { applyTransformationsOnNonDictionary } = require('../model/csnUtils');
+const { applyTransformationsOnNonDictionary } = require('../base/csnUtils');
 
 /**
  * Check that all paths in calculated elements-on write either access normal fields

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

@@ -5,7 +5,7 @@ const {
   forEachMemberRecursively,
   cardinality2str,
   hasPersistenceSkipAnnotation,
-} = require('../model/csnUtils');
+} = require('../base/csnUtils');
 const { isBuiltinType } = require('../base/builtins');
 const { isGeoTypeName } = require('../compiler/builtins');
 const { setProp } = require('../utils/objectUtils');
@@ -99,16 +99,50 @@ function checkPrimaryKey( art ) {
 
 
 /**
- * Checks virtual elements and throws an error if some is either structured or
- * an association
+ * Checks whether an element is or contains a virtual association or composition.
  *
  * @param {CSN.Element} member Element to be checked
  */
 function checkVirtualElement( member ) {
+  if (this.artifact.kind !== 'entity')
+    return;
+
   if (member.virtual) {
     if (this.csnUtils.isAssocOrComposition(member))
       this.error('def-unexpected-virtual', member.$path, { keyword: 'virtual' });
+    else
+      checkForNestedAssociations.call(this, member, member.$path, undefined, true);
+  }
+  else if (!member.elements) {
+    checkForNestedAssociations.call(this, member, member.$path);
+  }
+}
+
+/**
+ * Check whether a virtual structured element contains an association or composition.
+ *
+ * @param {CSN.Element} member Element to be checked
+ * @param {CSN.Path} virtualPath Path of the element being checked
+ * @param {CSN.Path} [typeUsagePath] Path of the element using a structured type
+ * @param {boolean} [parentIsVirtual] Whether the containing element is virtual
+ * @param {Set<object>} [visited] Element dictionaries in the current type chain
+ */
+function checkForNestedAssociations( member, virtualPath, typeUsagePath, parentIsVirtual = false, visited = new Set() ) {
+  const elements = member.elements || member._type?.elements || this.csnUtils.getFinalTypeInfo(member.type)?.elements;
+  if (!elements || visited.has(elements))
+    return;
+
+  visited.add(elements);
+  // Elements of a referenced type keep their declaration paths, so report them at the type usage instead.
+  const nestedTypeUsagePath = typeUsagePath || (member.elements ? null : virtualPath);
+  for (const [ name, elem ] of Object.entries(elements)) {
+    const elementPath = nestedTypeUsagePath || elem.$path || virtualPath.concat([ 'elements', name ]);
+    const isVirtual = parentIsVirtual || elem.virtual;
+    if (isVirtual && this.csnUtils.isAssocOrComposition(elem))
+      this.error('def-unexpected-virtual', elementPath, { keyword: 'virtual' });
+    checkForNestedAssociations.call(this, elem, elementPath, nestedTypeUsagePath, isVirtual, visited);
   }
+  visited.delete(elements);
 }
 
 /**

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

@@ -1,4 +1,4 @@
-// This is very similar to lib/model/enrichCsn - but the goal and the execution differ a bit:
+// This is very similar to lib/tool-lib/enrichCsn - but the goal and the execution differ a bit:
 // - enrichCsn is used to enhance ref files for testing.
 // - this file is used as a "pre-loading" step of the CSN validations.
 

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

@@ -1,6 +1,6 @@
 'use strict';
 
-const { applyTransformationsOnNonDictionary } = require('../model/csnUtils');
+const { applyTransformationsOnNonDictionary } = require('../base/csnUtils');
 
 /**
  * Checks a query for forbidden usage of the `exists` predicate within `groupBy` and `orderBy`.

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

@@ -3,7 +3,7 @@
 // Only to be used with validator.js - a correct this value needs to be provided!
 // not relevant for odata - entities need to be checked at the end of the transformation
 
-const { isPersistedOnDatabase } = require('../model/csnUtils.js');
+const { isPersistedOnDatabase } = require('../base/csnUtils.js');
 
 /**
  * Ensure that empty/only virtual entities do not reach the db.

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

@@ -1,6 +1,6 @@
 'use strict';
 
-const { applyTransformationsOnNonDictionary } = require('../model/csnUtils');
+const { applyTransformationsOnNonDictionary } = require('../base/csnUtils');
 
 /**
  * Check for nested projections (expand) on to-many associations or compositions.

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

@@ -1,6 +1,6 @@
 'use strict';
 
-const { applyTransformationsOnNonDictionary } = require('../model/csnUtils');
+const { applyTransformationsOnNonDictionary } = require('../base/csnUtils');
 
 /**
  * Check all refs in the given parent for the traversal of paths

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

@@ -1,6 +1,6 @@
 'use strict';
 
-const { forEachGeneric } = require('../model/csnUtils');
+const { forEachGeneric } = require('../base/csnUtils');
 const { otherSideIsExpandableStructure, resolveArtifactType } = require('./utils');
 const { pathId } = require('../base/csnRefs');
 

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

@@ -1,6 +1,6 @@
 'use strict';
 
-const { isPersistedOnDatabase } = require('../model/csnUtils.js');
+const { isPersistedOnDatabase } = require('../base/csnUtils.js');
 
 /**
  * Check that we don't have parameterized views - as we don't know yet how to represent them on postgres

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

@@ -1,6 +1,6 @@
 'use strict';
 
-const { isPersistedOnDatabase, applyTransformationsOnNonDictionary } = require('../model/csnUtils');
+const { isPersistedOnDatabase, applyTransformationsOnNonDictionary } = require('../base/csnUtils');
 const { isBuiltinType } = require('../base/builtins');
 const { requireForeignKeyAccess } = require('./onConditions');
 const { pathId } = require('../base/csnRefs');

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

@@ -1,6 +1,6 @@
 'use strict';
 
-const { applyTransformationsOnNonDictionary } = require('../model/csnUtils');
+const { applyTransformationsOnNonDictionary } = require('../base/csnUtils');
 
 // Only to be used with validator.js - a correct this value needs to be provided!
 

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

@@ -1,7 +1,7 @@
 'use strict';
 
 const { isBuiltinType } = require('../base/builtins');
-const { transformAnnotationExpression } = require('../model/csnUtils');
+const { transformAnnotationExpression } = require('../base/csnUtils');
 /**
  *
  * @param {object} member

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

@@ -1,6 +1,6 @@
 'use strict';
 
-const { forEachMemberRecursively } = require('../model/csnUtils');
+const { forEachMemberRecursively } = require('../base/csnUtils');
 
 // Only to be used with validator.js - a correct this value needs to be provided!
 

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

@@ -2,7 +2,7 @@
 
 // Only to be used with validator.js - a correct this value needs to be provided!
 
-const { hasPersistenceSkipAnnotation } = require('../model/csnUtils');
+const { hasPersistenceSkipAnnotation } = require('../base/csnUtils');
 
 /**
  * Scale must not be 'variable' or 'floating'

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

@@ -4,7 +4,7 @@ const {
   forEachDefinition, forEachMemberRecursively, forAllQueries,
   forEachMember, getNormalizedQuery,
   applyTransformations, functionList, mergeTransformers, hasPersistenceSkipAnnotation,
-} = require('../model/csnUtils');
+} = require('../base/csnUtils');
 const enrichCsn = require('./enricher');
 
 // forRelationalDB

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

@@ -212,7 +212,11 @@ function assertConsistency( model, stage ) {
           ],
           schema: {
             kind: { test: isString, enum: [ 'builtin' ] },
-            name: { test: isObject, instanceOf: XsnName, requires: [ 'id', 'element' ] },
+            name: {
+              test: isObject,
+              instanceOf: XsnName,
+              requires: [ 'id', 'element' ],
+            },
             $autoElement: { test: isString },
             $uncheckedElements: { test: isBoolean },
             $requireElementAccess: { test: isBoolean },
@@ -265,7 +269,6 @@ function assertConsistency( model, stage ) {
     foreignKeys: {
       kind: true,
       inherits: 'definitions',
-      instanceOf: 'ignore',
       also: [ false ],
     },
     $keysNavigation: { kind: true, test: TODO },
@@ -378,7 +381,7 @@ function assertConsistency( model, stage ) {
       optional: [
         'path', 'elements', '_outer', '_parent', '_main', '_block', 'kind',
         'scope', '_artifact', '$inferred', '$expand', '$inCycle', '$backlink',
-        '$tableAliases', '_$next',
+        '$tableAliases', '_$next', '_deps',
         '_origin', '_effectiveType', '$effectiveSeqNo', '_extensions', '$contains',
       ],
     },
@@ -551,7 +554,7 @@ function assertConsistency( model, stage ) {
     name: {
       isRequired: stageParser && (() => false), // not required in parser
       kind: true,
-      instanceOf: 'ignore', // TODO: XsnName,
+      instanceOf: XsnName,
       schema: {
         id: { test: isStringOrNumber },
         select: { test: TODO }, // TODO: remove
@@ -594,6 +597,7 @@ function assertConsistency( model, stage ) {
     },
     items: {
       kind: true,
+      instanceOf: XsnArtifact,
       also: [ 0 ],              // 0 for cyclic expansions
       requires: [ 'location' ],
       optional: [
@@ -603,7 +607,7 @@ function assertConsistency( model, stage ) {
         '_origin', '_block', '$inferred', '$expand', '$inCycle', '_deps',
         'localized',            // really? see #13135
         '$calcDepElement',
-        '$syntax', '_extensions',
+        '$syntax', '_extensions', '$postponeInclude',
         '_status', '_redirected',
         ...typeProperties,
       ],
@@ -690,7 +694,7 @@ function assertConsistency( model, stage ) {
     _status: { kind: true, test: TODO },    // TODO: $status
     _projections: { kind: true, test: TODO },
     _complexProjections: { kind: true, test: TODO }, // for projected paths with filters
-    _entities: { test: TODO },
+    _entities: { test: TODO },                       // all definitions in dependency order
     _associations: { test: TODO },
     $compositionTargets: { test: isDictionary( isBoolean ) },
     $collectedExtensions: { test: TODO },
@@ -706,6 +710,7 @@ function assertConsistency( model, stage ) {
     _descendants: { kind: [ 'entity' ], test: isDictionary( isArray( TODO ) ) },
 
     $errorReported: { parser: true, kind: true, test: isString },     // to avoid duplicate messages
+    // Remark: explain every occurence of $errorReported in code
     $duplicates: { parser: true, kind: true, test: TODO }, // array of arts or true
     $extension: { kind: true, test: TODO }, // TODO: introduce $applied instead or $status
     $inferred: {
@@ -1071,13 +1076,16 @@ function assertConsistency( model, stage ) {
     if (!node || typeof node !== 'object' )
       throw new InternalConsistencyError( `Expected object${ at( [ null, parent ], prop, name ) }` );
     const found = Object.getPrototypeOf( node )?.constructor?.name || 'null';
-    if (!spec.instanceOf && Object.getPrototypeOf( node ) !== Object.prototype)
+    if (!spec.instanceOf && Object.getPrototypeOf( node ) !== Object.prototype) {
       throw new InternalConsistencyError( `Expected standard object but found ${ found }${ at( [ null, parent ], prop, name ) }` );
-    // TODO
-    // else if (spec.instanceOf && spec.instanceOf !== 'ignore' &&
-    //    Object.getPrototypeOf( node ) !== spec.instanceOf.prototype)
-    // eslint-disable-next-line @stylistic/max-len
-    //  throw new InternalConsistencyError( `Expected object of class ${ spec.instanceOf.name } but found ${ found }${ at( [ null, parent ], prop, name ) }` );
+    }
+    else if (spec.instanceOf && spec.instanceOf !== 'ignore' &&
+             Object.getPrototypeOf( node ) !== spec.instanceOf.prototype) {
+      const err = new InternalConsistencyError( `Expected object of class ${ spec.instanceOf.name } but found ${ found }${ at( [ null, parent ], prop, name ) }` );
+      if (Error.captureStackTrace)
+        Error.captureStackTrace( err, isObject );
+      throw err;
+    }
   }
 
 

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

@@ -10,6 +10,7 @@
 const { builtinLocation } = require('../base/location');
 const { setLink } = require('./utils');
 const { isBetaEnabled } = require('../base/specialOptions');
+const { XsnArtifact, XsnName } = require('./xsn-model');
 
 // TODO: make type parameters a dict
 const core = {
@@ -388,9 +389,10 @@ function initBuiltins( model ) {
 
   function createNamespace( name, builtin ) {
     const art = {
+      __proto__: XsnArtifact.prototype,
       kind: 'namespace',
       // builtin namespaces don't have a cds file, so no location available
-      name: { id: name, location: builtinLocation() },
+      name: { __proto__: XsnName.prototype, id: name, location: builtinLocation() },
       blocks: [],
       builtin,
       location: builtinLocation(),
@@ -414,7 +416,10 @@ function initBuiltins( model ) {
       const id = prefix + name;
       // TODO: reconsider whether to set a type to itself - looks wrong
       const art = {
-        kind: 'type', builtin: true, name: { id },
+        __proto__: XsnArtifact.prototype,
+        kind: 'type',
+        builtin: true,
+        name: { __proto__: XsnName.prototype, id },
       };
       if (parent)
         parent._subArtifacts[name] = art;
@@ -439,7 +444,7 @@ function initBuiltins( model ) {
       // TODO: rename to $builtinFunction
       const art = {
         kind: 'builtin',        // TODO: $var
-        name: { id },
+        name: { __proto__: XsnName.prototype, id },
       };
       elements[id] = art;
       setLink( art, '_parent', model.$magicVariables );
@@ -473,7 +478,7 @@ function initBuiltins( model ) {
     for (const id of names) {
       const magic = {
         kind: 'builtin',        // TODO: '$var'
-        name: { id },
+        name: { __proto__: XsnName.prototype, id },
       };
       // Propagate this property so that it is available for sub-elements.
       if (art.$uncheckedElements)