npm - @trayio/tray-openapi - Versions diffs - 0.0.1-beta - Mend

@trayio/tray-openapi 0.0.1-beta

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 (62) hide show

package/dist/file-generators/GenerateHandlerTest.test.js ADDED Viewed

@@ -0,0 +1,640 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const E = __importStar(require("fp-ts/Either"));
+const O = __importStar(require("fp-ts/Option"));
+const GenerateHandlerTest_1 = require("./GenerateHandlerTest");
+describe('GenerateHandlerTest', () => {
+    it('should generate a handler test with inputs and outputs', () => {
+        const input = {
+            operationNameCamelCase: 'getItem',
+            input: {
+                type: O.some('object'),
+                title: O.none,
+                properties: O.some({
+                    id: {
+                        title: O.none,
+                        type: O.some('integer'),
+                        format: 'int64',
+                        properties: O.none,
+                        required: O.none,
+                        additionalProperties: O.some(false),
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                    name: {
+                        title: O.none,
+                        type: O.some('string'),
+                        properties: O.none,
+                        required: O.none,
+                        additionalProperties: O.some(false),
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                }),
+                required: O.some(['id', 'name']),
+                additionalProperties: O.some(false),
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+            output: {
+                type: O.some('object'),
+                title: O.none,
+                properties: O.some({
+                    id: {
+                        title: O.none,
+                        type: O.some('integer'),
+                        format: 'int64',
+                        properties: O.none,
+                        required: O.none,
+                        additionalProperties: O.some(false),
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                    name: {
+                        title: O.none,
+                        type: O.some('string'),
+                        properties: O.none,
+                        required: O.none,
+                        additionalProperties: O.some(false),
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                }),
+                required: O.some(['id']),
+                additionalProperties: O.some(false),
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+        };
+        const result = (0, GenerateHandlerTest_1.generateHandlerTest)(input);
+        if (E.isLeft(result)) {
+            console.log(result.left);
+            throw new Error('Expected right');
+        }
+        expect(`import { OperationHandlerTestSetup } from '@trayio/cdk-dsl/connector/operation/OperationHandlerTest';
+	import { OperationHandlerResult } from '@trayio/cdk-dsl/connector/operation/OperationHandler';
+	import { getItemHandler } from './handler';
+	import '@trayio/cdk-runtime/connector/operation/OperationHandlerTestRunner';
+	OperationHandlerTestSetup.configureHandlerTest(getItemHandler, (handlerTest) =>
+		handlerTest
+			.usingHandlerContext('test')
+			.nothingBeforeAll()
+			.testCase('should ${input.operationNameCamelCase}', (testCase) =>
+				testCase
+					.givenNothing()
+					.when(() => ({ id: 2, name: 'test' }))
+					.then(({ output }) => {
+						// console.log(output);
+						const outputValue =
+							OperationHandlerResult.getSuccessfulValueOrFail(output);
+						expect(outputValue.id).toEqual(2);
+						expect(outputValue.name).toEqual('test');
+					})
+					.finallyDoNothing()
+			)
+			.nothingAfterAll()
+	);`.replace(/\s/g, '')).toEqual(result.right.replace(/\s/g, ''));
+    });
+    it('should generate a handler test with empty inputs', () => {
+        const input = {
+            operationNameCamelCase: 'getItem',
+            input: {
+                title: O.none,
+                type: O.none,
+                properties: O.none,
+                required: O.none,
+                additionalProperties: O.none,
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+            output: {
+                type: O.some('object'),
+                title: O.none,
+                properties: O.some({
+                    success: {
+                        title: O.none,
+                        type: O.some('boolean'),
+                        properties: O.none,
+                        required: O.none,
+                        additionalProperties: O.none,
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                }),
+                required: O.some(['success']),
+                additionalProperties: O.some(false),
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+        };
+        const result = (0, GenerateHandlerTest_1.generateHandlerTest)(input);
+        if (E.isLeft(result)) {
+            console.log(result.left);
+            throw new Error('Expected right');
+        }
+        expect(`import { OperationHandlerTestSetup } from '@trayio/cdk-dsl/connector/operation/OperationHandlerTest';
+	import { OperationHandlerResult } from '@trayio/cdk-dsl/connector/operation/OperationHandler';
+	import { getItemHandler } from './handler';
+	import '@trayio/cdk-runtime/connector/operation/OperationHandlerTestRunner';
+	OperationHandlerTestSetup.configureHandlerTest(getItemHandler, (handlerTest) =>
+		handlerTest
+			.usingHandlerContext('test')
+			.nothingBeforeAll()
+			.testCase('should ${input.operationNameCamelCase}', (testCase) =>
+				testCase
+					.givenNothing()
+					.when(() => ({}))
+					.then(({ output }) => {
+						// console.log(output);
+						const outputValue =
+							OperationHandlerResult.getSuccessfulValueOrFail(output);
+						expect(outputValue.success).toEqual(true);
+					})
+					.finallyDoNothing()
+			)
+			.nothingAfterAll()
+	);`.replace(/\s/g, '')).toEqual(result.right.replace(/\s/g, ''));
+    });
+    it('should generate a handler test with a basic object input and output type', () => {
+        const input = {
+            operationNameCamelCase: 'createPerson',
+            input: {
+                title: O.none,
+                type: O.some('object'),
+                properties: O.some({
+                    metadata: {
+                        title: O.none,
+                        type: O.some('object'),
+                        properties: O.some({
+                            name: {
+                                title: O.none,
+                                type: O.some('string'),
+                                properties: O.none,
+                                required: O.none,
+                                additionalProperties: O.some(false),
+                                allOf: O.none,
+                                anyOf: O.none,
+                                oneOf: O.none,
+                                not: O.none,
+                                in: O.none,
+                            },
+                            age: {
+                                title: O.none,
+                                type: O.some('integer'),
+                                properties: O.none,
+                                required: O.none,
+                                additionalProperties: O.some(false),
+                                allOf: O.none,
+                                anyOf: O.none,
+                                oneOf: O.none,
+                                not: O.none,
+                                in: O.none,
+                            },
+                        }),
+                        required: O.none,
+                        additionalProperties: O.some(false),
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                }),
+                required: O.none,
+                additionalProperties: O.some(false),
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+            output: {
+                title: O.none,
+                type: O.some('object'),
+                properties: O.some({
+                    parents: {
+                        title: O.none,
+                        type: O.some('object'),
+                        properties: O.some({
+                            child: {
+                                title: O.none,
+                                type: O.some('string'),
+                                properties: O.none,
+                                required: O.none,
+                                additionalProperties: O.some(false),
+                                allOf: O.none,
+                                anyOf: O.none,
+                                oneOf: O.none,
+                                not: O.none,
+                                in: O.none,
+                            },
+                        }),
+                        required: O.none,
+                        additionalProperties: O.some(false),
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                }),
+                required: O.none,
+                additionalProperties: O.some(false),
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+        };
+        const result = (0, GenerateHandlerTest_1.generateHandlerTest)(input);
+        if (E.isLeft(result)) {
+            console.log(result.left);
+            throw new Error('Expected right');
+        }
+        expect(`import { OperationHandlerTestSetup } from '@trayio/cdk-dsl/connector/operation/OperationHandlerTest';
+	import { OperationHandlerResult } from '@trayio/cdk-dsl/connector/operation/OperationHandler';
+	import { createPersonHandler } from './handler';
+	import '@trayio/cdk-runtime/connector/operation/OperationHandlerTestRunner';
+	OperationHandlerTestSetup.configureHandlerTest(createPersonHandler, (handlerTest) =>
+		handlerTest
+			.usingHandlerContext('test')
+			.nothingBeforeAll()
+			.testCase('should ${input.operationNameCamelCase}', (testCase) =>
+				testCase
+					.givenNothing()
+					.when(() => ({ metadata: { name: 'test', age: 2 }}))
+					.then(({ output }) => {
+						// console.log(output);
+						const outputValue =
+							OperationHandlerResult.getSuccessfulValueOrFail(output);
+						expect(outputValue.parents).toEqual({child: 'test'});
+					})
+					.finallyDoNothing()
+			)
+			.nothingAfterAll()
+	);`.replace(/\s/g, '')).toEqual(result.right.replace(/\s/g, ''));
+    });
+    it('should generate a handler test with a basic array input and output type', () => {
+        const input = {
+            operationNameCamelCase: 'listItems',
+            input: {
+                type: O.some('object'),
+                title: O.none,
+                properties: O.some({
+                    ids: {
+                        title: O.none,
+                        type: 'array',
+                        items: {
+                            title: O.none,
+                            type: O.some('integer'),
+                            properties: O.none,
+                            required: O.none,
+                            additionalProperties: O.some(false),
+                            allOf: O.none,
+                            anyOf: O.none,
+                            oneOf: O.none,
+                            not: O.none,
+                            in: O.none,
+                        },
+                        properties: O.none,
+                        required: O.none,
+                        additionalProperties: O.some(false),
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                }),
+                required: O.none,
+                additionalProperties: O.some(false),
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+            output: {
+                type: O.some('object'),
+                title: O.none,
+                properties: O.some({
+                    parents: {
+                        title: O.none,
+                        type: 'array',
+                        items: {
+                            title: O.none,
+                            type: O.some('string'),
+                            properties: O.none,
+                            required: O.none,
+                            additionalProperties: O.some(false),
+                            allOf: O.none,
+                            anyOf: O.none,
+                            oneOf: O.none,
+                            not: O.none,
+                            in: O.none,
+                        },
+                        properties: O.none,
+                        required: O.none,
+                        additionalProperties: O.some(false),
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                }),
+                required: O.none,
+                additionalProperties: O.some(false),
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+        };
+        const result = (0, GenerateHandlerTest_1.generateHandlerTest)(input);
+        if (E.isLeft(result)) {
+            console.log(result.left);
+            throw new Error('Expected right');
+        }
+        expect(`import { OperationHandlerTestSetup } from '@trayio/cdk-dsl/connector/operation/OperationHandlerTest';
+	import { OperationHandlerResult } from '@trayio/cdk-dsl/connector/operation/OperationHandler';
+	import { listItemsHandler } from './handler';
+	import '@trayio/cdk-runtime/connector/operation/OperationHandlerTestRunner';
+	OperationHandlerTestSetup.configureHandlerTest(listItemsHandler, (handlerTest) =>
+		handlerTest
+			.usingHandlerContext('test')
+			.nothingBeforeAll()
+			.testCase('should ${input.operationNameCamelCase}', (testCase) =>
+				testCase
+					.givenNothing()
+					.when(() => ({ ids: [2] }))
+					.then(({ output }) => {
+						// console.log(output);
+						const outputValue =
+							OperationHandlerResult.getSuccessfulValueOrFail(output);
+						expect(outputValue.parents).toEqual(['test']);
+					})
+					.finallyDoNothing()
+			)
+			.nothingAfterAll()
+	);`.replace(/\s/g, '')).toEqual(result.right.replace(/\s/g, ''));
+    });
+    it('should generate a handler test with a complex object output type', () => {
+        const input = {
+            operationNameCamelCase: 'listItems',
+            input: {
+                title: O.none,
+                type: O.none,
+                properties: O.none,
+                required: O.none,
+                additionalProperties: O.none,
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+            output: {
+                type: O.some('object'),
+                title: O.none,
+                properties: O.some({
+                    parents: {
+                        title: O.none,
+                        type: O.some('object'),
+                        properties: O.some({
+                            child: {
+                                title: O.none,
+                                type: O.some('string'),
+                                properties: O.none,
+                                required: O.none,
+                                additionalProperties: O.none,
+                                allOf: O.none,
+                                anyOf: O.none,
+                                oneOf: O.none,
+                                not: O.none,
+                                in: O.none,
+                            },
+                            valueList: {
+                                title: O.none,
+                                type: 'array',
+                                items: {
+                                    title: O.none,
+                                    type: O.some('string'),
+                                    properties: O.none,
+                                    required: O.none,
+                                    additionalProperties: O.none,
+                                    allOf: O.none,
+                                    anyOf: O.none,
+                                    oneOf: O.none,
+                                    not: O.none,
+                                    in: O.none,
+                                },
+                                properties: O.none,
+                                required: O.none,
+                                additionalProperties: O.some(false),
+                                allOf: O.none,
+                                anyOf: O.none,
+                                oneOf: O.none,
+                                not: O.none,
+                                in: O.none,
+                            },
+                        }),
+                        required: O.none,
+                        additionalProperties: O.some(false),
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                }),
+                required: O.none,
+                additionalProperties: O.some(false),
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+        };
+        const result = (0, GenerateHandlerTest_1.generateHandlerTest)(input);
+        if (E.isLeft(result)) {
+            console.log(result.left);
+            throw new Error('Expected right');
+        }
+        expect(`import { OperationHandlerTestSetup } from '@trayio/cdk-dsl/connector/operation/OperationHandlerTest';
+	import { OperationHandlerResult } from '@trayio/cdk-dsl/connector/operation/OperationHandler';
+	import { listItemsHandler } from './handler';
+	import '@trayio/cdk-runtime/connector/operation/OperationHandlerTestRunner';
+	OperationHandlerTestSetup.configureHandlerTest(listItemsHandler, (handlerTest) =>
+		handlerTest
+			.usingHandlerContext('test')
+			.nothingBeforeAll()
+			.testCase('should ${input.operationNameCamelCase}', (testCase) =>
+				testCase
+					.givenNothing()
+					.when(() => ({}))
+					.then(({ output }) => {
+						// console.log(output);
+						const outputValue =
+							OperationHandlerResult.getSuccessfulValueOrFail(output);
+						expect(outputValue.parents).toEqual({child: 'test', valueList: ['test']});
+					})
+					.finallyDoNothing()
+			)
+			.nothingAfterAll()
+	);`.replace(/\s/g, '')).toEqual(result.right.replace(/\s/g, ''));
+    });
+    it('should generate a handler test with a complex array output type', () => {
+        const input = {
+            operationNameCamelCase: 'listItems',
+            input: {
+                title: O.none,
+                type: O.none,
+                properties: O.none,
+                required: O.none,
+                additionalProperties: O.none,
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+            output: {
+                title: O.none,
+                type: O.some('object'),
+                properties: O.some({
+                    parents: {
+                        title: O.none,
+                        type: 'array',
+                        items: {
+                            title: O.none,
+                            type: O.some('object'),
+                            properties: O.some({
+                                child: {
+                                    title: O.none,
+                                    type: O.some('string'),
+                                    properties: O.none,
+                                    required: O.none,
+                                    additionalProperties: O.none,
+                                    allOf: O.none,
+                                    anyOf: O.none,
+                                    oneOf: O.none,
+                                    not: O.none,
+                                    in: O.none,
+                                },
+                            }),
+                            required: O.none,
+                            additionalProperties: O.none,
+                            allOf: O.none,
+                            anyOf: O.none,
+                            oneOf: O.none,
+                            not: O.none,
+                            in: O.none,
+                        },
+                        properties: O.none,
+                        required: O.none,
+                        additionalProperties: O.some(false),
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                }),
+                required: O.none,
+                additionalProperties: O.some(false),
+                allOf: O.none,
+                anyOf: O.none,
+                oneOf: O.none,
+                not: O.none,
+                in: O.none,
+            },
+        };
+        const result = (0, GenerateHandlerTest_1.generateHandlerTest)(input);
+        if (E.isLeft(result)) {
+            console.log(result.left);
+            throw new Error('Expected right');
+        }
+        expect(`import { OperationHandlerTestSetup } from '@trayio/cdk-dsl/connector/operation/OperationHandlerTest';
+	import { OperationHandlerResult } from '@trayio/cdk-dsl/connector/operation/OperationHandler';
+	import { listItemsHandler } from './handler';
+	import '@trayio/cdk-runtime/connector/operation/OperationHandlerTestRunner';
+	OperationHandlerTestSetup.configureHandlerTest(listItemsHandler, (handlerTest) =>
+		handlerTest
+			.usingHandlerContext('test')
+			.nothingBeforeAll()
+			.testCase('should ${input.operationNameCamelCase}', (testCase) =>
+				testCase
+					.givenNothing()
+					.when(() => ({}))
+					.then(({ output }) => {
+						// console.log(output);
+						const outputValue =
+							OperationHandlerResult.getSuccessfulValueOrFail(output);
+						expect(outputValue.parents).toEqual([{child: 'test'}]);
+					})
+					.finallyDoNothing()
+			)
+			.nothingAfterAll()
+	);`.replace(/\s/g, '')).toEqual(result.right.replace(/\s/g, ''));
+    });
+});

package/dist/file-generators/GenerateOperationJson.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+import * as TE from 'fp-ts/TaskEither';
+import { FileStorage } from '@trayio/commons/file/File';
+export declare const generateOperationJson: (fileStorage: FileStorage, operationDirPath: string, operationNameSnakeCase: string, operationNameKebabCase: string, operationDescription: string) => TE.TaskEither<Error, undefined>;
+//# sourceMappingURL=GenerateOperationJson.d.ts.map

package/dist/file-generators/GenerateOperationJson.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"GenerateOperationJson.d.ts","sourceRoot":"","sources":["../../src/file-generators/GenerateOperationJson.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAGvC,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAGxD,eAAO,MAAM,qBAAqB,gBACpB,WAAW,oBACN,MAAM,0BACA,MAAM,0BACN,MAAM,wBACR,MAAM,KAC1B,GAAG,UAAU,CAAC,KAAK,EAAE,SAAS,CAuBhC,CAAC"}

package/dist/file-generators/GenerateOperationJson.js ADDED Viewed

@@ -0,0 +1,44 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateOperationJson = void 0;
+const TE = __importStar(require("fp-ts/TaskEither"));
+const O = __importStar(require("fp-ts/Option"));
+const function_1 = require("fp-ts/function");
+const stream_1 = require("stream");
+const generateOperationJson = (fileStorage, operationDirPath, operationNameSnakeCase, operationNameKebabCase, operationDescription) => {
+    const operationJson = {
+        name: operationNameSnakeCase,
+        title: operationNameKebabCase,
+        description: operationDescription,
+    };
+    const writeOperationJson = fileStorage.write({
+        content: stream_1.Readable.from(JSON.stringify(operationJson)),
+        key: `${operationDirPath}/operation.json`,
+        metadata: { name: 'operation.json' },
+    }, O.none);
+    return (0, function_1.pipe)(writeOperationJson, TE.mapLeft((error) => new Error(`Failed to generate operation.json for operation: ${error}`)), TE.map(() => undefined));
+};
+exports.generateOperationJson = generateOperationJson;

package/dist/file-generators/GenerateOperationJson.test.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export {};
2	+ //# sourceMappingURL=GenerateOperationJson.test.d.ts.map