Companion to SpacetimeDB#1940

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": [
+    "@changesets/changelog-github",
+    { "repo": "clockworklabs/spacetimedb-typescript-sdk" }
+  ],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/dull-mangos-appear.md

@@ -0,0 +1,5 @@
+---
+'@clockworklabs/spacetimedb-sdk': patch
+---
+
+fix: websocket message handling, Buffer, onConnect

.changeset/long-laws-mix.md

@@ -0,0 +1,5 @@
+---
+'@clockworklabs/spacetimedb-sdk': minor
+---
+
+Support light tx updates via builder.with*light_mode(*) and the call flag NoSuccessNotify

.changeset/pre.json

@@ -0,0 +1,16 @@
+{
+  "mode": "pre",
+  "tag": "rc1",
+  "initialVersions": {
+    "client-vite": "0.0.2",
+    "@clockworklabs/spacetimedb-sdk": "0.12.1",
+    "@clockworklabs/test-app": "0.0.2"
+  },
+  "changesets": [
+    "dull-mangos-appear",
+    "long-laws-mix",
+    "smart-dogs-listen",
+    "three-cats-listen",
+    "two-garlics-sin"
+  ]
+}

.changeset/smart-dogs-listen.md

@@ -0,0 +1,5 @@
+---
+'@clockworklabs/spacetimedb-sdk': major
+---
+
+Enter RC

.changeset/three-cats-listen.md

@@ -0,0 +1,5 @@
+---
+'@clockworklabs/spacetimedb-sdk': minor
+---
+
+Update Identity and Address to use bigints rather than byte arrays (see https://github.com/clockworklabs/SpacetimeDB/pull/1616)

.changeset/two-garlics-sin.md

@@ -0,0 +1,5 @@
+---
+'@clockworklabs/spacetimedb-sdk': major
+---
+
+feat: Switch to GZIP compression by default

.gitattributes

@@ -0,0 +1,2 @@
+src/client_api/*.ts linguist-generated=true
+examples/quickstart/client/src/module_bindings/*.ts linguist-generated=true

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+## Description of Changes
+
+_Describe what has been changed, any new features or bug fixes_
+
+## API
+
+- [ ] This is an API breaking change to the SDK
+
+_If the API is breaking, please state below what will break_
+
+## Requires SpacetimeDB PRs
+
+_List any PRs here that are required for this SDK change to work_

.github/workflows/cr.yml

@@ -0,0 +1,24 @@
+name: Continuous Releases
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9.7
+          run_install: true
+
+      - name: Build
+        run: pnpm compile
+
+      - name: Release
+        run: cd packages/sdk && pnpm dlx pkg-pr-new publish --compact --pnpm

.github/workflows/lint.yml

@@ -0,0 +1,38 @@
+name: Lint
+
+on:
+  push:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9.7
+          run_install: true
+
+      - name: Get pnpm store directory
+        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: Lint
+        run: pnpm lint

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: Publish
+on:
+  push:
+    branches:
+      - 'main'
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+      packages: write
+      pull-requests: write
+      issues: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9.7
+          run_install: true
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: 'pnpm'
+
+      - run: pnpm compile
+
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          publish: pnpm run ci:release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9.7
+          run_install: true
+
+      - name: Get pnpm store directory
+        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: Build
+        run: pnpm compile
+
+      - name: Run tests
+        run: pnpm test

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 .envrc
 dist/
+.DS_Store

.npmignore

@@ -1,4 +1,3 @@
 tests
-jest.config.js
 .envrc
 node_modules

.prettierignore

@@ -0,0 +1,4 @@
+node_modules
+pnpm-lock.yaml
+dist
+target

.prettierrc

@@ -0,0 +1,11 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "jsxSingleQuote": false,
+  "trailingComma": "es5",
+  "endOfLine": "auto",
+  "printWidth": 80
+}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "workbench.colorCustomizations": {
+    "[Material Theme Darker]": {},
+    "minimap.background": "#00000000",
+    "scrollbar.shadow": "#00000000"
+  }
+}

DEVELOP.md

@@ -0,0 +1,40 @@
+# Notes for maintainers
+
+The directory `src/client_api` is generated from [the SpacetimeDB client-api-messages](https://github.com/clockworklabs/SpacetimeDB/tree/master/crates/client-api-messages).
+This is not automated.
+Whenever the `client-api-messages` crate changes, you'll have to manually re-generate the definitions.
+See that crate's DEVELOP.md for how to do this.
+
+The generated files must be manually modified to fix their imports from the rest of the SDK.
+Within each generated file:
+
+- Change the import from `"@clockworklabs/spacetimedb-sdk"` to `"../index"`.
+
+## Releases and publishing
+
+Every Pull Request with public-facing change(Bug fix, perf, feature etc) must be accompanied by a changeset. Any person working on a patch or feature needs to run `pnpm -w changeset` command, which will prompt them to select packages changed. Choose `@clockworklabs/spacetimedb-sdk`
+
+![image](https://github.com/user-attachments/assets/3a69ff1f-c92b-459a-8dcc-d8fea53f77b4)
+
+Next it will ask whether you'd like to add a Major tag to it. Hit enter to go to minor tag. If its a minor change(In our case, minor is major until v1 comes out, as in every minor can have breaking changes). If its a patch change(Or minor for prerelease time), then again hit enter
+
+After selecting the correct tag, it will ask you for a message
+
+![image](https://github.com/user-attachments/assets/d05a338b-965d-4669-8155-542d0225b257)
+![image](https://github.com/user-attachments/assets/7abc830e-4590-42e7-bce8-86155d86c672)
+![image](https://github.com/user-attachments/assets/8f3b16bd-b01d-4117-8d02-3887f1d308dd)
+
+Once that is done, hit enter. It will generate a `.md` file which you can then push to github. This all has to be done in the PR with the feature/fix in it.
+
+We can merge it instantly to do a release, or we can merge PRs with their own Changesets. For eg, any new feature or patch we work on for 0.12 now, should have a Changeset in it. All of these will accumulate in the "Version Packages" PR. Once all these are satisfactorily done, we merge this PR, which will
+
+- Release the package on npm
+- Release on Github tags
+- Update CHANGELOG.md
+
+**NOTE: It is very important that no one manually runs `npm publish`. We have provenance enabled on this package, means each version will be signed by github and traceable to the very commit associated to it**
+
+Publishing manually will breach the provenance contract, and alert security servcies like Snyk into investigating the package or issuing a warning. npm install of our package will also warn them of potential compromise to the package
+
+![image](https://github.com/user-attachments/assets/b56282b7-9055-48a0-8a49-3df9d75d481f)
+![image](https://github.com/user-attachments/assets/99d023cf-31cc-48a0-93ed-a88c326425c5)

README.md

@@ -0,0 +1,3 @@
+`@clockworklabs/spacetimedb-sdk` is a TypeScript SDK for SpacetimeDB.
+
+Source code can be found here on [GitHub](https://github.com/clockworklabs/spacetimedb-typescript-sdk/blob/main/packages/sdk).

examples/quickstart/.gitignore

@@ -0,0 +1,26 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+server

examples/quickstart/CHANGELOG.md

@@ -0,0 +1,22 @@
+# client-vite
+
+## 0.0.3-rc1.0
+
+### Patch Changes
+
+- Updated dependencies [[`cf7b7d8`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/cf7b7d89a1547fb3863f6641f5b2eb40a27c05d8), [`a501f5c`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/a501f5ccf9a0a926eb4f345ddeb01ffcb872d67e), [`9032269`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/9032269004d4dae587c39ccd85da0a32fb9a0114), [`6547882`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/6547882bb28ed9a1ca436335745e9997328026ff), [`5d7304b`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/5d7304bd3e05dd7a032cfb7069aab97b881f0179)]:
+  - @clockworklabs/[email protected]
+
+## 0.0.2
+
+### Patch Changes
+
+- Updated dependencies [[`2f6c82c`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/2f6c82c724b9f9407c7bedee13252ca8ffab8f7d), [`b9db9b6`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/b9db9b6e46d8c98b29327d97c12c07b7a2fc96bf), [`79c278b`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/79c278be71b2dfd82106ada983fd81d395b1d912)]:
+  - @clockworklabs/[email protected]
+
+## 0.0.1
+
+### Patch Changes
+
+- Updated dependencies [[`5adb557`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/5adb55776c81d0760cf0268df0fa5dee600f0ef8), [`ab1f463`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/ab1f463d7da6e530a6cd47e2433141bfd16addd1), [`b8c944c`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/b8c944cd23d3b53c72131803a775127bf0a95213), [`17227c0`](https://github.com/clockworklabs/spacetimedb-typescript-sdk/commit/17227c0f65def3a9d5e767756ccf46777210041a)]:
+  - @clockworklabs/[email protected]

examples/quickstart/README.md

@@ -0,0 +1,8 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

examples/quickstart/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>