Unifies TypeScript packages and command names (#3195)

# Description of Changes

This PR:
 - standardizes the prettier config across all TypeScript projects
 - adds a root level package.json
 - standardizes all `pnpm` commands to be the same
 - updates documentation accordingly
- adds some additional typescript testing for serialization and
deserialization
 
**IMPORTANT!** Once this PR merges we will need to change the
`compile-and-test` required check to `build-and-test`

# API and ABI breaking changes

No breaking changes.

# Expected complexity level and risk

2 - It in principle doesn't change any code, but could affect deploy
processes.

# Testing

- [x] Just the automated testing that we had previously
- [x] I added additional automated tests

---------

Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>

Author: cloutiertyler

.github/workflows/ci.yml

@@ -254,19 +254,41 @@ jobs:
             GIT_REF="${{ github.ref }}"
           fi
           echo "GIT_REF=${GIT_REF}" >>"$GITHUB_ENV"
+
       - name: Checkout sources
         uses: actions/checkout@v4
         with:
           ref: ${{ env.GIT_REF }}
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - uses: pnpm/action-setup@v4
+        with:
+          run_install: true
+
+      - name: Get pnpm store directory
+        shell: bash
+        working-directory: sdks/typescript
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
       - uses: dsherret/rust-toolchain-file@v1
+
       - name: Check for docs change
         run: |
           cargo run --features markdown-docs -p spacetimedb-cli > docs/docs/cli-reference.md
-          cd docs
-          # This is needed because our website doesn't render markdown quite properly.
-          # See the README in docs for more details.
-          sed -i'' -E 's!^(##) `(.*)`$!\1 \2!' docs/cli-reference.md
-          sed -i'' -E 's!^(######) \*\*(.*)\*\*$!\1 <b>\2</b>!' docs/cli-reference.md
+          pnpm format
           git status
           if git diff --exit-code HEAD; then
             echo "No docs changes detected"
@@ -275,29 +297,3 @@ jobs:
             exit 1
           fi
 
-  license_check:
-    name: Check licenses
-    permissions: read-all
-    runs-on: ubuntu-latest
-    steps:
-      - name: Find Git ref
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        shell: bash
-        run: |
-          PR_NUMBER="${{ github.event.inputs.pr_number || null }}"
-          if test -n "${PR_NUMBER}"; then
-            GIT_REF="$( gh pr view --repo clockworklabs/SpacetimeDB $PR_NUMBER --json headRefName --jq .headRefName )"
-          else
-            GIT_REF="${{ github.ref }}"
-          fi
-          echo "GIT_REF=${GIT_REF}" >>"$GITHUB_ENV"
-      - name: Checkout sources
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ env.GIT_REF }}
-      - uses: dsherret/rust-toolchain-file@v1
-      - name: Check for invalid licenses
-        run: |
-          cd tools/license-check
-          cargo run

.github/workflows/docs-validate-nav-build.yml

@@ -18,12 +18,35 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
+      
+      - uses: pnpm/action-setup@v4
+        with:
+          run_install: true
+
+      - name: Get pnpm store directory
+        working-directory: sdks/typescript
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
 
       - name: Install dependencies
         working-directory: docs
         run: |
-          npm install
+          pnpm install
+      
+      - name: Lint
+        working-directory: docs
+        run: |
+          pnpm lint
 
       - name: Backup existing nav.js
         working-directory: docs
@@ -33,12 +56,12 @@ jobs:
       - name: Build nav.ts
         working-directory: docs
         run: |
-          npm run build
+          pnpm build
 
       - name: Compare generated nav.js with original nav.js
         working-directory: docs
         run: |
-          diff -q docs/nav.js docs/nav.js.original || (echo "Generated nav.js differs from committed version. Run 'npm run build' and commit the updated file." && exit 1)
+          diff -q docs/nav.js docs/nav.js.original || (echo "Generated nav.js differs from committed version. Run 'pnpm build' and commit the updated file." && exit 1)
 
       # We do this after checking that nav.js matches nav.ts, to avoid confusing error messages if an author updates one but not the other.
       # If the .ts and .js are in sync, it doesn't matter which one we check against here.

.github/workflows/typescript-lint.yml

@@ -22,7 +22,6 @@ jobs:
 
       - uses: pnpm/action-setup@v4
         with:
-          version: 9.7
           run_install: true
 
       - name: Get pnpm store directory

.github/workflows/typescript-test.yml

@@ -8,7 +8,7 @@ on:
   merge_group:
 
 jobs:
-  compile-and-test:
+  build-and-test:
     runs-on: ubuntu-latest
 
     steps:
@@ -22,7 +22,6 @@ jobs:
 
       - uses: pnpm/action-setup@v4
         with:
-          version: 9.7
           run_install: true
 
       - name: Get pnpm store directory
@@ -39,9 +38,9 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pnpm-store-
 
-      - name: Compile
+      - name: Build
         working-directory: sdks/typescript
-        run: pnpm compile
+        run: pnpm build
 
       - name: Run sdk tests
         working-directory: sdks/typescript/packages/sdk

crates/bindings-typescript/package.json

@@ -35,7 +35,6 @@
   "type": "module",
   "scripts": {
     "build": "tsc",
-    "compile": "pnpm run build",
     "format": "prettier --write .",
     "lint": "eslint . && prettier . --check",
     "test": "vitest run",

crates/bindings-typescript/src/connection_id.ts

@@ -4,21 +4,17 @@ import { hexStringToU128, u128ToHexString, u128ToUint8Array } from './utils';
  * A unique identifier for a client connected to a database.
  */
 export class ConnectionId {
-  data: bigint;
-
-  get __connection_id__(): bigint {
-    return this.data;
-  }
+  __connection_id__: bigint;
 
   /**
    * Creates a new `ConnectionId`.
    */
   constructor(data: bigint) {
-    this.data = data;
+    this.__connection_id__ = data;
   }
 
   isZero(): boolean {
-    return this.data === BigInt(0);
+    return this.__connection_id__ === BigInt(0);
   }
 
   static nullIfZero(addr: ConnectionId): ConnectionId | null {
@@ -44,21 +40,21 @@ export class ConnectionId {
    * Compare two connection IDs for equality.
    */
   isEqual(other: ConnectionId): boolean {
-    return this.data == other.data;
+    return this.__connection_id__ == other.__connection_id__;
   }
 
   /**
    * Print the connection ID as a hexadecimal string.
    */
   toHexString(): string {
-    return u128ToHexString(this.data);
+    return u128ToHexString(this.__connection_id__);
   }
 
   /**
    * Convert the connection ID to a Uint8Array.
    */
   toUint8Array(): Uint8Array {
-    return u128ToUint8Array(this.data);
+    return u128ToUint8Array(this.__connection_id__);
   }
 
   /**

crates/bindings-typescript/src/identity.ts

@@ -4,11 +4,7 @@ import { hexStringToU256, u256ToHexString, u256ToUint8Array } from './utils';
  * A unique identifier for a user connected to a database.
  */
 export class Identity {
-  data: bigint;
-
-  get __identity__(): bigint {
-    return this.data;
-  }
+  __identity__: bigint;
 
   /**
    * Creates a new `Identity`.
@@ -18,7 +14,7 @@ export class Identity {
   constructor(data: string | bigint) {
     // we get a JSON with __identity__ when getting a token with a JSON API
     // and an bigint when using BSATN
-    this.data = typeof data === 'string' ? hexStringToU256(data) : data;
+    this.__identity__ = typeof data === 'string' ? hexStringToU256(data) : data;
   }
 
   /**
@@ -32,14 +28,14 @@ export class Identity {
    * Print the identity as a hexadecimal string.
    */
   toHexString(): string {
-    return u256ToHexString(this.data);
+    return u256ToHexString(this.__identity__);
   }
 
   /**
    * Convert the address to a Uint8Array.
    */
   toUint8Array(): Uint8Array {
-    return u256ToUint8Array(this.data);
+    return u256ToUint8Array(this.__identity__);
   }
 
   /**

docs/.prettierignore

@@ -0,0 +1,2 @@
+**/*.md
+**/*.html