create-syncular-app 0.15.44 → 0.15.45

package/README.md

@@ -7,24 +7,13 @@ bun create syncular-app my-app            # prompts for the template
 bunx create-syncular-app my-app --template web
 ```
 
-> Naming (`@syncular/*`, bin `create-syncular-app`, CLI `syncular`) is not
-> final — package identity is TODO 6.3. Every user-visible name lives in
-> [`src/constants.ts`](./src/constants.ts) so a rename is mechanical: edit the
-> constants, regenerate the templates' generated files, done.
-
 ## Templates
 
 | Template | Shape |
 |---|---|
 | `minimal` | Server + a terminal two-client convergence demo (no browser) — migrations + manifest + `generate` wiring. Copy-evolved from `examples/quickstart`. The smallest honest starting point. |
 | `web` | Hono server + WebSocket realtime + a single-pane browser todo app whose whole client core runs in a Web Worker on OPFS. Derived from `apps/demo`, slimmed to one pane (no conflict simulator, no blob attachments) — the minimal browser app a real user starts from. |
-| `tauri` | One React codebase, web + desktop (RFC 0002 §4.1): the `web` template's server plus a shared React tree behind the `__TAURI_INTERNALS__` engine seam (`src/frontend/engine.ts`) — worker core on OPFS in the browser, native Rust core in a `src-tauri/` host (`tauri-plugin-syncular` from crates.io, `native-transport`). Derived from `bindings/tauri/example` + the [web+desktop guide](../../apps/docs/src/content/guide-web-desktop.md). |
-
-> **Next-template candidate: `react` (web-only).** [`apps/demo-react`](../../apps/demo-react)
-> is the ready-made source for a hooks-based web-only template — the `tauri`
-> template already carries the hook surface for the two-host story. Slim
-> demo-react the way `web` slims `apps/demo` when a web-only React template
-> is wanted. Not built yet — noted so the shape is on record.
+| `tauri` | One React codebase, web + desktop: the `web` template's server plus a shared React tree behind the `__TAURI_INTERNALS__` engine seam (`src/frontend/engine.ts`) — worker core on OPFS in the browser, native Rust core in a `src-tauri/` host (`tauri-plugin-syncular` from crates.io, `native-transport`). Derived from `bindings/tauri/example` + the [web+desktop guide](../../apps/docs/src/content/guide-web-desktop.md). |
 
 Each template ships its own `README.md` (run steps, what to edit first),
 `.gitignore` (as `gitignore` — see below), a working `tsconfig.json`, and a
@@ -40,13 +29,8 @@ ranges:
   are the only ranges that resolve when the scaffolded app sits inside this
   repo's workspace.
 - **default** (a normal `bunx create-…` run): rewrite to
-  `PUBLISHED_DEPENDENCY_RANGE` (`src/constants.ts`). **Today that constant is
-  *also* `workspace:*`** because the workspace packages are unpublished and
-  version-less (all `private`, no `version` — TODO 6.3), so there is no honest
-  semver range yet. The CLI **warns loudly** in this case: a `bun install`
-  outside the repo cannot resolve the deps until publishing lands. When the
-  packages ship, flip that one constant to `^<version>` (or teach the CLI to
-  read the published version) — a single edit.
+  `PUBLISHED_DEPENDENCY_RANGE` (`src/constants.ts`), derived from the
+  scaffolder's own version because all Syncular packages release in lockstep.
 
 `.gitignore` ships as `gitignore` (no dot) because npm strips real dotfiles
 from published tarballs; the scaffolder renames it on copy.

package/dist/constants.d.ts

@@ -1,9 +1,7 @@
 /**
- * The ONE place naming lives (TODO 6.3 is a product decision — final package
- * identity is not settled). Every user-visible name the scaffolder emits comes
- * from here so a rename is mechanical: change these constants, regenerate the
- * templates' generated files, done. No name is hardcoded elsewhere in this
- * package — grep for the literals below and you should only find them here.
+ * The one place scaffolder naming lives. Every user-visible name the
+ * scaffolder emits comes from here so a rename is mechanical: change these
+ * constants and regenerate the templates' generated files.
  */
 /** The scoped npm namespace for the v2 packages, e.g. `@syncular`. */
 export declare const PACKAGE_SCOPE = "@syncular";

package/dist/constants.js

@@ -1,10 +1,8 @@
 import { createRequire } from 'node:module';
 /**
- * The ONE place naming lives (TODO 6.3 is a product decision — final package
- * identity is not settled). Every user-visible name the scaffolder emits comes
- * from here so a rename is mechanical: change these constants, regenerate the
- * templates' generated files, done. No name is hardcoded elsewhere in this
- * package — grep for the literals below and you should only find them here.
+ * The one place scaffolder naming lives. Every user-visible name the
+ * scaffolder emits comes from here so a rename is mechanical: change these
+ * constants and regenerate the templates' generated files.
  */
 /** The scoped npm namespace for the v2 packages, e.g. `@syncular`. */
 export const PACKAGE_SCOPE = '@syncular';

package/dist/scaffold.d.ts

@@ -16,9 +16,8 @@ export declare function packageNameFromDirectory(targetDir: string): string;
  *   when the scaffolded app sits inside this repo's workspace (the in-tree
  *   smoke test path, and `--local` for anyone hacking on the tree).
  * - `local: false` rewrites to {@link PUBLISHED_DEPENDENCY_RANGE}. Today that
- *   is *also* `workspace:*` because the v2 packages are unpublished and
- *   version-less (TODO 6.3); the CLI warns. It is one constant to flip the day
- *   they publish.
+ *   is derived from the scaffolder's version because the packages release in
+ *   lockstep.
  */
 export declare function rewriteTemplatePackageJson(source: string, options: {
     packageName: string;

package/dist/scaffold.js

@@ -37,9 +37,8 @@ function isWorkspacePackage(dependencyName) {
  *   when the scaffolded app sits inside this repo's workspace (the in-tree
  *   smoke test path, and `--local` for anyone hacking on the tree).
  * - `local: false` rewrites to {@link PUBLISHED_DEPENDENCY_RANGE}. Today that
- *   is *also* `workspace:*` because the v2 packages are unpublished and
- *   version-less (TODO 6.3); the CLI warns. It is one constant to flip the day
- *   they publish.
+ *   is derived from the scaffolder's version because the packages release in
+ *   lockstep.
  */
 export function rewriteTemplatePackageJson(source, options) {
     const pkg = JSON.parse(source);

package/package.json

@@ -1,33 +1,12 @@
 {
   "name": "create-syncular-app",
-  "version": "0.15.44",
-  "description": "Scaffold a new Syncular app: `create-syncular-app`",
-  "license": "Apache-2.0",
+  "version": "0.15.45",
   "author": "Benjamin Kniffler",
-  "homepage": "https://syncular.dev",
   "repository": {
     "type": "git",
     "url": "https://github.com/syncular/syncular.git",
     "directory": "packages/create-app"
   },
-  "bugs": {
-    "url": "https://github.com/syncular/syncular/issues"
-  },
-  "keywords": [
-    "sync",
-    "offline-first",
-    "realtime",
-    "database",
-    "typescript"
-  ],
-  "type": "module",
-  "sideEffects": false,
-  "publishConfig": {
-    "access": "public"
-  },
-  "bin": {
-    "create-syncular-app": "./dist/cli.js"
-  },
   "exports": {
     ".": {
       "bun": "./src/index.ts",
@@ -38,6 +17,13 @@
       }
     }
   },
+  "bin": {
+    "create-syncular-app": "./dist/cli.js"
+  },
+  "bugs": {
+    "url": "https://github.com/syncular/syncular/issues"
+  },
+  "description": "Scaffold a new Syncular app: `create-syncular-app`",
   "files": [
     "dist",
     "src",
@@ -48,7 +34,18 @@
     "!dist/**/*.test.js",
     "!dist/**/*.test.d.ts"
   ],
-  "devDependencies": {
-    "@syncular/typegen": "0.15.44"
-  }
+  "homepage": "https://syncular.dev",
+  "keywords": [
+    "sync",
+    "offline-first",
+    "realtime",
+    "database",
+    "typescript"
+  ],
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "type": "module"
 }

package/src/constants.ts

@@ -1,11 +1,9 @@
 import { createRequire } from 'node:module';
 
 /**
- * The ONE place naming lives (TODO 6.3 is a product decision — final package
- * identity is not settled). Every user-visible name the scaffolder emits comes
- * from here so a rename is mechanical: change these constants, regenerate the
- * templates' generated files, done. No name is hardcoded elsewhere in this
- * package — grep for the literals below and you should only find them here.
+ * The one place scaffolder naming lives. Every user-visible name the
+ * scaffolder emits comes from here so a rename is mechanical: change these
+ * constants and regenerate the templates' generated files.
  */
 
 /** The scoped npm namespace for the v2 packages, e.g. `@syncular`. */

package/src/scaffold.ts

@@ -55,9 +55,8 @@ function isWorkspacePackage(dependencyName: string): boolean {
  *   when the scaffolded app sits inside this repo's workspace (the in-tree
  *   smoke test path, and `--local` for anyone hacking on the tree).
  * - `local: false` rewrites to {@link PUBLISHED_DEPENDENCY_RANGE}. Today that
- *   is *also* `workspace:*` because the v2 packages are unpublished and
- *   version-less (TODO 6.3); the CLI warns. It is one constant to flip the day
- *   they publish.
+ *   is derived from the scaffolder's version because the packages release in
+ *   lockstep.
  */
 export function rewriteTemplatePackageJson(
   source: string,

package/template/tauri/src-tauri/Cargo.toml

@@ -21,7 +21,7 @@ tauri = { version = "2", features = [] }
 # The syncular plugin from crates.io. `native-transport` gives the core its
 # real HTTP + WebSocket transport (ureq + tungstenite) inside the host
 # process — the webview never talks to the sync server directly.
-tauri-plugin-syncular = { version = "0.15.44", features = ["native-transport"] }
+tauri-plugin-syncular = { version = "0.15.45", features = ["native-transport"] }
 
 [features]
 default = []

package/template/web/README.md

@@ -17,6 +17,11 @@ Open the URL, add todos, toggle "Go offline" and keep editing — the outbox
 counter grows and drains with idempotent retry on reconnect. Open a second
 browser window on the same URL to watch them converge over the realtime socket.
 
+The page checks whether the origin has eviction-resistant storage and offers a
+`Protect offline data` action while it remains best effort. If permission is
+not granted, a non-empty outbox displays a warning because browser eviction can
+remove the OPFS database and its unsynced writes.
+
 `bun test` runs a server-level convergence smoke test (the browser UI is
 covered by `tsc`).
 

package/template/web/src/frontend/index.html

@@ -11,6 +11,7 @@
     header h1 { font-size: 1.2rem; margin: 0; }
     .badge { font-size: 0.7rem; padding: 0.1rem 0.45rem; border-radius: 999px; border: 1px solid currentColor; opacity: 0.7; }
     #status { font-size: 0.8rem; opacity: 0.7; min-height: 1.1em; margin: 0 0 1rem; }
+    #storage-warning { font-size: 0.8rem; border: 1px solid currentColor; padding: 0.6rem; }
     form { display: flex; gap: 0.5rem; margin-bottom: 1rem; }
     form input { flex: 1; padding: 0.4rem 0.6rem; }
     ul { list-style: none; margin: 0; padding: 0; }
@@ -24,9 +25,12 @@
   <header>
     <h1>__PROJECT_NAME__</h1>
     <span id="outbox" class="badge">outbox 0</span>
+    <span id="storage" class="badge">storage checking</span>
+    <button id="storage-btn" hidden>Protect offline data</button>
     <button id="offline-btn">Go offline</button>
   </header>
   <p id="status">starting…</p>
+  <p id="storage-warning" role="alert" hidden></p>
   <form id="add-form">
     <input id="add-input" placeholder="Add a todo…" autocomplete="off" />
     <button type="submit">Add</button>

package/template/web/src/frontend/main.ts

@@ -14,11 +14,14 @@
  */
 import {
   browserConnectivitySignal,
+  type BrowserStoragePersistence,
+  checkBrowserStoragePersistence,
   ClientSyncError,
   createSyncClientHandle,
   documentLifecycleSignal,
   installRealtimeSupervisor,
   realtimeSupervisorSnapshot,
+  requestBrowserStoragePersistence,
   type SqlRow,
   subscribeRealtimeSupervisor,
 } from '@syncular/client';
@@ -39,6 +42,11 @@ interface Todo {
 const statusEl = document.getElementById('status') as HTMLElement;
 const listEl = document.getElementById('todos') as HTMLUListElement;
 const outboxEl = document.getElementById('outbox') as HTMLElement;
+const storageEl = document.getElementById('storage') as HTMLElement;
+const storageWarningEl = document.getElementById(
+  'storage-warning',
+) as HTMLElement;
+const storageBtn = document.getElementById('storage-btn') as HTMLButtonElement;
 const form = document.getElementById('add-form') as HTMLFormElement;
 const input = document.getElementById('add-input') as HTMLInputElement;
 const offlineBtn = document.getElementById('offline-btn') as HTMLButtonElement;
@@ -48,6 +56,8 @@ function setStatus(text: string): void {
 }
 
 async function main(): Promise<void> {
+  let storagePersistence: BrowserStoragePersistence =
+    await checkBrowserStoragePersistence();
   const handle = await createSyncClientHandle({
     worker: () => new Worker('/worker.js', { type: 'module' }),
     schema,
@@ -93,6 +103,13 @@ async function main(): Promise<void> {
   renderRealtimeStatus();
   await refresh();
 
+  storageBtn.addEventListener('click', async () => {
+    storageBtn.disabled = true;
+    storagePersistence = await requestBrowserStoragePersistence();
+    storageBtn.disabled = false;
+    await refresh();
+  });
+
   let offline = false;
   offlineBtn.addEventListener('click', async () => {
     offline = !offline;
@@ -142,6 +159,16 @@ async function main(): Promise<void> {
     )) as unknown as Todo[];
     const pending = (await handle.pendingCommits()).length;
     outboxEl.textContent = `outbox ${pending}`;
+    storageEl.textContent =
+      storagePersistence.state === 'persistent'
+        ? 'storage persistent'
+        : 'storage best effort';
+    storageBtn.hidden = storagePersistence.state === 'persistent';
+    storageWarningEl.hidden =
+      storagePersistence.state === 'persistent' || pending === 0;
+    storageWarningEl.textContent =
+      'Unsynced changes can disappear if the browser evicts this site. ' +
+      'Keep this tab open and reconnect, or protect offline data.';
     listEl.replaceChildren(...rows.map((row) => renderRow(row)));
 
     async function toggle(row: Todo): Promise<void> {