Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Customize codecs #176

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Customize codecs #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f19cd6
fix: upgrading some vulnerable deps
kokovtsev Jul 8, 2022
95cd473
feat: make codec generation customizable via context
kokovtsev Jul 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 20 additions & 14 deletions src/language/typescript/3.0/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,33 @@ import { format } from 'prettier';
import { fragment, FSEntity, map as mapFS } from '../../../utils/fs';
import { Either } from 'fp-ts/lib/Either';
import { pipe } from 'fp-ts/lib/pipeable';
import { combineReader } from '@devexperts/utils/dist/adt/reader.utils';
import { combineReader, deferReader } from '@devexperts/utils/dist/adt/reader.utils';
import { either, record } from 'fp-ts';
import { Dictionary } from '../../../utils/types';
import { sequenceEither } from '@devexperts/utils/dist/adt/either.utils';
import { OpenapiObject } from '../../../schema/3.0/openapi-object';
import { defaultPrettierConfig, SerializeOptions } from '../common/utils';
import { serializePrimitiveDefault } from './serializers/schema-object';

export { serializeDocument } from './serializers/document';

export const serialize = combineReader(
serializeDocument,
serializeDocument => (
documents: Dictionary<OpenapiObject>,
options: SerializeOptions = {},
): Either<Error, FSEntity> =>
pipe(
documents,
record.collect(serializeDocument),
sequenceEither,
either.map(e =>
mapFS(fragment(e), content => format(content, options.prettierConfig || defaultPrettierConfig)),
export const serializeCustom = pipe(
combineReader(
serializeDocument,
serializeDocument => (
documents: Dictionary<OpenapiObject>,
options: SerializeOptions = {},
): Either<Error, FSEntity> =>
pipe(
documents,
record.collect(serializeDocument),
sequenceEither,
either.map(e =>
mapFS(fragment(e), content => format(content, options.prettierConfig || defaultPrettierConfig)),
),
),
),
),
reader => deferReader(reader, 'resolveRef'),
);

export const serialize = serializeCustom({ serializePrimitive: serializePrimitiveDefault });
32 changes: 22 additions & 10 deletions src/language/typescript/3.0/serializers/__tests__/schema-object.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { serializeSchemaObject } from '../schema-object';
import { serializeSchemaObjectDefault } from '../schema-object';
import {
getSerializedArrayType,
getSerializedDictionaryType,
Expand Down Expand Up @@ -50,7 +50,7 @@ describe('SchemaObject', () => {
},
],
});
const serialized = pipe(schema, reportIfFailed, either.chain(serializeSchemaObject(ref)));
const serialized = pipe(schema, reportIfFailed, either.chain(serializeSchemaObjectDefault(ref)));
pipe(
serialized,
either.fold(fail, result => {
Expand Down Expand Up @@ -85,10 +85,10 @@ describe('SchemaObject', () => {
property($refArbitrary, schema, string(), (from, schema, name) => {
const expected = pipe(
schema.items,
serializeSchemaObject(from, name),
serializeSchemaObjectDefault(from, name),
either.map(getSerializedArrayType(none, name)),
);
const serialized = pipe(schema, serializeSchemaObject(from, name));
const serialized = pipe(schema, serializeSchemaObjectDefault(from, name));
expect(serialized).toEqual(expected);
}),
);
Expand All @@ -107,9 +107,9 @@ describe('SchemaObject', () => {
getSerializedRefType(from),
getSerializedArrayType(none, name),
);
expect(pipe(schema, reportIfFailed, either.chain(serializeSchemaObject(from, name)))).toEqual(
right(expected),
);
expect(
pipe(schema, reportIfFailed, either.chain(serializeSchemaObjectDefault(from, name))),
).toEqual(right(expected));
}),
);
});
Expand Down Expand Up @@ -138,7 +138,11 @@ describe('SchemaObject', () => {
getSerializedObjectType(undefined),
getSerializedRecursiveType(ref, true),
);
const serialized = pipe(schema, reportIfFailed, either.chain(serializeSchemaObject(ref)));
const serialized = pipe(
schema,
reportIfFailed,
either.chain(serializeSchemaObjectDefault(ref)),
);

expect(serialized).toEqual(right(expected));
}),
Expand All @@ -162,7 +166,11 @@ describe('SchemaObject', () => {
},
},
});
const serialized = pipe(schema, reportIfFailed, either.chain(serializeSchemaObject(ref)));
const serialized = pipe(
schema,
reportIfFailed,
either.chain(serializeSchemaObjectDefault(ref)),
);
const expected = pipe(
ref,
getSerializedRefType(ref),
Expand All @@ -185,7 +193,11 @@ describe('SchemaObject', () => {
$ref: ref.$ref, // references self
},
});
const serialized = pipe(schema, reportIfFailed, either.chain(serializeSchemaObject(ref)));
const serialized = pipe(
schema,
reportIfFailed,
either.chain(serializeSchemaObjectDefault(ref)),
);

const expected = pipe(
ref,
Expand Down
128 changes: 78 additions & 50 deletions src/language/typescript/3.0/serializers/components-object.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,30 +19,37 @@ import { combineReader } from '@devexperts/utils/dist/adt/reader.utils';
import { RequestBodyObject, RequestBodyObjectCodec } from '../../../../schema/3.0/request-body-object';
import { serializeRequestBodyObject } from './request-body-object';

const serializeSchema = (from: Ref, schema: SchemaObject): Either<Error, File> => {
const typeName = getTypeName(from.name);
const ioName = getIOName(from.name);
const serialized = pipe(schema, serializeSchemaObject(from, typeName));
const dependencies = pipe(
serialized,
either.map(serialized => serializeDependencies(serialized.dependencies)),
);
return combineEither(serialized, dependencies, (serialized, dependencies) =>
file(
`${from.name}.ts`,
`
const serializeSchema = combineReader(
serializeSchemaObject,
serializeSchemaObject => (from: Ref, schema: SchemaObject): Either<Error, File> => {
const typeName = getTypeName(from.name);
const ioName = getIOName(from.name);
const serialized = pipe(schema, serializeSchemaObject(from, typeName));
const dependencies = pipe(
serialized,
either.map(serialized => serializeDependencies(serialized.dependencies)),
);
return combineEither(serialized, dependencies, (serialized, dependencies) =>
file(
`${from.name}.ts`,
`
${dependencies}

export type ${typeName} = ${serialized.type};
export const ${ioName} = ${serialized.io};
`,
),
);
};
),
);
},
);

const serializeSchemas = combineReader(
context,
e => (from: Ref, schemas: Record<string, ReferenceObject | SchemaObject>): Either<Error, FSEntity> =>
serializeSchema,
(e, serializeSchema) => (
from: Ref,
schemas: Record<string, ReferenceObject | SchemaObject>,
): Either<Error, FSEntity> =>
pipe(
schemas,
record.collect((name, schema) => {
Expand All @@ -60,27 +67,34 @@ const serializeSchemas = combineReader(
),
);

const serializeParameter = (from: Ref, parameterObject: ParameterObject): Either<Error, File> =>
pipe(
serializeParameterObject(from, parameterObject),
either.map(serialized => {
const dependencies = serializeDependencies(serialized.dependencies);
const serializeParameter = combineReader(
serializeParameterObject,
serializeParameterObject => (from: Ref, parameterObject: ParameterObject): Either<Error, File> =>
pipe(
serializeParameterObject(from, parameterObject),
either.map(serialized => {
const dependencies = serializeDependencies(serialized.dependencies);

return file(
`${from.name}.ts`,
`
return file(
`${from.name}.ts`,
`
${dependencies}

export type ${getTypeName(from.name)} = ${serialized.type};
export const ${getIOName(from.name)} = ${serialized.io};
`,
);
}),
);
);
}),
),
);

const serializeParameters = combineReader(
context,
e => (from: Ref, parameters: Record<string, ReferenceObject | ParameterObject>): Either<Error, FSEntity> =>
serializeParameter,
(e, serializeParameter) => (
from: Ref,
parameters: Record<string, ReferenceObject | ParameterObject>,
): Either<Error, FSEntity> =>
pipe(
parameters,
record.collect((name, parameter) => {
Expand All @@ -98,28 +112,35 @@ const serializeParameters = combineReader(
),
);

const serializeResponse = (from: Ref, responseObject: ResponseObject): Either<Error, File> =>
pipe(
serializeResponseObject(from, responseObject),
option.getOrElse(() => right(SERIALIZED_VOID_TYPE)),
either.map(serialized => {
const dependencies = serializeDependencies(serialized.dependencies);
const serializeResponse = combineReader(
serializeResponseObject,
serializeResponseObject => (from: Ref, responseObject: ResponseObject): Either<Error, File> =>
pipe(
serializeResponseObject(from, responseObject),
option.getOrElse(() => right(SERIALIZED_VOID_TYPE)),
either.map(serialized => {
const dependencies = serializeDependencies(serialized.dependencies);

return file(
`${from.name}.ts`,
`
return file(
`${from.name}.ts`,
`
${dependencies}

export type ${getTypeName(from.name)} = ${serialized.type};
export const ${getIOName(from.name)} = ${serialized.io};
`,
);
}),
);
);
}),
),
);

const serializeResponses = combineReader(
context,
e => (from: Ref, responses: Record<string, ReferenceObject | ResponseObject>): Either<Error, FSEntity> =>
serializeResponse,
(e, serializeResponse) => (
from: Ref,
responses: Record<string, ReferenceObject | ResponseObject>,
): Either<Error, FSEntity> =>
pipe(
responses,
record.collect((name, response) => {
Expand All @@ -137,25 +158,32 @@ const serializeResponses = combineReader(
),
);

const serializeRequestBody = (from: Ref, requestBody: RequestBodyObject): Either<Error, FSEntity> =>
pipe(
serializeRequestBodyObject(from, requestBody),
either.map(serialized =>
file(
`${from.name}.ts`,
`
const serializeRequestBody = combineReader(
serializeRequestBodyObject,
serializeRequestBodyObject => (from: Ref, requestBody: RequestBodyObject): Either<Error, FSEntity> =>
pipe(
serializeRequestBodyObject(from, requestBody),
either.map(serialized =>
file(
`${from.name}.ts`,
`
${serializeDependencies(serialized.dependencies)}

export type ${getTypeName(from.name)} = ${serialized.type};
export const ${getIOName(from.name)} = ${serialized.io};
`,
),
),
),
);
);

const serializeRequestBodies = combineReader(
context,
e => (from: Ref, requestBodies: Record<string, ReferenceObject | RequestBodyObject>): Either<Error, FSEntity> => {
serializeRequestBody,
(e, serializeRequestBody) => (
from: Ref,
requestBodies: Record<string, ReferenceObject | RequestBodyObject>,
): Either<Error, FSEntity> => {
return pipe(
requestBodies,
record.collect((name, requestBody) => {
Expand Down
11 changes: 9 additions & 2 deletions src/language/typescript/3.0/serializers/operation-object.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,13 @@ const contains = array.elem(eqParameterByNameAndIn);

export const getParameters = combineReader(
ask<ResolveRefContext>(),
e => (from: Ref, operation: OperationObject, pathItem: PathItemObject): Either<Error, Parameters> => {
serializeParameterObject,
serializeRequestBodyObject,
(e, serializeParameterObject, serializeRequestBodyObject) => (
from: Ref,
operation: OperationObject,
pathItem: PathItemObject,
): Either<Error, Parameters> => {
const processedParameters: ParameterObject[] = [];
const pathParameters: ParameterObject[] = [];
const serializedPathParameters: SerializedPathParameter[] = [];
Expand Down Expand Up @@ -258,7 +264,8 @@ export const getParameters = combineReader(
export const serializeOperationObject = combineReader(
ask<ResolveRefContext>(),
getParameters,
(e, getParameters) => (
serializeResponsesObject,
(e, getParameters, serializeResponsesObject) => (
pattern: string,
method: HTTPMethod,
from: Ref,
Expand Down
31 changes: 16 additions & 15 deletions src/language/typescript/3.0/serializers/parameter-object.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,28 @@ import {
} from '../../common/data/serialized-fragment';
import { serializedDependency } from '../../common/data/serialized-dependency';
import { openapi3utilsRef } from '../bundled/openapi-3-utils';
import { combineReader } from '@devexperts/utils/dist/adt/reader.utils';

const forParameter = (parameter: ParameterObject): string => `for parameter "${parameter.name}" in "${parameter.in}"`;

export const isRequired = (parameter: ParameterObject): boolean =>
parameter.in === 'path' ? parameter.required : pipe(parameter.required, option.getOrElse(constFalse));

export const serializeParameterObject = (
from: Ref,
parameterObject: ParameterObject,
): Either<Error, SerializedParameter> =>
pipe(
getParameterObjectSchema(parameterObject),
either.chain(schema => {
if (ReferenceObjectCodec.is(schema)) {
return pipe(fromString(schema.$ref), either.map(getSerializedRefType(from)));
} else {
return pipe(schema, serializeSchemaObject(from));
}
}),
either.map(fromSerializedType(isRequired(parameterObject))),
);
export const serializeParameterObject = combineReader(
serializeSchemaObject,
serializeSchemaObject => (from: Ref, parameterObject: ParameterObject): Either<Error, SerializedParameter> =>
pipe(
getParameterObjectSchema(parameterObject),
either.chain(schema => {
if (ReferenceObjectCodec.is(schema)) {
return pipe(fromString(schema.$ref), either.map(getSerializedRefType(from)));
} else {
return pipe(schema, serializeSchemaObject(from));
}
}),
either.map(fromSerializedType(isRequired(parameterObject))),
),
);

export const getParameterObjectSchema = (
parameterObject: ParameterObject,
Expand Down
Loading
Loading