Import TypeScript SDK repo

sdks/typescript/.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)

sdks/typescript/.changeset/config.json

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

sdks/typescript/.gitattributes

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

sdks/typescript/.github/pull_request_template.md

@@ -0,0 +1,19 @@
+## 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_
+
+## Testing
+
+_Write instructions for a test that you performed for this PR_
+
+- [ ] Describe a test for this PR that you have completed

sdks/typescript/.github/spacetimedb-version.txt

@@ -0,0 +1 @@
+master

sdks/typescript/.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

sdks/typescript/.github/workflows/lint.yml

@@ -0,0 +1,41 @@
+name: Lint
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+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

sdks/typescript/.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 }}

sdks/typescript/.github/workflows/test.yml

@@ -0,0 +1,146 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+
+jobs:
+  compile-and-test:
+    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: Compile
+        run: pnpm compile
+
+      - name: Run sdk tests
+        working-directory: packages/sdk
+        run: pnpm test
+
+      # - name: Extract SpacetimeDB branch name from file
+      #   id: extract-branch
+      #   run: |
+      #     # Define the path to the branch file
+      #     BRANCH_FILE=".github/spacetimedb-branch.txt"
+
+      #     # Default to master if file doesn't exist
+      #     if [ ! -f "$BRANCH_FILE" ]; then
+      #       echo "::notice::No SpacetimeDB branch file found, using 'master'"
+      #       echo "branch=master" >> $GITHUB_OUTPUT
+      #       exit 0
+      #     fi
+
+      #     # Read and trim whitespace from the file
+      #     branch=$(cat "$BRANCH_FILE" | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')
+
+      #     # Fallback to master if empty
+      #     if [ -z "$branch" ]; then
+      #       echo "::warning::SpacetimeDB branch file is empty, using 'master'"
+      #       branch="master"
+      #     fi
+
+      #     echo "branch=$branch" >> $GITHUB_OUTPUT
+      #     echo "Using SpacetimeDB branch from file: $branch"
+
+      - name: Checkout SpacetimeDB
+        uses: actions/checkout@v4
+        with:
+          repository: clockworklabs/SpacetimeDB
+      #    ref: ${{ steps.extract-branch.outputs.branch }}
+          path: SpacetimeDB
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Rust dependencies
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: SpacetimeDB/modules/quickstart-chat
+          shared-key: quickstart-chat-test
+
+      - name: Install SpacetimeDB CLI from the local checkout
+        run: |
+          cargo install --force --path SpacetimeDB/crates/cli --locked --message-format=short
+          cargo install --force --path SpacetimeDB/crates/standalone --locked --message-format=short
+          # Add a handy alias using the old binary name, so that we don't have to rewrite all scripts (incl. in submodules).
+          rm -f $HOME/.cargo/bin/spacetime
+          ln -s $HOME/.cargo/bin/spacetimedb-cli $HOME/.cargo/bin/spacetime
+          # Clear any existing information
+          spacetime server clear -y
+        env:
+          # Share the target directory with our local project to avoid rebuilding same SpacetimeDB crates twice.
+          CARGO_TARGET_DIR: SpacetimeDB/modules/quickstart-chat/target
+
+      - name: Generate client bindings
+        working-directory: SpacetimeDB/modules/quickstart-chat
+        run: |
+          spacetime generate --lang typescript --out-dir ../../../examples/quickstart-chat/src/module_bindings
+          pnpm lint --write
+
+      - name: Check for changes
+        run: |
+          # This was copied from SpacetimeDB/tools/check-diff.sh.
+          # It's required because `spacetime generate` creates lines with the SpacetimeDB commit
+          # version, which would make this `git diff` check very brittle if included.
+          PATTERN='^// This was generated using spacetimedb cli version.*'
+          if ! git diff --exit-code --ignore-matching-lines="$PATTERN" -- examples/quickstart-chat/src/module_bindings; then
+            echo "Error: Bindings are dirty. Please generate bindings again and commit them to this branch."
+            exit 1
+          fi
+
+      # - name: Start SpacetimeDB
+      #   run: |
+      #     spacetime start &
+      #     disown
+
+      # - name: Publish module to SpacetimeDB
+      #   working-directory: SpacetimeDB/modules/quickstart-chat
+      #   run: |
+      #     spacetime logout && spacetime login --server-issued-login local
+      #     spacetime publish -s local quickstart-chat -c -y
+
+      # - name: Publish module to SpacetimeDB
+      #   working-directory: SpacetimeDB/modules/quickstart-chat
+      #   run: |
+      #     spacetime logs quickstart-chat
+
+      - name: Check that quickstart-chat builds
+        working-directory: examples/quickstart-chat
+        run: pnpm build
+
+      # - name: Run quickstart-chat tests
+      #   working-directory: examples/quickstart-chat
+      #   run: pnpm test
+      #
+      # # Run this step always, even if the previous steps fail
+      # - name: Print rows in the user table
+      #   if: always()
+      #   run: spacetime sql quickstart-chat "SELECT * FROM user"

sdks/typescript/.gitignore

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

sdks/typescript/.npmignore

@@ -0,0 +1,3 @@
+tests
+.envrc
+node_modules

sdks/typescript/.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+pnpm-lock.yaml
+dist
+target
+/.github

sdks/typescript/.prettierrc

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

sdks/typescript/.vscode/settings.json

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

sdks/typescript/DEVELOP.md

@@ -0,0 +1,43 @@
+# Notes for maintainers
+
+The directory `packages/sdk/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"`.
+
+On a mac, you can do that by running this in the directory: `find . -type f -exec sed -i '' 's/"@clockworklabs\/spacetimedb-sdk"/"..\/index"/g' {} \;`.
+
+## Releases and publishing
+
+Every Pull Request with a 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. E.g. Any new feature or patch we work on for 1.0 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)