@sap/cds 8.9.3 → 9.0.2

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

@@ -1,108 +0,0 @@
-'use strict'
-
-/**
- * Error that can be thrown by an application using the OData library.
- * It provides methods to set additional properties as defined in the OData format specifications
- * that are used elsewhere, e.g., by the error serializers, and are therefore not to be renamed.
- * @extends Error
- */
-class ApplicationError extends Error {
-  /**
-   * @param {string} message the error message
-   */
-  constructor (message) {
-    if (!message || typeof message !== 'string') throw new Error("Parameter 'message' must be a string")
-    super(message)
-
-    // Overwrite the JavaScript standard Error property 'name'.
-    this.name = 'ApplicationError'
-  }
-
-  /**
-   * Sets the root error if there is any.
-   * @param {?Error} rootCause the root cause
-   * @returns {ApplicationError} this instance
-   */
-  setRootCause (rootCause) {
-    if (rootCause && !(rootCause instanceof Error)) {
-      throw new Error("Parameter 'rootCause' must be an instance of Error")
-    }
-    this._rootCause = rootCause
-    return this
-  }
-
-  /**
-   * @returns {?Error} the root cause
-   */
-  getRootCause () {
-    return this._rootCause
-  }
-
-  /**
-   * Set the HTTP status code (default is 500 - Internal Server Error).
-   * @param {?(HttpStatusCode.StatusCodes|number)} statusCode the status code
-   * @returns {ApplicationError} this instance
-   */
-  setStatusCode (statusCode) {
-    if (statusCode && typeof statusCode !== 'number') throw new Error("Parameter 'statusCode' must be a number")
-    this.statusCode = statusCode
-    return this
-  }
-
-  /**
-   * Set the service-defined error code. This code serves as a sub-status for the HTTP error code.
-   * @param {?string} code the error code
-   * @returns {ApplicationError} this instance
-   */
-  setCode (code) {
-    if (code && typeof code !== 'string') throw new Error("Parameter 'code' must be a string")
-    this.code = code
-    return this
-  }
-
-  /**
-   * Set the target of this error (for example, the name of the property in error).
-   * @param {?string} target the target
-   * @returns {ApplicationError} this instance
-   */
-  setTarget (target) {
-    if (target && typeof target !== 'string') throw new Error("Parameter 'target' must be a string")
-    this.target = target
-    return this
-  }
-
-  /**
-   * Set additional details.
-   * @param {?Array.<{ message: string, code: ?string, target: ?string }>} details the details
-   * @returns {ApplicationError} this instance
-   */
-  setDetails (details) {
-    if (details) {
-      if (!Array.isArray(details)) throw new Error("Parameter 'details' must be an Array")
-      for (const d of details) {
-        if (typeof d !== 'object') throw new Error('Detail must be an Object')
-        if (!d.message || typeof d.message !== 'string') throw new Error('Detail message must be a string')
-        if (d.code && typeof d.code !== 'string') throw new Error('Detail code must be a string')
-        if (d.target && typeof d.target !== 'string') throw new Error('Detail target must be a string')
-      }
-    }
-    this.details = details
-    return this
-  }
-
-  /**
-   * Add an annotation to this error (for example, a severity classification).
-   * @param {string} annotation the annotation in the form '@<namespace>.<term>'
-   * @param {*} value the value of the annotation
-   * @returns {ApplicationError} this instance
-   */
-  addAnnotation (annotation, value) {
-    if (typeof annotation !== 'string') throw new Error("Parameter 'annotation' must be a string")
-    if (!annotation.startsWith('@')) throw new Error("Parameter 'annotation' must start with '@'")
-    if (!annotation.includes('.')) throw new Error("Parameter 'annotation' must contain a '.'")
-    this[annotation] = value
-    return this
-  }
-}
-
-module.exports = ApplicationError

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

@@ -1,21 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-/**
- * Client error: the request is not well-formed.
- * @extends AbstractError
- */
-class BadRequestError extends AbstractError {
-  /**
-   * Creates an instance of BadRequestError.
-   * If an error message is not provided, the default message would be 'Bad request'.
-   * @param {string} message The error message
-   * @param {Error} rootCause the root cause
-   */
-  constructor (message = 'Bad request', rootCause) {
-    super(AbstractError.ErrorNames.BAD_REQUEST, message, rootCause)
-  }
-}
-
-module.exports = BadRequestError

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

@@ -1,11 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-class ConflictError extends AbstractError {
-  constructor (message) {
-    super(AbstractError.ErrorNames.CONFLICT, message || 'Conflict')
-  }
-}
-
-module.exports = ConflictError

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

@@ -1,19 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-/**
- * This class is used to represent a deserialization-related error.
- * @extends AbstractError
- */
-class DeserializationError extends AbstractError {
-  /**
-   * @param {string} message the error message
-   * @param {Error} [rootCause] the root cause
-   */
-  constructor (message, rootCause) {
-    super(AbstractError.ErrorNames.DESERIALIZATION, message, rootCause)
-  }
-}
-
-module.exports = DeserializationError

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

@@ -1,20 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-/**
- * @extends AbstractError
- */
-class InternalServerError extends AbstractError {
-  /**
-   * Creates an instance of InternalServerError.
-   * If an error message is not provided, the default message would be 'Internal server error'.
-   *
-   * @param {string} message The error message
-   */
-  constructor (message = 'Internal server error') {
-    super(AbstractError.ErrorNames.INTERNAL_SERVER_ERROR, message)
-  }
-}
-
-module.exports = InternalServerError

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

@@ -1,17 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-/**
- * @extends AbstractError
- */
-class MethodNotAllowedError extends AbstractError {
-  /**
-   * @param {string} [message] the error message
-   */
-  constructor (message) {
-    super(AbstractError.ErrorNames.METHOD_NOT_ALLOWED, message || 'Method not allowed')
-  }
-}
-
-module.exports = MethodNotAllowedError

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

@@ -1,21 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-/**
- * @extends AbstractError
- */
-class NotAcceptableError extends AbstractError {
-  /**
-   * @param {string} message the error message
-   */
-  constructor (message) {
-    super(AbstractError.ErrorNames.NOT_ACCEPTABLE, message)
-  }
-
-  static createForInacceptableContentType (requestedContentType) {
-    return new NotAcceptableError(`The requested content-type '${requestedContentType}' is not acceptable`)
-  }
-}
-
-module.exports = NotAcceptableError

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

@@ -1,33 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-/**
- * @extends AbstractError
- */
-class NotFoundError extends AbstractError {
-  /**
-   * Creates an instance of  NotFoundError. The error message would be
-   * "Resource '<resourceIdentifier>' could not be found". The param for resourceIdentifier
-   * should be the name of the resource which could not be found.
-   *
-   * @param {string} resourceIdentifier The not found resource identifier.
-   * @returns {NotFoundError} a new instance
-   */
-  static createForMissingResource (resourceIdentifier) {
-    let msg = `Resource '${resourceIdentifier}' could not be found`
-    return new NotFoundError(msg)
-  }
-
-  /**
-   * Creates an instance of NotFoundError.
-   * If an error message is not provided, the default message would be 'Resource not found'.
-   *
-   * @param {string} message The error message
-   */
-  constructor (message = 'Resource not found') {
-    super(AbstractError.ErrorNames.NOT_FOUND, message)
-  }
-}
-
-module.exports = NotFoundError

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

@@ -1,11 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-class PreconditionFailedError extends AbstractError {
-  constructor (message) {
-    super(AbstractError.ErrorNames.PRECONDITION_FAILED_ERROR, message || 'Precondition failed')
-  }
-}
-
-module.exports = PreconditionFailedError

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

@@ -1,11 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-class PreconditionRequiredError extends AbstractError {
-  constructor (message) {
-    super(AbstractError.ErrorNames.PRECONDITION_REQUIRED_ERROR, message || 'Precondition required')
-  }
-}
-
-module.exports = PreconditionRequiredError

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

@@ -1,19 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-/**
- * This class is used to represent a serialization-related error.
- * @extends AbstractError
- */
-class SerializationError extends AbstractError {
-  /**
-   * @param {string} message the error message
-   * @param {Error} rootCause the root cause
-   */
-  constructor (message, rootCause) {
-    super(AbstractError.ErrorNames.SERIALIZATION, message, rootCause)
-  }
-}
-
-module.exports = SerializationError

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

@@ -1,17 +0,0 @@
-'use strict'
-
-const AbstractError = require('../../odata-commons').errors.AbstractError
-
-/**
- * @extends AbstractError
- */
-class UnauthorizedError extends AbstractError {
-  /**
-   * @param {string} [message] the error message
-   */
-  constructor (message) {
-    super(AbstractError.ErrorNames.NOT_AUTHORIZED, message || 'Unauthorized')
-  }
-}
-
-module.exports = UnauthorizedError

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

@@ -1,86 +0,0 @@
-'use strict'
-
-const ContentTypeInfo = require('../../odata-commons').format.ContentTypeInfo
-
-/**
- * Used to store the parts of an accept type.
- * @extends ContentTypeInfo
- * @hideconstructor
- */
-class AcceptTypeInfo extends ContentTypeInfo {
-  /**
-   * Constructor
-   * @param {string} typeAndSubtype Mime type and subtype
-   */
-  constructor (typeAndSubtype) {
-    super()
-    super.setMimeType(typeAndSubtype)
-
-    /**
-     * @type {number}
-     * @private
-     */
-    this._quality = 1
-  }
-
-  /**
-   * Set the quality.
-   * @param {number} quality the quality
-   * @returns {AcceptTypeInfo} this instance
-   * @package
-   */
-  setQuality (quality) {
-    this._quality = quality
-    return this
-  }
-
-  /**
-   * Return the quality.
-   * @returns {number} quality
-   */
-  getQuality () {
-    return this._quality
-  }
-
-  toString () {
-    return super.toString() + (this._quality < 1 ? ';q=' + this._quality : '')
-  }
-
-  /**
-   * Return true if the given MIME type is matched by this instance's MIME type
-   * (which can contain '*'), false otherwise.
-   * @param {string} mimeType the MIME type to match
-   * @returns {boolean} whether the MIME type is matched
-   */
-  match (mimeType) {
-    const m = this.getMimeType()
-    if (m.startsWith('*')) return true
-    if (m.endsWith('*')) return m.substring(0, m.indexOf('/')) === mimeType.substring(0, mimeType.indexOf('/'))
-    return m === mimeType
-  }
-
-  /**
-   * Return a number indicating how two AcceptTypeInfo instances compare to each other
-   * according to the sort order determined by quality-parameter value and specificity
-   * (defined in RFC 7231, chapters 3.1.1.1, 5.3.1, and 5.3.2) as:
-   * a negative value if a comes before b;
-   * a positive value if a comes after b;
-   * 0 if they are considered equal.
-   * @param {AcceptTypeInfo} a first instance
-   * @param {AcceptTypeInfo} b second instance
-   * @returns {number} the comparison result (-1, 0, or 1)
-   */
-  static compare (a, b) {
-    if (a.getQuality() !== b.getQuality()) return b.getQuality() - a.getQuality()
-    // '^' is XOR in JavaScript.
-    if (a.getMimeType().startsWith('*') ^ b.getMimeType().startsWith('*')) {
-      return a.getMimeType().startsWith('*') ? 1 : -1
-    }
-    if (a.getMimeType().endsWith('*') ^ b.getMimeType().endsWith('*')) {
-      return a.getMimeType().endsWith('*') ? 1 : -1
-    }
-    return b.getParameters().length - a.getParameters().length
-  }
-}
-
-module.exports = AcceptTypeInfo

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

@@ -1,76 +0,0 @@
-'use strict'
-
-const CHARSETS = {
-  UTF_8: 'utf-8',
-  ALL: '*'
-}
-
-class CharsetInfo {
-  /**
-   * Used to store parts of the Accept-Charset Header
-   * @param {string} charset the character set
-   */
-  constructor (charset) {
-    this._charset = charset
-    this._quality = 1
-  }
-
-  /**
-   * Set the quality.
-   * @param {number} quality the quality
-   * @returns {CharsetInfo} this instance
-   * @package
-   */
-  setQuality (quality) {
-    this._quality = quality
-    return this
-  }
-
-  /**
-   * Return the quality.
-   * @returns {number} quality
-   * @package
-   */
-  getQuality () {
-    return this._quality
-  }
-
-  /**
-   * Set the charset.
-   * @param {string} charset character set
-   * @returns {CharsetInfo} this instance
-   */
-  setCharset (charset) {
-    this._charset = charset
-    return this
-  }
-
-  /**
-   * Return the charset.
-   * @returns {string} the character set
-   * @package
-   */
-  getCharset () {
-    return this._charset
-  }
-
-  /**
-   * Returns if all Charsets are supported.
-   * @returns {boolean} whether all character sets are supported
-   */
-  isAll () {
-    return this._charset.toLowerCase() === CHARSETS.ALL
-  }
-
-  /**
-   * Returns if the charset is supported.
-   * @returns {boolean} whether the character set is supported
-   */
-  isSupported () {
-    return this.isAll() || this._charset.toLowerCase() === CHARSETS.UTF_8
-  }
-}
-
-CharsetInfo.CHARSETS = CHARSETS
-
-module.exports = CharsetInfo

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

@@ -1,43 +0,0 @@
-'use strict'
-
-/**
- * Container for content type, serializer function, and parameter-check function.
- */
-class FormatDescription {
-  /**
-   * @param {ContentTypeInfo.ContentTypes} typeAndSubType Type and Subtype (e.g. application/json)
-   * @param {Function} serializerFunction Serializer
-   * @param {?Function} parameterCheckFunction the function to check the format parameters
-   */
-  constructor (typeAndSubType, serializerFunction, parameterCheckFunction) {
-    this._typeAndSubType = typeAndSubType
-    this._serializerFunction = serializerFunction
-    this._parameterCheckFunction = parameterCheckFunction
-  }
-
-  /**
-   * Return type and subtype (e.g. application/json).
-   * @returns {ContentTypeInfo.ContentTypes} the type and the subtype
-   */
-  getTypeAndSubtype () {
-    return this._typeAndSubType
-  }
-
-  /**
-   * Returns the serializer function.
-   * @returns {Function} the serializer
-   */
-  getSerializerFunction () {
-    return this._serializerFunction
-  }
-
-  /**
-   * Returns the parameter-check function
-   * @returns {?Function} the parameter-check function
-   */
-  getParameterCheckFunction () {
-    return this._parameterCheckFunction
-  }
-}
-
-module.exports = FormatDescription

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

@@ -1,91 +0,0 @@
-'use strict'
-
-const RepresentationKinds = require('../../odata-commons').format.RepresentationKind.Kinds
-const FormatDescription = require('./FormatDescription')
-
-/**
- * The FormatManager manages all formats which are supported by a odata service. A format consists of
- * - a representation kind which defines what kind of OData representation can be serialized
- * - a content type defining type and subtype
- * - a serializer function
- * - a parameter-check function to check whether the serializer function supports the given content-type parameters
- */
-class FormatManager {
-  /**
-   * Creates an instance of FormatManager.
-   */
-  constructor () {
-    /**
-     * Stores all format mappings for all representation kinds.
-     * @type {Map.<RepresentationKind.Kinds, FormatDescription[]>}
-     * @private
-     */
-    this._representationKindHandlers = new Map()
-  }
-
-  /**
-   * Registers a format description for later use.
-   * @param {RepresentationKind.Kinds} representationKind The corresponding representation kind
-   * @param {ContentTypeInfo.ContentTypes} contentType The corresponding content type
-   * @param {Function} serializerFunction The serializer function to register
-   * @param {?Function} parameterCheckFunction the function to check the format parameters
-   * @returns {FormatManager} Self reference
-   */
-  use (representationKind, contentType, serializerFunction, parameterCheckFunction = () => true) {
-    const formatDescription = new FormatDescription(contentType, serializerFunction, parameterCheckFunction)
-    let representationKindFormatHandlers = this._representationKindHandlers.get(representationKind)
-    if (representationKindFormatHandlers) {
-      representationKindFormatHandlers.unshift(formatDescription)
-    } else {
-      this._representationKindHandlers.set(representationKind, [formatDescription])
-    }
-    return this
-  }
-
-  /**
-   * Returns the format descriptions for a known representation kind.
-   * If that is unknown or no serializer is registered, an empty array will be returned.
-   *
-   * @param {RepresentationKind.Kinds} representationKind Representation kind
-   * @returns {FormatDescription[]} the registered format descriptions
-   */
-  getAllFormatDescriptions (representationKind) {
-    return this._representationKindHandlers.get(representationKind) || []
-  }
-
-  /**
-   * Returns the format descriptions for a known representation kind and content-type combination.
-   * If that is unknown or no serializer is registered, an empty array will be returned.
-   *
-   * @param {RepresentationKind.Kinds} representationKind Representation kind
-   * @param {ContentTypeInfo.ContentTypes} contentType Content type
-   * @returns {FormatDescription[]} the registered format descriptions
-   */
-  getFormatDescriptions (representationKind, contentType) {
-    return this.getAllFormatDescriptions(representationKind).filter(
-      formatDescription => formatDescription.getTypeAndSubtype() === contentType
-    )
-  }
-
-  /**
-   * Returns the serializer function for representation kind ERROR {@see RepresentationKind.Kinds.ERROR}
-   *
-   * @param {ContentTypeInfo.ContentTypes} contentType Content type
-   * @returns {Function} Returns the registered component
-   */
-  getErrorSerializer (contentType) {
-    return this.getFormatDescriptions(RepresentationKinds.ERROR, contentType)[0].getSerializerFunction()
-  }
-
-  /**
-   * Returns the debug serializer function for representation kind DEBUG {@see RepresentationKind.Kinds.DEBUG}
-   *
-   * @param {ContentTypeInfo.ContentTypes} contentType Content type
-   * @returns {Function} Returns the registered component
-   */
-  getDebugSerializer (contentType) {
-    return this.getFormatDescriptions(RepresentationKinds.DEBUG, contentType)[0].getSerializerFunction()
-  }
-}
-
-module.exports = FormatManager

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

@@ -1,62 +0,0 @@
-'use strict'
-
-const commons = require('../../odata-commons')
-const RepresentationKind = commons.format.RepresentationKind
-const RepresentationKinds = RepresentationKind.Kinds
-const HttpHeader = commons.http.HttpHeader
-const HeaderNames = HttpHeader.HeaderNames
-const DeserializationError = require('../errors/DeserializationError')
-
-/**
- * Negotiates the request payload type for the provided request.
- */
-class RequestContentNegotiator {
-  /**
-   * Negotiates the deserializer function in dependency of the request type and sets the result
-   * to the request contract.
-   *
-   * @param {FormatManager} bodyParserManager The format manager holding the deserializing function
-   * @param {OdataRequest} request The current odata request
-   * @returns {RequestContract} Returns the contract with attached deserializer facade
-   */
-  negotiate (bodyParserManager, request) {
-    const representationKind = RepresentationKind.getRequestRepresentationKind(
-      request.getUriInfo(),
-      request.getMethod()
-    )
-    let contract = request.getContract()
-    contract.setRepresentationKind(representationKind)
-
-    if (representationKind !== RepresentationKinds.NO_CONTENT) {
-      try {
-        contract.setContentTypeInfo(
-          HttpHeader.parseContentTypeHeader(request.getHeader(HeaderNames.CONTENT_TYPE.toLowerCase()))
-        )
-      } catch (error) {
-        throw new DeserializationError(
-          'Invalid value "' +
-            request.getHeader(HeaderNames.CONTENT_TYPE.toLowerCase()) +
-            '" in ' +
-            HeaderNames.CONTENT_TYPE.toLowerCase() +
-            ' header',
-          error
-        )
-      }
-    }
-
-    if (contract.getContentTypeInfo()) {
-      const mimeType = contract.getContentTypeInfo().getMimeType()
-      let formatDescriptions = bodyParserManager.getFormatDescriptions(representationKind, mimeType)
-      // If a binary is sent and no specific deserializer is found,
-      // use the deserializer registered for the empty-string content type.
-      if (!formatDescriptions.length && representationKind === RepresentationKinds.BINARY) {
-        formatDescriptions = bodyParserManager.getFormatDescriptions(representationKind, '')
-      }
-      contract.setDeserializerFunction(formatDescriptions.length ? formatDescriptions[0].getSerializerFunction() : null)
-    }
-
-    return contract
-  }
-}
-
-module.exports = RequestContentNegotiator