@trayio/tray-openapi 5.34.0 → 5.35.0-unstable.fd7158a

package/dist/file-generators/GenerateOperationJson.js

@@ -1,41 +1,16 @@
 "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 effect_1 = require("effect");
 const lodash_1 = require("lodash");
 const generateOperationJson = (operationName, path) => {
-    const operationDescription = O.getOrElse(() => O.getOrElse(() => '')(path.summary))(path.description);
+    const operationDescription = effect_1.Option.getOrElse(path.description, () => effect_1.Option.getOrElse(path.summary, () => ''));
     const operationNameSnakeCase = (0, lodash_1.snakeCase)(operationName);
     const operationNameTitleCase = (0, lodash_1.startCase)((0, lodash_1.camelCase)(operationName));
-    return (0, function_1.pipe)(operationDescription, TE.fromPredicate((description) => description.length > 0, () => new Error('Operation description is empty')), TE.map((description) => ({
+    return (0, effect_1.pipe)(operationDescription, effect_1.Effect.liftPredicate((description) => description.length > 0, () => new Error('Operation description is empty')), effect_1.Effect.map((description) => ({
         name: operationNameSnakeCase,
         title: operationNameTitleCase,
         description,
-    })), TE.map((operationJson) => JSON.stringify(operationJson, null, 2)), TE.mapLeft((error) => new Error(`Failed to generate operation.json for operation: ${error}`)));
+    })), effect_1.Effect.map((operationJson) => JSON.stringify(operationJson, null, 2)), effect_1.Effect.mapError((error) => new Error(`Failed to generate operation.json for operation: ${error}`)));
 };
 exports.generateOperationJson = generateOperationJson;

package/dist/file-generators/GenerateOperationJson.unit.test.js

@@ -1,45 +1,21 @@
 "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 effect_1 = require("effect");
 const GenerateOperationJson_1 = require("./GenerateOperationJson");
 describe('generateOperationJson', () => {
     it('should generate correct data for operation.json', async () => {
         const operationName = 'getPhoto';
         const path = {
             operationId: 'get_photo',
-            description: O.some('Get a photo'),
-            summary: O.none,
-            tags: O.some([]),
-            parameters: O.none,
-            requestBody: O.none,
-            responses: O.none,
+            description: effect_1.Option.some('Get a photo'),
+            summary: effect_1.Option.none(),
+            tags: effect_1.Option.some([]),
+            parameters: effect_1.Option.none(),
+            requestBody: effect_1.Option.none(),
+            responses: effect_1.Option.none(),
         };
-        const result = await (0, GenerateOperationJson_1.generateOperationJson)(operationName, path)();
-        if (E.isLeft(result)) {
+        const result = await effect_1.Effect.runPromise(effect_1.Effect.either((0, GenerateOperationJson_1.generateOperationJson)(operationName, path)));
+        if (effect_1.Either.isLeft(result)) {
             throw new Error('expected result to be right');
         }
         expect(result.right).toEqual(JSON.stringify({
@@ -52,15 +28,15 @@ describe('generateOperationJson', () => {
         const operationName = 'getPhoto';
         const path = {
             operationId: 'get_photo',
-            description: O.none,
-            summary: O.some('Get a photo'),
-            tags: O.some([]),
-            parameters: O.none,
-            requestBody: O.none,
-            responses: O.none,
+            description: effect_1.Option.none(),
+            summary: effect_1.Option.some('Get a photo'),
+            tags: effect_1.Option.some([]),
+            parameters: effect_1.Option.none(),
+            requestBody: effect_1.Option.none(),
+            responses: effect_1.Option.none(),
         };
-        const result = await (0, GenerateOperationJson_1.generateOperationJson)(operationName, path)();
-        if (E.isLeft(result)) {
+        const result = await effect_1.Effect.runPromise(effect_1.Effect.either((0, GenerateOperationJson_1.generateOperationJson)(operationName, path)));
+        if (effect_1.Either.isLeft(result)) {
             throw new Error('expected result to be right');
         }
         expect(result.right).toEqual(JSON.stringify({
@@ -73,15 +49,15 @@ describe('generateOperationJson', () => {
         const operationName = 'getPhoto';
         const path = {
             operationId: 'Get Photo',
-            description: O.none,
-            summary: O.some('Get a photo'),
-            tags: O.some([]),
-            parameters: O.none,
-            requestBody: O.none,
-            responses: O.none,
+            description: effect_1.Option.none(),
+            summary: effect_1.Option.some('Get a photo'),
+            tags: effect_1.Option.some([]),
+            parameters: effect_1.Option.none(),
+            requestBody: effect_1.Option.none(),
+            responses: effect_1.Option.none(),
         };
-        const result = await (0, GenerateOperationJson_1.generateOperationJson)(operationName, path)();
-        if (E.isLeft(result)) {
+        const result = await effect_1.Effect.runPromise(effect_1.Effect.either((0, GenerateOperationJson_1.generateOperationJson)(operationName, path)));
+        if (effect_1.Either.isLeft(result)) {
             throw new Error('expected result to be right');
         }
         expect(result.right).toEqual(JSON.stringify({

package/dist/file-generators/SchemaGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaGenerator.d.ts","sourceRoot":"","sources":["../../src/file-generators/SchemaGenerator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE/E,eAAO,MAAM,4BAA4B,iBAC1B,QAAQ,oBAAoB,CAAC,KACzC,YAeD,CAAC"}
+{"version":3,"file":"SchemaGenerator.d.ts","sourceRoot":"","sources":["../../src/file-generators/SchemaGenerator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE/E,eAAO,MAAM,4BAA4B,GACxC,cAAc,OAAO,CAAC,oBAAoB,CAAC,KACzC,YAeD,CAAC"}

package/dist/file-generators/SchemaGenerator.js

@@ -1,44 +1,21 @@
 "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.generateNonArraySchemaObject = void 0;
-const O = __importStar(require("fp-ts/Option"));
+const effect_1 = require("effect");
 const generateNonArraySchemaObject = (schemaObject) => ({
-    title: O.none,
-    type: 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,
-    default: O.none,
-    nullable: O.none,
-    enum: O.none,
+    title: effect_1.Option.none(),
+    type: effect_1.Option.none(),
+    properties: effect_1.Option.none(),
+    required: effect_1.Option.none(),
+    additionalProperties: effect_1.Option.some(false),
+    allOf: effect_1.Option.none(),
+    anyOf: effect_1.Option.none(),
+    oneOf: effect_1.Option.none(),
+    not: effect_1.Option.none(),
+    in: effect_1.Option.none(),
+    default: effect_1.Option.none(),
+    nullable: effect_1.Option.none(),
+    enum: effect_1.Option.none(),
     ...schemaObject,
 });
 exports.generateNonArraySchemaObject = generateNonArraySchemaObject;

package/dist/file-generators/types/GenerateInputSchema.d.ts

@@ -1,4 +1,4 @@
-import * as E from 'fp-ts/Either';
+import { Either } from 'effect';
 import { Path, SchemaObject } from '../../OpenApiTypeDescriptors';
-export declare const generateInputSchema: (endpoint: Path) => E.Either<Error, SchemaObject>;
+export declare const generateInputSchema: (endpoint: Path) => Either.Either<SchemaObject, Error>;
 //# sourceMappingURL=GenerateInputSchema.d.ts.map

package/dist/file-generators/types/GenerateInputSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GenerateInputSchema.d.ts","sourceRoot":"","sources":["../../../src/file-generators/types/GenerateInputSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAQlC,OAAO,EACN,IAAI,EAGJ,YAAY,EAEZ,MAAM,8BAA8B,CAAC;AAuJtC,eAAO,MAAM,mBAAmB,aACrB,IAAI,KACZ,EAAE,MAAM,CAAC,KAAK,EAAE,YAAY,CAiC9B,CAAC"}
+{"version":3,"file":"GenerateInputSchema.d.ts","sourceRoot":"","sources":["../../../src/file-generators/types/GenerateInputSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAgB,MAAM,QAAQ,CAAC;AAM9C,OAAO,EACN,IAAI,EAGJ,YAAY,EAEZ,MAAM,8BAA8B,CAAC;AAgKtC,eAAO,MAAM,mBAAmB,GAC/B,UAAU,IAAI,KACZ,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,CAmCnC,CAAC"}

package/dist/file-generators/types/GenerateInputSchema.js

@@ -1,63 +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.generateInputSchema = void 0;
-const E = __importStar(require("fp-ts/Either"));
-const function_1 = require("fp-ts/function");
+const effect_1 = require("effect");
 const lodash_1 = require("lodash");
-const O = __importStar(require("fp-ts/Option"));
 const openapi_schema_to_json_schema_1 = require("@openapi-contrib/openapi-schema-to-json-schema");
 const CompositeCodec_1 = require("@trayio/commons/codec/CompositeCodec");
 const RemoveNullValuesCodec_1 = require("@trayio/commons/codec/RemoveNullValuesCodec");
 const OpenApiCodecs_1 = require("../../OpenApiCodecs");
 const OpenApiTypeDescriptors_1 = require("../../OpenApiTypeDescriptors");
 const mergeRequired = (params, body) => {
-    const requiredBody = O.fold(() => [], (required) => required)(body.required);
-    const requiredParams = O.fold(() => [], (required) => required)(params.required);
+    const requiredBody = effect_1.Option.match(body.required, {
+        onNone: () => [],
+        onSome: (required) => required,
+    });
+    const requiredParams = effect_1.Option.match(params.required, {
+        onNone: () => [],
+        onSome: (required) => required,
+    });
     if ((0, lodash_1.isArray)(requiredBody) && (0, lodash_1.isArray)(requiredParams)) {
         return [...requiredBody, ...requiredParams];
     }
     return [];
 };
 const mergeParamsAndBody = (params, body) => ({
-    title: O.none,
-    type: O.some('object'),
-    properties: O.some({
-        ...(O.isSome(body.properties) && body.properties.value),
-        ...(O.isSome(params.properties) && params.properties.value),
+    title: effect_1.Option.none(),
+    type: effect_1.Option.some('object'),
+    properties: effect_1.Option.some({
+        ...(effect_1.Option.isSome(body.properties) && body.properties.value),
+        ...(effect_1.Option.isSome(params.properties) && params.properties.value),
     }),
-    required: O.some(mergeRequired(params, body)),
-    additionalProperties: O.some(false),
-    allOf: O.none,
-    anyOf: O.none,
-    oneOf: O.none,
-    not: O.none,
-    in: O.none,
-    default: O.none,
-    nullable: O.none,
-    enum: O.none,
+    required: effect_1.Option.some(mergeRequired(params, body)),
+    additionalProperties: effect_1.Option.some(false),
+    allOf: effect_1.Option.none(),
+    anyOf: effect_1.Option.none(),
+    oneOf: effect_1.Option.none(),
+    not: effect_1.Option.none(),
+    in: effect_1.Option.none(),
+    default: effect_1.Option.none(),
+    nullable: effect_1.Option.none(),
+    enum: effect_1.Option.none(),
 });
 const transformInput = (parameters) => {
     const transformedParameters = {};
@@ -67,9 +48,10 @@ const transformInput = (parameters) => {
         const parameterWithNoOptions = codecWithNullValueRemoval.encode(parameter);
         const parameterWithJsdocAnnotation = {
             ...parameterWithNoOptions,
-            description: `@description ${O.getOrElse(() => '<Replace Description>')(parameter.description)}`,
+            description: `@description ${effect_1.Option.getOrElse(parameter.description, () => '<Replace Description>')}`,
         };
-        const decodedParam = OpenApiTypeDescriptors_1.schemaObjectTypeDescriptor.decode({
+        // TypeCodec keeps properties the schema does not declare (the jsdoc description above), a bare Schema decode drops them
+        const decodedParam = OpenApiTypeDescriptors_1.schemaObjectTypeCodec.decode({
             ...(0, openapi_schema_to_json_schema_1.fromParameter)(parameterWithJsdocAnnotation),
             in: parameter.in,
         });
@@ -77,82 +59,93 @@ const transformInput = (parameters) => {
             throw new Error('Failed to decode params');
         }
         transformedParameters[parameter.name] = decodedParam.right;
-        if (O.isSome(parameter.required) && parameter.required.value === true) {
+        if (effect_1.Option.isSome(parameter.required) &&
+            parameter.required.value === true) {
             requiredParameters.push(parameter.name);
         }
     });
     return {
-        title: O.none,
-        type: O.some('object'),
-        properties: O.some(transformedParameters),
-        required: O.some([...requiredParameters]),
-        additionalProperties: O.some(false),
-        allOf: O.none,
-        anyOf: O.none,
-        oneOf: O.none,
-        not: O.none,
-        in: O.none,
-        default: O.none,
-        nullable: O.none,
-        enum: O.none,
+        title: effect_1.Option.none(),
+        type: effect_1.Option.some('object'),
+        properties: effect_1.Option.some(transformedParameters),
+        required: effect_1.Option.some([...requiredParameters]),
+        additionalProperties: effect_1.Option.some(false),
+        allOf: effect_1.Option.none(),
+        anyOf: effect_1.Option.none(),
+        oneOf: effect_1.Option.none(),
+        not: effect_1.Option.none(),
+        in: effect_1.Option.none(),
+        default: effect_1.Option.none(),
+        nullable: effect_1.Option.none(),
+        enum: effect_1.Option.none(),
     };
 };
 /**
  * OpenAPI spec's body params don't have an .in property, we add one in here since query, path, and header params do
  */
-const appendInPropertyToBody = (body) => O.fold(() => body, (properties) => {
-    const propsWithInBody = Object.keys(properties).reduce((acc, name) => ({
-        ...acc,
-        [name]: {
-            ...properties[name],
-            in: O.some('body'),
-        },
-    }), {});
-    return {
-        ...body,
-        properties: O.some(propsWithInBody),
-    };
-})(body.properties);
+const appendInPropertyToBody = (body) => effect_1.Option.match(body.properties, {
+    onNone: () => body,
+    onSome: (properties) => {
+        const propsWithInBody = Object.keys(properties).reduce((acc, name) => ({
+            ...acc,
+            [name]: {
+                ...properties[name],
+                in: effect_1.Option.some('body'),
+            },
+        }), {});
+        return {
+            ...body,
+            properties: effect_1.Option.some(propsWithInBody),
+        };
+    },
+});
 const blankOutputSchema = () => ({
-    title: O.none,
-    type: 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,
-    default: O.none,
-    nullable: O.none,
-    enum: O.none,
+    title: effect_1.Option.none(),
+    type: effect_1.Option.none(),
+    properties: effect_1.Option.none(),
+    required: effect_1.Option.none(),
+    additionalProperties: effect_1.Option.some(false),
+    allOf: effect_1.Option.none(),
+    anyOf: effect_1.Option.none(),
+    oneOf: effect_1.Option.none(),
+    not: effect_1.Option.none(),
+    in: effect_1.Option.none(),
+    default: effect_1.Option.none(),
+    nullable: effect_1.Option.none(),
+    enum: effect_1.Option.none(),
 });
 const getApplicationJsonMediaType = (content) => {
-    if (!Object.keys(content).length)
-        return E.right({ schema: O.none });
+    if (!Object.keys(content).length) {
+        return effect_1.Either.right({ schema: effect_1.Option.none() });
+    }
     // TODO: we should support any value here, but there may also be more than 1 media type so we need to iterate through
     // and combine all the schemas within into a single set of inputs
     const mediaTypeApplicationJson = Object.keys(content).find((mediaType) => /^application\/.*json$/.test(mediaType));
     if (mediaTypeApplicationJson) {
-        return E.right(content[mediaTypeApplicationJson]);
+        return effect_1.Either.right(content[mediaTypeApplicationJson]);
     }
     const mediaTypes = Object.keys(content);
-    return E.left(new Error(`Unsupported media type: ${mediaTypes}`));
+    return effect_1.Either.left(new Error(`Unsupported media type: ${mediaTypes}`));
 };
 const generateInputSchema = (endpoint) => {
-    const parameters = O.toNullable(endpoint.parameters);
-    const requestBody = O.toNullable(endpoint.requestBody);
+    const parameters = effect_1.Option.getOrNull(endpoint.parameters);
+    const requestBody = effect_1.Option.getOrNull(endpoint.requestBody);
     if (parameters && !requestBody) {
-        return E.right(transformInput(parameters));
+        return effect_1.Either.right(transformInput(parameters));
     }
     if (requestBody && !parameters) {
-        return (0, function_1.pipe)(getApplicationJsonMediaType(requestBody.content), E.map((mediaTypeObject) => O.fold(() => blankOutputSchema(), (schema) => appendInPropertyToBody(schema))(mediaTypeObject.schema)));
+        return (0, effect_1.pipe)(getApplicationJsonMediaType(requestBody.content), effect_1.Either.map((mediaTypeObject) => effect_1.Option.match(mediaTypeObject.schema, {
+            onNone: () => blankOutputSchema(),
+            onSome: (schema) => appendInPropertyToBody(schema),
+        })));
     }
     if (requestBody && parameters) {
         const params = transformInput(parameters);
-        return (0, function_1.pipe)(getApplicationJsonMediaType(requestBody.content), E.map((mediaTypeObject) => O.fold(() => blankOutputSchema(), (schema) => appendInPropertyToBody(schema))(mediaTypeObject.schema)), E.chain((schema) => E.right(mergeParamsAndBody(params, schema))));
+        return (0, effect_1.pipe)(getApplicationJsonMediaType(requestBody.content), effect_1.Either.map((mediaTypeObject) => effect_1.Option.match(mediaTypeObject.schema, {
+            onNone: () => blankOutputSchema(),
+            onSome: (schema) => appendInPropertyToBody(schema),
+        })), effect_1.Either.flatMap((schema) => effect_1.Either.right(mergeParamsAndBody(params, schema))));
     }
-    return E.right(blankOutputSchema());
+    return effect_1.Either.right(blankOutputSchema());
 };
 exports.generateInputSchema = generateInputSchema;