@lix-js/sdk 0.5.0-preview.0 → 0.5.0-preview.1

package/src/file/materialize-file-data-at-changeset.ts

@@ -1,123 +0,0 @@
-import { executeSync } from "../database/execute-sync.js";
-import type { Lix } from "../lix/open-lix.js";
-import type { LixFile } from "./schema.js";
-import { lixUnknownFileFallbackPlugin } from "./unknown-file-fallback-plugin.js";
-
-function globSync(args: {
-	lix: Pick<Lix, "sqlite">;
-	glob: string;
-	path: string;
-}): boolean {
-	const columnNames: string[] = [];
-	const result = args.lix.sqlite.exec({
-		sql: `SELECT CASE WHEN ? GLOB ? THEN 1 ELSE 0 END AS matches`,
-		bind: [args.path, args.glob],
-		returnValue: "resultRows",
-		columnNames,
-	});
-
-	return (result[0]?.[0] as any) === 1;
-}
-
-export function materializeFileDataAtChangeset(args: {
-	lix: Pick<Lix, "sqlite" | "plugin" | "db">;
-	file: Omit<LixFile, "data">;
-	changeSetId: string;
-	depth: number;
-}): Uint8Array {
-	const plugins = args.lix.plugin.getAllSync();
-
-	// First, try to find a specific plugin that can handle this file (excluding fallback)
-	for (const plugin of plugins) {
-		if (
-			!plugin.detectChangesGlob ||
-			!globSync({
-				lix: args.lix,
-				path: args.file.path,
-				glob: plugin.detectChangesGlob,
-			})
-		) {
-			continue;
-		}
-
-		if (!plugin.applyChanges) {
-			continue;
-		}
-
-		// Get plugin changes from state_history table
-		const changes = executeSync({
-			lix: args.lix,
-			query: args.lix.db
-				.selectFrom("state_history")
-				.where("plugin_key", "=", plugin.key)
-				.where("file_id", "=", args.file.id)
-				.where("change_set_id", "=", args.changeSetId)
-				.where("depth", "=", args.depth)
-				.select([
-					"entity_id",
-					"schema_key",
-					"file_id",
-					"plugin_key",
-					"snapshot_content",
-					"change_set_id as version_id", // Map to maintain compatibility
-				]),
-		});
-
-		// Format changes for plugin
-		const formattedChanges = changes.map((change) => ({
-			...change,
-			snapshot_content:
-				typeof change.snapshot_content === "string"
-					? JSON.parse(change.snapshot_content)
-					: change.snapshot_content,
-		}));
-
-		const file = plugin.applyChanges({
-			file: args.file,
-			changes: formattedChanges,
-		});
-
-		return file.fileData;
-	}
-
-	// If no specific plugin matched, use the fallback plugin
-	const changes = executeSync({
-		lix: args.lix,
-		query: args.lix.db
-			.selectFrom("state_history")
-			.where("plugin_key", "=", lixUnknownFileFallbackPlugin.key)
-			.where("file_id", "=", args.file.id)
-			.where("change_set_id", "=", args.changeSetId)
-			.where("depth", "=", args.depth)
-			.select([
-				"entity_id",
-				"schema_key",
-				"file_id",
-				"plugin_key",
-				"snapshot_content",
-				"change_set_id as version_id", // Map to maintain compatibility
-			]),
-	});
-
-	// Format changes for plugin
-	const formattedChanges = changes.map((change) => ({
-		...change,
-		snapshot_content:
-			typeof change.snapshot_content === "string"
-				? JSON.parse(change.snapshot_content)
-				: change.snapshot_content,
-	}));
-
-	if (formattedChanges.length === 0) {
-		throw new Error(
-			`[materializeFileDataAtChangeset] No changes found for file ${args.file.id} with plugin ${lixUnknownFileFallbackPlugin.key} at changeset ${args.changeSetId} depth ${args.depth}. Cannot materialize file data.`
-		);
-	}
-
-	const file = lixUnknownFileFallbackPlugin.applyChanges!({
-		file: args.file,
-		changes: formattedChanges,
-	});
-
-	return file.fileData;
-}

package/src/query-filter/change-has-label.test.ts

@@ -1,79 +0,0 @@
-import { test, expect } from "vitest";
-import { changeHasLabel } from "./change-has-label.js";
-import { openLix } from "../lix/open-lix.js";
-import { createChangeSet } from "../change-set/create-change-set.js";
-
-test("should only return changes with the given label", async () => {
-	const lix = await openLix({});
-
-	await lix.db
-		.insertInto("stored_schema")
-		.values({
-			value: {
-				"x-lix-key": "mock_schema",
-				"x-lix-version": "1.0",
-				type: "object",
-			},
-		})
-		.execute();
-
-	const changes0 = await lix.db
-		.insertInto("change")
-		.values([
-			{
-				id: "change1",
-				snapshot_content: null,
-				entity_id: "mock",
-				file_id: "mock",
-				schema_version: "1.0",
-				plugin_key: "mock",
-				schema_key: "mock_schema",
-			},
-			{
-				id: "change2",
-				snapshot_content: null,
-				entity_id: "mock",
-				file_id: "mock",
-				schema_version: "1.0",
-				plugin_key: "mock",
-				schema_key: "mock_schema",
-			},
-		])
-		.returningAll()
-		.execute();
-
-	const set = await createChangeSet({
-		lix,
-		elements: [
-			{
-				change_id: changes0[0]!.id,
-				entity_id: changes0[0]!.entity_id,
-				schema_key: changes0[0]!.schema_key,
-				file_id: changes0[0]!.file_id,
-			},
-		],
-		labels: [],
-	});
-
-	await lix.db.insertInto("label").values({ name: "mocked" }).execute();
-
-	const label = await lix.db
-		.selectFrom("label")
-		.where("name", "=", "mocked")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	await lix.db
-		.insertInto("change_set_label")
-		.values({ change_set_id: set.id, label_id: label.id })
-		.execute();
-
-	const changes = await lix.db
-		.selectFrom("change")
-		.where(changeHasLabel({ name: "mocked" }))
-		.selectAll()
-		.execute();
-
-	expect(changes).toHaveLength(1);
-	expect(changes[0]?.id).toBe("change1");
-});

package/src/query-filter/change-has-label.ts

@@ -1,45 +0,0 @@
-import type { ExpressionBuilder, ExpressionWrapper, SqlBool } from "kysely";
-import type { LixDatabaseSchema } from "../database/schema.js";
-
-/**
- * Selects changes that have a label with the given name.
- *
- * @example
- *   ```ts
- *   await lix.db.selectFrom("change")
- *      .where(changeHasLabel({ name: "checkpoint" }))
- *      .selectAll()
- *      .execute();
- *   ```
- *
- * @example
- *   You can use eb.not() to negate the filter.
- *
- *   ```ts
- *   await lix.db.selectFrom("change")
- * 		.where((eb) => eb.not(changeHasLabel({ name: "checkpoint"})))
- * 		.selectAll()
- * 		.execute();
- *   ```
- */
-export function changeHasLabel(
-	// lookup can happen via both id or name
-	label: { id: string; name?: string } | { name: string; id?: string }
-) {
-	return (
-		eb: ExpressionBuilder<LixDatabaseSchema, "change">
-	): ExpressionWrapper<LixDatabaseSchema, "change", SqlBool> =>
-		eb("change.id", "in", (subquery) =>
-			subquery
-				.selectFrom("change_set_element")
-				.innerJoin(
-					"change_set_label",
-					"change_set_label.change_set_id",
-					"change_set_element.change_set_id"
-				)
-				.innerJoin("label", "label.id", "change_set_label.label_id")
-				.select("change_set_element.change_id")
-				.$if("name" in label, (eb) => eb.where("label.name", "=", label.name!))
-				.$if("id" in label, (eb) => eb.where("label.id", "=", label.id!))
-		);
-}

package/src/query-filter/change-set-has-label.test.ts

@@ -1,42 +0,0 @@
-import { test, expect } from "vitest";
-import { changeSetHasLabel } from "./change-set-has-label.js";
-import { openLix } from "../lix/open-lix.js";
-import { createChangeSet } from "../change-set/create-change-set.js";
-import { createLabel } from "../label/create-label.js";
-
-test("should only return change sets with the given label", async () => {
-	const lix = await openLix({});
-
-	// Create two change sets
-	const cs0 = await createChangeSet({
-		lix,
-		id: "cs0",
-		elements: [],
-	});
-
-	await createChangeSet({
-		lix,
-		id: "cs1",
-		elements: [],
-	});
-
-	// Insert a label
-	const label = await createLabel({ lix, name: "mocked" });
-
-	// Assign the label to one of the change sets
-	await lix.db
-		.insertInto("change_set_label")
-		.values({ change_set_id: cs0.id, label_id: label.id })
-		.execute();
-
-	// Query change sets with the label
-	const changeSets = await lix.db
-		.selectFrom("change_set")
-		.where(changeSetHasLabel({ name: "mocked" }))
-		.selectAll()
-		.execute();
-
-	// Assertions
-	expect(changeSets).toHaveLength(1);
-	expect(changeSets[0]?.id).toBe(cs0.id);
-});

package/src/query-filter/change-set-has-label.ts

@@ -1,50 +0,0 @@
-import type { ExpressionBuilder, ExpressionWrapper, SqlBool } from "kysely";
-import type { LixDatabaseSchema } from "../database/schema.js";
-
-/**
- * Selects change sets that have a label with the given name.
- *
- * @example
- *   ```ts
- *   await lix.db.selectFrom("change_set")
- *      .where(changeSetHasLabel({ name: "checkpoint" }))
- *      .selectAll()
- *      .execute();
- *   ```
- *
- * @example
- *   You can use eb.not() to negate the filter.
- *
- *   ```ts
- *   await lix.db.selectFrom("change_set")
- * 		.where((eb) => eb.not(changeSetHasLabel({ name: "checkpoint" })))
- * 		.selectAll()
- * 		.execute();
- *   ```
- *
- * @example
- *   Id lookup also works:
- *
- *   ```ts
- *   await lix.db.selectFrom("change_set")
- * 		.where(changeSetHasLabel({ id: "39j9afj2" }))
- * 		.selectAll()
- * 		.execute();
- *   ```
- */
-export function changeSetHasLabel(
-	// lookup can happen via both id or name
-	label: { id: string; name?: string } | { name: string; id?: string }
-) {
-	return (
-		eb: ExpressionBuilder<LixDatabaseSchema, "change_set">
-	): ExpressionWrapper<LixDatabaseSchema, "change_set", SqlBool> =>
-		eb("change_set.id", "in", (subquery) =>
-			subquery
-				.selectFrom("change_set_label")
-				.innerJoin("label", "label.id", "change_set_label.label_id")
-				.select("change_set_label.change_set_id")
-				.$if("name" in label, (eb) => eb.where("label.name", "=", label.name!))
-				.$if("id" in label, (eb) => eb.where("label.id", "=", label.id!))
-		);
-}

package/src/query-filter/change-set-is-ancestor-of.test.ts

@@ -1,178 +0,0 @@
-import { test, expect } from "vitest";
-import { openLix } from "../lix/open-lix.js";
-import { createChangeSet } from "../change-set/create-change-set.js";
-import { changeSetIsAncestorOf } from "./change-set-is-ancestor-of.js";
-
-test("selects all ancestors of the current change set", async () => {
-	const lix = await openLix({});
-
-	// Create a linear chain of change sets: cs0 <- cs1 <- cs2
-	const cs0 = await createChangeSet({
-		lix,
-		id: "cs0",
-		elements: [],
-	});
-	const cs1 = await createChangeSet({
-		lix,
-		id: "cs1",
-		elements: [],
-		parents: [cs0],
-	});
-	const cs2 = await createChangeSet({
-		lix,
-		id: "cs2",
-		elements: [],
-		parents: [cs1],
-	});
-
-	// Should select cs0, cs1 as ancestors of cs2
-	const results = await lix.db
-		.selectFrom("change_set")
-		.where(changeSetIsAncestorOf(cs2))
-		.select("id")
-		.execute();
-
-	expect(results.map((r) => r.id).sort()).toEqual([cs0.id, cs1.id].sort());
-});
-
-test("respects the optional depth limit", async () => {
-	const lix = await openLix({});
-
-	// cs0 <- cs1 <- cs2
-	const cs0 = await createChangeSet({
-		lix,
-		id: "cs0",
-		elements: [],
-	});
-	const cs1 = await createChangeSet({
-		lix,
-		id: "cs1",
-		elements: [],
-		parents: [cs0],
-	});
-	const cs2 = await createChangeSet({
-		lix,
-		id: "cs2",
-		elements: [],
-		parents: [cs1],
-	});
-
-	// With depth: 1, we expect cs1 only
-	const results = await lix.db
-		.selectFrom("change_set")
-		.where(changeSetIsAncestorOf(cs2, { depth: 1 }))
-		.select("id")
-		.execute();
-
-	expect(results.map((r) => r.id).sort()).toEqual([cs1.id].sort());
-});
-
-test("includeSelf true selects the current change set as well", async () => {
-	const lix = await openLix({});
-
-	// cs0 <- cs1 <- cs2
-	const cs0 = await createChangeSet({
-		lix,
-		id: "cs0",
-		elements: [],
-	});
-	const cs1 = await createChangeSet({
-		lix,
-		id: "cs1",
-		elements: [],
-		parents: [cs0],
-	});
-	const cs2 = await createChangeSet({
-		lix,
-		id: "cs2",
-		elements: [],
-		parents: [cs1],
-	});
-
-	// Should select cs0, cs1, cs2
-	const results = await lix.db
-		.selectFrom("change_set")
-		.where(changeSetIsAncestorOf(cs2, { includeSelf: true }))
-		.select("id")
-		.execute();
-
-	expect(results.map((r) => r.id).sort()).toEqual(
-		[cs0.id, cs1.id, cs2.id].sort()
-	);
-});
-
-test("can be combined with where(id = X) to check specific ancestry", async () => {
-	const lix = await openLix({});
-
-	// Create chain: cs1 <- cs2 <- cs3
-	const cs1 = await createChangeSet({
-		lix,
-		id: "cs1",
-		elements: [],
-	});
-	const cs2 = await createChangeSet({
-		lix,
-		id: "cs2",
-		elements: [],
-		parents: [cs1],
-	});
-	const cs3 = await createChangeSet({
-		lix,
-		id: "cs3",
-		elements: [],
-		parents: [cs2],
-	});
-
-	// Test: Check if cs2 is an ancestor of cs3 (should return cs2)
-	const cs2IsAncestorOfCs3 = await lix.db
-		.selectFrom("change_set")
-		.where("id", "=", cs2.id)
-		.where(changeSetIsAncestorOf(cs3))
-		.select("id")
-		.execute();
-
-	expect(cs2IsAncestorOfCs3).toHaveLength(1);
-	expect(cs2IsAncestorOfCs3[0]!.id).toBe(cs2.id);
-
-	// Test: Check if cs1 is an ancestor of cs3 (should return cs1)
-	const cs1IsAncestorOfCs3 = await lix.db
-		.selectFrom("change_set")
-		.where("id", "=", cs1.id)
-		.where(changeSetIsAncestorOf(cs3))
-		.select("id")
-		.execute();
-
-	expect(cs1IsAncestorOfCs3).toHaveLength(1);
-	expect(cs1IsAncestorOfCs3[0]!.id).toBe(cs1.id);
-
-	// Test: Check if cs3 is an ancestor of cs3 (should return empty - not inclusive by default)
-	const cs3IsAncestorOfCs3 = await lix.db
-		.selectFrom("change_set")
-		.where("id", "=", cs3.id)
-		.where(changeSetIsAncestorOf(cs3))
-		.select("id")
-		.execute();
-
-	expect(cs3IsAncestorOfCs3).toHaveLength(0);
-
-	// Test: Check if cs3 is an ancestor of cs1 (should return empty - wrong direction)
-	const cs3IsAncestorOfCs1 = await lix.db
-		.selectFrom("change_set")
-		.where("id", "=", cs3.id)
-		.where(changeSetIsAncestorOf(cs1))
-		.select("id")
-		.execute();
-
-	expect(cs3IsAncestorOfCs1).toHaveLength(0);
-
-	// Test: Check with includeSelf option
-	const cs3IsAncestorOfCs3Inclusive = await lix.db
-		.selectFrom("change_set")
-		.where("id", "=", cs3.id)
-		.where(changeSetIsAncestorOf(cs3, { includeSelf: true }))
-		.select("id")
-		.execute();
-
-	expect(cs3IsAncestorOfCs3Inclusive).toHaveLength(1);
-	expect(cs3IsAncestorOfCs3Inclusive[0]!.id).toBe(cs3.id);
-});

package/src/query-filter/change-set-is-ancestor-of.ts

@@ -1,77 +0,0 @@
-import {
-	sql,
-	type SqlBool,
-	type ExpressionBuilder,
-	type ExpressionWrapper,
-} from "kysely";
-import type { LixDatabaseSchema } from "../database/schema.js";
-import type { ChangeSet } from "../change-set/schema.js";
-
-/**
- * Filters change sets that are ancestors of the given change set.
- *
- * By default, this is **exclusive**, meaning it returns only change sets strictly
- * *before* the provided change set in the graph.
- *
- * Traverses the `change_set_edge` graph recursively, starting from the provided change set
- * (or its parents if exclusive), and returns all change sets reachable via parent edges.
- *
- * This filter is typically used to scope the graph before applying filters like `changeIsLeaf()`.
- *
- * ⚠️ This filter only defines the traversal scope — it does not filter changes directly.
- *
- * --- Options ---
- * - `includeSelf`: If `true`, includes the starting `changeSet` in the results. Defaults to `false`.
- * - `depth`: Limits the traversal depth. `depth: 1` selects only immediate parents (if exclusive)
- *   or the starting node and its immediate parents (if inclusive).
- *
- * --- Examples ---
- *
- * @example Selecting strict ancestors (default)
- * ```ts
- * db.selectFrom("change_set")
- *   .where(changeSetIsAncestorOf({ id: "cs3" }))
- *   .selectAll()
- * ```
- *
- * @example Selecting inclusive ancestors
- * ```ts
- * db.selectFrom("change_set")
- *   .where(changeSetIsAncestorOf({ id: "cs3" }, { includeSelf: true }))
- *   .selectAll()
- * ```
- *
- * @example Combining with changeSetIsDescendantOf to select change sets between two points in time
- * ```ts
- * // Select all change sets between startPoint and endPoint (inclusive)
- * db.selectFrom("change_set")
- *   .where(changeSetIsDescendantOf({ id: "startPoint" }))
- *   .where(changeSetIsAncestorOf({ id: "endPoint" }))
- *   .selectAll()
- * ```
- */
-export function changeSetIsAncestorOf(
-	changeSet: Pick<ChangeSet, "id">,
-	options?: { depth?: number; includeSelf?: boolean }
-): (
-	eb: ExpressionBuilder<LixDatabaseSchema, "change_set">
-) => ExpressionWrapper<LixDatabaseSchema, "change_set", SqlBool> {
-	const depthLimit = options?.depth;
-	const includeSelf = options?.includeSelf ?? false;
-
-	return () =>
-		sql<SqlBool>`
-			change_set.id IN (
-				WITH RECURSIVE ap(id, depth) AS (
-					SELECT id, 0 AS depth FROM change_set WHERE id = ${sql.lit(changeSet.id)}
-					UNION ALL
-					SELECT change_set_edge.parent_id, ap.depth + 1
-					FROM change_set_edge
-					JOIN ap ON change_set_edge.child_id = ap.id
-					${depthLimit !== undefined ? sql`WHERE ap.depth < ${sql.lit(depthLimit)}` : sql``}
-				)
-				-- Select based on the includeSelf flag
-				SELECT id FROM ap ${includeSelf ? sql`` : sql`WHERE depth > 0`}
-			)
-		` as any;
-}