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

package/src/change-set/apply-change-set.ts

@@ -1,14 +1,14 @@
 import type { Lix } from "../lix/index.js";
-import type { ChangeSet } from "./schema.js";
-import { sql, type Kysely } from "kysely";
-import type { LixInternalDatabaseSchema } from "../database/schema.js";
+import type { LixChangeSet } from "./schema-definition.js";
+import { updateStateCache } from "../state/cache/update-state-cache.js";
+import { clearFileDataCache } from "../filesystem/file/cache/clear-file-data-cache.js";
 
 /**
  * Applies a change set to the lix.
  */
 export async function applyChangeSet(args: {
 	lix: Lix;
-	changeSet: Pick<ChangeSet, "id">;
+	changeSet: Pick<LixChangeSet, "id">;
 }): Promise<void> {
 	const executeInTransaction = async (trx: Lix["db"]) => {
 		// Get the current version
@@ -18,95 +18,59 @@ export async function applyChangeSet(args: {
 			.selectAll("version")
 			.executeTakeFirstOrThrow();
 
-		// Update the version to point to the new change set
+		// Skip change control for this transaction
+		// This allows us to apply changes without triggering change control logic
+		// This is necessary because we are applying a change set directly
+		// and we don't want to create a new change set for this operation
+		await trx
+			.insertInto("key_value_by_version")
+			.values({
+				key: "lix_skip_file_handlers",
+				value: true,
+				lixcol_untracked: true,
+				lixcol_version_id: version.id,
+			})
+			.execute();
+
+		// Update the version to point to the new commit
 		await trx
 			.updateTable("version")
-			.set({ change_set_id: args.changeSet.id })
+			.set({ commit_id: version.commit_id })
 			.where("id", "=", version.id)
 			.execute();
 
-		// Add a parent relationship (create the edge in the change set graph)
-		if (version.change_set_id !== args.changeSet.id) {
-			// Check if edge already exists to avoid conflict
-			const existingEdge = await trx
-				.selectFrom("change_set_edge_all")
-				.where("parent_id", "=", version.change_set_id)
-				.where("child_id", "=", args.changeSet.id)
-				.where("lixcol_version_id", "=", "global")
-				.selectAll()
-				.executeTakeFirst();
-
-			if (!existingEdge) {
-				await trx
-					.insertInto("change_set_edge_all")
-					.values({
-						parent_id: version.change_set_id,
-						child_id: args.changeSet.id,
-						lixcol_version_id: "global",
-					})
-					.execute();
-			}
-		}
-
 		// Query for changes in the provided change set (direct mode only)
 		const changesResult = await trx
 			.selectFrom("change")
 			.innerJoin(
-				"change_set_element_all",
-				"change_set_element_all.change_id",
+				"change_set_element_by_version",
+				"change_set_element_by_version.change_id",
 				"change.id"
 			)
-			.where("change_set_element_all.change_set_id", "=", args.changeSet.id)
-			.where("change_set_element_all.lixcol_version_id", "=", "global")
+			.where(
+				"change_set_element_by_version.change_set_id",
+				"=",
+				args.changeSet.id
+			)
+			.where("change_set_element_by_version.lixcol_version_id", "=", "global")
 			.selectAll("change")
-			.select(sql`${version.id}`.as("version_id"))
 			.execute();
 
-		// Write-through cache: populate internal_state_cache for all applied changes
-		for (const change of changesResult) {
-			const cacheKey = {
-				entity_id: change.entity_id,
-				schema_key: change.schema_key,
-				file_id: change.file_id,
-				version_id: version.id,
-			};
-
-			if (change.snapshot_content === null) {
-				// deletion – remove from cache
-				await (trx as unknown as Kysely<LixInternalDatabaseSchema>)
-					.deleteFrom("internal_state_cache")
-					.where("entity_id", "=", cacheKey.entity_id)
-					.where("schema_key", "=", cacheKey.schema_key)
-					.where("file_id", "=", cacheKey.file_id)
-					.where("version_id", "=", version.id)
-					.execute();
-			} else {
-				// insertion/update – upsert into cache
-				await (trx as unknown as Kysely<LixInternalDatabaseSchema>)
-					.insertInto("internal_state_cache")
-					.values({
-						...cacheKey,
-						plugin_key: change.plugin_key,
-						inheritance_delete_marker: change.snapshot_content === null ? 1 : 0,
-						snapshot_content: JSON.stringify(change.snapshot_content),
-						schema_version: change.schema_version,
-						created_at: change.created_at,
-						updated_at: change.created_at,
-						change_id: change.id,
-					})
-					.onConflict((oc) =>
-						oc
-							.columns(["entity_id", "schema_key", "file_id", "version_id"])
-							.doUpdateSet({
-								plugin_key: change.plugin_key,
-								snapshot_content: sql`excluded.snapshot_content`,
-								schema_version: change.schema_version,
-								updated_at: change.created_at,
-							})
-					)
-					.execute();
-			}
-		}
+		// Write-through cache: populate lix_internal_state_cache for all applied changes
+		const changesForCache = changesResult.map((change) => ({
+			...change,
+			snapshot_content: change.snapshot_content
+				? JSON.stringify(change.snapshot_content)
+				: null,
+			metadata: change.metadata ? JSON.stringify(change.metadata) : null,
+		}));
+
+		updateStateCache({
+			engine: args.lix.engine!,
+			changes: changesForCache,
+			version_id: version.id,
+			commit_id: version.commit_id,
+		});
 
 		// Group changes by file_id for processing
 		const changesGroupedByFile = Object.groupBy(
@@ -129,7 +93,7 @@ export async function applyChangeSet(args: {
 			// Skip plugin processing for lix own file changes (file metadata changes)
 			// These are handled by the database triggers and don't need plugin processing
 			const hasLixOwnEntityChanges = changes.some(
-				(c) => c.plugin_key === "lix_own_entity"
+				(c) => c.plugin_key === "lix_sdk"
 			);
 			if (hasLixOwnEntityChanges) {
 				continue;
@@ -145,6 +109,15 @@ export async function applyChangeSet(args: {
 				continue;
 			}
 
+			// Clear file cache before fetching to ensure we get fresh data
+			// This is important because the file may have been updated by previous operations
+			// and we need the current state for plugin processing
+			clearFileDataCache({
+				engine: args.lix.engine!,
+				fileId: file_id,
+				versionId: version.id,
+			});
+
 			const file = await trx
 				.selectFrom("file")
 				.where("id", "=", file_id)
@@ -177,6 +150,13 @@ export async function applyChangeSet(args: {
 					.where("id", "=", file.id)
 					.execute();
 			}
+
+			// After processing all plugins, emit file change event
+			await trx
+				.deleteFrom("key_value_by_version")
+				.where("lixcol_version_id", "=", version.id)
+				.where("key", "=", "lix_skip_file_handlers")
+				.execute();
 		}
 	};
 

package/src/change-set/create-change-set.test.ts

@@ -10,13 +10,14 @@ test("creating a change set should succeed", async () => {
 		.insertInto("stored_schema")
 		.values({
 			value: {
-				"x-lix-key": "mock-schema",
+				"x-lix-key": "mock_schema",
 				"x-lix-version": "1.0",
 				type: "object",
 				properties: {
 					id: { type: "string" },
 				},
 				required: ["id"],
+				additionalProperties: false,
 			} satisfies LixSchemaDefinition,
 		})
 		.execute();
@@ -26,7 +27,7 @@ test("creating a change set should succeed", async () => {
 		.values([
 			{
 				id: "change0",
-				schema_key: "mock-schema",
+				schema_key: "mock_schema",
 				schema_version: "1.0",
 				entity_id: "value1",
 				file_id: "mock",
@@ -35,7 +36,7 @@ test("creating a change set should succeed", async () => {
 			},
 			{
 				id: "change1",
-				schema_key: "mock-schema",
+				schema_key: "mock_schema",
 				schema_version: "1.0",
 				entity_id: "value2",
 				file_id: "mock",
@@ -89,94 +90,6 @@ test("creating a change set with empty elements array should succeed", async ()
 	expect(changeSetMembers).toHaveLength(0);
 });
 
-test("creating a change set with labels should associate the labels with the change set", async () => {
-	const lix = await openLix({});
-
-	// Get the active version to ensure we work in the same context
-	const activeVersion = await lix.db
-		.selectFrom("active_version")
-		.select("version_id")
-		.executeTakeFirstOrThrow();
-
-	// Create a new label in the active version context
-	await lix.db
-		.insertInto("label")
-		.values({
-			name: "test-label",
-		})
-		.execute();
-
-	const testLabel = await lix.db
-		.selectFrom("label")
-		.selectAll()
-		.where("name", "=", "test-label")
-		.executeTakeFirstOrThrow();
-
-	// Create a change set with labels in the same version context
-	const changeSet = await createChangeSet({
-		lix: lix,
-		elements: [],
-		labels: [testLabel],
-		lixcol_version_id: activeVersion.version_id,
-	});
-
-	// Verify the change set was created
-	expect(changeSet.id).toBeDefined();
-
-	// Get the labels associated with the change set
-	const changeSetLabels = await lix.db
-		.selectFrom("change_set_label")
-		.innerJoin("label", "label.id", "change_set_label.label_id")
-		.selectAll()
-		.where("change_set_id", "=", changeSet.id)
-		.execute();
-
-	// Verify both labels are associated with the change set
-	expect(changeSetLabels).toHaveLength(1);
-	expect(changeSetLabels.map((label) => label.name)).toEqual(
-		expect.arrayContaining(["test-label"])
-	);
-});
-
-test("creating a change set with parents should establish parent-child relationships", async () => {
-	const lix = await openLix({});
-
-	// Create two parent change sets
-	const parentChangeSet1 = await createChangeSet({
-		lix,
-		elements: [],
-	});
-
-	const parentChangeSet2 = await createChangeSet({
-		lix,
-		elements: [],
-	});
-
-	// Create a child change set with two parents
-	const childChangeSet = await createChangeSet({
-		lix,
-		elements: [],
-		parents: [parentChangeSet1, parentChangeSet2],
-	});
-
-	// Get the parent-child relationships from the database
-	const edges = await lix.db
-		.selectFrom("change_set_edge")
-		.selectAll()
-		.where("child_id", "=", childChangeSet.id)
-		.execute();
-
-	// Verify both parent-child relationships were created
-	expect(edges).toHaveLength(2);
-	expect(edges.map((edge) => edge.parent_id)).toEqual(
-		expect.arrayContaining([parentChangeSet1.id, parentChangeSet2.id])
-	);
-	expect(edges.map((edge) => edge.child_id)).toEqual([
-		childChangeSet.id,
-		childChangeSet.id,
-	]);
-});
-
 test("creating a change set with version_id should store it in the specified version", async () => {
 	const lix = await openLix({});
 
@@ -196,7 +109,7 @@ test("creating a change set with version_id should store it in the specified ver
 
 	// Also verify by querying the database directly
 	const storedChangeSet = await lix.db
-		.selectFrom("change_set_all")
+		.selectFrom("change_set_by_version")
 		.selectAll()
 		.where("id", "=", changeSet.id)
 		.where("lixcol_version_id", "=", globalVersion)

package/src/change-set/create-change-set.ts

@@ -1,11 +1,10 @@
-import { nanoid } from "../database/nano-id.js";
+import { nanoId } from "../engine/functions/nano-id.js";
 import type { Lix } from "../lix/open-lix.js";
-import type { ChangeSet, ChangeSetElement } from "./schema.js";
-import type { Label } from "../label/schema.js";
-import type { NewState } from "../entity-views/types.js";
+import type { LixChangeSet, LixChangeSetElement } from "./schema-definition.js";
+import type { NewState } from "../engine/entity-views/types.js";
 
 /**
- * Creates a change set and optionally attaches elements, labels and parents.
+ * Creates a change set and optionally attaches elements and labels.
  *
  * Change sets are the building blocks of versions and checkpoints. This
  * function inserts all provided relations in a single transaction and
@@ -18,22 +17,19 @@ import type { NewState } from "../entity-views/types.js";
  */
 
 export async function createChangeSet(args: {
-	lix: Pick<Lix, "db">;
+	lix: Lix;
 	id?: string;
-	elements?: Omit<NewState<ChangeSetElement>, "change_set_id">[];
-	labels?: Pick<Label, "id">[];
-	/** Parent change sets that this change set will be a child of */
-	parents?: Pick<ChangeSet, "id">[];
+	elements?: Omit<NewState<LixChangeSetElement>, "change_set_id">[];
 	/** Version ID where the change set should be stored. Defaults to active version */
 	lixcol_version_id?: string;
-}): Promise<ChangeSet & { lixcol_version_id: string }> {
+}): Promise<LixChangeSet & { lixcol_version_id: string }> {
 	const executeInTransaction = async (trx: Lix["db"]) => {
-		const csId = args.id ?? nanoid();
+		const csId = args.id ?? (await nanoId({ lix: { ...args.lix, db: trx } }));
 
 		// Use _all view if version_id is specified, otherwise use regular view
 		if (args.lixcol_version_id) {
 			await trx
-				.insertInto("change_set_all")
+				.insertInto("change_set_by_version")
 				.values({
 					id: csId,
 					lixcol_version_id: args.lixcol_version_id,
@@ -52,7 +48,7 @@ export async function createChangeSet(args: {
 			// Insert elements linking change set to changes
 			if (args.lixcol_version_id) {
 				await trx
-					.insertInto("change_set_element_all")
+					.insertInto("change_set_element_by_version")
 					.values(
 						args.elements.map((element) => ({
 							change_set_id: csId,
@@ -74,56 +70,8 @@ export async function createChangeSet(args: {
 			}
 		}
 
-		// Add labels if provided
-		if (args.labels && args.labels.length > 0) {
-			if (args.lixcol_version_id) {
-				await trx
-					.insertInto("change_set_label_all")
-					.values(
-						args.labels.map((label) => ({
-							lixcol_version_id: args.lixcol_version_id,
-							label_id: label.id,
-							change_set_id: csId,
-						}))
-					)
-					.execute();
-			} else {
-				await trx
-					.insertInto("change_set_label")
-					.values(
-						args.labels.map((label) => ({
-							label_id: label.id,
-							change_set_id: csId,
-						}))
-					)
-					.execute();
-			}
-		}
-
-		// Add parent-child relationships if parents are provided
-		for (const parent of args.parents ?? []) {
-			if (args.lixcol_version_id) {
-				await trx
-					.insertInto("change_set_edge_all")
-					.values({
-						parent_id: parent.id,
-						child_id: csId,
-						lixcol_version_id: args.lixcol_version_id,
-					})
-					.execute();
-			} else {
-				await trx
-					.insertInto("change_set_edge")
-					.values({
-						parent_id: parent.id,
-						child_id: csId,
-					})
-					.execute();
-			}
-		}
-
 		const changeSet = await trx
-			.selectFrom("change_set_all")
+			.selectFrom("change_set_by_version")
 			.selectAll()
 			.where("id", "=", csId)
 			.where(

package/src/change-set/index.ts

@@ -1,18 +1,8 @@
 export {
 	LixChangeSetSchema,
 	LixChangeSetElementSchema,
-	LixChangeSetEdgeSchema,
-	LixChangeSetLabelSchema,
-	LixChangeSetThreadSchema,
-	type ChangeSet,
-	type ChangeSetElement,
-	type ChangeSetEdge,
-	type ChangeSetLabel,
-	type ChangeSetThread,
-} from "./schema.js";
+	type LixChangeSet,
+	type LixChangeSetElement,
+} from "./schema-definition.js";
 export { createChangeSet } from "./create-change-set.js";
 export { applyChangeSet } from "./apply-change-set.js";
-export { createMergeChangeSet } from "./create-merge-change-set.js";
-export { createUndoChangeSet } from "./create-undo-change-set.js";
-export { createCheckpoint } from "./create-checkpoint.js";
-export { createTransitionChangeSet } from "./create-transition-change-set.js";

package/src/change-set/schema-definition.ts

@@ -0,0 +1,83 @@
+import type {
+	FromLixSchemaDefinition,
+	LixSchemaDefinition,
+} from "../schema-definition/definition.js";
+
+export type LixChangeSet = FromLixSchemaDefinition<typeof LixChangeSetSchema>;
+
+export const LixChangeSetSchema = {
+	"x-lix-key": "lix_change_set",
+	"x-lix-version": "1.0",
+	"x-lix-primary-key": ["/id"],
+	"x-lix-override-lixcols": {
+		lixcol_file_id: '"lix"',
+		lixcol_plugin_key: '"lix_sdk"',
+		lixcol_version_id: '"global"',
+	},
+	type: "object",
+	properties: {
+		id: {
+			type: "string",
+			"x-lix-default": "lix_uuid_v7()",
+		},
+	},
+	required: ["id"],
+	additionalProperties: false,
+} as const;
+LixChangeSetSchema satisfies LixSchemaDefinition;
+
+export type LixChangeSetElement = FromLixSchemaDefinition<
+	typeof LixChangeSetElementSchema
+>;
+
+export const LixChangeSetElementSchema = {
+	"x-lix-key": "lix_change_set_element",
+	"x-lix-version": "1.0",
+	"x-lix-foreign-keys": [
+		{
+			properties: ["/change_set_id"],
+			references: {
+				schemaKey: "lix_change_set",
+				properties: ["/id"],
+			},
+		},
+		{
+			properties: ["/change_id"],
+			references: {
+				schemaKey: "lix_change",
+				properties: ["/id"],
+			},
+		},
+		{
+			properties: ["/schema_key"],
+			references: {
+				schemaKey: "lix_stored_schema",
+				properties: ["/value/x-lix-key"],
+			},
+		},
+	],
+	"x-lix-primary-key": ["/change_set_id", "/change_id"],
+	"x-lix-unique": [["/change_set_id", "/entity_id", "/schema_key", "/file_id"]],
+	"x-lix-override-lixcols": {
+		lixcol_file_id: '"lix"',
+		lixcol_plugin_key: '"lix_sdk"',
+		lixcol_version_id: '"global"',
+	},
+	type: "object",
+	properties: {
+		change_set_id: { type: "string" },
+		change_id: { type: "string" },
+		entity_id: { type: "string" },
+		schema_key: { type: "string" },
+		file_id: { type: "string" },
+	},
+	required: [
+		"change_set_id",
+		"change_id",
+		"entity_id",
+		"schema_key",
+		"file_id",
+	],
+	additionalProperties: false,
+} as const;
+LixChangeSetElementSchema satisfies LixSchemaDefinition;