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

package/src/entity/label/schema.test.ts

@@ -1,9 +1,18 @@
 import { expect, test } from "vitest";
 import { openLix } from "../../lix/open-lix.js";
 import { createLabel } from "../../label/create-label.js";
+import type { LixSchemaDefinition } from "../../schema-definition/definition.js";
 
 test("entity_label mapping requires entity to exist in state", async () => {
-	const lix = await openLix({});
+	const lix = await openLix({
+		keyValues: [
+			{
+				key: "lix_deterministic_mode",
+				value: { enabled: true },
+				lixcol_version_id: "global",
+			},
+		],
+	});
 
 	// First create a label
 	const needsTranslationLabel = await createLabel({
@@ -11,12 +20,31 @@ test("entity_label mapping requires entity to exist in state", async () => {
 		name: "needs translation",
 	});
 
+	const bundleSchema: LixSchemaDefinition = {
+		"x-lix-key": "test_inlang_bundle",
+		"x-lix-version": "1.0",
+		"x-lix-primary-key": ["/id"],
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			id: { type: "string" },
+			key: { type: "string" },
+			messages: { type: "object" },
+		},
+		required: ["id", "key", "messages"],
+	};
+
+	await lix.db
+		.insertInto("stored_schema")
+		.values({ value: bundleSchema })
+		.execute();
+
 	// Create an entity in state (simulate a bundle entity)
 	await lix.db
 		.insertInto("state")
 		.values({
 			entity_id: "bundle123",
-			schema_key: "inlang_bundle",
+			schema_key: "test_inlang_bundle",
 			file_id: "messages.json",
 			schema_version: "1.0",
 			plugin_key: "test_plugin",
@@ -33,7 +61,7 @@ test("entity_label mapping requires entity to exist in state", async () => {
 		.insertInto("entity_label")
 		.values({
 			entity_id: "bundle123",
-			schema_key: "inlang_bundle",
+			schema_key: "test_inlang_bundle",
 			file_id: "messages.json",
 			label_id: needsTranslationLabel.id,
 		})
@@ -48,7 +76,7 @@ test("entity_label mapping requires entity to exist in state", async () => {
 
 	expect(mapping).toMatchObject({
 		entity_id: "bundle123",
-		schema_key: "inlang_bundle",
+		schema_key: "test_inlang_bundle",
 		file_id: "messages.json",
 		label_id: needsTranslationLabel.id,
 	});
@@ -63,12 +91,31 @@ test("entity can have multiple labels", async () => {
 		createLabel({ lix, name: "backend" }),
 	]);
 
+	const projectTaskSchema: LixSchemaDefinition = {
+		"x-lix-key": "test_project_task",
+		"x-lix-version": "1.0",
+		"x-lix-primary-key": ["/id"],
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			id: { type: "string" },
+			title: { type: "string" },
+			status: { type: "string" },
+		},
+		required: ["id", "title", "status"],
+	};
+
+	await lix.db
+		.insertInto("stored_schema")
+		.values({ value: projectTaskSchema })
+		.execute();
+
 	// Create an entity in state
 	await lix.db
 		.insertInto("state")
 		.values({
 			entity_id: "task456",
-			schema_key: "project_task",
+			schema_key: "test_project_task",
 			file_id: "tasks.json",
 			plugin_key: "test_plugin",
 			schema_version: "1.0",
@@ -86,7 +133,7 @@ test("entity can have multiple labels", async () => {
 			.insertInto("entity_label")
 			.values({
 				entity_id: "task456",
-				schema_key: "project_task",
+				schema_key: "test_project_task",
 				file_id: "tasks.json",
 				label_id: label.id,
 			})
@@ -114,23 +161,72 @@ test("same label can be applied to multiple entities", async () => {
 
 	const urgentLabel = await createLabel({ lix, name: "urgent" });
 
+	const multiSchemas: LixSchemaDefinition[] = [
+		{
+			"x-lix-key": "test_bug_report",
+			"x-lix-version": "1.0",
+			"x-lix-primary-key": ["/id"],
+			type: "object",
+			additionalProperties: false,
+			properties: {
+				id: { type: "string" },
+				title: { type: "string" },
+				severity: { type: "string" },
+			},
+			required: ["id", "title"],
+		},
+		{
+			"x-lix-key": "test_feature_request",
+			"x-lix-version": "1.0",
+			"x-lix-primary-key": ["/id"],
+			type: "object",
+			additionalProperties: false,
+			properties: {
+				id: { type: "string" },
+				title: { type: "string" },
+				priority: { type: "string" },
+			},
+			required: ["id", "title"],
+		},
+		{
+			"x-lix-key": "test_task",
+			"x-lix-version": "1.0",
+			"x-lix-primary-key": ["/id"],
+			type: "object",
+			additionalProperties: false,
+			properties: {
+				id: { type: "string" },
+				title: { type: "string" },
+				assigned: { type: "string" },
+			},
+			required: ["id", "title"],
+		},
+	];
+
+	for (const schema of multiSchemas) {
+		await lix.db
+			.insertInto("stored_schema")
+			.values({ value: schema })
+			.execute();
+	}
+
 	// Create multiple entities in state
 	const entities = [
 		{
 			entity_id: "bug1",
-			schema_key: "bug_report",
+			schema_key: "test_bug_report",
 			file_id: "bugs.json",
 			content: { id: "bug1", title: "Login fails", severity: "high" },
 		},
 		{
 			entity_id: "feature1",
-			schema_key: "feature_request",
+			schema_key: "test_feature_request",
 			file_id: "features.json",
 			content: { id: "feature1", title: "Dark mode", priority: "high" },
 		},
 		{
 			entity_id: "task1",
-			schema_key: "task",
+			schema_key: "test_task",
 			file_id: "tasks.json",
 			content: { id: "task1", title: "Update docs", assigned: "john" },
 		},
@@ -184,6 +280,24 @@ test("entity_label respects composite primary key constraint", async () => {
 
 	const label = await createLabel({ lix, name: "duplicate-test" });
 
+	const testEntitySchema: LixSchemaDefinition = {
+		"x-lix-key": "test_entity",
+		"x-lix-version": "1.0",
+		"x-lix-primary-key": ["/id"],
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			id: { type: "string" },
+			data: { type: "string" },
+		},
+		required: ["id"],
+	};
+
+	await lix.db
+		.insertInto("stored_schema")
+		.values({ value: testEntitySchema })
+		.execute();
+
 	// Create entity in state
 	await lix.db
 		.insertInto("state")
@@ -227,13 +341,59 @@ test("different entities with same ID but different schema_key or file_id can ha
 
 	const label = await createLabel({ lix, name: "shared" });
 
+	const typeSchemas: LixSchemaDefinition[] = [
+		{
+			"x-lix-key": "test_type_a",
+			"x-lix-version": "1.0",
+			"x-lix-primary-key": ["/id"],
+			type: "object",
+			additionalProperties: false,
+			properties: {
+				id: { type: "string" },
+				type: { type: "string" },
+			},
+			required: ["id"],
+		},
+		{
+			"x-lix-key": "test_type_b",
+			"x-lix-version": "1.0",
+			"x-lix-primary-key": ["/id"],
+			type: "object",
+			additionalProperties: false,
+			properties: {
+				id: { type: "string" },
+				type: { type: "string" },
+			},
+			required: ["id"],
+		},
+		{
+			"x-lix-key": "test_type_c",
+			"x-lix-version": "1.0",
+			"x-lix-primary-key": ["/id", "/file"],
+			type: "object",
+			additionalProperties: false,
+			properties: {
+				id: { type: "string" },
+				file: { type: "number" },
+			},
+			required: ["id", "file"],
+		},
+	];
+
+	for (const schema of typeSchemas) {
+		await lix.db
+			.insertInto("stored_schema")
+			.values({ value: schema })
+			.execute();
+	}
+
 	// Create entities in state with same ID but different schema_key
 	await lix.db
 		.insertInto("state")
 		.values([
 			{
 				entity_id: "shared123",
-				schema_key: "type_a",
+				schema_key: "test_type_a",
 				file_id: "file.json",
 				plugin_key: "test_plugin",
 				schema_version: "1.0",
@@ -241,7 +401,7 @@ test("different entities with same ID but different schema_key or file_id can ha
 			},
 			{
 				entity_id: "shared123",
-				schema_key: "type_b",
+				schema_key: "test_type_b",
 				file_id: "file.json",
 				plugin_key: "test_plugin",
 				schema_version: "1.0",
@@ -256,7 +416,7 @@ test("different entities with same ID but different schema_key or file_id can ha
 		.values([
 			{
 				entity_id: "shared456",
-				schema_key: "type_c",
+				schema_key: "test_type_c",
 				file_id: "file1.json",
 				plugin_key: "test_plugin",
 				schema_version: "1.0",
@@ -264,7 +424,7 @@ test("different entities with same ID but different schema_key or file_id can ha
 			},
 			{
 				entity_id: "shared456",
-				schema_key: "type_c",
+				schema_key: "test_type_c",
 				file_id: "file2.json",
 				plugin_key: "test_plugin",
 				schema_version: "1.0",
@@ -279,25 +439,25 @@ test("different entities with same ID but different schema_key or file_id can ha
 		.values([
 			{
 				entity_id: "shared123",
-				schema_key: "type_a",
+				schema_key: "test_type_a",
 				file_id: "file.json",
 				label_id: label.id,
 			},
 			{
 				entity_id: "shared123",
-				schema_key: "type_b",
+				schema_key: "test_type_b",
 				file_id: "file.json",
 				label_id: label.id,
 			},
 			{
 				entity_id: "shared456",
-				schema_key: "type_c",
+				schema_key: "test_type_c",
 				file_id: "file1.json",
 				label_id: label.id,
 			},
 			{
 				entity_id: "shared456",
-				schema_key: "type_c",
+				schema_key: "test_type_c",
 				file_id: "file2.json",
 				label_id: label.id,
 			},
@@ -318,6 +478,24 @@ test("removing entity_label mapping", async () => {
 
 	const label = await createLabel({ lix, name: "removable" });
 
+	const removableSchema: LixSchemaDefinition = {
+		"x-lix-key": "test_entity",
+		"x-lix-version": "1.0",
+		"x-lix-primary-key": ["/id"],
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			id: { type: "string" },
+			removable: { type: "boolean" },
+		},
+		required: ["id"],
+	};
+
+	await lix.db
+		.insertInto("stored_schema")
+		.values({ value: removableSchema })
+		.execute();
+
 	// Create entity in state
 	await lix.db
 		.insertInto("state")
@@ -377,6 +555,24 @@ test("querying entities by label with proper state", async () => {
 	const todoLabel = await createLabel({ lix, name: "todo" });
 	const doneLabel = await createLabel({ lix, name: "done" });
 
+	const taskSchema: LixSchemaDefinition = {
+		"x-lix-key": "test_task",
+		"x-lix-version": "1.0",
+		"x-lix-primary-key": ["/id"],
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			id: { type: "string" },
+			status: { type: "string" },
+		},
+		required: ["id", "status"],
+	};
+
+	await lix.db
+		.insertInto("stored_schema")
+		.values({ value: taskSchema })
+		.execute();
+
 	// Create task entities in state
 	const tasks = [
 		{ id: "task1", status: "pending" },
@@ -391,7 +587,7 @@ test("querying entities by label with proper state", async () => {
 			.insertInto("state")
 			.values({
 				entity_id: task.id,
-				schema_key: "task",
+				schema_key: "test_task",
 				file_id: "tasks.json",
 				plugin_key: "test_plugin",
 				schema_version: "1.0",
@@ -406,7 +602,7 @@ test("querying entities by label with proper state", async () => {
 			.insertInto("entity_label")
 			.values({
 				entity_id: `task${i}`,
-				schema_key: "task",
+				schema_key: "test_task",
 				file_id: "tasks.json",
 				label_id: todoLabel.id,
 			})
@@ -419,7 +615,7 @@ test("querying entities by label with proper state", async () => {
 			.insertInto("entity_label")
 			.values({
 				entity_id: `task${i}`,
-				schema_key: "task",
+				schema_key: "test_task",
 				file_id: "tasks.json",
 				label_id: doneLabel.id,
 			})
@@ -431,7 +627,7 @@ test("querying entities by label with proper state", async () => {
 		.selectFrom("entity_label")
 		.innerJoin("label", "label.id", "entity_label.label_id")
 		.where("label.name", "=", "todo")
-		.where("entity_label.schema_key", "=", "task")
+		.where("entity_label.schema_key", "=", "test_task")
 		.select(["entity_label.entity_id"])
 		.execute();
 
@@ -447,7 +643,7 @@ test("querying entities by label with proper state", async () => {
 		.selectFrom("entity_label")
 		.innerJoin("label", "label.id", "entity_label.label_id")
 		.where("label.name", "=", "done")
-		.where("entity_label.schema_key", "=", "task")
+		.where("entity_label.schema_key", "=", "test_task")
 		.select(["entity_label.entity_id"])
 		.execute();
 
@@ -459,7 +655,11 @@ test("entity_label works with change_set entities", async () => {
 	const lix = await openLix({});
 
 	// Create a label for change sets
-	const reviewedLabel = await createLabel({ lix, name: "reviewed" });
+	const reviewedLabel = await createLabel({
+		lix,
+		name: "reviewed",
+		lixcol_version_id: "global",
+	});
 
 	// Create a change set (which automatically creates state entry)
 	await lix.db
@@ -477,12 +677,13 @@ test("entity_label works with change_set entities", async () => {
 
 	// Label the change set
 	await lix.db
-		.insertInto("entity_label")
+		.insertInto("entity_label_by_version")
 		.values({
 			entity_id: changeSet.id,
 			schema_key: "lix_change_set",
 			file_id: "lix",
 			label_id: reviewedLabel.id,
+			lixcol_version_id: "global",
 		})
 		.execute();
 
@@ -507,6 +708,24 @@ test("query entities with specific label combinations", async () => {
 	const criticalLabel = await createLabel({ lix, name: "critical" });
 	const resolvedLabel = await createLabel({ lix, name: "resolved" });
 
+	const issueSchema: LixSchemaDefinition = {
+		"x-lix-key": "test_issue",
+		"x-lix-version": "1.0",
+		"x-lix-primary-key": ["/id"],
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			id: { type: "string" },
+			title: { type: "string" },
+		},
+		required: ["id", "title"],
+	};
+
+	await lix.db
+		.insertInto("stored_schema")
+		.values({ value: issueSchema })
+		.execute();
+
 	// Create issues in state
 	const issues = [
 		{ id: "issue1", title: "Critical bug", labels: [bugLabel, criticalLabel] },
@@ -521,7 +740,7 @@ test("query entities with specific label combinations", async () => {
 			.insertInto("state")
 			.values({
 				entity_id: issue.id,
-				schema_key: "issue",
+				schema_key: "test_issue",
 				file_id: "issues.json",
 				plugin_key: "test_plugin",
 				schema_version: "1.0",
@@ -535,7 +754,7 @@ test("query entities with specific label combinations", async () => {
 				.insertInto("entity_label")
 				.values({
 					entity_id: issue.id,
-					schema_key: "issue",
+					schema_key: "test_issue",
 					file_id: "issues.json",
 					label_id: label.id,
 				})
@@ -554,7 +773,7 @@ test("query entities with specific label combinations", async () => {
 		)
 		.where("el1.label_id", "=", bugLabel.id)
 		.where("el2.label_id", "=", criticalLabel.id)
-		.where("el1.schema_key", "=", "issue")
+		.where("el1.schema_key", "=", "test_issue")
 		.select(["el1.entity_id"])
 		.distinct()
 		.execute();
@@ -583,13 +802,30 @@ test("entity_label foreign key constraint prevents referencing non-existent stat
 			})
 			.execute()
 	).rejects.toThrow(
-		/Foreign key constraint violation.*lix_entity_label.*\(entity_id, schema_key, file_id\).*state\.\(entity_id, schema_key, file_id\)/
+		/Foreign key constraint violation.*lix_entity_label.*\(\/entity_id, \/schema_key, \/file_id\).*state\.\(\/entity_id, \/schema_key, \/file_id\)/
 	);
 });
 
 test("entity_label foreign key constraint prevents referencing non-existent labels", async () => {
 	const lix = await openLix({});
 
+	// Ensure schema is registered for validation
+	await lix.db
+		.insertInto("stored_schema")
+		.values({
+			value: {
+				"x-lix-key": "test_schema",
+				"x-lix-version": "1.0",
+				type: "object",
+				additionalProperties: false,
+				properties: {
+					id: { type: "string" },
+				},
+				required: ["id"],
+			},
+		})
+		.execute();
+
 	// Create an entity in state
 	await lix.db
 		.insertInto("state")
@@ -616,7 +852,7 @@ test("entity_label foreign key constraint prevents referencing non-existent labe
 			})
 			.execute()
 	).rejects.toThrow(
-		/Foreign key constraint violation.*lix_entity_label.*\(label_id\).*lix_label\.\(id\)/
+		/Foreign key constraint violation.*lix_entity_label.*\(\/label_id\).*lix_label\.\(\/id\)/
 	);
 });
 
@@ -625,12 +861,29 @@ test("entity_label composite foreign key correctly validates all three state col
 
 	const label = await createLabel({ lix, name: "test-label" });
 
+	const schemaOne: LixSchemaDefinition = {
+		"x-lix-key": "test_schema1",
+		"x-lix-version": "1.0",
+		"x-lix-primary-key": ["/id"],
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			id: { type: "string" },
+		},
+		required: ["id"],
+	};
+
+	await lix.db
+		.insertInto("stored_schema")
+		.values({ value: schemaOne })
+		.execute();
+
 	// Create an entity in state
 	await lix.db
 		.insertInto("state")
 		.values({
 			entity_id: "entity1",
-			schema_key: "schema1",
+			schema_key: "test_schema1",
 			file_id: "file1.json",
 			plugin_key: "test_plugin",
 			schema_version: "1.0",
@@ -644,7 +897,7 @@ test("entity_label composite foreign key correctly validates all three state col
 			.insertInto("entity_label")
 			.values({
 				entity_id: "wrong_entity",
-				schema_key: "schema1",
+				schema_key: "test_schema1",
 				file_id: "file1.json",
 				label_id: label.id,
 			})
@@ -670,7 +923,7 @@ test("entity_label composite foreign key correctly validates all three state col
 			.insertInto("entity_label")
 			.values({
 				entity_id: "entity1",
-				schema_key: "schema1",
+				schema_key: "test_schema1",
 				file_id: "wrong_file.json",
 				label_id: label.id,
 			})
@@ -683,7 +936,7 @@ test("entity_label composite foreign key correctly validates all three state col
 			.insertInto("entity_label")
 			.values({
 				entity_id: "entity1",
-				schema_key: "schema1",
+				schema_key: "test_schema1",
 				file_id: "file1.json",
 				label_id: label.id,
 			})

package/src/entity/types.ts

@@ -0,0 +1,13 @@
+// Entity type with canonical column names (used in regular tables like state, entity_label)
+export type LixEntityCanonical = {
+	schema_key: string;
+	file_id: string;
+	entity_id: string;
+};
+
+// Entity type with lixcol_ prefixed columns (used in entity views)
+export type LixEntity = {
+	lixcol_schema_key: string;
+	lixcol_file_id: string;
+	lixcol_entity_id: string;
+};