init

Author: bean1352

.github/workflows/deploy-sync-rules.yml

@@ -0,0 +1,35 @@
+name: Deploy Sync Rules
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "sync-rules.yaml"
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    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-file: node/.nvmrc
+
+      - name: Install PowerSync CLI
+        run: npm install -g @powersync/cli
+
+      - name: Deploy sync rules
+        env:
+          AUTH_TOKEN: ${{ secrets.POWERSYNC_AUTH_TOKEN }}
+          INSTANCE_ID: ${{ secrets.POWERSYNC_INSTANCE_ID }}
+        run: |
+          npx powersync instance sync-rules deploy --filePath ./sync-rules.yaml -s
+

.gitignore

@@ -0,0 +1,55 @@
+# Dependencies
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# But keep template files
+!.env.template
+!.env.example
+
+# Build output
+dist/
+build/
+out/
+*.tsbuildinfo
+
+# IDE & Editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Testing
+coverage/
+*.lcov
+.nyc_output/
+
+# Logs
+logs/
+*.log
+
+# Temporary files
+*.tmp
+.cache/
+.temp/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# TypeScript cache
+*.tsbuildinfo
+
+# SQLite database
+*.sqlite

README.md

@@ -0,0 +1,22 @@
+## GitHub Actions Sync Rules Demo
+
+This repository shows how to deploy PowerSync sync rules to an instance whenever a push to the `main` branch includes changes to `sync-rules.yaml`. The included GitHub Actions workflow installs the PowerSync CLI and runs the deployment command automatically.
+
+## Prerequisites
+
+- A PowerSync instance.
+- GitHub repository secrets named `POWERSYNC_AUTH_TOKEN` and `POWERSYNC_INSTANCE_ID`.
+
+## Getting the Auth Token
+
+1. Sign in to the PowerSync dashboard.
+2. Generate a personal access token with permissions to deploy sync rules.
+3. Store the token in your repository secrets as `POWERSYNC_AUTH_TOKEN`.
+4. Copy your PowerSync instance ID from the dashboard and store it as `POWERSYNC_INSTANCE_ID`.
+
+With the token and instance ID in place, the workflow will authenticate and deploy your sync rules whenever the `sync-rules.yaml` file changes on the `main` branch.
+
+## Node Sample
+
+The `node/` directory contains a simple Node project that connects to PowerSync, runs `SELECT * FROM lists` and `SELECT * FROM todos`, and logs the results. It exists purely as a demo alongside the GitHub Actions workflow.
+

node/.env.template

@@ -0,0 +1,2 @@
+POWERSYNC_URL=http://localhost:8080
+BACKEND_URL=http://localhost:6060

node/.nvmrc

@@ -0,0 +1 @@
+v22.16.0

node/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "js",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "dev": "node --experimental-strip-types src/index.ts",
+    "update-sync-rules": "node --experimental-strip-types update-sync-rules.ts"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@powersync/node": "^0.10.1"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "dotenv": "^17.1.0"
+  },
+  "packageManager": "pnpm@10.12.1+sha512.f0dda8580f0ee9481c5c79a1d927b9164f2c478e90992ad268bbb2465a736984391d6333d2c327913578b2804af33474ca554ba29c04a8b13060a717675ae3ac"
+}

node/pnpm-lock.yaml

@@ -0,0 +1,3 @@
+onlyBuiltDependencies:
+  - '@powersync/better-sqlite3'
+  - '@powersync/node'

node/pnpm-workspace.yaml

@@ -0,0 +1,60 @@
+import 'dotenv/config'
+import {
+  column,
+  Schema,
+  Table,
+  PowerSyncDatabase,
+} from "@powersync/node";
+
+export class Connector {
+  async fetchCredentials() {
+    const endpoint = process.env.POWERSYNC_URL;
+    if (!endpoint) {
+      return null;
+    }
+    const token = await fetch(`${process.env.BACKEND_URL}/api/auth/token`)
+      .then((response) => response.json())
+      .then((data) => data.token as string);
+    return { endpoint, token };
+  }
+  async uploadData(database: any) { }
+};
+
+
+const schema = new Schema({
+  lists: new Table({
+    name: column.text,
+    created_at: column.text,
+    owner_id: column.text,
+  }),
+  todos: new Table({
+    description: column.text,
+    list_id: column.text,
+    completed: column.integer,
+  }),
+});
+
+const powerSync = new PowerSyncDatabase({
+  schema,
+  database: { dbFilename: "example.sqlite" },
+});
+
+await powerSync.connect(new Connector(), {
+  params: {
+    test: "value"
+  }
+});
+await powerSync.init();
+await powerSync.waitForFirstSync();
+
+
+const lists = await powerSync.getAll(`SELECT * FROM lists`);
+console.log("lists: ", lists);
+
+const todos = await powerSync.getAll(`SELECT * FROM todos`);
+console.log("todos: ", todos);
+
+await powerSync.disconnect();
+console.log("Disconnected and cleared the database.");
+
+process.exit(0);

node/src/index.ts

@@ -0,0 +1,5 @@
+bucket_definitions:
+  global:
+    data:
+      - SELECT * FROM lists
+      - SELECT * FROM todos