@spooky-sync/cli 0.0.1-canary.33 → 0.0.1-canary.330

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cli.cjs CHANGED
@@ -1,2 +1,2 @@
1
1
  #!/usr/bin/env node
2
- "use strict";const r=require("child_process"),s=require("./resolve-binary-CFmJcXEj.cjs"),o=s.findBinary(),e=r.spawnSync(o,process.argv.slice(2),{stdio:"inherit"});e.error&&(console.error(`Failed to execute spooky: ${e.error.message}`),process.exit(1));process.exit(e.status??1);
2
+ "use strict";const r=require("child_process"),s=require("./resolve-binary-J8VAJRMF.cjs"),i=s.findBinary(),e=r.spawnSync(i,process.argv.slice(2),{stdio:"inherit"});e.error&&(console.error(`Failed to execute spky: ${e.error.message}`),process.exit(1));process.exit(e.status??1);
package/dist/cli.js CHANGED
@@ -1,6 +1,6 @@
1
1
  #!/usr/bin/env node
2
2
  import { spawnSync as e } from "child_process";
3
- import { f as s } from "./resolve-binary-BYotYL89.js";
3
+ import { f as s } from "./resolve-binary-kH1Jwk0z.js";
4
4
  const o = s(), r = e(o, process.argv.slice(2), { stdio: "inherit" });
5
- r.error && (console.error(`Failed to execute spooky: ${r.error.message}`), process.exit(1));
5
+ r.error && (console.error(`Failed to execute spky: ${r.error.message}`), process.exit(1));
6
6
  process.exit(r.status ?? 1);
@@ -0,0 +1,8 @@
1
+ "use strict";const o=require("os"),e=require("path"),t=require("fs"),g=require("url"),k=require("module");var s=typeof document<"u"?document.currentScript:null;const x=g.fileURLToPath(typeof document>"u"?require("url").pathToFileURL(__filename).href:s&&s.tagName.toUpperCase()==="SCRIPT"&&s.src||new URL("resolve-binary-J8VAJRMF.cjs",document.baseURI).href),c=e.dirname(x),d={"darwin-arm64":"@spooky-sync/cli-darwin-arm64","darwin-x64":"@spooky-sync/cli-darwin-x64","linux-arm64":"@spooky-sync/cli-linux-arm64","linux-x64":"@spooky-sync/cli-linux-x64","win32-x64":"@spooky-sync/cli-win32-x64"};function $(){const r=`${o.platform()}-${o.arch()}`,n=d[r];if(!n)return;const l=o.platform()==="win32"?"spky.exe":"spky";try{const i=k.createRequire(typeof document>"u"?require("url").pathToFileURL(__filename).href:s&&s.tagName.toUpperCase()==="SCRIPT"&&s.src||new URL("resolve-binary-J8VAJRMF.cjs",document.baseURI).href).resolve(`${n}/package.json`);return e.resolve(e.dirname(i),l)}catch{return}}function w(){const r=o.platform()==="win32"?"spky.exe":"spky",n=$();if(n&&t.existsSync(n))return n;const l=[e.resolve(c,"../../../target/release",r),e.resolve(c,"../target/release",r),e.resolve(c,"../../../target/debug",r),e.resolve(c,"../target/debug",r)],u=l.filter(a=>t.existsSync(a));if(u.length>0)return u.sort((a,h)=>t.statSync(h).mtimeMs-t.statSync(a).mtimeMs),u[0];const i=e.resolve(c,"..",r);if(t.existsSync(i))return i;const p=e.resolve(process.cwd(),r);if(t.existsSync(p))return p;const m=`${o.platform()}-${o.arch()}`,y=d[m],f=y?`
2
+ Try installing the platform package: npm install ${y}`:`
3
+ Your platform (${m}) is not supported.`;throw new Error(`Could not find spky binary. Checked paths:
4
+ - Platform package (${y??"none"})
5
+ `+l.map(a=>` - ${a}
6
+ `).join("")+` - ${i}
7
+ - ${p}
8
+ `+f)}exports.findBinary=w;
@@ -0,0 +1,60 @@
1
+ import { platform as m, arch as u } from "os";
2
+ import { dirname as d, resolve as t } from "path";
3
+ import { existsSync as c, statSync as f } from "fs";
4
+ import { fileURLToPath as h } from "url";
5
+ import { createRequire as w } from "module";
6
+ const $ = h(import.meta.url), i = d($), k = {
7
+ "darwin-arm64": "@spooky-sync/cli-darwin-arm64",
8
+ "darwin-x64": "@spooky-sync/cli-darwin-x64",
9
+ "linux-arm64": "@spooky-sync/cli-linux-arm64",
10
+ "linux-x64": "@spooky-sync/cli-linux-x64",
11
+ "win32-x64": "@spooky-sync/cli-win32-x64"
12
+ };
13
+ function P() {
14
+ const r = `${m()}-${u()}`, n = k[r];
15
+ if (!n) return;
16
+ const a = m() === "win32" ? "spky.exe" : "spky";
17
+ try {
18
+ const e = w(import.meta.url).resolve(`${n}/package.json`);
19
+ return t(d(e), a);
20
+ } catch {
21
+ return;
22
+ }
23
+ }
24
+ function B() {
25
+ const r = m() === "win32" ? "spky.exe" : "spky", n = P();
26
+ if (n && c(n))
27
+ return n;
28
+ const a = [
29
+ t(i, "../../../target/release", r),
30
+ // workspace release
31
+ t(i, "../target/release", r),
32
+ // per-package release
33
+ t(i, "../../../target/debug", r),
34
+ // workspace debug
35
+ t(i, "../target/debug", r)
36
+ // per-package debug
37
+ ], s = a.filter((o) => c(o));
38
+ if (s.length > 0)
39
+ return s.sort((o, x) => f(x).mtimeMs - f(o).mtimeMs), s[0];
40
+ const e = t(i, "..", r);
41
+ if (c(e))
42
+ return e;
43
+ const p = t(process.cwd(), r);
44
+ if (c(p))
45
+ return p;
46
+ const y = `${m()}-${u()}`, l = k[y], g = l ? `
47
+ Try installing the platform package: npm install ${l}` : `
48
+ Your platform (${y}) is not supported.`;
49
+ throw new Error(
50
+ `Could not find spky binary. Checked paths:
51
+ - Platform package (${l ?? "none"})
52
+ ` + a.map((o) => ` - ${o}
53
+ `).join("") + ` - ${e}
54
+ - ${p}
55
+ ` + g
56
+ );
57
+ }
58
+ export {
59
+ B as f
60
+ };
@@ -1 +1 @@
1
- {"version":3,"file":"resolve-binary.d.ts","sourceRoot":"","sources":["../src/resolve-binary.ts"],"names":[],"mappings":"AAiCA,wBAAgB,UAAU,IAAI,MAAM,CAyCnC"}
1
+ {"version":3,"file":"resolve-binary.d.ts","sourceRoot":"","sources":["../src/resolve-binary.ts"],"names":[],"mappings":"AAiCA,wBAAgB,UAAU,IAAI,MAAM,CAuDnC"}
package/dist/syncgen.cjs CHANGED
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("child_process"),a=require("util"),i=require("./resolve-binary-CFmJcXEj.cjs"),d=a.promisify(t.execFile);async function f(e){const n=i.findBinary(),r=[];r.push("--input",e.input),r.push("--output",e.output),e.format&&r.push("--format",e.format),e.pretty&&r.push("--pretty"),e.all&&r.push("--all"),e.noHeader&&r.push("--no-header"),e.append&&r.push("--append",e.append),e.modulesDir&&r.push("--modules-dir",e.modulesDir),e.mode&&r.push("--mode",e.mode),e.endpoint&&r.push("--endpoint",e.endpoint),e.secret&&r.push("--secret",e.secret),e.config&&r.push("--config",e.config);try{const{stdout:u,stderr:c}=await d(n,r);return c&&console.error(c),u}catch(u){throw new Error(`Syncgen failed: ${u.message}`)}}exports.runSyncgen=f;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("child_process"),a=require("util"),i=require("./resolve-binary-J8VAJRMF.cjs"),d=a.promisify(t.execFile);async function f(e){const n=i.findBinary(),r=[];r.push("--input",e.input),r.push("--output",e.output),e.format&&r.push("--format",e.format),e.pretty&&r.push("--pretty"),e.all&&r.push("--all"),e.noHeader&&r.push("--no-header"),e.append&&r.push("--append",e.append),e.modulesDir&&r.push("--modules-dir",e.modulesDir),e.mode&&r.push("--mode",e.mode),e.endpoint&&r.push("--endpoint",e.endpoint),e.secret&&r.push("--secret",e.secret),e.config&&r.push("--config",e.config);try{const{stdout:u,stderr:c}=await d(n,r);return c&&console.error(c),u}catch(u){throw new Error(`Syncgen failed: ${u.message}`,{cause:u})}}exports.runSyncgen=f;
package/dist/syncgen.js CHANGED
@@ -1,17 +1,17 @@
1
1
  import { execFile as c } from "child_process";
2
2
  import { promisify as d } from "util";
3
- import { f as t } from "./resolve-binary-BYotYL89.js";
3
+ import { f as t } from "./resolve-binary-kH1Jwk0z.js";
4
4
  const i = d(c);
5
- async function p(e) {
5
+ async function s(e) {
6
6
  const a = t(), r = [];
7
7
  r.push("--input", e.input), r.push("--output", e.output), e.format && r.push("--format", e.format), e.pretty && r.push("--pretty"), e.all && r.push("--all"), e.noHeader && r.push("--no-header"), e.append && r.push("--append", e.append), e.modulesDir && r.push("--modules-dir", e.modulesDir), e.mode && r.push("--mode", e.mode), e.endpoint && r.push("--endpoint", e.endpoint), e.secret && r.push("--secret", e.secret), e.config && r.push("--config", e.config);
8
8
  try {
9
- const { stdout: f, stderr: u } = await i(a, r);
10
- return u && console.error(u), f;
11
- } catch (f) {
12
- throw new Error(`Syncgen failed: ${f.message}`);
9
+ const { stdout: u, stderr: f } = await i(a, r);
10
+ return f && console.error(f), u;
11
+ } catch (u) {
12
+ throw new Error(`Syncgen failed: ${u.message}`, { cause: u });
13
13
  }
14
14
  }
15
15
  export {
16
- p as runSyncgen
16
+ s as runSyncgen
17
17
  };
package/package.json CHANGED
@@ -1,15 +1,16 @@
1
1
  {
2
2
  "name": "@spooky-sync/cli",
3
- "version": "0.0.1-canary.33",
3
+ "version": "0.0.1-canary.330",
4
4
  "description": "Generate TypeScript/Dart types from SurrealDB schema files",
5
5
  "type": "module",
6
6
  "main": "./dist/syncgen.cjs",
7
7
  "module": "./dist/syncgen.js",
8
8
  "types": "./dist/index.d.ts",
9
9
  "bin": {
10
- "spooky": "./dist/cli.js"
10
+ "spky": "./dist/cli.js"
11
11
  },
12
12
  "exports": {
13
+ "./devtools-mcp": "./devtools-mcp/index.js",
13
14
  ".": {
14
15
  "import": "./dist/syncgen.js",
15
16
  "require": "./dist/syncgen.cjs",
@@ -17,15 +18,20 @@
17
18
  }
18
19
  },
19
20
  "files": [
20
- "dist"
21
+ "dist",
22
+ "devtools-mcp",
23
+ "templates/cookbook",
24
+ "AGENTS.md"
21
25
  ],
22
26
  "scripts": {
23
27
  "dev": "vite",
28
+ "dev:build": "cargo build -p sp00ky-cli",
24
29
  "build:rust": "cargo build --release",
25
30
  "build:vite": "vite build",
26
31
  "build:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist",
32
+ "build:devtools-mcp": "vite build --config vite.config.devtools-mcp.ts",
27
33
  "build:js": "npm run build:vite && npm run build:types",
28
- "build": "npm run build:rust && npm run build:js",
34
+ "build": "npm run build:rust && npm run build:devtools-mcp && npm run build:js",
29
35
  "preview": "vite preview",
30
36
  "test": "vitest",
31
37
  "lint": "eslint src",
@@ -56,10 +62,10 @@
56
62
  "vitest": "^1.0.0"
57
63
  },
58
64
  "optionalDependencies": {
59
- "@spooky-sync/cli-darwin-arm64": "0.0.1-canary.33",
60
- "@spooky-sync/cli-darwin-x64": "0.0.1-canary.33",
61
- "@spooky-sync/cli-linux-arm64": "0.0.1-canary.33",
62
- "@spooky-sync/cli-linux-x64": "0.0.1-canary.33",
63
- "@spooky-sync/cli-win32-x64": "0.0.1-canary.33"
65
+ "@spooky-sync/cli-darwin-arm64": "0.0.1-canary.330",
66
+ "@spooky-sync/cli-darwin-x64": "0.0.1-canary.330",
67
+ "@spooky-sync/cli-linux-arm64": "0.0.1-canary.330",
68
+ "@spooky-sync/cli-linux-x64": "0.0.1-canary.330",
69
+ "@spooky-sync/cli-win32-x64": "0.0.1-canary.330"
64
70
  }
65
71
  }
@@ -0,0 +1,31 @@
1
+ # sp00ky cookbook
2
+
3
+ A short, scannable list of patterns an AI agent (or human) reaches for when writing code against a sp00ky-backed app. Each entry has a one-sentence "when to use," the canonical snippet, and one gotcha.
4
+
5
+ Render any recipe with:
6
+ ```
7
+ spky recipe <recipe> --table <your-table>
8
+ ```
9
+ or pass `--out path/to/file.tsx` to write the snippet directly.
10
+
11
+ ## Recipes
12
+
13
+ ### `live-list`
14
+ **When to use:** you want a reactive, sorted list of rows from a table that updates as records change.
15
+ **Render:** `spky recipe live-list --table thread`
16
+ **Gotcha:** end the query with `.build()` — `useQuery` will hang on a bare builder.
17
+
18
+ ### `optimistic-mutation`
19
+ **When to use:** you're inserting a new record from a UI action (form submit, button click) and want the local cache to update immediately while the mutation drains to the remote.
20
+ **Render:** `spky recipe optimistic-mutation --table thread`
21
+ **Gotcha:** `db.create` takes a *full* record-ID string (`'thread:abc'`), not `(table, payload)`. Use `Uuid` to mint IDs.
22
+
23
+ ### `crdt-text-field`
24
+ **When to use:** a `TYPE string` field is annotated `-- @crdt text` in your schema and several people should edit it at once.
25
+ **Render:** `spky recipe crdt-text-field --table note --field body`
26
+ **Gotcha:** edit through `useCrdtField(table, () => id, field)` and its `getDoc()`; never put the field in a `db.create` / `db.update` payload (the server owns it). The column itself is the server-written plain text, fine to read with `useQuery` for previews, but it trails live edits until the server folds the edit log. For `@crdt prosemirror` fields bind a ProseMirror editor with `loro-prosemirror` instead of a textarea.
27
+
28
+ ## Related
29
+
30
+ - See `AGENTS.md` (in your project root or `node_modules/@spooky-sync/*/AGENTS.md`) for the broader mental model and gotchas.
31
+ - After editing the schema: `spky generate` then `spky doctor` to confirm everything is in sync.
@@ -0,0 +1,54 @@
1
+ // Recipe: crdt-text-field
2
+ // A collaborative textarea for `{{table}}.{{field}}`, declared in the schema as
3
+ //
4
+ // -- @crdt text
5
+ // DEFINE FIELD {{field}} ON TABLE {{table}} TYPE string;
6
+ //
7
+ // The editor binds to the field's Loro document. Each client sends only its own
8
+ // edits (rows of the generated `{{table}}__crdt_log` table, through the outbox)
9
+ // and merges everyone else's as they sync; the server folds them into the
10
+ // canonical document. The `{{field}}` column itself is the server-written plain
11
+ // text: render it for previews, never write it with `db.create` / `db.update`.
12
+
13
+ import { createEffect, createSignal, onCleanup, Show } from 'solid-js';
14
+ import { useCrdtField, useDb, useQuery } from '@spooky-sync/client-solid';
15
+ import { schema } from '../schema.gen';
16
+
17
+ export function {{TablePascal}}{{FieldPascal}}Editor(props: { id: string }) {
18
+ // 3 arguments: table, a reactive record id, field. Reopens when the id changes.
19
+ const field = useCrdtField('{{table}}', () => props.id, '{{field}}');
20
+ const [text, setText] = createSignal('');
21
+
22
+ // Follow the document: local and remote edits alike re-render the textarea.
23
+ createEffect(() => {
24
+ const doc = field()?.getDoc();
25
+ if (!doc) return;
26
+ const loroText = doc.getText('{{field}}');
27
+ setText(loroText.toString());
28
+ onCleanup(doc.subscribe(() => setText(loroText.toString())));
29
+ });
30
+
31
+ const handleInput = (e: InputEvent & { currentTarget: HTMLTextAreaElement }) => {
32
+ const doc = field()?.getDoc();
33
+ if (!doc) return;
34
+ // Diff into the document rather than replacing it, so concurrent edits merge.
35
+ doc.getText('{{field}}').update(e.currentTarget.value);
36
+ doc.commit();
37
+ };
38
+
39
+ return (
40
+ <Show when={field()} fallback={<p>Loading...</p>}>
41
+ <textarea value={text()} onInput={handleInput} />
42
+ </Show>
43
+ );
44
+ }
45
+
46
+ // Previews read the column like any other. It is the document's text as of the
47
+ // server's last fold, so it trails live edits (a few seconds by default).
48
+ export function {{TablePascal}}{{FieldPascal}}Preview(props: { id: string }) {
49
+ const db = useDb<typeof schema>();
50
+ const result = useQuery(() =>
51
+ db.query('{{table}}').where({ id: props.id } as any).build()
52
+ );
53
+ return <p>{result.data()?.[0]?.{{field}}}</p>;
54
+ }
@@ -0,0 +1,22 @@
1
+ // Recipe: live-list
2
+ // Reactive, sorted list of `{{table}}` rows. Re-runs automatically as records change.
3
+
4
+ import { For } from 'solid-js';
5
+ import { useQuery, useDb } from '@spooky-sync/client-solid';
6
+ import { schema } from '../schema.gen';
7
+
8
+ export function {{TablePascal}}List() {
9
+ const db = useDb<typeof schema>();
10
+
11
+ const result = useQuery(() =>
12
+ db.query('{{table}}').orderBy('id', 'asc').limit(50).build()
13
+ );
14
+
15
+ return (
16
+ <ul>
17
+ <For each={result.data() ?? []}>
18
+ {(row) => <li>{row.id}</li>}
19
+ </For>
20
+ </ul>
21
+ );
22
+ }
@@ -0,0 +1,33 @@
1
+ // Recipe: optimistic-mutation
2
+ // Insert a new `{{table}}` row from a UI action. Local cache updates immediately;
3
+ // the mutation drains to the remote in the background.
4
+
5
+ import { createSignal } from 'solid-js';
6
+ import { Uuid, useDb } from '@spooky-sync/client-solid';
7
+ import { schema } from '../schema.gen';
8
+
9
+ export function Create{{TablePascal}}Form() {
10
+ const db = useDb<typeof schema>();
11
+ const [submitting, setSubmitting] = createSignal(false);
12
+
13
+ const handleSubmit = async (e: SubmitEvent) => {
14
+ e.preventDefault();
15
+ setSubmitting(true);
16
+ try {
17
+ const id = new Uuid().toString();
18
+ await db.create(`{{table}}:${id}`, {
19
+ // TODO: fill in the fields your `{{table}}` schema requires.
20
+ });
21
+ } finally {
22
+ setSubmitting(false);
23
+ }
24
+ };
25
+
26
+ return (
27
+ <form onSubmit={handleSubmit}>
28
+ <button type="submit" disabled={submitting()}>
29
+ {submitting() ? 'Creating…' : 'Create {{table}}'}
30
+ </button>
31
+ </form>
32
+ );
33
+ }
@@ -1,51 +0,0 @@
1
- import { platform as s, arch as l } from "os";
2
- import { dirname as y, resolve as a } from "path";
3
- import { existsSync as e } from "fs";
4
- import { fileURLToPath as k } from "url";
5
- import { createRequire as d } from "module";
6
- const x = k(import.meta.url), m = y(x), f = {
7
- "darwin-arm64": "@spooky-sync/cli-darwin-arm64",
8
- "darwin-x64": "@spooky-sync/cli-darwin-x64",
9
- "linux-arm64": "@spooky-sync/cli-linux-arm64",
10
- "linux-x64": "@spooky-sync/cli-linux-x64",
11
- "win32-x64": "@spooky-sync/cli-win32-x64"
12
- };
13
- function w() {
14
- const r = `${s()}-${l()}`, o = f[r];
15
- if (!o) return;
16
- const n = s() === "win32" ? "spooky.exe" : "spooky";
17
- try {
18
- const t = d(import.meta.url).resolve(`${o}/package.json`);
19
- return a(y(t), n);
20
- } catch {
21
- return;
22
- }
23
- }
24
- function _() {
25
- const r = s() === "win32" ? "spooky.exe" : "spooky", o = w();
26
- if (o && e(o))
27
- return o;
28
- const n = a(m, "../target/release", r);
29
- if (e(n))
30
- return n;
31
- const i = a(m, "..", r);
32
- if (e(i))
33
- return i;
34
- const t = a(process.cwd(), r);
35
- if (e(t))
36
- return t;
37
- const p = `${s()}-${l()}`, c = f[p], u = c ? `
38
- Try installing the platform package: npm install ${c}` : `
39
- Your platform (${p}) is not supported.`;
40
- throw new Error(
41
- `Could not find spooky binary. Checked paths:
42
- - Platform package (${c ?? "none"})
43
- - ${n}
44
- - ${i}
45
- - ${t}
46
- ` + u
47
- );
48
- }
49
- export {
50
- _ as f
51
- };
@@ -1,8 +0,0 @@
1
- "use strict";const n=require("os"),r=require("path"),c=require("fs"),d=require("url"),m=require("module");var o=typeof document<"u"?document.currentScript:null;const h=d.fileURLToPath(typeof document>"u"?require("url").pathToFileURL(__filename).href:o&&o.tagName.toUpperCase()==="SCRIPT"&&o.src||new URL("resolve-binary-CFmJcXEj.cjs",document.baseURI).href),p=r.dirname(h),y={"darwin-arm64":"@spooky-sync/cli-darwin-arm64","darwin-x64":"@spooky-sync/cli-darwin-x64","linux-arm64":"@spooky-sync/cli-linux-arm64","linux-x64":"@spooky-sync/cli-linux-x64","win32-x64":"@spooky-sync/cli-win32-x64"};function k(){const t=`${n.platform()}-${n.arch()}`,e=y[t];if(!e)return;const s=n.platform()==="win32"?"spooky.exe":"spooky";try{const i=m.createRequire(typeof document>"u"?require("url").pathToFileURL(__filename).href:o&&o.tagName.toUpperCase()==="SCRIPT"&&o.src||new URL("resolve-binary-CFmJcXEj.cjs",document.baseURI).href).resolve(`${e}/package.json`);return r.resolve(r.dirname(i),s)}catch{return}}function x(){const t=n.platform()==="win32"?"spooky.exe":"spooky",e=k();if(e&&c.existsSync(e))return e;const s=r.resolve(p,"../target/release",t);if(c.existsSync(s))return s;const a=r.resolve(p,"..",t);if(c.existsSync(a))return a;const i=r.resolve(process.cwd(),t);if(c.existsSync(i))return i;const u=`${n.platform()}-${n.arch()}`,l=y[u],f=l?`
2
- Try installing the platform package: npm install ${l}`:`
3
- Your platform (${u}) is not supported.`;throw new Error(`Could not find spooky binary. Checked paths:
4
- - Platform package (${l??"none"})
5
- - ${s}
6
- - ${a}
7
- - ${i}
8
- `+f)}exports.findBinary=x;