feat: add a protocol for generate docs

package.json

@@ -15,6 +15,7 @@
     "build:ioc": "pnpm -F @nailyjs/ioc build",
     "build:backend": "pnpm -F @nailyjs/backend build",
     "build:rpc": "pnpm -F @nailyjs/rpc build",
+    "build:rpc-docs-protocol": "pnpm -F @nailyjs/rpc-docs-protocol build",
     "build:unplugin-rpc": "pnpm -F unplugin-rpc build",
     "play:rpc": "pnpm -F rpc-playground dev",
     "play:build": "pnpm -F rpc-playground build",

packages/rpc-protocol/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@nailyjs/rpc-docs-protocol",
+  "type": "module",
+  "version": "1.0.14",
+  "description": "Json-RPC 2.0 protocol docs implementation.",
+  "author": "Naily Zero <[email protected]> (https://naily.cc)",
+  "keywords": [
+    "json-rpc",
+    "rpc",
+    "naily"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "watch": "tsup -w"
+  },
+  "dependencies": {
+    "@nailyjs/rpc": "workspace:*",
+    "@types/json-schema": "^7.0.15",
+    "json-schema": "^0.4.0",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.0"
+  }
+}

packages/rpc-protocol/src/index.ts

@@ -0,0 +1,27 @@
+import type { JSONSchema7 as JSONSchema } from 'json-schema'
+
+export interface JsonRpcParamsObject {
+  description?: string
+  name?: string
+  required?: boolean
+  schema?: JSONSchema
+}
+
+export interface JsonRpcResultObject {
+  description?: string
+  schema?: JSONSchema
+}
+
+export interface JsonRpcDocsObject {
+  description?: string
+  summary?: string
+  tags?: string[]
+  params: JsonRpcParamsObject[]
+  result?: JsonRpcResultObject
+}
+
+export interface JsonRpcDoc {
+  jsonrpc: '2.0'
+  tags: string[]
+  docs: Record<string, JsonRpcDocsObject>
+}

packages/rpc-protocol/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "Bundler"
+  },
+  "include": ["src"]
+}

packages/rpc-protocol/tsup.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  entry: {
+    index: './src/index.ts',
+  },
+  dts: true,
+  sourcemap: true,
+  clean: true,
+  format: ['cjs', 'esm'],
+})