Skip to content

feat: support date type #100

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.

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

Merged
merged 1 commit into from
Jan 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions src/language/typescript/2.0/serializers/swagger-object.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { clientFile } from '../../common/bundled/client';
import { serializeParametersDefinitionsObject } from './parameters-definitions-object';
import { combineReader } from '@devexperts/utils/dist/adt/reader.utils';
import { serializeResponsesDefinitionsObject } from './responses-definitions-object';
import { utilsFile } from '../../common/bundled/utils';

const definitionsRef = fromString('#/definitions');
const parametersRef = fromString('#/parameters');
Expand Down Expand Up @@ -52,8 +53,8 @@ export const serializeSwaggerObject = combineReader(
pathsRef,
either.chain(from => serializePaths(from, swaggerObject.paths)),
);
return combineEither(additional, paths, clientFile, (additional, paths, clientFile) =>
directory(name, [clientFile, ...additional, paths]),
return combineEither(additional, paths, clientFile, utilsFile, (additional, paths, clientFile, utilsFile) =>
directory(name, [clientFile, ...additional, utilsFile, paths]),
);
},
);
6 changes: 4 additions & 2 deletions src/language/typescript/3.0/serializers/document.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { OpenapiObject } from '../../../../schema/3.0/openapi-object';
import { pathsRef } from '../../common/utils';
import { clientFile } from '../../common/bundled/client';
import { openapi3utilsFile } from '../bundled/openapi-3-utils';
import { utilsFile } from '../../common/bundled/utils';

export const serializeDocument = combineReader(
serializeComponentsObject,
Expand All @@ -36,9 +37,10 @@ export const serializeDocument = combineReader(
paths,
additional,
clientFile,
utilsFile,
openapi3utilsFile,
(paths, additional, clientFile, openapi3utilsFile) =>
directory(name, [paths, ...additional, clientFile, openapi3utilsFile]),
(paths, additional, clientFile, utilsFile, openapi3utilsFile) =>
directory(name, [paths, ...additional, clientFile, utilsFile, openapi3utilsFile]),
);
},
);
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { array, either, option } from 'fp-ts';
import { combineEither, sequenceEither } from '@devexperts/utils/dist/adt/either.utils';
import { serializeChannelsObject } from './channels-object';
import { clientFile } from '../../common/bundled/client';
import { utilsFile } from '../../common/bundled/utils';

export const serializeAsyncAPIObject = combineReader(
serializeComponentsObject,
Expand All @@ -29,8 +30,13 @@ export const serializeAsyncAPIObject = combineReader(
either.chain(from => serializeChannelsObject(from, asyncAPIObject.channels)),
either.map(content => directory('channels', [content])),
);
return combineEither(channels, additional, clientFile, (channels, additional, clientFile) =>
directory(name, [channels, clientFile, ...additional]),
return combineEither(
channels,
additional,
clientFile,
utilsFile,
(channels, additional, clientFile, utilsFile) =>
directory(name, [channels, clientFile, ...additional, utilsFile]),
);
},
);
32 changes: 32 additions & 0 deletions src/language/typescript/common/bundled/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,38 @@ import { fromRef } from '../../../../utils/fs';
export const utilsRef = fromString('#/utils/utils');

const utils = `
import { either } from 'fp-ts/lib/Either';
import { Type, failure, success, string as tstring } from 'io-ts';

const getISOTimezoneOffsetString = (offsetMinutes: number): string => {
if (offsetMinutes === 0) {
return 'Z';
}

const absoluteOffsetMinutes = Math.abs(offsetMinutes);
const offsetHours = absoluteOffsetMinutes / 60;
const offsetRestMinutes = absoluteOffsetMinutes % 60;

return \`\${offsetMinutes > 0 ? '-' : '+'}\${offsetHours
.toString()
.padStart(2, '0')}:\${offsetRestMinutes.toString().padStart(2, '0')}\`;
};

export const DateFromISODateStringIO = new Type<Date, string, unknown>(
'DateFromISODateString',
(u): u is Date => u instanceof Date,
(u, c) =>
either.chain(tstring.validate(u, c), s => {
const offset = new Date().getTimezoneOffset();
const d = new Date(\`\${s}T00:00:00\${getISOTimezoneOffsetString(offset)}\`);
return isNaN(d.getTime()) ? failure(u, c) : success(d);
}),
a =>
\`\${a.getFullYear()}-\${(a.getMonth() + 1).toString().padStart(2, '0')}-\${a
.getDate()
.toString()
.padStart(2, '0')}\`,
);
`;

export const utilsFile = pipe(
Expand Down
12 changes: 10 additions & 2 deletions src/language/typescript/common/data/serialized-type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,20 +73,28 @@ export const SERIALIZED_BOOLEAN_TYPE = serializedType(
);
export const SERIALIZED_NUMBER_TYPE = serializedType('number', 'number', [serializedDependency('number', 'io-ts')], []);
export const SERIALIZED_INTEGER_TYPE = serializedType('Int', 'Int', [serializedDependency('Int', 'io-ts')], []);
export const SERIALIZED_DATE_TYPE = serializedType(
export const SERIALIZED_DATETIME_TYPE = serializedType(
'Date',
'DateFromISOString',
[serializedDependency('DateFromISOString', 'io-ts-types/lib/DateFromISOString')],
[],
);
export const SERIALIZED_DATE_TYPE = serializedType(
'Date',
'DateFromISODateStringIO',
[serializedDependency('DateFromISODateStringIO', '../utils/utils')],
[],
);
export const SERIALIZED_STRING_TYPE = serializedType('string', 'string', [serializedDependency('string', 'io-ts')], []);
export const getSerializedStringType = (format: Option<string>): SerializedType => {
return pipe(
format,
option.chain(format => {
// https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14
switch (format) {
case 'date-time':
case 'date-time': {
return some(SERIALIZED_DATETIME_TYPE);
}
case 'date': {
return some(SERIALIZED_DATE_TYPE);
}
Expand Down
14 changes: 10 additions & 4 deletions test/specs/2.0/json/common.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"format": "int32"
},
"shipDate": {
"type": "string",
"format": "date"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
},
Expand All @@ -34,10 +38,12 @@
"delivered"
]
},
"state" : {
"type" : "string",
"description" : "order state",
"enum" : [ "ACTIVE" ]
"state": {
"type": "string",
"description": "order state",
"enum": [
"ACTIVE"
]
},
"complete": {
"type": "boolean",
Expand Down
3 changes: 3 additions & 0 deletions test/specs/2.0/yaml/common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ definitions:
type: integer
format: int32
shipDate:
type: string
format: date
lastUpdate:
type: string
format: date-time
status:
Expand Down