@sap/cds 8.9.3 → 9.0.2

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/http/Preferences.js

@@ -1,222 +0,0 @@
-'use strict'
-
-/**
- * Stores the parsed prefer headers from the request.
- *
- * <a href="../ODataSpecification/odata-v4.0-errata03-os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Toc453752234">
- *     OData V4 part1 protocol 8.2.8 Header Prefer
- * </a>
- *
- * @hideconstructor
- */
-class Preferences {
-  constructor () {
-    this._odataAllowEntityReferences = false
-    this._odataCallback = null
-    this._odataContinueOnError = false
-    this._odataIncludeAnnotations = null
-    this._odataMaxPageSize = null
-    this._odataTrackChanges = null
-    this._return = null
-    this._respondAsync = false
-    this._wait = null
-
-    this._customPreferences = new Map()
-  }
-
-  /**
-   * Returns true if Preference "odata.allow-entityreferences" is set.
-   * @returns {boolean} whether "odata.allow-entityreferences" is set
-   */
-  getOdataAllowEntityReferences () {
-    return this._odataAllowEntityReferences
-  }
-
-  /**
-   * @param {boolean} value the value of the preference
-   * @returns {Preferences} this instance
-   * @package
-   */
-  setOdataAllowEntityReferences (value) {
-    this._odataAllowEntityReferences = value
-    return this
-  }
-
-  /**
-   * Returns the URI in Preference "odata.callback;url=<URI>".
-   * @returns {?string} the URI
-   */
-  getOdataCallback () {
-    return this._odataCallback
-  }
-
-  /**
-   * @param {?string} value the value of the preference
-   * @returns {Preferences} this instance
-   * @package
-   */
-  setOdataCallback (value) {
-    this._odataCallback = value
-    return this
-  }
-
-  /**
-   * Returns true if Preference "odata.continue-on-error" is set.
-   * @returns {boolean} whether to continue on error
-   */
-  getOdataContinueOnError () {
-    return this._odataContinueOnError
-  }
-
-  /**
-   * @param {boolean} value the value of the preference
-   * @returns {Preferences} this instance
-   * @package
-   */
-  setOdataContinueOnError (value) {
-    this._odataContinueOnError = value
-    return this
-  }
-
-  /**
-   * Returns the annotations list in "odata.include-annotations".
-   * @returns {*} the annotations list
-   */
-  getOdataIncludeAnnotations () {
-    return this._odataIncludeAnnotations
-  }
-
-  /**
-   * @param {*} value the value of the preference
-   * @returns {Preferences} this instance
-   * @package
-   */
-  setOdataIncludeAnnotations (value) {
-    this._odataIncludeAnnotations = value
-    return this
-  }
-
-  /**
-   * Returns the number set in Preference "odata.maxpagesize=<number>".
-   * @returns {?number} the page size preference
-   */
-  getOdataMaxPageSize () {
-    return this._odataMaxPageSize
-  }
-
-  /**
-   * @param {?number} value the value of the preference
-   * @returns {Preferences} this instance
-   * @package
-   */
-  setOdataMaxPageSize (value) {
-    this._odataMaxPageSize = value
-    return this
-  }
-
-  /**
-   * Returns true if Preference "odata.track-changes" is set.
-   * @returns {boolean} whether to track changes
-   */
-  getOdataTrackChanges () {
-    return this._odataTrackChanges
-  }
-
-  /**
-   * @param {boolean} value the value of the preference
-   * @returns {Preferences} this instance
-   * @package
-   */
-  setOdataTrackChanges (value) {
-    this._odataTrackChanges = value
-    return this
-  }
-
-  /**
-   * Returns the ReturnName set in Preference "return=<Preferences.ReturnValues>".
-   * @returns {?Preferences.ReturnValues} the return preference
-   */
-  getReturn () {
-    return this._return
-  }
-
-  /**
-   * @param {?Preferences.ReturnValues} value the value of the preference
-   * @returns {Preferences} this instance
-   * @package
-   */
-  setReturn (value) {
-    this._return = value
-    return this
-  }
-
-  /**
-   * Returns true if Preference "respond-async" is set.
-   * @returns {boolean} whether to respond asynchronously
-   */
-  getRespondAsync () {
-    return this._respondAsync
-  }
-
-  /**
-   * @param {boolean} value the value of the preference
-   * @returns {Preferences} this instance
-   * @package
-   */
-  setRespondAsync (value) {
-    this._respondAsync = value
-    return this
-  }
-
-  /**
-   * Returns the number in Preference "wait=<number>"
-   * @returns {?number} the wait time
-   */
-  getWait () {
-    return this._wait
-  }
-
-  /**
-   * @param {?number} value the value of the preference
-   * @returns {Preferences} this instance
-   * @package
-   */
-  setWait (value) {
-    this._wait = value
-    return this
-  }
-
-  /**
-   * Adds a custom preference object to the custom preferences map.
-   * The key in the map is the name of the preference (the token referring to the ABNF)
-   * @param {CustomPreference} customPreference the custom preference to add to the map
-   * @returns {Preferences} this instance
-   * @package
-   */
-  setCustomPreference (customPreference) {
-    this._customPreferences.set(customPreference.getPreferenceName(), customPreference)
-    return this
-  }
-
-  /**
-   * Returns the value of a custom preference.
-   * Returns null if the custom preference does not exist.
-   * @param {string} customPreferenceName the name of the custom preference
-   * @returns {?(string|boolean)} The value of the given custom preference
-   */
-  getCustomPreferenceValue (customPreferenceName) {
-    const customPreference = this._customPreferences.get(customPreferenceName)
-    return customPreference ? customPreference.getValue() : null
-  }
-
-  /**
-   * Returns all parameters of a custom preference.
-   * @param {string} preferenceName name of the preference
-   * @returns {Map.<string, string|boolean>} the parameters of the custom preference
-   */
-  getCustomPreferenceParameters (preferenceName) {
-    return this._customPreferences.get(preferenceName).getParameters()
-  }
-}
-
-module.exports = Preferences

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/http/PreferencesApplied.js

@@ -1,199 +0,0 @@
-'use strict'
-
-/**
- * Stores the applied preferences for the response header.
- *
- * <a href="../ODataSpecification/odata-v4.0-errata03-os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Toc453752239">
- *     OData V4 part1 protocol 8.3.4 Header Preference-Applied
- *
- * @hideconstructor
- */
-class PreferencesApplied {
-  constructor () {
-    this._odataAllowEntityReferencesApplied = false
-    this._odataCallbackApplied = false
-    this._odataContinueOnErrorApplied = false
-    this._odataIncludeAnnotationsApplied = null
-    this._odataMaxPageSizeApplied = null
-    this._respondAsyncApplied = false
-    this._returnApplied = null
-    this._odataTrackChangesApplied = null
-    this._waitApplied = null
-
-    this._customPreferencesApplied = new Map()
-  }
-
-  /**
-   * Returns true if Preference "odata.allow-entityreferences" is set.
-   * @returns {boolean} whether the preference has been applied
-   * @package
-   */
-  getOdataAllowEntityReferencesApplied () {
-    return this._odataAllowEntityReferencesApplied
-  }
-
-  /**
-   * Set to true if the Preference 'odata.allow-entityreferences' was applied to the processing.
-   * @param {boolean} value whether the preference has been applied
-   */
-  setOdataAllowEntityReferencesApplied (value) {
-    this._odataAllowEntityReferencesApplied = value
-  }
-
-  /**
-   * Returns true if Preference "odata.callback" is set.
-   * @returns {boolean} whether the preference has been applied
-   * @package
-   */
-  getOdataCallbackApplied () {
-    return this._odataCallbackApplied
-  }
-
-  /**
-   * Set to true if the Preference 'odata.callback' was applied to the processing.
-   * @param {boolean} value whether the preference has been applied
-   */
-  setOdataCallbackApplied (value) {
-    this._odataCallbackApplied = value
-  }
-
-  /**
-   * Returns true if Preference "odata.continue-on-error" is set.
-   * @returns {boolean} whether the preference has been applied
-   * @package
-   */
-  getOdataContinueOnErrorApplied () {
-    return this._odataContinueOnErrorApplied
-  }
-
-  /**
-   * Set to true if the Preference 'odata.continue-on-error' was applied to the processing.
-   * @param {boolean} value whether the preference has been applied
-   */
-  setOdataContinueOnErrorApplied (value) {
-    this._odataContinueOnErrorApplied = value
-  }
-
-  /**
-   * Returns the annotations list in "odata.include-annotations".
-   * @returns {*} the applied annotations list
-   * @package
-   */
-  getOdataIncludeAnnotationsApplied () {
-    return this._odataIncludeAnnotationsApplied
-  }
-
-  /**
-   * Set to to the actually applied annotations if the Preference 'odata.include-annotations' was applied to the processing.
-   * @param {*} value the applied annotations
-   */
-  setOdataIncludeAnnotationsApplied (value) {
-    this._odataIncludeAnnotationsApplied = value
-  }
-
-  /**
-   * Returns the number set in Preference "odata.maxpagesize=<number>".
-   * @returns {?number} the applied page size
-   * @package
-   */
-  getOdataMaxPageSizeApplied () {
-    return this._odataMaxPageSizeApplied
-  }
-
-  /**
-   * Set to actually applied maxPageSize if the Preference 'odata.maxpagesize' was applied to the processing.
-   * @param {?number} value the applied page size
-   */
-  setOdataMaxPageSizeApplied (value) {
-    this._odataMaxPageSizeApplied = value
-  }
-
-  /**
-   * Returns true if Preference "odata.track-changes" is set.
-   * @returns {boolean} whether the preference has been applied
-   * @package
-   */
-  getOdataTrackChangesApplied () {
-    return this._odataTrackChangesApplied
-  }
-
-  /**
-   * Set to true if the Preference 'odata.track-changes' was applied to the processing.
-   * @param {boolean} value whether the preference has been applied
-   */
-  setOdataTrackChangesApplied (value) {
-    this._odataTrackChangesApplied = value
-  }
-
-  /**
-   * Returns the ReturnName set in Preference "return=<Preferences.ReturnValues>".
-   * @returns {string} the applied return value
-   * @package
-   */
-  getReturnApplied () {
-    return this._returnApplied
-  }
-
-  /**
-   * Set to the actually applied value of the Preference 'return', if it was applied to the processing.
-   * @param {?Preferences.ReturnValues} value the applied return value
-   */
-  setReturnApplied (value) {
-    this._returnApplied = value
-  }
-
-  /**
-   * Returns true if Preference "respond-async" is set.
-   * @returns {boolean} whether the preference has been applied
-   * @package
-   */
-  getRespondAsyncApplied () {
-    return this._respondAsyncApplied
-  }
-
-  /**
-   * Set to true if the Preference 'respond-async' was applied to the processing.
-   * @param {boolean} value whether the preference has been applied
-   */
-  setRespondAsyncApplied (value) {
-    this._respondAsyncApplied = value
-  }
-
-  /**
-   * Returns the number in Preference "wait=<number>"
-   * @returns {?number} the applied waiting time
-   * @package
-   */
-  getWaitApplied () {
-    return this._waitApplied
-  }
-
-  /**
-   * Set to actually applied value in the Preference 'wait', if it was applied to the processing.
-   * @param {?number} value the applied waiting time
-   */
-  setWaitApplied (value) {
-    this._waitApplied = value
-  }
-
-  /**
-   * Adds a applied custom preference to the custom preferences map.
-   * The key in the map is the name of the preference.
-   * @param {CustomPreference} customPreferenceName the applied custom Preference to add to the map.
-   * @param {string|boolean} [value] the actually applied value for the Preference. Defaults to true.
-   */
-  setCustomPreferenceApplied (customPreferenceName, value = true) {
-    this._customPreferencesApplied.set(customPreferenceName, value)
-  }
-
-  /**
-   * Returns the names and values of all applied custom preferences.
-   * @returns {Map} The map with all applied custom preferences and their corresponding values.
-   * @package
-   */
-  getCustomPreferencesApplied () {
-    return this._customPreferencesApplied
-  }
-}
-
-module.exports = PreferencesApplied

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/index.js

@@ -1,37 +0,0 @@
-'use strict'
-const cds = require('../../../../../cds')
-const TRACE = cds.debug('trace')
-TRACE?.time('require okra'.padEnd(22))
-
-const commons = require('../odata-commons')
-
-module.exports = {
-  FullQualifiedName: commons.FullQualifiedName,
-  edm: {
-    EdmTypeKind: commons.edm.EdmType.TypeKind,
-    EdmPrimitiveTypeKind: commons.edm.EdmPrimitiveTypeKind
-  },
-  uri: {
-    UriResource: commons.uri.UriResource,
-    Expression: commons.uri.Expression,
-    BinaryExpression: commons.uri.BinaryExpression,
-    UnaryExpression: commons.uri.UnaryExpression,
-    MethodExpression: commons.uri.MethodExpression,
-    Transformation: commons.uri.apply.Transformation,
-    BottomTopTransformation: commons.uri.apply.BottomTopTransformation,
-    AggregateExpression: commons.uri.apply.AggregateExpression
-  },
-  QueryOptions: commons.uri.UriInfo.QueryOptions,
-  HttpMethods: commons.http.HttpMethod.Methods,
-  HttpStatusCodes: commons.http.HttpStatusCode.StatusCodes,
-  PreferenceReturnValues: commons.http.Preferences.ReturnValues,
-  ContentTypes: commons.format.ContentTypeInfo.ContentTypes,
-  RepresentationKinds: commons.format.RepresentationKind.Kinds,
-
-  ServiceFactory: require('./ServiceFactory'), // eslint-disable-line global-require
-  ApplicationError: require('./errors/ApplicationError'), // eslint-disable-line global-require
-  Components: require('./core/ComponentManager').Components, // eslint-disable-line global-require
-  BatchExitHandler: require('./batch/BatchExitHandler') // eslint-disable-line global-require
-}
-
-TRACE?.timeEnd('require okra'.padEnd(22))

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/Command.js

@@ -1,31 +0,0 @@
-'use strict'
-
-/**
- * The `next` callback to be called upon finish execution.
- * @callback Command~Next
- * @param {?Error} [error] An error if there is one or null if not
- */
-
-/**
- * Main abstract class for all commands.
- * @abstract
- */
-class Command {
-  /**
-   * Creates an instance of Command
-   * @param {Context} [context] The current odata context
-   */
-  constructor (context) {
-    this._context = context
-  }
-
-  /**
-   * Returns the current instance of the provided context.
-   * @returns {Context} The current instance of odata context
-   */
-  getContext () {
-    return this._context
-  }
-}
-
-module.exports = Command

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/CommandExecutor.js

@@ -1,94 +0,0 @@
-'use strict'
-
-const HttpStatusCode = require('../http/HttpStatusCode')
-
-/**
- * The CommandExecutor executes a chain of commands and handles possible errors.
- */
-class CommandExecutor {
-  /**
-   * Creates an instance of CommandExecutor.
-   * @param {LoggerFacade} logger the logger
-   * @param {?PerformanceMonitor} runTimeMeasurement the runtime-measurement instance
-   */
-  constructor (logger, runTimeMeasurement) {
-    this._logger = logger
-    this._runTimeMeasurement = runTimeMeasurement
-    this._error = null
-  }
-
-  /**
-   * Executes the command success chain and executes the error chain in case of an error in the success chain.
-   * @param {Array.<Array>} successCommands command chain (array of commands with their descriptions) to execute
-   * @param {Array.<Array>} failCommands command chain (array of commands with their descriptions) to execute in case of an error
-   * @param {?Error} initialError Error that occurred before initializing the command chain
-   * @param {Function} endCallback the function called at the end, with parameter error
-   */
-  execute (successCommands, failCommands, initialError, endCallback) {
-    const chainEndCallback = error => {
-      if (error) {
-        const statusCode = HttpStatusCode.resolveErrorStatusCode(null, null, error)
-        if (statusCode >= 400 && statusCode < 500) {
-          this._logger.warning(error)
-        } else {
-          this._logger.error(error)
-        }
-
-        if (failCommands) {
-          this._error = error
-          this._execute(failCommands, 0, endCallback)
-        } else {
-          endCallback(error)
-        }
-      } else {
-        endCallback()
-      }
-    }
-
-    // If the method was called with an initial error, only the error command chain will be executed
-    if (initialError) {
-      chainEndCallback(initialError)
-    } else {
-      this._execute(successCommands, 0, chainEndCallback)
-    }
-  }
-
-  /**
-   * Executes the command referenced by its index recursively. The execution is asynchronous.
-   * @param {Array.<Array>} commands command chain (array of commands with their descriptions) to execute recursively
-   * @param {number} index The current command index to execute
-   * @param {Function} callback called when chain ends or an error occurs
-   * @private
-   */
-  _execute (commands = [], index = 0, callback) {
-    const commandInfo = commands[index]
-    if (commandInfo) {
-      const command = commandInfo[0]
-      const description = commandInfo[1]
-
-      if (this._runTimeMeasurement && description) this._runTimeMeasurement.createChild(description).start()
-      try {
-        command.execute((err, mappedError) => {
-          if (this._error && mappedError) {
-            // The 'next(null, mappedError)' signature is used in case of an error listener
-            // where the listener can be used to map/exchange/wrap the original error.
-            this._error = mappedError
-          }
-          if (this._runTimeMeasurement && description) this._runTimeMeasurement.getChild(description).stop()
-          if (err) {
-            callback(err)
-          } else {
-            this._execute(commands, index + 1, callback)
-          }
-        }, this._error)
-      } catch (innerError) {
-        if (this._runTimeMeasurement && description) this._runTimeMeasurement.getChild(description).stop()
-        callback(innerError)
-      }
-    } else {
-      callback()
-    }
-  }
-}
-
-module.exports = CommandExecutor