Merge pull request #160 from bufferings/work

Add std-schema-openapi-plugin and various improvements

Author: bufferings

.changeset/add-std-schema-packages.md

@@ -0,0 +1,10 @@
+---
+'@korix/std-schema-openapi-plugin': minor
+'@korix/std-schema-adapter': minor
+---
+
+Add Standard Schema packages
+
+- Add std-schema-openapi-plugin for Standard JSON Schema support
+- Rename standard-schema-adapter to std-schema-adapter
+

.changeset/consolidate-error-classes.md

@@ -0,0 +1,11 @@
+---
+'@korix/kori': patch
+---
+
+Consolidate error classes into KoriError with KoriErrorCode
+
+Replace individual error classes with unified KoriError and KoriErrorCode constants:
+
+- Remove KoriCookieError, KoriResponseBuildError, KoriSetCookieHeaderError, KoriValidationConfigError
+- Add KoriErrorCode with predefined error codes
+- Make KoriError.code parameter required

.github/workflows/release.yml

@@ -15,8 +15,9 @@ jobs:
     timeout-minutes: 15
 
     permissions:
-      pull-requests: write
       contents: write
+      pull-requests: write
+      id-token: write
 
     steps:
       - name: Checkout Repo
@@ -29,6 +30,9 @@ jobs:
         with:
           node-version: 20
 
+      - name: Update npm for OIDC
+        run: npm install -g npm@latest
+
       - name: Install pnpm
         uses: pnpm/action-setup@v4
         with:
@@ -69,4 +73,3 @@ jobs:
           publish: pnpm changeset:publish
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -6,8 +6,8 @@ A modern, type-safe web framework for TypeScript, built on [Hono](https://hono.d
 
 - Fast and lightweight routing powered by Hono's router
 - TypeScript type inference throughout your application
-- Request and response validation with Zod schemas
-- OpenAPI specification generation from Zod schemas
+- Request and response validation with Standard Schema (Zod, Valibot, ArkType, etc.)
+- OpenAPI specification generation from Standard JSON Schema
 - Extensible plugin architecture
 
 Kori also supports Standard Schema for validation with other schema libraries.
@@ -104,24 +104,30 @@ Server log output:
 
 ## With Request Validation
 
-Let's create a user API with request validation:
+Let's create a user API with request validation.
+
+Supported libraries ([Standard Schema](https://standardschema.dev/) compliant):
+
+- Zod 4.0+
+- Valibot 1.0+
+- ArkType 2.0+
 
 ```bash
-npm install @korix/zod-schema-adapter zod
+npm install @korix/std-schema-adapter @standard-schema/spec zod
 ```
 
 ```typescript
 import { createKori } from '@korix/kori';
 import { startNodejsServer } from '@korix/nodejs-server';
-import { zodRequestSchema, enableZodRequestValidation } from '@korix/zod-schema-adapter';
+import { stdRequestSchema, enableStdRequestValidation } from '@korix/std-schema-adapter';
 import { z } from 'zod';
 
 const app = createKori({
-  ...enableZodRequestValidation(),
+  ...enableStdRequestValidation(),
 });
 
 app.post('/users', {
-  requestSchema: zodRequestSchema({
+  requestSchema: stdRequestSchema({
     body: z.object({
       name: z.string(),
       age: z.number(),
@@ -166,21 +172,21 @@ You can also add response schema validation to catch unexpected responses. By de
 ```typescript
 import { createKori } from '@korix/kori';
 import { startNodejsServer } from '@korix/nodejs-server';
-import { zodRequestSchema, zodResponseSchema, enableZodRequestAndResponseValidation } from '@korix/zod-schema-adapter';
+import { stdRequestSchema, stdResponseSchema, enableStdRequestAndResponseValidation } from '@korix/std-schema-adapter';
 import { z } from 'zod';
 
 const app = createKori({
-  ...enableZodRequestAndResponseValidation(),
+  ...enableStdRequestAndResponseValidation(),
 });
 
 app.post('/users', {
-  requestSchema: zodRequestSchema({
+  requestSchema: stdRequestSchema({
     body: z.object({
       name: z.string(),
       age: z.number(),
     }),
   }),
-  responseSchema: zodResponseSchema({
+  responseSchema: stdResponseSchema({
     '201': z.object({
       id: z.number(),
       name: z.string(),
@@ -233,7 +239,7 @@ Server log output:
     "body": {
       "stage": "validation",
       "reason": {
-        "provider": "zod",
+        "provider": "standard-schema",
         "type": "Validation",
         "message": "Validation error",
         "issues": [
@@ -252,34 +258,40 @@ Server log output:
 
 ## And OpenAPI
 
-Generate OpenAPI documentation from your validation schemas:
+Generate OpenAPI 3.1.0 documentation from your validation schemas.
+
+Supported libraries ([Standard JSON Schema](https://standardschema.dev/json-schema) compliant):
+
+- Zod 4.2+
+- ArkType 2.1.28+
+- Valibot 1.2+ (requires `@valibot/to-json-schema` v1.5+)
 
 ```bash
-npm install @korix/zod-openapi-plugin @korix/openapi-swagger-ui-plugin
+npm install @korix/std-schema-openapi-plugin @korix/openapi-swagger-ui-plugin
 ```
 
 ```typescript
 import { createKori } from '@korix/kori';
 import { startNodejsServer } from '@korix/nodejs-server';
 import { swaggerUiPlugin } from '@korix/openapi-swagger-ui-plugin';
-import { zodOpenApiPlugin } from '@korix/zod-openapi-plugin';
-import { zodRequestSchema, zodResponseSchema, enableZodRequestAndResponseValidation } from '@korix/zod-schema-adapter';
+import { stdRequestSchema, stdResponseSchema, enableStdRequestAndResponseValidation } from '@korix/std-schema-adapter';
+import { stdSchemaOpenApiPlugin } from '@korix/std-schema-openapi-plugin';
 import { z } from 'zod';
 
 const app = createKori({
-  ...enableZodRequestAndResponseValidation(),
+  ...enableStdRequestAndResponseValidation(),
 })
-  .applyPlugin(zodOpenApiPlugin({ info: { title: 'My API', version: '1.0.0' } }))
+  .applyPlugin(stdSchemaOpenApiPlugin({ info: { title: 'My API', version: '1.0.0' } }))
   .applyPlugin(swaggerUiPlugin());
 
 app.post('/users', {
-  requestSchema: zodRequestSchema({
+  requestSchema: stdRequestSchema({
     body: z.object({
       name: z.string(),
       age: z.number(),
     }),
   }),
-  responseSchema: zodResponseSchema({
+  responseSchema: stdResponseSchema({
     '201': z.object({
       id: z.number(),
       name: z.string(),
@@ -307,9 +319,8 @@ Now you can visit http://localhost:3000/docs for interactive API documentation.
 
 - [`@korix/kori`](./packages/kori) - Core framework
 - [`@korix/nodejs-server`](./packages/nodejs-server) - Node.js HTTP server adapter
-- [`@korix/zod-schema-adapter`](./packages/zod-schema-adapter) - Zod schema adapter for request and response validation
-- [`@korix/standard-schema-adapter`](./packages/standard-schema-adapter) - Standard Schema adapter for validation with other schema libraries
-- [`@korix/zod-openapi-plugin`](./packages/zod-openapi-plugin) - OpenAPI document generation from Zod schemas
+- [`@korix/std-schema-adapter`](./packages/std-schema-adapter) - Standard Schema adapter for validation (Zod, Valibot, ArkType, etc.)
+- [`@korix/std-schema-openapi-plugin`](./packages/std-schema-openapi-plugin) - OpenAPI document generation from Standard JSON Schema
 - [`@korix/openapi-swagger-ui-plugin`](./packages/openapi-swagger-ui-plugin) - Interactive API documentation with Swagger UI
 
 [View all packages →](./packages)

docs/.vitepress/config.js

@@ -53,40 +53,6 @@ export default defineConfig({
             { text: 'OpenAPI Integration', link: '/en/guide/openapi' },
           ],
         },
-        // {
-        //   text: 'Core API',
-        //   collapsed: true,
-        //   items: [
-        //     { text: 'Kori', link: '/en/core/kori' },
-        //     { text: 'Instance Context', link: '/en/core/instance-context' },
-        //     { text: 'Handler Context', link: '/en/core/handler-context' },
-        //     { text: 'Request', link: '/en/core/request' },
-        //     { text: 'Response', link: '/en/core/response' },
-        //   ],
-        // },
-        // {
-        //   text: 'Extensions',
-        //   collapsed: true,
-        //   items: [
-        //     { text: 'Zod Schema', link: '/en/extensions/zod-schema' },
-        //     { text: 'Zod Validation', link: '/en/extensions/zod-validation' },
-        //     { text: 'Zod OpenAPI Plugin', link: '/en/extensions/zod-openapi-plugin' },
-        //     { text: 'CORS Plugin', link: '/en/extensions/cors-plugin' },
-        //     { text: 'Body Limit Plugin', link: '/en/extensions/body-limit-plugin' },
-        //     { text: 'Security Headers Plugin', link: '/en/extensions/security-headers-plugin' },
-        //     { text: 'File Plugin', link: '/en/extensions/file-plugin' },
-        //   ],
-        // },
-        // {
-        //   text: 'Examples',
-        //   collapsed: true,
-        //   items: [
-        //     { text: 'Basic Server', link: '/en/examples/basic-server' },
-        //     { text: 'REST API', link: '/en/examples/rest-api' },
-        //     { text: 'File Upload', link: '/en/examples/file-upload' },
-        //     { text: 'WebSocket', link: '/en/examples/websocket' },
-        //   ],
-        // },
       ],
       '/ja/': [
         {
@@ -115,40 +81,6 @@ export default defineConfig({
             { text: 'OpenAPI統合', link: '/ja/guide/openapi' },
           ],
         },
-        // {
-        //   text: 'コアAPI',
-        //   collapsed: true,
-        //   items: [
-        //     { text: 'Kori', link: '/ja/core/kori' },
-        //     { text: 'インスタンスコンテキスト', link: '/ja/core/instance-context' },
-        //     { text: 'ハンドラーコンテキスト', link: '/ja/core/handler-context' },
-        //     { text: 'リクエスト', link: '/ja/core/request' },
-        //     { text: 'レスポンス', link: '/ja/core/response' },
-        //   ],
-        // },
-        // {
-        //   text: '拡張機能',
-        //   collapsed: true,
-        //   items: [
-        //     { text: 'Zodスキーマ', link: '/ja/extensions/zod-schema' },
-        //     { text: 'Zodバリデーション', link: '/ja/extensions/zod-validation' },
-        //     { text: 'Zod OpenAPIプラグイン', link: '/ja/extensions/zod-openapi-plugin' },
-        //     { text: 'CORSプラグイン', link: '/ja/extensions/cors-plugin' },
-        //     { text: 'ボディ制限プラグイン', link: '/ja/extensions/body-limit-plugin' },
-        //     { text: 'セキュリティヘッダープラグイン', link: '/ja/extensions/security-headers-plugin' },
-        //     { text: 'ファイルプラグイン', link: '/ja/extensions/file-plugin' },
-        //   ],
-        // },
-        // {
-        //   text: '例',
-        //   collapsed: true,
-        //   items: [
-        //     { text: '基本的なサーバー', link: '/ja/examples/basic-server' },
-        //     { text: 'REST API', link: '/ja/examples/rest-api' },
-        //     { text: 'ファイルアップロード', link: '/ja/examples/file-upload' },
-        //     { text: 'WebSocket', link: '/ja/examples/websocket' },
-        //   ],
-        // },
       ],
     },
 
@@ -158,18 +90,12 @@ export default defineConfig({
         nav: [
           { text: 'Home', link: '/en/' },
           { text: 'Guide', link: '/en/guide/what-is-kori' },
-          // { text: 'Core', link: '/en/core/' },
-          // { text: 'Extensions', link: '/en/extensions/' },
-          // { text: 'Examples', link: '/en/examples/' },
         ],
       },
       ja: {
         nav: [
           { text: 'ホーム', link: '/ja/' },
           { text: 'ガイド', link: '/ja/guide/what-is-kori' },
-          // { text: 'コア', link: '/ja/core/' },
-          // { text: '拡張機能', link: '/ja/extensions/' },
-          // { text: '例', link: '/ja/examples/' },
         ],
       },
     },