@spooky-sync/cli 0.0.0-canary.1

package/README.md

@@ -0,0 +1,105 @@
+# Spooky CLI
+
+Generate TypeScript and Dart types from SurrealDB schema files.
+
+## Overview
+
+This package wraps a Rust-based code generator that parses SurrealDB `.surql` schema files and generates type definitions. The core logic is implemented in Rust for performance, with a TypeScript/Node.js wrapper for easy integration into JavaScript/TypeScript projects.
+
+## Prerequisites
+
+- Rust toolchain (for building from source)
+- Node.js 18+
+- npx (for quicktype code generation)
+
+## Usage
+
+### CLI
+
+```bash
+# Generate TypeScript types
+spooky --input schema.surql --output types.ts
+
+# Generate Dart types
+spooky --input schema.surql --output types.dart
+
+# Generate JSON Schema
+spooky --input schema.surql --output schema.json
+
+# Generate all formats at once
+spooky --input schema.surql --output output --all
+
+# Specify format explicitly
+spooky --input schema.surql --output output.ts --format typescript
+```
+
+### Programmatic API
+
+```typescript
+import { runSpooky } from 'spooky-cli';
+
+// Generate types
+const output = await runSpooky({
+  input: 'path/to/schema.surql',
+  output: 'path/to/output.ts',
+  format: 'typescript', // or 'dart', 'json'
+  pretty: true,
+  all: false,
+});
+
+console.log(output);
+```
+
+## Options
+
+- `--input, -i`: Path to the input `.surql` schema file (required)
+- `--output, -o`: Path to the output file (required)
+- `--format, -f`: Output format: `json`, `typescript`, `dart` (optional, inferred from extension)
+- `--pretty, -p`: Pretty print JSON output (default: true)
+- `--all, -a`: Generate all formats (TypeScript, Dart, and JSON Schema)
+
+## Development
+
+### Build
+
+```bash
+# Install dependencies
+npm install
+
+# Build Rust binary and TypeScript wrapper
+npm run build
+
+# Build only Rust
+npm run build:rust
+
+# Build only TypeScript
+npm run build:vite
+```
+
+### Project Structure
+
+```
+cli/
+├── src/
+│   ├── main.rs          # Rust CLI entry point
+│   ├── parser.rs        # SurrealDB schema parser
+│   ├── json_schema.rs   # JSON Schema generator
+│   ├── codegen.rs       # Code generation logic
+│   ├── index.ts         # TypeScript wrapper
+│   └── cli.ts           # TypeScript CLI wrapper
+├── Cargo.toml           # Rust dependencies
+├── package.json         # npm package config
+├── vite.config.ts       # Vite build config
+└── tsconfig.json        # TypeScript config
+```
+
+## How It Works
+
+1. The Rust binary (`spooky`) parses SurrealDB schema files and generates JSON Schema
+2. For TypeScript/Dart output, it uses `quicktype` to convert JSON Schema to the target language
+3. The TypeScript wrapper (`src/index.ts`) spawns the Rust binary as a child process
+4. Vite bundles the TypeScript wrapper for distribution
+
+## License
+
+MIT

package/dist/cli.cjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+"use strict";const n=require("commander"),r=require("./syncgen.cjs"),o=new n.Command;o.name("syncgen").description("Generate types from SurrealDB schema files").version("0.1.0");o.option("-i, --input <path>","Path to the input .surql schema file").option("-o, --output <path>","Path to the output file (extension determines format: .json, .ts, .dart)").option("-f, --format <format>","Output format (json, typescript, dart, surql)").option("-p, --pretty","Pretty print the JSON output (only for JSON format)",!0).option("-a, --all","Generate all formats (TypeScript and Dart) in addition to JSON Schema",!1).option("--no-header","Disable the generated file comment header (enabled by default)",!1).option("--append <path>","Path to another .surql file to append to the input").option("--modules-dir <path>","Directory containing Surrealism modules to compile and bundle").option("--mode <mode>",'Generation mode: "singlenode" (HTTP to single SSP), "cluster" (HTTP to scheduler), or "surrealism" (embedded WASM)',"singlenode").option("--endpoint <url>","SSP/Scheduler Endpoint URL").option("--secret <secret>","SSP/Scheduler Auth Secret").option("--config <path>","Path to spooky.yml configuration file").parse(process.argv);const e=o.opts();async function i(){(!e.input||!e.output)&&(console.error("Error: --input and --output are required"),o.help(),process.exit(1));try{const t=await r.runSyncgen({input:e.input,output:e.output,format:e.format,pretty:e.pretty,all:e.all,noHeader:e.noHeader,append:e.append,modulesDir:e.modulesDir,mode:e.mode,endpoint:e.endpoint,secret:e.secret,config:e.config});console.log(t)}catch(t){console.error("Error:",t instanceof Error?t.message:String(t)),process.exit(1)}}i();

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+import { Command as n } from "commander";
+import { runSyncgen as r } from "./syncgen.js";
+const o = new n();
+o.name("syncgen").description("Generate types from SurrealDB schema files").version("0.1.0");
+o.option("-i, --input <path>", "Path to the input .surql schema file").option(
+  "-o, --output <path>",
+  "Path to the output file (extension determines format: .json, .ts, .dart)"
+).option("-f, --format <format>", "Output format (json, typescript, dart, surql)").option("-p, --pretty", "Pretty print the JSON output (only for JSON format)", !0).option(
+  "-a, --all",
+  "Generate all formats (TypeScript and Dart) in addition to JSON Schema",
+  !1
+).option("--no-header", "Disable the generated file comment header (enabled by default)", !1).option("--append <path>", "Path to another .surql file to append to the input").option("--modules-dir <path>", "Directory containing Surrealism modules to compile and bundle").option(
+  "--mode <mode>",
+  'Generation mode: "singlenode" (HTTP to single SSP), "cluster" (HTTP to scheduler), or "surrealism" (embedded WASM)',
+  "singlenode"
+).option("--endpoint <url>", "SSP/Scheduler Endpoint URL").option("--secret <secret>", "SSP/Scheduler Auth Secret").option("--config <path>", "Path to spooky.yml configuration file").parse(process.argv);
+const e = o.opts();
+async function i() {
+  (!e.input || !e.output) && (console.error("Error: --input and --output are required"), o.help(), process.exit(1));
+  try {
+    const t = await r({
+      input: e.input,
+      output: e.output,
+      format: e.format,
+      pretty: e.pretty,
+      all: e.all,
+      noHeader: e.noHeader,
+      append: e.append,
+      modulesDir: e.modulesDir,
+      mode: e.mode,
+      endpoint: e.endpoint,
+      secret: e.secret,
+      config: e.config
+    });
+    console.log(t);
+  } catch (t) {
+    console.error("Error:", t instanceof Error ? t.message : String(t)), process.exit(1);
+  }
+}
+i();

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+export interface SyncgenOptions {
+    input: string;
+    output: string;
+    format?: 'json' | 'typescript' | 'dart' | 'surql';
+    pretty?: boolean;
+    all?: boolean;
+    noHeader?: boolean;
+    append?: string;
+    modulesDir?: string;
+    mode?: string;
+    endpoint?: string;
+    secret?: string;
+    config?: string;
+}
+export declare function runSyncgen(options: SyncgenOptions): Promise<string>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;IAClD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AA0BD,wBAAsB,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CA0DzE"}

package/dist/syncgen.cjs

@@ -0,0 +1,4 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("child_process"),o=require("util"),t=require("path"),d=require("fs"),f=require("os"),l=require("url");var c=typeof document<"u"?document.currentScript:null;const p=o.promisify(a.execFile),h=l.fileURLToPath(typeof document>"u"?require("url").pathToFileURL(__filename).href:c&&c.tagName.toUpperCase()==="SCRIPT"&&c.src||new URL("syncgen.cjs",document.baseURI).href),i=t.dirname(h);function m(){const e=f.platform()==="win32"?"spooky.exe":"spooky",n=[t.resolve(i,"../target/release",e),t.resolve(i,"..",e),t.resolve(process.cwd(),e)];for(const r of n)if(d.existsSync(r))return r;throw new Error(`Could not find syncgen binary. Checked paths:
+${n.map(r=>` - ${r}`).join(`
+`)}
+Please ensure it is built or installed.`)}async function y(e){const n=m(),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:s,stderr:u}=await p(n,r);return u&&console.error(u),s}catch(s){throw new Error(`Syncgen failed: ${s.message}`)}}exports.runSyncgen=y;

package/dist/syncgen.d.ts

@@ -0,0 +1 @@
+export * from './index'

package/dist/syncgen.js

@@ -0,0 +1,39 @@
+import { execFile as s } from "child_process";
+import { promisify as o } from "util";
+import { dirname as c, resolve as i } from "path";
+import { existsSync as m } from "fs";
+import { platform as u } from "os";
+import { fileURLToPath as d } from "url";
+const p = o(s), l = d(import.meta.url), f = c(l);
+function h() {
+  const e = u() === "win32" ? "spooky.exe" : "spooky", t = [
+    // Development/Source build location (from dist/index.js -> ../target/release)
+    i(f, "../target/release", e),
+    // Distributed package location (relative to dist/index.js -> ../bin)
+    i(f, "..", e),
+    // Installation root
+    i(process.cwd(), e)
+  ];
+  for (const r of t)
+    if (m(r))
+      return r;
+  throw new Error(
+    `Could not find syncgen binary. Checked paths:
+${t.map((r) => ` - ${r}`).join(`
+`)}
+Please ensure it is built or installed.`
+  );
+}
+async function _(e) {
+  const t = h(), 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: n, stderr: a } = await p(t, r);
+    return a && console.error(a), n;
+  } catch (n) {
+    throw new Error(`Syncgen failed: ${n.message}`);
+  }
+}
+export {
+  _ as runSyncgen
+};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@spooky-sync/cli",
+  "version": "0.0.0-canary.1",
+  "description": "Generate TypeScript/Dart types from SurrealDB schema files",
+  "type": "module",
+  "main": "./dist/syncgen.cjs",
+  "module": "./dist/syncgen.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "spooky": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/syncgen.js",
+      "require": "./dist/syncgen.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "target/release/spooky"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build:rust": "cargo build --release",
+    "build:vite": "vite build",
+    "build:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist",
+    "build": "npm run build:rust && npm run build:vite && npm run build:types",
+    "preview": "vite preview",
+    "test": "vitest",
+    "lint": "eslint src",
+    "prepare": "test -f ./dist/cli.js || npm run build"
+  },
+  "keywords": [
+    "surrealdb",
+    "code-generation",
+    "typescript",
+    "dart",
+    "schema"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mono424/spooky.git",
+    "directory": "apps/cli"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "commander": "^12.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.3.0",
+    "vite": "^5.0.0",
+    "vite-plugin-dts": "^3.7.0",
+    "vitest": "^1.0.0"
+  }
+}