tsrpc creator 2.4.7 demo

examples/cocos-creator-2.4.7/backend/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+.DS_STORE

examples/cocos-creator-2.4.7/backend/.vscode/launch.json

@@ -0,0 +1,30 @@
+{
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "mocha current file",
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "args": [
+                "${file}"
+            ],
+            "internalConsoleOptions": "openOnSessionStart",
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "ts-node current file",
+            "protocol": "inspector",
+            "args": [
+                "${relativeFile}"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register"
+            ],
+            "internalConsoleOptions": "openOnSessionStart"
+        }
+    ]
+}

examples/cocos-creator-2.4.7/backend/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "typescript.tsdk": "node_modules\\typescript\\lib"
+}

examples/cocos-creator-2.4.7/backend/README.md

@@ -0,0 +1,35 @@
+# TSRPC Server
+
+## Run
+### Local Dev Server
+```
+npm run dev
+```
+
+
+
+### Build
+```
+npm run build
+```
+
+---
+
+## Files
+### Generate ServiceProto
+```
+npm run proto
+```
+
+### Generate API templates
+```
+npm run api
+```
+
+### Sync shared code to client
+
+```
+npm run sync
+```
+
+> If you chose symlink when using `create-tsrpc-app`, it would re-create the symlink instead of copy files.

examples/cocos-creator-2.4.7/backend/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "chatroom-backend",
+  "version": "0.1.0",
+  "main": "index.js",
+  "private": true,
+  "scripts": {
+    "proto": "tsrpc proto --config tsrpc.config.ts",
+    "sync": "tsrpc sync --config tsrpc.config.ts",
+    "api": "tsrpc api --config tsrpc.config.ts",
+    "dev": "tsrpc dev --config tsrpc.config.ts",
+    "build": "tsrpc build --config tsrpc.config.ts"
+  },
+  "devDependencies": {
+    "@types/node": "^15.14.9",
+    "onchange": "^7.1.0",
+    "ts-node": "^9.1.1",
+    "tsrpc-cli": "^2.2.0",
+    "typescript": "^4.5.2"
+  },
+  "dependencies": {
+    "tsrpc": "^3.1.2"
+  }
+}

examples/cocos-creator-2.4.7/backend/src/api/ApiSend.ts

@@ -0,0 +1,23 @@
+import { ApiCall } from "tsrpc";
+import { server } from "..";
+import { ReqSend, ResSend } from "../shared/protocols/PtlSend";
+
+export async function ApiSend(call: ApiCall<ReqSend, ResSend>) {
+    // Error
+    if (call.req.content.length === 0) {
+        call.error('Content is empty')
+        return;
+    }
+
+    // Success
+    let time = new Date();
+    call.succ({
+        time: time
+    });
+
+    // Broadcast
+    server.broadcastMsg('Chat', {
+        content: call.req.content,
+        time: time
+    })
+}

examples/cocos-creator-2.4.7/backend/src/index.ts

@@ -0,0 +1,24 @@
+import * as path from "path";
+import { WsServer } from "tsrpc";
+import { serviceProto } from './shared/protocols/serviceProto';
+
+// Create the Server
+export const server = new WsServer(serviceProto, {
+    port: 3000
+});
+
+// Entry function
+async function main() {
+    await server.autoImplementApi(path.resolve(__dirname, 'api'));
+
+    // TODO
+    // Prepare something... (e.g. connect the db)
+
+    await server.start();
+};
+
+main().catch(e => {
+    // Exit if any error during the startup
+    server.logger.error(e);
+    process.exit(-1);
+});

examples/cocos-creator-2.4.7/backend/src/shared/protocols.meta

@@ -0,0 +1,13 @@
+{
+  "ver": "1.1.3",
+  "uuid": "40721700-8121-4c1e-be92-c90e93cdc4c8",
+  "importer": "directory",
+  "isBundle": false,
+  "bundleName": "",
+  "priority": 1,
+  "compressionType": {},
+  "optimizeHotUpdate": {},
+  "inlineSpriteFrames": {},
+  "isRemoteBundle": {},
+  "subMetas": {}
+}

examples/cocos-creator-2.4.7/backend/src/shared/protocols/MsgChat.ts

@@ -0,0 +1,4 @@
+export interface MsgChat {
+    content: string,
+    time: Date
+}

examples/cocos-creator-2.4.7/backend/src/shared/protocols/MsgChat.ts.meta

@@ -0,0 +1,10 @@
+{
+  "ver": "1.1.0",
+  "uuid": "43723a09-6be4-404b-a21a-22ad675d0e58",
+  "importer": "typescript",
+  "isPlugin": false,
+  "loadPluginInWeb": true,
+  "loadPluginInNative": true,
+  "loadPluginInEditor": false,
+  "subMetas": {}
+}

examples/cocos-creator-2.4.7/backend/src/shared/protocols/PtlSend.ts

@@ -0,0 +1,7 @@
+export interface ReqSend {
+    content: string
+}
+
+export interface ResSend {
+    time: Date
+}

examples/cocos-creator-2.4.7/backend/src/shared/protocols/PtlSend.ts.meta

@@ -0,0 +1,10 @@
+{
+  "ver": "1.1.0",
+  "uuid": "48e989fd-b5a5-4a5b-ac68-71d7f7f3d8ee",
+  "importer": "typescript",
+  "isPlugin": false,
+  "loadPluginInWeb": true,
+  "loadPluginInNative": true,
+  "loadPluginInEditor": false,
+  "subMetas": {}
+}

examples/cocos-creator-2.4.7/backend/src/shared/protocols/serviceProto.ts

@@ -0,0 +1,75 @@
+import { ServiceProto } from 'tsrpc-proto';
+import { MsgChat } from './MsgChat';
+import { ReqSend, ResSend } from './PtlSend';
+
+export interface ServiceType {
+    api: {
+        "Send": {
+            req: ReqSend,
+            res: ResSend
+        }
+    },
+    msg: {
+        "Chat": MsgChat
+    }
+}
+
+export const serviceProto: ServiceProto<ServiceType> = {
+    "services": [
+        {
+            "id": 0,
+            "name": "Chat",
+            "type": "msg"
+        },
+        {
+            "id": 1,
+            "name": "Send",
+            "type": "api"
+        }
+    ],
+    "types": {
+        "MsgChat/MsgChat": {
+            "type": "Interface",
+            "properties": [
+                {
+                    "id": 0,
+                    "name": "content",
+                    "type": {
+                        "type": "String"
+                    }
+                },
+                {
+                    "id": 1,
+                    "name": "time",
+                    "type": {
+                        "type": "Date"
+                    }
+                }
+            ]
+        },
+        "PtlSend/ReqSend": {
+            "type": "Interface",
+            "properties": [
+                {
+                    "id": 0,
+                    "name": "content",
+                    "type": {
+                        "type": "String"
+                    }
+                }
+            ]
+        },
+        "PtlSend/ResSend": {
+            "type": "Interface",
+            "properties": [
+                {
+                    "id": 0,
+                    "name": "time",
+                    "type": {
+                        "type": "Date"
+                    }
+                }
+            ]
+        }
+    }
+};

examples/cocos-creator-2.4.7/backend/src/shared/protocols/serviceProto.ts.meta

@@ -0,0 +1,10 @@
+{
+  "ver": "1.1.0",
+  "uuid": "aeef551d-77fd-412f-be4b-4ea615a24639",
+  "importer": "typescript",
+  "isPlugin": false,
+  "loadPluginInWeb": true,
+  "loadPluginInNative": true,
+  "loadPluginInEditor": false,
+  "subMetas": {}
+}

examples/cocos-creator-2.4.7/backend/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "es2018"
+    ],
+    "module": "commonjs",
+    "target": "es2018",
+    "outDir": "dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node"
+  },
+  "include": [
+    "src"
+  ]
+}

examples/cocos-creator-2.4.7/backend/tsrpc.config.ts

@@ -0,0 +1,36 @@
+import { TsrpcConfig } from 'tsrpc-cli';
+
+const tsrpcConf: TsrpcConfig = {
+    // Generate ServiceProto
+    proto: [
+        {
+            ptlDir: 'src/shared/protocols', // Protocol dir
+            output: 'src/shared/protocols/serviceProto.ts', // Path for generated ServiceProto
+            apiDir: 'src/api'   // API dir
+        }
+    ],
+    // Sync shared code
+    sync: [
+        {
+            from: 'src/shared',
+            to: '../frontend/assets/scripts/shared',
+            type: 'symlink'     // Change this to 'copy' if your environment not support symlink
+        }
+    ],
+    // Dev server
+    dev: {
+        autoProto: true,        // Auto regenerate proto
+        autoSync: true,         // Auto sync when file changed
+        autoApi: true,          // Auto create API when ServiceProto updated
+        watch: 'src',           // Restart dev server when these files changed
+        entry: 'src/index.ts',  // Dev server command: node -r ts-node/register {entry}
+    },
+    // Build config
+    build: {
+        autoProto: true,        // Auto generate proto before build
+        autoSync: true,         // Auto sync before build
+        autoApi: true,          // Auto generate API before build
+        outDir: 'dist',         // Clean this dir before build
+    }
+}
+export default tsrpcConf;