vls-openapi-generator 1.4.0 → 1.6.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.
Files changed (7) hide show
  1. package/dist/generate-openapi.js +5 -1
  2. package/dist/lambda-type.d.ts +9 -0
  3. package/dist/openapi-type.d.ts +20 -22
  4. package/package.json +1 -1
  5. package/src/generate-openapi.ts +10 -2
  6. package/src/lambda-type.ts +10 -0
  7. package/src/openapi-type.ts +33 -30
package/dist/generate-openapi.js CHANGED
@@ -60,7 +60,11 @@ const generateOpenAPI = async () => {
60
60
  existingOpenAPIFile.paths = {};
61
61
  for (const handler of handlerFiles) {
62
62
  const fileName = path.parse(handler).name;
63
+ if (fileName.match(/^([a-z]+-)+queue-(publisher|consumer)$/)) {
64
+ continue;
65
+ }
63
66
  const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema, OPENAPI_CONFIG: openAPIConfig } = (await Promise.resolve(`${path.join(SCHEMAS_DIR, fileName + '.js')}`).then(s => __importStar(require(s))).catch(() => ({})));
67
+ const { LAMBDA_CONFIG } = (await Promise.resolve(`${path.join(HANDLERS_DIR, `${fileName}.js`)}`).then(s => __importStar(require(s))));
64
68
  const bodyComponent = (0, zod_openapi_1.generateSchema)(bodySchema ?? zod_1.z.never(), undefined, '3.0');
65
69
  const queryParametersComponent = (0, zod_openapi_1.generateSchema)(queryParametersSchema ?? zod_1.z.never(), undefined, '3.0');
66
70
  const eventResponseComponent = (0, zod_openapi_1.generateSchema)(zod_1.z.object({
@@ -91,7 +95,7 @@ const generateOpenAPI = async () => {
91
95
  }
92
96
  }
93
97
  existingOpenAPIFile.paths['/' + fileName] = {
94
- post: {
98
+ [LAMBDA_CONFIG?.method?.toLowerCase() ?? 'post']: {
95
99
  tags: openAPIConfig.tags,
96
100
  parameters: queryParametersSchema ? queryParameters : undefined,
97
101
  requestBody: bodySchema
package/dist/lambda-type.d.ts CHANGED
@@ -1,3 +1,12 @@
1
1
  export type OpenAPIConfig = {
2
2
  tags: string[];
3
3
  };
4
+ export type LambdaConfig = {
5
+ cron?: {
6
+ schedule: string;
7
+ input?: Record<string, unknown>;
8
+ };
9
+ timeout?: number;
10
+ memorySize?: number;
11
+ method?: 'GET' | 'POST';
12
+ };
package/dist/openapi-type.d.ts CHANGED
@@ -12,32 +12,30 @@ export type OpenAPI = {
12
12
  }, {
13
13
  url: string;
14
14
  }];
15
- paths: Record<string, {
16
- post: {
17
- parameters: {
18
- name: string;
19
- in: 'query';
20
- schema: ReturnType<typeof generateSchema>;
21
- }[] | undefined;
22
- requestBody: {
23
- required: true;
15
+ paths: Record<string, Partial<Record<'get' | 'post', {
16
+ parameters: {
17
+ name: string;
18
+ in: 'query';
19
+ schema: ReturnType<typeof generateSchema>;
20
+ }[] | undefined;
21
+ requestBody: {
22
+ required: true;
23
+ content: {
24
+ 'application/json': {
25
+ schema: ReturnType<typeof generateSchema>;
26
+ };
27
+ };
28
+ } | undefined;
29
+ responses: {
30
+ 200: {
31
+ description: string;
24
32
  content: {
25
33
  'application/json': {
26
34
  schema: ReturnType<typeof generateSchema>;
27
35
  };
28
- };
29
- } | undefined;
30
- responses: {
31
- 200: {
32
- description: string;
33
- content: {
34
- 'application/json': {
35
- schema: ReturnType<typeof generateSchema>;
36
- };
37
- } | undefined;
38
- };
36
+ } | undefined;
39
37
  };
40
- tags: string[];
41
38
  };
42
- }>;
39
+ tags: string[];
40
+ }>>>;
43
41
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vls-openapi-generator",
3
- "version": "1.4.0",
3
+ "version": "1.6.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "scripts": {
package/src/generate-openapi.ts CHANGED
@@ -5,7 +5,7 @@ import 'module-alias/register.js';
5
5
  import * as path from 'path';
6
6
  import { promisify } from 'util';
7
7
  import { z } from 'zod';
8
- import { OpenAPIConfig } from './lambda-type';
8
+ import { LambdaConfig, OpenAPIConfig } from './lambda-type';
9
9
  import { OpenAPI } from './openapi-type';
10
10
 
11
11
  const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
@@ -35,6 +35,10 @@ export const generateOpenAPI = async (): Promise<void> => {
35
35
  for (const handler of handlerFiles) {
36
36
  const fileName = path.parse(handler).name;
37
37
 
38
+ if (fileName.match(/^([a-z]+-)+queue-(publisher|consumer)$/)) {
39
+ continue;
40
+ }
41
+
38
42
  const {
39
43
  bodySchema,
40
44
  queryParametersSchema,
@@ -49,6 +53,10 @@ export const generateOpenAPI = async (): Promise<void> => {
49
53
  OPENAPI_CONFIG: OpenAPIConfig;
50
54
  };
51
55
 
56
+ const { LAMBDA_CONFIG } = (await import(path.join(HANDLERS_DIR, `${fileName}.js`))) as {
57
+ LAMBDA_CONFIG?: LambdaConfig;
58
+ };
59
+
52
60
  const bodyComponent = generateSchema(bodySchema ?? z.never(), undefined, '3.0');
53
61
  const queryParametersComponent = generateSchema(queryParametersSchema ?? z.never(), undefined, '3.0');
54
62
  const eventResponseComponent = generateSchema(
@@ -88,7 +96,7 @@ export const generateOpenAPI = async (): Promise<void> => {
88
96
  }
89
97
 
90
98
  existingOpenAPIFile.paths['/' + fileName] = {
91
- post: {
99
+ [LAMBDA_CONFIG?.method?.toLowerCase() ?? 'post']: {
92
100
  tags: openAPIConfig.tags,
93
101
  parameters: queryParametersSchema ? queryParameters : undefined,
94
102
  requestBody: bodySchema
package/src/lambda-type.ts CHANGED
@@ -1,3 +1,13 @@
1
1
  export type OpenAPIConfig = {
2
2
  tags: string[];
3
3
  };
4
+
5
+ export type LambdaConfig = {
6
+ cron?: {
7
+ schedule: string;
8
+ input?: Record<string, unknown>;
9
+ };
10
+ timeout?: number;
11
+ memorySize?: number;
12
+ method?: 'GET' | 'POST';
13
+ };
package/src/openapi-type.ts CHANGED
@@ -6,39 +6,42 @@ export type OpenAPI = {
6
6
  servers: [{ url: string }, { url: string }, { url: string }];
7
7
  paths: Record<
8
8
  string,
9
- {
10
- post: {
11
- parameters:
12
- | {
13
- name: string;
14
- in: 'query';
15
- schema: ReturnType<typeof generateSchema>;
16
- }[]
17
- | undefined;
18
- requestBody:
19
- | {
20
- required: true;
21
- content: {
22
- 'application/json': {
23
- schema: ReturnType<typeof generateSchema>;
24
- };
25
- };
26
- }
27
- | undefined;
28
- responses: {
29
- 200: {
30
- description: string;
31
- content:
32
- | {
9
+ Partial<
10
+ Record<
11
+ 'get' | 'post',
12
+ {
13
+ parameters:
14
+ | {
15
+ name: string;
16
+ in: 'query';
17
+ schema: ReturnType<typeof generateSchema>;
18
+ }[]
19
+ | undefined;
20
+ requestBody:
21
+ | {
22
+ required: true;
23
+ content: {
33
24
  'application/json': {
34
25
  schema: ReturnType<typeof generateSchema>;
35
26
  };
36
- }
37
- | undefined;
27
+ };
28
+ }
29
+ | undefined;
30
+ responses: {
31
+ 200: {
32
+ description: string;
33
+ content:
34
+ | {
35
+ 'application/json': {
36
+ schema: ReturnType<typeof generateSchema>;
37
+ };
38
+ }
39
+ | undefined;
40
+ };
38
41
  };
39
- };
40
- tags: string[];
41
- };
42
- }
42
+ tags: string[];
43
+ }
44
+ >
45
+ >
43
46
  >;
44
47
  };