@hedystia/validations 1.2.7 → 1.2.9

package/dist/index.d.ts

@@ -126,21 +126,93 @@ declare class ObjectSchemaType<T extends Record<string, unknown>> extends BaseSc
 }
 type AnySchema = SchemaPrimitive | BaseSchema<any, any> | SchemaDefinition;
 declare function toStandard<T>(schema: AnySchema): Schema<unknown, T>;
+/**
+ * Create standard schema types
+ * @returns {typeof h} Standard schema types
+ */
 declare const h: {
+    /**
+     * Create string schema type
+     * @returns {StringSchemaType} String schema type
+     */
     string: () => StringSchemaType;
+    /**
+     * Create number schema type
+     * @returns {NumberSchemaType} Number schema type
+     */
     number: () => NumberSchemaType;
+    /**
+     * Create boolean schema type
+     * @returns {BooleanSchemaType} Boolean schema type
+     */
     boolean: () => BooleanSchemaType;
+    /**
+     * Create null schema type
+     * @returns {NullSchemaType} Null schema type
+     */
     null: () => NullSchemaType;
+    /**
+     * Create any schema type
+     * @returns {AnySchemaType} Any schema type
+     */
     any: () => AnySchemaType;
+    /**
+     * Create literal schema type
+     * @param {T} value - Literal value
+     * @returns {LiteralSchema<T>} Literal schema type
+     */
     literal: <T extends string | number | boolean>(value: T) => LiteralSchema<T>;
+    /**
+     * Create object schema type
+     * @param {S} [schemaDef] - Schema definition
+     * @returns {ObjectSchemaType<InferObject<S>>} Object schema type
+     */
     object: <S extends SchemaDefinition>(schemaDef?: S) => ObjectSchemaType<InferObject<S>>;
+    /**
+     * Create array schema type
+     * @param {S} schema - Schema
+     * @returns {ArraySchema<unknown, InferSchema<S>[]>} Array schema type
+     */
     array: <S extends AnySchema>(schema: S) => ArraySchema<unknown, InferSchema<S>[]>;
+    /**
+     * Create enum schema type
+     * @param {T} values - Enum values
+     * @returns {EnumSchema<unknown, T[number]>} Enum schema type
+     */
     enum: <T extends readonly [any, ...any[]]>(values: T) => EnumSchema<unknown, T[number]>;
+    /**
+     * Create optional schema type
+     * @param {S} schema - Schema
+     * @returns {OptionalSchema<unknown, InferSchema<S> | undefined>} Optional schema type
+     */
     optional: <S extends AnySchema>(schema: S) => OptionalSchema<unknown, InferSchema<S> | undefined>;
+    /**
+     * Create options schema type
+     * @param {S} schemas - Schemas
+     * @returns {UnionSchema<unknown, InferSchema<S[number]>>} Options schema type
+     */
     options: <S extends AnySchema[]>(...schemas: S) => UnionSchema<unknown, InferSchema<S[number]>>;
+    /**
+     * Create instance of schema type
+     * @param {C} constructor - Constructor function
+     * @returns {InstanceOfSchema<unknown, InstanceType<C>>} Instance of schema type
+     */
     instanceOf: <C extends new (...args: any[]) => any>(constructor: C) => InstanceOfSchema<unknown, InstanceType<C>>;
+    /**
+     * Create email schema type
+     * @returns {StringSchemaType} Email schema type
+     */
     email: () => StringSchemaType;
+    /**
+     * Create phone schema type
+     * @returns {StringSchemaType} Phone schema type
+     */
     phone: () => StringSchemaType;
+    /**
+     * Convert schema to standard schema
+     * @param {AnySchema} schema - Schema
+     * @returns {Schema<unknown, any>} Standard schema
+     */
     toStandard: typeof toStandard;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hedystia/validations",
-  "version": "1.2.7",
+  "version": "1.2.9",
   "devDependencies": {
     "@standard-schema/spec": "^1.0.0",
     "@types/bun": "latest",

package/readme.md

@@ -1,167 +1,167 @@
-<div align="center">
-  <p>
-    <strong>🚀 Hedystia Framework</strong>
-  </p>
-
-  <p>
-    <strong>Next-gen TypeScript framework for building type-safe APIs at lightspeed! ⚡</strong>
-  </p>
-
-  <p>
-    <a href="https://www.npmjs.com/package/hedystia"><img src="https://img.shields.io/npm/v/hedystia.svg?style=flat-square" alt="npm version"></a>
-    <a href="https://www.npmjs.com/package/hedystia"><img src="https://img.shields.io/npm/dm/hedystia.svg?style=flat-square" alt="npm downloads"></a>
-    <a href="LICENSE"><img src="https://img.shields.io/github/license/Hedystia/Framework.svg?style=flat-square" alt="license"></a>
-    <img src="https://img.shields.io/badge/Bun-powered-FFD43B?style=flat-square&logo=bun" alt="Bun powered">
-  </p>
-</div>
-
-## 🚨 Early Access Notice
-> **Warning**
-> Framework is in active development. Core features are stable but some advanced functionality still being implemented.
-
-## 🌟 Superpowers
-
-- 🌐 **Multi-runtime support** - Bun (default), Deno, Node.js, Vercel, Cloudflare Workers, Fastly Compute, Lambda, etc.
-- 🔒 **End-to-end type safety** - From params to response, full TypeScript integration
-- ⚡ **Bun-native performance** - Built for Bun runtime with native validation
-- 🧩 **Client integration** - Auto-generated type-safe HTTP client
-- 🛡️ **Validation built-in** - Zod integration for runtime safety
-- 🔌 **Extensible architecture** - Middleware, hooks and macros system
-- 📝 **Standard Schema** - Compatibility with the standard schema so you can use it with Zod, Arktype, etc.
-
-## 🚀 Launch in 30 Seconds
-
-1. Install with Bun:
-```bash
-bun add hedystia
-```
-
-2. Create your first API:
-```typescript
-import { Hedystia, h } from "hedystia";
-
-const app = new Hedystia()
-  .get("/hello/:name", (ctx) => `Hello ${ctx.params.name}!`, {
-    params: h.object({ name: h.string() }),
-    response: h.string()
-  })
-  .listen(3000);
-```
-
-3. Generate client and consume API:
-```typescript
-import { createClient } from "@hedystia/client";
-
-const client = createClient<typeof app>("http://localhost:3000");
-
-// Fully typed request!
-const { data } = await client.hello.name("World").get();
-console.log(data); // "Hello World!"
-```
-
-## 💡 Why Developers Love Hedystia
-
-### 🔄 Full-stack Type Safety
-```typescript
-// Server-side validation
-.post("/users", (ctx) => {...}, {
-  body: h.object({
-    email: h.email(),
-    age: h.number()
-  })
-})
-
-// Client-side types
-await client.users.post({
-  email: "user@example.com", // Autocompletes!
-  age: 25 // Type-checked
-});
-```
-
-### 📖 Swagger Integration
-
-```typescript
-import { swagger } from "@hedystia/swagger";
-
-const swaggerPlugin = swagger({
-  title: "My API",
-  description: "An example API with Swagger",
-  version: "1.0.0",
-  tags: [
-    { name: "users", description: "User operations" },
-  ],
-});
-
-swaggerPlugin.captureRoutes(app);
-
-app.use("/swagger", swaggerPlugin.plugin).listen(3000);
-```
-
-### ⚡ Performance First
-- Bun runtime optimized
-- Faster by default
-- Own type validation system
-- Faster than Express
-- Built-in response compression
-
-### 🧩 Modern Feature Set
-```typescript
-// File uploads
-.post("/upload", async (ctx) => {
-  const formData = await ctx.body; // FormData type
-})
-
-// Binary responses
-.get("/pdf", () => new Blob([...]), {
-  response: h.instanceof(Blob)
-})
-
-// Nested routing
-.group("/api/v1", (v1) => v1
-  .group("/users", (users) => users
-    .get("/:id", ...)
-  )
-)
-```
-
-## 🛠️ Development Roadmap
-
-### Core Features
-- ✅ HTTP Methods: GET, POST, PUT, PATCH, DELETE
-- ✅ Response Types: JSON, Text, FormData, Blob, ArrayBuffer
-- ✅ Router Groups & Middleware
-- ✅ Type-safe Client Generation
-- ✅ WebSocket Support
-- ✅ Adapter System to work with other frameworks
-
-### Advanced Capabilities
-- ✅ Standard Schema Compatibility
-- ✅ Hooks System (onRequest, onError, etc)
-- ✅ Macro System for Auth/Rate Limiting
-- ✅ OpenAPI - Swagger Integration
-
-## 💼 Production Ready
-```typescript
-// Error handling
-.onError((err) => {
-  return Response.json({ 
-    error: err.message 
-  }, { status: 500 })
-})
-
-// Rate limiting macro
-.macro({
-  rateLimit: () => ({
-    resolve: async (ctx) => {
-      // Implement your logic
-    }
-  })
-})
-```
-
-## 📜 License
-MIT License © 2025 Hedystia
-
-## 🗣️ Community
-- [GitHub Issues](https://github.com/Hedystia/Framework/issues)
-- [Discord Server](https://hedystia.com/support)
+<div align="center">
+  <p>
+    <strong>🚀 Hedystia Framework</strong>
+  </p>
+
+  <p>
+    <strong>Next-gen TypeScript framework for building type-safe APIs at lightspeed! ⚡</strong>
+  </p>
+
+  <p>
+    <a href="https://www.npmjs.com/package/hedystia"><img src="https://img.shields.io/npm/v/hedystia.svg?style=flat-square" alt="npm version"></a>
+    <a href="https://www.npmjs.com/package/hedystia"><img src="https://img.shields.io/npm/dm/hedystia.svg?style=flat-square" alt="npm downloads"></a>
+    <a href="LICENSE"><img src="https://img.shields.io/github/license/Hedystia/Framework.svg?style=flat-square" alt="license"></a>
+    <img src="https://img.shields.io/badge/Bun-powered-FFD43B?style=flat-square&logo=bun" alt="Bun powered">
+  </p>
+</div>
+
+## 🚨 Early Access Notice
+> **Warning**
+> Framework is in active development. Core features are stable but some advanced functionality still being implemented.
+
+## 🌟 Superpowers
+
+- 🌐 **Multi-runtime support** - Bun (default), Deno, Node.js, Vercel, Cloudflare Workers, Fastly Compute, Lambda, etc.
+- 🔒 **End-to-end type safety** - From params to response, full TypeScript integration
+- ⚡ **Bun-native performance** - Built for Bun runtime with native validation
+- 🧩 **Client integration** - Auto-generated type-safe HTTP client
+- 🛡️ **Validation built-in** - Zod integration for runtime safety
+- 🔌 **Extensible architecture** - Middleware, hooks and macros system
+- 📝 **Standard Schema** - Compatibility with the standard schema so you can use it with Zod, Arktype, etc.
+
+## 🚀 Launch in 30 Seconds
+
+1. Install with Bun:
+```bash
+bun add hedystia
+```
+
+2. Create your first API:
+```typescript
+import { Hedystia, h } from "hedystia";
+
+const app = new Hedystia()
+  .get("/hello/:name", (ctx) => `Hello ${ctx.params.name}!`, {
+    params: h.object({ name: h.string() }),
+    response: h.string()
+  })
+  .listen(3000);
+```
+
+3. Generate client and consume API:
+```typescript
+import { createClient } from "@hedystia/client";
+
+const client = createClient<typeof app>("http://localhost:3000");
+
+// Fully typed request!
+const { data } = await client.hello.name("World").get();
+console.log(data); // "Hello World!"
+```
+
+## 💡 Why Developers Love Hedystia
+
+### 🔄 Full-stack Type Safety
+```typescript
+// Server-side validation
+.post("/users", (ctx) => {...}, {
+  body: h.object({
+    email: h.email(),
+    age: h.number()
+  })
+})
+
+// Client-side types
+await client.users.post({
+  email: "user@example.com", // Autocompletes!
+  age: 25 // Type-checked
+});
+```
+
+### 📖 Swagger Integration
+
+```typescript
+import { swagger } from "@hedystia/swagger";
+
+const swaggerPlugin = swagger({
+  title: "My API",
+  description: "An example API with Swagger",
+  version: "1.0.0",
+  tags: [
+    { name: "users", description: "User operations" },
+  ],
+});
+
+swaggerPlugin.captureRoutes(app);
+
+app.use("/swagger", swaggerPlugin.plugin).listen(3000);
+```
+
+### ⚡ Performance First
+- Bun runtime optimized
+- Faster by default
+- Own type validation system
+- Faster than Express
+- Built-in response compression
+
+### 🧩 Modern Feature Set
+```typescript
+// File uploads
+.post("/upload", async (ctx) => {
+  const formData = await ctx.body; // FormData type
+})
+
+// Binary responses
+.get("/pdf", () => new Blob([...]), {
+  response: h.instanceof(Blob)
+})
+
+// Nested routing
+.group("/api/v1", (v1) => v1
+  .group("/users", (users) => users
+    .get("/:id", ...)
+  )
+)
+```
+
+## 🛠️ Development Roadmap
+
+### Core Features
+- ✅ HTTP Methods: GET, POST, PUT, PATCH, DELETE
+- ✅ Response Types: JSON, Text, FormData, Blob, ArrayBuffer
+- ✅ Router Groups & Middleware
+- ✅ Type-safe Client Generation
+- ✅ WebSocket Support
+- ✅ Adapter System to work with other frameworks
+
+### Advanced Capabilities
+- ✅ Standard Schema Compatibility
+- ✅ Hooks System (onRequest, onError, etc)
+- ✅ Macro System for Auth/Rate Limiting
+- ✅ OpenAPI - Swagger Integration
+
+## 💼 Production Ready
+```typescript
+// Error handling
+.onError((err) => {
+  return Response.json({ 
+    error: err.message 
+  }, { status: 500 })
+})
+
+// Rate limiting macro
+.macro({
+  rateLimit: () => ({
+    resolve: async (ctx) => {
+      // Implement your logic
+    }
+  })
+})
+```
+
+## 📜 License
+MIT License © 2025 Hedystia
+
+## 🗣️ Community
+- [GitHub Issues](https://github.com/Hedystia/Framework/issues)
+- [Discord Server](https://hedystia.com/support)