Merge pull request #476 from shimataro/develop

version 3.0.0-rc.8

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [3.0.0-rc.8] - 2020-06-13
+
+### Changed
+
+* enabled property completion and type inference, without explicit type specification
+
 ## [3.0.0-rc.7] - 2020-06-11
 
 ### Fixed
@@ -477,7 +483,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 * First release.
 
-[Unreleased]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.7...HEAD
+[Unreleased]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.8...HEAD
+[3.0.0-rc.8]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.7...v3.0.0-rc.8
 [3.0.0-rc.7]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.6...v3.0.0-rc.7
 [3.0.0-rc.6]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.5...v3.0.0-rc.6
 [3.0.0-rc.5]: https://github.com/shimataro/value-schema/compare/v3.0.0-rc.4...v3.0.0-rc.5

README.md

@@ -474,7 +474,7 @@ interface Parameters {
     bar: string
 }
 
-const schemaObject: vs.SchemaObject = {
+const schemaObject = {
     foo: vs.number(),
     bar: vs.string(),
 };
@@ -2069,7 +2069,7 @@ type OptionsForObject = {
     ifEmptyString?: object | null;
     ifNull?: object | null;
 
-    schemaObject?: SchemaObject;
+    schemaObject?: Record<string, BaseSchema>;
 
     converter?: (values: object, fail: () => never) => object | null;
 }

examples/example-deno.ts

@@ -1,22 +1,7 @@
 import * as assert from "https://deno.land/std/testing/asserts.ts";
 import vs from "../mod.ts";
 
-interface Input {
-	id: number;
-	name: string;
-	age: number;
-	email: string;
-	state: string;
-	classes: number[];
-	skills: string[];
-	creditCard: string;
-	remoteAddr: string;
-	remoteAddrIpv6: string;
-	limit: number,
-	offset: number,
-};
-
-const schemaObject: vs.SchemaObject = { // schema for input
+const schemaObject = { // schema for input
 	id: vs.number({ // number, >=1
 		minValue: 1,
 	}),
@@ -108,7 +93,7 @@ const expected = { // should be converted to this
 };
 
 // Let's apply!
-const actual = vs.applySchemaObject<Input>(schemaObject, input);
+const actual = vs.applySchemaObject(schemaObject, input);
 
 // verification
 assert.assertEquals(actual, expected);

examples/example.ts

@@ -1,22 +1,7 @@
 import assert from "assert";
 import vs from "value-schema";
 
-interface Input {
-	id: number;
-	name: string;
-	age: number;
-	email: string;
-	state: string;
-	classes: number[];
-	skills: string[];
-	creditCard: string;
-	remoteAddr: string;
-	remoteAddrIpv6: string;
-	limit: number,
-	offset: number,
-};
-
-const schemaObject: vs.SchemaObject = { // schema for input
+const schemaObject = { // schema for input
 	id: vs.number({ // number, >=1
 		minValue: 1,
 	}),
@@ -108,7 +93,7 @@ const expected = { // should be converted to this
 };
 
 // Let's apply!
-const actual = vs.applySchemaObject<Input>(schemaObject, input);
+const actual = vs.applySchemaObject(schemaObject, input);
 
 // verification
 assert.deepStrictEqual(actual, expected);

package.json

@@ -1,7 +1,7 @@
 {
   "name": "value-schema",
   "description": "simple, easy-to-use, and declarative schema validator",
-  "version": "3.0.0-rc.7",
+  "version": "3.0.0-rc.8",
   "author": "shimataro",
   "license": "MIT",
   "repository": {

src/appliers/object/schema.ts

@@ -1,10 +1,10 @@
-import {Key, Values} from "../../libs/types";
-import {SchemaObject, applySchemaObjectCore} from "../../libs/applySchemaObjectCore";
+import {Key, ObjectTypeOf, SchemaObject, Values} from "../../libs/types";
+import {applySchemaObjectCore} from "../../libs/applySchemaObjectCore";
 import {onErrorDefault, onFinishedDefault} from "../../libs/BaseSchema";
 
-export interface Options
+export interface Options<S>
 {
-	schemaObject?: SchemaObject;
+	schemaObject?: S;
 }
 
 /**
@@ -15,7 +15,7 @@ export interface Options
  * @returns ends applying
  * @throws {ValueSchemaError}
  */
-export function applyTo<T>(values: Values, options: Options, keyStack: Key[]): values is Values<T>
+export function applyTo<S extends SchemaObject>(values: Values, options: Options<S>, keyStack: Key[]): values is Values<ObjectTypeOf<S>>
 {
 	if(options.schemaObject === undefined)
 	{

src/libs/applySchemaObject.ts

@@ -1,9 +1,8 @@
-import {SchemaObject, applySchemaObjectCore} from "./applySchemaObjectCore";
+import {applySchemaObjectCore} from "./applySchemaObjectCore";
 import {ErrorHandler, FinishHandler, onErrorDefault, onFinishedDefault} from "./BaseSchema";
 
-import {Empty} from "../libs/types";
+import {ObjectTypeOf, SchemaObject} from "./types";
 
-export {SchemaObject} from "./applySchemaObjectCore";
 export {ErrorHandler} from "./BaseSchema";
 
 /**
@@ -14,7 +13,7 @@ export {ErrorHandler} from "./BaseSchema";
  * @param onFinished finish handler
  * @returns applied data
  */
-export function applySchemaObject<T extends Empty>(schemaObject: SchemaObject, data: unknown, onError: ErrorHandler = onErrorDefault, onFinished: FinishHandler = onFinishedDefault): T
+export function applySchemaObject<S extends SchemaObject>(schemaObject: S, data: unknown, onError: ErrorHandler = onErrorDefault, onFinished: FinishHandler = onFinishedDefault): ObjectTypeOf<S>
 {
 	return applySchemaObjectCore(schemaObject, data, onError, onFinished, []);
 }

src/libs/applySchemaObjectCore.ts

@@ -1,9 +1,7 @@
-import {AnyObject, Empty, Key, isObject} from "./types";
-import {BaseSchema, ErrorHandler, FinishHandler} from "./BaseSchema";
+import {AnyObject, Key, ObjectTypeOf, SchemaObject, isObject} from "./types";
+import {ErrorHandler, FinishHandler} from "./BaseSchema";
 import {CAUSE, ValueSchemaError} from "./ValueSchemaError";
 
-export type SchemaObject = Record<string, BaseSchema>
-
 /**
  * apply schema object to data
  * @param schemaObject schema object
@@ -13,7 +11,7 @@ export type SchemaObject = Record<string, BaseSchema>
  * @param keyStack path to key that caused error
  * @returns applied data
  */
-export function applySchemaObjectCore<T extends Empty>(schemaObject: SchemaObject, data: unknown, onError: ErrorHandler, onFinished: FinishHandler, keyStack: Key[]): T
+export function applySchemaObjectCore<S extends SchemaObject>(schemaObject: S, data: unknown, onError: ErrorHandler, onFinished: FinishHandler, keyStack: Key[]): ObjectTypeOf<S>
 {
 	if(!isObject(data))
 	{
@@ -24,7 +22,7 @@ export function applySchemaObjectCore<T extends Empty>(schemaObject: SchemaObjec
 			throw err;
 		}
 
-		return result as T;
+		return result as ObjectTypeOf<S>;
 	}
 
 	const appliedObject: AnyObject = {};
@@ -39,7 +37,7 @@ export function applySchemaObjectCore<T extends Empty>(schemaObject: SchemaObjec
 	{
 		onFinished();
 	}
-	return appliedObject as T;
+	return appliedObject as ObjectTypeOf<S>;
 
 	/**
 	 * error handler (to avoid "no-loop-func" error on eslint)

src/libs/types.ts

@@ -1,10 +1,23 @@
+import {BaseSchema} from "./BaseSchema";
+
+class AS<T> extends BaseSchema<T[]>
+{}
+class OS<S extends SchemaObject> extends BaseSchema<ObjectTypeOf<S>>
+{}
+export type ObjectTypeOf<S extends SchemaObject> = {
+	[K in keyof S]:
+		S[K] extends AS<infer T> ? T[] :
+		S[K] extends OS<infer S2> ? ObjectTypeOf<S2> :
+		S[K] extends BaseSchema<boolean> ? boolean :
+		S[K] extends BaseSchema<number> ? number :
+		S[K] extends BaseSchema<string> ? string :
+		never
+}
+
 type Scalar = boolean | number | string;
 
 export type AnyObject = Record<string, unknown>;
-
-export interface Empty
-{
-}
+export type SchemaObject = Record<string, BaseSchema>
 
 export type Key = string | number;
 
@@ -102,7 +115,7 @@ export function isArray(value: unknown): value is unknown[]
  * @param value value to check
  * @returns Yes/No
  */
-export function isObject(value: unknown): value is Record<string, unknown>
+export function isObject(value: unknown): value is AnyObject
 {
 	if(value === null)
 	{

src/schemas/object.ts

@@ -6,19 +6,19 @@ import * as schema from "../appliers/object/schema";
 import * as type from "../appliers/object/type";
 
 import {BaseSchema} from "../libs/BaseSchema";
-import {AnyObject} from "../libs/types";
+import {AnyObject, ObjectTypeOf, SchemaObject} from "../libs/types";
 
-type OptionsForObject =
+type OptionsForObject<S> =
 	converter.Options<AnyObject> |
 	ifUndefined.Options<AnyObject> |
 	ifEmptyString.Options<AnyObject> |
 	ifNull.Options<AnyObject> |
-	schema.Options |
+	schema.Options<S> |
 	type.Options;
 
-class ObjectSchema extends BaseSchema<AnyObject>
+class ObjectSchema<S extends SchemaObject> extends BaseSchema<ObjectTypeOf<S>>
 {
-	constructor(options: OptionsForObject)
+	constructor(options: OptionsForObject<S>)
 	{
 		super(options, [
 			ifUndefined.applyTo,
@@ -36,7 +36,7 @@ class ObjectSchema extends BaseSchema<AnyObject>
  * @param options Options
  * @returns schema
  */
-export function object(options: OptionsForObject = {}): ObjectSchema
+export function object<S extends SchemaObject>(options: OptionsForObject<S> = {}): ObjectSchema<S>
 {
 	return new ObjectSchema(options);
 }