yuppi 1.4.1 → 1.4.2

package/README.md

@@ -17,12 +17,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/>
@@ -56,18 +63,17 @@
 
 ## 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 +125,8 @@ yuppi
 ├── type JSONSchema
 ├── type Schema
 ├── type ValidationError
-└── type YuppiOptions
+├── type YuppiOptions
+└── type YupSchema
 ```
 
 ### Import
@@ -273,7 +280,7 @@ Convert your Yuppi schema into Yup schema.
 > | --------- | -------- | ------- | ------------- |
 > | schema    | [Schema] |         | Yuppi schema. |
 >
-> returns [AnyObject]
+> returns [YupSchema]
 >
 > Example:
 >
@@ -357,6 +364,7 @@ Convert your Yuppi schema into [JSON Schema](https://json-schema.org).
 | [Schema]          |
 | [ValidationError] |
 | [YuppiOptions]    |
+| [YupSchema]       |
 
 ## Links
 

package/dist/main.d.mts

@@ -1,10 +1,10 @@
 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, ValidationError as ValidationError$1, AnySchema } from 'yup';
+import { TAnySchema } from '@sinclair/typebox';
 
 type AnyObject = AnyObject$1;
 
-type JSONSchema = TObject<Record<string, TAnySchema>>;
+type JSONSchema = TAnySchema;
 
 type String = {
     type: 'string';
@@ -149,4 +149,6 @@ declare namespace Patterns_export {
 
 type ValidationError = ValidationError$1;
 
-export { type AnyObject, type JSONSchema, Patterns_export as Patterns, type Schema, type ValidationError, Yuppi, type YuppiOptions };
+type YupSchema = AnySchema;
+
+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,10 @@
 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, ValidationError as ValidationError$1, AnySchema } from 'yup';
+import { TAnySchema } from '@sinclair/typebox';
 
 type AnyObject = AnyObject$1;
 
-type JSONSchema = TObject<Record<string, TAnySchema>>;
+type JSONSchema = TAnySchema;
 
 type String = {
     type: 'string';
@@ -149,4 +149,6 @@ declare namespace Patterns_export {
 
 type ValidationError = ValidationError$1;
 
-export { type AnyObject, type JSONSchema, Patterns_export as Patterns, type Schema, type ValidationError, Yuppi, type YuppiOptions };
+type YupSchema = AnySchema;
+
+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);

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);

package/package.json

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