@ethalium/nestjs-openapi 0.0.1

package/decorators/route.decorator.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OARoute = OARoute;
+const decorator_utils_1 = require("../utils/decorator.utils");
+const type_utils_1 = require("../utils/type.utils");
+const common_1 = require("@nestjs/common");
+const response_decorator_1 = require("./response.decorator");
+const body_decorator_1 = require("./body.decorator");
+const request_decorator_1 = require("./request.decorator");
+const swagger_1 = require("@nestjs/swagger");
+function OARoute(method, ...args) {
+    return (0, decorator_utils_1.createDecorator)({
+        transform: (opts) => Object.assign({ path: (0, type_utils_1.extractRoute)(opts.data) || '' }, (0, type_utils_1.extractObject)(opts.data) || {}, (0, type_utils_1.extractFalse)(opts.data) ? { exclude: true } : {}),
+        decorators: (options, store) => {
+            store.push((0, common_1.RequestMapping)({
+                method: method,
+                path: options.data.path,
+            }));
+            store.push((0, request_decorator_1.OARequest)('route', options.data));
+            if ([options.data.summary, options.data.description, options.data.operationId, options.data.externalDocs].filter(Boolean).length > 0) {
+                store.push((0, swagger_1.ApiOperation)({
+                    summary: options.data.summary,
+                    description: options.data.description,
+                    operationId: options.data.operationId,
+                    externalDocs: options.data.externalDocs,
+                }));
+            }
+            if (options.data.body) {
+                store.push((0, body_decorator_1.OABody)(options.data.body));
+            }
+            if (options.data.response) {
+                switch (method) {
+                    case common_1.RequestMethod.POST: {
+                        store.push((0, response_decorator_1.OACreatedResponse)(options.data.response));
+                        break;
+                    }
+                    default: {
+                        store.push((0, response_decorator_1.OAOkResponse)(options.data.response));
+                    }
+                }
+            }
+        },
+    })(args);
+}
+//# sourceMappingURL=route.decorator.js.map

package/decorators/route.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route.decorator.js","sourceRoot":"","sources":["../../../lib/decorators/route.decorator.ts"],"names":[],"mappings":";;AAaA,0BAgDC;AA7DD,8DAAyD;AAEzD,oDAA8E;AAC9E,2CAA6D;AAE7D,6DAAqE;AACrE,qDAAwC;AACxC,2DAA8C;AAC9C,6CAA6C;AAK7C,SAAgB,OAAO,CAAC,MAAqB,EAAE,GAAG,IAAW;IAC3D,OAAO,IAAA,iCAAe,EAA8B;QAClD,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAChC,EAAE,IAAI,EAAE,IAAA,yBAAY,EAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EACvC,IAAA,0BAAa,EAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAC9B,IAAA,yBAAY,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CACjD;QACD,UAAU,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YAG7B,KAAK,CAAC,IAAI,CAAC,IAAA,uBAAc,EAAC;gBACxB,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI;aACxB,CAAC,CAAC,CAAC;YAGJ,KAAK,CAAC,IAAI,CAAC,IAAA,6BAAS,EAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;YAG7C,IAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAC,CAAC;gBACnI,KAAK,CAAC,IAAI,CAAC,IAAA,sBAAY,EAAC;oBACtB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO;oBAC7B,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW;oBACrC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW;oBACrC,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY;iBACxC,CAAC,CAAC,CAAC;YACN,CAAC;YAGD,IAAG,OAAO,CAAC,IAAI,CAAC,IAAI,EAAC,CAAC;gBACpB,KAAK,CAAC,IAAI,CAAC,IAAA,uBAAM,EAAC,OAAO,CAAC,IAAI,CAAC,IAAW,CAAC,CAAC,CAAC;YAC/C,CAAC;YAGD,IAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAC,CAAC;gBACxB,QAAO,MAAM,EAAC,CAAC;oBACb,KAAK,sBAAa,CAAC,IAAI,CAAC,CAAC,CAAC;wBACxB,KAAK,CAAC,IAAI,CAAC,IAAA,sCAAiB,EAAC,OAAO,CAAC,IAAI,CAAC,QAAe,CAAC,CAAC,CAAC;wBAC5D,MAAM;oBACR,CAAC;oBACD,OAAO,CAAC,CAAC,CAAC;wBACR,KAAK,CAAC,IAAI,CAAC,IAAA,iCAAY,EAAC,OAAO,CAAC,IAAI,CAAC,QAAe,CAAC,CAAC,CAAC;oBACzD,CAAC;gBACH,CAAC;YACH,CAAC;QAEH,CAAC;KACF,CAAC,CAAC,IAAI,CAAQ,CAAC;AAClB,CAAC"}

package/decorators/routes/delete.decorator.d.ts

@@ -0,0 +1,4 @@
+import { IOpenApiRouteLike } from "../../interfaces/common.interface";
+import { IOpenApiRouteOptions } from "../../interfaces/route.interface";
+export declare function OADelete(path: IOpenApiRouteLike, options?: Omit<IOpenApiRouteOptions, 'path'> | false): MethodDecorator;
+export declare function OADelete(options?: IOpenApiRouteOptions): MethodDecorator;

package/decorators/routes/delete.decorator.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OADelete = OADelete;
+const route_decorator_1 = require("../route.decorator");
+const common_1 = require("@nestjs/common");
+function OADelete(...args) {
+    return (0, route_decorator_1.OARoute)(common_1.RequestMethod.DELETE, ...args);
+}
+//# sourceMappingURL=delete.decorator.js.map

package/decorators/routes/delete.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.decorator.js","sourceRoot":"","sources":["../../../../lib/decorators/routes/delete.decorator.ts"],"names":[],"mappings":";;AAOA,4BAEC;AAPD,wDAA2C;AAC3C,2CAA6C;AAI7C,SAAgB,QAAQ,CAAC,GAAG,IAAW;IACrC,OAAO,IAAA,yBAAO,EAAC,sBAAa,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;AAChD,CAAC"}

package/decorators/routes/get.decorator.d.ts

@@ -0,0 +1,4 @@
+import { IOpenApiRouteLike } from "../../interfaces/common.interface";
+import { IOpenApiRouteOptions } from "../../interfaces/route.interface";
+export declare function OAGet(path: IOpenApiRouteLike, options?: Omit<IOpenApiRouteOptions, 'path'> | false): MethodDecorator;
+export declare function OAGet(options?: IOpenApiRouteOptions): MethodDecorator;

package/decorators/routes/get.decorator.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAGet = OAGet;
+const route_decorator_1 = require("../route.decorator");
+const common_1 = require("@nestjs/common");
+function OAGet(...args) {
+    return (0, route_decorator_1.OARoute)(common_1.RequestMethod.GET, ...args);
+}
+//# sourceMappingURL=get.decorator.js.map

package/decorators/routes/get.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.decorator.js","sourceRoot":"","sources":["../../../../lib/decorators/routes/get.decorator.ts"],"names":[],"mappings":";;AAOA,sBAEC;AAPD,wDAA2C;AAC3C,2CAA6C;AAI7C,SAAgB,KAAK,CAAC,GAAG,IAAW;IAClC,OAAO,IAAA,yBAAO,EAAC,sBAAa,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AAC7C,CAAC"}

package/decorators/routes/patch.decorator.d.ts

@@ -0,0 +1,4 @@
+import { IOpenApiRouteLike } from "../../interfaces/common.interface";
+import { IOpenApiRouteOptions } from "../../interfaces/route.interface";
+export declare function OAPatch(path: IOpenApiRouteLike, options?: Omit<IOpenApiRouteOptions, 'path'> | false): MethodDecorator;
+export declare function OAPatch(options?: IOpenApiRouteOptions): MethodDecorator;

package/decorators/routes/patch.decorator.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAPatch = OAPatch;
+const route_decorator_1 = require("../route.decorator");
+const common_1 = require("@nestjs/common");
+function OAPatch(...args) {
+    return (0, route_decorator_1.OARoute)(common_1.RequestMethod.PATCH, ...args);
+}
+//# sourceMappingURL=patch.decorator.js.map

package/decorators/routes/patch.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.decorator.js","sourceRoot":"","sources":["../../../../lib/decorators/routes/patch.decorator.ts"],"names":[],"mappings":";;AAOA,0BAEC;AAPD,wDAA2C;AAC3C,2CAA6C;AAI7C,SAAgB,OAAO,CAAC,GAAG,IAAW;IACpC,OAAO,IAAA,yBAAO,EAAC,sBAAa,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;AAC/C,CAAC"}

package/decorators/routes/post.decorator.d.ts

@@ -0,0 +1,4 @@
+import { IOpenApiRouteLike } from "../../interfaces/common.interface";
+import { IOpenApiRouteOptions } from "../../interfaces/route.interface";
+export declare function OAPost(path: IOpenApiRouteLike, options?: Omit<IOpenApiRouteOptions, 'path'> | false): MethodDecorator;
+export declare function OAPost(options?: IOpenApiRouteOptions): MethodDecorator;

package/decorators/routes/post.decorator.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAPost = OAPost;
+const route_decorator_1 = require("../route.decorator");
+const common_1 = require("@nestjs/common");
+function OAPost(...args) {
+    return (0, route_decorator_1.OARoute)(common_1.RequestMethod.POST, ...args);
+}
+//# sourceMappingURL=post.decorator.js.map

package/decorators/routes/post.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"post.decorator.js","sourceRoot":"","sources":["../../../../lib/decorators/routes/post.decorator.ts"],"names":[],"mappings":";;AAOA,wBAEC;AAPD,wDAA2C;AAC3C,2CAA6C;AAI7C,SAAgB,MAAM,CAAC,GAAG,IAAW;IACnC,OAAO,IAAA,yBAAO,EAAC,sBAAa,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;AAC9C,CAAC"}

package/decorators/routes/put.decorator.d.ts

@@ -0,0 +1,4 @@
+import { IOpenApiRouteLike } from "../../interfaces/common.interface";
+import { IOpenApiRouteOptions } from "../../interfaces/route.interface";
+export declare function OAPut(path: IOpenApiRouteLike, options?: Omit<IOpenApiRouteOptions, 'path'> | false): MethodDecorator;
+export declare function OAPut(options?: IOpenApiRouteOptions): MethodDecorator;

package/decorators/routes/put.decorator.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAPut = OAPut;
+const route_decorator_1 = require("../route.decorator");
+const common_1 = require("@nestjs/common");
+function OAPut(...args) {
+    return (0, route_decorator_1.OARoute)(common_1.RequestMethod.PUT, ...args);
+}
+//# sourceMappingURL=put.decorator.js.map

package/decorators/routes/put.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"put.decorator.js","sourceRoot":"","sources":["../../../../lib/decorators/routes/put.decorator.ts"],"names":[],"mappings":";;AAOA,sBAEC;AAPD,wDAA2C;AAC3C,2CAA6C;AAI7C,SAAgB,KAAK,CAAC,GAAG,IAAW;IAClC,OAAO,IAAA,yBAAO,EAAC,sBAAa,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AAC7C,CAAC"}

package/decorators/tag-group.decorator.d.ts

@@ -0,0 +1,4 @@
+import { IOpenApiTagGroupMetadata } from "../interfaces/common.interface";
+export declare function OATagGroup(options: IOpenApiTagGroupMetadata): ClassDecorator & MethodDecorator;
+export declare function OATagGroup(name: string, options?: Omit<IOpenApiTagGroupMetadata, 'name'>): ClassDecorator & MethodDecorator;
+export declare function OATagGroup(name: string, description?: string, options?: Omit<IOpenApiTagGroupMetadata, 'name' | 'description'>): ClassDecorator & MethodDecorator;

package/decorators/tag-group.decorator.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OATagGroup = OATagGroup;
+const decorator_utils_1 = require("../utils/decorator.utils");
+const type_utils_1 = require("../utils/type.utils");
+const metadata_constants_1 = require("../constants/metadata.constants");
+function OATagGroup(...args) {
+    return (0, decorator_utils_1.createDecorator)({
+        transform: (ctx) => Object.assign({ name: (0, type_utils_1.extractString)(ctx.data) }, { description: (0, type_utils_1.extractString)(ctx.data, 1) }, (0, type_utils_1.extractObject)(ctx.data) || {}),
+        onApply: (ctx) => {
+            metadata_constants_1.DECORATORS.OPENAPI.TAG_GROUPS.set(ctx.data, ...ctx.decorateArgs);
+        }
+    })(args);
+}
+//# sourceMappingURL=tag-group.decorator.js.map

package/decorators/tag-group.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tag-group.decorator.js","sourceRoot":"","sources":["../../../lib/decorators/tag-group.decorator.ts"],"names":[],"mappings":";;AAeA,gCAWC;AA1BD,8DAAyD;AAEzD,oDAAiE;AACjE,wEAA2D;AAY3D,SAAgB,UAAU,CAAC,GAAG,IAAW;IACvC,OAAO,IAAA,iCAAe,EAAkC;QACtD,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAC/B,EAAE,IAAI,EAAE,IAAA,0BAAa,EAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EACjC,EAAE,WAAW,EAAE,IAAA,0BAAa,EAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAC3C,IAAA,0BAAa,EAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAC9B;QACD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACf,+BAAU,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;QACnE,CAAC;KACF,CAAC,CAAC,IAAI,CAAqC,CAAC;AAC/C,CAAC"}

package/decorators/tag.decorator.d.ts

@@ -0,0 +1,5 @@
+import { IOpenApiTagMetadata } from "../interfaces/common.interface";
+export declare function OATags(...tags: Array<string | IOpenApiTagMetadata>): ClassDecorator & MethodDecorator;
+export declare function OATag(options: IOpenApiTagMetadata): ClassDecorator & MethodDecorator;
+export declare function OATag(name: string, options?: Omit<IOpenApiTagMetadata, 'name'>): ClassDecorator & MethodDecorator;
+export declare function OATag(name: string, description?: string, options?: Omit<IOpenApiTagMetadata, 'name' | 'description'>): ClassDecorator & MethodDecorator;

package/decorators/tag.decorator.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OATags = OATags;
+exports.OATag = OATag;
+const decorator_utils_1 = require("../utils/decorator.utils");
+const type_utils_1 = require("../utils/type.utils");
+const metadata_constants_1 = require("../constants/metadata.constants");
+const swagger_1 = require("@nestjs/swagger");
+function OATags(...tags) {
+    return (0, decorator_utils_1.createDecorator)({
+        transform: (ctx) => ctx.data.map(tag => typeof tag === 'string' ? { name: tag } : tag),
+        decorators: (ctx, store) => ctx.data.map(tag => store.push(OATag(tag)))
+    })(tags);
+}
+function OATag(...args) {
+    return (0, decorator_utils_1.createDecorator)({
+        transform: (ctx) => Object.assign({ name: (0, type_utils_1.extractString)(ctx.data) }, { description: (0, type_utils_1.extractString)(ctx.data, 1) }, (0, type_utils_1.extractObject)(ctx.data) || {}),
+        decorators: (ctx, store) => {
+            store.push((0, swagger_1.ApiTags)(ctx.data.name));
+        },
+        onApply: (ctx) => {
+            metadata_constants_1.DECORATORS.OPENAPI.TAGS.add(ctx.data, ...ctx.decorateArgs);
+        }
+    })(args);
+}
+//# sourceMappingURL=tag.decorator.js.map

package/decorators/tag.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tag.decorator.js","sourceRoot":"","sources":["../../../lib/decorators/tag.decorator.ts"],"names":[],"mappings":";;AAMA,wBAKC;AAKD,sBAcC;AA9BD,8DAAyD;AAEzD,oDAAiE;AACjE,wEAA2D;AAC3D,6CAAwC;AAExC,SAAgB,MAAM,CAAC,GAAG,IAAuC;IAC/D,OAAO,IAAA,iCAAe,EAA2D;QAC/E,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QACtF,UAAU,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;KACxE,CAAC,CAAC,IAAI,CAAqC,CAAC;AAC/C,CAAC;AAKD,SAAgB,KAAK,CAAC,GAAG,IAAW;IAClC,OAAO,IAAA,iCAAe,EAA6B;QACjD,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAC/B,EAAE,IAAI,EAAE,IAAA,0BAAa,EAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EACjC,EAAE,WAAW,EAAE,IAAA,0BAAa,EAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAC3C,IAAA,0BAAa,EAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAC9B;QACD,UAAU,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACzB,KAAK,CAAC,IAAI,CAAC,IAAA,iBAAO,EAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACf,+BAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;QAC7D,CAAC;KACF,CAAC,CAAC,IAAI,CAAqC,CAAC;AAC/C,CAAC"}

package/index.d.ts

@@ -0,0 +1,66 @@
+export * from './openapi.builder';
+export * from './openapi.module';
+export * from './openapi.scanner';
+export * from './constants/metadata.constants';
+export * from './decorators/body.decorator';
+export * from './decorators/controller.decorator';
+export * from './decorators/error.decorator';
+export * from './decorators/header.decorator';
+export * from './decorators/param.decorator';
+export * from './decorators/property.decorator';
+export * from './decorators/query.decorator';
+export * from './decorators/request.decorator';
+export * from './decorators/response.decorator';
+export * from './decorators/route.decorator';
+export * from './decorators/tag-group.decorator';
+export * from './decorators/tag.decorator';
+export * from './decorators/errors/bad-gateway.decorator';
+export * from './decorators/errors/bad-request.decorator';
+export * from './decorators/errors/forbidden.decorator';
+export * from './decorators/errors/gateway-timeout.decorator';
+export * from './decorators/errors/gone.decorator';
+export * from './decorators/errors/internal-server-error.decorator';
+export * from './decorators/errors/method-not-allowed.decorator';
+export * from './decorators/errors/not-acceptable.decorator';
+export * from './decorators/errors/not-found.decorator';
+export * from './decorators/errors/not-implemented.decorator';
+export * from './decorators/errors/payload-too-large.decorator';
+export * from './decorators/errors/payment-required.decorator';
+export * from './decorators/errors/precondition-failed.decorator';
+export * from './decorators/errors/request-timeout.decorator';
+export * from './decorators/errors/service-unavailable.decorator';
+export * from './decorators/errors/too-many-requests.decorator';
+export * from './decorators/errors/unauthorized.decorator';
+export * from './decorators/errors/unprocessable-entity.decorator';
+export * from './decorators/errors/unsupported-media-type.decorator';
+export * from './decorators/properties/all-of.decorator';
+export * from './decorators/properties/any-of.decorator';
+export * from './decorators/properties/boolean.decorator';
+export * from './decorators/properties/enum.decorator';
+export * from './decorators/properties/number.decorator';
+export * from './decorators/properties/object.decorator';
+export * from './decorators/properties/one-of.decorator';
+export * from './decorators/properties/string.decorator';
+export * from './decorators/properties/type.decorator';
+export * from './decorators/routes/delete.decorator';
+export * from './decorators/routes/get.decorator';
+export * from './decorators/routes/patch.decorator';
+export * from './decorators/routes/post.decorator';
+export * from './decorators/routes/put.decorator';
+export * from './interfaces/body.interface';
+export * from './interfaces/common.interface';
+export * from './interfaces/controller.interface';
+export * from './interfaces/document.interface';
+export * from './interfaces/header.interface';
+export * from './interfaces/param.interface';
+export * from './interfaces/property.interface';
+export * from './interfaces/query.interface';
+export * from './interfaces/request.interface';
+export * from './interfaces/route.interface';
+export * from './utils/class.utils';
+export * from './utils/common.utils';
+export * from './utils/decorator.utils';
+export * from './utils/document-builder.utils';
+export * from './utils/metadata.utils';
+export * from './utils/schema.utils';
+export * from './utils/type.utils';

package/index.js

@@ -0,0 +1,83 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./openapi.builder"), exports);
+__exportStar(require("./openapi.module"), exports);
+__exportStar(require("./openapi.scanner"), exports);
+__exportStar(require("./constants/metadata.constants"), exports);
+__exportStar(require("./decorators/body.decorator"), exports);
+__exportStar(require("./decorators/controller.decorator"), exports);
+__exportStar(require("./decorators/error.decorator"), exports);
+__exportStar(require("./decorators/header.decorator"), exports);
+__exportStar(require("./decorators/param.decorator"), exports);
+__exportStar(require("./decorators/property.decorator"), exports);
+__exportStar(require("./decorators/query.decorator"), exports);
+__exportStar(require("./decorators/request.decorator"), exports);
+__exportStar(require("./decorators/response.decorator"), exports);
+__exportStar(require("./decorators/route.decorator"), exports);
+__exportStar(require("./decorators/tag-group.decorator"), exports);
+__exportStar(require("./decorators/tag.decorator"), exports);
+__exportStar(require("./decorators/errors/bad-gateway.decorator"), exports);
+__exportStar(require("./decorators/errors/bad-request.decorator"), exports);
+__exportStar(require("./decorators/errors/forbidden.decorator"), exports);
+__exportStar(require("./decorators/errors/gateway-timeout.decorator"), exports);
+__exportStar(require("./decorators/errors/gone.decorator"), exports);
+__exportStar(require("./decorators/errors/internal-server-error.decorator"), exports);
+__exportStar(require("./decorators/errors/method-not-allowed.decorator"), exports);
+__exportStar(require("./decorators/errors/not-acceptable.decorator"), exports);
+__exportStar(require("./decorators/errors/not-found.decorator"), exports);
+__exportStar(require("./decorators/errors/not-implemented.decorator"), exports);
+__exportStar(require("./decorators/errors/payload-too-large.decorator"), exports);
+__exportStar(require("./decorators/errors/payment-required.decorator"), exports);
+__exportStar(require("./decorators/errors/precondition-failed.decorator"), exports);
+__exportStar(require("./decorators/errors/request-timeout.decorator"), exports);
+__exportStar(require("./decorators/errors/service-unavailable.decorator"), exports);
+__exportStar(require("./decorators/errors/too-many-requests.decorator"), exports);
+__exportStar(require("./decorators/errors/unauthorized.decorator"), exports);
+__exportStar(require("./decorators/errors/unprocessable-entity.decorator"), exports);
+__exportStar(require("./decorators/errors/unsupported-media-type.decorator"), exports);
+__exportStar(require("./decorators/properties/all-of.decorator"), exports);
+__exportStar(require("./decorators/properties/any-of.decorator"), exports);
+__exportStar(require("./decorators/properties/boolean.decorator"), exports);
+__exportStar(require("./decorators/properties/enum.decorator"), exports);
+__exportStar(require("./decorators/properties/number.decorator"), exports);
+__exportStar(require("./decorators/properties/object.decorator"), exports);
+__exportStar(require("./decorators/properties/one-of.decorator"), exports);
+__exportStar(require("./decorators/properties/string.decorator"), exports);
+__exportStar(require("./decorators/properties/type.decorator"), exports);
+__exportStar(require("./decorators/routes/delete.decorator"), exports);
+__exportStar(require("./decorators/routes/get.decorator"), exports);
+__exportStar(require("./decorators/routes/patch.decorator"), exports);
+__exportStar(require("./decorators/routes/post.decorator"), exports);
+__exportStar(require("./decorators/routes/put.decorator"), exports);
+__exportStar(require("./interfaces/body.interface"), exports);
+__exportStar(require("./interfaces/common.interface"), exports);
+__exportStar(require("./interfaces/controller.interface"), exports);
+__exportStar(require("./interfaces/document.interface"), exports);
+__exportStar(require("./interfaces/header.interface"), exports);
+__exportStar(require("./interfaces/param.interface"), exports);
+__exportStar(require("./interfaces/property.interface"), exports);
+__exportStar(require("./interfaces/query.interface"), exports);
+__exportStar(require("./interfaces/request.interface"), exports);
+__exportStar(require("./interfaces/route.interface"), exports);
+__exportStar(require("./utils/class.utils"), exports);
+__exportStar(require("./utils/common.utils"), exports);
+__exportStar(require("./utils/decorator.utils"), exports);
+__exportStar(require("./utils/document-builder.utils"), exports);
+__exportStar(require("./utils/metadata.utils"), exports);
+__exportStar(require("./utils/schema.utils"), exports);
+__exportStar(require("./utils/type.utils"), exports);
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,mDAAiC;AACjC,oDAAkC;AAClC,iEAA+C;AAC/C,8DAA4C;AAC5C,oEAAkD;AAClD,+DAA6C;AAC7C,gEAA8C;AAC9C,+DAA6C;AAC7C,kEAAgD;AAChD,+DAA6C;AAC7C,iEAA+C;AAC/C,kEAAgD;AAChD,+DAA6C;AAC7C,mEAAiD;AACjD,6DAA2C;AAC3C,4EAA0D;AAC1D,4EAA0D;AAC1D,0EAAwD;AACxD,gFAA8D;AAC9D,qEAAmD;AACnD,sFAAoE;AACpE,mFAAiE;AACjE,+EAA6D;AAC7D,0EAAwD;AACxD,gFAA8D;AAC9D,kFAAgE;AAChE,iFAA+D;AAC/D,oFAAkE;AAClE,gFAA8D;AAC9D,oFAAkE;AAClE,kFAAgE;AAChE,6EAA2D;AAC3D,qFAAmE;AACnE,uFAAqE;AACrE,2EAAyD;AACzD,2EAAyD;AACzD,4EAA0D;AAC1D,yEAAuD;AACvD,2EAAyD;AACzD,2EAAyD;AACzD,2EAAyD;AACzD,2EAAyD;AACzD,yEAAuD;AACvD,uEAAqD;AACrD,oEAAkD;AAClD,sEAAoD;AACpD,qEAAmD;AACnD,oEAAkD;AAClD,8DAA4C;AAC5C,gEAA8C;AAC9C,oEAAkD;AAClD,kEAAgD;AAChD,gEAA8C;AAC9C,+DAA6C;AAC7C,kEAAgD;AAChD,+DAA6C;AAC7C,iEAA+C;AAC/C,+DAA6C;AAC7C,sDAAoC;AACpC,uDAAqC;AACrC,0DAAwC;AACxC,iEAA+C;AAC/C,yDAAuC;AACvC,uDAAqC;AACrC,qDAAmC"}

package/interfaces/body.interface.d.ts

@@ -0,0 +1,5 @@
+import { IOpenApiType, IOpenApiTypeHost } from "./common.interface";
+import { ApiResponseMetadata } from "@nestjs/swagger/dist/decorators/api-response.decorator";
+export type IOpenApiBodyOptions = IOpenApiType | IOpenApiBodyMetadata;
+export interface IOpenApiBodyMetadata extends IOpenApiTypeHost, Omit<ApiResponseMetadata, 'type'> {
+}

package/interfaces/body.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=body.interface.js.map

package/interfaces/body.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"body.interface.js","sourceRoot":"","sources":["../../../lib/interfaces/body.interface.ts"],"names":[],"mappings":""}

package/interfaces/common.interface.d.ts

@@ -0,0 +1,36 @@
+import { Type } from "@nestjs/common";
+import { ApiResponseExamples, ApiResponseNoStatusOptions, ApiResponseOptions } from "@nestjs/swagger/dist/decorators/api-response.decorator";
+export type IOpenApiStatus = number | '1XX' | '2XX' | '3XX' | '4XX' | '5XX';
+export type IOpenApiType<T = unknown> = IOpenApiTypeRef<T> | Function | [Function] | string;
+export type IOpenApiTypeRef<T = unknown> = IOpenApiTypeRefSingle<T> | IOpenApiTypeRefList<T>;
+export type IOpenApiTypeRefSingle<T = unknown> = Type<T> | IOpenApiForwardRef<Type<T>>;
+export type IOpenApiTypeRefList<T = unknown> = Type<T>[] | IOpenApiForwardRef<Type<T>[]>;
+export type IOpenApiForwardRef<T = Type<unknown> | [Type<unknown>]> = () => T;
+export type IOpenApiResponseType = IOpenApiTypeRef;
+export type IOpenApiResponseOptions = ApiResponseNoStatusOptions & {
+    status?: number;
+    type?: IOpenApiForwardRef;
+};
+export type IOpenApiErrorType = IOpenApiTypeRef;
+export type IOpenApiErrorOptions = Omit<ApiResponseOptions, 'type'> & {
+    type?: IOpenApiErrorType;
+    example?: any;
+    examples?: Record<string, ApiResponseExamples>;
+};
+export type IOpenApiRouteLike = string | string[];
+export interface IOpenApiTypeHost {
+    type?: IOpenApiType;
+}
+export type IOpenApiTags = Array<string | IOpenApiTagMetadata>;
+export interface IOpenApiTagMetadata {
+    name: string;
+    displayName?: string;
+    description?: string;
+    trait?: boolean;
+}
+export type IOpenApiTagGroups = Array<string | IOpenApiTagGroupMetadata>;
+export interface IOpenApiTagGroupMetadata {
+    name: string;
+    description?: string;
+    tags?: string[];
+}

package/interfaces/common.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.interface.js.map

package/interfaces/common.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.interface.js","sourceRoot":"","sources":["../../../lib/interfaces/common.interface.ts"],"names":[],"mappings":""}

package/interfaces/controller.interface.d.ts

@@ -0,0 +1,4 @@
+import { ControllerOptions } from "@nestjs/common";
+import { IOpenApiRequestOptions } from "./request.interface";
+export interface IOpenApiControllerOptions extends IOpenApiRequestOptions, ControllerOptions {
+}

package/interfaces/controller.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=controller.interface.js.map

package/interfaces/controller.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"controller.interface.js","sourceRoot":"","sources":["../../../lib/interfaces/controller.interface.ts"],"names":[],"mappings":""}

package/interfaces/document.interface.d.ts

@@ -0,0 +1,31 @@
+import { SwaggerDocumentOptions } from "@nestjs/swagger/dist/interfaces";
+import { OpenAPIObject } from "@nestjs/swagger";
+import { TagObject } from "@nestjs/swagger/dist/interfaces/open-api-spec.interface";
+import { IOpenApiStatus, IOpenApiTagGroupMetadata, IOpenApiTypeRefSingle } from "./common.interface";
+import { Type } from "@nestjs/common";
+export interface IOpenApiDocumentOptions extends SwaggerDocumentOptions {
+    uniqueTagGroupTags?: boolean;
+    uniqueTagGroupTagNameFactory?: (groupName: string, tagName: string) => string;
+    tagGroupUngrouped?: boolean | string | Omit<IOpenApiTagGroupMetadata, 'tags'>;
+    responseOverrides?: IOpenApiDocumentOverrideResponses;
+    responseOverrideModelNameFactory?: boolean | ((overrideName: string, responseType: string) => string);
+}
+export type IOpenApiDocumentOverrideResponses = Partial<Record<IOpenApiDocumentOverrideResponseStatus, IOpenApiDocumentOverrideResponseValue>>;
+export type IOpenApiDocumentOverrideResponseStatus = 'default' | 'info' | 'success' | 'redirect' | 'error' | 'clientError' | 'serverError' | IOpenApiStatus;
+export type IOpenApiDocumentOverrideResponseValue = IOpenApiTypeRefSingle | [Type<unknown>, string] | IOpenApiDocumentOverrideResponse;
+export interface IOpenApiDocumentOverrideResponse {
+    type: Type<unknown>;
+    subKey?: string;
+}
+export interface OpenApiDocument extends Omit<OpenAPIObject, 'tags'> {
+    tags?: OpenApiDocumentTag[];
+    'x-tagGroups'?: OpenApiDocumentTagGroup[];
+}
+export interface OpenApiDocumentTag extends TagObject {
+    'x-displayName'?: string;
+}
+export interface OpenApiDocumentTagGroup {
+    name: string;
+    description?: string;
+    tags?: string[];
+}

package/interfaces/document.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=document.interface.js.map

package/interfaces/document.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.interface.js","sourceRoot":"","sources":["../../../lib/interfaces/document.interface.ts"],"names":[],"mappings":""}

package/interfaces/header.interface.d.ts

@@ -0,0 +1,7 @@
+import { ApiHeaderOptions } from "@nestjs/swagger";
+export type IOpenApiHeaderOptions = IOpenApiHeaderSpec;
+export interface IOpenApiHeaderSpec {
+    [header: string]: Omit<ApiHeaderOptions, 'name'>;
+}
+export interface IOpenApiHeaderMetadata extends Omit<ApiHeaderOptions, 'name'> {
+}

package/interfaces/header.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=header.interface.js.map

package/interfaces/header.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"header.interface.js","sourceRoot":"","sources":["../../../lib/interfaces/header.interface.ts"],"names":[],"mappings":""}

package/interfaces/param.interface.d.ts

@@ -0,0 +1,13 @@
+import { IOpenApiType } from "./common.interface";
+import { SwaggerEnumType } from "@nestjs/swagger/dist/types/swagger-enum.type";
+import { ParameterObject } from "@nestjs/swagger/dist/interfaces/open-api-spec.interface";
+export type IOpenApiParamOptions = IOpenApiParamSpec;
+export interface IOpenApiParamSpec {
+    [param: string]: Omit<IOpenApiParamMetadata, 'name'>;
+}
+export interface IOpenApiParamMetadata extends Omit<ParameterObject, 'in'> {
+    type?: IOpenApiType;
+    format?: string;
+    enum?: SwaggerEnumType;
+    enumName?: string;
+}

package/interfaces/param.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=param.interface.js.map

package/interfaces/param.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"param.interface.js","sourceRoot":"","sources":["../../../lib/interfaces/param.interface.ts"],"names":[],"mappings":""}

package/interfaces/property.interface.d.ts

@@ -0,0 +1,2 @@
+import { ApiPropertyOptions } from "@nestjs/swagger";
+export type IOpenApiPropertyOptions = ApiPropertyOptions;

package/interfaces/property.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=property.interface.js.map

package/interfaces/property.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"property.interface.js","sourceRoot":"","sources":["../../../lib/interfaces/property.interface.ts"],"names":[],"mappings":""}

package/interfaces/query.interface.d.ts

@@ -0,0 +1,14 @@
+import { ParameterObject } from "@nestjs/swagger/dist/interfaces/open-api-spec.interface";
+import { IOpenApiType } from "./common.interface";
+import { SwaggerEnumType } from "@nestjs/swagger/dist/types/swagger-enum.type";
+export type IOpenApiQueryOptions = IOpenApiQuerySpec;
+export interface IOpenApiQuerySpec {
+    [query: string]: Omit<IOpenApiQueryMetadata, 'name'>;
+}
+export interface IOpenApiQueryMetadata extends Omit<ParameterObject, 'in'> {
+    type?: IOpenApiType;
+    format?: string;
+    enum?: SwaggerEnumType;
+    enumName?: string;
+    isArray?: boolean;
+}

package/interfaces/query.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=query.interface.js.map

package/interfaces/query.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.interface.js","sourceRoot":"","sources":["../../../lib/interfaces/query.interface.ts"],"names":[],"mappings":""}

package/interfaces/request.interface.d.ts

@@ -0,0 +1,12 @@
+import { IOpenApiTagGroups, IOpenApiTags } from "./common.interface";
+import { IOpenApiHeaderOptions } from "./header.interface";
+import { IOpenApiQueryOptions } from "./query.interface";
+import { IOpenApiParamOptions } from "./param.interface";
+export interface IOpenApiRequestOptions {
+    exclude?: boolean;
+    tags?: IOpenApiTags;
+    tagGroups?: IOpenApiTagGroups;
+    headers?: IOpenApiHeaderOptions;
+    query?: IOpenApiQueryOptions;
+    params?: IOpenApiParamOptions;
+}

package/interfaces/request.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=request.interface.js.map

package/interfaces/request.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.interface.js","sourceRoot":"","sources":["../../../lib/interfaces/request.interface.ts"],"names":[],"mappings":""}