@sap_oss/odata-library/lib/model/oasis/annotations/Annotation.js

OData client for testing Netweawer OData services.

"use strict";

const _ = require("lodash");

function createBasicProperties(annotation, rawMetadata) {
  Object.defineProperty(annotation, "raw", {
    get: () => rawMetadata,
  });

  Object.defineProperty(annotation, "term", {
    get: () => rawMetadata.$.Term,
  });

  Object.defineProperty(annotation, "qualifier", {
    get: () => rawMetadata.$.Qualifier,
  });

  if (!annotation.term) {
    throw new Error("Annotation must contain attribute Term.");
  }
}

/**
 * Envelops an annotation. (OASIS-CSDL)
 *
 * http://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/cs01/odata-csdl-xml-v4.01-cs01.html#sec_Annotation
 *
 * MC-CSDL has different concept (TypeAnnotation and ValueAnnotation)
 * see https://docs.microsoft.com/en-us/openspecs/windows_protocols/mc-csdl/9fb2fa3c-5aac-4430-87c6-6786314b1588
 *
 * @class Annotation
 */
class Annotation {
  /**
   * Creates an instance of Annotation.
   * @param {Object} rawMetadata raw metadata object for the annotation
   * @param {Object} expressionBuilder expression builder for creating value objects
   * @memberof Annotation
   */
  constructor(rawMetadata, expressionBuilder) {
    createBasicProperties(this, rawMetadata);

    let annotations = _.get(this.raw, "Annotation", []).map(
      expressionBuilder.buildAnnotation
    );
    Object.defineProperty(this, "annotations", {
      get: () => annotations,
    });

    expressionBuilder.assignElementValue(this, `Annotation '${this.term}'`);
  }
}

module.exports = Annotation;