vls-openapi-generator 1.3.1 → 1.3.2
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/dist/generate-openapi.js +57 -20
- package/dist/index.js +34 -16
- package/dist/lambda-type.js +2 -1
- package/dist/openapi-type.js +2 -1
- package/dist/postman-service.js +10 -3
- package/dist/upload-openapi.js +44 -7
- package/package.json +1 -1
- package/src/index.ts +19 -17
- package/tsconfig.json +2 -2
package/dist/generate-openapi.js
CHANGED
|
@@ -1,15 +1,51 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
35
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
+
exports.generateOpenAPI = void 0;
|
|
37
|
+
const zod_openapi_1 = require("@anatine/zod-openapi");
|
|
38
|
+
const child_process_1 = require("child_process");
|
|
39
|
+
const fs_1 = require("fs");
|
|
40
|
+
require("module-alias/register.js");
|
|
41
|
+
const path = __importStar(require("path"));
|
|
42
|
+
const util_1 = require("util");
|
|
43
|
+
const zod_1 = require("zod");
|
|
8
44
|
const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
|
|
9
45
|
const HANDLERS_DIR = path.join(process.cwd(), 'dist', 'src', 'handlers');
|
|
10
46
|
const SCHEMAS_DIR = path.join(process.cwd(), 'dist', 'src', 'schemas');
|
|
11
47
|
const OUTPUT_FILE = path.join(process.cwd(), 'openapi.json');
|
|
12
|
-
|
|
48
|
+
const generateOpenAPI = async () => {
|
|
13
49
|
const args = process.argv;
|
|
14
50
|
const params = {};
|
|
15
51
|
for (let i = 2; i < args.length; i += 2) {
|
|
@@ -17,27 +53,27 @@ export const generateOpenAPI = async () => {
|
|
|
17
53
|
params[key] = args[i + 1];
|
|
18
54
|
}
|
|
19
55
|
console.info('Generating Open API documentation...');
|
|
20
|
-
await promisify(exec)('rm -rf ./dist');
|
|
21
|
-
await promisify(exec)('npx tsc');
|
|
22
|
-
const handlerFiles = await
|
|
23
|
-
const existingOpenAPIFile = JSON.parse(await
|
|
56
|
+
await (0, util_1.promisify)(child_process_1.exec)('rm -rf ./dist');
|
|
57
|
+
await (0, util_1.promisify)(child_process_1.exec)('npx tsc');
|
|
58
|
+
const handlerFiles = await fs_1.promises.readdir(HANDLERS_DIR);
|
|
59
|
+
const existingOpenAPIFile = JSON.parse(await fs_1.promises.readFile(OPENAPI_FILE, 'utf-8'));
|
|
24
60
|
for (const handler of handlerFiles) {
|
|
25
61
|
const fileName = path.parse(handler).name;
|
|
26
|
-
const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema, OPENAPI_CONFIG: openAPIConfig } = (await
|
|
27
|
-
const bodyComponent = generateSchema(bodySchema ?? z.never(), undefined, '3.0');
|
|
28
|
-
const queryParametersComponent = generateSchema(queryParametersSchema ?? z.never(), undefined, '3.0');
|
|
29
|
-
const eventResponseComponent = generateSchema(z.object({
|
|
62
|
+
const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema, OPENAPI_CONFIG: openAPIConfig } = (await Promise.resolve(`${path.join(SCHEMAS_DIR, fileName + '.js')}`).then(s => __importStar(require(s))).catch(() => ({})));
|
|
63
|
+
const bodyComponent = (0, zod_openapi_1.generateSchema)(bodySchema ?? zod_1.z.never(), undefined, '3.0');
|
|
64
|
+
const queryParametersComponent = (0, zod_openapi_1.generateSchema)(queryParametersSchema ?? zod_1.z.never(), undefined, '3.0');
|
|
65
|
+
const eventResponseComponent = (0, zod_openapi_1.generateSchema)(zod_1.z.object({
|
|
30
66
|
...(eventResponseParametersSchema
|
|
31
67
|
? { params: eventResponseParametersSchema }
|
|
32
|
-
: { params: z.object({}) }),
|
|
68
|
+
: { params: zod_1.z.object({}) }),
|
|
33
69
|
...(eventResponseModulesSchema
|
|
34
70
|
? { modules: eventResponseModulesSchema }
|
|
35
71
|
: {
|
|
36
|
-
modules: extendApi(z.array(z.unknown()), {
|
|
72
|
+
modules: (0, zod_openapi_1.extendApi)(zod_1.z.array(zod_1.z.unknown()), {
|
|
37
73
|
example: []
|
|
38
74
|
})
|
|
39
75
|
}),
|
|
40
|
-
fallback: z.boolean().default(false)
|
|
76
|
+
fallback: zod_1.z.boolean().default(false)
|
|
41
77
|
}), undefined, '3.0');
|
|
42
78
|
const queryParameters = [];
|
|
43
79
|
if (queryParametersSchema) {
|
|
@@ -80,5 +116,6 @@ export const generateOpenAPI = async () => {
|
|
|
80
116
|
}
|
|
81
117
|
};
|
|
82
118
|
}
|
|
83
|
-
await
|
|
119
|
+
await fs_1.promises.writeFile(OUTPUT_FILE, JSON.stringify(existingOpenAPIFile, undefined, 4));
|
|
84
120
|
};
|
|
121
|
+
exports.generateOpenAPI = generateOpenAPI;
|
package/dist/index.js
CHANGED
|
@@ -1,23 +1,41 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
}
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
2
|
+
"use strict";
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
15
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
|
+
};
|
|
17
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
const generate_openapi_1 = require("./generate-openapi");
|
|
19
|
+
const upload_openapi_js_1 = require("./upload-openapi.js");
|
|
20
|
+
__exportStar(require("./lambda-type"), exports);
|
|
21
|
+
(async () => {
|
|
15
22
|
try {
|
|
16
|
-
await
|
|
17
|
-
console.info('Open API documentation
|
|
23
|
+
await (0, generate_openapi_1.generateOpenAPI)();
|
|
24
|
+
console.info('Open API documentation generated successfully');
|
|
18
25
|
}
|
|
19
26
|
catch (error) {
|
|
20
27
|
console.error(error);
|
|
21
28
|
process.exit(1);
|
|
22
29
|
}
|
|
23
|
-
|
|
30
|
+
if (process.argv.includes('--upload')) {
|
|
31
|
+
console.info('Uploading Open API documentation to Postman...');
|
|
32
|
+
try {
|
|
33
|
+
await (0, upload_openapi_js_1.uploadOpenAPI)();
|
|
34
|
+
console.info('Open API documentation uploaded successfully');
|
|
35
|
+
}
|
|
36
|
+
catch (error) {
|
|
37
|
+
console.error(error);
|
|
38
|
+
process.exit(1);
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
})().catch(console.error);
|
package/dist/lambda-type.js
CHANGED
|
@@ -1 +1,2 @@
|
|
|
1
|
-
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/dist/openapi-type.js
CHANGED
|
@@ -1 +1,2 @@
|
|
|
1
|
-
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/dist/postman-service.js
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
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.PostmanService = void 0;
|
|
7
|
+
const axios_1 = __importDefault(require("axios"));
|
|
8
|
+
class PostmanService {
|
|
3
9
|
constructor(apiKey) {
|
|
4
10
|
this.getCollections = async () => {
|
|
5
11
|
return (await this.client.get('/collections')).data;
|
|
@@ -13,7 +19,7 @@ export class PostmanService {
|
|
|
13
19
|
input: payload
|
|
14
20
|
});
|
|
15
21
|
};
|
|
16
|
-
this.client =
|
|
22
|
+
this.client = axios_1.default.create({
|
|
17
23
|
baseURL: 'https://api.getpostman.com',
|
|
18
24
|
headers: {
|
|
19
25
|
'Content-Type': 'application/json',
|
|
@@ -22,3 +28,4 @@ export class PostmanService {
|
|
|
22
28
|
});
|
|
23
29
|
}
|
|
24
30
|
}
|
|
31
|
+
exports.PostmanService = PostmanService;
|
package/dist/upload-openapi.js
CHANGED
|
@@ -1,9 +1,45 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
35
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
+
exports.uploadOpenAPI = void 0;
|
|
37
|
+
const fs_1 = require("fs");
|
|
38
|
+
require("module-alias/register.js");
|
|
39
|
+
const path = __importStar(require("path"));
|
|
40
|
+
const postman_service_1 = require("./postman-service");
|
|
5
41
|
const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
|
|
6
|
-
|
|
42
|
+
const uploadOpenAPI = async () => {
|
|
7
43
|
const args = process.argv;
|
|
8
44
|
const params = {};
|
|
9
45
|
for (let i = 2; i < args.length; i += 2) {
|
|
@@ -18,11 +54,12 @@ export const uploadOpenAPI = async () => {
|
|
|
18
54
|
if (!params['stack-name']) {
|
|
19
55
|
throw new Error('Stack name is missing.');
|
|
20
56
|
}
|
|
21
|
-
const postmanService = new PostmanService(postmanToken);
|
|
57
|
+
const postmanService = new postman_service_1.PostmanService(postmanToken);
|
|
22
58
|
const stackCollection = (await postmanService.getCollections()).collections.find((x) => x.name === stackName);
|
|
23
59
|
if (stackCollection) {
|
|
24
60
|
await postmanService.deleteCollection(stackCollection.id);
|
|
25
61
|
}
|
|
26
|
-
const existingOpenAPIFile = JSON.parse(await
|
|
62
|
+
const existingOpenAPIFile = JSON.parse(await fs_1.promises.readFile(OPENAPI_FILE, 'utf-8'));
|
|
27
63
|
await postmanService.createCollection(existingOpenAPIFile);
|
|
28
64
|
};
|
|
65
|
+
exports.uploadOpenAPI = uploadOpenAPI;
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -1,30 +1,32 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
3
|
import { generateOpenAPI } from './generate-openapi';
|
|
4
|
-
import { uploadOpenAPI } from './upload-openapi';
|
|
4
|
+
import { uploadOpenAPI } from './upload-openapi.js';
|
|
5
5
|
|
|
6
6
|
export * from './lambda-type';
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
await generateOpenAPI();
|
|
10
|
-
|
|
11
|
-
console.info('Open API documentation generated successfully');
|
|
12
|
-
} catch (error) {
|
|
13
|
-
console.error(error);
|
|
14
|
-
|
|
15
|
-
process.exit(1);
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
if (process.argv.includes('--upload')) {
|
|
19
|
-
console.info('Uploading Open API documentation to Postman...');
|
|
20
|
-
|
|
8
|
+
(async () => {
|
|
21
9
|
try {
|
|
22
|
-
await
|
|
10
|
+
await generateOpenAPI();
|
|
23
11
|
|
|
24
|
-
console.info('Open API documentation
|
|
12
|
+
console.info('Open API documentation generated successfully');
|
|
25
13
|
} catch (error) {
|
|
26
14
|
console.error(error);
|
|
27
15
|
|
|
28
16
|
process.exit(1);
|
|
29
17
|
}
|
|
30
|
-
|
|
18
|
+
|
|
19
|
+
if (process.argv.includes('--upload')) {
|
|
20
|
+
console.info('Uploading Open API documentation to Postman...');
|
|
21
|
+
|
|
22
|
+
try {
|
|
23
|
+
await uploadOpenAPI();
|
|
24
|
+
|
|
25
|
+
console.info('Open API documentation uploaded successfully');
|
|
26
|
+
} catch (error) {
|
|
27
|
+
console.error(error);
|
|
28
|
+
|
|
29
|
+
process.exit(1);
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
})().catch(console.error);
|
package/tsconfig.json
CHANGED
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
|
|
26
26
|
|
|
27
27
|
/* Modules */
|
|
28
|
-
"module": "
|
|
28
|
+
"module": "CommonJS" /* Specify what module code is generated. */,
|
|
29
29
|
"rootDir": "src" /* Specify the root folder within your source files. */,
|
|
30
|
-
"moduleResolution": "node10" /* Specify how TypeScript looks up a file from a given module specifier. */,
|
|
30
|
+
// "moduleResolution": "node10" /* Specify how TypeScript looks up a file from a given module specifier. */,
|
|
31
31
|
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
|
|
32
32
|
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
|
|
33
33
|
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
|