yuppi 1.2.4 → 1.2.6

package/README.md

@@ -112,31 +112,21 @@ Yuppi
 │   ├── URI
 │   └── Username
 │
-└── type Types
-    │
-    ├── AnyObject
-    ├── JSONSchema
-    ├── Schema
-    ├── ValidateOptions
-    ├── ValidationError
-    └── YuppiOptions
+├── type AnyObject
+├── type JSONSchema
+├── type Schema
+├── type ValidateOptions
+├── type ValidationError
+└── type YuppiOptions
 ```
 
 ### Import
 
 Briefly as follows.
 
-> TypeScript
->
-> ```typescript
-> import { Yuppi, Patterns, type Types as YuppiTypes } from "yuppi";
-> ```
->
-> JavaScript
->
-> ```javascript
-> import { Yuppi, Patterns } from "yuppi";
-> ```
+```typescript
+import { Yuppi, Patterns } from 'yuppi';
+```
 
 ### Constructors
 
@@ -151,7 +141,7 @@ Yuppi schema builder.
 > Example:
 >
 > ```typescript
-> const Yupp: Yuppi = new Yuppi();
+> const Yupp = new Yuppi();
 > ```
 
 ### Methods
@@ -170,9 +160,9 @@ Validate the properties with your Yuppi schema.
 > Example:
 >
 > ```typescript
-> const schema: YuppiTypes.Schema = {
+> const schema: Schema = {
 >   display_name: {
->     type: "string",
+>     type: 'string',
 >     min: 1,
 >     max: 32,
 >     nullable: false,
@@ -180,7 +170,7 @@ Validate the properties with your Yuppi schema.
 >   },
 >
 >   username: {
->     type: "string",
+>     type: 'string',
 >     min: 3,
 >     max: 16,
 >     pattern: Patterns.Username,
@@ -189,7 +179,7 @@ Validate the properties with your Yuppi schema.
 >   },
 >
 >   email: {
->     type: "string",
+>     type: 'string',
 >     pattern: Patterns.Email,
 >     lowercase: true,
 >     nullable: false,
@@ -197,10 +187,10 @@ Validate the properties with your Yuppi schema.
 >   }
 > };
 >
-> const properties: YuppiTypes.AnyObject = {
->   display_name: "Fırat",
->   username: "fir4tozden",
->   email: "fir4tozden@gmail.com"
+> const properties = {
+>   display_name: 'Fırat',
+>   username: 'fir4tozden',
+>   email: 'fir4tozden@gmail.com'
 > };
 >
 > try {
@@ -212,7 +202,7 @@ Validate the properties with your Yuppi schema.
 >       email: "fir4tozden@gmail.com"
 >     }
 >   */
-> } catch((error: YuppiTypes.ValidationError)) {
+> } catch (error) {
 >   console.log(error.message); // "Field email must match the required pattern ^[a-zA-Z0-9._-]+@([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}$"
 > }
 > ```
@@ -232,9 +222,9 @@ Convert your Yuppi schema into Yup schema.
 > Example:
 >
 > ```typescript
-> const schema: YuppiTypes.Schema = {
+> const schema: Schema = {
 >   display_name: {
->     type: "string",
+>     type: 'string',
 >     min: 1,
 >     max: 32,
 >     nullable: false,
@@ -242,7 +232,7 @@ Convert your Yuppi schema into Yup schema.
 >   },
 >
 >   username: {
->     type: "string",
+>     type: 'string',
 >     min: 3,
 >     max: 16,
 >     pattern: Patterns.Username,
@@ -251,7 +241,7 @@ Convert your Yuppi schema into Yup schema.
 >   },
 >
 >   email: {
->     type: "string",
+>     type: 'string',
 >     pattern: Patterns.Email,
 >     lowercase: true,
 >     nullable: false,
@@ -272,14 +262,14 @@ Convert your Yuppi schema into [JSON Schema](https://json-schema.org).
 > | --------- | ------- | -------------------------- |
 > | schema    |         | [Schema]<br/>Yuppi schema. |
 >
-> returns [AnyObject]
+> returns [JSONSchema]
 >
 > Example:
 >
 > ```typescript
-> const schema: YuppiTypes.Schema = {
+> const schema: Schema = {
 >   display_name: {
->     type: "string",
+>     type: 'string',
 >     min: 1,
 >     max: 32,
 >     nullable: false,
@@ -287,7 +277,7 @@ Convert your Yuppi schema into [JSON Schema](https://json-schema.org).
 >   },
 >
 >   username: {
->     type: "string",
+>     type: 'string',
 >     min: 3,
 >     max: 16,
 >     pattern: Patterns.Username,
@@ -296,7 +286,7 @@ Convert your Yuppi schema into [JSON Schema](https://json-schema.org).
 >   },
 >
 >   email: {
->     type: "string",
+>     type: 'string',
 >     pattern: Patterns.Email,
 >     lowercase: true,
 >     nullable: false,

package/dist/Yuppi.class.d.mts

@@ -1,16 +1,23 @@
+import * as yup from 'yup';
 import { AnyObject } from './types/AnyObject.type.mjs';
 import { JSONSchema } from './types/JSONSchema.type.mjs';
 import { Schema } from './types/Schema.type.mjs';
 import { YuppiOptions } from './types/YuppiOptions.type.mjs';
-import 'yup';
 import '@sinclair/typebox';
 import './types/ValidateOptions.type.mjs';
 
 declare class Yuppi {
     private readonly options;
     constructor(options?: YuppiOptions);
-    validate(schema: Schema, properties: AnyObject): AnyObject;
-    convertToYup(schema: Schema): AnyObject;
+    validate(schema: Schema, properties: AnyObject): {
+        [x: string]: any;
+        [x: number]: any;
+    };
+    convertToYup(schema: Schema): yup.ObjectSchema<{
+        [x: string]: any;
+    }, yup.AnyObject, {
+        [x: string]: any;
+    }, "">;
     convertToJSONSchema(schema: Schema): JSONSchema;
 }
 

package/dist/Yuppi.class.d.ts

@@ -1,16 +1,23 @@
+import * as yup from 'yup';
 import { AnyObject } from './types/AnyObject.type.js';
 import { JSONSchema } from './types/JSONSchema.type.js';
 import { Schema } from './types/Schema.type.js';
 import { YuppiOptions } from './types/YuppiOptions.type.js';
-import 'yup';
 import '@sinclair/typebox';
 import './types/ValidateOptions.type.js';
 
 declare class Yuppi {
     private readonly options;
     constructor(options?: YuppiOptions);
-    validate(schema: Schema, properties: AnyObject): AnyObject;
-    convertToYup(schema: Schema): AnyObject;
+    validate(schema: Schema, properties: AnyObject): {
+        [x: string]: any;
+        [x: number]: any;
+    };
+    convertToYup(schema: Schema): yup.ObjectSchema<{
+        [x: string]: any;
+    }, yup.AnyObject, {
+        [x: string]: any;
+    }, "">;
     convertToJSONSchema(schema: Schema): JSONSchema;
 }
 

package/dist/main.d.mts

@@ -1,13 +1,12 @@
 export { Yuppi } from './Yuppi.class.mjs';
 export { P as Patterns } from './Patterns.barrel-D-k3IHDq.mjs';
-export { T as Types } from './Types.barrel--XGUUjIp.mjs';
-import './types/AnyObject.type.mjs';
+export { AnyObject } from './types/AnyObject.type.mjs';
+export { JSONSchema } from './types/JSONSchema.type.mjs';
+export { Schema } from './types/Schema.type.mjs';
+export { ValidateOptions } from './types/ValidateOptions.type.mjs';
+export { ValidationError } from './types/ValidationError.type.mjs';
+export { YuppiOptions } from './types/YuppiOptions.type.mjs';
 import 'yup';
-import './types/JSONSchema.type.mjs';
-import '@sinclair/typebox';
-import './types/Schema.type.mjs';
-import './types/YuppiOptions.type.mjs';
-import './types/ValidateOptions.type.mjs';
 import './patterns/Any.pattern.mjs';
 import './patterns/Domain.pattern.mjs';
 import './patterns/Email.pattern.mjs';
@@ -15,4 +14,4 @@ import './patterns/HTTP.pattern.mjs';
 import './patterns/PhoneNumber.pattern.mjs';
 import './patterns/URI.pattern.mjs';
 import './patterns/Username.pattern.mjs';
-import './types/ValidationError.type.mjs';
+import '@sinclair/typebox';

package/dist/main.d.ts

@@ -1,13 +1,12 @@
 export { Yuppi } from './Yuppi.class.js';
 export { P as Patterns } from './Patterns.barrel-JdN3lL2Q.js';
-export { T as Types } from './Types.barrel-wzQq8e9v.js';
-import './types/AnyObject.type.js';
+export { AnyObject } from './types/AnyObject.type.js';
+export { JSONSchema } from './types/JSONSchema.type.js';
+export { Schema } from './types/Schema.type.js';
+export { ValidateOptions } from './types/ValidateOptions.type.js';
+export { ValidationError } from './types/ValidationError.type.js';
+export { YuppiOptions } from './types/YuppiOptions.type.js';
 import 'yup';
-import './types/JSONSchema.type.js';
-import '@sinclair/typebox';
-import './types/Schema.type.js';
-import './types/YuppiOptions.type.js';
-import './types/ValidateOptions.type.js';
 import './patterns/Any.pattern.js';
 import './patterns/Domain.pattern.js';
 import './patterns/Email.pattern.js';
@@ -15,4 +14,4 @@ import './patterns/HTTP.pattern.js';
 import './patterns/PhoneNumber.pattern.js';
 import './patterns/URI.pattern.js';
 import './patterns/Username.pattern.js';
-import './types/ValidationError.type.js';
+import '@sinclair/typebox';

package/dist/types/Schema.type.d.mts

@@ -5,7 +5,7 @@ type Base = {
     required: boolean;
 };
 type String = Base & {
-    type: "string";
+    type: 'string';
     enum?: string[];
     min?: number;
     max?: number;
@@ -13,7 +13,7 @@ type String = Base & {
     uppercase?: boolean;
 };
 type Number = Base & {
-    type: "number";
+    type: 'number';
     enum?: number[];
     min?: number;
     max?: number;
@@ -22,26 +22,24 @@ type Number = Base & {
     negative?: boolean;
 };
 type Boolean = Base & {
-    type: "boolean";
+    type: 'boolean';
 };
 type Date = Base & {
-    type: "date";
+    type: 'date';
     min?: string;
     max?: string;
 };
 type Object$1 = Base & {
-    type: "object";
+    type: 'object';
     properties: Schema;
 };
 type Array = Base & {
-    type: "array";
+    type: 'array';
     min?: number;
     max?: number;
     items: Types;
 };
 type Types = String | Number | Boolean | Date | Object$1 | Array;
-type Schema = {
-    [key: string]: Types;
-};
+type Schema = Record<string, Types>;
 
 export type { Array, Base, Boolean, Date, Number, Object$1 as Object, Schema, String, Types };

package/dist/types/Schema.type.d.ts

@@ -5,7 +5,7 @@ type Base = {
     required: boolean;
 };
 type String = Base & {
-    type: "string";
+    type: 'string';
     enum?: string[];
     min?: number;
     max?: number;
@@ -13,7 +13,7 @@ type String = Base & {
     uppercase?: boolean;
 };
 type Number = Base & {
-    type: "number";
+    type: 'number';
     enum?: number[];
     min?: number;
     max?: number;
@@ -22,26 +22,24 @@ type Number = Base & {
     negative?: boolean;
 };
 type Boolean = Base & {
-    type: "boolean";
+    type: 'boolean';
 };
 type Date = Base & {
-    type: "date";
+    type: 'date';
     min?: string;
     max?: string;
 };
 type Object$1 = Base & {
-    type: "object";
+    type: 'object';
     properties: Schema;
 };
 type Array = Base & {
-    type: "array";
+    type: 'array';
     min?: number;
     max?: number;
     items: Types;
 };
 type Types = String | Number | Boolean | Date | Object$1 | Array;
-type Schema = {
-    [key: string]: Types;
-};
+type Schema = Record<string, Types>;
 
 export type { Array, Base, Boolean, Date, Number, Object$1 as Object, Schema, String, Types };

package/dist/utils/ConvertToJSONSchema.util.d.mts

@@ -1,6 +1,7 @@
+import * as yup from 'yup';
 import { TObject } from '@sinclair/typebox';
 import { Schema } from '../types/Schema.type.mjs';
 
-declare const convertToJSONSchema: (schema: Schema) => TObject;
+declare const convertToJSONSchema: (schema: Schema) => TObject<yup.AnyObject>;
 
 export { convertToJSONSchema };

package/dist/utils/ConvertToJSONSchema.util.d.ts

@@ -1,6 +1,7 @@
+import * as yup from 'yup';
 import { TObject } from '@sinclair/typebox';
 import { Schema } from '../types/Schema.type.js';
 
-declare const convertToJSONSchema: (schema: Schema) => TObject;
+declare const convertToJSONSchema: (schema: Schema) => TObject<yup.AnyObject>;
 
 export { convertToJSONSchema };

package/dist/utils/ConvertToYup.util.d.mts

@@ -1,9 +1,12 @@
-import { AnyObject } from '../types/AnyObject.type.mjs';
+import * as yup from 'yup';
 import { Schema } from '../types/Schema.type.mjs';
 import { YuppiOptions } from '../types/YuppiOptions.type.mjs';
-import 'yup';
 import '../types/ValidateOptions.type.mjs';
 
-declare const convertToYup: (schema: Schema, error_messages: YuppiOptions["error_messages"]) => AnyObject;
+declare const convertToYup: (schema: Schema, error_messages: YuppiOptions["error_messages"]) => yup.ObjectSchema<{
+    [x: string]: any;
+}, yup.AnyObject, {
+    [x: string]: any;
+}, "">;
 
 export { convertToYup };

package/dist/utils/ConvertToYup.util.d.ts

@@ -1,9 +1,12 @@
-import { AnyObject } from '../types/AnyObject.type.js';
+import * as yup from 'yup';
 import { Schema } from '../types/Schema.type.js';
 import { YuppiOptions } from '../types/YuppiOptions.type.js';
-import 'yup';
 import '../types/ValidateOptions.type.js';
 
-declare const convertToYup: (schema: Schema, error_messages: YuppiOptions["error_messages"]) => AnyObject;
+declare const convertToYup: (schema: Schema, error_messages: YuppiOptions["error_messages"]) => yup.ObjectSchema<{
+    [x: string]: any;
+}, yup.AnyObject, {
+    [x: string]: any;
+}, "">;
 
 export { convertToYup };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yuppi",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "description": "Schemas that can be converted to Yup and JSON Schema.",
   "license": "MIT",
   "homepage": "https://github.com/keift/yuppi",
@@ -10,8 +10,8 @@
   "types": "./dist/main.d.ts",
   "scripts": {
     "tests": "bun run lint && bun test",
-    "prettier": "prettier --write ./",
     "build": "tsup",
+    "prettier": "prettier --write ./",
     "lint": "eslint ./"
   },
   "dependencies": {
@@ -21,7 +21,7 @@
     "yup": "^1.7.0"
   },
   "devDependencies": {
-    "neatlint": "^1.0.0",
+    "neatlint": "^1.1.6",
     "prettier": "^3.6.2",
     "tsup": "^8.5.0"
   },

package/dist/Types.barrel--XGUUjIp.d.mts

@@ -1,18 +0,0 @@
-import { AnyObject } from './types/AnyObject.type.mjs';
-import { JSONSchema } from './types/JSONSchema.type.mjs';
-import { Schema } from './types/Schema.type.mjs';
-import { ValidateOptions } from './types/ValidateOptions.type.mjs';
-import { ValidationError } from './types/ValidationError.type.mjs';
-import { YuppiOptions } from './types/YuppiOptions.type.mjs';
-
-declare const Types_barrel_AnyObject: typeof AnyObject;
-declare const Types_barrel_JSONSchema: typeof JSONSchema;
-declare const Types_barrel_Schema: typeof Schema;
-declare const Types_barrel_ValidateOptions: typeof ValidateOptions;
-declare const Types_barrel_ValidationError: typeof ValidationError;
-declare const Types_barrel_YuppiOptions: typeof YuppiOptions;
-declare namespace Types_barrel {
-  export { Types_barrel_AnyObject as AnyObject, Types_barrel_JSONSchema as JSONSchema, Types_barrel_Schema as Schema, Types_barrel_ValidateOptions as ValidateOptions, Types_barrel_ValidationError as ValidationError, Types_barrel_YuppiOptions as YuppiOptions };
-}
-
-export { Types_barrel as T };

package/dist/Types.barrel-wzQq8e9v.d.ts

@@ -1,18 +0,0 @@
-import { AnyObject } from './types/AnyObject.type.js';
-import { JSONSchema } from './types/JSONSchema.type.js';
-import { Schema } from './types/Schema.type.js';
-import { ValidateOptions } from './types/ValidateOptions.type.js';
-import { ValidationError } from './types/ValidationError.type.js';
-import { YuppiOptions } from './types/YuppiOptions.type.js';
-
-declare const Types_barrel_AnyObject: typeof AnyObject;
-declare const Types_barrel_JSONSchema: typeof JSONSchema;
-declare const Types_barrel_Schema: typeof Schema;
-declare const Types_barrel_ValidateOptions: typeof ValidateOptions;
-declare const Types_barrel_ValidationError: typeof ValidationError;
-declare const Types_barrel_YuppiOptions: typeof YuppiOptions;
-declare namespace Types_barrel {
-  export { Types_barrel_AnyObject as AnyObject, Types_barrel_JSONSchema as JSONSchema, Types_barrel_Schema as Schema, Types_barrel_ValidateOptions as ValidateOptions, Types_barrel_ValidationError as ValidationError, Types_barrel_YuppiOptions as YuppiOptions };
-}
-
-export { Types_barrel as T };