@sap/cds-compiler 2.10.4 → 2.12.0

package/CHANGELOG.md

@@ -7,6 +7,142 @@
 Note: `beta` fixes, changes and features are usually not listed in this ChangeLog but [here](doc/CHANGELOG_BETA.md).
 The compiler behavior concerning `beta` features can change at any time without notice.
 
+## Version 2.12.0 - 2022-01-25
+
+### Added
+
+- CDL parser: You can now use multiline string literals and text blocks.  
+  Use backticks (\`) for string literals that can span multiple lines and can use JavaScript-like escape
+  sequences such as `\u{0020}`.  You can also use three backticks (\`\`\`) for strings (a.k.a. text blocks)
+  which are automatically indentation-stripped and can have an optional language identifier that is used
+  for syntax highlighting, similar to markdown.  In difference to the former, text blocks require the
+  opening and closing backticks to be on separate lines.
+  Example:
+
+      @annotation: `Multi
+       line\u{0020}strings`
+  
+      @textblock: ```xml
+                  <summary>
+                    <detail>The root tag has no indentation in this example</detail>
+                  </summary>
+                  ```
+      ...
+
+- Enhance the ellipsis operator `...` for array annotations by an `up to ‹val›`:
+  only values in the array of the base annotation up to (including) the first match
+  of the specified `‹val›` are included at the specified place in the final array value.
+  An array annotation can have more than on `... up to ‹val›` items and must also
+  have a pure `...` item after them.  
+  A structured `‹val›` matches if the array item is also a structure and all property
+  values in `‹val›` are equal to the corresponding property value in the array value;
+  it is not necessary to specify all properties of the array value items in `‹val›`.
+  Example
+
+      @Anno: [{name: one, val: 1}, {name: two, val: 2}, {name: four, val: 4}]
+      type T: Integer;
+      @Anno: [{name: zero, val: 0}, ... up to {name: two}, {name: three, val: 3}, ...]
+      annotate T;
+
+- for.odata: Support `@cds.on {update|insert}` as replacement for deprecated `@odata.on { update|insert }` to
+  set `@Core.Computed`.
+
+### Changed
+
+- Update OData Vocabularies 'Aggregation', 'Capabilities', 'Common', 'Core', PersonalData, 'Session', 'UI'
+
+### Fixed
+
+- to.sql/hdi/hdbcds: With `exists`, ensure that the precedence of the existing association-on-conditions and where-conditions is kept by adding braces.
+- to.sql/hdi: Window function suffixes are now properly rendered.
+- to.sql: `$self` comparisons inside aspects are not checked and won't result in an error anymore.
+- to.hdbcds:
+  + Correctly apply the "."-to-"_"-translation algorithm to artifacts that are marked with `@cds.persistence.exists`.
+  + Message with ID `anno-hidden-exists` (former `anno-unstable-hdbcds`) is now
+    only issued if the compiler generates a SAP HANA CDS artifact which would hide
+    a native database object from being resolved in a SAP HANA CDS `using … as …`.
+- to.cdl: Annotation paths containing special characters such as spaces or `@` are now quoted, e.g. `@![some@annotation]`.
+- compiler: A warning is emitted for elements of views with localized keys as the localized property is ignored for them.
+
+## Version 2.11.4 - 2021-12-21
+
+### Fixed
+
+- CDL parser: in many situations, improve message when people use reserved keywords as identifier
+- Improve error text and error location for ambiguous auto-redirection target
+- to.sql/hdi/hdbcds:
+  + Correctly detect `exists` in projections
+  + Correctly handle elements starting with `$` in the on-condition of associations
+  + Correctly handle sub queries in an entity defined with `projection on`
+  + Correctly handle associations in sub queries in a `from` of a sub query
+  + foreign key constraints: respect @assert.integrity: false for compositions
+- to.hdbcds: Correctly quote elements named `$self` and `$projection`
+- to.cdl: `when` was added to the keyword list for smart quoting
+- Compiler support for code completion for `$user` and `$session` now respect user
+  provided variables in `options.variableReplacements`.
+- API: `deduplicateMessages()` no longer removes messages for `duplicate` artifact/annotation errors.
+  Prior to this version, only one of the duplicated artifacts had a message, leaving the user to
+  guess where the other duplicates were.
+
+
+## Version 2.11.2 - 2021-12-06
+
+### Fixed
+
+- to.sql/hdi/hdbcds:
+  + No foreign key constraint will be rendered for managed `composition of one` if annotated with `@assert.integrity: false`
+  + Correctly handle managed associations with other managed associations as foreign keys in conjunction with `exists`
+
+## Version 2.11.0 - 2021-12-02
+
+### Added
+
+- Option `defaultBinaryLength` to set a `length` type facet for all definitions with type `cds.Binary`. This option
+  overrides the default binary length in the database backends and is also used as `MaxLength` attribute in Odata.
+- If doc-comments are ignored by the compiler, an info message is now emitted.  A doc-comment is ignored,
+  if it can't be assigned to an artifact.  For example for two subsequent doc-comments, the first doc-comment
+  is ignored.  To suppress these info messages, explicitly set option `docComment` to `false`.
+- `cdsc`:
+  + `cdsc explain list` can now be used to get a list of message IDs with explanation texts.
+  + `cdsc` now respects the environment variable `NO_COLOR`. If set, no ANSI escape codes will be used.
+    Can be overwritten by `cdsc --color always`.
+- to.sql/hdi: Support SQL Window Functions
+- to.sql/hdi/hdbcds:
+  + Support configuration of `$session` and `$user` via option `variableReplacements`.
+  + Restricted support for SQL foreign key constraints if option `assertIntegrityType` is set to `"DB"`.
+    The behavior of this feature might change in the future.
+
+### Changed
+
+- Updated OData vocabularies 'Common' and 'UI'.
+- to.sql/hdi/hdbcds: The default length of `cds.Binary` is set to `5000` similar to `cds.String`.
+
+### Removed
+
+- to.hdbcds: Doc comments on view columns are not rendered anymore. Doc comments on string literals will make the deployment fail
+  as the SAP HANA CDS compiler concatenates the doc comment with the string literal. Besides that, doc comments on view columns
+  are not transported to the database by SAP HANA CDS.
+- to.hdbcds/sql/hdi: Forbid associations in filters after `exists` (except for nested `exists`), as the final behavior is not yet specified.
+
+### Fixed
+
+- CSN parser: doc-comment extensions are no longer ignored.
+- Properly check for duplicate annotation definitions.
+- Correctly apply annotations on inherited enum symbols.
+- Correctly apply annotations on elements in an inherited structure array.
+- Fix a bug in API `defaultStringLength` value evaluation.
+- Fix crash if named arguments are used in a function that's inside a `CASE` statement.
+- to.sql/hdi/hdbcds:
+  + Properly flatten ad-hoc defined elements in `returns` / `params` of `actions` and `functions`.
+  + Correctly handle `*` in non-first position.
+  + Correctly handle action return types
+  + Correctly handle mixin association named `$self`
+- to.cdl: doc-comments are no longer rendered twice.
+- to.edm(x):
+  + Fix a bug in V2/V4 partner ship calculation.
+  + Remove warning of unknown types for Open Types in `@Core.Dictionary`.
+  + An empty CSN no longer results in a JavaScript type error
+
 ## Version 2.10.4 - 2021-11-05
 
 ### Fixed

package/bin/.eslintrc.json

@@ -11,7 +11,6 @@
     "no-process-exit": "off",
     "camelcase": "off",
     "radix": "off",
-    // should probably be on
-    "no-shadow": "off"
+    "no-shadow": "warn"
   }
 }

package/bin/cds_update_identifiers.js

@@ -24,37 +24,39 @@
 'use strict';
 
 const parseLanguage = require('../lib/language/antlrParser');
+const { createMessageFunctions } = require('../lib/base/messages');
 
 const fs = require('fs');
 const path = require('path');
 
 const cliArgs = process.argv.slice(2);
-const filename = cliArgs[0];
+const filepath = cliArgs[0];
 
 if (cliArgs.length !== 1)
   exitError(`Expected exactly one argument, ${cliArgs.length} given`);
 
-if (!filename)
-  exitError('Expected non-empty filename as argument!');
+if (!filepath)
+  exitError('Expected non-empty filepath as argument!');
 
 // Do not use allow-list approach.
 // There may be CDS files with other extensions than `.cds`.
-if (filename.endsWith('.csn') || filename.endsWith('.json'))
+if (filepath.endsWith('.csn') || filepath.endsWith('.json'))
   exitError('Only CDS files can be passed! Found CSN file!');
 
-let source = fs.readFileSync(filename, 'utf-8');
-source = modernizeIdentifierStyle(source, filename);
-fs.writeFileSync(filename, source);
+let sourceStr = fs.readFileSync(filepath, 'utf-8');
+sourceStr = modernizeIdentifierStyle(sourceStr, filepath);
+fs.writeFileSync(filepath, sourceStr);
 process.exit(0); // success
 
 // --------------------------------------------------------
 
 function modernizeIdentifierStyle(source, filename) {
   const options = { messages: [], attachTokens: true };
+  const messageFunctions = createMessageFunctions( options, 'parse', null );
 
   // parseLanguage does not throw on CompilationError, so
   // we do not need a try...catch block.
-  const ast = parseLanguage(source, filename, options);
+  const ast = parseLanguage(source, filename, options, messageFunctions);
 
   // To avoid spam, only report errors.
   // Users should use the compiler to get all messages.

package/bin/cdsc.js

@@ -26,8 +26,10 @@ const path = require('path');
 const { reveal } = require('../lib/model/revealInternalProperties');
 const enrichCsn = require('../lib/model/enrichCsn');
 const { optionProcessor } = require('../lib/optionProcessor');
-const { explainMessage, hasMessageExplanation, sortMessages } = require('../lib/base/messages');
-const term = require('../lib/utils/term');
+const {
+  explainMessage, hasMessageExplanation, sortMessages, messageIdsWithExplanation,
+} = require('../lib/base/messages');
+const { term } = require('../lib/utils/term');
 const { splitLines } = require('../lib/utils/file');
 const { addLocalizationViews } = require('../lib/transform/localized');
 const { availableBetaFlags } = require('../lib/base/model');
@@ -52,9 +54,11 @@ function remapCmdOptions(options, cmdOptions) {
         options.sqlMapping = value;
         break;
       case 'user':
-        if (!options.magicVars)
-          options.magicVars = {};
-        options.magicVars.user = value;
+        if (!options.variableReplacements)
+          options.variableReplacements = {};
+        if (!options.variableReplacements.$user)
+          options.variableReplacements.$user = {};
+        options.variableReplacements.$user.id = value;
         break;
       case 'dialect':
         options.sqlDialect = value;
@@ -63,9 +67,11 @@ function remapCmdOptions(options, cmdOptions) {
         options.odataVersion = value;
         break;
       case 'locale':
-        if (!options.magicVars)
-          options.magicVars = {};
-        options.magicVars.locale = value;
+        if (!options.variableReplacements)
+          options.variableReplacements = {};
+        if (!options.variableReplacements.$user)
+          options.variableReplacements.$user = {};
+        options.variableReplacements.$user.locale = value;
         break;
       default:
         options[key] = value;
@@ -124,8 +130,6 @@ try {
       global.cds = {};
     global.cds.home = cmdLine.options.cdsHome;
   }
-  // Default color mode is 'auto'
-  term.useColor(cmdLine.options.color || 'auto');
 
   // Set default command if required
   cmdLine.command = cmdLine.command || 'toCsn';
@@ -137,10 +141,7 @@ try {
   if (cmdLine.command === 'parseCdl') {
     cmdLine.command = 'toCsn';
     cmdLine.options.parseCdl = true;
-    if (cmdLine.args.files.length > 1) {
-      const err = `'parseCdl' expects exactly one file! ${cmdLine.args.files.length} provided.`;
-      displayUsage(err, optionProcessor.commands.parseCdl.helpText, 2);
-    }
+    cmdLine.args.files = [ cmdLine.args.file ];
   }
 
   if (cmdLine.options.directBackend)
@@ -155,6 +156,21 @@ try {
     });
   }
 
+  // remap string values for `assertIntegrity` option to boolean
+  if (cmdLine.options.assertIntegrity &&
+      cmdLine.options.assertIntegrity === 'true' ||
+      cmdLine.options.assertIntegrity === 'false'
+  )
+    cmdLine.options.assertIntegrity = cmdLine.options.assertIntegrity === 'true';
+
+  // remap string values for `constraintsAsAlter` option to boolean
+  if (cmdLine.options.constraintsAsAlter &&
+    cmdLine.options.constraintsAsAlter === 'true' ||
+    cmdLine.options.constraintsAsAlter === 'false'
+  )
+    cmdLine.options.constraintsAsAlter = cmdLine.options.constraintsAsAlter === 'true';
+
+
   // Enable all beta-flags if betaMode is set to true
   if (cmdLine.options.betaMode)
     cmdLine.options.beta = availableBetaFlags;
@@ -211,7 +227,7 @@ function displayUsage(error, helpText, code) {
   out.write(`${helpText}\n`);
   if (error) {
     if (error instanceof Array)
-      out.write(`${error.map(error => `cdsc: ERROR: ${error}`).join('\n')}\n`);
+      out.write(`${error.map(err => `cdsc: ERROR: ${err}`).join('\n')}\n`);
     else
       out.write(`cdsc: ERROR: ${error}\n`);
   }
@@ -231,6 +247,8 @@ function executeCommandLine(command, options, args) {
   if (options.out && options.out !== '-' && !fs.existsSync(options.out))
     fs.mkdirSync(options.out);
 
+  // Default color mode is 'auto'
+  const colorTerm = term(options.color || 'auto');
 
   // Add implementation functions corresponding to commands here
   const commands = {
@@ -283,11 +301,11 @@ function executeCommandLine(command, options, args) {
   // Return the original model (for chaining)
   function toCsn( model ) {
     if (options.directBackend) {
-      displayNamedCsn(model, 'csn', options);
+      displayNamedCsn(model, 'csn');
     }
     else {
       // Result already provided by caller
-      displayNamedXsn(model, 'csn', options);
+      displayNamedXsn(model, 'csn');
     }
     return model;
   }
@@ -298,7 +316,7 @@ function executeCommandLine(command, options, args) {
     const csn = options.directBackend ? model : compactModel(model, options);
 
     if (options.toHana && options.toHana.csn) {
-      displayNamedCsn(for_hdbcds(csn, remapCmdOptions(options, options.toHana)), 'hana_csn', options);
+      displayNamedCsn(for_hdbcds(csn, remapCmdOptions(options, options.toHana)), 'hana_csn');
     }
     else {
       const hanaResult = main.to.hdbcds(csn, remapCmdOptions(options, options.toHana));
@@ -321,7 +339,7 @@ function executeCommandLine(command, options, args) {
     const csn = options.directBackend ? model : compactModel(model, options);
     const odataCsn = main.for.odata(csn, remapCmdOptions(options, options.toOdata));
     if (options.toOdata && options.toOdata.csn) {
-      displayNamedCsn(odataCsn, 'odata_csn', options);
+      displayNamedCsn(odataCsn, 'odata_csn');
     }
     else if (options.toOdata && options.toOdata.json) {
       const result = main.to.edm.all(odataCsn, options);
@@ -374,7 +392,7 @@ function executeCommandLine(command, options, args) {
     const csn = options.directBackend ? model : compactModel(model, options);
     if (options.toSql && options.toSql.src === 'hdi') {
       if (options.toSql.csn) {
-        displayNamedCsn(for_hdi(csn, remapCmdOptions(options, options.toSql)), 'hdi_csn', options);
+        displayNamedCsn(for_hdi(csn, remapCmdOptions(options, options.toSql)), 'hdi_csn');
       }
       else {
         const hdiResult = main.to.hdi(csn, remapCmdOptions(options, options.toSql));
@@ -383,7 +401,7 @@ function executeCommandLine(command, options, args) {
       }
     }
     else if (options.toSql && options.toSql.csn) {
-      displayNamedCsn(for_sql(csn, remapCmdOptions(options, options.toSql)), 'sql_csn', options);
+      displayNamedCsn(for_sql(csn, remapCmdOptions(options, options.toSql)), 'sql_csn');
     }
     else {
       const sqlResult = main.to.sql(csn, remapCmdOptions(options, options.toSql));
@@ -393,14 +411,15 @@ function executeCommandLine(command, options, args) {
   }
 
   function explain() {
-    if (args.length !== 1)
-      displayUsage('Command \'explain\' expects exactly one message-id.', optionProcessor.commands.explain.helpText, 2);
+    if (args.messageId === 'list') {
+      console.log(messageIdsWithExplanation().join('\n'));
+      throw new ProcessExitError(0);
+    }
 
-    const id = args.files[0];
-    if (!hasMessageExplanation(id))
-      console.error(`Message '${id}' does not have an explanation!`);
+    if (!hasMessageExplanation(args.messageId))
+      console.error(`Message '${args.messageId}' does not have an explanation!`);
     else
-      console.log(explainMessage(id));
+      console.log(explainMessage(args.messageId));
   }
 
   // Display error messages in `err` resulting from a compilation.  Also set
@@ -464,16 +483,20 @@ function executeCommandLine(command, options, args) {
         hasAtLeastOneExplanation = hasAtLeastOneExplanation || main.hasMessageExplanation(msg.messageId);
         const name = msg.location && msg.location.file;
         const fullFilePath = name ? path.resolve('', name) : undefined;
-        const context = fullFilePath && sourceLines(fullFilePath);
+        const context = fullFilePath ? sourceLines(fullFilePath) : [];
         log(main.messageStringMultiline(msg, {
-          normalizeFilename, noMessageId: !options.showMessageId, withLineSpacer: true, hintExplanation: true,
+          normalizeFilename,
+          noMessageId: !options.showMessageId,
+          withLineSpacer: true,
+          hintExplanation: true,
+          color: options.color,
         }));
         if (context)
-          log(main.messageContext(context, msg));
+          log(main.messageContext(context, msg, { color: options.color }));
         log(); // newline
       });
       if (options.showMessageId && hasAtLeastOneExplanation)
-        log(`${term.help('help')}: Messages marked with '…' have an explanation text. Use \`cdsc explain <message-id>\` for a more detailed error description.`);
+        log(`${colorTerm.help('help')}: Messages marked with '…' have an explanation text. Use \`cdsc explain <message-id>\` for a more detailed error description.`);
     }
     return model;
   }
@@ -482,7 +505,7 @@ function executeCommandLine(command, options, args) {
   // or display it to stdout if 'options.out' is '-'.
   // Depending on 'options.rawOutput', the model is either compacted to 'name.json' or
   // written in raw form to '<name>_raw.txt'.
-  function displayNamedXsn(xsn, name, options) {
+  function displayNamedXsn(xsn, name) {
     if (options.rawOutput) {
       writeToFileOrDisplay(options.out, `${name}_raw.txt`, util.inspect(reveal(xsn, options.rawOutput), false, null), true);
     }
@@ -502,9 +525,8 @@ function executeCommandLine(command, options, args) {
   /**
    * @param {CSN.Model} csn
    * @param {string} name
-   * @param {CSN.Options} options
    */
-  function displayNamedCsn(csn, name, options) {
+  function displayNamedCsn(csn, name) {
     if (!csn) // only print CSN if it is set.
       return;
     if (options.internalMsg) {
@@ -549,10 +571,11 @@ function executeCommandLine(command, options, args) {
   }
 
   function catchErrors(err) {
+    // @ts-ignore
     if (err instanceof Error && err.hasBeenReported)
       return;
     console.error( '' );
-    console.error( 'INTERNAL ERROR: %s', err );
+    console.error( 'INTERNAL ERROR:' );
     console.error( util.inspect(err, false, null) );
     console.error( '' );
     process.exitCode = 70;

package/bin/cdsse.js

@@ -11,6 +11,7 @@
 // Planned are: gotoDefinition, highlight (for syntax highighting).
 
 /* eslint no-console:off */
+// @ts-nocheck
 
 'use strict';
 

package/bin/cdsv2m.js

@@ -34,10 +34,11 @@ function usage( err ) {
 function ria() {
   const annotates = Object.create( null );
   const msgs = options.messages.filter( m => m.messageId === 'redirected-implicitly-ambiguous' );
-  // regex match on message text not for productive code!
+  // 'Choose via $(ANNO) one of $(SORTED_ARTS) as redirection target for $(TARGET) in … $(ART) otherwise'
+  // NOTE: regex match on message text not for productive code!
   for (const msgObj of msgs) {
     const matches = msgObj.message.match( /["“][^"”]+["”]/g );
-    matches.slice(2).forEach( (name) => {
+    matches.slice( 1, -2 ).forEach( (name) => {
       annotates[name.slice( 1, -1 )] = true;
     } );
   }

package/doc/CHANGELOG_ARCHIVE.md

@@ -1516,7 +1516,7 @@ Changes
 * Preserve the `key` properties of elements selected in a view (like we do in projections).
 * Improve the CSN representation for views.
   Represent the `where` and `on` condition of `select`s like other conditions.
-* Project name in github is now `cdx/cds-compiler`.
+* Project name in github is now `cap/cds-compiler`.
 
 Features
 * Support `select *` in views.

package/doc/CHANGELOG_BETA.md

@@ -8,6 +8,16 @@ Note: `beta` fixes, changes and features are listed in this ChangeLog just for i
 The compiler behavior concerning `beta` features can change at any time without notice.
 **Don't use `beta` fixes, changes and features in productive mode.**
 
+## Version 2.12.0 - 2022-01-25
+
+### Added `sqlSnippets`
+
+- to.sql/hdi/hdbcds: Introduce the annotations `@sql.prepend` and `@sql.append` that allow inserting user-written SQL snippets into the compiler generated content.
+
+## Version 2.11.0
+
+### Removed `foreignKeyConstraints`
+
 ## Version 2.10.4
 
 ### Fixed `nestedProjections`
@@ -159,6 +169,12 @@ The association to join transformation treats foreign key accesses with priority
 
 Unique constraints are now generally available.
 
+## Version 1.33.0 - 2020-08-24
+
+### Added `hanaAssocRealCardinality`
+
+Render JOIN cardinality in native HANA association if provided. If no cardinality has been specified.
+
 ## Version 1.32.0 - 2020-07-10
 
 ### Removed `aspectCompositions`

package/lib/api/.eslintrc.json

@@ -14,6 +14,8 @@
     "jsdoc"
   ],
   "rules": {
+    // Does not recognize TS types
+    "jsdoc/no-undefined-types": "off",
     // eslint-plugin-jsdoc warning
     "jsdoc/require-property": 0,
     // =airbnb, >eslint:

package/lib/api/main.js

@@ -14,7 +14,7 @@ const { toSqlDdl } = require('../render/toSql');
 const { compareModels } = require('../modelCompare/compare');
 const sortViews = require('../model/sortViews');
 const { getResultingName } = require('../model/csnUtils');
-const timetrace = require('../utils/timetrace');
+const { timetrace } = require('../utils/timetrace');
 const { transformForHanaWithCsn } = require('../transform/forHanaNew');
 
 /**
@@ -135,7 +135,7 @@ function odataInternal(csn, internalOptions) {
  * Return a odata-transformed CSN
  *
  * @param {CSN.Model} csn Clean input CSN
- * @param {oDataOptions} [options={}] Options
+ * @param {ODataOptions} [options={}] Options
  * @returns {oDataCSN} Return an oData-pre-processed CSN
  */
 function odata(csn, options = {}) {
@@ -159,12 +159,13 @@ function cdl(csn, externalOptions = {}) {
  * Transform a CSN like to.sql
  *
  * @param {CSN.Model} csn Plain input CSN
- * @param {sqlOptions} [options={}] Options
+ * @param {SqlOptions} [options={}] Options
  * @returns {CSN.Model} CSN transformed like to.sql
  * @private
  */
 function forSql(csn, options = {}) {
   const internalOptions = prepareOptions.to.sql(options);
+  internalOptions.transformation = 'sql';
   internalOptions.toSql.csn = true;
   return backends.toSqlWithCsn(csn, internalOptions).csn;
 }
@@ -202,11 +203,12 @@ function forHdbcds(csn, options = {}) {
  * Process the given CSN into SQL.
  *
  * @param {CSN.Model} csn A clean input CSN
- * @param {sqlOptions} [options={}] Options
+ * @param {SqlOptions} [options={}] Options
  * @returns {SQL[]} Array of SQL statements, tables first, views second
  */
 function sql(csn, options = {}) {
   const internalOptions = prepareOptions.to.sql(options);
+  internalOptions.transformation = 'sql';
 
   // we need the CSN for view sorting
   internalOptions.toSql.csn = true;
@@ -454,7 +456,7 @@ function hdbcds(csn, options = {}) {
  * Generate a edm document for the given service
  *
  * @param {CSN|oDataCSN} csn Clean input CSN or a pre-transformed CSN
- * @param {oDataOptions} [options={}] Options
+ * @param {ODataOptions} [options={}] Options
  * @returns {edm} The JSON representation of the service
  */
 function edm(csn, options = {}) {
@@ -484,7 +486,7 @@ edm.all = edmall;
  * Generate edm documents for all services
  *
  * @param {CSN|oDataCSN} csn Clean input CSN or a pre-transformed CSN
- * @param {oDataOptions} [options={}] Options
+ * @param {ODataOptions} [options={}] Options
  * @returns {edms} { <service>:<JSON representation>, ...}
  */
 function edmall(csn, options = {}) {
@@ -516,7 +518,7 @@ function edmall(csn, options = {}) {
  * Generate a edmx document for the given service
  *
  * @param {CSN|oDataCSN} csn Clean input CSN or a pre-transformed CSN
- * @param {oDataOptions} [options={}] Options
+ * @param {ODataOptions} [options={}] Options
  * @returns {edmx} The XML representation of the service
  */
 function edmx(csn, options = {}) {
@@ -547,7 +549,7 @@ edmx.all = edmxall;
  * Generate edmx documents for all services
  *
  * @param {CSN|oDataCSN} csn Clean input CSN or a pre-transformed CSN
- * @param {oDataOptions} [options={}] Options
+ * @param {ODataOptions} [options={}] Options
  * @returns {edmxs} { <service>:<XML representation>, ...}
  */
 function edmxall(csn, options = {}) {
@@ -709,20 +711,6 @@ function publishCsnProcessor( processor, _name ) {
  * @property {Array} [messages] Allows collecting all messages in the options instead of printing them to stderr.
  */
 
-/**
- * Options available for all oData-based functions
- *
- * @typedef {object} oDataOptions
- * @property {object} [beta] Enable experimental features - not for productive use!
- * @property {boolean} [longAutoexposed=false] Deprecated: Produce long names (with underscores) for autoexposed entities
- * @property {Map<string, number>} [severities={}] Map of message-id and severity that allows setting the severity for the given message
- * @property {Array} [messages] Allows collecting all messages in the options instead of printing them to stderr.
- * @property {oDataVersion} [odataVersion='v4'] Odata version to use
- * @property {oDataFormat} [odataFormat='flat'] Wether to generate oData as flat or as structured. Structured only with v4.
- * @property {NamingMode} [sqlMapping='plain'] Naming mode to use
- * @property {string} [service] If a single service is to be rendered
- */
-
 /**
  * Options available for to.hdi
  *
@@ -747,20 +735,6 @@ function publishCsnProcessor( processor, _name ) {
  * @property {Array} [messages] Allows collecting all messages in the options instead of printing them to stderr.
  */
 
-/**
- * Options available for to.sql
- *
- * @typedef {object} sqlOptions
- * @property {NamingMode} [sqlMapping='plain'] Naming mode to use
- * @property {SQLDialect} [sqlDialect='sqlite'] SQL dialect to use
- * @property {object} [magicVars] Object containing values for magic variables like "$user"
- * @property {string} [magicVars.locale] Value for the "$user.locale" in "sqlite" dialect
- * @property {string} [magicVars.user] Value for the "$user" variable in "sqlite" dialect
- * @property {object} [beta] Enable experimental features - not for productive use!
- * @property {boolean} [longAutoexposed=false] Deprecated: Produce long names (with underscores) for autoexposed entities
- * @property {Map<string, number>} [severities={}] Map of message-id and severity that allows setting the severity for the given message
- * @property {Array} [messages] Allows collecting all messages in the options instead of printing them to stderr.
- */
 
 /**
  * A fresh (just compiled, not transformed) CSN