@kaapi/kaapi 0.0.24 → 0.0.26

package/lib/services/docs/modifiers.js

@@ -0,0 +1,674 @@
+"use strict";
+var _SchemaModifier_instances, _a, _SchemaModifier_convertOne, _SchemaModifier_convertMany, _SchemaModifier_convertObjectOf;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupResponseDocsModifier = exports.ContextResponseDocsModifier = exports.ResponseDocsModifier = exports.RequestBodyDocsModifier = exports.MediaTypeModifier = exports.SchemaModifier = exports.ExampleModifier = void 0;
+exports.groupResponses = groupResponses;
+const tslib_1 = require("tslib");
+const deep_extend_1 = require("./deep-extend");
+const jsontoxml_1 = tslib_1.__importDefault(require("jsontoxml"));
+const api_doc_generator_1 = require("@novice1/api-doc-generator");
+// -------------------- CLASSES --------------------
+class ExampleModifier {
+    constructor(name, example) {
+        this.name = name;
+        if (example) {
+            this.value = example.value;
+            this.externalValue = example.externalValue;
+            this.summary = example.summary;
+            this.description = example.description;
+        }
+    }
+    getName() {
+        return this.name;
+    }
+    setValue(value) {
+        this.value = value;
+        return this;
+    }
+    getValue() {
+        return this.value;
+    }
+    setExternalValue(externalValue) {
+        this.externalValue = externalValue;
+        return this;
+    }
+    getExternalValue() {
+        return this.externalValue;
+    }
+    setSummary(summary) {
+        this.summary = summary;
+        return this;
+    }
+    getSummary() {
+        return this.summary;
+    }
+    setDescription(description) {
+        this.description = description;
+        return this;
+    }
+    getDescription() {
+        return this.description;
+    }
+    ref() {
+        return { $ref: `#/components/examples/${this.name}` };
+    }
+    toObject() {
+        return {
+            description: this.description,
+            externalValue: this.externalValue,
+            summary: this.summary,
+            value: this.value
+        };
+    }
+    toJSON() {
+        return this.toObject();
+    }
+}
+exports.ExampleModifier = ExampleModifier;
+class SchemaModifier {
+    constructor(name, schema) {
+        _SchemaModifier_instances.add(this);
+        this.schema = {};
+        this.name = name;
+        if (schema) {
+            this.setSchema(schema);
+        }
+    }
+    getName() {
+        return this.name;
+    }
+    setSchema(schema) {
+        this.schema = schema;
+        return this;
+    }
+    ref() {
+        return { $ref: `#/components/schemas/${this.name}` };
+    }
+    toObject() {
+        const _b = this.schema, { allOf, anyOf, oneOf, not, items, properties, additionalProperties } = _b, value = tslib_1.__rest(_b, ["allOf", "anyOf", "oneOf", "not", "items", "properties", "additionalProperties"]);
+        const valueToKeep = value;
+        if (allOf) {
+            valueToKeep.allOf = tslib_1.__classPrivateFieldGet(this, _SchemaModifier_instances, "m", _SchemaModifier_convertMany).call(this, allOf);
+        }
+        if (anyOf) {
+            valueToKeep.anyOf = tslib_1.__classPrivateFieldGet(this, _SchemaModifier_instances, "m", _SchemaModifier_convertMany).call(this, anyOf);
+        }
+        if (oneOf) {
+            valueToKeep.oneOf = tslib_1.__classPrivateFieldGet(this, _SchemaModifier_instances, "m", _SchemaModifier_convertMany).call(this, oneOf);
+        }
+        if (not) {
+            valueToKeep.not = tslib_1.__classPrivateFieldGet(this, _SchemaModifier_instances, "m", _SchemaModifier_convertOne).call(this, not);
+        }
+        if (items) {
+            valueToKeep.items = tslib_1.__classPrivateFieldGet(this, _SchemaModifier_instances, "m", _SchemaModifier_convertOne).call(this, items);
+        }
+        if (properties) {
+            valueToKeep.properties = tslib_1.__classPrivateFieldGet(this, _SchemaModifier_instances, "m", _SchemaModifier_convertObjectOf).call(this, properties);
+        }
+        if (typeof additionalProperties !== 'undefined') {
+            if (typeof additionalProperties === 'boolean') {
+                valueToKeep.additionalProperties = additionalProperties;
+            }
+            else {
+                valueToKeep.additionalProperties = tslib_1.__classPrivateFieldGet(this, _SchemaModifier_instances, "m", _SchemaModifier_convertOne).call(this, additionalProperties);
+            }
+        }
+        return Object.assign({}, valueToKeep);
+    }
+    toJSON() {
+        return this.toObject();
+    }
+}
+exports.SchemaModifier = SchemaModifier;
+_a = SchemaModifier, _SchemaModifier_instances = new WeakSet(), _SchemaModifier_convertOne = function _SchemaModifier_convertOne(v) {
+    if ('ref' in v && typeof v.ref == 'function') {
+        return v.ref();
+    }
+    else {
+        return new _a('tmp', v).toObject();
+    }
+}, _SchemaModifier_convertMany = function _SchemaModifier_convertMany(v) {
+    const r = [];
+    for (const element of v) {
+        r.push(tslib_1.__classPrivateFieldGet(this, _SchemaModifier_instances, "m", _SchemaModifier_convertOne).call(this, element));
+    }
+    return r;
+}, _SchemaModifier_convertObjectOf = function _SchemaModifier_convertObjectOf(v) {
+    const r = {};
+    for (const k in v) {
+        const vk = v[k];
+        r[k] = (tslib_1.__classPrivateFieldGet(this, _SchemaModifier_instances, "m", _SchemaModifier_convertOne).call(this, vk));
+    }
+    return r;
+};
+class MediaTypeModifier extends api_doc_generator_1.MediaTypeUtil {
+    constructor(mediaType) {
+        super({});
+        if (mediaType) {
+            const { examples, schema, encoding, example } = mediaType;
+            if (encoding)
+                this.setEncoding(encoding);
+            if (example)
+                this.setExample(example);
+            if (examples) {
+                this.setExamples(examples);
+            }
+            if (schema) {
+                this.setSchema(schema);
+            }
+        }
+    }
+    setExamples(examples) {
+        this.examples = examples;
+        return this;
+    }
+    setSchema(schema) {
+        this.schema = schema;
+        return this;
+    }
+    toObject(noRef) {
+        const withSchema = {};
+        if (typeof this.schema !== 'undefined') {
+            if (this.schema instanceof SchemaModifier) {
+                withSchema.schema = this.schema.ref();
+            }
+            else {
+                withSchema.schema = new SchemaModifier('tmp', this.schema).toObject();
+            }
+        }
+        if (typeof this.examples !== 'undefined') {
+            withSchema.examples = {};
+            for (const key in this.examples) {
+                const example = this.examples[key];
+                if (example instanceof ExampleModifier) {
+                    if (noRef) {
+                        withSchema.examples[key] = example.toObject();
+                    }
+                    else {
+                        withSchema.examples[key] = example.ref();
+                    }
+                }
+                else {
+                    withSchema.examples[key] = example;
+                }
+            }
+        }
+        const copy = (0, deep_extend_1.deepExtend)(super.toObject(), withSchema);
+        return copy;
+    }
+    toModel() {
+        return Object.assign(Object.assign({}, super.toObject()), { schema: this.schema, examples: this.examples });
+    }
+}
+exports.MediaTypeModifier = MediaTypeModifier;
+function isContentFileSchema(schema) {
+    let r = false;
+    let nbProps = 0;
+    if ('type' in schema) {
+        if (schema.type !== 'string') {
+            return r;
+        }
+        nbProps++;
+    }
+    if ('contentMediaType' in schema) {
+        nbProps++;
+    }
+    if ('contentEncoding' in schema) {
+        nbProps++;
+    }
+    if ('$ref' in schema) {
+        nbProps++;
+    }
+    if ('$schema' in schema) {
+        nbProps++;
+    }
+    if (nbProps === Object.keys(schema).length) {
+        r = true;
+    }
+    return r;
+}
+function createElementJsontoxmlSample(name, schema) {
+    const res = {
+        name
+    };
+    if ('xml' in schema) {
+        let prefix = '';
+        const xml = schema.xml;
+        if (xml === null || xml === void 0 ? void 0 : xml.name) {
+            res.name = xml.name;
+        }
+        if (xml === null || xml === void 0 ? void 0 : xml.prefix) {
+            prefix = xml.prefix;
+        }
+        if (xml === null || xml === void 0 ? void 0 : xml.namespace) {
+            const xmlns = prefix ? `xmlns:${prefix}` : `xmlns:${res.name}`;
+            res.attrs = {
+                [xmlns]: xml.namespace
+            };
+        }
+        if (prefix) {
+            res.name = `${prefix}:${res.name}`;
+        }
+    }
+    return res;
+}
+function formatJsontoxmlSample(json, properties) {
+    for (const propName in properties) {
+        const propSchema = properties[propName];
+        const jsonChild = createJsontoxmlSample(propName, propSchema);
+        if ('xml' in propSchema) {
+            const xmlObject = propSchema.xml;
+            if (xmlObject === null || xmlObject === void 0 ? void 0 : xmlObject.attribute) {
+                json.attrs = json.attrs || {};
+                json.attrs[propName] = jsonChild.text || '';
+            }
+            else {
+                json.children = json.children || [];
+                json.children.push(jsonChild);
+            }
+        }
+        else {
+            json.children = json.children || [];
+            json.children.push(jsonChild);
+        }
+    }
+}
+function createJsontoxmlSample(name, schema) {
+    var _b, _c;
+    const res = createElementJsontoxmlSample(name, schema);
+    if ('type' in schema) {
+        if (schema.type === 'array') {
+            // no overdo: do not support anyOf or oneOf here
+            if (schema.items && 'type' in schema.items && typeof schema.items.type === 'string') {
+                let text;
+                const itemType = schema.items.type;
+                const itemSchema = schema.items;
+                if (typeof itemSchema.default !== 'undefined') {
+                    text = `${itemSchema.default}`;
+                }
+                else if ((_b = itemSchema.examples) === null || _b === void 0 ? void 0 : _b.length) {
+                    text = `${itemSchema.examples[0]}`;
+                }
+                else if (itemSchema.type === 'number' || itemSchema.type === 'integer') {
+                    text = `${itemSchema.minimum ? itemSchema.minimum : (itemSchema.exclusiveMinimum ? itemSchema.exclusiveMinimum : 0)}`;
+                }
+                else if (itemSchema.type === 'boolean') {
+                    text = 'true';
+                }
+                else if (itemSchema.type === 'string') {
+                    text = `${itemSchema.format || itemSchema.type}`;
+                }
+                else if (itemSchema.format) {
+                    text = `(${itemSchema.format})`;
+                }
+                else if (itemType) {
+                    text = `(${itemType})`;
+                }
+                if (text) {
+                    res.text = text;
+                }
+            }
+        }
+        else if (schema.type === 'object' && schema.properties && Object.keys(schema.properties).length) {
+            formatJsontoxmlSample(res, schema.properties);
+        }
+        else {
+            let text;
+            if (typeof schema.default !== 'undefined') {
+                text = `${schema.default}`;
+            }
+            else if ((_c = schema.examples) === null || _c === void 0 ? void 0 : _c.length) {
+                text = `${schema.examples[0]}`;
+            }
+            else if (schema.type === 'number' || schema.type === 'integer') {
+                text = `${schema.minimum ? schema.minimum : (schema.exclusiveMinimum ? schema.exclusiveMinimum : 0)}`;
+            }
+            else if (schema.type === 'boolean') {
+                text = 'true';
+            }
+            else if (schema.type === 'string') {
+                text = `${schema.format || schema.type}`;
+            }
+            else if (schema.format) {
+                text = `(${schema.format})`;
+            }
+            else if (schema.type) {
+                text = `(${schema.type})`;
+            }
+            if (text) {
+                res.text = text;
+            }
+        }
+    }
+    return res;
+}
+function createRawSample(schema, deepLevel = 0) {
+    let sample;
+    if (deepLevel > 9 || !Object.keys(schema).length) {
+        return;
+    }
+    if ('$ref' in schema && Object.keys(schema).length === 1) {
+        return;
+    }
+    if ('default' in schema && typeof schema.default !== 'undefined') {
+        // default value
+        sample = schema.default;
+    }
+    else if ('enum' in schema && Array.isArray(schema.enum) && schema.enum.length) {
+        // default value
+        sample = schema.enum[0];
+    }
+    else if ('examples' in schema && Array.isArray(schema.examples) && schema.examples.length) {
+        // first example value
+        sample = schema.examples[0];
+    }
+    else if ('anyOf' in schema && Array.isArray(schema.anyOf) && schema.anyOf.length) {
+        // first example value
+        sample = createRawSample(schema.anyOf[0], deepLevel + 1);
+    }
+    else if ('oneOf' in schema && Array.isArray(schema.oneOf) && schema.oneOf.length) {
+        // first example value
+        sample = createRawSample(schema.oneOf[0], deepLevel + 1);
+    }
+    else if ('type' in schema) {
+        if (schema.type === 'object') {
+            const obj = {};
+            if (schema.properties) {
+                const props = schema.properties;
+                Object.keys(props).forEach(name => {
+                    obj[name] = createRawSample(props[name], deepLevel + 1);
+                });
+            }
+            sample = obj;
+        }
+        else if (schema.type === 'array') {
+            const arr = [];
+            if (schema.items) {
+                const itemSample = createRawSample(schema.items, deepLevel + 1);
+                if (typeof itemSample !== 'undefined') {
+                    arr.push(itemSample);
+                }
+            }
+            sample = arr;
+        }
+        else if (schema.type === 'number' || schema.type === 'integer') {
+            sample = schema.minimum ? schema.minimum : (schema.exclusiveMinimum ? schema.exclusiveMinimum : 0);
+        }
+        else if (schema.type === 'boolean') {
+            sample = true;
+        }
+        else if (schema.format) {
+            sample = `<${schema.format}>`;
+        }
+        else if (schema.type === 'string') {
+            sample = '';
+        }
+        else {
+            sample = `<${schema.type}>`;
+        }
+    }
+    return sample;
+}
+class RequestBodyDocsModifier {
+    constructor(name) {
+        this.content = {};
+        this.name = name || this.constructor.name;
+    }
+    /**
+     *
+     * @param description A short description of the response.
+     * CommonMark syntax MAY be used for rich text representation.
+     */
+    setDescription(description) {
+        this.description = description;
+        return this;
+    }
+    setName(name) {
+        this.name = name;
+        return this;
+    }
+    setRequired(isRequired) {
+        this.required = isRequired;
+        return this;
+    }
+    setRef(requestBodyRef) {
+        this.requestBodyRef = requestBodyRef;
+        return this;
+    }
+    getDescription() {
+        return this.description;
+    }
+    getName() {
+        return this.name;
+    }
+    isRequired() {
+        return !!this.required;
+    }
+    addMediaType(contentType, mediaType = {}) {
+        this.content = this.content || {};
+        if (mediaType instanceof MediaTypeModifier) {
+            this.content[contentType] = mediaType;
+        }
+        else {
+            this.content[contentType] = new MediaTypeModifier(mediaType);
+        }
+        return this;
+    }
+    ref() {
+        return { $ref: this.requestBodyRef || `#/components/requestBodies/${this.name}` };
+    }
+    toPostman() {
+        var _b;
+        const result = {};
+        const header = [];
+        for (const contentType in this.content) {
+            header.push({
+                key: 'Content-Type',
+                value: contentType
+            });
+            const mediaTypeModel = this.content[contentType].toModel();
+            const contentSchema = mediaTypeModel.schema;
+            result.mode = 'raw';
+            if (contentType === 'multipart/form-data') {
+                result.mode = 'formdata';
+                result.formdata = [];
+                if (contentSchema) {
+                    const rawSchema = contentSchema instanceof SchemaModifier ?
+                        contentSchema.toObject() : (!('$ref' in contentSchema) ? new SchemaModifier('tmp', contentSchema).toObject() : undefined);
+                    if (rawSchema) {
+                        if (rawSchema.properties) {
+                            for (const key in rawSchema.properties) {
+                                const propSchema = rawSchema.properties[key];
+                                if ('$ref' in propSchema) {
+                                    result.formdata.push({
+                                        key,
+                                        type: 'text'
+                                    });
+                                }
+                                else {
+                                    const fieldType = propSchema.contentMediaType ? 'file' : 'text';
+                                    result.formdata.push({
+                                        key,
+                                        type: fieldType,
+                                        description: propSchema.description,
+                                        src: fieldType === 'file' ? [] : undefined,
+                                        disabled: ((_b = rawSchema.required) === null || _b === void 0 ? void 0 : _b.includes(key)) ? false : true
+                                    });
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+            else if (!contentSchema || isContentFileSchema(contentSchema)) {
+                result.mode = 'file';
+                result.file = {
+                    src: ''
+                };
+                result.disabled = false;
+            }
+            else {
+                // create raw value
+                if (typeof mediaTypeModel.example !== 'undefined') {
+                    result.raw = `${mediaTypeModel.example}`;
+                }
+                // if there are examples
+                if (typeof mediaTypeModel.examples !== 'undefined' && Object.keys(mediaTypeModel.examples).length !== 0) {
+                    for (const key in mediaTypeModel.examples) {
+                        const example = mediaTypeModel.examples[key];
+                        if (example instanceof ExampleModifier) {
+                            result.raw = `${example.getValue()}`;
+                            break;
+                        }
+                        else if (example && 'value' in example && typeof example.value !== 'undefined') {
+                            result.raw = `${example.value}`;
+                            break;
+                        }
+                    }
+                }
+                // if no raw content was set
+                if (!result.raw) {
+                    const rawSchema = contentSchema instanceof SchemaModifier ?
+                        contentSchema.toObject() : (!('$ref' in contentSchema) ? new SchemaModifier('tmp', contentSchema).toObject() : undefined);
+                    if (rawSchema) {
+                        if (contentType === 'application/xml') {
+                            // xml
+                            const json = createElementJsontoxmlSample('element', rawSchema);
+                            if ('properties' in rawSchema && rawSchema.properties) {
+                                formatJsontoxmlSample(json, rawSchema.properties);
+                            }
+                            result.raw = (0, jsontoxml_1.default)([json], {
+                                xmlHeader: true,
+                                indent: ' '
+                            });
+                        }
+                        else {
+                            const sample = createRawSample(rawSchema);
+                            if (typeof sample !== 'undefined') {
+                                result.raw = JSON.stringify(sample, null, '\t');
+                            }
+                        }
+                    }
+                }
+            }
+            break;
+        }
+        return { header, body: result };
+    }
+    toOpenAPI() {
+        const content = {};
+        for (const contentType in this.content) {
+            const modifier = this.content[contentType];
+            content[contentType] = modifier.toObject();
+        }
+        const result = {
+            content
+        };
+        if (this.description) {
+            result.description = this.description;
+        }
+        if (this.isRequired()) {
+            result.required = true;
+        }
+        return result;
+    }
+}
+exports.RequestBodyDocsModifier = RequestBodyDocsModifier;
+/**
+ * Set a name (setName) or a ref (setRef) for it to be used as a reference.
+ */
+class ResponseDocsModifier extends api_doc_generator_1.ResponseUtil {
+    constructor(name) {
+        super(name);
+        if (!name)
+            this.setName('');
+    }
+    toOpenAPIRefPreferred(ctxt = {}) {
+        let name = this.name;
+        if (this.code) {
+            name = `${this.code}`;
+        }
+        if (ctxt.code) {
+            name = `${ctxt.code}`;
+        }
+        if (ctxt.default) {
+            name = 'default';
+        }
+        if (this.default) {
+            name = 'default';
+        }
+        if (ctxt.ref) {
+            return {
+                [name]: {
+                    $ref: ctxt.ref
+                }
+            };
+        }
+        if (this.ref) {
+            return {
+                [name]: {
+                    $ref: this.ref
+                }
+            };
+        }
+        if (this.name) {
+            return {
+                [name]: {
+                    $ref: `#/components/responses/${this.name}`
+                }
+            };
+        }
+        return this.toOpenAPI(ctxt);
+    }
+    withContext() {
+        return new ContextResponseDocsModifier(this);
+    }
+}
+exports.ResponseDocsModifier = ResponseDocsModifier;
+class ContextResponseDocsModifier extends api_doc_generator_1.ContextResponseUtil {
+    toOpenAPI() {
+        const ctxt = {};
+        if (this.code) {
+            ctxt.code = this.code;
+        }
+        if (this.ref) {
+            ctxt.ref = this.ref;
+        }
+        if (this.links) {
+            ctxt.links = this.links;
+        }
+        if (this.default) {
+            ctxt.default = this.default;
+        }
+        if (this.responseUtil instanceof ResponseDocsModifier) {
+            return this.responseUtil.toOpenAPIRefPreferred(ctxt);
+        }
+        else {
+            return this.responseUtil.toOpenAPI(ctxt);
+        }
+    }
+}
+exports.ContextResponseDocsModifier = ContextResponseDocsModifier;
+class GroupResponseDocsModifier extends api_doc_generator_1.GroupResponseUtil {
+    constructor(responseUtils) {
+        super(responseUtils);
+        this.responseUtils = responseUtils;
+    }
+    toOpenAPIRefPreferred() {
+        let r = {};
+        this.responseUtils.forEach(builder => {
+            if (builder instanceof ResponseDocsModifier) {
+                r = Object.assign(Object.assign({}, r), builder.toOpenAPIRefPreferred());
+            }
+            else {
+                r = Object.assign(Object.assign({}, r), builder.toOpenAPI());
+            }
+        });
+        return r;
+    }
+}
+exports.GroupResponseDocsModifier = GroupResponseDocsModifier;
+function groupResponses(...modifiers) {
+    return new GroupResponseDocsModifier(modifiers);
+}
+//# sourceMappingURL=modifiers.js.map