@sap/cds-dk 7.9.6 → 8.0.3

package/lib/compile/asyncapi/components/schemas/index.js

@@ -1,14 +0,0 @@
-const { definitionToSchema } = require('./definition');
-const { getEventName } = require('../../utils');
-
-module.exports = function csnToJSONSchema(definitions, events) {
-    let schemaCache = {};
-    let schema = {};
-
-    events.forEach(event => {
-        const eventName = getEventName(event, definitions[event]);
-        schema[eventName] = definitionToSchema(event, definitions, schemaCache);
-    });
-
-    return schema;
-}

package/lib/compile/asyncapi/components/schemas/localized.js

@@ -1,29 +0,0 @@
-const primitiveElementToSchema = require('./primitiveElement');
-const { getBaseTypeStructure } = require('./utils');
-
-function getPatternStructure(pattern, example) {
-    var schema = getBaseTypeStructure('string');
-    schema.pattern = pattern;
-    if (example) {
-        schema.examples = [example];
-    }
-    return schema;
-}
-
-function toLocalizedArray(localizedElement) {
-    return {
-        type: "array",
-        items: {
-            type: "object",
-            properties: {
-                lang: getPatternStructure('^[a-z]{2}(?:-[A-z]{2})?$'),
-                content: primitiveElementToSchema(localizedElement)
-            },
-            required: ['lang', 'content']
-        }
-    }
-}
-
-module.exports = {
-    toLocalizedArray
-}

package/lib/compile/asyncapi/components/schemas/primitiveElement.js

@@ -1,41 +0,0 @@
-const Examples = require('./examples');
-const { getBaseTypeStructure, getFormatStructure, toString } = require('./utils');
-
-module.exports = function primitiveElementToSchema(entry) {
-    switch(entry.type) {
-        case 'cds.Boolean':
-            return getBaseTypeStructure("boolean");
-        case 'cds.Integer':
-            return getBaseTypeStructure("integer");
-        case 'cds.Double':
-            return getBaseTypeStructure("number");
-        case 'cds.UUID':
-            return getFormatStructure("uuid", Examples.UUID_EXAMPLE);
-        case 'cds.Integer64':
-            return getFormatStructure("int64", Examples.INT_64_EXAMPLE);
-        case 'cds.Decimal': {
-            let schema = getFormatStructure("decimal", Examples.DECIMAL_EXAMPLE);
-            if (entry.precision) {
-                schema['x-sap-precision'] = entry.precision;
-            }
-            if (entry.scale) {
-                schema['x-sap-scale'] = entry.scale;
-            }
-            return schema;
-        }
-        case 'cds.Date':
-            return getFormatStructure("date", Examples.DATE_EXAMPLE);
-        case 'cds.Time':
-            return getFormatStructure("partial-time", Examples.PARTIAL_TIME_EXAMPLE);
-        case 'cds.DateTime':
-        case 'cds.Timestamp':
-            return getFormatStructure("date-time", Examples.DATE_TIME_EXAMPLE);
-        case 'cds.String':
-        case 'cds.LargeString':
-        case 'cds.Binary':
-        case 'cds.LargeBinary':
-            return toString(entry);
-        default:
-            throw new Error(`Unsupported type ${entry.type}`);
-    }
-}

package/lib/compile/asyncapi/components/schemas/ref.js

@@ -1,45 +0,0 @@
-const { isElements, isRefEntry } = require('./utils');
-
-function followRefRecursive(definitions, ref) {
-  const element = followRef(definitions, ref);
-
-  if (isRefEntry(element)) {
-    return followRefRecursive(definitions, element.type);
-  }
-
-  return element;
-}
-
-function followRef(definitions, { ref }) {
-  const definition = definitions[ref[0]];
-
-  if (!definition) {
-    throw new Error(`Cannot find definition '${ref[0]}'`);
-  }
-
-  if (!isElements(definition.elements)) {
-    throw new Error(`'${ref[0]}' is not a structured type`);
-  }
-
-  let pointer = definition.elements;
-  let element;
-
-  // Navigate down to the last elements section
-  for (let elementIndex = 1; elementIndex < ref.length; elementIndex++) {
-    element = pointer[ref[elementIndex]];
-
-    if (element && isElements(element.elements)) {
-      pointer = element.elements;
-    }
-  }
-
-  if (!element) {
-    throw new Error(`Cannot resolve reference '${ref.join(':')}'`);
-  }
-
-  return element;
-}
-
-module.exports = {
-  followRefRecursive
-}

package/lib/compile/asyncapi/components/schemas/utils.js

@@ -1,108 +0,0 @@
-
-function toString(element) {
-    let schema = getBaseTypeStructure("string");
-
-    if ('length' in element && typeof element.length === 'number') {
-        schema.maxLength = element.length;
-    }
-
-    return schema;
-}
-
-function getBaseTypeStructure(type) {
-    return { type: type };
-}
-
-function getFormatStructure(format, example) {
-    let schema = getBaseTypeStructure("string");
-
-    schema.format = format;
-    if (example) {
-        schema.example = [example];
-    }
-
-    return schema;
-}
-
-function isAssociation(entry) {
-    return !!entry && entry.type === 'cds.Association';
-}
-
-function isComposition(entry) {
-    return !!entry && entry.type === 'cds.Composition';
-}
-
-function isStructured(entry) {
-    return !!entry && typeof entry === 'object' && 'elements' in entry && isElements(entry.elements);
-}
-
-function isToMany(entry) {
-    return entry.cardinality?.max === '*' || (typeof entry.cardinality?.max === 'number' && entry.cardinality?.max > 1);
-}
-
-function isDefault(entry) {
-    return "default" in entry;
-}
-
-function isEnum(entry) {
-    return "enum" in entry;
-}
-
-function addDefaultValue(entry, schema) {
-    schema.default = entry.default.val;
-}
-
-function isVal(value) {
-    return typeof value === 'object' && !!value && 'val' in value && Object.keys(value).length === 1;
-}
-
-function isElements(value) {
-    return typeof value === 'object' && !!value && !Array.isArray(value) && !('=' in value) && !isVal(value);
-}
-
-function isManyEntry(entry) {
-    return (
-        'items' in entry &&
-        typeof entry.items === 'object' &&
-        !!entry.items &&
-        (('type' in entry.items && typeof entry.items.type === 'string') ||
-          ('elements' in entry.items && isElements(entry.items.elements)))
-    );
-}
-
-function isLocalizedElement(name, element) {
-    return (((name === 'texts' && isComposition(element)) || (name === 'localized' && isAssociation(element))) &&
-        element.target.endsWith('.texts'));
-}
-
-function isToManyAssociation(entry) {
-    return isAssociation(entry) && isToMany(entry);
-}
-
-function elementIsRelevant(name, element) {
-    return !isLocalizedElement(name, element);
-}
-
-function isRefEntry(entry) {
-    let type = entry.type;
-    return typeof type === 'object' && !!type && 'ref' in type && Array.isArray(type.ref);
-}
-
-module.exports = {
-    toString,
-    getBaseTypeStructure,
-    getFormatStructure,
-    isAssociation,
-    isComposition,
-    isStructured,
-    isToMany,
-    isDefault,
-    addDefaultValue,
-    isEnum,
-    isVal,
-    elementIsRelevant,
-    isManyEntry,
-    isElements,
-    isRefEntry,
-    isToManyAssociation
-}

package/lib/compile/asyncapi/index.js

@@ -1,247 +0,0 @@
-const csnToJSONSchema = require('./components/schemas');
-const getMessageTraits = require('./components/messageTraits');
-const { definitionsToMessages, nestedAnnotation } = require('./components/messages');
-const getChannels = require('./channels');
-const cds = require('../../cds');
-const messages = require("./message");
-const presetMapping = {
-    'event_spec_version': 'x-sap-event-spec-version',
-    'event_source': 'x-sap-event-source',
-    'event_source_params': 'x-sap-event-source-parameters',
-    'event_characteristics': 'x-sap-event-characteristics'
-};
-
-module.exports = function processor(csn, options = {}) {
-
-    const envConf = cds.env.export?.asyncapi;
-    _serviceErrorHandling(csn, options);
-
-    const applicationNamespace = envConf?.application_namespace;
-
-    if (!applicationNamespace) {
-        throw new Error(messages.APPLICATION_NAMESPACE);
-    }
-
-    const presets = getPresets(envConf);
-
-    if (options.service === 'all') {
-        if (options["asyncapi:merged"]) {
-            if (!envConf?.merged?.title || !envConf.merged?.version ) {
-                throw new Error(messages.TITLE_VERSION_MERGED);
-            }
-
-            const infoObject = getInfoObject({}, envConf.merged);
-            // verify version follows the required pattern
-            isVersionValid(infoObject.version);
-            const shortTextObj = getShortText({}, envConf.merged.short_text);
-
-            const events = getEvents(csn.definitions);
-
-            return {
-                asyncapi: '2.0.0',
-                'x-sap-catalog-spec-version': '1.2',
-                'x-sap-application-namespace': applicationNamespace,
-                ...Object.keys(shortTextObj).length && { 'x-sap-shortText': shortTextObj },
-                info: infoObject,
-                defaultContentType: 'application/json',
-                channels: getChannels(csn.definitions, events),
-                components: getComponents(csn.definitions, events, presets)
-            }
-        } else {
-            const services  = getServicesWithEvents(csn.definitions);
-            return _iterate(services, csn, applicationNamespace, presets);
-        }
-    } else {
-        const events = getEvents(csn.definitions, options.service);
-
-        if (events.length === 0) {
-            throw new Error(messages.NO_EVENTS);
-        }
-
-        return _getAsyncApi(csn, events, options.service, applicationNamespace, presets);
-    }
-}
-
-function getPresets(envConf) {
-    let projectPresets = {};
-    for (const [key, value] of Object.entries(envConf)) {
-        if (presetMapping[key]) projectPresets[presetMapping[key]] = value;
-    }
-    return projectPresets;
-}
-
-function _getAsyncApi(csn, events, serviceName, applicationNamespace, presets) {
-
-    const infoObject = getInfoObject(csn.definitions[serviceName]);
-    const stateObj = getStateInfo(csn.definitions[serviceName]);
-    const shortTextObj = getShortText(csn.definitions[serviceName]);
-    const extensionAnnotationObj = getExtensions(csn.definitions[serviceName], shortTextObj, stateObj);
-    return {
-        asyncapi: '2.0.0',
-        'x-sap-catalog-spec-version': '1.2',
-        'x-sap-application-namespace': applicationNamespace,
-        ...Object.keys(stateObj).length && { 'x-sap-stateInfo': stateObj },
-        ...Object.keys(shortTextObj).length && { 'x-sap-shortText': shortTextObj },
-        ...Object.keys(extensionAnnotationObj).length && extensionAnnotationObj,
-        info: infoObject,
-        defaultContentType: 'application/json',
-        channels: getChannels(csn.definitions, events),
-        components: getComponents(csn.definitions, events, presets)
-    };
-}
-
-function getExtensions(serviceCsn, shortTextObj, stateObj) {
-    let extensionObj = {};
-    for (const [key, value] of Object.entries(serviceCsn)) {
-        if (key.startsWith('@AsyncAPI.Extensions')) {
-            const annotationProperties = key.split('@AsyncAPI.Extensions.')[1];
-            const keys = annotationProperties.split('.');
-            keys[0] = "x-" + keys[0];
-            if ((keys[0] === 'x-sap-shortText' && Object.keys(shortTextObj).length > 0) ||
-                (keys[0] === 'x-sap-stateInfo' && Object.keys(stateObj).length > 0)
-            ) continue;
-            if (keys.length === 1) {
-                extensionObj[keys[0]] = value;
-            } else {
-                nestedAnnotation(extensionObj, keys[0], keys, value);
-            }
-        }
-    }
-    return extensionObj;
-}
-
-function getShortText(serviceCsn, presetValue = undefined) {
-    let shortTextValue = presetValue || serviceCsn["@AsyncAPI.ShortText"];
-    if (shortTextValue) {
-        return shortTextValue;
-    }
-    return {};
-}
-
-function getStateInfo(serviceCsn) {
-    const stateProperties = ['state', 'deprecationDate', 'decomissionedDate', 'link'];
-    const stateObj = {};
-
-    stateProperties.forEach(function (item) {
-        if (serviceCsn['@AsyncAPI.StateInfo.' + item]) {
-            stateObj[item] = serviceCsn['@AsyncAPI.StateInfo.' + item];
-        }
-    });
-
-    return stateObj;
-}
-
-function getInfoObject(serviceCsn, mergedPresetObject = undefined) {
-    const info = {};
-
-    if (mergedPresetObject) {
-        Object.keys(mergedPresetObject).forEach(key => {
-            if (key !== "short_text")  info[key] = mergedPresetObject[key];
-        });
-        return info;
-    }
-
-    if (!serviceCsn['@AsyncAPI.SchemaVersion'] || !serviceCsn['@AsyncAPI.Title']) {
-        throw new Error(messages.TITLE_VERSION_ANNOTATIONS);
-    }
-
-    isVersionValid(serviceCsn['@AsyncAPI.SchemaVersion']);
-
-    info.version = serviceCsn['@AsyncAPI.SchemaVersion'];
-    info.title = serviceCsn['@AsyncAPI.Title'];
-
-    if (serviceCsn['@AsyncAPI.Description']) {
-        info.description = serviceCsn['@AsyncAPI.Description'];
-    }
-
-    return info;
-}
-
-function isVersionValid(version) {
-    version.split('.').forEach(element => {
-        if (isNaN(element)) {
-            throw new Error(messages.UNSUPPORTED_VERSION);
-        }
-    });
-    return true;
-}
-
-function getEvents(definitions, service = '') {
-    let events = [];
-    for (const [key, value] of Object.entries(definitions)) {
-        if (value.kind === 'event' && value._service !== undefined) {
-            if (service === '' || value._service.name === service) {
-                events.push(key);
-            }
-        }
-    }
-    return events;
-}
-
-function getServicesWithEvents(definitions) {
-    const services = {};
-
-    // traverse the definitions list and extract services
-    for (const [key, value] of Object.entries(definitions)) {
-        if (value.kind === 'service') {
-            services[key] = {
-                events: []
-            };
-        }
-    }
-
-    // traverse the definitions list and map events to services
-    for (const [key, value] of Object.entries(definitions)) {
-        if (value.kind === 'event' && value._service) {
-            services[value._service.name].events.push(key);
-        }
-    }
-
-    // traverse the services list and remove service with no events
-    for (const [key, value] of Object.entries(services)) {
-        if (value.events.length === 0) {
-            delete services[key];
-        }
-    }
-
-    return services;
-}
-
-function getComponents(definitions, events, presets) {
-
-    return {
-        messageTraits: getMessageTraits(),
-        messages: definitionsToMessages(definitions, events, presets),
-        schemas: csnToJSONSchema(definitions, events)
-    }
-}
-
-function _serviceErrorHandling(csn, options) {
-    const services = cds.linked(csn).services;
-
-    if (services.length < 1) throw new Error(messages.NO_SERVICES);
-
-    if (!options.service && services.length > 1) throw new Error(`\n
-      Found multiple service definitions in given model(s).
-      Please choose by adding one of... \n
-      -s all ${services.map(s => `\n      -s ${s.name}`).join('')}
-    `);
-
-    if (!options.service) {
-      options.service = services[0].name;
-    } else if (options.service !== 'all') {
-      const srv = services.find(s => s.name === options.service);
-      if (!srv) throw new Error(`Service definition with given ${options.service} not found in the model(s).`);
-    }
-
-    if (options["asyncapi:merged"] && options.service !== 'all') {
-        throw new Error(messages.MERGED_FLAG);
-    }
-}
-
-function* _iterate(services, csn, applicationNamespace, presets) {
-    for (const [key, value] of Object.entries(services)) {
-        const generatedAsyncAPI = _getAsyncApi(csn, value.events, key, applicationNamespace, presets);
-        yield [generatedAsyncAPI, { file: key }];
-    }
-}

package/lib/compile/asyncapi/message.js

@@ -1,13 +0,0 @@
-"use strict";
-
-const errorMessages = {
-    APPLICATION_NAMESPACE: 'Preset for application namespace needs to be added.',
-    TITLE_VERSION_MERGED: 'Preset for Title and Version info needs to be added when merged flag is used.',
-    NO_EVENTS: 'No events found in the service.',
-    TITLE_VERSION_ANNOTATIONS: 'Title and Version info annotations needs to be added to the service(s).',
-    UNSUPPORTED_VERSION: 'The version value provided is unsupported.',
-    NO_SERVICES: 'There are no service definitions found in the given model(s).',
-    MERGED_FLAG: 'Merged flag cannot be used with single service definition.',
-};
-
-module.exports = errorMessages;

package/lib/compile/asyncapi/utils.js

@@ -1,27 +0,0 @@
-/**
- * Returns value of EventType Annotation if it is present. Otherwise it returns the definition name only.
- */
-function getEventName(eventName, eventDefinition) {
-
-    if (eventDefinition["@AsyncAPI.EventType"]) {
-        eventName = eventDefinition["@AsyncAPI.EventType"];
-    }
-
-    return eventName;
-}
-
-/**
- * Gets the property value from the entry if it is defined otherwise returns undefined.
- */
-function getOwnValue(entry, key) {
-    if (Object.prototype.hasOwnProperty.call(entry, key)) {
-        return entry[key];
-    }
-
-    return;
-}
-
-module.exports = {
-    getEventName,
-    getOwnValue
-}