@grandlinex/swagger-mate 1.1.1 → 1.2.1

package/dist/cjs/Swagger/Client/SwaggerClient.js

@@ -182,8 +182,8 @@ function createPackage(name, version, module) {
         module: module ? 'dist/index.js' : undefined,
         type: module ? 'module' : undefined,
         dependencies: {
-            'form-data': '4.0.3',
-            axios: '1.10.0',
+            'form-data': '4.0.4',
+            axios: '1.11.0',
         },
         devDependencies: {
             '@types/node': '22.15.32',

package/dist/cjs/Swagger/SwaggerUtil.d.ts

@@ -1,11 +1,13 @@
 import { ObjectLike } from '@grandlinex/core';
 import { Server } from 'net';
-import { MergeInputType, SwaggerConfig } from './Meta/SwaggerTypes.js';
+import { MergeInputType, SwaggerConfig, SwaggerRPath } from './Meta/SwaggerTypes.js';
+import { RouteData } from './annotation/index.js';
 export default class SwaggerUtil {
     static writeMeta(conf: SwaggerConfig, kind: 'JSON' | 'YAML', path?: string): void;
     static readMeta(path: string): any;
     static serveMeta(conf: SwaggerConfig, port?: number, auth?: string): Promise<Server | null>;
     static metaExtractor(root: ObjectLike, npmPackageVersion: boolean, ...path: ObjectLike[]): SwaggerConfig | undefined;
+    static routeToSwaggerPath(route: RouteData): SwaggerRPath;
     static merge(root: SwaggerConfig, data: MergeInputType[]): SwaggerConfig;
     static mergeConfig(root: SwaggerConfig, data: SwaggerConfig[]): SwaggerConfig;
 }

package/dist/cjs/Swagger/SwaggerUtil.js

@@ -44,6 +44,8 @@ const express_1 = __importDefault(require("express"));
 const process = __importStar(require("process"));
 const Swagger_js_1 = require("./Meta/Swagger.js");
 const PathHelp_js_1 = __importStar(require("../PathHelp.js"));
+const index_js_1 = require("./annotation/index.js");
+const index_js_2 = require("../index.js");
 class SwaggerUtil {
     static writeMeta(conf, kind, path) {
         if (kind === 'JSON') {
@@ -90,10 +92,95 @@ class SwaggerUtil {
                 rootMeta.info.version = version;
             }
         }
-        return this.merge(rootMeta, path.map((el) => ({
-            path: (0, Swagger_js_1.getSPath)(el),
-            comp: (0, Swagger_js_1.getSComponent)(el),
-        })));
+        return this.merge(rootMeta, path.map((el) => {
+            const sPath = (0, Swagger_js_1.getSPath)(el);
+            const meta = (0, index_js_1.getRouteMeta)(el);
+            let sMeta;
+            if (meta) {
+                sMeta = {
+                    path: this.routeToSwaggerPath(meta),
+                };
+            }
+            return {
+                path: sPath || sMeta,
+                comp: (0, Swagger_js_1.getSComponent)(el),
+            };
+        }));
+    }
+    static routeToSwaggerPath(route) {
+        const conf = {
+            responses: route.meta?.responses,
+            description: route.meta?.description,
+            summary: route.meta?.summary,
+            tags: route.meta?.tags,
+            operationId: route.meta?.operationId,
+            requestBody: route.meta?.requestBody,
+            parameters: route.meta?.parameters,
+        };
+        if (route.meta) {
+            if (route.meta.requestSchema && !conf.requestBody) {
+                conf.requestBody = index_js_2.SPathUtil.jsonBody(route.meta.requestSchema);
+            }
+            if (route.meta.responseSchema && !conf.responses) {
+                const ax = route.meta.responseCodes?.slice(1) || [];
+                if (typeof route.meta.responseSchema === 'string' ||
+                    (0, core_1.instanceOfEntity)(route.meta.responseSchema)) {
+                    conf.responses = index_js_2.SPathUtil.refResponse(route.meta.responseCodes?.[0] || '200', route.meta.responseSchema, route.meta.responseType === 'LIST', ...ax);
+                }
+                else {
+                    conf.responses = index_js_2.SPathUtil.jsonResponse(route.meta.responseCodes?.[0] || '200', route.meta.responseSchema, route.meta.responseType === 'LIST', ...ax);
+                }
+            }
+            else if (route.meta.responseCodes) {
+                conf.responses = index_js_2.SPathUtil.defaultResponse(...route.meta.responseCodes);
+            }
+            else {
+                conf.responses = index_js_2.SPathUtil.defaultResponse('200');
+            }
+        }
+        const convertedPath = route.meta?.pathOverride ||
+            route.path
+                .split('/')
+                .map((e) => {
+                if (e.startsWith(':')) {
+                    return `{${e.substring(1)}}`;
+                }
+                return e;
+            })
+                .join('/');
+        const path = {};
+        switch (route.type) {
+            case 'POST':
+                path[convertedPath] = {
+                    post: conf,
+                };
+                break;
+            case 'GET':
+                path[convertedPath] = {
+                    get: conf,
+                };
+                break;
+            case 'PATCH':
+                path[convertedPath] = {
+                    patch: conf,
+                };
+                break;
+            case 'DELETE':
+                path[convertedPath] = {
+                    delete: conf,
+                };
+                break;
+            case 'USE':
+                path[convertedPath] = {
+                    get: conf,
+                    patch: conf,
+                    post: conf,
+                    delete: conf,
+                };
+                break;
+            default:
+        }
+        return path;
     }
     static merge(root, data) {
         const out = root;

package/dist/cjs/Swagger/annotation/index.d.ts

@@ -0,0 +1,26 @@
+import 'reflect-metadata';
+import { CoreEntity, ObjectLike } from '@grandlinex/core';
+import { SSchemaEl, SwaggerRPathConf } from '../Meta/SwaggerTypes.js';
+import { HttpStatusTypes } from '../Meta/SwaggerTypesStatic.js';
+export declare enum ActionMode {
+    'DEFAULT' = 0,
+    'DMZ' = 1,
+    'DMZ_WITH_USER' = 2
+}
+export type ActionTypes = 'POST' | 'GET' | 'USE' | 'PATCH' | 'DELETE';
+export type ResponseTypes = 'LIST';
+export type RouteMeta = {
+    pathOverride?: string;
+    mode?: ActionMode;
+    requestSchema?: SSchemaEl;
+    responseSchema?: SSchemaEl | CoreEntity | string;
+    responseType?: ResponseTypes;
+    responseCodes?: HttpStatusTypes[];
+} & SwaggerRPathConf;
+export type RouteData = {
+    type: ActionTypes;
+    path: string;
+    meta?: RouteMeta;
+};
+export declare const Route: (type: RouteData["type"], path: RouteData["path"], meta?: RouteMeta) => ClassDecorator;
+export declare function getRouteMeta<T extends ObjectLike>(target: T): RouteData | undefined;

package/dist/cjs/Swagger/annotation/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Route = exports.ActionMode = void 0;
+exports.getRouteMeta = getRouteMeta;
+require("reflect-metadata");
+var ActionMode;
+(function (ActionMode) {
+    ActionMode[ActionMode["DEFAULT"] = 0] = "DEFAULT";
+    ActionMode[ActionMode["DMZ"] = 1] = "DMZ";
+    ActionMode[ActionMode["DMZ_WITH_USER"] = 2] = "DMZ_WITH_USER";
+})(ActionMode || (exports.ActionMode = ActionMode = {}));
+const routeKey = Symbol('route');
+const Route = (type, path, meta) => {
+    return (target) => {
+        const metadata = {
+            type,
+            path,
+            meta,
+        };
+        Reflect.defineMetadata(routeKey, metadata, target.prototype);
+    };
+};
+exports.Route = Route;
+function getRouteMeta(target) {
+    return Reflect.getMetadata(routeKey, target.constructor.prototype);
+}

package/dist/cjs/index.d.ts

@@ -2,6 +2,7 @@ import SwaggerUtil from './Swagger/SwaggerUtil.js';
 import SPathUtil from './Swagger/Path/SPathUtil.js';
 import SwaggerClient from './Swagger/Client/SwaggerClient.js';
 export * from './Swagger/debug/index.js';
+export * from './Swagger/annotation/index.js';
 export * from './Swagger/Meta/Swagger.js';
 export * from './Swagger/Meta/SwaggerTypes.js';
 export * from './Swagger/Meta/SwaggerTypesStatic.js';

package/dist/cjs/index.js

@@ -25,6 +25,7 @@ exports.SPathUtil = SPathUtil_js_1.default;
 const SwaggerClient_js_1 = __importDefault(require("./Swagger/Client/SwaggerClient.js"));
 exports.SwaggerClient = SwaggerClient_js_1.default;
 __exportStar(require("./Swagger/debug/index.js"), exports);
+__exportStar(require("./Swagger/annotation/index.js"), exports);
 __exportStar(require("./Swagger/Meta/Swagger.js"), exports);
 __exportStar(require("./Swagger/Meta/SwaggerTypes.js"), exports);
 __exportStar(require("./Swagger/Meta/SwaggerTypesStatic.js"), exports);

package/dist/mjs/Swagger/Client/SwaggerClient.js

@@ -144,8 +144,8 @@ function createPackage(name, version, module) {
         module: module ? 'dist/index.js' : undefined,
         type: module ? 'module' : undefined,
         dependencies: {
-            'form-data': '4.0.3',
-            axios: '1.10.0',
+            'form-data': '4.0.4',
+            axios: '1.11.0',
         },
         devDependencies: {
             '@types/node': '22.15.32',

package/dist/mjs/Swagger/SwaggerUtil.d.ts

@@ -1,11 +1,13 @@
 import { ObjectLike } from '@grandlinex/core';
 import { Server } from 'net';
-import { MergeInputType, SwaggerConfig } from './Meta/SwaggerTypes.js';
+import { MergeInputType, SwaggerConfig, SwaggerRPath } from './Meta/SwaggerTypes.js';
+import { RouteData } from './annotation/index.js';
 export default class SwaggerUtil {
     static writeMeta(conf: SwaggerConfig, kind: 'JSON' | 'YAML', path?: string): void;
     static readMeta(path: string): any;
     static serveMeta(conf: SwaggerConfig, port?: number, auth?: string): Promise<Server | null>;
     static metaExtractor(root: ObjectLike, npmPackageVersion: boolean, ...path: ObjectLike[]): SwaggerConfig | undefined;
+    static routeToSwaggerPath(route: RouteData): SwaggerRPath;
     static merge(root: SwaggerConfig, data: MergeInputType[]): SwaggerConfig;
     static mergeConfig(root: SwaggerConfig, data: SwaggerConfig[]): SwaggerConfig;
 }

package/dist/mjs/Swagger/SwaggerUtil.js

@@ -1,11 +1,13 @@
 import * as Path from 'path';
 import * as fs from 'fs';
 import jsyaml from 'js-yaml';
-import { CMap } from '@grandlinex/core';
+import { CMap, instanceOfEntity } from '@grandlinex/core';
 import express from 'express';
 import * as process from 'process';
 import { getSComponent, getSPath, getSwaggerMeta } from './Meta/Swagger.js';
 import PathHelp, { getBaseFolder } from '../PathHelp.js';
+import { getRouteMeta } from './annotation/index.js';
+import { SPathUtil } from '../index.js';
 export default class SwaggerUtil {
     static writeMeta(conf, kind, path) {
         if (kind === 'JSON') {
@@ -52,10 +54,95 @@ export default class SwaggerUtil {
                 rootMeta.info.version = version;
             }
         }
-        return this.merge(rootMeta, path.map((el) => ({
-            path: getSPath(el),
-            comp: getSComponent(el),
-        })));
+        return this.merge(rootMeta, path.map((el) => {
+            const sPath = getSPath(el);
+            const meta = getRouteMeta(el);
+            let sMeta;
+            if (meta) {
+                sMeta = {
+                    path: this.routeToSwaggerPath(meta),
+                };
+            }
+            return {
+                path: sPath || sMeta,
+                comp: getSComponent(el),
+            };
+        }));
+    }
+    static routeToSwaggerPath(route) {
+        const conf = {
+            responses: route.meta?.responses,
+            description: route.meta?.description,
+            summary: route.meta?.summary,
+            tags: route.meta?.tags,
+            operationId: route.meta?.operationId,
+            requestBody: route.meta?.requestBody,
+            parameters: route.meta?.parameters,
+        };
+        if (route.meta) {
+            if (route.meta.requestSchema && !conf.requestBody) {
+                conf.requestBody = SPathUtil.jsonBody(route.meta.requestSchema);
+            }
+            if (route.meta.responseSchema && !conf.responses) {
+                const ax = route.meta.responseCodes?.slice(1) || [];
+                if (typeof route.meta.responseSchema === 'string' ||
+                    instanceOfEntity(route.meta.responseSchema)) {
+                    conf.responses = SPathUtil.refResponse(route.meta.responseCodes?.[0] || '200', route.meta.responseSchema, route.meta.responseType === 'LIST', ...ax);
+                }
+                else {
+                    conf.responses = SPathUtil.jsonResponse(route.meta.responseCodes?.[0] || '200', route.meta.responseSchema, route.meta.responseType === 'LIST', ...ax);
+                }
+            }
+            else if (route.meta.responseCodes) {
+                conf.responses = SPathUtil.defaultResponse(...route.meta.responseCodes);
+            }
+            else {
+                conf.responses = SPathUtil.defaultResponse('200');
+            }
+        }
+        const convertedPath = route.meta?.pathOverride ||
+            route.path
+                .split('/')
+                .map((e) => {
+                if (e.startsWith(':')) {
+                    return `{${e.substring(1)}}`;
+                }
+                return e;
+            })
+                .join('/');
+        const path = {};
+        switch (route.type) {
+            case 'POST':
+                path[convertedPath] = {
+                    post: conf,
+                };
+                break;
+            case 'GET':
+                path[convertedPath] = {
+                    get: conf,
+                };
+                break;
+            case 'PATCH':
+                path[convertedPath] = {
+                    patch: conf,
+                };
+                break;
+            case 'DELETE':
+                path[convertedPath] = {
+                    delete: conf,
+                };
+                break;
+            case 'USE':
+                path[convertedPath] = {
+                    get: conf,
+                    patch: conf,
+                    post: conf,
+                    delete: conf,
+                };
+                break;
+            default:
+        }
+        return path;
     }
     static merge(root, data) {
         const out = root;

package/dist/mjs/Swagger/annotation/index.d.ts

@@ -0,0 +1,26 @@
+import 'reflect-metadata';
+import { CoreEntity, ObjectLike } from '@grandlinex/core';
+import { SSchemaEl, SwaggerRPathConf } from '../Meta/SwaggerTypes.js';
+import { HttpStatusTypes } from '../Meta/SwaggerTypesStatic.js';
+export declare enum ActionMode {
+    'DEFAULT' = 0,
+    'DMZ' = 1,
+    'DMZ_WITH_USER' = 2
+}
+export type ActionTypes = 'POST' | 'GET' | 'USE' | 'PATCH' | 'DELETE';
+export type ResponseTypes = 'LIST';
+export type RouteMeta = {
+    pathOverride?: string;
+    mode?: ActionMode;
+    requestSchema?: SSchemaEl;
+    responseSchema?: SSchemaEl | CoreEntity | string;
+    responseType?: ResponseTypes;
+    responseCodes?: HttpStatusTypes[];
+} & SwaggerRPathConf;
+export type RouteData = {
+    type: ActionTypes;
+    path: string;
+    meta?: RouteMeta;
+};
+export declare const Route: (type: RouteData["type"], path: RouteData["path"], meta?: RouteMeta) => ClassDecorator;
+export declare function getRouteMeta<T extends ObjectLike>(target: T): RouteData | undefined;

package/dist/mjs/Swagger/annotation/index.js

@@ -0,0 +1,21 @@
+import 'reflect-metadata';
+export var ActionMode;
+(function (ActionMode) {
+    ActionMode[ActionMode["DEFAULT"] = 0] = "DEFAULT";
+    ActionMode[ActionMode["DMZ"] = 1] = "DMZ";
+    ActionMode[ActionMode["DMZ_WITH_USER"] = 2] = "DMZ_WITH_USER";
+})(ActionMode || (ActionMode = {}));
+const routeKey = Symbol('route');
+export const Route = (type, path, meta) => {
+    return (target) => {
+        const metadata = {
+            type,
+            path,
+            meta,
+        };
+        Reflect.defineMetadata(routeKey, metadata, target.prototype);
+    };
+};
+export function getRouteMeta(target) {
+    return Reflect.getMetadata(routeKey, target.constructor.prototype);
+}

package/dist/mjs/index.d.ts

@@ -2,6 +2,7 @@ import SwaggerUtil from './Swagger/SwaggerUtil.js';
 import SPathUtil from './Swagger/Path/SPathUtil.js';
 import SwaggerClient from './Swagger/Client/SwaggerClient.js';
 export * from './Swagger/debug/index.js';
+export * from './Swagger/annotation/index.js';
 export * from './Swagger/Meta/Swagger.js';
 export * from './Swagger/Meta/SwaggerTypes.js';
 export * from './Swagger/Meta/SwaggerTypesStatic.js';

package/dist/mjs/index.js

@@ -2,6 +2,7 @@ import SwaggerUtil from './Swagger/SwaggerUtil.js';
 import SPathUtil from './Swagger/Path/SPathUtil.js';
 import SwaggerClient from './Swagger/Client/SwaggerClient.js';
 export * from './Swagger/debug/index.js';
+export * from './Swagger/annotation/index.js';
 export * from './Swagger/Meta/Swagger.js';
 export * from './Swagger/Meta/SwaggerTypes.js';
 export * from './Swagger/Meta/SwaggerTypesStatic.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grandlinex/swagger-mate",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "type": "module",
   "exports": {
     ".": {
@@ -38,14 +38,15 @@
     "swagger-mate-esm": "./dist/mjs/cli.js"
   },
   "dependencies": {
-    "@grandlinex/core": "1.1.1",
+    "@grandlinex/core": "1.2.0",
     "express": "5.1.0",
-    "form-data": "4.0.3",
+    "form-data": "4.0.4",
     "js-yaml": "4.1.0",
     "reflect-metadata": "0.2.2"
   },
   "devDependencies": {
     "axios": "1.11.0",
+    "node-fetch": "3.3.2",
     "cross-env": "10.0.0",
     "@types/express": "5.0.3",
     "@types/js-yaml": "4.0.9",