@trayio/tray-openapi 5.35.0-unstable.fd7158a → 6.0.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/dist/OpenApiCodecs.d.ts +4 -207
- package/dist/OpenApiCodecs.d.ts.map +1 -1
- package/dist/OpenApiCodecs.js +3 -3
- package/dist/OpenApiSchemaImporter.d.ts +2 -2
- package/dist/OpenApiSchemaImporter.d.ts.map +1 -1
- package/dist/OpenApiSchemaImporter.js +55 -33
- package/dist/OpenApiSchemaImporter.unit.test.js +13 -24
- package/dist/OpenApiSchemaTransformer.d.ts +2 -2
- package/dist/OpenApiSchemaTransformer.d.ts.map +1 -1
- package/dist/OpenApiSchemaTransformer.js +25 -2
- package/dist/OpenApiSchemaTransformer.unit.test.js +44 -30
- package/dist/OpenApiTypeDescriptors.d.ts +32 -389
- package/dist/OpenApiTypeDescriptors.d.ts.map +1 -1
- package/dist/OpenApiTypeDescriptors.js +109 -80
- package/dist/file-generators/GenerateHandler.d.ts +2 -2
- package/dist/file-generators/GenerateHandler.d.ts.map +1 -1
- package/dist/file-generators/GenerateHandler.js +78 -75
- package/dist/file-generators/GenerateHandler.unit.test.js +97 -73
- package/dist/file-generators/GenerateHandlerTest.d.ts +2 -2
- package/dist/file-generators/GenerateHandlerTest.d.ts.map +1 -1
- package/dist/file-generators/GenerateHandlerTest.js +76 -69
- package/dist/file-generators/GenerateHandlerTest.unit.test.js +230 -206
- package/dist/file-generators/GenerateOperationJson.d.ts +2 -2
- package/dist/file-generators/GenerateOperationJson.d.ts.map +1 -1
- package/dist/file-generators/GenerateOperationJson.js +29 -4
- package/dist/file-generators/GenerateOperationJson.unit.test.js +49 -25
- package/dist/file-generators/SchemaGenerator.d.ts.map +1 -1
- package/dist/file-generators/SchemaGenerator.js +37 -14
- package/dist/file-generators/types/GenerateInputSchema.d.ts +2 -2
- package/dist/file-generators/types/GenerateInputSchema.d.ts.map +1 -1
- package/dist/file-generators/types/GenerateInputSchema.js +95 -88
- package/dist/file-generators/types/GenerateInputSchema.test.js +91 -60
- package/dist/file-generators/types/GenerateInputType.test.js +169 -143
- package/dist/file-generators/types/GenerateInputTypes.d.ts +2 -2
- package/dist/file-generators/types/GenerateInputTypes.d.ts.map +1 -1
- package/dist/file-generators/types/GenerateInputTypes.js +28 -7
- package/dist/file-generators/types/GenerateOutput.d.ts +6 -4
- package/dist/file-generators/types/GenerateOutput.d.ts.map +1 -1
- package/dist/file-generators/types/GenerateOutput.js +57 -46
- package/dist/file-generators/types/GenerateOutput.test.js +62 -35
- package/package.json +8 -6
|
@@ -1,73 +1,84 @@
|
|
|
1
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 (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
2
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
26
|
exports.generateOutputTypes = exports.generateOutputSchema = exports.getApplicationJsonMediaType = void 0;
|
|
4
|
-
const effect_1 = require("effect");
|
|
5
27
|
const json_schema_to_typescript_1 = require("json-schema-to-typescript");
|
|
28
|
+
const TE = __importStar(require("fp-ts/TaskEither"));
|
|
29
|
+
const E = __importStar(require("fp-ts/Either"));
|
|
30
|
+
const O = __importStar(require("fp-ts/Option"));
|
|
31
|
+
const function_1 = require("fp-ts/function");
|
|
6
32
|
const CompositeCodec_1 = require("@trayio/commons/codec/CompositeCodec");
|
|
7
33
|
const RemoveNullValuesCodec_1 = require("@trayio/commons/codec/RemoveNullValuesCodec");
|
|
8
34
|
const JsonSchemaToTypescriptOptions_1 = require("./JsonSchemaToTypescriptOptions");
|
|
9
35
|
const OpenApiTypeDescriptors_1 = require("../../OpenApiTypeDescriptors");
|
|
10
|
-
const get2XXResponse = (responses) =>
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
return effect_1.Effect.fail(new Error(`Unsupported success response code: ${responseCodes}`));
|
|
19
|
-
},
|
|
20
|
-
});
|
|
36
|
+
const get2XXResponse = (responses) => O.fold(() => TE.left(new Error('No responses found')), (someResponses) => {
|
|
37
|
+
const statusCode2XX = Object.keys(someResponses).find((statusCode) => /^2\d{2}$/.test(statusCode));
|
|
38
|
+
if (statusCode2XX) {
|
|
39
|
+
return TE.right(someResponses[statusCode2XX]);
|
|
40
|
+
}
|
|
41
|
+
const responseCodes = Object.keys(someResponses);
|
|
42
|
+
return TE.left(new Error(`Unsupported success response code: ${responseCodes}`));
|
|
43
|
+
})(responses);
|
|
21
44
|
const blankOutputSchema = () => ({
|
|
22
|
-
title:
|
|
23
|
-
type:
|
|
24
|
-
properties:
|
|
25
|
-
required:
|
|
26
|
-
additionalProperties:
|
|
27
|
-
allOf:
|
|
28
|
-
anyOf:
|
|
29
|
-
oneOf:
|
|
30
|
-
not:
|
|
31
|
-
in:
|
|
32
|
-
default:
|
|
33
|
-
nullable:
|
|
34
|
-
enum:
|
|
35
|
-
});
|
|
36
|
-
const getContent = (response) => effect_1.Option.match(response.content, {
|
|
37
|
-
onNone: () => ({
|
|
38
|
-
'application/json': { schema: effect_1.Option.some(blankOutputSchema()) },
|
|
39
|
-
}),
|
|
40
|
-
onSome: (content) => content,
|
|
45
|
+
title: O.none,
|
|
46
|
+
type: O.none,
|
|
47
|
+
properties: O.none,
|
|
48
|
+
required: O.none,
|
|
49
|
+
additionalProperties: O.some(false),
|
|
50
|
+
allOf: O.none,
|
|
51
|
+
anyOf: O.none,
|
|
52
|
+
oneOf: O.none,
|
|
53
|
+
not: O.none,
|
|
54
|
+
in: O.none,
|
|
55
|
+
default: O.none,
|
|
56
|
+
nullable: O.none,
|
|
57
|
+
enum: O.none,
|
|
41
58
|
});
|
|
59
|
+
const getContent = (response) => O.fold(() => ({ 'application/json': { schema: O.some(blankOutputSchema()) } }), (content) => content)(response.content);
|
|
42
60
|
const getApplicationJsonMediaType = (content) => {
|
|
43
|
-
if (!Object.keys(content).length)
|
|
44
|
-
return
|
|
45
|
-
}
|
|
61
|
+
if (!Object.keys(content).length)
|
|
62
|
+
return E.right({ schema: O.none });
|
|
46
63
|
const mediaTypeApplicationJson = Object.keys(content).find((mediaType) => /^application\/.*json.*$/.test(mediaType));
|
|
47
64
|
if (mediaTypeApplicationJson) {
|
|
48
|
-
return
|
|
65
|
+
return E.right(content[mediaTypeApplicationJson]);
|
|
49
66
|
}
|
|
50
67
|
const mediaTypes = Object.keys(content);
|
|
51
|
-
return
|
|
68
|
+
return E.left(new Error(`Unsupported media type: ${mediaTypes}`));
|
|
52
69
|
};
|
|
53
70
|
exports.getApplicationJsonMediaType = getApplicationJsonMediaType;
|
|
54
|
-
const generateOutputSchema = (responses) => (0,
|
|
55
|
-
onNone: () => blankOutputSchema(),
|
|
56
|
-
onSome: (schema) => schema,
|
|
57
|
-
})), effect_1.Effect.mapError((error) => new Error(`Failed to generate output schema: ${error}`)));
|
|
71
|
+
const generateOutputSchema = (responses) => (0, function_1.pipe)(get2XXResponse(responses), TE.chain((successResponse) => TE.fromEither((0, exports.getApplicationJsonMediaType)(getContent(successResponse)))), TE.map((mediaType) => O.fold(() => blankOutputSchema(), (schema) => schema)(mediaType.schema)), TE.mapLeft((error) => new Error(`Failed to generate output schema: ${error}`)));
|
|
58
72
|
exports.generateOutputSchema = generateOutputSchema;
|
|
59
73
|
const encodeOutputSchema = (outputSchema) => {
|
|
60
74
|
const codecWithNullValueRemoval = CompositeCodec_1.CompositeCodec.fromCodecs(OpenApiTypeDescriptors_1.schemaObjectTypeCodec, RemoveNullValuesCodec_1.RemoveNullValuesCodec.instance);
|
|
61
75
|
return codecWithNullValueRemoval.encode(outputSchema);
|
|
62
76
|
};
|
|
63
77
|
const generateOutputTypes = (operationNameCamelCase, outputSchema) => {
|
|
64
|
-
if (
|
|
65
|
-
outputSchema.title =
|
|
78
|
+
if (O.isSome(outputSchema.title)) {
|
|
79
|
+
outputSchema.title = O.none;
|
|
66
80
|
}
|
|
67
81
|
const resolvedOutputSchema = encodeOutputSchema(outputSchema);
|
|
68
|
-
return
|
|
69
|
-
try: () => (0, json_schema_to_typescript_1.compile)(resolvedOutputSchema, `${operationNameCamelCase}Output`, JsonSchemaToTypescriptOptions_1.JsonSchemaToTypescriptOptions),
|
|
70
|
-
catch: (error) => new Error(`Failed to generate output types: ${error}`),
|
|
71
|
-
});
|
|
82
|
+
return TE.tryCatch(() => (0, json_schema_to_typescript_1.compile)(resolvedOutputSchema, `${operationNameCamelCase}Output`, JsonSchemaToTypescriptOptions_1.JsonSchemaToTypescriptOptions), (error) => new Error(`Failed to generate output types: ${error}`));
|
|
72
83
|
};
|
|
73
84
|
exports.generateOutputTypes = generateOutputTypes;
|
|
@@ -1,47 +1,74 @@
|
|
|
1
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 (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
2
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const
|
|
26
|
+
const TE = __importStar(require("fp-ts/TaskEither"));
|
|
27
|
+
const E = __importStar(require("fp-ts/Either"));
|
|
28
|
+
const O = __importStar(require("fp-ts/Option"));
|
|
4
29
|
const GenerateOutput_1 = require("./GenerateOutput");
|
|
5
30
|
const SchemaGenerator_1 = require("../SchemaGenerator");
|
|
6
31
|
const generateOutputFileContents = async (responses) => {
|
|
7
32
|
const operationNameCamelCase = 'CreatePost';
|
|
8
|
-
const generatedOutputSchema = await
|
|
9
|
-
if (
|
|
33
|
+
const generatedOutputSchema = await (0, GenerateOutput_1.generateOutputSchema)(responses)();
|
|
34
|
+
if (E.isLeft(generatedOutputSchema)) {
|
|
10
35
|
throw new Error('Should have been right');
|
|
11
36
|
}
|
|
12
37
|
const generatedOutputTypes = (0, GenerateOutput_1.generateOutputTypes)(operationNameCamelCase, generatedOutputSchema.right);
|
|
13
|
-
return
|
|
38
|
+
return TE.getOrElse((error) => {
|
|
39
|
+
throw new Error('Should have been right');
|
|
40
|
+
})(generatedOutputTypes)();
|
|
14
41
|
};
|
|
15
42
|
describe('Generate output: ', () => {
|
|
16
43
|
it('it should generate output.ts file contents for a response code 200 content json', async () => {
|
|
17
|
-
const responses =
|
|
44
|
+
const responses = O.some({
|
|
18
45
|
'200': {
|
|
19
46
|
description: 'A post was created',
|
|
20
|
-
content:
|
|
47
|
+
content: O.some({
|
|
21
48
|
'application/json': {
|
|
22
|
-
schema:
|
|
23
|
-
title:
|
|
24
|
-
type:
|
|
25
|
-
required:
|
|
26
|
-
properties:
|
|
49
|
+
schema: O.some((0, SchemaGenerator_1.generateNonArraySchemaObject)({
|
|
50
|
+
title: O.some('Post'),
|
|
51
|
+
type: O.some('object'),
|
|
52
|
+
required: O.some(['id', 'userId', 'title', 'body']),
|
|
53
|
+
properties: O.some({
|
|
27
54
|
id: (0, SchemaGenerator_1.generateNonArraySchemaObject)({
|
|
28
|
-
type:
|
|
29
|
-
additionalProperties:
|
|
55
|
+
type: O.some('integer'),
|
|
56
|
+
additionalProperties: O.some(false),
|
|
30
57
|
}),
|
|
31
58
|
userId: (0, SchemaGenerator_1.generateNonArraySchemaObject)({
|
|
32
|
-
type:
|
|
33
|
-
additionalProperties:
|
|
59
|
+
type: O.some('integer'),
|
|
60
|
+
additionalProperties: O.some(false),
|
|
34
61
|
}),
|
|
35
62
|
title: (0, SchemaGenerator_1.generateNonArraySchemaObject)({
|
|
36
|
-
type:
|
|
37
|
-
additionalProperties:
|
|
63
|
+
type: O.some('string'),
|
|
64
|
+
additionalProperties: O.some(false),
|
|
38
65
|
}),
|
|
39
66
|
body: (0, SchemaGenerator_1.generateNonArraySchemaObject)({
|
|
40
|
-
type:
|
|
41
|
-
additionalProperties:
|
|
67
|
+
type: O.some('string'),
|
|
68
|
+
additionalProperties: O.some(false),
|
|
42
69
|
}),
|
|
43
70
|
}),
|
|
44
|
-
additionalProperties:
|
|
71
|
+
additionalProperties: O.some(false),
|
|
45
72
|
})),
|
|
46
73
|
},
|
|
47
74
|
}),
|
|
@@ -58,33 +85,33 @@ describe('Generate output: ', () => {
|
|
|
58
85
|
expect(generatedOutputFileContents).toEqual(expectedOutputFileContents);
|
|
59
86
|
});
|
|
60
87
|
it('it should generate output.ts file contents for a response code 201 content json', async () => {
|
|
61
|
-
const responses =
|
|
88
|
+
const responses = O.some({
|
|
62
89
|
'201': {
|
|
63
90
|
description: 'A post was created',
|
|
64
|
-
content:
|
|
91
|
+
content: O.some({
|
|
65
92
|
'application/json': {
|
|
66
|
-
schema:
|
|
67
|
-
type:
|
|
68
|
-
required:
|
|
69
|
-
properties:
|
|
93
|
+
schema: O.some((0, SchemaGenerator_1.generateNonArraySchemaObject)({
|
|
94
|
+
type: O.some('object'),
|
|
95
|
+
required: O.some(['id', 'userId', 'title', 'body']),
|
|
96
|
+
properties: O.some({
|
|
70
97
|
id: (0, SchemaGenerator_1.generateNonArraySchemaObject)({
|
|
71
|
-
type:
|
|
72
|
-
additionalProperties:
|
|
98
|
+
type: O.some('integer'),
|
|
99
|
+
additionalProperties: O.some(false),
|
|
73
100
|
}),
|
|
74
101
|
userId: (0, SchemaGenerator_1.generateNonArraySchemaObject)({
|
|
75
|
-
type:
|
|
76
|
-
additionalProperties:
|
|
102
|
+
type: O.some('integer'),
|
|
103
|
+
additionalProperties: O.some(false),
|
|
77
104
|
}),
|
|
78
105
|
title: (0, SchemaGenerator_1.generateNonArraySchemaObject)({
|
|
79
|
-
type:
|
|
80
|
-
additionalProperties:
|
|
106
|
+
type: O.some('string'),
|
|
107
|
+
additionalProperties: O.some(false),
|
|
81
108
|
}),
|
|
82
109
|
body: (0, SchemaGenerator_1.generateNonArraySchemaObject)({
|
|
83
|
-
type:
|
|
84
|
-
additionalProperties:
|
|
110
|
+
type: O.some('string'),
|
|
111
|
+
additionalProperties: O.some(false),
|
|
85
112
|
}),
|
|
86
113
|
}),
|
|
87
|
-
additionalProperties:
|
|
114
|
+
additionalProperties: O.some(false),
|
|
88
115
|
})),
|
|
89
116
|
},
|
|
90
117
|
}),
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@trayio/tray-openapi",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "6.0.0",
|
|
4
4
|
"description": "Creating CDK Projects from OpenAPI 3.0 Schemas",
|
|
5
5
|
"exports": {
|
|
6
6
|
"./*": "./dist/*.js"
|
|
@@ -24,12 +24,14 @@
|
|
|
24
24
|
"dependencies": {
|
|
25
25
|
"@openapi-contrib/openapi-schema-to-json-schema": "5.1.0",
|
|
26
26
|
"@stoplight/json-ref-resolver": "3.1.6",
|
|
27
|
-
"@trayio/cdk-dsl": "
|
|
28
|
-
"@trayio/cdk-runtime": "
|
|
29
|
-
"@trayio/commons": "
|
|
30
|
-
"@trayio/generator": "
|
|
27
|
+
"@trayio/cdk-dsl": "6.0.0",
|
|
28
|
+
"@trayio/cdk-runtime": "6.0.0",
|
|
29
|
+
"@trayio/commons": "6.0.0",
|
|
30
|
+
"@trayio/generator": "6.0.0",
|
|
31
31
|
"@types/json-schema": "7.0.15",
|
|
32
|
-
"
|
|
32
|
+
"fp-ts": "2.12.3",
|
|
33
|
+
"io-ts": "2.2.20",
|
|
34
|
+
"io-ts-types": "0.5.19",
|
|
33
35
|
"json-schema-to-typescript": "13.1.1",
|
|
34
36
|
"json-to-typescript": "1.0.1",
|
|
35
37
|
"lodash": "4.18.1"
|