refactor: use Integer type from io-ts (#84)

BREAKING CHANGE: removed empty utils file

Author: raveclassic

src/language/typescript/2.0/serializers/items-object.ts

@@ -1,14 +1,13 @@
 import { ItemsObject } from '../../../../schema/2.0/items-object';
 import {
 	getSerializedArrayType,
-	getSerializedIntegerType,
 	getSerializedStringType,
 	SERIALIZED_BOOLEAN_TYPE,
+	SERIALIZED_INTEGER_TYPE,
 	SERIALIZED_NUMBER_TYPE,
 	SerializedType,
 } from '../../common/data/serialized-type';
 import { Ref } from '../../../../utils/ref';
-import { utilsRef } from '../../common/bundled/utils';
 import { pipe } from 'fp-ts/lib/pipeable';
 import { either } from 'fp-ts';
 import { Either, right } from 'fp-ts/lib/Either';
@@ -28,10 +27,7 @@ export const serializeItemsObject = (from: Ref, itemsObject: ItemsObject): Eithe
 			return right(SERIALIZED_NUMBER_TYPE);
 		}
 		case 'integer': {
-			return pipe(
-				utilsRef,
-				either.map(utilsRef => getSerializedIntegerType(from, utilsRef)),
-			);
+			return right(SERIALIZED_INTEGER_TYPE);
 		}
 		case 'boolean': {
 			return right(SERIALIZED_BOOLEAN_TYPE);

src/language/typescript/2.0/serializers/parameter-object.ts

@@ -2,9 +2,9 @@ import { Ref } from '../../../../utils/ref';
 import { ParameterObject } from '../../../../schema/2.0/parameter-object';
 import {
 	getSerializedArrayType,
-	getSerializedIntegerType,
 	getSerializedStringType,
 	SERIALIZED_BOOLEAN_TYPE,
+	SERIALIZED_INTEGER_TYPE,
 	SERIALIZED_NUMBER_TYPE,
 	SERIALIZED_UNKNOWN_TYPE,
 } from '../../common/data/serialized-type';
@@ -15,7 +15,6 @@ import { fromSerializedType, SerializedParameter } from '../../common/data/seria
 import { pipe } from 'fp-ts/lib/pipeable';
 import { either, option } from 'fp-ts';
 import { constFalse } from 'fp-ts/lib/function';
-import { utilsRef } from '../../common/bundled/utils';
 
 export const serializeParameterObject = (
 	from: Ref,
@@ -35,10 +34,7 @@ export const serializeParameterObject = (
 					return right(toSerializedParameter(SERIALIZED_NUMBER_TYPE));
 				}
 				case 'integer': {
-					return pipe(
-						utilsRef,
-						either.map(utilsRef => toSerializedParameter(getSerializedIntegerType(from, utilsRef))),
-					);
+					return right(toSerializedParameter(SERIALIZED_INTEGER_TYPE));
 				}
 				case 'boolean': {
 					return right(toSerializedParameter(SERIALIZED_BOOLEAN_TYPE));

src/language/typescript/2.0/serializers/schema-object.ts

@@ -13,8 +13,8 @@ import {
 	getSerializedIntersectionType,
 	getSerializedEnumType,
 	SERIALIZED_NULL_TYPE,
-	getSerializedIntegerType,
 	getSerializedStringType,
+	SERIALIZED_INTEGER_TYPE,
 } from '../../common/data/serialized-type';
 import { serializedDependency } from '../../common/data/serialized-dependency';
 import {
@@ -33,7 +33,6 @@ import { either, option, record } from 'fp-ts';
 import { traverseNEAEither } from '../../../../utils/either';
 import { ReferenceObject, ReferenceObjectCodec } from '../../../../schema/2.0/reference-object';
 import { NonEmptyArray } from 'fp-ts/lib/NonEmptyArray';
-import { utilsRef } from '../../common/bundled/utils';
 
 export const serializeSchemaObject = (from: Ref, schema: SchemaObject): Either<Error, SerializedType> =>
 	serializeSchemaObjectWithRecursion(from, schema, true);
@@ -149,10 +148,7 @@ const serializePrimitive = (from: Ref, schemaObject: PrimitiveSchemaObject): Eit
 			return right(SERIALIZED_NUMBER_TYPE);
 		}
 		case 'integer': {
-			return pipe(
-				utilsRef,
-				either.map(utilsRef => getSerializedIntegerType(from, utilsRef)),
-			);
+			return right(SERIALIZED_INTEGER_TYPE);
 		}
 		case 'boolean': {
 			return right(SERIALIZED_BOOLEAN_TYPE);

src/language/typescript/2.0/serializers/swagger-object.ts

@@ -12,7 +12,6 @@ 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');
@@ -57,8 +56,8 @@ export const serializeSwaggerObject = combineReader(
 			pathsRef,
 			either.chain(from => serializePaths(from, swaggerObject.paths)),
 		);
-		return combineEither(additional, paths, clientFile, utilsFile, (additional, paths, clientFile, utilsFile) =>
-			directory(name, [clientFile, utilsFile, ...additional, paths]),
+		return combineEither(additional, paths, clientFile, (additional, paths, clientFile) =>
+			directory(name, [clientFile, ...additional, paths]),
 		);
 	},
 );

src/language/typescript/3.0/serializers/document.ts

@@ -11,7 +11,6 @@ import { applyTo } from '../../../../utils/function';
 import { OpenapiObject } from '../../../../schema/3.0/openapi-object';
 import { pathsRef } from '../../common/utils';
 import { clientFile } from '../../common/bundled/client';
-import { utilsFile } from '../../common/bundled/utils';
 import { openapi3utilsFile } from '../bundled/openapi-3-utils';
 
 export const serializeDocument = combineReader(
@@ -48,10 +47,9 @@ export const serializeDocument = combineReader(
 			paths,
 			additional,
 			clientFile,
-			utilsFile,
 			openapi3utilsFile,
-			(paths, additional, clientFile, utilsFile, openapi3utilsFile) =>
-				directory(name, [paths, ...additional, clientFile, utilsFile, openapi3utilsFile]),
+			(paths, additional, clientFile, openapi3utilsFile) =>
+				directory(name, [paths, ...additional, clientFile, openapi3utilsFile]),
 		);
 	},
 );

src/language/typescript/3.0/serializers/schema-object.ts

@@ -2,7 +2,6 @@ import {
 	getSerializedArrayType,
 	getSerializedDictionaryType,
 	getSerializedEnumType,
-	getSerializedIntegerType,
 	getSerializedIntersectionType,
 	getSerializedObjectType,
 	getSerializedOptionPropertyType,
@@ -12,6 +11,7 @@ import {
 	getSerializedUnionType,
 	intercalateSerializedTypes,
 	SERIALIZED_BOOLEAN_TYPE,
+	SERIALIZED_INTEGER_TYPE,
 	SERIALIZED_NUMBER_TYPE,
 	SERIALIZED_UNKNOWN_TYPE,
 	SerializedType,
@@ -35,7 +35,6 @@ import {
 import { ReferenceObject, ReferenceObjectCodec } from '../../../../schema/3.0/reference-object';
 import { traverseNEAEither } from '../../../../utils/either';
 import { NonEmptyArray } from 'fp-ts/lib/NonEmptyArray';
-import { utilsRef } from '../../common/bundled/utils';
 
 type AdditionalProperties = boolean | ReferenceObject | SchemaObject;
 type AllowedAdditionalProperties = true | ReferenceObject | SchemaObject;
@@ -199,10 +198,7 @@ const serializePrimitive = (from: Ref, schemaObject: PrimitiveSchemaObject): Eit
 			return right(SERIALIZED_NUMBER_TYPE);
 		}
 		case 'integer': {
-			return pipe(
-				utilsRef,
-				either.map(utilsRef => getSerializedIntegerType(from, utilsRef)),
-			);
+			return right(SERIALIZED_INTEGER_TYPE);
 		}
 		case 'boolean': {
 			return right(SERIALIZED_BOOLEAN_TYPE);

src/language/typescript/asyncapi-2.0.0/serializers/asyncapi-object.ts

@@ -9,7 +9,6 @@ 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,
@@ -33,13 +32,8 @@ export const serializeAsyncAPIObject = combineReader(
 			either.chain(from => serializeChannelsObject(from, asyncAPIObject.channels)),
 			either.map(content => directory('channels', [content])),
 		);
-		return combineEither(
-			channels,
-			additional,
-			clientFile,
-			utilsFile,
-			(channels, additional, clientFile, utilsFile) =>
-				directory(name, [channels, clientFile, utilsFile, ...additional]),
+		return combineEither(channels, additional, clientFile, (channels, additional, clientFile) =>
+			directory(name, [channels, clientFile, ...additional]),
 		);
 	},
 );

src/language/typescript/asyncapi-2.0.0/serializers/schema-object.ts

@@ -19,7 +19,7 @@ import {
 	SerializedType,
 	getSerializedEnumType,
 	getSerializedStringType,
-	getSerializedIntegerType,
+	SERIALIZED_INTEGER_TYPE,
 } from '../../common/data/serialized-type';
 import {
 	AllOfSchemaObjectCodec,
@@ -37,7 +37,6 @@ import { traverseNEAEither } from '../../../../utils/either';
 import { constFalse } from 'fp-ts/lib/function';
 import { sequenceEither } from '@devexperts/utils/dist/adt/either.utils';
 import { Option } from 'fp-ts/lib/Option';
-import { utilsRef } from '../../common/bundled/utils';
 
 export const serializeSchemaObject = (
 	from: Ref,
@@ -77,10 +76,7 @@ const serializeSchemaObjectWithRecursion = (
 			return right(SERIALIZED_NUMBER_TYPE);
 		}
 		case 'integer': {
-			return pipe(
-				utilsRef,
-				either.map(utilsRef => getSerializedIntegerType(from, utilsRef)),
-			);
+			return right(SERIALIZED_INTEGER_TYPE);
 		}
 		case 'boolean': {
 			return right(SERIALIZED_BOOLEAN_TYPE);

src/language/typescript/common/bundled/utils.ts

@@ -6,35 +6,6 @@ import { fromRef } from '../../../../utils/fs';
 export const utilsRef = fromString('#/utils/utils');
 
 const utils = `
-	import { brand, Branded, intersection, number, string, success, Type } from 'io-ts';
-
-	export interface IntegerBrand {
-		readonly Integer: unique symbol;
-	}
-	export type Integer = Branded<number, IntegerBrand>;
-	export const integer: Type<Integer, number> = brand(
-		number,
-		(n): n is Integer => n !== -Infinity && n !== Infinity && Math.floor(n) === n,
-		'Integer',
-	);
-	
-	export interface NonNegativeBrand {
-		readonly NonNegative: unique symbol;
-	}
-	export type NonNegative = Branded<number, NonNegativeBrand>;
-	export const nonNegative: Type<NonNegative, number> = brand(number, (n): n is NonNegative => n >= 0.0, 'NonNegative');
-	
-	export interface PositiveBrand {
-		readonly Positive: unique symbol;
-	}
-	export type Positive = Branded<number, PositiveBrand>;
-	export const positive: Type<Positive, number> = brand(number, (n): n is Positive => n > 0.0, 'Positive');
-	
-	export type Natural = NonNegative & Integer;
-	export const natural: Type<Natural, number> = intersection([nonNegative, integer], 'Natural');
-	
-	export const split = (separator: string): Type<string[], string, string> =>
-		new Type('Split', (u): u is string[] => string.is(u), u => success(u.split(separator)), as => as.join(separator));
 `;
 
 export const utilsFile = pipe(

src/language/typescript/common/data/__tests__/serialized-type.spec.ts

@@ -16,7 +16,7 @@ import { getRelativePath } from '../../../../../utils/ref';
 import { pipe } from 'fp-ts/lib/pipeable';
 import { arbitrary, nonEmptyArray } from '../../../../../utils/fast-check';
 import { none, some } from 'fp-ts/lib/Option';
-import { getIOName, getTypeName } from '../../utils';
+import { getIOName, getTypeName, UNSAFE_PROPERTY_PATTERN } from '../../utils';
 import { when } from '../../../../../utils/string';
 import { head } from 'fp-ts/lib/NonEmptyArray';
 
@@ -55,17 +55,12 @@ describe('SerializedType', () => {
 		assert(
 			property(string(), serializedTypeArbitrary, boolean(), (name, s, isRequired) => {
 				const serialized = getSerializedOptionPropertyType(name, isRequired)(s);
-				const fixedName = (name: string) => (name.includes('-') ? `['${name}']` : name);
+				const safeName = UNSAFE_PROPERTY_PATTERN.test(name) ? `['${name}']` : name;
 				const expected = isRequired
-					? serializedType(
-							`${fixedName(name)}: ${s.type}`,
-							`${fixedName(name)}: ${s.io}`,
-							s.dependencies,
-							s.refs,
-					  )
+					? serializedType(`${safeName}: ${s.type}`, `${safeName}: ${s.io}`, s.dependencies, s.refs)
 					: serializedType(
-							`${fixedName(name)}: Option<${s.type}>`,
-							`${fixedName(name)}: optionFromNullable(${s.io})`,
+							`${safeName}: Option<${s.type}>`,
+							`${safeName}: optionFromNullable(${s.io})`,
 							[
 								...s.dependencies,
 								serializedDependency('Option', 'fp-ts/lib/Option'),

src/language/typescript/common/data/serialized-type.ts

@@ -11,7 +11,7 @@ import { intercalate } from 'fp-ts/lib/Foldable';
 import { array, getMonoid, uniq } from 'fp-ts/lib/Array';
 import { Eq, eqString, getStructEq } from 'fp-ts/lib/Eq';
 import { getRelativePath, Ref, uniqRefs } from '../../../../utils/ref';
-import { getIOName, getTypeName } from '../utils';
+import { getIOName, getTypeName, UNSAFE_PROPERTY_PATTERN } from '../utils';
 import { concatIfL } from '../../../../utils/array';
 import { when } from '../../../../utils/string';
 import { head, NonEmptyArray } from 'fp-ts/lib/NonEmptyArray';
@@ -72,15 +72,7 @@ export const SERIALIZED_BOOLEAN_TYPE = serializedType(
 	[],
 );
 export const SERIALIZED_NUMBER_TYPE = serializedType('number', 'number', [serializedDependency('number', 'io-ts')], []);
-export const getSerializedIntegerType = (from: Ref, utilsRef: Ref): SerializedType => {
-	const pathToUtils = getRelativePath(from, utilsRef);
-	return serializedType(
-		'Integer',
-		'integer',
-		[serializedDependency('Integer', pathToUtils), serializedDependency('integer', pathToUtils)],
-		[],
-	);
-};
+export const SERIALIZED_INTEGER_TYPE = serializedType('Int', 'Int', [serializedDependency('Int', 'io-ts')], []);
 export const SERIALIZED_DATE_TYPE = serializedType(
 	'Date',
 	'DateFromISOString',
@@ -218,13 +210,15 @@ export const getSerializedPropertyType = (
 	name: string,
 	isRequired: boolean,
 	serialized: SerializedType,
-): SerializedType =>
-	serializedType(
-		`${name.includes('-') ? `['${name}']` : name}${when(!isRequired, '?')}: ${serialized.type}`,
-		`${name.includes('-') ? `['${name}']` : name}: ${serialized.io}`,
+): SerializedType => {
+	const safeName = UNSAFE_PROPERTY_PATTERN.test(name) ? `['${name}']` : name;
+	return serializedType(
+		`${safeName}${when(!isRequired, '?')}: ${serialized.type}`,
+		`${safeName}: ${serialized.io}`,
 		serialized.dependencies,
 		serialized.refs,
 	);
+};
 
 export const getSerializedOptionPropertyType = (name: string, isRequired: boolean) => (
 	serialized: SerializedType,

src/language/typescript/common/utils.ts

@@ -22,7 +22,7 @@ export const getURL = (pattern: string, pathParameters: SerializedPathParameter[
 export const getJSDoc = (lines: string[]): string =>
 	unless(
 		lines.length === 0,
-		`/** 
+		`/**
 			 ${lines.map(line => `* ${line}`).join('\n')}
 		 */`,
 	);
@@ -65,5 +65,7 @@ export const getKindValue = (kind: Kind, value: string): string => {
 
 export const getControllerName = (name: string): string => `${name}Controller`;
 
+export const UNSAFE_PROPERTY_PATTERN = /[^a-zA-Z_0-9]/;
+const REPLACE_PATTERN = new RegExp(UNSAFE_PROPERTY_PATTERN, 'g');
 export const getSafePropertyName = (value: string): string =>
-	value.replace(/[^a-zA-Z_0-9]/g, '_').replace(/^(\d)/, '_$1') || '_';
+	value.replace(REPLACE_PATTERN, '_').replace(/^(\d)/, '_$1') || '_';