yuppi 1.4.1 → 1.4.3

package/README.md

@@ -1,7 +1,6 @@
 [String]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String
 [Number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number
 [Boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-[Object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
 [Date]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date
 [Buffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
 [Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
@@ -17,12 +16,19 @@
 [PhoneNumber]: ./src/patterns/PhoneNumber.pattern.ts
 [URI]: ./src/patterns/URI.pattern.ts
 [Username]: ./src/patterns/Username.pattern.ts
+
+<!---->
+
 [YuppiOptionsDefault]: ./src/defaults/YuppiOptions.default.ts
+
+<!---->
+
 [AnyObject]: ./src/types/AnyObject.type.ts
 [JSONSchema]: ./src/types/JSONSchema.type.ts
 [Schema]: ./src/types/Schema.type.ts
 [ValidationError]: ./src/types/ValidationError.type.ts
 [YuppiOptions]: ./src/types/YuppiOptions.type.ts
+[YupSchema]: ./src/types/YupSchema.type.ts
 
 <div align="center">
   <br/>
@@ -49,25 +55,24 @@
   - [Types](#types)
 - [Links](#links)
   - [Discord](https://discord.gg/keift)
-  - [Telegram](https://t.me/keiftt)
-  - [Twitter](https://x.com/keiftttt)
+  - [Telegram](https://t.me/keiftco)
+  - [Twitter](https://x.com/keiftco)
   - [GitHub](https://github.com/keift)
 - [License](#license)
 
 ## About
 
-Perform validation using portable and simple schemas.
+Portable and simple schemas for property validation.
 
 ## Features
 
-- Easy and understandable schema
+- Easy and understandable schemas
 - Contains ready regex patterns
 - Portable schemas as a JSON file
-- Works with [Yup](https://npmjs.com/package/yup), stable and secure
 - Schemas can be declared for TypeScript
-- It has union support, properties can have multiple types
+- Schemas can be converted to [JSON Schema](https://json-schema.org). JSON Schema is OpenAPI compatible
 - Error messages are ready to be understood but can be edited if desired
-- Can be converted to Yup and [JSON Schema](https://json-schema.org). JSON Schema is OpenAPI compatible
+- Works with [Yup](https://npmjs.com/package/yup), stable and secure
 
 ## Installation
 
@@ -119,7 +124,8 @@ yuppi
 ├── type JSONSchema
 ├── type Schema
 ├── type ValidationError
-└── type YuppiOptions
+├── type YuppiOptions
+└── type YupSchema
 ```
 
 ### Import
@@ -136,9 +142,9 @@ import { Yuppi, Patterns } from 'yuppi';
 
 Yuppi schema builder.
 
-> | Parameter | Type           | Default               | Description            |
-> | --------- | -------------- | --------------------- | ---------------------- |
-> | options?  | [YuppiOptions] | [YuppiOptionsDefault] | Constructor's options. |
+> | Parameter  | Type           | Default               | Description            |
+> | ---------- | -------------- | --------------------- | ---------------------- |
+> | `options?` | [YuppiOptions] | [YuppiOptionsDefault] | Constructor's options. |
 >
 > Example:
 >
@@ -152,10 +158,10 @@ Yuppi schema builder.
 
 Validate the properties with your Yuppi schema.
 
-> | Parameter  | Type        | Default | Description                |
-> | ---------- | ----------- | ------- | -------------------------- |
-> | schema     | [Schema]    |         | Yuppi schema.              |
-> | properties | [AnyObject] |         | Properties to be validate. |
+> | Parameter    | Type        | Default | Description                |
+> | ------------ | ----------- | ------- | -------------------------- |
+> | `schema`     | [Schema]    |         | Yuppi schema.              |
+> | `properties` | [AnyObject] |         | Properties to be validate. |
 >
 > returns [Promise]<[AnyObject]>
 >
@@ -240,8 +246,8 @@ Declare your Yuppi schema for TypeScript.
 
 > | Parameter | Type     | Default | Description       |
 > | --------- | -------- | ------- | ----------------- |
-> | schema    | [Schema] |         | Yuppi schema.     |
-> | name      | [String] |         | Declaration name. |
+> | `schema`  | [Schema] |         | Yuppi schema.     |
+> | `name`    | [String] |         | Declaration name. |
 >
 > returns [Promise]<[Void]>
 >
@@ -271,9 +277,9 @@ Convert your Yuppi schema into Yup schema.
 
 > | Parameter | Type     | Default | Description   |
 > | --------- | -------- | ------- | ------------- |
-> | schema    | [Schema] |         | Yuppi schema. |
+> | `schema`  | [Schema] |         | Yuppi schema. |
 >
-> returns [AnyObject]
+> returns [YupSchema]
 >
 > Example:
 >
@@ -289,7 +295,7 @@ Convert your Yuppi schema into [JSON Schema](https://json-schema.org).
 
 > | Parameter | Type     | Default | Description   |
 > | --------- | -------- | ------- | ------------- |
-> | schema    | [Schema] |         | Yuppi schema. |
+> | `schema`  | [Schema] |         | Yuppi schema. |
 >
 > returns [JSONSchema]
 >
@@ -357,12 +363,13 @@ Convert your Yuppi schema into [JSON Schema](https://json-schema.org).
 | [Schema]          |
 | [ValidationError] |
 | [YuppiOptions]    |
+| [YupSchema]       |
 
 ## Links
 
 - [Discord](https://discord.gg/keift)
-- [Telegram](https://t.me/keiftt)
-- [Twitter](https://x.com/keiftttt)
+- [Telegram](https://t.me/keiftco)
+- [Twitter](https://x.com/keiftco)
 - [GitHub](https://github.com/keift)
 
 ## License

package/dist/main.d.mts

@@ -1,10 +1,9 @@
-import * as yup from 'yup';
-import { AnyObject as AnyObject$1, ValidateOptions, ValidationError as ValidationError$1 } from 'yup';
-import { TObject, TAnySchema } from '@sinclair/typebox';
+import { AnyObject as AnyObject$1, ValidateOptions, AnySchema, ValidationError as ValidationError$1 } from 'yup';
+import { TAnySchema } from '@sinclair/typebox';
 
 type AnyObject = AnyObject$1;
 
-type JSONSchema = TObject<Record<string, TAnySchema>>;
+type JSONSchema = TAnySchema;
 
 type String = {
     type: 'string';
@@ -108,20 +107,15 @@ type YuppiOptions = {
     validate_options?: ValidateOptions;
 };
 
+type YupSchema = AnySchema;
+
 declare class Yuppi {
     private readonly options;
     constructor(options?: YuppiOptions);
     private cleanupTypesDir;
-    validate(schema: Schema, properties: AnyObject): Promise<{
-        [x: string]: any;
-        [x: number]: any;
-    }>;
+    validate(schema: Schema, properties: AnyObject): Promise<AnyObject>;
     declare(schema: Schema, name: string): Promise<void>;
-    convertToYup(schema: Schema): yup.ObjectSchema<{
-        [x: string]: any;
-    }, yup.AnyObject, {
-        [x: string]: any;
-    }, "">;
+    convertToYup(schema: Schema): YupSchema;
     convertToJSONSchema(schema: Schema): JSONSchema;
 }
 
@@ -149,4 +143,4 @@ declare namespace Patterns_export {
 
 type ValidationError = ValidationError$1;
 
-export { type AnyObject, type JSONSchema, Patterns_export as Patterns, type Schema, type ValidationError, Yuppi, type YuppiOptions };
+export { type AnyObject, type JSONSchema, Patterns_export as Patterns, type Schema, type ValidationError, type YupSchema, Yuppi, type YuppiOptions };

package/dist/main.d.ts

@@ -1,10 +1,9 @@
-import * as yup from 'yup';
-import { AnyObject as AnyObject$1, ValidateOptions, ValidationError as ValidationError$1 } from 'yup';
-import { TObject, TAnySchema } from '@sinclair/typebox';
+import { AnyObject as AnyObject$1, ValidateOptions, AnySchema, ValidationError as ValidationError$1 } from 'yup';
+import { TAnySchema } from '@sinclair/typebox';
 
 type AnyObject = AnyObject$1;
 
-type JSONSchema = TObject<Record<string, TAnySchema>>;
+type JSONSchema = TAnySchema;
 
 type String = {
     type: 'string';
@@ -108,20 +107,15 @@ type YuppiOptions = {
     validate_options?: ValidateOptions;
 };
 
+type YupSchema = AnySchema;
+
 declare class Yuppi {
     private readonly options;
     constructor(options?: YuppiOptions);
     private cleanupTypesDir;
-    validate(schema: Schema, properties: AnyObject): Promise<{
-        [x: string]: any;
-        [x: number]: any;
-    }>;
+    validate(schema: Schema, properties: AnyObject): Promise<AnyObject>;
     declare(schema: Schema, name: string): Promise<void>;
-    convertToYup(schema: Schema): yup.ObjectSchema<{
-        [x: string]: any;
-    }, yup.AnyObject, {
-        [x: string]: any;
-    }, "">;
+    convertToYup(schema: Schema): YupSchema;
     convertToJSONSchema(schema: Schema): JSONSchema;
 }
 
@@ -149,4 +143,4 @@ declare namespace Patterns_export {
 
 type ValidationError = ValidationError$1;
 
-export { type AnyObject, type JSONSchema, Patterns_export as Patterns, type Schema, type ValidationError, Yuppi, type YuppiOptions };
+export { type AnyObject, type JSONSchema, Patterns_export as Patterns, type Schema, type ValidationError, type YupSchema, Yuppi, type YuppiOptions };

package/dist/main.js

@@ -81,7 +81,7 @@ var convertToJSONSchema = (schema, options) => {
       schema2 = import_typebox.Type.Array(build(key, config.items), { minItems: config.min, maxItems: config.max, default: config.default });
       schema2 = base(schema2, key, config);
       return schema2;
-    } else throw new Error(`Unsupported schema type for ${key}`);
+    } else throw new Error(`Invalid schema type for ${key}`);
   };
   const build = (key, config) => {
     if (!Array.isArray(config)) return buildSingle(key, config);
@@ -184,7 +184,7 @@ var convertToYup = (schema, options) => {
       schema2 = schema2.of(build(key, config.items));
       schema2 = base(schema2, key, config);
       return schema2;
-    }
+    } else throw new Error(`Invalid schema type for ${key}`);
   };
   const build = (key, config) => {
     if (!Array.isArray(config)) return buildSingle(key, config);
@@ -200,9 +200,7 @@ var convertToYup = (schema, options) => {
 };
 
 // src/utils/PascalCase.util.ts
-var pascalCase = (text) => {
-  return text.replace(/[^a-zA-Z0-9]/g, " ").split(" ").map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join("");
-};
+var pascalCase = (text) => text.replace(/[^a-zA-Z0-9]/g, " ").split(" ").map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join("");
 
 // src/defaults/YuppiOptions.default.ts
 var YuppiOptionsDefault = {

package/dist/main.mjs

@@ -50,7 +50,7 @@ var convertToJSONSchema = (schema, options) => {
       schema2 = Typebox.Array(build(key, config.items), { minItems: config.min, maxItems: config.max, default: config.default });
       schema2 = base(schema2, key, config);
       return schema2;
-    } else throw new Error(`Unsupported schema type for ${key}`);
+    } else throw new Error(`Invalid schema type for ${key}`);
   };
   const build = (key, config) => {
     if (!Array.isArray(config)) return buildSingle(key, config);
@@ -153,7 +153,7 @@ var convertToYup = (schema, options) => {
       schema2 = schema2.of(build(key, config.items));
       schema2 = base(schema2, key, config);
       return schema2;
-    }
+    } else throw new Error(`Invalid schema type for ${key}`);
   };
   const build = (key, config) => {
     if (!Array.isArray(config)) return buildSingle(key, config);
@@ -169,9 +169,7 @@ var convertToYup = (schema, options) => {
 };
 
 // src/utils/PascalCase.util.ts
-var pascalCase = (text) => {
-  return text.replace(/[^a-zA-Z0-9]/g, " ").split(" ").map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join("");
-};
+var pascalCase = (text) => text.replace(/[^a-zA-Z0-9]/g, " ").split(" ").map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join("");
 
 // src/defaults/YuppiOptions.default.ts
 var YuppiOptionsDefault = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "yuppi",
-  "version": "1.4.1",
-  "description": "Perform validation using portable and simple schemas.",
+  "version": "1.4.3",
+  "description": "Portable and simple schemas for property validation.",
   "license": "MIT",
   "homepage": "https://github.com/keift/yuppi",
   "bugs": "https://github.com/keift/yuppi/issues",