solid-objects 0.13.3 → 0.14.1

package/examples/sqlite-quickstart.ts

@@ -6,6 +6,17 @@ import { join, resolve } from "node:path"
 import { fileURLToPath } from "node:url"
 import { Actor, createRuntime } from "solid-objects"
 import { sqlite } from "solid-objects/database/sqlite"
+import { createInterface } from "node:readline/promises"
+import {
+  answerAllowsRun,
+  formatQuickstartPlan,
+  formatQuickstartPrompt,
+  formatQuickstartReport,
+  formatQuickstartStop,
+  type QuickstartSummary,
+} from "./quickstart-report.js"
+
+const SAME_IDENTITY_CALLS = 25
 
 class Counter extends Actor {
   static override readonly actorType = "QuickstartCounter"
@@ -27,12 +38,61 @@ class Counter extends Actor {
   }
 }
 
+const COUNTER_SOURCE = `class Counter extends Actor {
+  static override readonly actorType = "QuickstartCounter"
+
+  count = 0
+
+  increment(): number {
+    this.count += 1
+    return this.count
+  }
+
+  async pause({ milliseconds }: { milliseconds: number }) {
+    const startedAt = performance.now()
+    await new Promise((done) => setTimeout(done, milliseconds))
+    return { startedAt, finishedAt: performance.now() }
+  }
+}`
+
+async function confirmRun(options: {
+  format?: "report" | "json"
+  confirm?: () => boolean | Promise<boolean>
+}): Promise<boolean> {
+  if (options.format === "json") return true
+  if (options.confirm) return options.confirm()
+  if (!process.stdin.isTTY) return true
+  const questions = createInterface({ input: process.stdin, output: process.stdout })
+  try {
+    return answerAllowsRun(await questions.question(formatQuickstartPrompt()))
+  } catch {
+    return false
+  } finally {
+    questions.close()
+  }
+}
+
 export async function runQuickstart(
   options: {
     signal?: AbortSignal
     write?: (value: string) => void
+    format?: "report" | "json"
+    confirm?: () => boolean | Promise<boolean>
   } = {},
 ): Promise<void> {
+  const write = options.write ?? ((value: string) => process.stdout.write(value))
+  if (options.format !== "json") {
+    write(
+      formatQuickstartPlan({
+        sameIdentityCalls: SAME_IDENTITY_CALLS,
+        actorSource: COUNTER_SOURCE,
+      }),
+    )
+  }
+  if (!(await confirmRun(options))) {
+    write(formatQuickstartStop())
+    return
+  }
   const directory = await mkdtemp(join(tmpdir(), "solid-objects-quickstart-"))
   const databasePath = join(directory, "state.sqlite3")
   const runtime = createRuntime({
@@ -58,13 +118,15 @@ export async function runQuickstart(
     running = runtime.run(shutdown.signal)
 
     const counter = runtime.ref(Counter, "room-1")
-    const results = await Promise.all(Array.from({ length: 25 }, () => counter.increment()))
+    const results = await Promise.all(
+      Array.from({ length: SAME_IDENTITY_CALLS }, () => counter.increment()),
+    )
     assert.deepEqual(
       [...results].sort((left, right) => left - right),
-      Array.from({ length: 25 }, (_value, index) => index + 1),
+      Array.from({ length: SAME_IDENTITY_CALLS }, (_value, index) => index + 1),
     )
     sameIdentityFinalState = await counter.count
-    assert.equal(sameIdentityFinalState, 25)
+    assert.equal(sameIdentityFinalState, SAME_IDENTITY_CALLS)
 
     const pauses = await Promise.all([
       runtime.ref(Counter, "room-2").send.pause({ milliseconds: 100 }),
@@ -89,19 +151,17 @@ export async function runQuickstart(
   }
 
   assert.equal(existsSync(directory), false)
-  const write = options.write ?? ((value: string) => process.stdout.write(value))
-  write(
-    `${JSON.stringify(
-      {
-        sameIdentityCalls: 25,
-        sameIdentityFinalState,
-        independentIdentitiesOverlapped,
-        temporaryStateRemoved: true,
-      },
-      null,
-      2,
-    )}\n`,
-  )
+  const summary: QuickstartSummary = {
+    sameIdentityCalls: SAME_IDENTITY_CALLS,
+    sameIdentityFinalState,
+    independentIdentitiesOverlapped,
+    temporaryStateRemoved: true,
+  }
+  if (options.format === "json") {
+    write(`${JSON.stringify(summary, null, 2)}\n`)
+    return
+  }
+  write(formatQuickstartReport(summary))
 }
 
 if (process.argv[1] && fileURLToPath(import.meta.url) === resolve(process.argv[1])) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solid-objects",
-  "version": "0.13.3",
+  "version": "0.14.1",
   "description": "Race-free realtime state per application identity, backed by your SQL database",
   "type": "module",
   "license": "MIT",
@@ -46,6 +46,14 @@
       "types": "./dist/database/sqlite.d.ts",
       "import": "./dist/database/sqlite.js"
     },
+    "./database/sqlite-wasm": {
+      "types": "./dist/database/sqlite-wasm.d.ts",
+      "import": "./dist/database/sqlite-wasm.js"
+    },
+    "./database/shared-sqlite-wasm": {
+      "types": "./dist/database/shared-sqlite-wasm.d.ts",
+      "import": "./dist/database/shared-sqlite-wasm.js"
+    },
     "./database/postgresql": {
       "types": "./dist/database/postgresql.d.ts",
       "import": "./dist/database/postgresql.js"
@@ -62,6 +70,22 @@
       "types": "./dist/browser/index.d.ts",
       "import": "./dist/browser/index.js"
     },
+    "./browser/host": {
+      "types": "./dist/browser/host.d.ts",
+      "import": "./dist/browser/host.js"
+    },
+    "./browser/tab-host": {
+      "types": "./dist/browser/tab-host.d.ts",
+      "import": "./dist/browser/tab-host.js"
+    },
+    "./signals": {
+      "types": "./dist/signals.d.ts",
+      "import": "./dist/signals.js"
+    },
+    "./transmit": {
+      "types": "./dist/transmit.d.ts",
+      "import": "./dist/transmit.js"
+    },
     "./web": {
       "types": "./dist/web/index.d.ts",
       "import": "./dist/web/index.js"
@@ -69,7 +93,8 @@
   },
   "scripts": {
     "build": "pnpm run clean && tsc -p tsconfig.build.json && tsc -p tsconfig.quickstart-build.json && node scripts/prepare-executable.mjs",
-    "check": "pnpm run check:parameters && pnpm run check:documentation && tsc -p tsconfig.json --noEmit && tsc -p tsconfig.examples.json --noEmit",
+    "check": "pnpm run check:parameters && pnpm run check:documentation && pnpm run check:browser-imports && tsc -p tsconfig.json --noEmit && tsc -p tsconfig.examples.json --noEmit",
+    "check:browser-imports": "node scripts/check-browser-imports.mjs",
     "check:documentation": "node scripts/check-documentation.mjs",
     "check:parameters": "node scripts/check-parameter-style.mjs",
     "clean": "node scripts/clean.mjs",
@@ -91,6 +116,7 @@
   },
   "devDependencies": {
     "@playwright/test": "^1.62.1",
+    "@sqlite.org/sqlite-wasm": "3.53.0-build1",
     "@types/node": "^24.0.0",
     "@types/pg": "^8.21.0",
     "@types/ws": "^8.18.1",
@@ -99,16 +125,25 @@
     "pg": "^8.23.0",
     "prettier": "^3.9.6",
     "redis": "^6.2.1",
+    "signal-polyfill": "^0.2.2",
     "typescript": "^5.9.0",
     "vitest": "^4.1.10",
     "ws": "^8.21.3"
   },
   "peerDependencies": {
+    "@sqlite.org/sqlite-wasm": ">=3.50.0-build1",
+    "signal-polyfill": ">=0.2.2",
     "mysql2": "^3.23.3",
     "pg": "^8.23.0",
     "redis": "^6.2.1"
   },
   "peerDependenciesMeta": {
+    "@sqlite.org/sqlite-wasm": {
+      "optional": true
+    },
+    "signal-polyfill": {
+      "optional": true
+    },
     "mysql2": {
       "optional": true
     },