moonflower 0.9.0
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.
- package/.eslintrc.js +26 -0
- package/.prettierrc.js +7 -0
- package/README.md +383 -0
- package/cli/cli.ts +59 -0
- package/cli/entry.cjs +3 -0
- package/cli/prettyprint.ts +16 -0
- package/dist/cli/cli.d.ts +2 -0
- package/dist/cli/cli.d.ts.map +1 -0
- package/dist/cli/cli.js +79 -0
- package/dist/cli/prettyprint.d.ts +4 -0
- package/dist/cli/prettyprint.d.ts.map +1 -0
- package/dist/cli/prettyprint.js +18 -0
- package/dist/src/errors/BaseHttpError.d.ts +13 -0
- package/dist/src/errors/BaseHttpError.d.ts.map +1 -0
- package/dist/src/errors/BaseHttpError.js +13 -0
- package/dist/src/errors/HttpErrorHandler.d.ts +3 -0
- package/dist/src/errors/HttpErrorHandler.d.ts.map +1 -0
- package/dist/src/errors/HttpErrorHandler.js +23 -0
- package/dist/src/errors/UserFacingErrors.d.ts +11 -0
- package/dist/src/errors/UserFacingErrors.d.ts.map +1 -0
- package/dist/src/errors/UserFacingErrors.js +23 -0
- package/dist/src/hooks/authentication/useAuth.d.ts +3 -0
- package/dist/src/hooks/authentication/useAuth.d.ts.map +1 -0
- package/dist/src/hooks/authentication/useAuth.js +7 -0
- package/dist/src/hooks/authentication/useOptionalAuth.d.ts +3 -0
- package/dist/src/hooks/authentication/useOptionalAuth.d.ts.map +1 -0
- package/dist/src/hooks/authentication/useOptionalAuth.js +16 -0
- package/dist/src/hooks/useApiEndpoint.d.ts +8 -0
- package/dist/src/hooks/useApiEndpoint.d.ts.map +1 -0
- package/dist/src/hooks/useApiEndpoint.js +7 -0
- package/dist/src/hooks/useApiHeader/index.d.ts +2 -0
- package/dist/src/hooks/useApiHeader/index.d.ts.map +1 -0
- package/dist/src/hooks/useApiHeader/index.js +17 -0
- package/dist/src/hooks/useApiHeader/useApiHeader.d.ts +3 -0
- package/dist/src/hooks/useApiHeader/useApiHeader.d.ts.map +1 -0
- package/dist/src/hooks/useApiHeader/useApiHeader.js +6 -0
- package/dist/src/hooks/useApiHeader/useApiHeader.spec.data.d.ts +2 -0
- package/dist/src/hooks/useApiHeader/useApiHeader.spec.data.d.ts.map +1 -0
- package/dist/src/hooks/useApiHeader/useApiHeader.spec.data.js +22 -0
- package/dist/src/hooks/useCookieParams.d.ts +9 -0
- package/dist/src/hooks/useCookieParams.d.ts.map +1 -0
- package/dist/src/hooks/useCookieParams.js +50 -0
- package/dist/src/hooks/useExposeApiModel/index.d.ts +2 -0
- package/dist/src/hooks/useExposeApiModel/index.d.ts.map +1 -0
- package/dist/src/hooks/useExposeApiModel/index.js +17 -0
- package/dist/src/hooks/useExposeApiModel/useExposeApiModel.d.ts +3 -0
- package/dist/src/hooks/useExposeApiModel/useExposeApiModel.d.ts.map +1 -0
- package/dist/src/hooks/useExposeApiModel/useExposeApiModel.js +9 -0
- package/dist/src/hooks/useExposeApiModel/useExposeApiModel.spec.data.d.ts +2 -0
- package/dist/src/hooks/useExposeApiModel/useExposeApiModel.spec.data.d.ts.map +1 -0
- package/dist/src/hooks/useExposeApiModel/useExposeApiModel.spec.data.js +16 -0
- package/dist/src/hooks/useHeaderParams.d.ts +12 -0
- package/dist/src/hooks/useHeaderParams.d.ts.map +1 -0
- package/dist/src/hooks/useHeaderParams.js +52 -0
- package/dist/src/hooks/usePathParams.d.ts +22 -0
- package/dist/src/hooks/usePathParams.d.ts.map +1 -0
- package/dist/src/hooks/usePathParams.js +46 -0
- package/dist/src/hooks/useQueryParams.d.ts +9 -0
- package/dist/src/hooks/useQueryParams.d.ts.map +1 -0
- package/dist/src/hooks/useQueryParams.js +50 -0
- package/dist/src/hooks/useRequestBody.d.ts +9 -0
- package/dist/src/hooks/useRequestBody.d.ts.map +1 -0
- package/dist/src/hooks/useRequestBody.js +59 -0
- package/dist/src/hooks/useRequestRawBody.d.ts +7 -0
- package/dist/src/hooks/useRequestRawBody.d.ts.map +1 -0
- package/dist/src/hooks/useRequestRawBody.js +34 -0
- package/dist/src/index.d.ts +18 -0
- package/dist/src/index.d.ts.map +1 -0
- package/dist/src/index.js +33 -0
- package/dist/src/openapi/analyzerModule/analyzerModule.d.ts +18 -0
- package/dist/src/openapi/analyzerModule/analyzerModule.d.ts.map +1 -0
- package/dist/src/openapi/analyzerModule/analyzerModule.js +192 -0
- package/dist/src/openapi/analyzerModule/nodeParsers.d.ts +19 -0
- package/dist/src/openapi/analyzerModule/nodeParsers.d.ts.map +1 -0
- package/dist/src/openapi/analyzerModule/nodeParsers.js +521 -0
- package/dist/src/openapi/analyzerModule/parseEndpoint.d.ts +4 -0
- package/dist/src/openapi/analyzerModule/parseEndpoint.d.ts.map +1 -0
- package/dist/src/openapi/analyzerModule/parseEndpoint.js +246 -0
- package/dist/src/openapi/analyzerModule/parseExposedModels.d.ts +5 -0
- package/dist/src/openapi/analyzerModule/parseExposedModels.d.ts.map +1 -0
- package/dist/src/openapi/analyzerModule/parseExposedModels.js +32 -0
- package/dist/src/openapi/analyzerModule/test/openApiAnalyzer.spec.data.d.ts +2 -0
- package/dist/src/openapi/analyzerModule/test/openApiAnalyzer.spec.data.d.ts.map +1 -0
- package/dist/src/openapi/analyzerModule/test/openApiAnalyzer.spec.data.js +400 -0
- package/dist/src/openapi/analyzerModule/types.d.ts +53 -0
- package/dist/src/openapi/analyzerModule/types.d.ts.map +1 -0
- package/dist/src/openapi/analyzerModule/types.js +2 -0
- package/dist/src/openapi/discoveryModule/discoverImports/discoverImports.d.ts +8 -0
- package/dist/src/openapi/discoveryModule/discoverImports/discoverImports.d.ts.map +1 -0
- package/dist/src/openapi/discoveryModule/discoverImports/discoverImports.js +33 -0
- package/dist/src/openapi/discoveryModule/discoverRouterFiles/data/testRouterA.spec.data.d.ts +4 -0
- package/dist/src/openapi/discoveryModule/discoverRouterFiles/data/testRouterA.spec.data.d.ts.map +1 -0
- package/dist/src/openapi/discoveryModule/discoverRouterFiles/data/testRouterA.spec.data.js +8 -0
- package/dist/src/openapi/discoveryModule/discoverRouterFiles/data/testRouterB.spec.data.d.ts +4 -0
- package/dist/src/openapi/discoveryModule/discoverRouterFiles/data/testRouterB.spec.data.d.ts.map +1 -0
- package/dist/src/openapi/discoveryModule/discoverRouterFiles/data/testRouterB.spec.data.js +8 -0
- package/dist/src/openapi/discoveryModule/discoverRouterFiles/discoverRouterFiles.d.ts +17 -0
- package/dist/src/openapi/discoveryModule/discoverRouterFiles/discoverRouterFiles.d.ts.map +1 -0
- package/dist/src/openapi/discoveryModule/discoverRouterFiles/discoverRouterFiles.js +80 -0
- package/dist/src/openapi/discoveryModule/discoverRouters/discoverRouters.d.ts +6 -0
- package/dist/src/openapi/discoveryModule/discoverRouters/discoverRouters.d.ts.map +1 -0
- package/dist/src/openapi/discoveryModule/discoverRouters/discoverRouters.js +31 -0
- package/dist/src/openapi/discoveryModule/discoverRouters/discoverRouters.spec.data.d.ts +5 -0
- package/dist/src/openapi/discoveryModule/discoverRouters/discoverRouters.spec.data.d.ts.map +1 -0
- package/dist/src/openapi/discoveryModule/discoverRouters/discoverRouters.spec.data.js +38 -0
- package/dist/src/openapi/discoveryModule/index.d.ts +3 -0
- package/dist/src/openapi/discoveryModule/index.d.ts.map +1 -0
- package/dist/src/openapi/discoveryModule/index.js +18 -0
- package/dist/src/openapi/generatorModule/generateComponentSchemas.d.ts +4 -0
- package/dist/src/openapi/generatorModule/generateComponentSchemas.d.ts.map +1 -0
- package/dist/src/openapi/generatorModule/generateComponentSchemas.js +12 -0
- package/dist/src/openapi/generatorModule/generatePaths.d.ts +10 -0
- package/dist/src/openapi/generatorModule/generatePaths.d.ts.map +1 -0
- package/dist/src/openapi/generatorModule/generatePaths.js +116 -0
- package/dist/src/openapi/generatorModule/generatorModule.d.ts +16 -0
- package/dist/src/openapi/generatorModule/generatorModule.d.ts.map +1 -0
- package/dist/src/openapi/generatorModule/generatorModule.js +18 -0
- package/dist/src/openapi/generatorModule/getSchema.d.ts +36 -0
- package/dist/src/openapi/generatorModule/getSchema.d.ts.map +1 -0
- package/dist/src/openapi/generatorModule/getSchema.js +133 -0
- package/dist/src/openapi/generatorModule/index.d.ts +5 -0
- package/dist/src/openapi/generatorModule/index.d.ts.map +1 -0
- package/dist/src/openapi/generatorModule/index.js +20 -0
- package/dist/src/openapi/generatorModule/test/openApiGenerator.spec.data.d.ts +515 -0
- package/dist/src/openapi/generatorModule/test/openApiGenerator.spec.data.d.ts.map +1 -0
- package/dist/src/openapi/generatorModule/test/openApiGenerator.spec.data.js +1119 -0
- package/dist/src/openapi/initOpenApiEngine.d.ts +4 -0
- package/dist/src/openapi/initOpenApiEngine.d.ts.map +1 -0
- package/dist/src/openapi/initOpenApiEngine.js +14 -0
- package/dist/src/openapi/manager/OpenApiManager.d.ts +67 -0
- package/dist/src/openapi/manager/OpenApiManager.d.ts.map +1 -0
- package/dist/src/openapi/manager/OpenApiManager.js +86 -0
- package/dist/src/openapi/router/OpenApiRouter.d.ts +4 -0
- package/dist/src/openapi/router/OpenApiRouter.d.ts.map +1 -0
- package/dist/src/openapi/router/OpenApiRouter.js +11 -0
- package/dist/src/openapi/types.d.ts +81 -0
- package/dist/src/openapi/types.d.ts.map +1 -0
- package/dist/src/openapi/types.js +2 -0
- package/dist/src/router/Router.d.ts +23 -0
- package/dist/src/router/Router.d.ts.map +1 -0
- package/dist/src/router/Router.js +81 -0
- package/dist/src/router/responseValueToJson.d.ts +2 -0
- package/dist/src/router/responseValueToJson.d.ts.map +1 -0
- package/dist/src/router/responseValueToJson.js +10 -0
- package/dist/src/setupTests.d.ts +1 -0
- package/dist/src/setupTests.d.ts.map +1 -0
- package/dist/src/setupTests.js +3 -0
- package/dist/src/test/TestAppRouter.d.ts +8 -0
- package/dist/src/test/TestAppRouter.d.ts.map +1 -0
- package/dist/src/test/TestAppRouter.js +58 -0
- package/dist/src/test/app.d.ts +3 -0
- package/dist/src/test/app.d.ts.map +1 -0
- package/dist/src/test/app.js +41 -0
- package/dist/src/utils/TypeUtils.d.ts +22 -0
- package/dist/src/utils/TypeUtils.d.ts.map +1 -0
- package/dist/src/utils/TypeUtils.js +2 -0
- package/dist/src/utils/fromZodSchema.d.ts +2 -0
- package/dist/src/utils/fromZodSchema.d.ts.map +1 -0
- package/dist/src/utils/fromZodSchema.js +6 -0
- package/dist/src/utils/loadTestData.d.ts +2 -0
- package/dist/src/utils/loadTestData.d.ts.map +1 -0
- package/dist/src/utils/loadTestData.js +39 -0
- package/dist/src/utils/mockContext.d.ts +20 -0
- package/dist/src/utils/mockContext.d.ts.map +1 -0
- package/dist/src/utils/mockContext.js +85 -0
- package/dist/src/utils/nameOf.d.ts +5 -0
- package/dist/src/utils/nameOf.d.ts.map +1 -0
- package/dist/src/utils/nameOf.js +7 -0
- package/dist/src/utils/object.d.ts +7 -0
- package/dist/src/utils/object.d.ts.map +1 -0
- package/dist/src/utils/object.js +21 -0
- package/dist/src/utils/printers.d.ts +6 -0
- package/dist/src/utils/printers.d.ts.map +1 -0
- package/dist/src/utils/printers.js +76 -0
- package/dist/src/utils/validationMessages.d.ts +18 -0
- package/dist/src/utils/validationMessages.d.ts.map +1 -0
- package/dist/src/utils/validationMessages.js +43 -0
- package/dist/src/validators/BuiltInValidators.d.ts +61 -0
- package/dist/src/validators/BuiltInValidators.d.ts.map +1 -0
- package/dist/src/validators/BuiltInValidators.js +66 -0
- package/dist/src/validators/InternalParamWrappers.d.ts +5 -0
- package/dist/src/validators/InternalParamWrappers.d.ts.map +1 -0
- package/dist/src/validators/InternalParamWrappers.js +5 -0
- package/dist/src/validators/ParamWrappers.d.ts +11 -0
- package/dist/src/validators/ParamWrappers.d.ts.map +1 -0
- package/dist/src/validators/ParamWrappers.js +9 -0
- package/dist/src/validators/types.d.ts +18 -0
- package/dist/src/validators/types.d.ts.map +1 -0
- package/dist/src/validators/types.js +2 -0
- package/dist/tsconfig.build.tsbuildinfo +1 -0
- package/package.json +59 -0
- package/src/errors/BaseHttpError.ts +16 -0
- package/src/errors/HttpErrorHandler.ts +20 -0
- package/src/errors/UserFacingErrors.ts +39 -0
- package/src/hooks/authentication/useAuth.ts +8 -0
- package/src/hooks/authentication/useOptionalAuth.ts +17 -0
- package/src/hooks/useApiEndpoint.spec.ts +11 -0
- package/src/hooks/useApiEndpoint.ts +10 -0
- package/src/hooks/useApiHeader/index.ts +1 -0
- package/src/hooks/useApiHeader/useApiHeader.spec.data.ts +22 -0
- package/src/hooks/useApiHeader/useApiHeader.spec.ts +34 -0
- package/src/hooks/useApiHeader/useApiHeader.ts +6 -0
- package/src/hooks/useCookieParams.spec.ts +174 -0
- package/src/hooks/useCookieParams.ts +73 -0
- package/src/hooks/useExposeApiModel/index.ts +1 -0
- package/src/hooks/useExposeApiModel/useExposeApiModel.spec.data.ts +48 -0
- package/src/hooks/useExposeApiModel/useExposeApiModel.spec.ts +388 -0
- package/src/hooks/useExposeApiModel/useExposeApiModel.ts +9 -0
- package/src/hooks/useHeaderParams.spec.ts +186 -0
- package/src/hooks/useHeaderParams.ts +83 -0
- package/src/hooks/usePathParams.spec.ts +161 -0
- package/src/hooks/usePathParams.ts +89 -0
- package/src/hooks/useQueryParams.spec.ts +224 -0
- package/src/hooks/useQueryParams.ts +73 -0
- package/src/hooks/useRequestBody.spec.ts +215 -0
- package/src/hooks/useRequestBody.ts +94 -0
- package/src/hooks/useRequestRawBody.spec.ts +154 -0
- package/src/hooks/useRequestRawBody.ts +56 -0
- package/src/index.ts +17 -0
- package/src/openapi/analyzerModule/analyzerModule.ts +228 -0
- package/src/openapi/analyzerModule/nodeParsers.ts +648 -0
- package/src/openapi/analyzerModule/parseEndpoint.ts +305 -0
- package/src/openapi/analyzerModule/parseExposedModels.ts +34 -0
- package/src/openapi/analyzerModule/test/openApiAnalyzer.spec.data.ts +521 -0
- package/src/openapi/analyzerModule/test/openApiAnalyzer.spec.ts +1043 -0
- package/src/openapi/analyzerModule/types.ts +72 -0
- package/src/openapi/discoveryModule/discoverImports/discoverImports.ts +43 -0
- package/src/openapi/discoveryModule/discoverRouterFiles/data/testRouterA.spec.data.ts +7 -0
- package/src/openapi/discoveryModule/discoverRouterFiles/data/testRouterB.spec.data.ts +7 -0
- package/src/openapi/discoveryModule/discoverRouterFiles/discoverRouterFiles.spec.ts +36 -0
- package/src/openapi/discoveryModule/discoverRouterFiles/discoverRouterFiles.ts +80 -0
- package/src/openapi/discoveryModule/discoverRouters/discoverRouters.spec.data.ts +42 -0
- package/src/openapi/discoveryModule/discoverRouters/discoverRouters.spec.ts +18 -0
- package/src/openapi/discoveryModule/discoverRouters/discoverRouters.ts +39 -0
- package/src/openapi/discoveryModule/index.ts +2 -0
- package/src/openapi/generatorModule/generateComponentSchemas.ts +12 -0
- package/src/openapi/generatorModule/generatePaths.ts +138 -0
- package/src/openapi/generatorModule/generatorModule.ts +17 -0
- package/src/openapi/generatorModule/getSchema.ts +169 -0
- package/src/openapi/generatorModule/index.ts +4 -0
- package/src/openapi/generatorModule/test/openApiGenerator.spec.data.ts +1119 -0
- package/src/openapi/generatorModule/test/openApiGenerator.spec.ts +783 -0
- package/src/openapi/initOpenApiEngine.ts +20 -0
- package/src/openapi/manager/OpenApiManager.ts +153 -0
- package/src/openapi/router/OpenApiRouter.ts +11 -0
- package/src/openapi/types.ts +86 -0
- package/src/router/Router.ts +123 -0
- package/src/router/responseValueToJson.ts +6 -0
- package/src/setupTests.ts +3 -0
- package/src/test/TestAppRouter.ts +76 -0
- package/src/test/app.spec.ts +130 -0
- package/src/test/app.ts +43 -0
- package/src/utils/TypeUtils.ts +51 -0
- package/src/utils/loadTestData.ts +15 -0
- package/src/utils/mockContext.ts +86 -0
- package/src/utils/nameOf.ts +7 -0
- package/src/utils/object.spec.ts +27 -0
- package/src/utils/object.ts +17 -0
- package/src/utils/printers.spec.ts +103 -0
- package/src/utils/printers.ts +49 -0
- package/src/utils/validationMessages.ts +65 -0
- package/src/validators/BuiltInValidators.ts +64 -0
- package/src/validators/InternalParamWrappers.ts +14 -0
- package/src/validators/ParamWrappers.ts +22 -0
- package/src/validators/types.ts +35 -0
- package/tsconfig.build.json +15 -0
- package/tsconfig.json +29 -0
- package/vite.config.ts +16 -0
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import Koa from 'koa';
|
|
2
|
+
import { prepareOpenApiSpec } from './analyzerModule/analyzerModule';
|
|
3
|
+
export declare const initOpenApiEngine: (props: Parameters<typeof prepareOpenApiSpec>[0]) => (ctx: Koa.ParameterizedContext<any, any>, next: Koa.Next) => any;
|
|
4
|
+
//# sourceMappingURL=initOpenApiEngine.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"initOpenApiEngine.d.ts","sourceRoot":"","sources":["../../../src/openapi/initOpenApiEngine.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AASpE,eAAO,MAAM,iBAAiB,UAAW,WAAW,yBAAyB,CAAC,CAAC,CAAC,CAAC,WAKnE,IAAI,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,IAAI,IAAI,QAG/D,CAAA"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.initOpenApiEngine = void 0;
|
|
4
|
+
const analyzerModule_1 = require("./analyzerModule/analyzerModule");
|
|
5
|
+
const OpenApiRouter_1 = require("./router/OpenApiRouter");
|
|
6
|
+
const initOpenApiEngine = (props) => {
|
|
7
|
+
(0, analyzerModule_1.prepareOpenApiSpec)(props);
|
|
8
|
+
const builtInRoutes = OpenApiRouter_1.OpenApiRouter.routes();
|
|
9
|
+
const builtInAllowedMethods = OpenApiRouter_1.OpenApiRouter.allowedMethods();
|
|
10
|
+
return (ctx, next) => {
|
|
11
|
+
return builtInRoutes(ctx, () => builtInAllowedMethods(ctx, next));
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
exports.initOpenApiEngine = initOpenApiEngine;
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { Router } from '../../router/Router';
|
|
2
|
+
import { EndpointData, ExposedModelData } from '../types';
|
|
3
|
+
type UrlType = `${'http' | 'https'}://${string}.${string}`;
|
|
4
|
+
export type ApiDocsHeader = {
|
|
5
|
+
title: string;
|
|
6
|
+
version: string;
|
|
7
|
+
description?: string;
|
|
8
|
+
termsOfService?: UrlType;
|
|
9
|
+
contact?: {
|
|
10
|
+
name?: string;
|
|
11
|
+
url?: UrlType;
|
|
12
|
+
email?: string;
|
|
13
|
+
};
|
|
14
|
+
license?: {
|
|
15
|
+
name?: string;
|
|
16
|
+
url?: UrlType;
|
|
17
|
+
};
|
|
18
|
+
};
|
|
19
|
+
export type ApiDocsPreferences = {
|
|
20
|
+
allowOptionalPathParams: boolean;
|
|
21
|
+
};
|
|
22
|
+
export type ApiAnalysisStats = {
|
|
23
|
+
explicitRouterFiles: {
|
|
24
|
+
path: string;
|
|
25
|
+
routers: {
|
|
26
|
+
name: string;
|
|
27
|
+
endpoints: string[];
|
|
28
|
+
}[];
|
|
29
|
+
}[];
|
|
30
|
+
discoveredRouterFiles: {
|
|
31
|
+
path: string;
|
|
32
|
+
routers: {
|
|
33
|
+
name: string;
|
|
34
|
+
endpoints: string[];
|
|
35
|
+
}[];
|
|
36
|
+
}[];
|
|
37
|
+
};
|
|
38
|
+
export declare class OpenApiManager {
|
|
39
|
+
private apiDocsHeader;
|
|
40
|
+
private exposedModels;
|
|
41
|
+
private endpoints;
|
|
42
|
+
private preferences;
|
|
43
|
+
private stats;
|
|
44
|
+
private static instance;
|
|
45
|
+
private isInitialized;
|
|
46
|
+
private registeredRouters;
|
|
47
|
+
constructor(apiDocsHeader: ApiDocsHeader, exposedModels: ExposedModelData[], endpoints: EndpointData[], preferences: ApiDocsPreferences, stats: ApiAnalysisStats);
|
|
48
|
+
isReady(): boolean;
|
|
49
|
+
hasExposedModel(name: string): boolean;
|
|
50
|
+
getExposedModels(): ExposedModelData[];
|
|
51
|
+
setExposedModels(models: ExposedModelData[]): this;
|
|
52
|
+
setEndpoints(endpoints: EndpointData[]): this;
|
|
53
|
+
markAsReady(): this;
|
|
54
|
+
getHeader(): ApiDocsHeader;
|
|
55
|
+
setHeader(docs: ApiDocsHeader): this;
|
|
56
|
+
getEndpoints(): EndpointData[];
|
|
57
|
+
getPreferences(): ApiDocsPreferences;
|
|
58
|
+
setPreferences(preferences: ApiDocsPreferences): this;
|
|
59
|
+
getStats(): ApiAnalysisStats;
|
|
60
|
+
setStats(stats: ApiAnalysisStats): this;
|
|
61
|
+
getRouters(): readonly Router[];
|
|
62
|
+
registerRouters(routers: Router<any, any>[]): this;
|
|
63
|
+
reset(): void;
|
|
64
|
+
static getInstance(): OpenApiManager;
|
|
65
|
+
}
|
|
66
|
+
export {};
|
|
67
|
+
//# sourceMappingURL=OpenApiManager.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OpenApiManager.d.ts","sourceRoot":"","sources":["../../../../src/openapi/manager/OpenApiManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEzD,KAAK,OAAO,GAAG,GAAG,MAAM,GAAG,OAAO,MAAM,MAAM,IAAI,MAAM,EAAE,CAAA;AAE1D,MAAM,MAAM,aAAa,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,OAAO,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,GAAG,CAAC,EAAE,OAAO,CAAA;QACb,KAAK,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,OAAO,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,GAAG,CAAC,EAAE,OAAO,CAAA;KACb,CAAA;CACD,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAChC,uBAAuB,EAAE,OAAO,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC9B,mBAAmB,EAAE;QACpB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE;YACR,IAAI,EAAE,MAAM,CAAA;YACZ,SAAS,EAAE,MAAM,EAAE,CAAA;SACnB,EAAE,CAAA;KACH,EAAE,CAAA;IACH,qBAAqB,EAAE;QACtB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE;YACR,IAAI,EAAE,MAAM,CAAA;YACZ,SAAS,EAAE,MAAM,EAAE,CAAA;SACnB,EAAE,CAAA;KACH,EAAE,CAAA;CACH,CAAA;AAED,qBAAa,cAAc;IAOzB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,KAAK;IAVd,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA8B;IAErD,OAAO,CAAC,aAAa,CAAQ;IAC7B,OAAO,CAAC,iBAAiB,CAAe;gBAG/B,aAAa,EAAE,aAAa,EAC5B,aAAa,EAAE,gBAAgB,EAAE,EACjC,SAAS,EAAE,YAAY,EAAE,EACzB,WAAW,EAAE,kBAAkB,EAC/B,KAAK,EAAE,gBAAgB;IAGzB,OAAO,IAAI,OAAO;IAIlB,eAAe,CAAC,IAAI,EAAE,MAAM;IAI5B,gBAAgB;IAIhB,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,EAAE;IAK3C,YAAY,CAAC,SAAS,EAAE,YAAY,EAAE;IAKtC,WAAW;IAKX,SAAS,IAAI,aAAa;IAI1B,SAAS,CAAC,IAAI,EAAE,aAAa;IAK7B,YAAY;IAIZ,cAAc;IAId,cAAc,CAAC,WAAW,EAAE,kBAAkB;IAO9C,QAAQ;IAIR,QAAQ,CAAC,KAAK,EAAE,gBAAgB;IAOhC,UAAU,IAAI,SAAS,MAAM,EAAE;IAI/B,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;IAK3C,KAAK;WAKE,WAAW;CAoBzB"}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OpenApiManager = void 0;
|
|
4
|
+
class OpenApiManager {
|
|
5
|
+
constructor(apiDocsHeader, exposedModels, endpoints, preferences, stats) {
|
|
6
|
+
this.apiDocsHeader = apiDocsHeader;
|
|
7
|
+
this.exposedModels = exposedModels;
|
|
8
|
+
this.endpoints = endpoints;
|
|
9
|
+
this.preferences = preferences;
|
|
10
|
+
this.stats = stats;
|
|
11
|
+
this.isInitialized = false;
|
|
12
|
+
this.registeredRouters = [];
|
|
13
|
+
}
|
|
14
|
+
isReady() {
|
|
15
|
+
return this.isInitialized;
|
|
16
|
+
}
|
|
17
|
+
hasExposedModel(name) {
|
|
18
|
+
return this.exposedModels.some((model) => model.name === name);
|
|
19
|
+
}
|
|
20
|
+
getExposedModels() {
|
|
21
|
+
return this.exposedModels;
|
|
22
|
+
}
|
|
23
|
+
setExposedModels(models) {
|
|
24
|
+
this.exposedModels = models;
|
|
25
|
+
return this;
|
|
26
|
+
}
|
|
27
|
+
setEndpoints(endpoints) {
|
|
28
|
+
this.endpoints = endpoints;
|
|
29
|
+
return this;
|
|
30
|
+
}
|
|
31
|
+
markAsReady() {
|
|
32
|
+
this.isInitialized = true;
|
|
33
|
+
return this;
|
|
34
|
+
}
|
|
35
|
+
getHeader() {
|
|
36
|
+
return this.apiDocsHeader;
|
|
37
|
+
}
|
|
38
|
+
setHeader(docs) {
|
|
39
|
+
this.apiDocsHeader = docs;
|
|
40
|
+
return this;
|
|
41
|
+
}
|
|
42
|
+
getEndpoints() {
|
|
43
|
+
return this.endpoints;
|
|
44
|
+
}
|
|
45
|
+
getPreferences() {
|
|
46
|
+
return this.preferences;
|
|
47
|
+
}
|
|
48
|
+
setPreferences(preferences) {
|
|
49
|
+
this.preferences = Object.assign({}, preferences);
|
|
50
|
+
return this;
|
|
51
|
+
}
|
|
52
|
+
getStats() {
|
|
53
|
+
return this.stats;
|
|
54
|
+
}
|
|
55
|
+
setStats(stats) {
|
|
56
|
+
this.stats = Object.assign({}, stats);
|
|
57
|
+
return this;
|
|
58
|
+
}
|
|
59
|
+
getRouters() {
|
|
60
|
+
return this.registeredRouters;
|
|
61
|
+
}
|
|
62
|
+
registerRouters(routers) {
|
|
63
|
+
routers.forEach((r) => this.registeredRouters.push(r));
|
|
64
|
+
return this;
|
|
65
|
+
}
|
|
66
|
+
reset() {
|
|
67
|
+
this.exposedModels = [];
|
|
68
|
+
this.endpoints = [];
|
|
69
|
+
}
|
|
70
|
+
static getInstance() {
|
|
71
|
+
if (!OpenApiManager.instance) {
|
|
72
|
+
OpenApiManager.instance = new OpenApiManager({
|
|
73
|
+
title: 'Default title',
|
|
74
|
+
version: '1.0.0',
|
|
75
|
+
}, [], [], {
|
|
76
|
+
allowOptionalPathParams: false,
|
|
77
|
+
}, {
|
|
78
|
+
discoveredRouterFiles: [],
|
|
79
|
+
explicitRouterFiles: [],
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
return OpenApiManager.instance;
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
exports.OpenApiManager = OpenApiManager;
|
|
86
|
+
OpenApiManager.instance = null;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OpenApiRouter.d.ts","sourceRoot":"","sources":["../../../../src/openapi/router/OpenApiRouter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAU5C,eAAO,MAAM,aAAa,kEAAS,CAAA"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OpenApiRouter = void 0;
|
|
4
|
+
const Router_1 = require("../../router/Router");
|
|
5
|
+
const generatorModule_1 = require("../generatorModule/generatorModule");
|
|
6
|
+
const OpenApiManager_1 = require("../manager/OpenApiManager");
|
|
7
|
+
const router = new Router_1.Router({ skipOpenApiAnalysis: true });
|
|
8
|
+
router.get('/api-json', () => {
|
|
9
|
+
return (0, generatorModule_1.generateOpenApiSpec)(OpenApiManager_1.OpenApiManager.getInstance());
|
|
10
|
+
});
|
|
11
|
+
exports.OpenApiRouter = router;
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { ShapeOfType } from './analyzerModule/types';
|
|
2
|
+
import { SchemaType } from './generatorModule/getSchema';
|
|
3
|
+
type PathParam = {
|
|
4
|
+
name: string;
|
|
5
|
+
in: 'query' | 'path' | 'header';
|
|
6
|
+
description: string;
|
|
7
|
+
required: true | false | undefined;
|
|
8
|
+
};
|
|
9
|
+
export type PathDefinition = {
|
|
10
|
+
summary?: string;
|
|
11
|
+
description: string;
|
|
12
|
+
operationId?: string;
|
|
13
|
+
parameters: PathParam[];
|
|
14
|
+
requestBody: any;
|
|
15
|
+
tags?: string[];
|
|
16
|
+
responses: Record<string, {
|
|
17
|
+
description: string;
|
|
18
|
+
content?: {
|
|
19
|
+
'application/json': {
|
|
20
|
+
schema: {
|
|
21
|
+
oneOf: SchemaType[];
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
};
|
|
25
|
+
}>;
|
|
26
|
+
};
|
|
27
|
+
export type ExposedModelData = {
|
|
28
|
+
name: string;
|
|
29
|
+
shape: string | ShapeOfType[];
|
|
30
|
+
};
|
|
31
|
+
export type EndpointData = {
|
|
32
|
+
method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
33
|
+
path: string;
|
|
34
|
+
sourceFilePath: string;
|
|
35
|
+
name?: string;
|
|
36
|
+
summary?: string;
|
|
37
|
+
description?: string;
|
|
38
|
+
tags?: string[];
|
|
39
|
+
requestPathParams: {
|
|
40
|
+
identifier: string;
|
|
41
|
+
signature: string | ShapeOfType[];
|
|
42
|
+
optional: boolean;
|
|
43
|
+
description?: string;
|
|
44
|
+
errorMessage?: string;
|
|
45
|
+
}[];
|
|
46
|
+
requestQuery: {
|
|
47
|
+
identifier: string;
|
|
48
|
+
signature: string | ShapeOfType[];
|
|
49
|
+
optional: boolean;
|
|
50
|
+
description?: string;
|
|
51
|
+
errorMessage?: string;
|
|
52
|
+
}[];
|
|
53
|
+
requestHeaders: {
|
|
54
|
+
identifier: string;
|
|
55
|
+
signature: string | ShapeOfType[];
|
|
56
|
+
optional: boolean;
|
|
57
|
+
description?: string;
|
|
58
|
+
errorMessage?: string;
|
|
59
|
+
}[];
|
|
60
|
+
rawBody?: {
|
|
61
|
+
signature: string | ShapeOfType[];
|
|
62
|
+
optional: boolean;
|
|
63
|
+
description?: string;
|
|
64
|
+
errorMessage?: string;
|
|
65
|
+
};
|
|
66
|
+
objectBody: {
|
|
67
|
+
identifier: string;
|
|
68
|
+
signature: string | ShapeOfType[];
|
|
69
|
+
optional: boolean;
|
|
70
|
+
description?: string;
|
|
71
|
+
errorMessage?: string;
|
|
72
|
+
}[];
|
|
73
|
+
responses: {
|
|
74
|
+
status: number;
|
|
75
|
+
signature: string | ShapeOfType[];
|
|
76
|
+
description?: string;
|
|
77
|
+
errorMessage?: string;
|
|
78
|
+
}[];
|
|
79
|
+
};
|
|
80
|
+
export {};
|
|
81
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/openapi/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAA;AAExD,KAAK,SAAS,GAAG;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,IAAI,GAAG,KAAK,GAAG,SAAS,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,WAAW,EAAE,GAAG,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,SAAS,EAAE,MAAM,CAChB,MAAM,EACN;QACC,WAAW,EAAE,MAAM,CAAA;QACnB,OAAO,CAAC,EAAE;YACT,kBAAkB,EAAE;gBACnB,MAAM,EAAE;oBACP,KAAK,EAAE,UAAU,EAAE,CAAA;iBACnB,CAAA;aACD,CAAA;SACD,CAAA;KACD,CACD,CAAA;CACD,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,GAAG,WAAW,EAAE,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IAC1B,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAA;IACnD,IAAI,EAAE,MAAM,CAAA;IACZ,cAAc,EAAE,MAAM,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,iBAAiB,EAAE;QAClB,UAAU,EAAE,MAAM,CAAA;QAClB,SAAS,EAAE,MAAM,GAAG,WAAW,EAAE,CAAA;QACjC,QAAQ,EAAE,OAAO,CAAA;QACjB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,YAAY,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;IACH,YAAY,EAAE;QACb,UAAU,EAAE,MAAM,CAAA;QAClB,SAAS,EAAE,MAAM,GAAG,WAAW,EAAE,CAAA;QACjC,QAAQ,EAAE,OAAO,CAAA;QACjB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,YAAY,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;IACH,cAAc,EAAE;QACf,UAAU,EAAE,MAAM,CAAA;QAClB,SAAS,EAAE,MAAM,GAAG,WAAW,EAAE,CAAA;QACjC,QAAQ,EAAE,OAAO,CAAA;QACjB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,YAAY,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;IACH,OAAO,CAAC,EAAE;QACT,SAAS,EAAE,MAAM,GAAG,WAAW,EAAE,CAAA;QACjC,QAAQ,EAAE,OAAO,CAAA;QACjB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,YAAY,CAAC,EAAE,MAAM,CAAA;KACrB,CAAA;IACD,UAAU,EAAE;QACX,UAAU,EAAE,MAAM,CAAA;QAClB,SAAS,EAAE,MAAM,GAAG,WAAW,EAAE,CAAA;QACjC,QAAQ,EAAE,OAAO,CAAA;QACjB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,YAAY,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;IACH,SAAS,EAAE;QACV,MAAM,EAAE,MAAM,CAAA;QACd,SAAS,EAAE,MAAM,GAAG,WAAW,EAAE,CAAA;QACjC,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,YAAY,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;CACH,CAAA"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/// <reference types="koa__router" />
|
|
2
|
+
import KoaRouter from '@koa/router';
|
|
3
|
+
import Koa from 'koa';
|
|
4
|
+
import { ExtractedRequestParams } from '../utils/TypeUtils';
|
|
5
|
+
type Props = {
|
|
6
|
+
skipOpenApiAnalysis: boolean;
|
|
7
|
+
};
|
|
8
|
+
export declare class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
|
|
9
|
+
koaRouter: KoaRouter;
|
|
10
|
+
constructor(props?: Props);
|
|
11
|
+
use(...middleware: Array<KoaRouter.Middleware<StateT, ContextT>>): this;
|
|
12
|
+
with<ResponseTypeT extends Record<string, any>>(middleware: (ctx: Koa.ParameterizedContext<ContextT>) => ResponseTypeT): Router<StateT, ContextT & (ResponseTypeT extends Promise<any> ? Awaited<ResponseTypeT> : ResponseTypeT)>;
|
|
13
|
+
get<P extends string>(path: P, callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>): this;
|
|
14
|
+
post<P extends string>(path: P, callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>): this;
|
|
15
|
+
put<P extends string>(path: P, callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>): this;
|
|
16
|
+
delete<P extends string>(path: P, callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>): this;
|
|
17
|
+
del<P extends string>(path: P, callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>): this;
|
|
18
|
+
patch<P extends string>(path: P, callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>): this;
|
|
19
|
+
routes(): KoaRouter.Middleware<Koa.DefaultState, Koa.DefaultContext, unknown>;
|
|
20
|
+
allowedMethods(): KoaRouter.Middleware<Koa.DefaultState, Koa.DefaultContext, unknown>;
|
|
21
|
+
}
|
|
22
|
+
export {};
|
|
23
|
+
//# sourceMappingURL=Router.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Router.d.ts","sourceRoot":"","sources":["../../../src/router/Router.ts"],"names":[],"mappings":";AACA,OAAO,SAAS,MAAM,aAAa,CAAA;AACnC,OAAO,GAAG,MAAM,KAAK,CAAA;AAGrB,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAG3D,KAAK,KAAK,GAAG;IACZ,mBAAmB,EAAE,OAAO,CAAA;CAC5B,CAAA;AAED,qBAAa,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,YAAY,EAAE,QAAQ,GAAG,GAAG,CAAC,cAAc;IACpE,SAAS,EAAE,SAAS,CAAkB;gBAE1B,KAAK,GAAE,KAAsC;IAOzD,GAAG,CAAC,GAAG,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAMhE,IAAI,CAAC,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACpD,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,oBAAoB,CAAC,QAAQ,CAAC,KAAK,aAAa;IAchE,GAAG,CAAC,CAAC,SAAS,MAAM,EAC1B,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAUtE,IAAI,CAAC,CAAC,SAAS,MAAM,EAC3B,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAUtE,GAAG,CAAC,CAAC,SAAS,MAAM,EAC1B,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAUtE,MAAM,CAAC,CAAC,SAAS,MAAM,EAC7B,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAUtE,GAAG,CAAC,CAAC,SAAS,MAAM,EAC1B,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAUtE,KAAK,CAAC,CAAC,SAAS,MAAM,EAC5B,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAUtE,MAAM;IAIN,cAAc;CAGrB"}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Router = void 0;
|
|
7
|
+
const router_1 = __importDefault(require("@koa/router"));
|
|
8
|
+
const OpenApiManager_1 = require("../openapi/manager/OpenApiManager");
|
|
9
|
+
const responseValueToJson_1 = require("./responseValueToJson");
|
|
10
|
+
class Router {
|
|
11
|
+
constructor(props = { skipOpenApiAnalysis: false }) {
|
|
12
|
+
this.koaRouter = new router_1.default();
|
|
13
|
+
if (!props.skipOpenApiAnalysis) {
|
|
14
|
+
const openApiManager = OpenApiManager_1.OpenApiManager.getInstance();
|
|
15
|
+
openApiManager.registerRouters([this]);
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
use(...middleware) {
|
|
19
|
+
this.koaRouter.use(...middleware);
|
|
20
|
+
return this;
|
|
21
|
+
}
|
|
22
|
+
with(middleware) {
|
|
23
|
+
this.koaRouter.use(async (ctx, next) => {
|
|
24
|
+
const userData = await Promise.resolve(middleware(ctx));
|
|
25
|
+
Object.keys(userData).forEach((key) => {
|
|
26
|
+
ctx[key] = userData[key];
|
|
27
|
+
});
|
|
28
|
+
await next();
|
|
29
|
+
});
|
|
30
|
+
return this;
|
|
31
|
+
}
|
|
32
|
+
get(path, callback) {
|
|
33
|
+
this.koaRouter.get(path, async (ctx) => {
|
|
34
|
+
const responseValue = await callback(ctx, undefined);
|
|
35
|
+
ctx.body = (0, responseValueToJson_1.responseValueToJson)(responseValue);
|
|
36
|
+
});
|
|
37
|
+
return this;
|
|
38
|
+
}
|
|
39
|
+
post(path, callback) {
|
|
40
|
+
this.koaRouter.post(path, async (ctx) => {
|
|
41
|
+
const responseValue = await callback(ctx, undefined);
|
|
42
|
+
ctx.body = (0, responseValueToJson_1.responseValueToJson)(responseValue);
|
|
43
|
+
});
|
|
44
|
+
return this;
|
|
45
|
+
}
|
|
46
|
+
put(path, callback) {
|
|
47
|
+
this.koaRouter.put(path, async (ctx) => {
|
|
48
|
+
const responseValue = await callback(ctx, undefined);
|
|
49
|
+
ctx.body = (0, responseValueToJson_1.responseValueToJson)(responseValue);
|
|
50
|
+
});
|
|
51
|
+
return this;
|
|
52
|
+
}
|
|
53
|
+
delete(path, callback) {
|
|
54
|
+
this.koaRouter.delete(path, async (ctx) => {
|
|
55
|
+
const responseValue = await callback(ctx, undefined);
|
|
56
|
+
ctx.body = (0, responseValueToJson_1.responseValueToJson)(responseValue);
|
|
57
|
+
});
|
|
58
|
+
return this;
|
|
59
|
+
}
|
|
60
|
+
del(path, callback) {
|
|
61
|
+
this.koaRouter.del(path, async (ctx) => {
|
|
62
|
+
const responseValue = await callback(ctx, undefined);
|
|
63
|
+
ctx.body = (0, responseValueToJson_1.responseValueToJson)(responseValue);
|
|
64
|
+
});
|
|
65
|
+
return this;
|
|
66
|
+
}
|
|
67
|
+
patch(path, callback) {
|
|
68
|
+
this.koaRouter.patch(path, async (ctx) => {
|
|
69
|
+
const responseValue = await callback(ctx, undefined);
|
|
70
|
+
ctx.body = (0, responseValueToJson_1.responseValueToJson)(responseValue);
|
|
71
|
+
});
|
|
72
|
+
return this;
|
|
73
|
+
}
|
|
74
|
+
routes() {
|
|
75
|
+
return this.koaRouter.routes();
|
|
76
|
+
}
|
|
77
|
+
allowedMethods() {
|
|
78
|
+
return this.koaRouter.allowedMethods();
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
exports.Router = Router;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"responseValueToJson.d.ts","sourceRoot":"","sources":["../../../src/router/responseValueToJson.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,UAAW,GAAG,WAK7C,CAAA"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.responseValueToJson = void 0;
|
|
4
|
+
const responseValueToJson = (value) => {
|
|
5
|
+
if (typeof value === 'string') {
|
|
6
|
+
return value;
|
|
7
|
+
}
|
|
8
|
+
return JSON.stringify(value, (_, value) => (typeof value === 'bigint' ? value.toString() : value));
|
|
9
|
+
};
|
|
10
|
+
exports.responseValueToJson = responseValueToJson;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
//# sourceMappingURL=setupTests.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"setupTests.d.ts","sourceRoot":"","sources":["../../src/setupTests.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/// <reference types="koa" />
|
|
2
|
+
import { Router as RenamedRouter } from '../router/Router';
|
|
3
|
+
export declare const TestAppRouter: RenamedRouter<import("koa").DefaultState, import("koa").DefaultContext & {
|
|
4
|
+
user: {
|
|
5
|
+
id: string;
|
|
6
|
+
};
|
|
7
|
+
}>;
|
|
8
|
+
//# sourceMappingURL=TestAppRouter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TestAppRouter.d.ts","sourceRoot":"","sources":["../../../src/test/TestAppRouter.ts"],"names":[],"mappings":";AAOA,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAoE1D,eAAO,MAAM,aAAa;;;;EAAW,CAAA"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.TestAppRouter = void 0;
|
|
4
|
+
const __1 = require("..");
|
|
5
|
+
const Router_1 = require("../router/Router");
|
|
6
|
+
const myRouter = new Router_1.Router()
|
|
7
|
+
.use((_, next) => next())
|
|
8
|
+
.with(() => {
|
|
9
|
+
const user = { id: '123' };
|
|
10
|
+
return {
|
|
11
|
+
user,
|
|
12
|
+
};
|
|
13
|
+
});
|
|
14
|
+
myRouter.get('/test/hello', () => {
|
|
15
|
+
return {
|
|
16
|
+
greeting: 'hello world',
|
|
17
|
+
};
|
|
18
|
+
});
|
|
19
|
+
myRouter.get('/test/query', (ctx) => {
|
|
20
|
+
const { email, string } = (0, __1.useQueryParams)(ctx, {
|
|
21
|
+
email: __1.EmailValidator,
|
|
22
|
+
string: __1.NonEmptyStringValidator,
|
|
23
|
+
});
|
|
24
|
+
return {
|
|
25
|
+
email,
|
|
26
|
+
string,
|
|
27
|
+
};
|
|
28
|
+
});
|
|
29
|
+
myRouter.post('/test/post', () => {
|
|
30
|
+
return 'post response';
|
|
31
|
+
});
|
|
32
|
+
myRouter.del('/test/del', () => {
|
|
33
|
+
});
|
|
34
|
+
myRouter.delete('/test/delete', () => {
|
|
35
|
+
});
|
|
36
|
+
myRouter.patch('/test/patch', () => {
|
|
37
|
+
return 'patch response';
|
|
38
|
+
});
|
|
39
|
+
myRouter.get('/test/error/generic', () => {
|
|
40
|
+
throw new Error('Generic error');
|
|
41
|
+
});
|
|
42
|
+
myRouter.get('/test/error/unauthorized', () => {
|
|
43
|
+
throw new __1.UnauthorizedError('Test error');
|
|
44
|
+
});
|
|
45
|
+
myRouter.get('/test/error/badrequest', () => {
|
|
46
|
+
throw new __1.BadRequestError('Test error');
|
|
47
|
+
});
|
|
48
|
+
myRouter.get('/test/get/bigint', () => {
|
|
49
|
+
return {
|
|
50
|
+
foo: BigInt(100),
|
|
51
|
+
};
|
|
52
|
+
});
|
|
53
|
+
myRouter.get('/test/get/middleware-data', (ctx) => {
|
|
54
|
+
return {
|
|
55
|
+
user: ctx.user,
|
|
56
|
+
};
|
|
57
|
+
});
|
|
58
|
+
exports.TestAppRouter = myRouter;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/test/app.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAOrB,eAAO,MAAM,GAAG,2CAAY,CAAA"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.app = void 0;
|
|
7
|
+
const koa_1 = __importDefault(require("koa"));
|
|
8
|
+
const koa_bodyparser_1 = __importDefault(require("koa-bodyparser"));
|
|
9
|
+
const path_1 = require("path");
|
|
10
|
+
const __1 = require("..");
|
|
11
|
+
const TestAppRouter_1 = require("./TestAppRouter");
|
|
12
|
+
exports.app = new koa_1.default();
|
|
13
|
+
(0, __1.useApiHeader)({
|
|
14
|
+
title: 'Test title',
|
|
15
|
+
version: '1.0.0',
|
|
16
|
+
description: 'Test description',
|
|
17
|
+
termsOfService: 'http://example.com',
|
|
18
|
+
contact: {
|
|
19
|
+
name: 'QA Engineer',
|
|
20
|
+
url: 'http://best-qa.com',
|
|
21
|
+
email: 'admin@best-qa.com',
|
|
22
|
+
},
|
|
23
|
+
license: {
|
|
24
|
+
name: 'MIT',
|
|
25
|
+
url: 'http://best-qa.com/license',
|
|
26
|
+
},
|
|
27
|
+
});
|
|
28
|
+
exports.app
|
|
29
|
+
.use(__1.HttpErrorHandler)
|
|
30
|
+
.use((0, koa_bodyparser_1.default)({
|
|
31
|
+
enableTypes: ['text', 'json', 'form'],
|
|
32
|
+
}))
|
|
33
|
+
.use(TestAppRouter_1.TestAppRouter.routes())
|
|
34
|
+
.use(TestAppRouter_1.TestAppRouter.allowedMethods())
|
|
35
|
+
.use((0, __1.initOpenApiEngine)({
|
|
36
|
+
tsconfigPath: './tsconfig.json',
|
|
37
|
+
sourceFileDiscovery: {
|
|
38
|
+
rootPath: (0, path_1.resolve)(__dirname, '.'),
|
|
39
|
+
},
|
|
40
|
+
sourceFilePaths: ['./src/test/TestAppRouter.ts'],
|
|
41
|
+
}));
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export type RemoveFirstFromTuple<T extends any[]> = T['length'] extends 0 ? undefined : ((...b: T) => void) extends (a: infer Q, ...b: infer I) => void ? I : [];
|
|
2
|
+
export type SplitStringBy<S extends string, D extends string> = string extends S ? string[] : S extends '' ? [] : S extends `${infer T}${D}${infer U}` ? [T, ...SplitStringBy<U, D>] : [S];
|
|
3
|
+
type PickParams<S extends string[], P extends string> = S['length'] extends 0 ? [] : S[0] extends `${P}${string}` ? [
|
|
4
|
+
S[0],
|
|
5
|
+
...PickParams<RemoveFirstFromTuple<S>, P>
|
|
6
|
+
] : PickParams<RemoveFirstFromTuple<S>, P>;
|
|
7
|
+
export type Substring<S extends string[]> = S['length'] extends 0 ? [] : [
|
|
8
|
+
SplitStringBy<S[0], ':'>[1],
|
|
9
|
+
...Substring<RemoveFirstFromTuple<S>>
|
|
10
|
+
];
|
|
11
|
+
export type ExtractedRequestParams<S extends string> = {
|
|
12
|
+
parsedPathParams: PickParams<SplitStringBy<S, '/'>, ':'>;
|
|
13
|
+
};
|
|
14
|
+
export type CamelCase<S extends string> = S extends `${infer P1}_${infer P2}${infer P3}` ? `${Lowercase<P1>}${Uppercase<P2>}${CamelCase<P3>}` : S extends `${infer P1}-${infer P2}${infer P3}` ? `${Lowercase<P1>}${Uppercase<P2>}${CamelCase<P3>}` : S;
|
|
15
|
+
export type KeysToCamelCase<T> = {
|
|
16
|
+
[K in keyof T as CamelCase<string & K>]: T[K] extends Record<any, any> ? KeysToCamelCase<T[K]> : T[K];
|
|
17
|
+
};
|
|
18
|
+
type RemoveLeadingColon<S extends string> = S['length'] extends 0 ? never : SplitStringBy<S, ':'>[1];
|
|
19
|
+
type RemoveTrailingQuestion<S extends string> = S['length'] extends 0 ? never : SplitStringBy<S, '?'>[0];
|
|
20
|
+
export type CleanUpPathParam<S> = S extends string ? RemoveLeadingColon<RemoveTrailingQuestion<S>> extends string ? RemoveLeadingColon<RemoveTrailingQuestion<S>> : '' : never;
|
|
21
|
+
export {};
|
|
22
|
+
//# sourceMappingURL=TypeUtils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TypeUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/TypeUtils.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GACtE,SAAS,GACT,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GAC/D,CAAC,GACD,EAAE,CAAA;AAEL,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI,MAAM,SAAS,CAAC,GAC7E,MAAM,EAAE,GACR,CAAC,SAAS,EAAE,GACZ,EAAE,GACF,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,EAAE,GACpC,CAAC,CAAC,EAAE,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC3B,CAAC,CAAC,CAAC,CAAA;AAEN,KAAK,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,EAAE,CAAC,SAAS,MAAM,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAC1E,EAAE,GACF,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG,MAAM,EAAE,GAE5B;IAAC,CAAC,CAAC,CAAC,CAAC;IAAE,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;CAAC,GAEjD,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAEzC,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAC9D,EAAE,GAEF;IAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAAE,GAAG,SAAS,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;CAAC,CAAA;AAEvE,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,IAAI;IACtD,gBAAgB,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;CACxD,CAAA;AAED,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,EAAE,IAAI,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,GACrF,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,EAAE,GAClD,CAAC,SAAS,GAAG,MAAM,EAAE,IAAI,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,GAC9C,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,EAAE,GAClD,CAAC,CAAA;AAEJ,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI;KAC/B,CAAC,IAAI,MAAM,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrG,CAAA;AAED,KAAK,kBAAkB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,aAAa,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;AACpG,KAAK,sBAAsB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,aAAa,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;AACxG,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAE/C,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAE3D,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAC7C,EAAE,GACH,KAAK,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fromZodSchema.d.ts","sourceRoot":"","sources":["../../../src/utils/fromZodSchema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,YAEzB,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"loadTestData.d.ts","sourceRoot":"","sources":["../../../src/utils/loadTestData.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,YAAY,aAAc,MAAM,kCAW5C,CAAA"}
|