teyit 1.0.0 → 1.0.2

package/README.md

@@ -24,6 +24,7 @@
 <!---->
 
 [AnyObject]: ./src/types/AnyObject.type.ts
+[InferSchema]: ./src/types/InferSchema.type.ts
 [JSONSchema]: ./src/types/JSONSchema.type.ts
 [Schema]: ./src/types/Schema.type.ts
 [TeyitOptions]: ./src/types/TeyitOptions.type.ts
@@ -119,6 +120,7 @@ teyit
 │   └── Username
 │
 ├── type AnyObject
+├── type InferSchema
 ├── type JSONSchema
 ├── type Schema
 ├── type TeyitOptions
@@ -156,17 +158,17 @@ Teyit schema builder.
 
 Validate the properties with your Teyit schema.
 
-> | Parameter    | Type            | Default | Description                |
-> | ------------ | --------------- | ------- | -------------------------- |
-> | `schema`     | [Schema]        |         | Teyit schema.              |
-> | `properties` | [UnknownObject] |         | Properties to be validate. |
+> | Parameter    | Type        | Default | Description                |
+> | ------------ | ----------- | ------- | -------------------------- |
+> | `schema`     | [Schema]    |         | Teyit schema.              |
+> | `properties` | [AnyObject] |         | Properties to be validate. |
 >
-> returns [Promise]<[AnyObject]>
+> returns [Promise]<[InferSchema<Schema>]>
 >
 > Example:
 >
 > ```typescript
-> const schema: Schema = {
+> const schema = {
 >   display_name: {
 >     type: 'string',
 >     max: 32,
@@ -210,7 +212,7 @@ Validate the properties with your Teyit schema.
 >       required: true
 >     }
 >   ]
-> };
+> } as const satisfies Schema;
 >
 > const properties = {
 >   display_name: 'Fırat',
@@ -350,6 +352,7 @@ Convert your Teyit schema into [JSON Schema](https://json-schema.org).
 | Type              |
 | ----------------- |
 | [AnyObject]       |
+| [InferSchema]     |
 | [JSONSchema]      |
 | [Schema]          |
 | [TeyitOptions]    |

package/dist/main.d.mts

@@ -35,7 +35,7 @@ type Boolean = {
     nullable: boolean;
     required: boolean;
 };
-type Date = {
+type Date$1 = {
     type: 'date';
     min?: string;
     max?: string;
@@ -59,7 +59,7 @@ type Array = {
     nullable: boolean;
     required: boolean;
 };
-type TypeSingle = String | Number | Boolean | Date | Object$1 | Array;
+type TypeSingle = String | Number | Boolean | Date$1 | Object$1 | Array;
 type TypeUnion = [TypeSingle, TypeSingle, ...TypeSingle[]];
 type Type = TypeSingle | TypeUnion;
 type SchemaSingle = Record<string, Type>;
@@ -113,13 +113,11 @@ type TeyitOptions = {
     };
 };
 
-type UnknownObject = Record<string, unknown>;
-
 declare class Teyit {
     private readonly options;
     constructor(options?: TeyitOptions);
     private cleanupTypesDir;
-    validate(schema: Schema, properties: UnknownObject): Promise<AnyObject>;
+    validate<const _Schema extends Schema>(schema: _Schema, properties: AnyObject): Promise<InferSchema<_Schema>>;
     declare(schema: Schema, name: string): Promise<void>;
     convertToJSONSchema(schema: Schema): JSONSchema;
 }
@@ -146,6 +144,49 @@ declare namespace Patterns_export {
   export { Patterns_export_Domain as Domain, Patterns_export_Email as Email, Patterns_export_HTTP as HTTP, Patterns_export_PhoneNumber as PhoneNumber, Patterns_export_URI as URI, Patterns_export_Username as Username };
 }
 
+type Prettify<Type> = {
+    [Key in keyof Type]: Type[Key];
+} & {};
+type InferBaseType<Type> = Type extends {
+    type: 'string';
+} ? string : Type extends {
+    type: 'number';
+} ? number : Type extends {
+    type: 'boolean';
+} ? boolean : Type extends {
+    type: 'date';
+} ? Date : Type extends {
+    type: 'object';
+    properties: infer Properties;
+} ? InferSchema<Properties> : Type extends {
+    type: 'array';
+    items: infer Items;
+} ? InferType<Items>[] : never;
+type ApplyNullable<Type, Definition> = Definition extends {
+    nullable: true;
+} ? Type | null : Type;
+type InferTypeSingle<Type> = Type extends unknown ? ApplyNullable<InferBaseType<Type>, Type> : never;
+type InferType<Type> = Type extends readonly unknown[] ? InferTypeSingle<Type[number]> : InferTypeSingle<Type>;
+type IsOptional<Type> = Type extends {
+    required: false;
+} ? true : Type extends readonly (infer Union)[] ? (Union extends {
+    required: false;
+} ? true : false) : false;
+type RequiredKeys<Schema> = {
+    [Key in keyof Schema]: IsOptional<Schema[Key]> extends true ? never : Key;
+}[keyof Schema];
+type OptionalKeys<Schema> = {
+    [Key in keyof Schema]: IsOptional<Schema[Key]> extends true ? Key : never;
+}[keyof Schema];
+type InferSchemaSingle<Schema> = Prettify<{
+    [Key in RequiredKeys<Schema>]: InferType<Schema[Key]>;
+} & {
+    [Key in OptionalKeys<Schema>]?: InferType<Schema[Key]>;
+}>;
+type InferSchema<Schema> = Schema extends readonly unknown[] ? InferSchemaSingle<Schema[number]> : InferSchemaSingle<Schema>;
+
+type UnknownObject = Record<string, unknown>;
+
 declare class ValidationError extends Error {
     errors: {
         message: string;
@@ -160,4 +201,4 @@ declare class ValidationError extends Error {
     });
 }
 
-export { type AnyObject, type JSONSchema, Patterns_export as Patterns, type Schema, Teyit, type TeyitOptions, type UnknownObject, ValidationError };
+export { type AnyObject, type InferSchema, type JSONSchema, Patterns_export as Patterns, type Schema, Teyit, type TeyitOptions, type UnknownObject, ValidationError };

package/dist/main.d.ts

@@ -35,7 +35,7 @@ type Boolean = {
     nullable: boolean;
     required: boolean;
 };
-type Date = {
+type Date$1 = {
     type: 'date';
     min?: string;
     max?: string;
@@ -59,7 +59,7 @@ type Array = {
     nullable: boolean;
     required: boolean;
 };
-type TypeSingle = String | Number | Boolean | Date | Object$1 | Array;
+type TypeSingle = String | Number | Boolean | Date$1 | Object$1 | Array;
 type TypeUnion = [TypeSingle, TypeSingle, ...TypeSingle[]];
 type Type = TypeSingle | TypeUnion;
 type SchemaSingle = Record<string, Type>;
@@ -113,13 +113,11 @@ type TeyitOptions = {
     };
 };
 
-type UnknownObject = Record<string, unknown>;
-
 declare class Teyit {
     private readonly options;
     constructor(options?: TeyitOptions);
     private cleanupTypesDir;
-    validate(schema: Schema, properties: UnknownObject): Promise<AnyObject>;
+    validate<const _Schema extends Schema>(schema: _Schema, properties: AnyObject): Promise<InferSchema<_Schema>>;
     declare(schema: Schema, name: string): Promise<void>;
     convertToJSONSchema(schema: Schema): JSONSchema;
 }
@@ -146,6 +144,49 @@ declare namespace Patterns_export {
   export { Patterns_export_Domain as Domain, Patterns_export_Email as Email, Patterns_export_HTTP as HTTP, Patterns_export_PhoneNumber as PhoneNumber, Patterns_export_URI as URI, Patterns_export_Username as Username };
 }
 
+type Prettify<Type> = {
+    [Key in keyof Type]: Type[Key];
+} & {};
+type InferBaseType<Type> = Type extends {
+    type: 'string';
+} ? string : Type extends {
+    type: 'number';
+} ? number : Type extends {
+    type: 'boolean';
+} ? boolean : Type extends {
+    type: 'date';
+} ? Date : Type extends {
+    type: 'object';
+    properties: infer Properties;
+} ? InferSchema<Properties> : Type extends {
+    type: 'array';
+    items: infer Items;
+} ? InferType<Items>[] : never;
+type ApplyNullable<Type, Definition> = Definition extends {
+    nullable: true;
+} ? Type | null : Type;
+type InferTypeSingle<Type> = Type extends unknown ? ApplyNullable<InferBaseType<Type>, Type> : never;
+type InferType<Type> = Type extends readonly unknown[] ? InferTypeSingle<Type[number]> : InferTypeSingle<Type>;
+type IsOptional<Type> = Type extends {
+    required: false;
+} ? true : Type extends readonly (infer Union)[] ? (Union extends {
+    required: false;
+} ? true : false) : false;
+type RequiredKeys<Schema> = {
+    [Key in keyof Schema]: IsOptional<Schema[Key]> extends true ? never : Key;
+}[keyof Schema];
+type OptionalKeys<Schema> = {
+    [Key in keyof Schema]: IsOptional<Schema[Key]> extends true ? Key : never;
+}[keyof Schema];
+type InferSchemaSingle<Schema> = Prettify<{
+    [Key in RequiredKeys<Schema>]: InferType<Schema[Key]>;
+} & {
+    [Key in OptionalKeys<Schema>]?: InferType<Schema[Key]>;
+}>;
+type InferSchema<Schema> = Schema extends readonly unknown[] ? InferSchemaSingle<Schema[number]> : InferSchemaSingle<Schema>;
+
+type UnknownObject = Record<string, unknown>;
+
 declare class ValidationError extends Error {
     errors: {
         message: string;
@@ -160,4 +201,4 @@ declare class ValidationError extends Error {
     });
 }
 
-export { type AnyObject, type JSONSchema, Patterns_export as Patterns, type Schema, Teyit, type TeyitOptions, type UnknownObject, ValidationError };
+export { type AnyObject, type InferSchema, type JSONSchema, Patterns_export as Patterns, type Schema, Teyit, type TeyitOptions, type UnknownObject, ValidationError };

package/dist/main.js

@@ -252,11 +252,10 @@ var validate = (schema, properties, options) => {
               if (equivalent.lowercase === true) this.update(property.toLowerCase());
               if (equivalent.uppercase === true) this.update(property.toUpperCase());
               if (equivalent.enum !== void 0 && !equivalent.enum.map((item) => {
-                let mappedItem = item;
-                if (equivalent.trim !== false) mappedItem = mappedItem.trim();
-                if (equivalent.lowercase === true) mappedItem = mappedItem.toLowerCase();
-                if (equivalent.uppercase === true) mappedItem = mappedItem.toUpperCase();
-                return mappedItem;
+                if (equivalent.trim !== false) item = item.trim();
+                if (equivalent.lowercase === true) item = item.toLowerCase();
+                if (equivalent.uppercase === true) item = item.toUpperCase();
+                return item;
               }).includes(property))
                 reportError({ message: (options.error_messages?.string?.enum ?? "").replaceAll("{path}", path2), parts: { path: path2 } });
               if (equivalent.pattern !== void 0 && !new RegExp(equivalent.pattern).test(property)) {

package/dist/main.mjs

@@ -220,11 +220,10 @@ var validate = (schema, properties, options) => {
               if (equivalent.lowercase === true) this.update(property.toLowerCase());
               if (equivalent.uppercase === true) this.update(property.toUpperCase());
               if (equivalent.enum !== void 0 && !equivalent.enum.map((item) => {
-                let mappedItem = item;
-                if (equivalent.trim !== false) mappedItem = mappedItem.trim();
-                if (equivalent.lowercase === true) mappedItem = mappedItem.toLowerCase();
-                if (equivalent.uppercase === true) mappedItem = mappedItem.toUpperCase();
-                return mappedItem;
+                if (equivalent.trim !== false) item = item.trim();
+                if (equivalent.lowercase === true) item = item.toLowerCase();
+                if (equivalent.uppercase === true) item = item.toUpperCase();
+                return item;
               }).includes(property))
                 reportError({ message: (options.error_messages?.string?.enum ?? "").replaceAll("{path}", path2), parts: { path: path2 } });
               if (equivalent.pattern !== void 0 && !new RegExp(equivalent.pattern).test(property)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "teyit",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Portable and simple schemas for property validation.",
   "license": "MIT",
   "homepage": "https://github.com/keift/teyit",