@gravito/mass 1.0.0-alpha.2

package/README.md

@@ -0,0 +1,145 @@
+# @gravito/mass
+
+TypeBox-based validation for Gravito - High-performance schema validation with full TypeScript support.
+
+## 特色
+
+- **高效能驗證**: 基於 TypeBox，比 Zod 更快的執行速度
+- **完整 TypeScript 支援**: 自動推導型別，無需手動定義
+- **Hono 整合**: 完美整合 Hono 的驗證中間件
+- **多種資料來源**: 支援 JSON、Query、Param、Form 驗證
+
+## 安裝
+
+```bash
+bun add @gravito/mass
+```
+
+## 基本使用
+
+### JSON 驗證
+
+```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}` })
+  }
+)
+```
+
+### Query 參數驗證
+
+```typescript
+app.get('/search',
+  validate('query', Schema.Object({
+    q: Schema.String(),
+    page: Schema.Optional(Schema.Number())
+  })),
+  (c) => {
+    const { q, page } = c.req.valid('query')
+    return c.json({ query: q, page: page ?? 1 })
+  }
+)
+```
+
+### Route 參數驗證
+
+```typescript
+app.get('/users/:id',
+  validate('param', Schema.Object({
+    id: Schema.String({ pattern: '^[0-9]+$' })
+  })),
+  (c) => {
+    const { id } = c.req.valid('param')
+    return c.json({ userId: id })
+  }
+)
+```
+
+## Schema 建構器
+
+`Schema` 物件提供所有 TypeBox 的建構器：
+
+```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 整合
+
+使用 `app.route()` 方法串接路由模組，可以獲得完整的型別推導：
+
+```typescript
+// app.ts
+import { Hono } from 'hono'
+import { userRoute } from './routes/user'
+
+const app = new Hono()
+const routes = app.route('/api/users', userRoute)
+
+export default app
+export type AppRoutes = typeof routes
+```
+
+前端使用時可以獲得完整的型別提示：
+
+```typescript
+// client.ts
+import { hc } from 'hono/client'
+import type { AppRoutes } from './types'
+
+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' }
+})
+```
+
+## 效能優勢
+
+TypeBox 相較於 Zod 的優勢：
+
+- **編譯時驗證**: TypeBox 在編譯時生成驗證器，執行時效能更高
+- **更小的 bundle**: 產生的程式碼更小
+- **更好的型別推導**: 與 TypeScript 深度整合
+
+## License
+
+MIT
+

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @gravito/mass
+ *
+ * TypeBox-based validation for Gravito
+ * High-performance schema validation with full TypeScript support
+ *
+ * @example
+ * ```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}` })
+ *   }
+ * )
+ * ```
+ */
+export { tbValidator as validator } from '@hono/typebox-validator';
+export type { Static, TSchema } from '@sinclair/typebox';
+export * as Schema from '@sinclair/typebox';
+export { type ValidationSource, validate } from './validator';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAGH,OAAO,EAAE,WAAW,IAAI,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGlE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAExD,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAA;AAG3C,OAAO,EAAE,KAAK,gBAAgB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -0,0 +1,15 @@
+// @bun
+// src/index.ts
+import { tbValidator as tbValidator2 } from "@hono/typebox-validator";
+import * as Schema from "@sinclair/typebox";
+
+// src/validator.ts
+import { tbValidator } from "@hono/typebox-validator";
+function validate(source, schema) {
+  return tbValidator(source, schema);
+}
+export {
+  tbValidator2 as validator,
+  validate,
+  Schema
+};

package/dist/validator.d.ts

@@ -0,0 +1,22 @@
+import type { Static, TSchema } from '@sinclair/typebox';
+import type { Env, MiddlewareHandler } from 'hono';
+/**
+ * Validation source type.
+ */
+export type ValidationSource = 'json' | 'query' | 'param' | 'form';
+/**
+ * Create a validation middleware.
+ *
+ * @param source - Validation source (json, query, param, form)
+ * @param schema - TypeBox Schema
+ * @returns Hono middleware
+ */
+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: {
+        [K in S]: Static<T>;
+    };
+    out: {
+        [K in S]: Static<T>;
+    };
+}>;
+//# sourceMappingURL=validator.d.ts.map

package/dist/validator.d.ts.map

@@ -0,0 +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"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@gravito/mass",
+  "version": "1.0.0-alpha.2",
+  "description": "TypeBox-based validation for Gravito - High-performance schema validation with full TypeScript support",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bun run build.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "bun test",
+    "prepublishOnly": "bun run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@hono/typebox-validator": "^1.1.0",
+    "@sinclair/typebox": "^0.34.0"
+  },
+  "peerDependencies": {
+    "hono": "^4.0.0"
+  },
+  "devDependencies": {
+    "bun-types": "^1.1.0",
+    "typescript": "^5.0.0"
+  },
+  "author": "Carl Lee <carllee0520@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gravito-framework/gravito.git",
+    "directory": "packages/mass"
+  },
+  "keywords": [
+    "gravito",
+    "validation",
+    "typebox",
+    "schema",
+    "hono",
+    "middleware",
+    "typescript"
+  ],
+  "homepage": "https://github.com/gravito-framework/gravito#readme"
+}