Publish Node SDK

.github/workflows/pr-sdk.yml

@@ -15,8 +15,55 @@ env:
   CARGO_PROFILE_TEST_DEBUG: 0
 
 jobs:
+  node-sdk:
+    name: Build Node SDK
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up Protoc
+        uses: arduino/setup-protoc@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Print version of protoc
+        run: protoc --version
+
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: npm
+          cache-dependency-path: sdk/node/package-lock.json
+
+      - name: Install Buf dependencies
+        run: npm install -g grpc_tools_node_protoc_ts grpc-tools
+
+      - name: Set up Buf
+        uses: bufbuild/buf-setup-action@v1.3.1
+
+      - name: Run Buf
+        working-directory: api
+        run: buf generate
+
+      - name: Install dependencies
+        working-directory: ./sdk/node
+        run: npm install
+
+      - name: Build Node client
+        working-directory: ./sdk/node
+        run: npm run build
+
+      - name: Upload Node SDK
+        uses: actions/upload-artifact@v3
+        with:
+          name: node-sdk
+          path: sdk/node/**
+
   test-server:
-    name: Build test-server
+    name: Build test server
     runs-on: ubuntu-latest
 
     steps:
@@ -44,6 +91,51 @@ jobs:
           name: test-server
           path: target/debug/test-server
 
+  javascript:
+    name: Test JavaScript bot
+    runs-on: ubuntu-latest
+
+    needs:
+      - node-sdk
+      - test-server
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: npm
+          cache-dependency-path: examples/javascript/package-lock.json
+
+      - name: Download Node SDK
+        uses: actions/download-artifact@v3
+        with:
+          name: node-sdk
+          path: sdk/node
+
+      - name: Install dependencies
+        working-directory: ./examples/javascript
+        run: npm install
+
+      - name: Download test-server
+        uses: actions/download-artifact@v3
+        with:
+          name: test-server
+          path: bin
+
+      - name: Set permissions for test-server
+        run: chmod +x bin/test-server
+
+      - name: Start test-server
+        run: bin/test-server &
+
+      - name: Run JavaScript example
+        working-directory: ./examples/javascript
+        run: npm start
+
   rust:
     name: Test Rust bot
     runs-on: ubuntu-latest
@@ -86,3 +178,48 @@ jobs:
         with:
           command: run
           args: -p auto-traffic-control-example
+
+  typescript:
+    name: Test TypeScript bot
+    runs-on: ubuntu-latest
+
+    needs:
+      - node-sdk
+      - test-server
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: npm
+          cache-dependency-path: examples/typescript/package-lock.json
+
+      - name: Download Node SDK
+        uses: actions/download-artifact@v3
+        with:
+          name: node-sdk
+          path: sdk/node
+
+      - name: Install dependencies
+        working-directory: ./examples/typescript
+        run: npm install
+
+      - name: Download test-server
+        uses: actions/download-artifact@v3
+        with:
+          name: test-server
+          path: bin
+
+      - name: Set permissions for test-server
+        run: chmod +x bin/test-server
+
+      - name: Start test-server
+        run: bin/test-server &
+
+      - name: Run JavaScript example
+        working-directory: ./examples/typescript
+        run: npm start

.github/workflows/release-sdk.yml

@@ -8,6 +8,58 @@ name: SDK
       - released
 
 jobs:
+  node:
+    name: Node
+    runs-on: ubuntu-latest
+
+    env:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+    steps:
+      - name: Set up Protoc
+        uses: arduino/setup-protoc@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Print version of protoc
+        run: protoc --version
+
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: npm
+          cache-dependency-path: sdk/node/package-lock.json
+
+      - name: Install Buf dependencies
+        run: npm install -g grpc_tools_node_protoc_plugin_ts grpc-tools
+
+      - name: Set up Buf
+        uses: bufbuild/buf-setup-action@v1.3.1
+
+      - name: Run Buf
+        working-directory: api
+        run: buf generate
+
+      - name: Install dependencies
+        working-directory: ./sdk/node
+        run: npm install
+
+      - name: Authenticate using a token
+        working-directory: ./sdk/node
+        run: echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > .npmrc
+
+      - name: Build Node client
+        working-directory: ./sdk/node
+        run: npm run build
+
+      - name: Publish to npm
+        working-directory: ./sdk/node
+        run: npm publish
+
   rust:
     name: Publish Rust SDK
     runs-on: ubuntu-latest

README.md

@@ -1,6 +1,6 @@
 # 🛬 Auto Traffic Control
 
-[![GitHub branch checks state](https://img.shields.io/github/checks-status/jdno/atc/main)](https://github.com/jdno/atc/actions)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jdno/auto-traffic-control/main)](https://github.com/jdno/auto-traffic-control/actions)
 
 [Homepage](https://auto-traffic-control.com) |
 [Documentation](https://auto-traffic-control.com/docs) |

api/buf.gen.yaml

@@ -0,0 +1,19 @@
+---
+version: v1
+
+managed:
+  enabled: true
+
+plugins:
+  - name: js
+    out: ../sdk/node/src
+    opt: import_style=commonjs,binary
+
+  - name: grpc
+    out: ../sdk/node/src
+    opt: grpc_js
+    path: grpc_tools_node_protoc_plugin
+
+  - name: ts
+    out: ../sdk/node/src
+    opt: grpc_js

examples/javascript/.gitignore

@@ -0,0 +1,51 @@
+### Node.gitignore
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local

examples/javascript/main.js

@@ -0,0 +1,29 @@
+import atc from "auto-traffic-control";
+
+const { getCredentials, AtcServiceClient, GetVersionRequest } = atc;
+
+const atcService = new AtcServiceClient("localhost:4747", getCredentials());
+
+atcService.getVersion(new GetVersionRequest(), (err, response) => {
+  if (err != null) {
+    throw err;
+  }
+
+  const version = response.getVersion();
+
+  if (version != null) {
+    let versionString = [
+      version.getMajor(),
+      version.getMinor(),
+      version.getPatch(),
+    ].join(".");
+
+    if (version.getPre() !== "") {
+      versionString = versionString.concat(version.getPre());
+    }
+
+    console.log(`Auto Traffic Control is running version '${versionString}'`);
+  } else {
+    throw new Error("Requesting the version returned an empty response.");
+  }
+});