the-first-api

first-api/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"
+        }
+    ]
+}

first-api/backend/.vscode/settings.json

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

first-api/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.

first-api/backend/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "first-api-backend",
+  "version": "0.1.0",
+  "main": "index.js",
+  "private": true,
+  "scripts": {
+    "proto": "tsrpc proto -i src/shared/protocols -o src/shared/protocols/serviceProto.ts",
+    "sync": "tsrpc sync --from src/shared --to ../frontend/src/shared",
+    "api": "tsrpc api -i src/shared/protocols/serviceProto.ts -o src/api",
+    "dev": "onchange \"src/**/*.ts\" -i -k -- ts-node \"src/index.ts\"",
+    "build": "tsrpc build"
+  },
+  "devDependencies": {
+    "@types/node": "^15.12.2",
+    "onchange": "^7.1.0",
+    "ts-node": "^9.1.1",
+    "tsrpc-cli": "^2.0.1-dev.11",
+    "typescript": "^4.3.2"
+  },
+  "dependencies": {
+    "tsrpc": "^3.0.0-dev.17"
+  }
+}

first-api/backend/src/api/ApiHello.ts

@@ -0,0 +1,14 @@
+import { ApiCall } from "tsrpc";
+import { ReqHello, ResHello } from "../shared/protocols/PtlHello";
+
+export async function ApiHello(call: ApiCall<ReqHello, ResHello>) {
+    if (call.req.name === 'World') {
+        call.succ({
+            reply: 'Hello, ' + call.req.name,
+            time: new Date()
+        });
+    }
+    else {
+        call.error('Invalid name');
+    }
+}

first-api/backend/src/index.ts

@@ -0,0 +1,26 @@
+import * as path from "path";
+import { HttpServer } from "tsrpc";
+import { serviceProto } from "./shared/protocols/serviceProto";
+
+// Create the Server
+const server = new HttpServer(serviceProto, {
+    port: 3000,
+    cors: '*'
+});
+
+// Entry function
+async function main() {
+    // Auto implement APIs
+    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);
+});

first-api/backend/src/shared/protocols/PtlHello.ts

@@ -0,0 +1,8 @@
+export interface ReqHello {
+    name: string
+}
+
+export interface ResHello {
+    reply: string,
+    time: Date
+}

first-api/backend/src/shared/protocols/serviceProto.ts

@@ -0,0 +1,57 @@
+import { ServiceProto } from 'tsrpc-proto';
+import { ReqHello, ResHello } from './PtlHello';
+
+export interface ServiceType {
+    api: {
+        "Hello": {
+            req: ReqHello,
+            res: ResHello
+        }
+    },
+    msg: {
+
+    }
+}
+
+export const serviceProto: ServiceProto<ServiceType> = {
+    "services": [
+        {
+            "id": 0,
+            "name": "Hello",
+            "type": "api"
+        }
+    ],
+    "types": {
+        "PtlHello/ReqHello": {
+            "type": "Interface",
+            "properties": [
+                {
+                    "id": 0,
+                    "name": "name",
+                    "type": {
+                        "type": "String"
+                    }
+                }
+            ]
+        },
+        "PtlHello/ResHello": {
+            "type": "Interface",
+            "properties": [
+                {
+                    "id": 0,
+                    "name": "reply",
+                    "type": {
+                        "type": "String"
+                    }
+                },
+                {
+                    "id": 1,
+                    "name": "time",
+                    "type": {
+                        "type": "Date"
+                    }
+                }
+            ]
+        }
+    }
+};

first-api/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"
+  ]
+}