@indexable/sdk 0.0.4 → 0.2.0

package/src/index.ts

@@ -1,146 +1,7 @@
-/**
- * @indexable/sdk — TypeScript SDK for the ix platform.
- *
- * Native addon built from Rust via napi-rs. No WASM, no runtime init.
- *
- * ```ts
- * import Ix from "@indexable/sdk"
- *
- * const ix = new Ix()
- * const vm = ix.spawn("ubuntu:24.04")         // sync — no await
- * console.log(vm.id)                           // "vm_06e9..." (available immediately)
- * await vm.writeFile("/tmp/hi", "hello")       // first await creates the VM on server
- * ```
- */
+// @indexable/sdk — TypeScript bindings for the ix platform.
+//
+// This package re-exports UniFFI-generated bindings from ix-sdk-ffi.
+// All business logic, RPC, and protocol handling lives in the Rust SDK.
+// This package is a thin TypeScript wrapper — nothing more.
 
-// napi-rs native addon — loaded from platform-specific npm package.
-import { createRequire } from "node:module";
-
-const require = createRequire(import.meta.url);
-
-// Platform packages installed via optionalDependencies.
-// npm/bun only installs the one matching the current os+cpu.
-const PLATFORM_PACKAGES: Record<string, string> = {
-	"linux-x64": "@indexable/sdk-linux-x64-gnu",
-};
-
-function loadNativeAddon() {
-	const key = `${process.platform}-${process.arch}`;
-	const pkg = PLATFORM_PACKAGES[key];
-	if (!pkg) throw new Error(`@indexable/sdk: unsupported platform ${key}`);
-	try {
-		return require(pkg);
-	} catch {
-		throw new Error(
-			`@indexable/sdk: failed to load native addon for ${key}. ` +
-				`Ensure ${pkg} is installed (npm install / bun install).`,
-		);
-	}
-}
-
-const native = loadNativeAddon();
-
-export interface SpawnOptions {
-	name?: string;
-	memory?: number;
-	cpus?: number;
-	ipv4?: boolean;
-}
-
-export interface DirEntry {
-	name: string;
-	size: number;
-	isDir: boolean;
-}
-
-export interface MergeResult {
-	appliedOps: number;
-	conflictPaths: string[];
-}
-
-export interface SecretEntry {
-	name: string;
-	createdAt: string;
-}
-
-/** Output from executing a command inside a VM. */
-export interface ExecResult {
-	/** Process exit code (0 = success). */
-	exitCode: number;
-	/** Captured stdout. */
-	stdout: string;
-	/** Captured stderr. */
-	stderr: string;
-}
-
-export interface ConnectOptions {
-	server?: string;
-	token?: string;
-}
-
-/** A virtual machine handle. Getters return `null` until the first awaited operation. */
-export interface Vm {
-	/** VM identifier — always available, even before the VM is created on the server. */
-	readonly id: string;
-	readonly name: string | null;
-	readonly image: string | null;
-	readonly status: string | null;
-	readonly ipv6: string | null;
-	readonly ipv4: string | null;
-	readonly subdomain: string | null;
-	readonly startedAt: string | null;
-	readonly stoppedAt: string | null;
-	readonly failureReason: string | null;
-
-	/** Explicitly trigger VM creation when you need metadata before any operation. */
-	ready(): Promise<void>;
-
-	stop(): Promise<void>;
-	start(): Promise<void>;
-	restart(): Promise<void>;
-	delete(): Promise<void>;
-
-	/** Execute a command inside the VM and return its output. */
-	exec(command: string[], workingDir?: string): Promise<ExecResult>;
-
-	writeFile(path: string, content: string): Promise<void>;
-	readFile(path: string): Promise<string>;
-	listDir(path: string): Promise<DirEntry[]>;
-
-	fork(name?: string): Promise<Vm>;
-	merge(source: Vm): Promise<MergeResult>;
-
-	undo(): Promise<boolean>;
-	redo(): Promise<boolean>;
-	revert(timestampMs: number): Promise<void>;
-
-	setSecret(key: string, value: string): Promise<void>;
-	deleteSecret(key: string): Promise<void>;
-	secrets(): Promise<SecretEntry[]>;
-}
-
-/** The ix SDK client. */
-export class Ix {
-	private inner: InstanceType<typeof native.Ix>;
-
-	constructor(options?: ConnectOptions) {
-		this.inner = new native.Ix(options ?? undefined);
-	}
-
-	/** Create a VM handle from an OCI image. Returns immediately (sync). */
-	spawn(image: string, options?: SpawnOptions): Vm {
-		return this.inner.spawn(image, options ?? undefined);
-	}
-
-	/** Retrieve a single VM by ID. */
-	async getVm(vmId: string): Promise<Vm> {
-		return this.inner.getVm(vmId);
-	}
-
-	/** List all VMs. */
-	async vms(): Promise<Vm[]> {
-		return this.inner.vms();
-	}
-}
-
-export default Ix;
+export * from './bindings'

package/src/index.test.ts

@@ -1,165 +0,0 @@
-import { describe, test, expect, afterEach } from "bun:test";
-import Ix from "./index";
-import type { Vm } from "./index";
-
-const IMAGE = "ubuntu:24.04";
-const TIMEOUT_MS = 120_000;
-
-let cleanup: Vm[] = [];
-
-afterEach(async () => {
-	for (const vm of cleanup) {
-		try {
-			await vm.stop();
-		} catch {
-			// might already be stopped
-		}
-		try {
-			await vm.delete();
-		} catch {
-			// best-effort
-		}
-	}
-	cleanup = [];
-});
-
-function track(vm: Vm): Vm {
-	cleanup.push(vm);
-	return vm;
-}
-
-describe("Ix", () => {
-	test("lists VMs", async () => {
-		const ix = new Ix();
-		const vms = await ix.vms();
-		expect(Array.isArray(vms)).toBe(true);
-	});
-});
-
-describe("Vm lifecycle", () => {
-	test(
-		"spawn → ready → getters → stop",
-		async () => {
-			const ix = new Ix();
-			const vm = track(ix.spawn(IMAGE, { name: "sdk-lifecycle" }));
-
-			// ID is available immediately (client-generated).
-			expect(vm.id).toMatch(/^vm_/);
-
-			await vm.ready();
-			expect(vm.id).toBeTruthy();
-			expect(vm.image).toBe(IMAGE);
-			expect(vm.ipv6).toBeTruthy();
-			expect(vm.status).toBe("running");
-
-			await vm.stop();
-			cleanup = [];
-		},
-		TIMEOUT_MS,
-	);
-});
-
-describe("Vm filesystem", () => {
-	test(
-		"writeFile → readFile → listDir",
-		async () => {
-			const ix = new Ix();
-			const vm = track(ix.spawn(IMAGE, { name: "sdk-fs" }));
-
-			const content = `hello from sdk test ${Date.now()}`;
-			await vm.writeFile("/tmp/sdk-test.txt", content);
-
-			const read = await vm.readFile("/tmp/sdk-test.txt");
-			expect(read).toBe(content);
-
-			const entries = await vm.listDir("/tmp");
-			const found = entries.find((e) => e.name === "sdk-test.txt");
-			expect(found).toBeTruthy();
-		},
-		TIMEOUT_MS,
-	);
-});
-
-describe("Vm exec", () => {
-	test(
-		"exec → capture stdout and exit code",
-		async () => {
-			const ix = new Ix();
-			const vm = track(ix.spawn(IMAGE, { name: "sdk-exec" }));
-
-			const result = await vm.exec(["echo", "hello from exec"]);
-			expect(result.exitCode).toBe(0);
-			expect(result.stdout).toContain("hello from exec");
-			expect(result.stderr).toBe("");
-		},
-		TIMEOUT_MS,
-	);
-
-	test(
-		"exec → nonzero exit code",
-		async () => {
-			const ix = new Ix();
-			const vm = track(ix.spawn(IMAGE, { name: "sdk-exec-fail" }));
-
-			const result = await vm.exec(["sh", "-c", "exit 42"]);
-			expect(result.exitCode).toBe(42);
-		},
-		TIMEOUT_MS,
-	);
-
-	test(
-		"exec → capture stderr",
-		async () => {
-			const ix = new Ix();
-			const vm = track(ix.spawn(IMAGE, { name: "sdk-exec-stderr" }));
-
-			const result = await vm.exec([
-				"sh",
-				"-c",
-				"echo err >&2; echo out",
-			]);
-			expect(result.exitCode).toBe(0);
-			expect(result.stdout).toContain("out");
-			expect(result.stderr).toContain("err");
-		},
-		TIMEOUT_MS,
-	);
-
-	test(
-		"exec → working directory",
-		async () => {
-			const ix = new Ix();
-			const vm = track(ix.spawn(IMAGE, { name: "sdk-exec-cwd" }));
-
-			const result = await vm.exec(["pwd"], "/tmp");
-			expect(result.exitCode).toBe(0);
-			expect(result.stdout.trim()).toBe("/tmp");
-		},
-		TIMEOUT_MS,
-	);
-});
-
-describe("Vm version control", () => {
-	test(
-		"fork → write on fork → merge back",
-		async () => {
-			const ix = new Ix();
-			const main = track(ix.spawn(IMAGE, { name: "sdk-vcs-main" }));
-
-			await main.writeFile("/tmp/file-a.txt", "from main");
-
-			const fork = track(await main.fork("sdk-vcs-fork"));
-
-			await fork.writeFile("/tmp/file-b.txt", "from fork");
-
-			const result = await main.merge(fork);
-			expect(result.conflictPaths.length).toBe(0);
-
-			const a = await main.readFile("/tmp/file-a.txt");
-			expect(a).toBe("from main");
-			const b = await main.readFile("/tmp/file-b.txt");
-			expect(b).toBe("from fork");
-		},
-		TIMEOUT_MS,
-	);
-});