@gongt/trpc-lib 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 GongT<admin@gongt.me>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,57 @@
+# library for [trpc](https://trpc.io/)
+
+
+## socket-io link
+
+复用socket-io的连接，执行trpc调用
+
+```ts
+// Client side
+import { createTRPCClient } from '@trpc/client';
+import { SocketIoLink } from '@gongt/trpc-lib/client';
+
+const client = createTRPCClient({
+  links: [
+    SocketIoLink({
+      url: 'ws://localhost:3000/socket.io/',
+	  namespace: '/trpc',
+    }),
+  ],
+});
+```
+
+```ts
+// Server side
+import { createSocketIoMiddleware } from '@gongt/trpc-lib/server';
+import { initTRPC } from '@trpc/server';
+
+const io = new SocketIO.Server({
+	path: '/socket.io/',
+	addTrailingSlash: true,
+	transports: ['websocket', 'polling'],
+});
+
+export const trpc = initTRPC.context<XXX>().create({});
+export const appRouter = trpc.router(...);
+
+io.of('/trpc').use(
+  createSocketIoMiddleware({
+	router: appRouter,
+  }),
+);
+```
+
+## api-extractor
+
+调用 [api-extractor](https://api-extractor.com/) 提取trpc的类型定义，生成客户端可用的类型文件，避免客户端依赖服务端。同时生成sourcemap保持调试友好
+
+```sh
+npx @gongt/trpc-lib extract ./lib/router.d.ts -o ../client/src/trpc-server-define.d.ts
+```
+
+说明:
+1. 必须编译，不能直接使用ts文件（例如./src/router.ts）
+1. 服务端`router.d.ts`中必须导出有且仅有一个 `BuiltRouter` 类型 （此类型来自 `@trpc/server`）
+1. 输出文件将会`import type xxx from '@trpc/server'`，因此客户端需要安装 `@trpc/server` 依赖，不过这个项目并不依赖 `@types/node` 之类的定义，所以不会污染客户端类型
+1. 如果源文件中存在 `import type xxx from '...'`，那么目标文件中也会存在相同的import语句，因此需要保证客户端也能找到这些类型定义，这些定义最好来自一个独立的包，否则提取操作没有意义
+   1. *输出文件实际也可以放入独立协议包中*

package/lib/bin/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/bin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/bin/index.ts"],"names":[],"mappings":""}

package/lib/bin/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/lib/bin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/bin/index.ts"],"names":[],"mappings":""}

package/lib/client/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":""}

package/lib/client/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/lib/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":""}

package/lib/server/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/server/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":""}

package/lib/server/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/lib/server/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":""}

package/loader/bin.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+import '@idlebox/source-map-support/register';
+
+process.title = `Trpc.Gen`;
+
+await import('../lib/bin/index.js');

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@gongt/trpc-lib",
+  "version": "1.0.0",
+  "description": "A tRPC library",
+  "keywords": [
+    "trpc",
+    "socket.io",
+    "api-extractor"
+  ],
+  "sideEffects": false,
+  "exports": {
+    "./server": {
+      "default": "./lib/server/index.js"
+    },
+    "./client": {
+      "default": "./lib/client/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "trpc-api-extractor": "./lib/extract.js"
+  },
+  "dependencies": {
+    "@trpc/server": "^11.5.1",
+    "@idlebox/common": "^1.5.10",
+    "@idlebox/node": "^1.4.19",
+    "@idlebox/source-map-support": "^0.0.13"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.14",
+    "@build-script/codegen": "^1.0.15",
+    "@build-script/single-dog-asset": "latest",
+    "@mpis/run": "^0.0.16"
+  },
+  "license": "MIT",
+  "author": "GongT <admin@gongt.me>",
+  "repository": "https://github.com/GongT/baobao",
+  "scripts": {
+    "build": "mpis-run build",
+    "watch": "mpis-run watch",
+    "clean": "mpis-run clean",
+    "lint": "internal-lint"
+  }
+}

package/src/tsconfig.json

@@ -0,0 +1,10 @@
+{
+	"extends": "@build-script/single-dog-asset/package/tsconfig.json",
+	"compilerOptions": {
+		"typeRoots": ["../node_modules/@types", "../node_modules"],
+		"outDir": "../lib",
+		"rootDir": "./",
+		"lib": ["ESNext"],
+		"types": ["node"]
+	}
+}