readme

README.md

@@ -15,5 +15,4 @@ Start local frontend server:
 ```
 cd <example-dir>/frontend
 npm install
-npm run dev
 ```

examples/chatroom/backend/package.json

@@ -15,10 +15,10 @@
     "@types/node": "^15.14.9",
     "onchange": "^7.1.0",
     "ts-node": "^9.1.1",
-    "tsrpc-cli": "^2.0.8",
-    "typescript": "^4.4.3"
+    "tsrpc-cli": "^2.4.0",
+    "typescript": "^4.5.5"
   },
   "dependencies": {
-    "tsrpc": "^3.0.9"
+    "tsrpc": "^3.2.0"
   }
 }

examples/chatroom/frontend/package.json

@@ -7,15 +7,15 @@
     "build": "webpack --mode=production"
   },
   "devDependencies": {
-    "copy-webpack-plugin": "^9.0.1",
-    "html-webpack-plugin": "^5.3.2",
+    "copy-webpack-plugin": "^9.1.0",
+    "html-webpack-plugin": "^5.5.0",
     "ts-loader": "^9.2.6",
-    "typescript": "^4.4.3",
-    "webpack": "^5.57.1",
-    "webpack-cli": "^4.9.0",
-    "webpack-dev-server": "^3.11.2"
+    "typescript": "^4.5.5",
+    "webpack": "^5.69.1",
+    "webpack-cli": "^4.9.2",
+    "webpack-dev-server": "^3.11.3"
   },
   "dependencies": {
-    "tsrpc-browser": "^3.0.7"
+    "tsrpc-browser": "^3.2.0"
   }
 }

examples/client-mock/backend/package.json

@@ -14,11 +14,11 @@
   "devDependencies": {
     "@types/node": "^15.14.9",
     "onchange": "^7.1.0",
-    "ts-node": "^10.2.1",
-    "tsrpc-cli": "^2.0.8",
-    "typescript": "^4.4.3"
+    "ts-node": "^10.5.0",
+    "tsrpc-cli": "^2.4.0",
+    "typescript": "^4.5.5"
   },
   "dependencies": {
-    "tsrpc": "^3.0.9"
+    "tsrpc": "^3.2.0"
   }
 }

examples/client-mock/frontend/package.json

@@ -7,16 +7,16 @@
     "build": "webpack --mode=production"
   },
   "devDependencies": {
-    "copy-webpack-plugin": "^9.0.1",
-    "html-webpack-plugin": "^5.3.2",
+    "copy-webpack-plugin": "^9.1.0",
+    "html-webpack-plugin": "^5.5.0",
     "ts-loader": "^9.2.6",
-    "typescript": "^4.4.3",
-    "webpack": "^5.57.1",
-    "webpack-cli": "^4.9.0",
-    "webpack-dev-server": "^3.11.2"
+    "typescript": "^4.5.5",
+    "webpack": "^5.69.1",
+    "webpack-cli": "^4.9.2",
+    "webpack-dev-server": "^3.11.3"
   },
   "dependencies": {
-    "tsrpc-browser": "^3.0.7"
+    "tsrpc-browser": "^3.2.0"
   },
   "browserslist": [
     "defaults"

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

@@ -15,10 +15,10 @@
     "@types/node": "^15.14.9",
     "onchange": "^7.1.0",
     "ts-node": "^9.1.1",
-    "tsrpc-cli": "^2.2.0",
-    "typescript": "^4.5.2"
+    "tsrpc-cli": "^2.4.0",
+    "typescript": "^4.5.5"
   },
   "dependencies": {
-    "tsrpc": "^3.1.2"
+    "tsrpc": "^3.2.0"
   }
 }

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

@@ -9,7 +9,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "tsrpc-browser": "^3.1.2",
-    "tsrpc-miniapp": "^3.1.2"
+    "tsrpc-browser": "^3.2.0",
+    "tsrpc-miniapp": "^3.2.0"
   }
 }

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

@@ -15,10 +15,10 @@
     "@types/node": "^15.14.9",
     "onchange": "^7.1.0",
     "ts-node": "^9.1.1",
-    "tsrpc-cli": "^2.2.0",
-    "typescript": "^4.5.2"
+    "tsrpc-cli": "^2.4.0",
+    "typescript": "^4.5.5"
   },
   "dependencies": {
-    "tsrpc": "^3.1.2"
+    "tsrpc": "^3.2.0"
   }
 }

examples/cocos-creator-3.3.0/frontend/package.json

@@ -4,7 +4,7 @@
   "uuid": "cd1e2fff-2ab5-4407-b917-e60b25207723",
   "version": "3.3.2",
   "dependencies": {
-    "tsrpc-browser": "^3.1.2",
-    "tsrpc-miniapp": "^3.1.2"
+    "tsrpc-browser": "^3.2.0",
+    "tsrpc-miniapp": "^3.2.0"
   }
 }

examples/file-upload/backend/package.json

@@ -15,10 +15,10 @@
     "@types/node": "^15.14.9",
     "onchange": "^7.1.0",
     "ts-node": "^9.1.1",
-    "tsrpc-cli": "^2.0.8",
-    "typescript": "^4.4.3"
+    "tsrpc-cli": "^2.4.0",
+    "typescript": "^4.5.5"
   },
   "dependencies": {
-    "tsrpc": "^3.0.9"
+    "tsrpc": "^3.2.0"
   }
 }

examples/file-upload/backend/src/index.ts

@@ -6,7 +6,8 @@ import { serviceProto } from "./shared/protocols/serviceProto";
 // Create the Server
 const server = new HttpServer(serviceProto, {
     port: 3000,
-    cors: '*'
+    cors: '*',
+    json: true
 });
 
 // Flow: Serve static files

examples/file-upload/frontend/package.json

@@ -7,15 +7,15 @@
     "build": "webpack --mode=production"
   },
   "devDependencies": {
-    "copy-webpack-plugin": "^9.0.1",
-    "html-webpack-plugin": "^5.3.2",
+    "copy-webpack-plugin": "^9.1.0",
+    "html-webpack-plugin": "^5.5.0",
     "ts-loader": "^9.2.6",
-    "typescript": "^4.4.3",
-    "webpack": "^5.57.1",
-    "webpack-cli": "^4.9.0",
-    "webpack-dev-server": "^3.11.2"
+    "typescript": "^4.5.5",
+    "webpack": "^5.69.1",
+    "webpack-cli": "^4.9.2",
+    "webpack-dev-server": "^3.11.3"
   },
   "dependencies": {
-    "tsrpc-browser": "^3.0.7"
+    "tsrpc-browser": "^3.2.0"
   }
 }

examples/first-api/backend/package.json

@@ -19,6 +19,6 @@
     "typescript": "^4.4.3"
   },
   "dependencies": {
-    "tsrpc": "^3.0.9"
+    "tsrpc": "^3.1.8"
   }
-}
+}

examples/mongodb-crud/backend/.mocharc.js

@@ -4,5 +4,8 @@ module.exports = {
     ],
     timeout: 999999,
     exit: true,
-    'preserve-symlinks': true
+    'preserve-symlinks': true,
+    spec: [
+        './test/**/*.test.ts'
+    ]
 }

examples/mongodb-crud/backend/package.json

@@ -9,20 +9,21 @@
     "api": "tsrpc api",
     "doc": "tsrpc doc",
     "dev": "tsrpc dev",
-    "build": "tsrpc build"
+    "build": "tsrpc build",
+    "test": "mocha"
   },
   "devDependencies": {
     "@types/mocha": "^8.2.3",
     "@types/mongodb": "^3.6.20",
     "@types/node": "^15.14.9",
-    "mocha": "^9.1.2",
+    "mocha": "^9.2.1",
     "onchange": "^7.1.0",
-    "ts-node": "^10.2.1",
-    "tsrpc-cli": "^2.0.8",
-    "typescript": "^4.4.3"
+    "ts-node": "^10.5.0",
+    "tsrpc-cli": "^2.4.0",
+    "typescript": "^4.5.5"
   },
   "dependencies": {
-    "mongodb": "^3.7.2",
-    "tsrpc": "^3.0.9"
+    "mongodb": "^4.4.0",
+    "tsrpc": "^3.2.0"
   }
-}
+}

examples/mongodb-crud/backend/src/api/ApiAddPost.ts

@@ -1,3 +1,4 @@
+import { Document, ObjectId } from "mongodb";
 import { ApiCall } from "tsrpc";
 import { Global } from "../models/Global";
 import { ReqAddPost, ResAddPost } from "../shared/protocols/PtlAddPost";

examples/mongodb-crud/backend/src/api/ApiDelPost.ts

@@ -1,11 +1,11 @@
-import { ObjectID } from 'mongodb';
+import { ObjectId } from 'mongodb';
 import { ApiCall } from "tsrpc";
 import { Global } from "../models/Global";
 import { ReqDelPost, ResDelPost } from "../shared/protocols/PtlDelPost";
 
 export async function ApiDelPost(call: ApiCall<ReqDelPost, ResDelPost>) {
     let op = await Global.collection('Post').deleteOne({
-        _id: new ObjectID(call.req._id)
+        _id: call.req._id
     })
 
     call.succ({});

examples/mongodb-crud/backend/src/api/ApiGetPost.ts

@@ -1,11 +1,11 @@
-import { ObjectID } from 'mongodb';
+import { ObjectId } from 'mongodb';
 import { ApiCall } from "tsrpc";
 import { Global } from "../models/Global";
 import { ReqGetPost, ResGetPost } from "../shared/protocols/PtlGetPost";
 
 export async function ApiGetPost(call: ApiCall<ReqGetPost, ResGetPost>) {
     let op = await Global.collection('Post').findOne({
-        _id: new ObjectID(call.req._id)
+        _id: call.req._id
     });
 
     if (!op) {
@@ -16,7 +16,7 @@ export async function ApiGetPost(call: ApiCall<ReqGetPost, ResGetPost>) {
     call.succ({
         post: {
             ...op,
-            _id: op._id.toHexString()
+            _id: op._id
         }
     })
 }

examples/mongodb-crud/backend/src/api/ApiUpdatePost.ts

@@ -1,16 +1,16 @@
-import { ObjectID } from 'mongodb';
+import { ObjectId } from 'mongodb';
 import { ApiCall } from "tsrpc";
 import { Global } from "../models/Global";
 import { ReqUpdatePost, ResUpdatePost } from "../shared/protocols/PtlUpdatePost";
 
 export async function ApiUpdatePost(call: ApiCall<ReqUpdatePost, ResUpdatePost>) {
-    let { _id, ...update } = call.req.update;
+    let { _id, ...rest } = call.req.update;
 
     let op = await Global.collection('Post').updateOne({
-        _id: new ObjectID(_id)
+        _id: _id
     }, {
         $set: {
-            ...update,
+            ...rest,
             update: {
                 uid: 'xxx',
                 time: new Date()

examples/mongodb-crud/backend/src/models/BackConfig.ts

@@ -1,4 +1,4 @@
 export const BackConfig = {
     // Please replace by your db
-    mongoDb: 'mongodb://username:password@xxx.com:27017/test?authSource=admin',
+    mongoDb: 'mongodb+srv://test:test@tsrpc-example.0gzai.mongodb.net/tsrpc-example?retryWrites=true&w=majority',
 }

examples/mongodb-crud/backend/src/models/Global.ts

@@ -1,7 +1,7 @@
-import { Collection, Db, MongoClient } from "mongodb";
+import { Collection, Db, MongoClient, OptionalId } from "mongodb";
 import { Logger } from "tsrpc";
+import { DbPost } from "../shared/db/DbPost";
 import { BackConfig } from "./BackConfig";
-import { DbPost } from "./dbItems/DbPost";
 
 export class Global {
 
@@ -14,7 +14,7 @@ export class Global {
         this.db = client.db();
     }
 
-    static collection<T extends keyof DbCollectionType>(col: T): Collection<DbCollectionType[T]> {
+    static collection<T extends keyof DbCollectionType>(col: T): Collection<OptionalId<DbCollectionType[T]>> {
         return this.db.collection(col);
     }
 

examples/mongodb-crud/backend/src/models/dbItems/DbPost.ts

@@ -1,7 +0,0 @@
-import { ObjectID } from "mongodb";
-import { Overwrite } from "tsrpc";
-import { Post } from "../../shared/protocols/models/Post";
-
-export type DbPost = Overwrite<Post, {
-    _id: ObjectID
-}>

examples/mongodb-crud/backend/src/shared/db/DbPost.ts

@@ -1,5 +1,7 @@
-export interface Post {
-    _id: string;
+import { ObjectId } from "mongodb";
+
+export interface DbPost {
+    _id: ObjectId;
     author: string;
     title: string;
     content: string;

examples/mongodb-crud/backend/src/shared/protocols/PtlAddPost.ts

@@ -1,7 +1,7 @@
-import { Post } from "./models/Post";
+import { DbPost } from "../db/DbPost";
 
 export interface ReqAddPost {
-    newPost: Omit<Post, '_id' | 'create' | 'update' | 'visitedNum'>;
+    newPost: Omit<DbPost, '_id' | 'create' | 'update' | 'visitedNum'>;
 }
 
 export interface ResAddPost {

examples/mongodb-crud/backend/src/shared/protocols/PtlDelPost.ts

@@ -1,5 +1,7 @@
+import { ObjectId } from "bson";
+
 export interface ReqDelPost {
-    _id: string;
+    _id: ObjectId;
 }
 
 export interface ResDelPost {

examples/mongodb-crud/backend/src/shared/protocols/PtlGetPost.ts

@@ -1,9 +1,10 @@
-import { Post } from "./models/Post";
+import { ObjectId } from "bson";
+import { DbPost } from "../db/DbPost";
 
 export interface ReqGetPost {
-    _id: string;
+    _id: ObjectId;
 }
 
 export interface ResGetPost {
-    post: Post;
+    post: DbPost;
 }

examples/mongodb-crud/backend/src/shared/protocols/PtlUpdatePost.ts

@@ -1,7 +1,7 @@
-import { Post } from "./models/Post";
+import { DbPost } from "../db/DbPost";
 
 export interface ReqUpdatePost {
-    update: { _id: string } & Partial<Pick<Post, 'title' | 'content'>>;
+    update: Pick<DbPost, '_id'> & Partial<Pick<DbPost, 'title' | 'content'>>;
 }
 
 export interface ResUpdatePost {

examples/mongodb-crud/backend/src/shared/protocols/serviceProto.ts

@@ -29,7 +29,7 @@ export interface ServiceType {
 }
 
 export const serviceProto: ServiceProto<ServiceType> = {
-    "version": 16,
+    "version": 17,
     "services": [
         {
             "id": 0,
@@ -62,7 +62,7 @@ export const serviceProto: ServiceProto<ServiceType> = {
                     "type": {
                         "target": {
                             "type": "Reference",
-                            "target": "models/Post/Post"
+                            "target": "../db/DbPost/DbPost"
                         },
                         "keys": [
                             "_id",
@@ -75,14 +75,15 @@ export const serviceProto: ServiceProto<ServiceType> = {
                 }
             ]
         },
-        "models/Post/Post": {
+        "../db/DbPost/DbPost": {
             "type": "Interface",
             "properties": [
                 {
                     "id": 0,
                     "name": "_id",
                     "type": {
-                        "type": "String"
+                        "type": "Reference",
+                        "target": "?mongodb/ObjectId"
                     }
                 },
                 {
@@ -181,7 +182,8 @@ export const serviceProto: ServiceProto<ServiceType> = {
                     "id": 0,
                     "name": "_id",
                     "type": {
-                        "type": "String"
+                        "type": "Reference",
+                        "target": "?bson/ObjectId"
                     }
                 }
             ]
@@ -196,7 +198,8 @@ export const serviceProto: ServiceProto<ServiceType> = {
                     "id": 0,
                     "name": "_id",
                     "type": {
-                        "type": "String"
+                        "type": "Reference",
+                        "target": "?bson/ObjectId"
                     }
                 }
             ]
@@ -209,7 +212,7 @@ export const serviceProto: ServiceProto<ServiceType> = {
                     "name": "post",
                     "type": {
                         "type": "Reference",
-                        "target": "models/Post/Post"
+                        "target": "../db/DbPost/DbPost"
                     }
                 }
             ]
@@ -224,28 +227,26 @@ export const serviceProto: ServiceProto<ServiceType> = {
                         "type": "Intersection",
                         "members": [
                             {
-                                "id": 1,
+                                "id": 4,
                                 "type": {
-                                    "type": "Interface",
-                                    "properties": [
-                                        {
-                                            "id": 0,
-                                            "name": "_id",
-                                            "type": {
-                                                "type": "String"
-                                            }
-                                        }
-                                    ]
+                                    "target": {
+                                        "type": "Reference",
+                                        "target": "../db/DbPost/DbPost"
+                                    },
+                                    "keys": [
+                                        "_id"
+                                    ],
+                                    "type": "Pick"
                                 }
                             },
                             {
-                                "id": 3,
+                                "id": 5,
                                 "type": {
                                     "type": "Partial",
                                     "target": {
                                         "target": {
                                             "type": "Reference",
-                                            "target": "models/Post/Post"
+                                            "target": "../db/DbPost/DbPost"
                                         },
                                         "keys": [
                                             "title",

examples/mongodb-crud/frontend/package.json

@@ -7,16 +7,16 @@
     "build": "webpack --mode=production"
   },
   "devDependencies": {
-    "copy-webpack-plugin": "^9.0.1",
-    "html-webpack-plugin": "^5.3.2",
+    "copy-webpack-plugin": "^9.1.0",
+    "html-webpack-plugin": "^5.5.0",
     "ts-loader": "^9.2.6",
-    "typescript": "^4.4.3",
-    "webpack": "^5.57.1",
-    "webpack-cli": "^4.9.0",
-    "webpack-dev-server": "^3.11.2"
+    "typescript": "^4.5.5",
+    "webpack": "^5.69.1",
+    "webpack-cli": "^4.9.2",
+    "webpack-dev-server": "^3.11.3"
   },
   "dependencies": {
-    "tsrpc-browser": "^3.0.7"
+    "tsrpc-browser": "^3.2.0"
   },
   "browserslist": [
     "defaults"

examples/mongodb-crud/frontend/src/env.d.ts

@@ -0,0 +1,9 @@
+// TSRPC would decode ObjectId as string in frontend.
+declare module 'mongodb' {
+    export type ObjectId = string;
+    export type ObjectID = string;
+}
+declare module 'bson' {
+    export type ObjectId = string;
+    export type ObjectID = string;
+}