@kaapi/kaapi 0.0.24 → 0.0.25

package/lib/services/docs/doc-adapters.js

@@ -0,0 +1,430 @@
+"use strict";
+var _SchemaAdapter_instances, _a, _SchemaAdapter_convertOne, _SchemaAdapter_convertMany, _SchemaAdapter_convertObjectOf;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupResponseAdapter = exports.ContextResponseAdapter = exports.ResponseAdapter = exports.RequestBodyAdapter = exports.MediaTypeAdapter = exports.SchemaAdapter = exports.ExampleAdapter = void 0;
+exports.groupResponses = groupResponses;
+const tslib_1 = require("tslib");
+const deep_extend_1 = require("./deep-extend");
+const api_doc_generator_1 = require("@novice1/api-doc-generator");
+// -------------------- CLASSES --------------------
+class ExampleAdapter {
+    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.ExampleAdapter = ExampleAdapter;
+class SchemaAdapter {
+    constructor(name, schema) {
+        _SchemaAdapter_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, _SchemaAdapter_instances, "m", _SchemaAdapter_convertMany).call(this, allOf);
+        }
+        if (anyOf) {
+            valueToKeep.anyOf = tslib_1.__classPrivateFieldGet(this, _SchemaAdapter_instances, "m", _SchemaAdapter_convertMany).call(this, anyOf);
+        }
+        if (oneOf) {
+            valueToKeep.oneOf = tslib_1.__classPrivateFieldGet(this, _SchemaAdapter_instances, "m", _SchemaAdapter_convertMany).call(this, oneOf);
+        }
+        if (not) {
+            valueToKeep.not = tslib_1.__classPrivateFieldGet(this, _SchemaAdapter_instances, "m", _SchemaAdapter_convertOne).call(this, not);
+        }
+        if (items) {
+            valueToKeep.items = tslib_1.__classPrivateFieldGet(this, _SchemaAdapter_instances, "m", _SchemaAdapter_convertOne).call(this, items);
+        }
+        if (properties) {
+            valueToKeep.properties = tslib_1.__classPrivateFieldGet(this, _SchemaAdapter_instances, "m", _SchemaAdapter_convertObjectOf).call(this, properties);
+        }
+        if (typeof additionalProperties !== 'undefined') {
+            if (typeof additionalProperties === 'boolean') {
+                valueToKeep.additionalProperties = additionalProperties;
+            }
+            else {
+                valueToKeep.additionalProperties = tslib_1.__classPrivateFieldGet(this, _SchemaAdapter_instances, "m", _SchemaAdapter_convertOne).call(this, additionalProperties);
+            }
+        }
+        return Object.assign({}, valueToKeep);
+    }
+    toJSON() {
+        return this.toObject();
+    }
+}
+exports.SchemaAdapter = SchemaAdapter;
+_a = SchemaAdapter, _SchemaAdapter_instances = new WeakSet(), _SchemaAdapter_convertOne = function _SchemaAdapter_convertOne(v) {
+    if ('ref' in v && typeof v.ref == 'function') {
+        return v.ref();
+    }
+    else {
+        return new _a('tmp', v).toObject();
+    }
+}, _SchemaAdapter_convertMany = function _SchemaAdapter_convertMany(v) {
+    const r = [];
+    for (const element of v) {
+        r.push(tslib_1.__classPrivateFieldGet(this, _SchemaAdapter_instances, "m", _SchemaAdapter_convertOne).call(this, element));
+    }
+    return r;
+}, _SchemaAdapter_convertObjectOf = function _SchemaAdapter_convertObjectOf(v) {
+    const r = {};
+    for (const k in v) {
+        const vk = v[k];
+        r[k] = (tslib_1.__classPrivateFieldGet(this, _SchemaAdapter_instances, "m", _SchemaAdapter_convertOne).call(this, vk));
+    }
+    return r;
+};
+class MediaTypeAdapter extends api_doc_generator_1.MediaTypeUtil {
+    constructor(mediaType) {
+        if (mediaType) {
+            const { examples, schema } = mediaType, rest = tslib_1.__rest(mediaType, ["examples", "schema"]);
+            super(rest);
+            if (examples) {
+                this.setExamples(examples);
+            }
+            if (schema) {
+                this.setSchema(schema);
+            }
+        }
+        else {
+            super();
+        }
+    }
+    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 SchemaAdapter) {
+                withSchema.schema = this.schema.ref();
+            }
+            else {
+                withSchema.schema = new SchemaAdapter('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 ExampleAdapter) {
+                    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.MediaTypeAdapter = MediaTypeAdapter;
+class RequestBodyAdapter {
+    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 MediaTypeAdapter) {
+            this.content[contentType] = mediaType;
+        }
+        else {
+            this.content[contentType] = new MediaTypeAdapter(mediaType);
+        }
+        return this;
+    }
+    ref() {
+        return { $ref: this.requestBodyRef || `#/components/requestBodies/${this.name}` };
+    }
+    toPostman() {
+        var _b;
+        const result = {};
+        for (const contentType in this.content) {
+            const mediaTypeModel = this.content[contentType].toModel();
+            const contentSchema = mediaTypeModel.schema;
+            result.mode = 'raw';
+            if (contentType === 'multipart/form-data') {
+                result.mode = 'form-data';
+                result.formdata = [];
+                if (contentSchema) {
+                    if (contentSchema instanceof SchemaAdapter) {
+                        const rawSchema = contentSchema.toObject();
+                        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 || Object.keys(contentSchema).length === 0) {
+                result.mode = 'file';
+                result.disabled = false;
+            }
+            else {
+                // create raw value
+                if (typeof mediaTypeModel.example !== 'undefined') {
+                    result.raw = `${mediaTypeModel.example}`;
+                }
+                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 ExampleAdapter) {
+                            result.raw = `${example.getValue()}`;
+                            break;
+                        }
+                        else if (example && 'value' in example && typeof example.value !== 'undefined') {
+                            result.raw = `${example.value}`;
+                            break;
+                        }
+                    }
+                }
+            }
+            break;
+        }
+        return result;
+    }
+    toOpenAPI() {
+        const content = {};
+        for (const contentType in this.content) {
+            const adapter = this.content[contentType];
+            content[contentType] = adapter.toObject();
+        }
+        const result = {
+            content
+        };
+        if (this.description) {
+            result.description = this.description;
+        }
+        if (this.isRequired()) {
+            result.required = true;
+        }
+        return result;
+    }
+}
+exports.RequestBodyAdapter = RequestBodyAdapter;
+/**
+ * Set a name (setName) or a ref (setRef) for it to be used as a reference.
+ */
+class ResponseAdapter 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 ContextResponseAdapter(this);
+    }
+}
+exports.ResponseAdapter = ResponseAdapter;
+class ContextResponseAdapter 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 ResponseAdapter) {
+            return this.responseUtil.toOpenAPIRefPreferred(ctxt);
+        }
+        else {
+            return this.responseUtil.toOpenAPI(ctxt);
+        }
+    }
+}
+exports.ContextResponseAdapter = ContextResponseAdapter;
+class GroupResponseAdapter extends api_doc_generator_1.GroupResponseUtil {
+    constructor(responseUtils) {
+        super(responseUtils);
+        this.responseUtils = responseUtils;
+    }
+    toOpenAPIRefPreferred() {
+        let r = {};
+        this.responseUtils.forEach(builder => {
+            if (builder instanceof ResponseAdapter) {
+                r = Object.assign(Object.assign({}, r), builder.toOpenAPIRefPreferred());
+            }
+            else {
+                r = Object.assign(Object.assign({}, r), builder.toOpenAPI());
+            }
+        });
+        return r;
+    }
+}
+exports.GroupResponseAdapter = GroupResponseAdapter;
+function groupResponses(...adapters) {
+    return new GroupResponseAdapter(adapters);
+}
+//# sourceMappingURL=doc-adapters.js.map

package/lib/services/docs/doc-adapters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-adapters.js","sourceRoot":"","sources":["../../../src/services/docs/doc-adapters.ts"],"names":[],"mappings":";;;;AAkgBA,wCAIC;;AAtgBD,+CAA0C;AAC1C,kEAQmC;AAuCnC,oDAAoD;AAEpD,MAAa,cAAc;IAQvB,YAAY,IAAY,EAAE,OAAuB;QAC7C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,OAAO,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;YAC1B,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAA;YAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;YAC9B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;QAC1C,CAAC;IACL,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,IAAI,CAAA;IACpB,CAAC;IAED,QAAQ,CAAC,KAAc;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,OAAO,IAAI,CAAA;IACf,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;IAED,gBAAgB,CAAC,aAAqB;QAClC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,OAAO,IAAI,CAAA;IACf,CAAC;IAED,gBAAgB;QACZ,OAAO,IAAI,CAAC,aAAa,CAAA;IAC7B,CAAC;IAED,UAAU,CAAC,OAAe;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,OAAO,IAAI,CAAA;IACf,CAAC;IAED,UAAU;QACN,OAAO,IAAI,CAAC,OAAO,CAAA;IACvB,CAAC;IAED,cAAc,CAAC,WAAmB;QAC9B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,OAAO,IAAI,CAAA;IACf,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,WAAW,CAAA;IAC3B,CAAC;IAED,GAAG;QACC,OAAO,EAAE,IAAI,EAAE,yBAAyB,IAAI,CAAC,IAAI,EAAE,EAAE,CAAA;IACzD,CAAC;IAED,QAAQ;QACJ,OAAO;YACH,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;SACpB,CAAA;IACL,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;IAC1B,CAAC;CACJ;AA1ED,wCA0EC;AAED,MAAa,aAAa;IAItB,YAAY,IAAY,EAAE,MAAoB;;QAFpC,WAAM,GAAgB,EAAE,CAAA;QAG9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,MAAM,EAAE,CAAC;YACT,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC;IACL,CAAC;IA2BD,OAAO;QACH,OAAO,IAAI,CAAC,IAAI,CAAA;IACpB,CAAC;IAED,SAAS,CAAC,MAAmB;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAA;IACf,CAAC;IAED,GAAG;QACC,OAAO,EAAE,IAAI,EAAE,wBAAwB,IAAI,CAAC,IAAI,EAAE,EAAE,CAAA;IACxD,CAAC;IAED,QAAQ;QACJ,MAAM,KAAkF,IAAI,CAAC,MAAM,EAA7F,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,oBAAoB,OAA0B,EAArB,KAAK,sBAA7E,iFAA+E,CAAc,CAAA;QACnG,MAAM,WAAW,GAAoB,KAAK,CAAA;QAC1C,IAAI,KAAK,EAAE,CAAC;YACR,WAAW,CAAC,KAAK,GAAG,+BAAA,IAAI,4DAAa,MAAjB,IAAI,EAAc,KAAK,CAAC,CAAA;QAChD,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACR,WAAW,CAAC,KAAK,GAAG,+BAAA,IAAI,4DAAa,MAAjB,IAAI,EAAc,KAAK,CAAC,CAAA;QAChD,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACR,WAAW,CAAC,KAAK,GAAG,+BAAA,IAAI,4DAAa,MAAjB,IAAI,EAAc,KAAK,CAAC,CAAA;QAChD,CAAC;QACD,IAAI,GAAG,EAAE,CAAC;YACN,WAAW,CAAC,GAAG,GAAG,+BAAA,IAAI,2DAAY,MAAhB,IAAI,EAAa,GAAG,CAAC,CAAA;QAC3C,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACR,WAAW,CAAC,KAAK,GAAG,+BAAA,IAAI,2DAAY,MAAhB,IAAI,EAAa,KAAK,CAAC,CAAA;QAC/C,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACb,WAAW,CAAC,UAAU,GAAG,+BAAA,IAAI,gEAAiB,MAArB,IAAI,EAAkB,UAAU,CAAC,CAAA;QAC9D,CAAC;QACD,IAAI,OAAO,oBAAoB,KAAK,WAAW,EAAE,CAAC;YAC9C,IAAI,OAAO,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBAC5C,WAAW,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;YAC3D,CAAC;iBAAM,CAAC;gBACJ,WAAW,CAAC,oBAAoB,GAAG,+BAAA,IAAI,2DAAY,MAAhB,IAAI,EAAa,oBAAoB,CAAC,CAAA;YAC7E,CAAC;QACL,CAAC;QACD,yBAAY,WAAW,EAAG;IAC9B,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;IAC1B,CAAC;CACJ;AAnFD,sCAmFC;6HAxEe,CAA+B;IACvC,IAAI,KAAK,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC,GAAG,IAAI,UAAU,EAAE,CAAC;QAC3C,OAAO,CAAC,CAAC,GAAG,EAAE,CAAA;IAClB,CAAC;SAAM,CAAC;QACJ,OAAO,IAAI,EAAa,CAAC,KAAK,EAAE,CAAgB,CAAC,CAAC,QAAQ,EAAE,CAAA;IAChE,CAAC;AACL,CAAC,mEAEY,CAAsC;IAC/C,MAAM,CAAC,GAA6C,EAAE,CAAA;IACtD,KAAK,MAAM,OAAO,IAAI,CAAC,EAAE,CAAC;QACtB,CAAC,CAAC,IAAI,CAAC,+BAAA,IAAI,2DAAY,MAAhB,IAAI,EAAa,OAAO,CAAC,CAAC,CAAA;IACrC,CAAC;IACD,OAAO,CAAC,CAAA;AACZ,CAAC,2EAEgB,CAA+C;IAC5D,MAAM,CAAC,GAAsD,EAAE,CAAA;IAC/D,KAAK,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAChB,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QACf,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,+BAAA,IAAI,2DAAY,MAAhB,IAAI,EAAa,EAAE,CAAC,CAAC,CAAA;IACjC,CAAC;IACD,OAAO,CAAC,CAAA;AACZ,CAAC;AAmDL,MAAa,gBAAiB,SAAQ,iCAAa;IAM/C,YAAY,SAA0B;QAClC,IAAI,SAAS,EAAE,CAAC;YACZ,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAc,SAAS,EAAlB,IAAI,kBAAK,SAAS,EAAzC,sBAA6B,CAAY,CAAA;YAC/C,KAAK,CAAC,IAAI,CAAC,CAAA;YACX,IAAI,QAAQ,EAAE,CAAC;gBACX,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;YAC9B,CAAC;YACD,IAAI,MAAM,EAAE,CAAC;gBACT,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;YAC1B,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,KAAK,EAAE,CAAA;QACX,CAAC;IACL,CAAC;IAED,WAAW,CAAC,QAA0E;QAClF,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,OAAO,IAAI,CAAA;IACf,CAAC;IAED,SAAS,CAAC,MAAmC;QACzC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,OAAO,IAAI,CAAA;IACf,CAAC;IAED,QAAQ,CAAC,KAAe;QACpB,MAAM,UAAU,GAA+G,EAAE,CAAC;QAClI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YACrC,IAAI,IAAI,CAAC,MAAM,YAAY,aAAa,EAAE,CAAC;gBACvC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAA;YACzC,CAAC;iBAAM,CAAC;gBACJ,UAAU,CAAC,MAAM,GAAG,IAAI,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAA;YACxE,CAAC;QACL,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;YACvC,UAAU,CAAC,QAAQ,GAAG,EAAE,CAAA;YACxB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;gBAClC,IAAI,OAAO,YAAY,cAAc,EAAE,CAAC;oBACpC,IAAI,KAAK,EAAE,CAAC;wBACR,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAA;oBACjD,CAAC;yBAAM,CAAC;wBACJ,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;oBAC5C,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,OAAO,CAAA;gBACtC,CAAC;YACL,CAAC;QACL,CAAC;QACD,MAAM,IAAI,GAAoB,IAAA,wBAAU,EAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;QACvE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO;QACH,uCAAY,KAAK,CAAC,QAAQ,EAAE,KAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAG;IACjF,CAAC;CACJ;AA9DD,4CA8DC;AAED,MAAa,kBAAkB;IAO3B,YAAY,IAAa;QALf,YAAO,GAAqC,EAAE,CAAC;QAMrD,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,WAAmB;QAC9B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,CAAC,IAAY;QAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,WAAW,CAAC,UAAmB;QAC3B,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC;QAC3B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,cAAsB;QACzB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,UAAU;QACN,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,YAAY,CAAC,WAAmB,EAAE,YAA+C,EAAE;QAC/E,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAClC,IAAI,SAAS,YAAY,gBAAgB,EAAE,CAAC;YACxC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;QAC1C,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,GAAG;QACC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,cAAc,IAAI,8BAA8B,IAAI,CAAC,IAAI,EAAE,EAAE,CAAA;IACrF,CAAC;IAED,SAAS;;QACL,MAAM,MAAM,GAA4B,EAAE,CAAA;QAC1C,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACrC,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,CAAA;YAC1D,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,CAAA;YAC3C,MAAM,CAAC,IAAI,GAAG,KAAK,CAAA;YACnB,IAAI,WAAW,KAAK,qBAAqB,EAAE,CAAC;gBACxC,MAAM,CAAC,IAAI,GAAG,WAAW,CAAA;gBACzB,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAA;gBACpB,IAAI,aAAa,EAAE,CAAC;oBAChB,IAAI,aAAa,YAAY,aAAa,EAAE,CAAC;wBACzC,MAAM,SAAS,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAA;wBAC1C,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;4BACvB,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;gCACrC,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;gCAC5C,IAAI,MAAM,IAAI,UAAU,EAAE,CAAC;oCACvB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;wCACjB,GAAG;wCACH,IAAI,EAAE,MAAM;qCACf,CAAC,CAAA;gCACN,CAAC;qCAAM,CAAC;oCACJ,MAAM,SAAS,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAA;oCAC/D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;wCACjB,GAAG;wCACH,IAAI,EAAE,SAAS;wCACf,WAAW,EAAE,UAAU,CAAC,WAAW;wCACnC,GAAG,EAAE,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;wCAC1C,QAAQ,EAAE,CAAA,MAAA,SAAS,CAAC,QAAQ,0CAAE,QAAQ,CAAC,GAAG,CAAC,EAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;qCAC7D,CAAC,CAAA;gCACN,CAAC;4BACL,CAAC;wBACL,CAAC;oBACL,CAAC;gBACL,CAAC;YACL,CAAC;iBAAM,IAAI,CAAC,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACnE,MAAM,CAAC,IAAI,GAAG,MAAM,CAAA;gBACpB,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAA;YAC3B,CAAC;iBAAM,CAAC;gBACJ,mBAAmB;gBACnB,IAAI,OAAO,cAAc,CAAC,OAAO,KAAK,WAAW,EAAE,CAAC;oBAChD,MAAM,CAAC,GAAG,GAAG,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;gBAC7C,CAAC;gBACD,IAAI,OAAO,cAAc,CAAC,QAAQ,KAAK,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACtG,KAAK,MAAM,GAAG,IAAI,cAAc,CAAC,QAAQ,EAAE,CAAC;wBACxC,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;wBAC7C,IAAI,OAAO,YAAY,cAAc,EAAE,CAAC;4BACpC,MAAM,CAAC,GAAG,GAAG,GAAG,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;4BACrC,MAAM;wBACV,CAAC;6BAAM,IAAI,OAAO,IAAI,OAAO,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,WAAW,EAAE,CAAC;4BAC/E,MAAM,CAAC,GAAG,GAAG,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;4BAChC,MAAM;wBACV,CAAC;oBACL,CAAC;gBACL,CAAC;YACL,CAAC;YACD,MAAM;QACV,CAAC;QACD,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,SAAS;QACL,MAAM,OAAO,GAAwC,EAAE,CAAA;QACvD,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;YACzC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAA;QAC7C,CAAC;QACD,MAAM,MAAM,GAA6B;YACrC,OAAO;SACV,CAAA;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACzC,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACpB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAA;QAC1B,CAAC;QAED,OAAO,MAAM,CAAA;IACjB,CAAC;CACJ;AA9ID,gDA8IC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,gCAAY;IAC7C,YAAY,IAAa;QACrB,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,IAAI;YACL,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACxB,CAAC;IAGD,qBAAqB,CAAC,OAAgC,EAAE;QACpD,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,GAAG,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,GAAG,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO;gBACH,CAAC,IAAI,CAAC,EAAE;oBACJ,IAAI,EAAE,IAAI,CAAC,GAAG;iBACjB;aACJ,CAAC;QACN,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO;gBACH,CAAC,IAAI,CAAC,EAAE;oBACJ,IAAI,EAAE,IAAI,CAAC,GAAG;iBACjB;aACJ,CAAC;QACN,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO;gBACH,CAAC,IAAI,CAAC,EAAE;oBACJ,IAAI,EAAE,0BAA0B,IAAI,CAAC,IAAI,EAAE;iBAC9C;aACJ,CAAA;QACL,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED,WAAW;QACP,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAA;IAC3C,CAAC;CACJ;AAjDD,0CAiDC;AAED,MAAa,sBAAuB,SAAQ,uCAAmB;IAC3D,SAAS;QACL,MAAM,IAAI,GAA4B,EAAE,CAAC;QACzC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5B,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAChC,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,YAAY,eAAe,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACzD,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;IACL,CAAC;CACJ;AArBD,wDAqBC;AAED,MAAa,oBAAqB,SAAQ,qCAAiB;IACvD,YAAY,aAAiC;QACzC,KAAK,CAAC,aAAa,CAAC,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACvC,CAAC;IACD,qBAAqB;QACjB,IAAI,CAAC,GAAqD,EAAE,CAAC;QAC7D,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACjC,IAAI,OAAO,YAAY,eAAe,EAAE,CAAC;gBACrC,CAAC,mCAAQ,CAAC,GAAK,OAAO,CAAC,qBAAqB,EAAE,CAAE,CAAC;YACrD,CAAC;iBAAM,CAAC;gBACJ,CAAC,mCAAQ,CAAC,GAAK,OAAO,CAAC,SAAS,EAAE,CAAE,CAAC;YACzC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,CAAC;IACb,CAAC;CACJ;AAhBD,oDAgBC;AAED,SAAgB,cAAc,CAC1B,GAAG,QAA4B;IAE/B,OAAO,IAAI,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AAC7C,CAAC"}

package/lib/services/docs/docs-modifiers.d.ts

@@ -0,0 +1,108 @@
+import { ContextResponseUtil, GroupResponseUtil, IOpenAPIResponseContext, MediaTypeUtil, ReferenceObject, ResponseUtil, SchemaObject3_1 } from '@novice1/api-doc-generator';
+import { ExampleObject, MediaTypeObject, ResponseObject } from '@novice1/api-doc-generator/lib/generators/openapi/definitions';
+import { RequestBodyObject } from '@novice1/api-doc-generator/lib/generators/postman/definitions';
+import { BaseResponseUtil } from '@novice1/api-doc-generator/lib/utils/responses/baseResponseUtils';
+export type SchemaModel = Omit<SchemaObject3_1, 'allOf' | 'anyOf' | 'oneOf' | 'not' | 'items' | 'properties' | 'additionalProperties'> & {
+    allOf?: Array<SchemaModel | ISchemaModifier>;
+    anyOf?: Array<SchemaModel | ISchemaModifier>;
+    oneOf?: Array<SchemaModel | ISchemaModifier>;
+    not?: SchemaModel | ISchemaModifier;
+    items?: SchemaModel | ISchemaModifier;
+    properties?: Record<string, SchemaModel | ISchemaModifier>;
+    additionalProperties?: boolean | SchemaModel | ISchemaModifier;
+};
+export interface ISchemaModifier {
+    ref(): ReferenceObject;
+    toObject(): SchemaObject3_1;
+}
+export type MediaTypeModel = Omit<MediaTypeObject, 'schema' | 'examples'> & {
+    examples?: Record<string, ExampleObject | ReferenceObject | ExampleModifier>;
+    schema?: SchemaModel | ReferenceObject | SchemaModifier;
+};
+export interface OpenAPIRequestBodyObject {
+    content: Record<string, MediaTypeObject>;
+    description?: string;
+    required?: boolean;
+}
+export type PostmanRequestBodyModel = RequestBodyObject;
+export declare class ExampleModifier {
+    protected name: string;
+    protected value: unknown;
+    protected externalValue?: string;
+    protected summary?: string;
+    protected description?: string;
+    constructor(name: string, example?: ExampleObject);
+    getName(): string;
+    setValue(value: unknown): this;
+    getValue(): unknown;
+    setExternalValue(externalValue: string): this;
+    getExternalValue(): string | undefined;
+    setSummary(summary: string): this;
+    getSummary(): string | undefined;
+    setDescription(description: string): this;
+    getDescription(): string | undefined;
+    ref(): ReferenceObject;
+    toObject(): ExampleObject;
+    toJSON(): ExampleObject;
+}
+export declare class SchemaModifier implements ISchemaModifier {
+    #private;
+    protected name: string;
+    protected schema: SchemaModel;
+    constructor(name: string, schema?: SchemaModel);
+    getName(): string;
+    setSchema(schema: SchemaModel): this;
+    ref(): ReferenceObject;
+    toObject(): SchemaObject3_1;
+    toJSON(): SchemaObject3_1;
+}
+export declare class MediaTypeModifier extends MediaTypeUtil {
+    protected schema?: SchemaModel | SchemaModifier;
+    protected examples?: Record<string, ExampleObject | ReferenceObject | ExampleModifier>;
+    constructor(mediaType?: MediaTypeModel);
+    setExamples(examples: Record<string, ExampleObject | ReferenceObject | ExampleModifier>): this;
+    setSchema(schema: SchemaModel | SchemaModifier): this;
+    toObject(noRef?: boolean): MediaTypeObject;
+    toModel(): MediaTypeModel;
+}
+export declare class RequestBodyDocsModifier {
+    protected name: string;
+    protected content: Record<string, MediaTypeModifier>;
+    protected description?: string;
+    protected required?: boolean;
+    protected requestBodyRef?: string;
+    constructor(name?: string);
+    /**
+     *
+     * @param description A short description of the response.
+     * CommonMark syntax MAY be used for rich text representation.
+     */
+    setDescription(description: string): this;
+    setName(name: string): this;
+    setRequired(isRequired: boolean): this;
+    setRef(requestBodyRef: string): this;
+    getDescription(): string | undefined;
+    getName(): string;
+    isRequired(): boolean;
+    addMediaType(contentType: string, mediaType?: MediaTypeModel | MediaTypeModifier): this;
+    ref(): ReferenceObject;
+    toPostman(): PostmanRequestBodyModel;
+    toOpenAPI(): OpenAPIRequestBodyObject;
+}
+/**
+ * Set a name (setName) or a ref (setRef) for it to be used as a reference.
+ */
+export declare class ResponseDocsModifier extends ResponseUtil {
+    constructor(name?: string);
+    toOpenAPIRefPreferred(): Record<string, ResponseObject | ReferenceObject>;
+    toOpenAPIRefPreferred(ctxt: IOpenAPIResponseContext): Record<string, ResponseObject | ReferenceObject>;
+    withContext(): ContextResponseDocsModifier;
+}
+export declare class ContextResponseDocsModifier extends ContextResponseUtil {
+    toOpenAPI(): Record<string, ResponseObject | ReferenceObject>;
+}
+export declare class GroupResponseDocsModifier extends GroupResponseUtil {
+    constructor(responseUtils: BaseResponseUtil[]);
+    toOpenAPIRefPreferred(): Record<string, ResponseObject | ReferenceObject>;
+}
+export declare function groupResponses(...modifiers: BaseResponseUtil[]): GroupResponseDocsModifier;