@novice1/api-doc-json-helper 0.1.0 → 0.1.1

package/README.md

@@ -95,6 +95,52 @@ const router = routing()
 //...
 ```
 
+## Postman Specification
+
+```ts
+import { 
+  Postman 
+} from '@novice1/api-doc-generator';
+import { 
+    PostmanJsonHelper 
+} from '@novice1/api-doc-json-helper';
+import routing from '@novice1/routing';
+
+PostmanJsonHelper.schemaProperty = 'jsonSchemas'
+
+const postman = new Postman(PostmanJsonHelper);
+
+const router = routing()
+  .get({
+    name: 'Main app',
+    path: '/app',
+    auth: true,
+    tags: ['default'],
+    parameters: {
+        
+        jsonSchemas: {
+            query: {
+                '$schema': 'http://json-schema.org/draft-07/schema#',
+                type: 'object',
+                properties: {
+                    version: {
+                        type: 'string',
+                        description: 'version number',
+                        enum: ['1','2','3'],
+                        default: '2'
+                    }
+                }
+            }
+        }
+
+    }
+}, function (req, res) {
+    res.json(req.query.version)
+});
+
+//...
+```
+
 ## References
 
 - [@novice1/api-doc-generator](https://kisiwu.github.io/novice-api-doc-generator/latest/)

package/lib/index.d.ts

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

package/lib/index.js

@@ -2,4 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./openapi"), exports);
+tslib_1.__exportStar(require("./postman"), 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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,oDAAyB;AACzB,oDAAyB"}

package/lib/postman.d.ts

@@ -0,0 +1,29 @@
+import { PostmanHelperInterface } from '@novice1/api-doc-generator';
+import { XMLObject } from '@novice1/api-doc-generator/lib/generators/openapi/definitions';
+export declare class PostmanJsonHelper implements PostmanHelperInterface {
+    protected _schema: object;
+    protected _isRequired: boolean;
+    static schemaProperty: string;
+    constructor(schema?: object | unknown, isRequired?: boolean);
+    getFirstItem(): PostmanJsonHelper | undefined;
+    getChildren(): Record<string, PostmanJsonHelper>;
+    getAlternatives(): PostmanJsonHelper[];
+    getXml?(): XMLObject | undefined;
+    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/postman.js

@@ -0,0 +1,163 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostmanJsonHelper = void 0;
+class PostmanJsonHelper {
+    constructor(schema = {}, isRequired) {
+        this._isRequired = false;
+        this._schema = {};
+        if (schema && typeof schema === 'object') {
+            const s = schema;
+            this._schema = s;
+            if (PostmanJsonHelper.schemaProperty && PostmanJsonHelper.schemaProperty in s) {
+                const s2 = s[PostmanJsonHelper.schemaProperty];
+                if (s2 && typeof s2 === 'object') {
+                    this._schema = s2;
+                }
+            }
+            if (!('type' in this._schema)) {
+                this._schema = {
+                    type: 'object',
+                    properties: this._schema
+                };
+            }
+        }
+        if (isRequired) {
+            this._isRequired = isRequired;
+        }
+    }
+    getFirstItem() {
+        const schema = this._schema;
+        if ('items' in schema && typeof schema.items === 'object') {
+            return new PostmanJsonHelper(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(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(p));
+            }
+        }
+        return r;
+    }
+    getXml() {
+        return;
+    }
+    isValid() {
+        return !!(this._schema && typeof this._schema === 'object');
+    }
+    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;
+        }
+        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() {
+        return '';
+    }
+}
+exports.PostmanJsonHelper = PostmanJsonHelper;
+PostmanJsonHelper.schemaProperty = '';
+//# sourceMappingURL=postman.js.map

package/lib/postman.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postman.js","sourceRoot":"","sources":["../src/postman.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAM1B,YAAY,SAA2B,EAAE,EAAE,UAAoB;QAJrD,gBAAW,GAAG,KAAK,CAAA;QAKzB,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;YAChB,IAAI,iBAAiB,CAAC,cAAc,IAAI,iBAAiB,CAAC,cAAc,IAAI,CAAC,EAAE,CAAC;gBAC5E,MAAM,EAAE,GAAG,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAA;gBAC9C,IAAI,EAAE,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;oBAC/B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;gBACrB,CAAC;YACL,CAAC;YACD,IAAI,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5B,IAAI,CAAC,OAAO,GAAG;oBACX,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE,IAAI,CAAC,OAAO;iBAC3B,CAAA;YACL,CAAC;QACL,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACb,IAAI,CAAC,WAAW,GAAG,UAAU,CAAA;QACjC,CAAC;IACL,CAAC;IACD,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,MAAM,CAAC,KAAK,CAAC,CAAA;QAC9C,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,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;YAC3D,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,CAAC,CAAC,CAAC,CAAA;YACpC,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAA;IACZ,CAAC;IACD,MAAM;QACF,OAAM;IACV,CAAC;IACD,OAAO;QACH,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAA;IAC/D,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;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,OAAO,EAAE,CAAA;IACb,CAAC;;AAvKL,8CAwKC;AApKU,gCAAc,GAAW,EAAE,AAAb,CAAa"}

package/package.json

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