refactor: extract client-helpers package, update svelte-query to v6 (#535)

Author: ymc9

.github/workflows/build-test.yml

@@ -33,7 +33,7 @@ jobs:
 
         strategy:
             matrix:
-                node-version: [20.x]
+                node-version: [22.x]
                 provider: [sqlite, postgresql]
 
         steps:

.github/workflows/bump-version.yml

@@ -26,7 +26,7 @@ jobs:
             - name: Use Node.js
               uses: actions/setup-node@v4
               with:
-                  node-version: 20.x
+                  node-version: 22.x
                   cache: 'pnpm'
 
             - name: Install dependencies

.github/workflows/publish-release.yml

@@ -28,7 +28,7 @@ jobs:
             - name: Use Node.js
               uses: actions/setup-node@v4
               with:
-                  node-version: 20.x
+                  node-version: 22.x
                   cache: 'pnpm'
                   registry-url: 'https://registry.npmjs.org'
 

.github/workflows/update-samples.yml

@@ -65,7 +65,7 @@ jobs:
               if: steps.check-package.outputs.exists == 'true'
               uses: actions/setup-node@v4
               with:
-                  node-version: 20.x
+                  node-version: 22.x
                   cache: 'npm'
 
             - name: Update @zenstackhq packages to latest

.gitignore

@@ -9,3 +9,4 @@ dist
 .pnpm-store
 *.vsix
 .DS_Store
+coverage

CONTRIBUTING.md

@@ -6,7 +6,7 @@ Before you start working on anything major, please make sure to open an issue or
 
 ## Prerequisites
 
-- Node.js: v20 or above
+- Node.js: v22 or above
 - PNPM: as specified in [package.json](./package.json)
 
 Test cases are run against both SQLite and Postgres. You should have a postgres server (16 or above) running (either natively or via Docker). The default connection is:

package.json

@@ -12,6 +12,7 @@
         "test:all": "pnpm run test:sqlite && pnpm run test:pg",
         "test:pg": "TEST_DB_PROVIDER=postgresql turbo run test",
         "test:sqlite": "TEST_DB_PROVIDER=sqlite turbo run test",
+        "test:coverage": "vitest run --coverage",
         "format": "prettier --write \"**/*.{ts,tsx,md}\"",
         "pr": "gh pr create --fill-first --base dev",
         "merge-main": "gh pr create --title \"merge dev to main\" --body \"\" --base main --head dev",
@@ -26,8 +27,10 @@
     "devDependencies": {
         "@eslint/js": "^9.29.0",
         "@types/node": "catalog:",
+        "@vitest/coverage-v8": "^4.0.16",
         "eslint": "~9.29.0",
         "glob": "^11.1.0",
+        "npm-run-all": "^4.1.5",
         "prettier": "^3.5.3",
         "prisma": "catalog:",
         "tsup": "^8.5.0",
@@ -40,7 +43,10 @@
     },
     "pnpm": {
         "onlyBuiltDependencies": [
-            "better-sqlite3"
+            "@parcel/watcher",
+            "better-sqlite3",
+            "esbuild",
+            "vue-demi"
         ]
     }
 }

packages/cli/package.json

@@ -28,6 +28,9 @@
         "test": "vitest run",
         "pack": "pnpm pack"
     },
+    "exports": {
+        "./package.json": "./package.json"
+    },
     "dependencies": {
         "@zenstackhq/common-helpers": "workspace:*",
         "@zenstackhq/language": "workspace:*",

packages/clients/client-helpers/eslint.config.js

@@ -0,0 +1,4 @@
+import config from '@zenstackhq/eslint-config/base.js';
+
+/** @type {import("eslint").Linter.Config} */
+export default config;

packages/clients/client-helpers/package.json

@@ -0,0 +1,40 @@
+{
+    "name": "@zenstackhq/client-helpers",
+    "version": "3.0.0",
+    "description": "Helpers for implementing clients that consume ZenStack's CRUD service",
+    "type": "module",
+    "scripts": {
+        "build": "tsc --noEmit && tsup-node && pnpm test:typecheck",
+        "watch": "tsup-node --watch",
+        "lint": "eslint src --ext ts",
+        "test": "vitest run",
+        "test:typecheck": "tsc --noEmit --project tsconfig.test.json",
+        "pack": "pnpm pack"
+    },
+    "author": "ZenStack Team",
+    "license": "MIT",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        },
+        "./fetch": {
+            "types": "./dist/fetch.d.ts",
+            "default": "./dist/fetch.js"
+        }
+    },
+    "dependencies": {
+        "@zenstackhq/common-helpers": "workspace:*",
+        "@zenstackhq/schema": "workspace:*",
+        "decimal.js": "catalog:",
+        "superjson": "^2.2.3"
+    },
+    "devDependencies": {
+        "@zenstackhq/eslint-config": "workspace:*",
+        "@zenstackhq/language": "workspace:*",
+        "@zenstackhq/orm": "workspace:*",
+        "@zenstackhq/sdk": "workspace:*",
+        "@zenstackhq/typescript-config": "workspace:*",
+        "@zenstackhq/vitest-config": "workspace:*"
+    }
+}