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

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-element-in-ancestry-of.test.ts

@@ -1,354 +0,0 @@
-import { test, expect } from "vitest";
-import { openLix } from "../lix/open-lix.js";
-import { createChangeSet } from "../change-set/create-change-set.js";
-import { changeSetElementInAncestryOf } from "./change-set-element-in-ancestry-of.js";
-
-test("returns all elements from a single change set and its ancestors", async () => {
-	const lix = await openLix({});
-
-	// Insert required schema entry
-	await lix.db
-		.insertInto("stored_schema")
-		.values({
-			key: "mock",
-			version: "1",
-			value: {
-				"x-lix-key": "mock",
-				"x-lix-version": "1",
-				additionalProperties: false,
-				properties: {},
-				type: "object",
-			},
-		})
-		.execute();
-
-	// Insert mock change (reused across sets)
-	const changes = await lix.db
-		.insertInto("change")
-		.values({
-			id: "c0",
-			entity_id: "e1",
-			file_id: "f1",
-			plugin_key: "mock",
-			schema_version: "1",
-			schema_key: "mock",
-			snapshot_content: { hello: "world" },
-		})
-		.returningAll()
-		.execute();
-
-	// cs0 <- cs1 <- cs2
-	const cs0 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-	});
-	const cs1 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs0],
-	});
-	const cs2 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs1],
-	});
-
-	const elements = await lix.db
-		.selectFrom("change_set_element")
-		.where(changeSetElementInAncestryOf(cs2))
-		.select("change_set_id")
-		.execute();
-
-	expect(elements.map((e) => e.change_set_id).sort()).toEqual(
-		[cs0.id, cs1.id, cs2.id].sort()
-	);
-});
-
-test("respects depth limit when provided for a single target", async () => {
-	const lix = await openLix({});
-
-	// Insert required schema entry
-	await lix.db
-		.insertInto("stored_schema")
-		.values({
-			key: "mock",
-			version: "1",
-			value: {
-				"x-lix-key": "mock",
-				"x-lix-version": "1",
-				additionalProperties: false,
-				properties: {},
-				type: "object",
-			},
-		})
-		.execute();
-
-	const changes = await lix.db
-		.insertInto("change")
-		.values({
-			id: "c1",
-			entity_id: "e1",
-			file_id: "f1",
-			schema_version: "1",
-			plugin_key: "mock",
-			schema_key: "mock",
-			snapshot_content: { val: "hi" },
-		})
-		.returningAll()
-		.execute();
-
-	// cs0 <- cs1 <- cs2
-	const cs0 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-	});
-	const cs1 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs0],
-	});
-	const cs2 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs1],
-	});
-
-	const elements = await lix.db
-		.selectFrom("change_set_element")
-		.where(changeSetElementInAncestryOf(cs2, { depth: 1 }))
-		.select("change_set_id")
-		.execute();
-
-	expect(elements.map((e) => e.change_set_id).sort()).toEqual(
-		[cs1.id, cs2.id].sort()
-	);
-});
-
-test("returns combined elements from multiple divergent change set ancestries", async () => {
-	const lix = await openLix({});
-
-	// Insert required schema entry
-	await lix.db
-		.insertInto("stored_schema")
-		.values({
-			key: "mock",
-			version: "1",
-			value: {
-				"x-lix-key": "mock",
-				"x-lix-version": "1",
-				additionalProperties: false,
-				properties: {},
-				type: "object",
-			},
-		})
-		.execute();
-
-	// Shared change
-	const changes = await lix.db
-		.insertInto("change")
-		.values({
-			id: "c1",
-			entity_id: "e1",
-			file_id: "f1",
-			schema_version: "1",
-			plugin_key: "mock",
-			schema_key: "mock",
-			snapshot_content: { val: "shared" },
-		})
-		.returningAll()
-		.execute();
-
-	// cs0 <- cs1 <- cs2
-	//    \
-	//     <- cs3 <- cs4
-	const cs0 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-	});
-	const cs1 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs0],
-	});
-	const cs2 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs1],
-	}); // Branch 1 leaf
-	const cs3 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs0],
-	});
-	const cs4 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs3],
-	}); // Branch 2 leaf
-
-	const elements = await lix.db
-		.selectFrom("change_set_element")
-		.where(changeSetElementInAncestryOf([cs2, cs4])) // Target both leaves
-		.select("change_set_id")
-		.distinct()
-		.execute();
-
-	// Expect all change sets from both branches, including common ancestor cs0
-	expect(elements.map((e) => e.change_set_id).sort()).toEqual(
-		[cs0.id, cs1.id, cs2.id, cs3.id, cs4.id].sort()
-	);
-});
-
-test("respects depth limit with multiple divergent targets", async () => {
-	const lix = await openLix({});
-
-	// Insert required schema entry
-	await lix.db
-		.insertInto("stored_schema")
-		.values({
-			key: "mock",
-			version: "1",
-			value: {
-				"x-lix-key": "mock",
-				"x-lix-version": "1",
-				additionalProperties: false,
-				properties: {},
-				type: "object",
-			},
-		})
-		.execute();
-
-	const changes = await lix.db
-		.insertInto("change")
-		.values({
-			id: "c1",
-			entity_id: "e1",
-			file_id: "f1",
-			schema_version: "1",
-			plugin_key: "mock",
-			schema_key: "mock",
-			snapshot_content: { val: "shared" },
-		})
-		.returningAll()
-		.execute();
-
-	// cs0 <- cs1 <- cs2
-	//    \
-	//     <- cs3 <- cs4
-	const cs0 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-	});
-	const cs1 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs0],
-	});
-	const cs2 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs1],
-	}); // Branch 1 leaf
-	const cs3 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs0],
-	});
-	const cs4 = await createChangeSet({
-		lix,
-		elements: [changes[0]!].map((change) => ({
-			change_id: change.id,
-			entity_id: change.entity_id,
-			schema_key: change.schema_key,
-			file_id: change.file_id,
-		})),
-		parents: [cs3],
-	}); // Branch 2 leaf
-
-	const elements = await lix.db
-		.selectFrom("change_set_element")
-		.where(changeSetElementInAncestryOf([cs2, cs4], { depth: 1 })) // Depth 1 from targets
-		.select("change_set_id")
-		.distinct()
-		.execute();
-
-	// Expect targets and their direct parents (cs1, cs3)
-	expect(elements.map((e) => e.change_set_id).sort()).toEqual(
-		[cs1.id, cs2.id, cs3.id, cs4.id].sort()
-	);
-});

package/src/query-filter/change-set-element-in-ancestry-of.ts

@@ -1,64 +0,0 @@
-import type { ChangeSet } from "../change-set/schema.js";
-import {
-	sql,
-	type ExpressionBuilder,
-	type ExpressionWrapper,
-	type SqlBool,
-} from "kysely";
-import type { LixDatabaseSchema } from "../database/schema.js";
-
-/**
- * Filters elements that are in the ancestry of the given change set(s).
- *
- * @param target - A target change set object (or its id), or an array of such objects/ids.
- * @param options - Optional options object (e.g., depth limit)
- * @returns A Kysely ExpressionBuilder function for filtering.
- *
- * @example
- * // Elements from the history of cs2 (object)
- * db.selectFrom("change_set_element")
- *   .where(changeSetElementInAncestryOf(cs2))
- *   .selectAll()
- *
- * // Elements from the history of cs2 (id)
- * db.selectFrom("change_set_element")
- *   .where(changeSetElementInAncestryOf(cs2.id))
- *   .selectAll()
- *
- * // Elements from the combined history of cs2 and cs4 (divergent branches)
- * db.selectFrom("change_set_element")
- *   .where(changeSetElementInAncestryOf([cs2, cs4]))
- *   .selectAll()
- */
-export function changeSetElementInAncestryOf(
-	target: Pick<ChangeSet, "id"> | Array<Pick<ChangeSet, "id">>,
-	options?: { depth?: number }
-): (
-	eb: ExpressionBuilder<LixDatabaseSchema, "change_set_element">
-) => ExpressionWrapper<LixDatabaseSchema, "change_set_element", SqlBool> {
-	const depthLimit = options?.depth;
-	const targetsArray = Array.isArray(target) ? target : [target];
-	if (targetsArray.length === 0) {
-		throw new Error(
-			"changeSetElementInAncestryOf requires at least one target change set."
-		);
-	}
-	const targetIds = targetsArray.map((cs) =>
-		typeof cs === "object" && cs !== null ? cs.id : cs
-	);
-
-	return () =>
-		sql<SqlBool>`
-      change_set_element.change_set_id IN (
-        WITH RECURSIVE ancestors(id, depth) AS (
-          SELECT id, 0 AS depth FROM change_set WHERE id IN (${sql.join(targetIds.map((id) => sql.lit(id)))})
-          UNION ALL
-          SELECT change_set_edge.parent_id, ancestors.depth + 1
-          FROM change_set_edge
-          JOIN ancestors ON change_set_edge.child_id = ancestors.id
-          ${depthLimit !== undefined ? sql`WHERE ancestors.depth < ${sql.lit(depthLimit)}` : sql``}
-        )
-        SELECT id FROM ancestors
-      )
-    ` as any;
-}