@grandlinex/swagger-mate 1.2.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/cjs/Swagger/SwaggerUtil.js +7 -1
  2. package/dist/cjs/Swagger/annotation/index.d.ts +3 -3
  3. package/dist/mjs/Swagger/SwaggerUtil.js +8 -2
  4. package/dist/mjs/Swagger/annotation/index.d.ts +3 -3
  5. package/package.json +1 -1
package/dist/cjs/Swagger/SwaggerUtil.js CHANGED
@@ -123,7 +123,13 @@ class SwaggerUtil {
123
123
  }
124
124
  if (route.meta.responseSchema && !conf.responses) {
125
125
  const ax = route.meta.responseCodes?.slice(1) || [];
126
- conf.responses = index_js_2.SPathUtil.jsonResponse(route.meta.responseCodes?.[0] || '200', route.meta.responseSchema, route.meta.responseType === 'LIST', ...ax);
126
+ if (typeof route.meta.responseSchema === 'string' ||
127
+ (0, core_1.instanceOfEntity)(route.meta.responseSchema)) {
128
+ conf.responses = index_js_2.SPathUtil.refResponse(route.meta.responseCodes?.[0] || '200', route.meta.responseSchema, route.meta.responseType === 'LIST', ...ax);
129
+ }
130
+ else {
131
+ conf.responses = index_js_2.SPathUtil.jsonResponse(route.meta.responseCodes?.[0] || '200', route.meta.responseSchema, route.meta.responseType === 'LIST', ...ax);
132
+ }
127
133
  }
128
134
  else if (route.meta.responseCodes) {
129
135
  conf.responses = index_js_2.SPathUtil.defaultResponse(...route.meta.responseCodes);
package/dist/cjs/Swagger/annotation/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import 'reflect-metadata';
2
- import { ObjectLike } from '@grandlinex/core';
2
+ import { CoreEntity, ObjectLike } from '@grandlinex/core';
3
3
  import { SSchemaEl, SwaggerRPathConf } from '../Meta/SwaggerTypes.js';
4
4
  import { HttpStatusTypes } from '../Meta/SwaggerTypesStatic.js';
5
5
  export declare enum ActionMode {
@@ -13,7 +13,7 @@ export type RouteMeta = {
13
13
  pathOverride?: string;
14
14
  mode?: ActionMode;
15
15
  requestSchema?: SSchemaEl;
16
- responseSchema?: SSchemaEl;
16
+ responseSchema?: SSchemaEl | CoreEntity | string;
17
17
  responseType?: ResponseTypes;
18
18
  responseCodes?: HttpStatusTypes[];
19
19
  } & SwaggerRPathConf;
@@ -22,5 +22,5 @@ export type RouteData = {
22
22
  path: string;
23
23
  meta?: RouteMeta;
24
24
  };
25
- export declare const Route: (type: RouteData["type"], path: RouteData["path"], meta: RouteMeta) => ClassDecorator;
25
+ export declare const Route: (type: RouteData["type"], path: RouteData["path"], meta?: RouteMeta) => ClassDecorator;
26
26
  export declare function getRouteMeta<T extends ObjectLike>(target: T): RouteData | undefined;
package/dist/mjs/Swagger/SwaggerUtil.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import * as Path from 'path';
2
2
  import * as fs from 'fs';
3
3
  import jsyaml from 'js-yaml';
4
- import { CMap } from '@grandlinex/core';
4
+ import { CMap, instanceOfEntity } from '@grandlinex/core';
5
5
  import express from 'express';
6
6
  import * as process from 'process';
7
7
  import { getSComponent, getSPath, getSwaggerMeta } from './Meta/Swagger.js';
@@ -85,7 +85,13 @@ export default class SwaggerUtil {
85
85
  }
86
86
  if (route.meta.responseSchema && !conf.responses) {
87
87
  const ax = route.meta.responseCodes?.slice(1) || [];
88
- conf.responses = SPathUtil.jsonResponse(route.meta.responseCodes?.[0] || '200', route.meta.responseSchema, route.meta.responseType === 'LIST', ...ax);
88
+ if (typeof route.meta.responseSchema === 'string' ||
89
+ instanceOfEntity(route.meta.responseSchema)) {
90
+ conf.responses = SPathUtil.refResponse(route.meta.responseCodes?.[0] || '200', route.meta.responseSchema, route.meta.responseType === 'LIST', ...ax);
91
+ }
92
+ else {
93
+ conf.responses = SPathUtil.jsonResponse(route.meta.responseCodes?.[0] || '200', route.meta.responseSchema, route.meta.responseType === 'LIST', ...ax);
94
+ }
89
95
  }
90
96
  else if (route.meta.responseCodes) {
91
97
  conf.responses = SPathUtil.defaultResponse(...route.meta.responseCodes);
package/dist/mjs/Swagger/annotation/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import 'reflect-metadata';
2
- import { ObjectLike } from '@grandlinex/core';
2
+ import { CoreEntity, ObjectLike } from '@grandlinex/core';
3
3
  import { SSchemaEl, SwaggerRPathConf } from '../Meta/SwaggerTypes.js';
4
4
  import { HttpStatusTypes } from '../Meta/SwaggerTypesStatic.js';
5
5
  export declare enum ActionMode {
@@ -13,7 +13,7 @@ export type RouteMeta = {
13
13
  pathOverride?: string;
14
14
  mode?: ActionMode;
15
15
  requestSchema?: SSchemaEl;
16
- responseSchema?: SSchemaEl;
16
+ responseSchema?: SSchemaEl | CoreEntity | string;
17
17
  responseType?: ResponseTypes;
18
18
  responseCodes?: HttpStatusTypes[];
19
19
  } & SwaggerRPathConf;
@@ -22,5 +22,5 @@ export type RouteData = {
22
22
  path: string;
23
23
  meta?: RouteMeta;
24
24
  };
25
- export declare const Route: (type: RouteData["type"], path: RouteData["path"], meta: RouteMeta) => ClassDecorator;
25
+ export declare const Route: (type: RouteData["type"], path: RouteData["path"], meta?: RouteMeta) => ClassDecorator;
26
26
  export declare function getRouteMeta<T extends ObjectLike>(target: T): RouteData | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@grandlinex/swagger-mate",
3
- "version": "1.2.0",
3
+ "version": "1.2.1",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {