@novice1/api-doc-json-helper 1.0.3 → 1.0.4

package/lib/BaseJsonHelper.d.ts

@@ -0,0 +1,31 @@
+import { BaseHelperInterface } from '@novice1/api-doc-generator/lib/helpers/baseHelper';
+/**
+ * JSON schema (draft-07) helper for \@novice1/api-doc-generator
+ */
+export declare abstract class BaseJsonHelper implements BaseHelperInterface {
+    protected _schema: object;
+    protected _isRequired: boolean;
+    constructor({ value: schema }: {
+        value?: object | unknown;
+        isRoot?: boolean;
+    }, isRequired?: boolean);
+    protected hasMeta(v: string): boolean;
+    protected getMeta(v: string): unknown;
+    isValid(): boolean;
+    getType(): string;
+    getDescription(): string;
+    isRequired(): boolean;
+    isUnique(): boolean;
+    hasDefaultValue(): boolean;
+    getDefaultValue(): unknown;
+    hasExampleValue(): boolean;
+    getExampleValue(): unknown;
+    isDeprecated(): boolean;
+    allowsEmptyValue(): boolean;
+    getEnum(): unknown[];
+    hasMin(): boolean;
+    hasMax(): boolean;
+    getMin(): number | undefined;
+    getMax(): number | undefined;
+    getUnit(): string;
+}

package/lib/BaseJsonHelper.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseJsonHelper = void 0;
+/**
+ * JSON schema (draft-07) helper for \@novice1/api-doc-generator
+ */
+class BaseJsonHelper {
+    constructor({ value: schema = {} }, isRequired) {
+        this._isRequired = false;
+        this._schema = {};
+        if (schema && typeof schema === 'object') {
+            const s = schema;
+            this._schema = s;
+        }
+        if (isRequired) {
+            this._isRequired = isRequired;
+        }
+    }
+    hasMeta(v) {
+        if (!this.isValid()) {
+            return false;
+        }
+        return 'meta' in this._schema &&
+            this._schema.meta &&
+            typeof this._schema.meta === 'object' &&
+            v in this._schema.meta && typeof this._schema.meta[v] !== 'undefined' ?
+            true : false;
+    }
+    getMeta(v) {
+        if (!this.hasMeta(v)) {
+            return;
+        }
+        return 'meta' in this._schema &&
+            this._schema.meta &&
+            typeof this._schema.meta === 'object' &&
+            v in this._schema.meta && this._schema.meta[v];
+    }
+    isValid() {
+        return !!(this._schema && typeof this._schema === 'object' &&
+            (('type' in this._schema && typeof this._schema.type === 'string') ||
+                ('oneOf' in this._schema && Array.isArray(this._schema.oneOf)) ||
+                ('anyOf' in this._schema && Array.isArray(this._schema.anyOf))));
+    }
+    getType() {
+        let r = '';
+        if ('type' in this._schema && typeof this._schema.type === 'string') {
+            r = this._schema.type;
+        }
+        if ('format' in this._schema && typeof this._schema.format === 'string') {
+            r = this._schema.format;
+        }
+        return r;
+    }
+    getDescription() {
+        let r = '';
+        if ('description' in this._schema && typeof this._schema.description === 'string') {
+            r = this._schema.description;
+        }
+        return r;
+    }
+    isRequired() {
+        return this._isRequired;
+    }
+    isUnique() {
+        return !!('uniqueItems' in this._schema && this._schema.uniqueItems);
+    }
+    hasDefaultValue() {
+        return !!('default' in this._schema && typeof this._schema.default != 'undefined');
+    }
+    getDefaultValue() {
+        return 'default' in this._schema ? this._schema.default : undefined;
+    }
+    hasExampleValue() {
+        const schema = this._schema;
+        return !!('examples' in schema && Array.isArray(schema.examples) && schema.examples.length);
+    }
+    getExampleValue() {
+        const schema = this._schema;
+        if ('examples' in schema && Array.isArray(schema.examples) && schema.examples.length) {
+            return schema.examples[0];
+        }
+        return;
+    }
+    isDeprecated() {
+        return !!('deprecated' in this._schema && this._schema.deprecated);
+    }
+    allowsEmptyValue() {
+        let r = false;
+        if ('enum' in this._schema && Array.isArray(this._schema.enum)) {
+            const enume = this._schema.enum;
+            r = ['', null].some(v => enume.includes(v));
+        }
+        return r;
+    }
+    getEnum() {
+        let r = [];
+        if ('enum' in this._schema && Array.isArray(this._schema.enum)) {
+            r = this._schema.enum;
+        }
+        else if ('anyOf' in this._schema && Array.isArray(this._schema.anyOf)) {
+            for (const p of this._schema.anyOf) {
+                if (p && typeof p === 'object' && 'const' in p) {
+                    r.push(p.const);
+                }
+            }
+        }
+        return r;
+    }
+    hasMin() {
+        return 'minProperties' in this._schema || 'minItems' in this._schema || 'minimum' in this._schema || 'minLength' in this._schema;
+    }
+    hasMax() {
+        return 'maxProperties' in this._schema || 'maxItems' in this._schema || 'maximum' in this._schema || 'maxLength' in this._schema;
+    }
+    getMin() {
+        if ('minProperties' in this._schema && typeof this._schema.minProperties === 'number') {
+            return this._schema.minProperties;
+        }
+        if ('minItems' in this._schema && typeof this._schema.minItems === 'number') {
+            return this._schema.minItems;
+        }
+        if ('minimum' in this._schema && typeof this._schema.minimum === 'number') {
+            return this._schema.minimum;
+        }
+        if ('minLength' in this._schema && typeof this._schema.minLength === 'number') {
+            return this._schema.minLength;
+        }
+        return;
+    }
+    getMax() {
+        if ('maxProperties' in this._schema && typeof this._schema.maxProperties === 'number') {
+            return this._schema.maxProperties;
+        }
+        if ('maxItems' in this._schema && typeof this._schema.maxItems === 'number') {
+            return this._schema.maxItems;
+        }
+        if ('maximum' in this._schema && typeof this._schema.maximum === 'number') {
+            return this._schema.maximum;
+        }
+        if ('maxLength' in this._schema && typeof this._schema.maxLength === 'number') {
+            return this._schema.maxLength;
+        }
+        return;
+    }
+    getUnit() {
+        const unit = this.getMeta('unit');
+        if (typeof unit === 'string') {
+            return unit;
+        }
+        return '';
+    }
+}
+exports.BaseJsonHelper = BaseJsonHelper;
+//# sourceMappingURL=BaseJsonHelper.js.map

package/lib/BaseJsonHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseJsonHelper.js","sourceRoot":"","sources":["../src/BaseJsonHelper.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAsB,cAAc;IAIhC,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,EAAE,EAAkD,EAAE,UAAoB;QAF9F,gBAAW,GAAG,KAAK,CAAA;QAGzB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,CAAC,GAAG,MAAiC,CAAA;YAC3C,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;QACpB,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACb,IAAI,CAAC,WAAW,GAAG,UAAU,CAAA;QACjC,CAAC;IACL,CAAC;IAES,OAAO,CAAC,CAAS;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,MAAM,IAAI,IAAI,CAAC,OAAO;YACzB,IAAI,CAAC,OAAO,CAAC,IAAI;YACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ;YACrC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,OAAQ,IAAI,CAAC,OAAO,CAAC,IAAqC,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC;YACzG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IACrB,CAAC;IAES,OAAO,CAAC,CAAS;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACnB,OAAO;QACX,CAAC;QACD,OAAO,MAAM,IAAI,IAAI,CAAC,OAAO;YACzB,IAAI,CAAC,OAAO,CAAC,IAAI;YACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ;YACrC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,IAAK,IAAI,CAAC,OAAO,CAAC,IAAqC,CAAC,CAAC,CAAC,CAAC;IACzF,CAAC;IAED,OAAO;QACH,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ;YACtD,CACI,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC;gBACjE,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC9D,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CACjE,CAAC,CAAA;IACV,CAAC;IACD,OAAO;QACH,IAAI,CAAC,GAAG,EAAE,CAAA;QAEV,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAClE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;QACzB,CAAC;QAED,IAAI,QAAQ,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACtE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;QAC3B,CAAC;QAED,OAAO,CAAC,CAAC;IACb,CAAC;IACD,cAAc;QACV,IAAI,CAAC,GAAG,EAAE,CAAA;QAEV,IAAI,aAAa,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YAChF,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAA;QAChC,CAAC;QAED,OAAO,CAAC,CAAC;IACb,CAAC;IACD,UAAU;QACN,OAAO,IAAI,CAAC,WAAW,CAAA;IAC3B,CAAC;IACD,QAAQ;QACJ,OAAO,CAAC,CAAC,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IACxE,CAAC;IACD,eAAe;QACX,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,WAAW,CAAC,CAAA;IACtF,CAAC;IACD,eAAe;QACX,OAAO,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;IACvE,CAAC;IACD,eAAe;QACX,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,CAAC,CAAC,CAAC,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC/F,CAAC;IACD,eAAe;QACX,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACnF,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;QAC7B,CAAC;QACD,OAAM;IACV,CAAC;IACD,YAAY;QACR,OAAO,CAAC,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IACtE,CAAC;IACD,gBAAgB;QACZ,IAAI,CAAC,GAAG,KAAK,CAAC;QACd,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;YAC/B,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/C,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,OAAO;QACH,IAAI,CAAC,GAAc,EAAE,CAAA;QACrB,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;QACzB,CAAC;aAAM,IAAI,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACtE,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACjC,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,EAAE,CAAC;oBAC7C,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;gBACnB,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,MAAM;QACF,OAAO,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,CAAA;IACpI,CAAC;IACD,MAAM;QACF,OAAO,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,CAAA;IACpI,CAAC;IACD,MAAM;QACF,IAAI,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;YACpF,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAA;QACrC,CAAC;QACD,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAA;QAChC,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACxE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAA;QAC/B,CAAC;QACD,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAA;QACjC,CAAC;QACD,OAAM;IACV,CAAC;IACD,MAAM;QACF,IAAI,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;YACpF,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAA;QACrC,CAAC;QACD,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAA;QAChC,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACxE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAA;QAC/B,CAAC;QACD,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAA;QACjC,CAAC;QACD,OAAM;IACV,CAAC;IACD,OAAO;QACH,MAAM,IAAI,GAAY,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QAC1C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAA;QACf,CAAC;QACD,OAAO,EAAE,CAAA;IACb,CAAC;CAEJ;AA7JD,wCA6JC"}

package/lib/OpenAPIJsonHelper.d.ts

@@ -0,0 +1,25 @@
+import { OpenAPIHelperInterface } from '@novice1/api-doc-generator';
+import { AdditionalProperties, DiscriminatorObject, XMLObject, ExampleObject, ReferenceObject, EncodingObject } from '@novice1/api-doc-generator/lib/generators/openapi/definitions';
+import { BaseJsonHelper } from './BaseJsonHelper';
+/**
+ * JSON schema (draft-07) helper for \@novice1/api-doc-generator
+ */
+export declare class OpenAPIJsonHelper extends BaseJsonHelper implements OpenAPIHelperInterface {
+    getFirstItem(): OpenAPIJsonHelper | undefined;
+    getChildren(): Record<string, OpenAPIJsonHelper>;
+    getAlternatives(): OpenAPIJsonHelper[];
+    hasStyle(): boolean;
+    getStyle(): string;
+    hasAdditionalProperties(): boolean;
+    getAdditionalProperties(): AdditionalProperties;
+    hasRef(): boolean;
+    getRef(): string | undefined;
+    hasDiscriminator(): boolean;
+    getDiscriminator(): DiscriminatorObject | undefined;
+    hasXml(): boolean;
+    getXml(): XMLObject | undefined;
+    hasExamples?(): boolean;
+    getExamples?(): Record<string, ExampleObject | ReferenceObject> | undefined;
+    hasEncoding?(): boolean;
+    getEncoding?(): Record<string, EncodingObject> | undefined;
+}

package/lib/OpenAPIJsonHelper.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAPIJsonHelper = void 0;
+const BaseJsonHelper_1 = require("./BaseJsonHelper");
+/**
+ * JSON schema (draft-07) helper for \@novice1/api-doc-generator
+ */
+class OpenAPIJsonHelper extends BaseJsonHelper_1.BaseJsonHelper {
+    getFirstItem() {
+        const schema = this._schema;
+        if ('items' in schema && typeof schema.items === 'object') {
+            return new OpenAPIJsonHelper({ value: schema.items });
+        }
+        return;
+    }
+    getChildren() {
+        const r = {};
+        const schema = this._schema;
+        if ('properties' in schema && typeof schema.properties === 'object' && schema.properties) {
+            const properties = schema.properties;
+            for (const p in properties) {
+                const isRequired = 'required' in schema && Array.isArray(schema.required) && schema.required.includes(p);
+                r[p] = new OpenAPIJsonHelper({ value: properties[p] }, isRequired);
+            }
+        }
+        return r;
+    }
+    getAlternatives() {
+        const r = [];
+        const schema = this._schema;
+        if ('oneOf' in schema && Array.isArray(schema.oneOf)) {
+            for (const p of schema.oneOf) {
+                r.push(new OpenAPIJsonHelper({ value: p }));
+            }
+        }
+        return r;
+    }
+    hasStyle() {
+        return typeof this.getMeta('style') === 'string';
+    }
+    getStyle() {
+        const style = this.getMeta('style');
+        if (typeof style === 'string') {
+            return style;
+        }
+        return '';
+    }
+    hasAdditionalProperties() {
+        const schema = this._schema;
+        return !!('additionalProperties' in schema && schema.additionalProperties);
+    }
+    getAdditionalProperties() {
+        const schema = this._schema;
+        return 'additionalProperties' in schema && schema.additionalProperties;
+    }
+    hasRef() {
+        const schema = this._schema;
+        return !!('$ref' in schema && typeof schema.$ref === 'string');
+    }
+    getRef() {
+        const schema = this._schema;
+        return '$ref' in schema && typeof schema.$ref === 'string' ? schema.$ref : undefined;
+    }
+    hasDiscriminator() {
+        return !!('discriminator' in this._schema &&
+            this._schema.discriminator &&
+            typeof this._schema.discriminator === 'object' &&
+            'propertyName' in this._schema.discriminator &&
+            this._schema.discriminator.propertyName &&
+            typeof this._schema.discriminator.propertyName === 'string');
+    }
+    getDiscriminator() {
+        return 'discriminator' in this._schema &&
+            this._schema.discriminator &&
+            typeof this._schema.discriminator === 'object' &&
+            'propertyName' in this._schema.discriminator &&
+            this._schema.discriminator.propertyName &&
+            typeof this._schema.discriminator.propertyName === 'string' ?
+            this._schema.discriminator :
+            undefined;
+    }
+    hasXml() {
+        const xmlMeta = this.getMeta('xml');
+        return !!(xmlMeta && typeof xmlMeta === 'object');
+    }
+    getXml() {
+        return this.getMeta('xml');
+    }
+    hasExamples() {
+        const schema = this._schema;
+        return !!('examples' in schema && Array.isArray(schema.examples));
+    }
+    getExamples() {
+        const schema = this._schema;
+        if ('examples' in schema && Array.isArray(schema.examples)) {
+            const r = {};
+            let i = 1;
+            for (const value of schema.examples) {
+                r[`${i}`] = {
+                    value
+                };
+                i++;
+            }
+            return r;
+        }
+        return;
+    }
+    hasEncoding() {
+        const encodingMeta = this.getMeta('encoding');
+        return !!(encodingMeta && typeof encodingMeta === 'object');
+    }
+    getEncoding() {
+        return this.getMeta('encoding');
+    }
+}
+exports.OpenAPIJsonHelper = OpenAPIJsonHelper;
+//# sourceMappingURL=OpenAPIJsonHelper.js.map

package/lib/OpenAPIJsonHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAPIJsonHelper.js","sourceRoot":"","sources":["../src/OpenAPIJsonHelper.ts"],"names":[],"mappings":";;;AASA,qDAAkD;AAElD;;GAEG;AACH,MAAa,iBAAkB,SAAQ,+BAAc;IAGjD,YAAY;QAER,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAE3B,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxD,OAAO,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAA;QACzD,CAAC;QAED,OAAM;IACV,CAAC;IACD,WAAW;QACP,MAAM,CAAC,GAAsC,EAAE,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,YAAY,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACvF,MAAM,UAAU,GAA4B,MAAM,CAAC,UAAqC,CAAA;YACxF,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;gBACzB,MAAM,UAAU,GAAY,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;gBACjH,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;YACtE,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,eAAe;QACX,MAAM,CAAC,GAAwB,EAAE,CAAA;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,OAAO,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC3B,CAAC,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;YAC/C,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAA;IACZ,CAAC;IACD,QAAQ;QACJ,OAAO,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAA;IACpD,CAAC;IACD,QAAQ;QACJ,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACnC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAA;QAChB,CAAC;QACD,OAAO,EAAE,CAAA;IACb,CAAC;IACD,uBAAuB;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,CAAC,CAAC,CAAC,sBAAsB,IAAI,MAAM,IAAI,MAAM,CAAC,oBAAoB,CAAC,CAAA;IAC9E,CAAC;IACD,uBAAuB;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,sBAAsB,IAAI,MAAM,IAAK,MAAM,CAAC,oBAA6C,CAAA;IACpG,CAAC;IACD,MAAM;QACF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,CAAC,CAAC,CAAC,MAAM,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAA;IAClE,CAAC;IACD,MAAM;QACF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,MAAM,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAA;IACxF,CAAC;IACD,gBAAgB;QACZ,OAAO,CAAC,CAAC,CAAC,eAAe,IAAI,IAAI,CAAC,OAAO;YACrC,IAAI,CAAC,OAAO,CAAC,aAAa;YAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,QAAQ;YAC9C,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa;YAC5C,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY;YACvC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAA;IACpE,CAAC;IACD,gBAAgB;QACZ,OAAO,eAAe,IAAI,IAAI,CAAC,OAAO;YAClC,IAAI,CAAC,OAAO,CAAC,aAAa;YAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,QAAQ;YAC9C,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa;YAC5C,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY;YACvC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAC;YACxD,IAAI,CAAC,OAAO,CAAC,aAAqC,CAAC,CAAC;YACpD,SAAS,CAAA;IACtB,CAAC;IACD,MAAM;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACnC,OAAO,CAAC,CAAC,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAA;IACrD,CAAC;IACD,MAAM;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAA0B,CAAA;IACvD,CAAC;IACD,WAAW;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,CAAC,CAAC,CAAC,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;IACrE,CAAC;IACD,WAAW;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzD,MAAM,CAAC,GAAoD,EAAE,CAAC;YAC9D,IAAI,CAAC,GAAG,CAAC,CAAA;YACT,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAClC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG;oBACR,KAAK;iBACR,CAAA;gBACD,CAAC,EAAE,CAAA;YACP,CAAC;YACD,OAAO,CAAC,CAAA;QACZ,CAAC;QACD,OAAM;IACV,CAAC;IACD,WAAW;QACP,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QAC7C,OAAO,CAAC,CAAC,CAAC,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAA;IAC/D,CAAC;IACD,WAAW;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAA+C,CAAA;IACjF,CAAC;CAEJ;AAjHD,8CAiHC"}

package/lib/PostmanJsonHelper.d.ts

@@ -0,0 +1,14 @@
+import { PostmanHelperInterface } from '@novice1/api-doc-generator';
+import { XMLObject } from '@novice1/api-doc-generator/lib/generators/openapi/definitions';
+import { BaseJsonHelper } from './BaseJsonHelper';
+export declare class PostmanJsonHelper extends BaseJsonHelper implements PostmanHelperInterface {
+    getFirstItem(): PostmanJsonHelper | undefined;
+    getChildren(): Record<string, PostmanJsonHelper>;
+    getAlternatives(): PostmanJsonHelper[];
+    hasContentType(): boolean;
+    getContentType(): string | undefined;
+    hasDescriptionType(): boolean;
+    getDescriptionType(): string | undefined;
+    hasXml(): boolean;
+    getXml(): XMLObject | undefined;
+}

package/lib/PostmanJsonHelper.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostmanJsonHelper = void 0;
+const BaseJsonHelper_1 = require("./BaseJsonHelper");
+class PostmanJsonHelper extends BaseJsonHelper_1.BaseJsonHelper {
+    getFirstItem() {
+        const schema = this._schema;
+        if ('items' in schema && typeof schema.items === 'object') {
+            return new PostmanJsonHelper({ value: schema.items });
+        }
+        return;
+    }
+    getChildren() {
+        const r = {};
+        const schema = this._schema;
+        if ('properties' in schema && typeof schema.properties === 'object' && schema.properties) {
+            const properties = schema.properties;
+            for (const p in properties) {
+                const isRequired = 'required' in schema && Array.isArray(schema.required) && schema.required.includes(p);
+                r[p] = new PostmanJsonHelper({ value: properties[p] }, isRequired);
+            }
+        }
+        return r;
+    }
+    getAlternatives() {
+        const r = [];
+        const schema = this._schema;
+        if ('oneOf' in schema && Array.isArray(schema.oneOf)) {
+            for (const p of schema.oneOf) {
+                r.push(new PostmanJsonHelper({ value: p }));
+            }
+        }
+        return r;
+    }
+    hasContentType() {
+        return typeof this.getMeta('contentType') === 'string';
+    }
+    getContentType() {
+        const contentType = this.getMeta('contentType');
+        if (typeof contentType === 'string') {
+            return contentType;
+        }
+        return;
+    }
+    hasDescriptionType() {
+        return typeof this.getMeta('descriptionType') === 'string';
+    }
+    getDescriptionType() {
+        const descriptionType = this.getMeta('descriptionType');
+        if (typeof descriptionType === 'string') {
+            return descriptionType;
+        }
+        return;
+    }
+    hasXml() {
+        const xmlMeta = this.getMeta('xml');
+        return !!(xmlMeta && typeof xmlMeta === 'object');
+    }
+    getXml() {
+        return this.getMeta('xml');
+    }
+}
+exports.PostmanJsonHelper = PostmanJsonHelper;
+//# sourceMappingURL=PostmanJsonHelper.js.map

package/lib/PostmanJsonHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PostmanJsonHelper.js","sourceRoot":"","sources":["../src/PostmanJsonHelper.ts"],"names":[],"mappings":";;;AAEA,qDAAkD;AAGlD,MAAa,iBAAkB,SAAQ,+BAAc;IAEjD,YAAY;QAER,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAE3B,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxD,OAAO,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAA;QACzD,CAAC;QAED,OAAM;IACV,CAAC;IACD,WAAW;QACP,MAAM,CAAC,GAAsC,EAAE,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,YAAY,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACvF,MAAM,UAAU,GAA4B,MAAM,CAAC,UAAqC,CAAA;YACxF,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;gBACzB,MAAM,UAAU,GAAY,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;gBACjH,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;YACtE,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,eAAe;QACX,MAAM,CAAC,GAAwB,EAAE,CAAA;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,OAAO,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC3B,CAAC,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;YAC/C,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAA;IACZ,CAAC;IAED,cAAc;QACV,OAAO,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,QAAQ,CAAA;IAC1D,CAAC;IAED,cAAc;QACV,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QAC/C,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,WAAW,CAAA;QACtB,CAAC;QACD,OAAM;IACV,CAAC;IAED,kBAAkB;QACd,OAAO,OAAO,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,QAAQ,CAAA;IAC9D,CAAC;IAED,kBAAkB;QACd,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;QACvD,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;YACtC,OAAO,eAAe,CAAA;QAC1B,CAAC;QACD,OAAM;IACV,CAAC;IAED,MAAM;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACnC,OAAO,CAAC,CAAC,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAA;IACrD,CAAC;IACD,MAAM;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAA0B,CAAA;IACvD,CAAC;CACJ;AAlED,8CAkEC"}

package/lib/index.d.ts

@@ -1,2 +1,2 @@
-export * from './openapi';
-export * from './postman';
+export * from './OpenAPIJsonHelper';
+export * from './PostmanJsonHelper';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./openapi"), exports);
-tslib_1.__exportStar(require("./postman"), exports);
+tslib_1.__exportStar(require("./OpenAPIJsonHelper"), exports);
+tslib_1.__exportStar(require("./PostmanJsonHelper"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,oDAAyB;AACzB,oDAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,8DAAmC;AACnC,8DAAmC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@novice1/api-doc-json-helper",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "",
   "main": "lib/index.js",
   "scripts": {