@sap/cds 8.9.3 → 9.0.2

package/libx/_runtime/cds-services/adapter/odata-v4/odata-to-cqn/utils.js

@@ -1,217 +0,0 @@
-const { getFeatureNotSupportedError } = require('../../../util/errors')
-const { resolveStructuredName } = require('../utils/handlerUtils')
-const { findCsnTargetFor } = require('../../../../common/utils/csn')
-
-const addLimit = (item, rows, offset) => {
-  // ignore 0 offset -> truthy check
-  if (rows != null || offset) {
-    if (!item.limit) {
-      item.limit = {}
-    }
-    if (rows != null) {
-      item.limit.rows = { val: rows }
-    }
-    if (offset) {
-      item.limit.offset = { val: offset }
-    }
-  }
-}
-
-const _isNum = type => {
-  const nums = {
-    'Edm.Byte': 1,
-    'Edm.Int16': 1,
-    'Edm.Int32': 1,
-    'Edm.Double': 1
-  }
-
-  return type.toString() in nums
-}
-
-const _isBigNum = type => {
-  const bigNums = {
-    'Edm.Int64': 1,
-    'Edm.Decimal': 1
-  }
-
-  return type.toString() in bigNums
-}
-
-const _getValue = (value, type) => {
-  if (_isNum(type)) return Number(value)
-  if (_isBigNum(type)) {
-    const num = Number(value)
-    return Number.isSafeInteger(num) ? num : value
-  }
-  if (type === 'Edm.Boolean') return value === 'true'
-  return value
-}
-
-const convertKeyPredicatesToWhere = keyPredicates => {
-  const where = []
-  if (keyPredicates.length) {
-    keyPredicates.forEach(kp => {
-      if (where.length) where.push('and')
-      const keyName = kp.getEdmRef().getName().replace(/\//g, '.')
-      const type = kp.getEdmRef().getProperty().getType()
-      let keyValue = _getValue(kp.getText(), type.toString())
-      where.push({ ref: [keyName] }, '=', { val: keyValue })
-    })
-  }
-
-  return where
-}
-
-const convertUrlPathToCqn = (segments, service) => {
-  return segments
-    .filter(
-      segment =>
-        segment.getKind() !== 'COUNT' && segment.getKind() !== 'PRIMITIVE.PROPERTY' && segment.getKind() !== 'VALUE'
-    )
-    .reduce((expr, segment) => {
-      if (segment.getKind() === 'ENTITY' || segment.getKind() === 'ENTITY.COLLECTION') {
-        const entity = segment.getEntitySet().getEntityType().getFullQualifiedName()
-        const where = convertKeyPredicatesToWhere(segment.getKeyPredicates())
-        let ref
-        if (where.length) {
-          ref = { ref: [{ id: findCsnTargetFor(entity.name, service.model, service.namespace).name, where }] }
-        } else {
-          ref = { ref: [findCsnTargetFor(entity.name, service.model, service.namespace).name] }
-        }
-        return ref
-      }
-
-      if (segment.getKind() === 'SINGLETON') {
-        const singleton = segment.getSingleton().getEntityType().getFullQualifiedName()
-        return { ref: [findCsnTargetFor(singleton.name, service.model, service.namespace).name] }
-      }
-
-      if (segment.getKind() === 'COMPLEX.PROPERTY') {
-        expr.ref.push(segment.getProperty().getName())
-        return expr
-      }
-
-      const where = convertKeyPredicatesToWhere(segment.getKeyPredicates())
-      let ref
-      if (where.length) {
-        ref = { id: segment.getNavigationProperty().getName(), where }
-      } else {
-        ref = segment.getNavigationProperty().getName()
-      }
-
-      if (!expr.ref) expr.ref = []
-      expr.ref.push(ref)
-      return expr
-    }, {})
-}
-
-const convertUrlPathToViewCqn = segments => {
-  const args = segments[0].getKeyPredicates().reduce((prev, curr) => {
-    const { keyName, val } = getSegmentKeyValue(curr)
-    prev[keyName.replace(/\//g, '_')] = { val }
-    return prev
-  }, {})
-
-  // REVISIT: Replace .getFullQualifiedName().toString() with findCsnTargetFor as done in convertUrlPathToCqn
-  return {
-    ref: [
-      {
-        id: segments[0]
-          .getEntitySet()
-          .getEntityType()
-          .getFullQualifiedName()
-          .toString()
-          .replace(/Parameters$/, ''),
-        args
-      }
-    ]
-  }
-}
-
-const getPropertyParam = segments => {
-  const index = segments[segments.length - 1].getKind() === 1 ? 2 : 1
-  const prop = segments[segments.length - index].getProperty()
-  const name = prop && prop.getName()
-  return (
-    name &&
-    (segments.length > 1 ? { ref: resolveStructuredName(segments, segments.length - 2, [name]) } : { ref: [name] })
-  )
-}
-
-const isSameArray = (arr1, arr2) => {
-  return arr1.length === arr2.length && arr1.every((element, index) => element === arr2[index])
-}
-
-const _getStructKeys = (key, prefix, joinStructured) => {
-  const structKeys = []
-  for (const keyName in key.elements) {
-    const keyElement = key.elements[keyName]
-    if (keyElement._isStructured) {
-      structKeys.push(..._getStructKeys(keyElement, [...prefix, keyName], joinStructured))
-      continue
-    }
-    if (keyElement.isAssociation) continue
-    const newKey = joinStructured ? [...prefix, keyName].join('_') : [...prefix, keyName]
-    structKeys.push(newKey)
-  }
-  return structKeys
-}
-
-const getAllKeys = (entity, joinStructured = true) => {
-  const allKeys = []
-  if (entity && entity.elements) {
-    // in elements because of aspects
-    for (const keyName in entity.elements) {
-      const key = entity.elements[keyName]
-      if (!key.key || key.isAssociation || key.isComposition) continue
-      if (key._isStructured) allKeys.push(..._getStructKeys(key, [keyName], joinStructured))
-      else allKeys.push(keyName)
-    }
-  }
-  return allKeys
-}
-
-const isPathSupported = (supported, pathSegments) => {
-  for (const segment of pathSegments) {
-    if (!supported[segment.getKind()]) {
-      throw getFeatureNotSupportedError(`Request parameter "${segment.getKind()}"`)
-    }
-  }
-}
-
-const _parsePrimitiveValue = (edmRef, value) => {
-  const typeName = edmRef.getProperty ? edmRef.getProperty().getType().getName() : edmRef.getType().getName()
-  return typeName.startsWith('Int') ? Number(value) : typeName === 'Boolean' ? value === 'true' : value
-}
-
-const getSegmentKeyValue = segmentParam => {
-  const edmRef = segmentParam.getEdmRef()
-  const keyName = edmRef.getName()
-  let val
-  if (segmentParam.getAliasValue()) {
-    const value = segmentParam.getAliasValue()
-    // must be JSON  or a string according to
-    // https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html#sec_ComplexandCollectionLiterals
-    try {
-      val = value === 'undefined' ? undefined : JSON.parse(value)
-      return { keyName, val }
-    } catch {
-      // plain string
-    }
-    val = _parsePrimitiveValue(edmRef, value) //> REVISIT: undefined handling needed here as well?
-    return { keyName, val }
-  }
-  val = segmentParam.getText() === undefined ? undefined : _parsePrimitiveValue(edmRef, segmentParam.getText())
-  return { keyName, val }
-}
-
-module.exports = {
-  addLimit,
-  convertUrlPathToCqn,
-  convertUrlPathToViewCqn,
-  isSameArray,
-  getAllKeys,
-  isPathSupported,
-  getSegmentKeyValue,
-  getPropertyParam
-}

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-commons/FeatureSupport.js

@@ -1,70 +0,0 @@
-'use strict'
-
-const util = require('util')
-const NotImplementedError = require('./errors/NotImplementedError')
-
-/**
- * Describes a feature.
- */
-class Feature {
-  /**
-   * Constructor
-   * @param {string} message Short text info of feature
-   */
-  constructor (message) {
-    /**
-     * Short text info of feature (used for error information)
-     * @type {string}
-     * @private
-     */
-    this._message = message
-  }
-}
-
-/**
- * List of not (fully) supported features
- * Example:
- * features.TypeCast --> TypeCasts as general features are not supported
- */
-const features = {
-  AttributeAbstract: new Feature('Entity and complex type attribute abstract is not supported'),
-  AttributeHasStream: new Feature('The attribute HasStream is not supported'),
-  AttributeOpenType: new Feature('Entity and complex type attribute opentype is not supported'),
-  AttributeUnicode: new Feature(
-    'The attribute Unicode with a false value is not supported',
-    'All properties must be set with a unicode character set'
-  ),
-
-  QueryParameterDeltatoken: new Feature('The system query parameter $deltatoken is not supported'),
-  QueryParameterId: new Feature('The system query parameter $id is not supported'),
-  QueryParameterSkipToken: new Feature(
-    'The system query parameter $skiptoken is only supported for entity- and reference-collections'
-  ),
-
-  CrossJoin: new Feature('Requests with $crossjoin are not supported'),
-  All: new Feature('Requests with $all are not supported'),
-  Entity_id: new Feature('Requests with $entity are not supported'),
-  TypeCast: new Feature("The typecast '%s' at position %d is not supported."),
-
-  Ref: new Feature('Requests with $ref in $expand are not supported'),
-  Levels: new Feature('The $expand option $levels is currently not supported')
-}
-
-/**
- * Facade allowing the various lib parts to reject requests for explicitly not supported features
- */
-class FeatureSupport {
-  /**
-   * Fail with an appropriate message.
-   * @param {Feature} feature the feature
-   * @param {Array} parameters the parameters for the error message
-   * @throws {NotImplementedError} the unsupported error
-   */
-  static failUnsupported (feature, ...parameters) {
-    throw new NotImplementedError(util.format(feature._message, ...parameters))
-  }
-}
-
-FeatureSupport.features = features
-
-module.exports = FeatureSupport

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-commons/FullQualifiedName.js

@@ -1,94 +0,0 @@
-'use strict'
-
-const validateThat = require('./validator/ParameterValidator').validateThat
-const IllegalArgumentError = require('./errors/IllegalArgumentError')
-
-/**
- * <a href="../ODataSpecification/odata-v4.0-errata03-os/complete/part3-csdl/odata-v4.0-errata03-os-part3-csdl-complete.html#_Toc453752676">
- *     OData CSDL # 17.3 QualifiedName
- * </a>
- */
-class FullQualifiedName {
-  /**
-   * @param {string} namespace - namespace or alias of the schema
-   * @param {string} name - name value
-   */
-  constructor (namespace, name) {
-    validateThat('namespace', namespace)
-      .truthy()
-      .typeOf('string')
-    validateThat('name', name)
-      .truthy()
-      .typeOf('string')
-
-    /** @type {string} */
-    this.namespace = namespace
-
-    /** @type {string} */
-    this.name = name
-  }
-
-  /**
-   * @returns {string} string representation of the full qualified name
-   */
-  toString () {
-    return this.namespace + '.' + this.name
-  }
-
-  /**
-   * Returns string representation of the input parameter, represented either as a
-   * FullQualifiedName instance or as an object having string properties 'namespace' and 'name'.
-   *
-   * @param {FullQualifiedName | {namespace: string, name: string}} fullQualifiedName - full
-   * qualified name, represented either as a FullQualifiedName instance or as an object having
-   * string 'namespace' and 'name' properties
-   *
-   * @returns {?string} string representation of the full qualified name or null, if null was specified as input
-   */
-  static getFQNAsString (fullQualifiedName) {
-    if (!fullQualifiedName) return null
-    return fullQualifiedName.namespace + '.' + fullQualifiedName.name
-  }
-
-  /**
-   * Creates FullQualifiedName instance from the specified full qualified name string.
-   * @param {string} namespaceAndName string representing a full qualified name, i.e., having namespace and name
-   *                                  separated by dot character
-   * @returns {FullQualifiedName} the created full-qualified name
-   */
-  static createFromNameSpaceAndName (namespaceAndName) {
-    validateThat('namespaceAndName', namespaceAndName)
-      .truthy()
-      .typeOf('string')
-
-    const dotIdx = namespaceAndName.lastIndexOf('.')
-
-    if (dotIdx === -1 || dotIdx === 0 || dotIdx === namespaceAndName.length - 1) {
-      throw IllegalArgumentError.createForMalformedValueFormat('namespaceAndName', '<namespace>.<name>')
-    }
-
-    return new FullQualifiedName(namespaceAndName.substring(0, dotIdx), namespaceAndName.substring(dotIdx + 1))
-  }
-
-  /**
-   * Compares two full qualified names.
-   * @param { FullQualifiedName | {namespace: string, name: string} } fullQualifiedName1 - first full qualified name
-   * @param { FullQualifiedName | {namespace: string, name: string} } fullQualifiedName2 - second full qualified name
-   * @returns {boolean} true if namespace and name of the first full qualified name are strictly equal to the
-   *                    namespace and name of the second full qualified name, otherwise false
-   */
-  static equals (fullQualifiedName1, fullQualifiedName2) {
-    if (typeof fullQualifiedName1 !== 'object' || typeof fullQualifiedName2 !== 'object') return false
-
-    if (!fullQualifiedName1 && !fullQualifiedName2) return true
-
-    if (!fullQualifiedName1 || !fullQualifiedName2) return false
-
-    return (
-      fullQualifiedName1.namespace === fullQualifiedName2.namespace &&
-      fullQualifiedName1.name === fullQualifiedName2.name
-    )
-  }
-}
-
-module.exports = FullQualifiedName

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-commons/csdl/CsdlAction.js

@@ -1,139 +0,0 @@
-'use strict'
-
-const validateThat = require('../validator/ParameterValidator').validateThat
-
-/**
- * <a href="./../ODataSpecification/odata-v4.0-errata03-os/complete/part3-csdl/odata-v4.0-errata03-os-part3-csdl-complete.html#_Toc453752579">
- *     OData CSDL # 12.1 Element edm:Action
- * </a>
- */
-class CsdlAction {
-  /**
-   * @param {string} name - OData CSDL # 12.1.1 Attribute Name
-   */
-  constructor (name) {
-    validateThat('name', name)
-      .truthy()
-      .typeOf('string')
-
-    /**
-     * OData CSDL # 12.1.1 Attribute Name.
-     * @type {string}
-     */
-    this.name = name
-
-    /**
-     * OData CSDL # 12.1.2 Attribute IsBound
-     * @type {boolean}
-     */
-    this.isBound = false
-
-    /**
-     * OData CSDL # 12.1.3 Attribute EntitySetPath
-     * @type {string}
-     */
-    this.entitySetPath = null
-
-    /**
-     * OData CSDL # 12.4 Element edm:Parameter
-     * @type {CsdlParameter[]}
-     */
-    this.parameters = []
-
-    /**
-     * OData CSDL # 12.3 Element edm:ReturnType
-     * @type {CsdlReturnType}
-     */
-    this.returnType = null
-
-    /**
-     * OData CSDL # 14.3 Element edm:Annotation
-     * @type {CsdlAnnotation[]}
-     */
-    this.annotations = []
-  }
-
-  /**
-   * Sets whether the action is a bound action.
-   * OData CSDL # 12.1.2 Attribute IsBound
-   *
-   * @param {boolean} isBound - indicates whether the action is a bound action
-   * @returns {CsdlAction} this instance
-   */
-  setBound (isBound) {
-    validateThat('isBound', isBound)
-      .notNullNorUndefined()
-      .typeOf('boolean')
-
-    this.isBound = isBound
-    return this
-  }
-
-  /**
-   * Sets entity set path.
-   * OData CSDL # 12.1.3 Attribute EntitySetPath
-   *
-   * @param {string} entitySetPath - entity set path for the action
-   * @returns {CsdlAction} this instance
-   */
-  setEntitySetPath (entitySetPath) {
-    validateThat('entitySetPath', entitySetPath)
-      .truthy()
-      .typeOf('string')
-
-    this.entitySetPath = entitySetPath
-    return this
-  }
-
-  /**
-   * Sets parameters for the action.
-   * OData CSDL # 12.4 Element edm:Parameter
-   *
-   * @param {CsdlParameter[]} parameters - action parameters
-   * @returns {CsdlAction} this instance
-   */
-  setParameters (parameters) {
-    validateThat('parameters', parameters)
-      .notNullNorUndefined()
-      .array()
-      .containsInstancesOf(Object)
-
-    this.parameters = parameters
-    return this
-  }
-
-  /**
-   * Sets return type of the action.
-   * OData CSDL # 12.3 Element edm:ReturnType
-   *
-   * @param {CsdlReturnType} returnType - return type of the action
-   * @returns {CsdlAction} this instance
-   */
-  setReturnType (returnType) {
-    validateThat('returnType', returnType)
-      .truthy()
-      .instanceOf(Object)
-
-    this.returnType = returnType
-    return this
-  }
-
-  /**
-   * Sets a list of annotations for the action.
-   * OData CSDL # 14.3 Element edm:Annotation
-   *
-   * @param {CsdlAnnotation[]} annotations - annotations for the action
-   * @returns {CsdlAction} this instance
-   */
-  setAnnotations (annotations) {
-    validateThat('annotations', annotations)
-      .notNullNorUndefined()
-      .array()
-      .containsInstancesOf(Object)
-
-    this.annotations = annotations
-    return this
-  }
-}
-
-module.exports = CsdlAction

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-commons/csdl/CsdlActionImport.js

@@ -1,82 +0,0 @@
-'use strict'
-
-const validateThat = require('../validator/ParameterValidator').validateThat
-
-/**
- * <a href="./../ODataSpecification/odata-v4.0-errata03-os/complete/part3-csdl/odata-v4.0-errata03-os-part3-csdl-complete.html#_Toc453752610">
- *     OData CSDL # 13.5 Element edm:ActionImport
- * </a>
- */
-class CsdlActionImport {
-  /**
-   * @param {string} name - OData CSDL # 13.5.1 Attribute Name
-   * @param {FullQualifiedName} action - OData CSDL # 13.5.2 Attribute Action
-   */
-  constructor (name, action) {
-    validateThat('name', name)
-      .truthy()
-      .typeOf('string')
-    validateThat('action', action)
-      .truthy()
-      .instanceOf(Object)
-
-    /**
-     * OData CSDL # 13.5.1 Attribute Name
-     * @type {string}
-     */
-    this.name = name
-
-    /**
-     * OData CSDL # 13.5.2 Attribute Action
-     * @type {FullQualifiedName}
-     */
-    this.action = action
-
-    /**
-     * OData CSDL # 13.5.3 Attribute EntitySet
-     * @type {string}
-     */
-    this.entitySet = null
-
-    /**
-     * OData CSDL # 14.3 Element edm:Annotation
-     * @type {CsdlAnnotation[]}
-     */
-    this.annotations = []
-  }
-
-  /**
-   * Sets entity set for the action import.
-   * OData CSDL # 13.5.3 Attribute EntitySet
-   *
-   * @param {string} entitySet - name of the entity set for the action import
-   * @returns {CsdlActionImport} this instance
-   */
-  setEntitySet (entitySet) {
-    validateThat('entitySet', entitySet)
-      .truthy()
-      .typeOf('string')
-
-    this.entitySet = entitySet
-    return this
-  }
-
-  /**
-   * Sets a list of annotations
-   * OData CSDL # 14.3 Element edm:Annotation
-   *
-   * @param {CsdlAnnotation[]} annotations - annotations for the action import
-   * @returns {CsdlActionImport} this instance
-   */
-  setAnnotations (annotations) {
-    validateThat('annotations', annotations)
-      .notNullNorUndefined()
-      .array()
-      .containsInstancesOf(Object)
-
-    this.annotations = annotations
-    return this
-  }
-}
-
-module.exports = CsdlActionImport

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-commons/csdl/CsdlAliasInfo.js

@@ -1,44 +0,0 @@
-'use strict'
-
-const validateThat = require('../validator/ParameterValidator').validateThat
-
-/**
- * This class represents the mapping between a namespace and the corresponding alias.
- */
-class CsdlAliasInfo {
-  /**
-   * @param {string} namespace - namespace value
-   * @param {string} alias - alias value for the namespace
-   */
-  constructor (namespace, alias) {
-    validateThat('namespace', namespace)
-      .truthy()
-      .typeOf('string')
-    validateThat('alias', alias)
-      .truthy()
-      .typeOf('string')
-
-    /**
-     * Namespace, which the alias corresponds to
-     * @type {string}
-     */
-    this.namespace = namespace
-
-    /**
-     * Alias value for the namespace
-     * @type {string}
-     */
-    this.alias = alias
-  }
-
-  /**
-   * Returns the full qualified name of this alias.
-   *
-   * @returns {string} The full qualified name
-   */
-  toString () {
-    return this.namespace + '.' + this.alias
-  }
-}
-
-module.exports = CsdlAliasInfo