@grandlinex/swagger-mate 1.3.1 → 1.3.2

package/dist/cjs/Swagger/Path/SPathUtil.d.ts

@@ -2,15 +2,104 @@ import { CoreEntity } from '@grandlinex/core';
 import { HttpStatusTypes } from '../Meta/SwaggerTypesStatic.js';
 import { SKey, SSchemaEl, SwaggerContent, SwaggerRPathConfResponse, SwaggerRPathReqBody } from '../Meta/SwaggerTypes.js';
 export default class SPathUtil {
+    /**
+     * Generates a default response mapping for the specified HTTP status types.
+     *
+     * @param {HttpStatusTypes[]} types - The HTTP status types for which default responses should be created.
+     * @return {SwaggerRPathConfResponse} An object mapping each provided status type to its default response definition. */
     static defaultResponse(...types: HttpStatusTypes[]): SwaggerRPathConfResponse;
+    /**
+     * Creates a request body definition for JSON content type using the provided schema.
+     *
+     * @param {SSchemaEl} schema - The JSON schema used for validating the request body.
+     * @return {SwaggerRPathReqBody} A Swagger path request body object specifying application/json content type with the provided schema.
+     */
     static jsonBody(schema: SSchemaEl): SwaggerRPathReqBody;
+    /**
+     * Builds a Swagger request body for `multipart/form-data` requests.
+     *
+     * @param {SSchemaEl} [schema] Optional schema describing the form data.
+     *        If omitted, a default schema with a single binary `file` field is provided.
+     * @return {SwaggerRPathReqBody} Swagger request body definition with
+     *         `multipart/form-data` content and the supplied or default schema. */
     static formBody(schema?: SSchemaEl): SwaggerRPathReqBody;
+    /**
+     * Generates a Swagger content definition for the provided entity.
+     *
+     * @param {T} entity - The entity instance to derive the Swagger schema from.
+     * @param {boolean} [list] - When true, the schema will be wrapped in an array type, representing a list of entities.
+     *
+     * @returns {SwaggerContent|undefined} The Swagger content object for the entity, or `undefined` if the entity does not have a schema.
+     */
     static entityContent<T extends CoreEntity>(entity: T, list?: boolean): SwaggerContent | undefined;
+    /**
+     * @template T extends CoreEntity
+     * @param {T} entity - The entity instance for which to build the response configuration.
+     * @param {boolean} [list] - Indicates whether the response should represent a list of entities.
+     * @param {boolean} [create] - Indicates whether the response corresponds to a creation operation (status code 201); otherwise 200.
+     * @returns {SwaggerRPathConfResponse} The Swagger response configuration object containing the appropriate status code and content.
+     */
     static entityResponse<T extends CoreEntity>(entity: T, list?: boolean, create?: boolean): SwaggerRPathConfResponse;
+    /**
+     * Builds a JSON schema reference path for the given component name.
+     *
+     * @param {string} inp - The name of the schema component.
+     * @return {string} The JSON reference path formatted as `#/components/schemas/<inp>`.
+     */
     static schemaPath(inp: string): string;
+    /**
+     * Creates a Swagger request body definition that references a schema.
+     *
+     * @param {string | CoreEntity} $ref
+     *   Either the string reference to a schema or a `CoreEntity` instance whose
+     *   class name will be used to build the reference path.
+     * @param {boolean} list
+     *   If true, the referenced schema is wrapped in an array; otherwise the
+     *   schema is used directly.
+     * @returns {SwaggerRPathReqBody}
+     *   The request body object containing the appropriate content and schema
+     *   configuration.
+     */
+    static refRequest($ref: string | CoreEntity, list: boolean): SwaggerRPathReqBody;
+    /**
+     * Creates a Swagger response configuration for a given HTTP status code.
+     *
+     * @param {HttpStatusTypes} code - The primary HTTP status code for */
     static refResponse(code: HttpStatusTypes, $ref: string | CoreEntity, list: boolean, ...addCodes: HttpStatusTypes[]): SwaggerRPathConfResponse;
+    /**
+     * Builds a Swagger response configuration object for a given HTTP status code and schema.
+     *
+     * @param {HttpStatusTypes} code - The primary HTTP status code for the response.
+     * @param {SSchemaEl} schema - The JSON schema definition for the response body.
+     * @param {boolean} list - If true, the schema is wrapped in an array for list responses.
+     * @param {...HttpStatusTypes} addCodes - Additional HTTP status codes for default responses.
+     * @return {SwaggerRPathConfResponse} The constructed response configuration object.
+     */
     static jsonResponse(code: HttpStatusTypes, schema: SSchemaEl, list: boolean, ...addCodes: HttpStatusTypes[]): SwaggerRPathConfResponse;
+    /**
+     * Generates a JSON schema representation from a CoreEntity instance.
+     *
+     * This method inspects the entity's metadata to construct a schema object
+     * describing the entity's shape. The resulting schema contains:
+     * - `type`: always `"object"`.
+     * - `description`: a string indicating the entity name.
+     * - `required`: an array of property names that are defined on the entity.
+     * - `properties`: an object mapping each property name to an object that
+     *   includes the resolved database type and its nullability.
+     *
+     * If no metadata is found for the provided entity, the method returns `undefined`.
+     *
+     * @param {T} entity - The entity instance for which to create a schema.
+     * @returns {SSchemaEl | undefined} The generated schema object, or `undefined`
+     *          if the entity's metadata could not be retrieved.
+     */
     static schemaFromEntity<T extends CoreEntity>(entity: T): SSchemaEl | undefined;
+    /**
+     * Generates a content schema object for the given entity. The schema contains a description derived from the entity metadata and a JSON content schema based on the entity's structure.
+     *
+     * @param {T} entity - The entity instance for which to generate the content schema. The generic type `T` must extend {@link CoreEntity}.
+     * @returns {{ description: string; content: { 'application/json': { schema: SSchemaEl } }; } | undefined} An object containing the content schema, or `undefined` if no metadata is available for the entity.
+     */
     static contentSchemaFromEntity<T extends CoreEntity>(entity: T): {
         description: string;
         content: {
@@ -20,9 +109,91 @@ export default class SPathUtil {
         };
     } | undefined;
     /**
-     * generate global schema
-     * @param e
+     * Generates a mapping from entity names to their corresponding schema objects.
+     *
+     * @param {CoreEntity[]} e The entities for which schema entries should be generated.
+     * @return {SKey<SSchemaEl>} An object whose keys are entity names and values are the schemas derived from those entities.
      */
     static schemaEntryGen(...e: CoreEntity[]): SKey<SSchemaEl>;
+    /**
+     * Builds a JSON schema representation for an entity view that includes both the
+     * entity data and its related entity map.
+     *
+     * @param entity The primary entity used to construct the `dat` portion of the schema.
+     * @param entityMap The related entity map used to construct the `join_map` portion of the schema.
+     * @returns A {@link SSchemaEl} object schema with properties `i`, `dat`, and `join_map`.
+     */
     static schemaFromEntityView<A extends CoreEntity, B extends CoreEntity>(entity: A, entityMap: B): SSchemaEl;
+    /**
+     * Extends an entity schema object by merging additional schema options.
+     *
+     * @param {CoreEntity} entity
+     *   The entity for which the schema should be extended.
+     *
+     * @param {...Object} options
+     *   One or more objects defining schema extensions. Each object may contain:
+     *   - `key` (string): The property key to add or extend.
+     *   - `list` (boolean, optional): Indicates whether the property is a list.
+     *   - `entity` (CoreEntity, optional): The entity type for the property.
+     *   - `schema` (SSchemaEl, optional): A custom schema definition for the property.
+     *   - `required` (boolean, optional): Whether the property is required.
+     *
+     * @return {SSchemaEl}
+     *   The resulting schema element. If a single property is returned by
+     *   `extendEntitySchema`, its schema is returned directly; otherwise an
+     *   object schema with a type of `'object'` is returned.
+     */
+    static extendEntitySchemaObject(entity: CoreEntity, ...options: {
+        key: string;
+        list?: boolean;
+        entity?: CoreEntity;
+        schema?: SSchemaEl;
+        required?: boolean;
+    }[]): SSchemaEl;
+    /**
+     * Extends the schema of a given {@link CoreEntity} with additional properties.
+     *
+     * @param {CoreEntity} entity
+     *   The entity whose schema will be extended.
+     *
+     * @param {...{
+     *   key: string,
+     *   list?: boolean,
+     *   entity?: CoreEntity,
+     *   schema?: SSchemaEl,
+     *   required?: boolean
+     * }} options
+     *   One or more option objects specifying the extensions to apply. Each option
+     *   may provide either a direct schema (`schema`) or an entity reference
+     *   (`entity`). The `list` flag indicates whether the property should be
+     *   represented as an array of the provided schema. The `required` flag
+     *   adds the property to the schema’s required list.
+     *
+     * @returns {SKey<SSchemaEl>}
+     *   An object containing the updated schema for the entity, keyed by the
+     *   entity’s name. If the entity metadata cannot be found, an empty
+     *   object is returned.
+     */
+    static extendEntitySchema(entity: CoreEntity, ...options: {
+        key: string;
+        list?: boolean;
+        entity?: CoreEntity;
+        schema?: SSchemaEl;
+        required?: boolean;
+    }[]): SKey<SSchemaEl>;
+    /**
+     * Reduces the entity schema to a single schema element or a generic object.
+     *
+     * @param entity The entity whose schema should be reduced.
+     * @param keys Optional list of keys to include in the reduced schema. If omitted, all keys are considered.
+     * @return Returns the schema element of the sole key if only one key is present; otherwise, returns a generic object schema with type `'object'`. */
+    static reduceEntitySchemaObject<T extends CoreEntity>(entity: T, ...keys: (keyof T)[]): SSchemaEl;
+    /**
+     * Creates a reduced version of an entity's schema by excluding specified properties.
+     *
+     * @param {CoreEntity} entity - The entity whose schema is to be processed.
+     * @param {...string} keys - Property names to remove from the schema's `properties` and `required` lists.
+     *
+     * @returns */
+    static reduceEntitySchema<T extends CoreEntity>(entity: T, ...keys: (keyof T)[]): SKey<SSchemaEl>;
 }

package/dist/cjs/Swagger/Path/SPathUtil.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@grandlinex/core");
 const SUtilMap_js_1 = __importDefault(require("./SUtilMap.js"));
+const SwaggerTypes_js_1 = require("../Meta/SwaggerTypes.js");
 function resolveDBType(dType) {
     switch (dType) {
         case 'int':
@@ -30,6 +31,11 @@ function resolveDBType(dType) {
     }
 }
 class SPathUtil {
+    /**
+     * Generates a default response mapping for the specified HTTP status types.
+     *
+     * @param {HttpStatusTypes[]} types - The HTTP status types for which default responses should be created.
+     * @return {SwaggerRPathConfResponse} An object mapping each provided status type to its default response definition. */
     static defaultResponse(...types) {
         const res = {};
         types.forEach((el) => {
@@ -37,6 +43,12 @@ class SPathUtil {
         });
         return res;
     }
+    /**
+     * Creates a request body definition for JSON content type using the provided schema.
+     *
+     * @param {SSchemaEl} schema - The JSON schema used for validating the request body.
+     * @return {SwaggerRPathReqBody} A Swagger path request body object specifying application/json content type with the provided schema.
+     */
     static jsonBody(schema) {
         return {
             content: {
@@ -46,6 +58,13 @@ class SPathUtil {
             },
         };
     }
+    /**
+     * Builds a Swagger request body for `multipart/form-data` requests.
+     *
+     * @param {SSchemaEl} [schema] Optional schema describing the form data.
+     *        If omitted, a default schema with a single binary `file` field is provided.
+     * @return {SwaggerRPathReqBody} Swagger request body definition with
+     *         `multipart/form-data` content and the supplied or default schema. */
     static formBody(schema) {
         return {
             content: {
@@ -64,6 +83,14 @@ class SPathUtil {
             },
         };
     }
+    /**
+     * Generates a Swagger content definition for the provided entity.
+     *
+     * @param {T} entity - The entity instance to derive the Swagger schema from.
+     * @param {boolean} [list] - When true, the schema will be wrapped in an array type, representing a list of entities.
+     *
+     * @returns {SwaggerContent|undefined} The Swagger content object for the entity, or `undefined` if the entity does not have a schema.
+     */
     static entityContent(entity, list) {
         const schema = this.schemaFromEntity(entity);
         if (!schema) {
@@ -85,6 +112,13 @@ class SPathUtil {
             },
         };
     }
+    /**
+     * @template T extends CoreEntity
+     * @param {T} entity - The entity instance for which to build the response configuration.
+     * @param {boolean} [list] - Indicates whether the response should represent a list of entities.
+     * @param {boolean} [create] - Indicates whether the response corresponds to a creation operation (status code 201); otherwise 200.
+     * @returns {SwaggerRPathConfResponse} The Swagger response configuration object containing the appropriate status code and content.
+     */
     static entityResponse(entity, list, create) {
         const code = create ? '201' : '200';
         const an = {};
@@ -94,9 +128,58 @@ class SPathUtil {
         };
         return an;
     }
+    /**
+     * Builds a JSON schema reference path for the given component name.
+     *
+     * @param {string} inp - The name of the schema component.
+     * @return {string} The JSON reference path formatted as `#/components/schemas/<inp>`.
+     */
     static schemaPath(inp) {
         return `#/components/schemas/${inp}`;
     }
+    /**
+     * Creates a Swagger request body definition that references a schema.
+     *
+     * @param {string | CoreEntity} $ref
+     *   Either the string reference to a schema or a `CoreEntity` instance whose
+     *   class name will be used to build the reference path.
+     * @param {boolean} list
+     *   If true, the referenced schema is wrapped in an array; otherwise the
+     *   schema is used directly.
+     * @returns {SwaggerRPathReqBody}
+     *   The request body object containing the appropriate content and schema
+     *   configuration.
+     */
+    static refRequest($ref, list) {
+        const t = typeof $ref === 'string'
+            ? { $ref }
+            : {
+                $ref: this.schemaPath(core_1.XUtil.getEntityNames($ref).className),
+            };
+        if (list) {
+            return {
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: t,
+                        },
+                    },
+                },
+            };
+        }
+        return {
+            content: {
+                'application/json': {
+                    schema: t,
+                },
+            },
+        };
+    }
+    /**
+     * Creates a Swagger response configuration for a given HTTP status code.
+     *
+     * @param {HttpStatusTypes} code - The primary HTTP status code for */
     static refResponse(code, $ref, list, ...addCodes) {
         const an = {
             ...this.defaultResponse(...addCodes),
@@ -131,6 +214,15 @@ class SPathUtil {
         }
         return an;
     }
+    /**
+     * Builds a Swagger response configuration object for a given HTTP status code and schema.
+     *
+     * @param {HttpStatusTypes} code - The primary HTTP status code for the response.
+     * @param {SSchemaEl} schema - The JSON schema definition for the response body.
+     * @param {boolean} list - If true, the schema is wrapped in an array for list responses.
+     * @param {...HttpStatusTypes} addCodes - Additional HTTP status codes for default responses.
+     * @return {SwaggerRPathConfResponse} The constructed response configuration object.
+     */
     static jsonResponse(code, schema, list, ...addCodes) {
         const an = {
             ...this.defaultResponse(...addCodes),
@@ -160,6 +252,23 @@ class SPathUtil {
         }
         return an;
     }
+    /**
+     * Generates a JSON schema representation from a CoreEntity instance.
+     *
+     * This method inspects the entity's metadata to construct a schema object
+     * describing the entity's shape. The resulting schema contains:
+     * - `type`: always `"object"`.
+     * - `description`: a string indicating the entity name.
+     * - `required`: an array of property names that are defined on the entity.
+     * - `properties`: an object mapping each property name to an object that
+     *   includes the resolved database type and its nullability.
+     *
+     * If no metadata is found for the provided entity, the method returns `undefined`.
+     *
+     * @param {T} entity - The entity instance for which to create a schema.
+     * @returns {SSchemaEl | undefined} The generated schema object, or `undefined`
+     *          if the entity's metadata could not be retrieved.
+     */
     static schemaFromEntity(entity) {
         const schema = {
             type: 'object',
@@ -184,6 +293,12 @@ class SPathUtil {
         });
         return schema;
     }
+    /**
+     * Generates a content schema object for the given entity. The schema contains a description derived from the entity metadata and a JSON content schema based on the entity's structure.
+     *
+     * @param {T} entity - The entity instance for which to generate the content schema. The generic type `T` must extend {@link CoreEntity}.
+     * @returns {{ description: string; content: { 'application/json': { schema: SSchemaEl } }; } | undefined} An object containing the content schema, or `undefined` if no metadata is available for the entity.
+     */
     static contentSchemaFromEntity(entity) {
         const meta = (0, core_1.getEntityMeta)(entity);
         if (!meta) {
@@ -199,8 +314,10 @@ class SPathUtil {
         };
     }
     /**
-     * generate global schema
-     * @param e
+     * Generates a mapping from entity names to their corresponding schema objects.
+     *
+     * @param {CoreEntity[]} e The entities for which schema entries should be generated.
+     * @return {SKey<SSchemaEl>} An object whose keys are entity names and values are the schemas derived from those entities.
      */
     static schemaEntryGen(...e) {
         const out = {};
@@ -212,6 +329,14 @@ class SPathUtil {
         });
         return out;
     }
+    /**
+     * Builds a JSON schema representation for an entity view that includes both the
+     * entity data and its related entity map.
+     *
+     * @param entity The primary entity used to construct the `dat` portion of the schema.
+     * @param entityMap The related entity map used to construct the `join_map` portion of the schema.
+     * @returns A {@link SSchemaEl} object schema with properties `i`, `dat`, and `join_map`.
+     */
     static schemaFromEntityView(entity, entityMap) {
         return {
             type: 'object',
@@ -224,5 +349,136 @@ class SPathUtil {
             },
         };
     }
+    /**
+     * Extends an entity schema object by merging additional schema options.
+     *
+     * @param {CoreEntity} entity
+     *   The entity for which the schema should be extended.
+     *
+     * @param {...Object} options
+     *   One or more objects defining schema extensions. Each object may contain:
+     *   - `key` (string): The property key to add or extend.
+     *   - `list` (boolean, optional): Indicates whether the property is a list.
+     *   - `entity` (CoreEntity, optional): The entity type for the property.
+     *   - `schema` (SSchemaEl, optional): A custom schema definition for the property.
+     *   - `required` (boolean, optional): Whether the property is required.
+     *
+     * @return {SSchemaEl}
+     *   The resulting schema element. If a single property is returned by
+     *   `extendEntitySchema`, its schema is returned directly; otherwise an
+     *   object schema with a type of `'object'` is returned.
+     */
+    static extendEntitySchemaObject(entity, ...options) {
+        const schema = this.extendEntitySchema(entity, ...options);
+        const ent = Object.entries(schema);
+        if (ent.length === 1) {
+            return ent[0][1];
+        }
+        return {
+            type: 'object',
+        };
+    }
+    /**
+     * Extends the schema of a given {@link CoreEntity} with additional properties.
+     *
+     * @param {CoreEntity} entity
+     *   The entity whose schema will be extended.
+     *
+     * @param {...{
+     *   key: string,
+     *   list?: boolean,
+     *   entity?: CoreEntity,
+     *   schema?: SSchemaEl,
+     *   required?: boolean
+     * }} options
+     *   One or more option objects specifying the extensions to apply. Each option
+     *   may provide either a direct schema (`schema`) or an entity reference
+     *   (`entity`). The `list` flag indicates whether the property should be
+     *   represented as an array of the provided schema. The `required` flag
+     *   adds the property to the schema’s required list.
+     *
+     * @returns {SKey<SSchemaEl>}
+     *   An object containing the updated schema for the entity, keyed by the
+     *   entity’s name. If the entity metadata cannot be found, an empty
+     *   object is returned.
+     */
+    static extendEntitySchema(entity, ...options) {
+        const meta = (0, core_1.getEntityMeta)(entity);
+        if (meta) {
+            const schema = SPathUtil.schemaEntryGen(entity)[meta.name];
+            if (schema && !(0, SwaggerTypes_js_1.isSwaggerRef)(schema) && schema.properties) {
+                for (const option of options) {
+                    if (option.schema) {
+                        if (option.list) {
+                            schema.properties[option.key] = {
+                                type: 'array',
+                                items: option.schema,
+                            };
+                        }
+                        else {
+                            schema.properties[option.key] = option.schema;
+                        }
+                    }
+                    else if (option.entity) {
+                        const eMeta = (0, core_1.getEntityMeta)(option.entity);
+                        if (eMeta) {
+                            const scheme = SPathUtil.schemaEntryGen(option.entity)[eMeta.name];
+                            if (option.list) {
+                                schema.properties[option.key] = {
+                                    type: 'array',
+                                    items: scheme,
+                                };
+                            }
+                            else {
+                                schema.properties[option.key] = scheme;
+                            }
+                        }
+                    }
+                    if (option.required) {
+                        schema.required = [...(schema.required || []), option.key];
+                    }
+                }
+            }
+            return {
+                [meta.name]: schema,
+            };
+        }
+        return {};
+    }
+    /**
+     * Reduces the entity schema to a single schema element or a generic object.
+     *
+     * @param entity The entity whose schema should be reduced.
+     * @param keys Optional list of keys to include in the reduced schema. If omitted, all keys are considered.
+     * @return Returns the schema element of the sole key if only one key is present; otherwise, returns a generic object schema with type `'object'`. */
+    static reduceEntitySchemaObject(entity, ...keys) {
+        const schema = this.reduceEntitySchema(entity, ...keys);
+        const ent = Object.entries(schema);
+        if (ent.length === 1) {
+            return ent[0][1];
+        }
+        return {
+            type: 'object',
+        };
+    }
+    /**
+     * Creates a reduced version of an entity's schema by excluding specified properties.
+     *
+     * @param {CoreEntity} entity - The entity whose schema is to be processed.
+     * @param {...string} keys - Property names to remove from the schema's `properties` and `required` lists.
+     *
+     * @returns */
+    static reduceEntitySchema(entity, ...keys) {
+        const meta = (0, core_1.getEntityMeta)(entity);
+        if (meta) {
+            const schema = SPathUtil.schemaEntryGen(entity)[meta.name];
+            if (schema && !(0, SwaggerTypes_js_1.isSwaggerRef)(schema) && schema.properties) {
+                schema.properties = Object.fromEntries(Object.entries(schema.properties).filter(([e]) => !keys.includes(e)));
+                schema.required = (schema.required || []).filter((e) => !keys.includes(e));
+            }
+            return { [meta.name]: schema };
+        }
+        return {};
+    }
 }
 exports.default = SPathUtil;

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

@@ -1,11 +1,27 @@
-import { ObjectLike } from '@grandlinex/core';
+import { CoreLogChannel, ObjectLike } from '@grandlinex/core';
 import { Server } from 'net';
 import { MergeInputType, SwaggerConfig, SwaggerRPath } from './Meta/SwaggerTypes.js';
 import { RouteData } from './annotation/index.js';
 export default class SwaggerUtil {
+    static logger: CoreLogChannel | null;
+    static getLogger(): CoreLogChannel;
     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>;
+    /**
+     * Serves a meta page for Swagger UI or rapi-doc.
+     *
+     * @param {SwaggerConfig} conf The swagger configuration to expose via `/spec`.
+     * @param {Object} [option] Options for serving the meta page.
+     * @param {'swagger-ui'|'rapi-doc'} [option.type='swagger-ui'] The type of UI to serve.
+     * @param {number} [option.port] The port to listen on. Defaults to 9000.
+     * @param {string} [option.auth] Optional authentication key appended to the URL.
+     * @returns {Promise<Server|null>} A promise that resolves with the created server instance or null.
+     */
+    static serveMeta(conf: SwaggerConfig, option?: {
+        type?: 'swagger-ui' | 'rapi-doc';
+        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;

package/dist/cjs/Swagger/SwaggerUtil.js

@@ -47,6 +47,13 @@ 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 getLogger() {
+        if (!this.logger) {
+            const logger = new core_1.DefaultLogger();
+            this.logger = new core_1.CoreLogChannel('SwaggerUtil', logger);
+        }
+        return this.logger;
+    }
     static writeMeta(conf, kind, path) {
         if (kind === 'JSON') {
             const p = Path.join(path || process.cwd(), 'openapi.json');
@@ -63,11 +70,25 @@ class SwaggerUtil {
             return JSON.parse(file);
         }
         catch (e) {
+            this.getLogger().error(e);
             return null;
         }
     }
-    static async serveMeta(conf, port, auth) {
-        const resFiles = (0, PathHelp_js_1.default)((0, PathHelp_js_1.getBaseFolder)(), '..', 'res', 'html');
+    /**
+     * Serves a meta page for Swagger UI or rapi-doc.
+     *
+     * @param {SwaggerConfig} conf The swagger configuration to expose via `/spec`.
+     * @param {Object} [option] Options for serving the meta page.
+     * @param {'swagger-ui'|'rapi-doc'} [option.type='swagger-ui'] The type of UI to serve.
+     * @param {number} [option.port] The port to listen on. Defaults to 9000.
+     * @param {string} [option.auth] Optional authentication key appended to the URL.
+     * @returns {Promise<Server|null>} A promise that resolves with the created server instance or null.
+     */
+    static async serveMeta(conf, option) {
+        const type = option?.type ?? 'swagger-ui';
+        const port = option?.port || 9000;
+        const auth = option?.auth;
+        const resFiles = (0, PathHelp_js_1.default)((0, PathHelp_js_1.getBaseFolder)(), '..', 'res', 'html', type);
         const key = auth ? `?auth=${auth}` : '';
         const app = (0, express_1.default)();
         app.use('/', express_1.default.static(resFiles));
@@ -75,8 +96,8 @@ class SwaggerUtil {
             res.status(200).send(conf);
         });
         return new Promise((resolve) => {
-            const s = app.listen(port || 9000, () => {
-                console.log(`listen on http://localhost:${port || 9000}${key}#`);
+            const s = app.listen(port, () => {
+                this.getLogger().log(`${type} listen on http://localhost:${port}${key}#`);
                 resolve(s);
             });
         });
@@ -121,7 +142,13 @@ class SwaggerUtil {
             // Handle requestBody
             if (!conf.requestBody) {
                 if (route.meta.requestSchema) {
-                    conf.requestBody = index_js_2.SPathUtil.jsonBody(route.meta.requestSchema);
+                    if (typeof route.meta.requestSchema === 'string' ||
+                        (0, core_1.instanceOfEntity)(route.meta.requestSchema)) {
+                        conf.requestBody = index_js_2.SPathUtil.refRequest(route.meta.requestSchema, route.meta.responseType === 'LIST');
+                    }
+                    else {
+                        conf.requestBody = index_js_2.SPathUtil.jsonBody(route.meta.requestSchema);
+                    }
                 }
             }
             // Handle responses

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

@@ -8,13 +8,18 @@ export declare enum ActionMode {
     'DMZ_WITH_USER' = 2
 }
 export type ActionTypes = 'POST' | 'GET' | 'USE' | 'PATCH' | 'DELETE';
-export type ResponseTypes = 'LIST';
+/**
+ * LIST - Response is an array of items
+ * SINGLE - Response is a single item (default)
+ */
+export type ResponseRequestTypes = 'LIST' | 'SINGLE';
 export type RouteMeta = {
     pathOverride?: string;
     mode?: ActionMode;
-    requestSchema?: SSchemaEl;
+    requestSchema?: SSchemaEl | CoreEntity | string;
     responseSchema?: SSchemaEl | CoreEntity | string;
-    responseType?: ResponseTypes;
+    requestType?: ResponseRequestTypes;
+    responseType?: ResponseRequestTypes;
     responseCodes?: HttpStatusTypes[];
 } & SwaggerRPathConf;
 export type RouteData = {