@gravito/mass 1.0.0-alpha.2 → 1.0.0-alpha.5

package/README.md

@@ -1,23 +1,23 @@
 # @gravito/mass
 
-TypeBox-based validation for Gravito - High-performance schema validation with full TypeScript support.
+TypeBox-based validation for Gravito. High-performance schema validation with full TypeScript support.
 
-## 特色
+## Features
 
-- **高效能驗證**: 基於 TypeBox，比 Zod 更快的執行速度
-- **完整 TypeScript 支援**: 自動推導型別，無需手動定義
-- **Hono 整合**: 完美整合 Hono 的驗證中間件
-- **多種資料來源**: 支援 JSON、Query、Param、Form 驗證
+- **Fast validation**: TypeBox-powered validators with strong runtime performance
+- **Full TypeScript support**: Type inference without manual typings
+- **Hono integration**: Works seamlessly with Hono validation middleware
+- **Multiple sources**: Validate JSON, query, params, and form data
 
-## 安裝
+## Installation
 
 ```bash
 bun add @gravito/mass
 ```
 
-## 基本使用
+## Quick Start
 
-### JSON 驗證
+### JSON validation
 
 ```typescript
 import { Hono } from 'hono'
@@ -37,7 +37,7 @@ app.post('/login',
 )
 ```
 
-### Query 參數驗證
+### Query validation
 
 ```typescript
 app.get('/search',
@@ -52,7 +52,7 @@ app.get('/search',
 )
 ```
 
-### Route 參數驗證
+### Route param validation
 
 ```typescript
 app.get('/users/:id',
@@ -66,40 +66,33 @@ app.get('/users/:id',
 )
 ```
 
-## Schema 建構器
+## Schema Builder
 
-`Schema` 物件提供所有 TypeBox 的建構器：
+`Schema` exposes TypeBox constructors:
 
 ```typescript
 import { Schema } from '@gravito/mass'
 
-// 基本型別
 Schema.String()
 Schema.Number()
 Schema.Boolean()
 Schema.Array(Schema.String())
 
-// 物件
 Schema.Object({
   name: Schema.String(),
   age: Schema.Number()
 })
 
-// 選填欄位
 Schema.Optional(Schema.String())
-
-// 預設值
 Schema.String({ default: 'hello' })
-
-// 驗證規則
 Schema.String({ minLength: 2, maxLength: 100 })
 Schema.Number({ minimum: 0, maximum: 100 })
 Schema.String({ format: 'email' })
 ```
 
-## 與 Hono Client 整合
+## Hono Client Integration
 
-使用 `app.route()` 方法串接路由模組，可以獲得完整的型別推導：
+When you compose routes with `app.route()`, you get full type inference for the client:
 
 ```typescript
 // app.ts
@@ -113,8 +106,6 @@ export default app
 export type AppRoutes = typeof routes
 ```
 
-前端使用時可以獲得完整的型別提示：
-
 ```typescript
 // client.ts
 import { hc } from 'hono/client'
@@ -124,22 +115,16 @@ export const createClient = (baseUrl: string) => {
   return hc<AppRoutes>(baseUrl)
 }
 
-// 使用時有完整的型別提示
 const client = createClient('http://localhost:3000')
 const result = await client.api.users.login.$post({
   json: { username: 'user', password: 'pass' }
 })
 ```
 
-## 效能優勢
+## Performance Notes
 
-TypeBox 相較於 Zod 的優勢：
-
-- **編譯時驗證**: TypeBox 在編譯時生成驗證器，執行時效能更高
-- **更小的 bundle**: 產生的程式碼更小
-- **更好的型別推導**: 與 TypeScript 深度整合
+TypeBox generates validators at build-time for faster runtime performance, smaller bundles, and strong TypeScript inference.
 
 ## License
 
 MIT
-

package/README.zh-TW.md

@@ -0,0 +1,29 @@
+# @gravito/mass
+
+> Gravito 的 TypeBox 驗證模組，提供高效能且完整的 TypeScript 支援。
+
+## 安裝
+
+```bash
+bun add @gravito/mass
+```
+
+## 快速開始
+
+```typescript
+import { Hono } from 'hono'
+import { Schema, validate } from '@gravito/mass'
+
+const app = new Hono()
+
+app.post('/login',
+  validate('json', Schema.Object({
+    username: Schema.String(),
+    password: Schema.String()
+  })),
+  (c) => {
+    const { username } = c.req.valid('json')
+    return c.json({ success: true, message: `Welcome ${username}` })
+  }
+)
+```

package/dist/validator.d.ts

@@ -7,9 +7,11 @@ export type ValidationSource = 'json' | 'query' | 'param' | 'form';
 /**
  * Create a validation middleware.
  *
+ * Validates the request data against the provided TypeBox schema.
+ *
  * @param source - Validation source (json, query, param, form)
  * @param schema - TypeBox Schema
- * @returns Hono middleware
+ * @returns Hono middleware handler that validates the request.
  */
 export declare function validate<T extends TSchema, S extends ValidationSource, E extends Env = any, P extends string = any>(source: S, schema: T): MiddlewareHandler<E, P, {
     in: {

package/dist/validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../src/validator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAA;AAElD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;AAElE;;;;;;GAMG;AACH,wBAAgB,QAAQ,CACtB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,gBAAgB,EAC1B,CAAC,SAAS,GAAG,GAAG,GAAG,EACnB,CAAC,SAAS,MAAM,GAAG,GAAG,EAEtB,MAAM,EAAE,CAAC,EACT,MAAM,EAAE,CAAC,GACR,iBAAiB,CAClB,CAAC,EACD,CAAC,EACD;IACE,EAAE,EAAE;SAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;KAAE,CAAA;IAC3B,GAAG,EAAE;SAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;KAAE,CAAA;CAC7B,CACF,CAEA"}
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../src/validator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAA;AAElD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;AAElE;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,gBAAgB,EAC1B,CAAC,SAAS,GAAG,GAAG,GAAG,EACnB,CAAC,SAAS,MAAM,GAAG,GAAG,EAEtB,MAAM,EAAE,CAAC,EACT,MAAM,EAAE,CAAC,GACR,iBAAiB,CAClB,CAAC,EACD,CAAC,EACD;IACE,EAAE,EAAE;SAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;KAAE,CAAA;IAC3B,GAAG,EAAE;SAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;KAAE,CAAA;CAC7B,CACF,CAEA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravito/mass",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.5",
   "description": "TypeBox-based validation for Gravito - High-performance schema validation with full TypeScript support",
   "type": "module",
   "main": "./dist/index.js",
@@ -28,10 +28,11 @@
     "@sinclair/typebox": "^0.34.0"
   },
   "peerDependencies": {
-    "hono": "^4.0.0"
+    "gravito-core": "1.0.0-beta.4"
   },
   "devDependencies": {
     "bun-types": "^1.1.0",
+    "hono": "^4.0.0",
     "typescript": "^5.0.0"
   },
   "author": "Carl Lee <carllee0520@gmail.com>",
@@ -46,7 +47,6 @@
     "validation",
     "typebox",
     "schema",
-    "hono",
     "middleware",
     "typescript"
   ],