@lix-js/sdk 0.0.1 → 0.2.0

package/src/database/schema.ts

@@ -17,7 +17,7 @@ export type LixDatabaseSchema = {
 
 	// file
 	file: LixFileTable;
-	change_queue: ChangeQueueTable;
+	file_queue: FileQueueTable;
 
 	// change
 	change: ChangeTable;
@@ -28,7 +28,6 @@ export type LixDatabaseSchema = {
 	change_set: ChangeSetTable;
 	change_set_element: ChangeSetElementTable;
 	change_set_label: ChangeSetLabelTable;
-	change_set_label_author: ChangeSetLabelAuthorTable;
 
 	// key value
 	key_value: KeyValueTable;
@@ -50,16 +49,16 @@ export type LixDatabaseSchema = {
 	mutation_log: MutationLogTable;
 };
 
-export type ChangeQueueEntry = Selectable<ChangeQueueTable>;
-export type NewChangeQueueEntry = Insertable<ChangeQueueTable>;
-export type ChangeQueueEntryUpdate = Updateable<ChangeQueueTable>;
-type ChangeQueueTable = {
+export type FileQueueEntry = Selectable<FileQueueTable>;
+export type NewFileQueueEntry = Insertable<FileQueueTable>;
+export type FileQueueEntryUpdate = Updateable<FileQueueTable>;
+type FileQueueTable = {
 	id: Generated<number>;
 	file_id: string;
 	path_before: string | null;
 	path_after: string | null;
-	data_before: ArrayBuffer | null;
-	data_after: ArrayBuffer | null;
+	data_before: Uint8Array | null;
+	data_after: Uint8Array | null;
 	metadata_before: Record<string, any> | null;
 	metadata_after: Record<string, any> | null;
 };
@@ -80,7 +79,7 @@ type LixFileTable = {
 	 *   - `/path/to/file.txt`
 	 */
 	path: string;
-	data: ArrayBuffer;
+	data: Uint8Array;
 	metadata: Record<string, any> | null;
 };
 
@@ -175,8 +174,6 @@ type CommentTable = {
 	id: Generated<string>;
 	parent_id: string | null;
 	discussion_id: string;
-	created_at: Generated<string>;
-	created_by: string;
 	content: string;
 };
 
@@ -198,15 +195,6 @@ type ChangeSetLabelTable = {
 	label_id: string;
 };
 
-export type ChangeSetLabelAuthor = Selectable<ChangeSetLabelAuthorTable>;
-export type NewChangeSetLabelAuthor = Insertable<ChangeSetLabelAuthorTable>;
-export type ChangeSetLabelAuthorUpdate = Updateable<ChangeSetLabelAuthorTable>;
-type ChangeSetLabelAuthorTable = {
-	change_set_id: string;
-	label_id: string;
-	account_id: string;
-};
-
 // ------ versiones ------
 
 export type Version = Selectable<VersionTable>;
@@ -214,7 +202,7 @@ export type Newversion = Insertable<VersionTable>;
 export type VersionUpdate = Updateable<VersionTable>;
 type VersionTable = {
 	id: Generated<string>;
-	name: string | null;
+	name: Generated<string>;
 };
 
 export type VersionChange = Selectable<VersionChangeTable>;
@@ -223,6 +211,9 @@ export type VersionChangeUpdate = Updateable<VersionChangeTable>;
 type VersionChangeTable = {
 	version_id: string;
 	change_id: string;
+	entity_id: string;
+	file_id: string;
+	schema_key: string;
 };
 
 export type VersionChangeConflict = Selectable<VersionChangeConflictTable>;
@@ -234,9 +225,9 @@ type VersionChangeConflictTable = {
 	change_conflict_id: string;
 };
 
-export type Currentversion = Selectable<CurrentVersionTable>;
-export type NewCurrentversion = Insertable<CurrentVersionTable>;
-export type CurrentversionUpdate = Updateable<CurrentVersionTable>;
+export type CurrentVersion = Selectable<CurrentVersionTable>;
+export type NewCurrentVersion = Insertable<CurrentVersionTable>;
+export type CurrentVersionUpdate = Updateable<CurrentVersionTable>;
 type CurrentVersionTable = {
 	id: string;
 };

package/src/discussion/create-comment.ts

@@ -1,4 +1,3 @@
-import type { Account } from "../account/database-schema.js";
 import type { Comment } from "../database/schema.js";
 import type { Lix } from "../lix/open-lix.js";
 
@@ -6,7 +5,6 @@ export async function createComment(args: {
 	lix: Pick<Lix, "db">;
 	parentComment: Pick<Comment, "id" | "discussion_id">;
 	content: string;
-	createdBy: Pick<Account, "id">;
 }): Promise<Comment> {
 	return args.lix.db
 		.insertInto("comment")
@@ -14,7 +12,6 @@ export async function createComment(args: {
 			discussion_id: args.parentComment.discussion_id,
 			parent_id: args.parentComment.id,
 			content: args.content,
-			created_by: args.createdBy.id,
 		})
 		.returningAll()
 		.executeTakeFirstOrThrow();

package/src/discussion/create-discussion.test.ts

@@ -1,50 +1,20 @@
 import { expect, test } from "vitest";
 import { openLixInMemory } from "../lix/open-lix-in-memory.js";
-import { newLixFile } from "../lix/new-lix.js";
-import type { DetectedChange, LixPlugin } from "../plugin/lix-plugin.js";
 import { createDiscussion } from "./create-discussion.js";
 import { createChangeSet } from "../change-set/create-change-set.js";
-import { changeQueueSettled } from "../change-queue/change-queue-settled.js";
-
-const mockPlugin: LixPlugin = {
-	key: "mock-plugin",
-	detectChangesGlob: "*",
-	detectChanges: async ({ after }) => {
-		return [
-			{
-				schema: {
-					key: "text",
-					type: "json",
-				},
-				entity_id: "test",
-				snapshot: {
-					text: after ? new TextDecoder().decode(after.data) : undefined,
-				},
-			} satisfies DetectedChange,
-		];
-	},
-};
 
 test("should be able to start a discussion on changes", async () => {
-	const lix = await openLixInMemory({
-		blob: await newLixFile(),
-		providePlugins: [mockPlugin],
-	});
-
-	const enc = new TextEncoder();
+	const lix = await openLixInMemory({});
 
+	// produce a change
 	await lix.db
-		.insertInto("file")
-		.values({ id: "test", path: "/test.txt", data: enc.encode("test") })
+		.insertInto("key_value")
+		.values({
+			key: "mock_key",
+			value: "mock_value",
+		})
 		.execute();
 
-	await changeQueueSettled({ lix });
-
-	const current_author = await lix.db
-		.selectFrom("active_account")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
 	const changes = await lix.db
 		.selectFrom("change")
 		.selectAll("change")
@@ -53,9 +23,8 @@ test("should be able to start a discussion on changes", async () => {
 	await lix.db.transaction().execute(async (trx) => {
 		await createDiscussion({
 			lix: { db: trx },
+			firstComment: { content: "Hello, world!" },
 			changeSet: await createChangeSet({ lix: { db: trx }, changes }),
-			content: "comment on a change",
-			createdBy: { id: current_author.id },
 		});
 	});
 

package/src/discussion/create-discussion.ts

@@ -1,4 +1,3 @@
-import type { Account } from "../account/database-schema.js";
 import type { ChangeSet, Comment, Discussion } from "../database/schema.js";
 import type { Lix } from "../lix/open-lix.js";
 
@@ -8,7 +7,7 @@ import type { Lix } from "../lix/open-lix.js";
  * @example
  *   ```ts
  *   const changeSet = await createChangeSet({ lix, changes: ["change1", "change2"] });
- *   const discussion = await createDiscussion({ lix, changeSet, body: "first comment" });
+ *   const discussion = await createDiscussion({ lix, changeSet, firstComment: { content: "first comment" } });
  *   ```
  *
  * @returns the created discussion
@@ -16,9 +15,8 @@ import type { Lix } from "../lix/open-lix.js";
 export async function createDiscussion(args: {
 	lix: Pick<Lix, "db">;
 	changeSet: Pick<ChangeSet, "id">;
-	content: Comment["content"];
-	createdBy: Pick<Account, "id">;
-}): Promise<Discussion & { comment: Comment }> {
+	firstComment: Pick<Comment, "content">;
+}): Promise<Discussion & { firstComment: Comment }> {
 	const executeInTransaction = async (trx: Lix["db"]) => {
 		const discussion = await trx
 			.insertInto("discussion")
@@ -28,18 +26,17 @@ export async function createDiscussion(args: {
 			.returningAll()
 			.executeTakeFirstOrThrow();
 
-		const comment = await trx
+		const firstComment = await trx
 			.insertInto("comment")
 			.values({
 				parent_id: null,
 				discussion_id: discussion.id,
-				content: args.content,
-				created_by: args.createdBy.id,
+				content: args.firstComment.content,
 			})
 			.returningAll()
 			.executeTakeFirstOrThrow();
 
-		return { ...discussion, comment };
+		return { ...discussion, firstComment };
 	};
 
 	// user provided an open transaction

package/src/{change-queue → file-queue}/file-handlers.ts

@@ -1,4 +1,4 @@
-import type { ChangeQueueEntry } from "../database/schema.js";
+import type { FileQueueEntry } from "../database/schema.js";
 import type { DetectedChange } from "../plugin/lix-plugin.js";
 import type { Lix } from "../lix/open-lix.js";
 import { sql } from "kysely";
@@ -31,7 +31,7 @@ async function glob(args: {
 // creates initial changes for new files
 export async function handleFileInsert(args: {
 	lix: Pick<Lix, "db" | "plugin" | "sqlite">;
-	changeQueueEntry: ChangeQueueEntry;
+	fileQueueEntry: FileQueueEntry;
 }): Promise<void> {
 	const detectedChanges: Array<DetectedChange & { pluginKey: string }> = [];
 
@@ -40,7 +40,7 @@ export async function handleFileInsert(args: {
 	// the path of the file is either the after path or the before path
 	// depending on whether the file was deleted, updated, or created
 	const path =
-		args.changeQueueEntry.path_after ?? args.changeQueueEntry.path_before;
+		args.fileQueueEntry.path_after ?? args.fileQueueEntry.path_before;
 
 	if (path === null) {
 		throw new Error("Both before and after paths are null");
@@ -67,7 +67,7 @@ export async function handleFileInsert(args: {
 			throw error;
 		}
 
-		if (args.changeQueueEntry.data_after === null) {
+		if (args.fileQueueEntry.data_after === null) {
 			throw new Error("Data after is null");
 		}
 
@@ -75,10 +75,10 @@ export async function handleFileInsert(args: {
 			lix: args.lix,
 			before: undefined,
 			after: {
-				id: args.changeQueueEntry.file_id,
+				id: args.fileQueueEntry.file_id,
 				path,
-				metadata: args.changeQueueEntry.metadata_after,
-				data: args.changeQueueEntry.data_after,
+				metadata: args.fileQueueEntry.metadata_after,
+				data: args.fileQueueEntry.data_after,
 			},
 		})) {
 			detectedChanges.push({
@@ -107,7 +107,7 @@ export async function handleFileInsert(args: {
 					authors: currentAuthors,
 					version: currentVersion,
 					entityId: detectedChange.entity_id,
-					fileId: args.changeQueueEntry.file_id,
+					fileId: args.fileQueueEntry.file_id,
 					pluginKey: detectedChange.pluginKey,
 					schemaKey: detectedChange.schema.key,
 					snapshotContent: detectedChange.snapshot,
@@ -116,15 +116,15 @@ export async function handleFileInsert(args: {
 		);
 
 		await trx
-			.deleteFrom("change_queue")
-			.where("id", "=", args.changeQueueEntry.id)
+			.deleteFrom("file_queue")
+			.where("id", "=", args.fileQueueEntry.id)
 			.execute();
 	});
 }
 
 export async function handleFileUpdate(args: {
 	lix: Pick<Lix, "db" | "plugin" | "sqlite">;
-	changeQueueEntry: ChangeQueueEntry;
+	fileQueueEntry: FileQueueEntry;
 }): Promise<void> {
 	const detectedChanges: Array<DetectedChange & { pluginKey: string }> = [];
 
@@ -133,7 +133,7 @@ export async function handleFileUpdate(args: {
 	// the path of the file is either the after path or the before path
 	// depending on whether the file was deleted, updated, or created
 	const path =
-		args.changeQueueEntry.path_after ?? args.changeQueueEntry.path_before;
+		args.fileQueueEntry.path_after ?? args.fileQueueEntry.path_before;
 
 	if (path === null) {
 		throw new Error("Both before and after paths are null");
@@ -160,19 +160,19 @@ export async function handleFileUpdate(args: {
 		}
 		for (const change of await plugin.detectChanges({
 			lix: args.lix,
-			before: args.changeQueueEntry.data_before
+			before: args.fileQueueEntry.data_before
 				? {
-						id: args.changeQueueEntry.file_id,
+						id: args.fileQueueEntry.file_id,
 						path: path,
-						metadata: args.changeQueueEntry.metadata_before,
-						data: args.changeQueueEntry.data_before,
+						metadata: args.fileQueueEntry.metadata_before,
+						data: args.fileQueueEntry.data_before,
 					}
 				: undefined,
 			after: {
-				id: args.changeQueueEntry.file_id,
+				id: args.fileQueueEntry.file_id,
 				path,
-				metadata: args.changeQueueEntry.metadata_after,
-				data: args.changeQueueEntry.data_after!,
+				metadata: args.fileQueueEntry.metadata_after,
+				data: args.fileQueueEntry.data_after!,
 			},
 		})) {
 			detectedChanges.push({
@@ -201,7 +201,7 @@ export async function handleFileUpdate(args: {
 					authors: currentAuthors,
 					version: currentVersion,
 					entityId: detectedChange.entity_id,
-					fileId: args.changeQueueEntry.file_id,
+					fileId: args.fileQueueEntry.file_id,
 					pluginKey: detectedChange.pluginKey,
 					schemaKey: detectedChange.schema.key,
 					snapshotContent: detectedChange.snapshot,
@@ -210,8 +210,8 @@ export async function handleFileUpdate(args: {
 		);
 
 		await trx
-			.deleteFrom("change_queue")
-			.where("id", "=", args.changeQueueEntry.id)
+			.deleteFrom("file_queue")
+			.where("id", "=", args.fileQueueEntry.id)
 			.execute();
 	});
 }
@@ -227,7 +227,7 @@ export async function handleFileUpdate(args: {
  */
 export async function handleFileDelete(args: {
 	lix: Pick<Lix, "db" | "plugin" | "sqlite">;
-	changeQueueEntry: ChangeQueueEntry;
+	fileQueueEntry: FileQueueEntry;
 }): Promise<void> {
 	await args.lix.db.transaction().execute(async (trx) => {
 		const currentVersion = await trx
@@ -238,7 +238,7 @@ export async function handleFileDelete(args: {
 
 		const toBeDeletedEntities = await trx
 			.selectFrom("change")
-			.where("file_id", "=", args.changeQueueEntry.file_id)
+			.where("file_id", "=", args.fileQueueEntry.file_id)
 			.where(changeIsLeafInVersion(currentVersion))
 			.select("entity_id")
 			.select("schema_key")
@@ -257,7 +257,7 @@ export async function handleFileDelete(args: {
 					authors: currentAuthors,
 					version: currentVersion,
 					entityId: change.entity_id,
-					fileId: args.changeQueueEntry.file_id,
+					fileId: args.fileQueueEntry.file_id,
 					pluginKey: change.plugin_key,
 					schemaKey: change.schema_key,
 					snapshotContent: null, // Snapshot is null for deletions
@@ -266,8 +266,8 @@ export async function handleFileDelete(args: {
 		);
 
 		await trx
-			.deleteFrom("change_queue")
-			.where("id", "=", args.changeQueueEntry.id)
+			.deleteFrom("file_queue")
+			.where("id", "=", args.fileQueueEntry.id)
 			.execute();
 	});
 }

package/src/{change-queue/init-change-queue.test.ts → file-queue/file-queue-process.test.ts}

@@ -2,8 +2,8 @@ import { expect, test, vi } from "vitest";
 import { openLixInMemory } from "../lix/open-lix-in-memory.js";
 import { newLixFile } from "../lix/new-lix.js";
 import type { DetectedChange, LixPlugin } from "../plugin/lix-plugin.js";
-import type { ChangeQueueEntry, LixFile } from "../database/schema.js";
-import { changeQueueSettled } from "./change-queue-settled.js";
+import type { FileQueueEntry, LixFile } from "../database/schema.js";
+import { fileQueueSettled } from "./file-queue-settled.js";
 
 test("should use queue and settled correctly", async () => {
 	const mockPlugin: LixPlugin = {
@@ -52,7 +52,7 @@ test("should use queue and settled correctly", async () => {
 		.values({ id: "test", path: "/test.txt", data: dataInitial })
 		.execute();
 
-	const queue = await lix.db.selectFrom("change_queue").selectAll().execute();
+	const queue = await lix.db.selectFrom("file_queue").selectAll().execute();
 
 	expect(queue).toEqual([
 		expect.objectContaining({
@@ -61,13 +61,13 @@ test("should use queue and settled correctly", async () => {
 			path_after: "/test.txt",
 			data_after: dataInitial,
 			data_before: null,
-		} satisfies Partial<ChangeQueueEntry>),
+		} satisfies Partial<FileQueueEntry>),
 	]);
 
-	await changeQueueSettled({ lix });
+	await fileQueueSettled({ lix });
 
 	expect(
-		(await lix.db.selectFrom("change_queue").selectAll().execute()).length
+		(await lix.db.selectFrom("file_queue").selectAll().execute()).length
 	).toBe(0);
 
 	// TODO QUEUE check if the replacement of file_internal was expected
@@ -104,8 +104,7 @@ test("should use queue and settled correctly", async () => {
 				content: {
 					text: "insert text",
 				},
-				// handles the author (which defaults to anonymous)
-				account_id: expect.stringMatching(/^anonymous_/),
+				account_id: expect.stringMatching(/./),
 			}),
 		])
 	);
@@ -118,14 +117,14 @@ test("should use queue and settled correctly", async () => {
 		.execute();
 
 	// const beforeQueueTick = await lix.db
-	// 	.selectFrom("change_queue")
+	// 	.selectFrom("file_queue")
 	// 	.selectAll()
 	// 	.execute();
 
 	// expect(beforeQueueTick.length).toBe(1);
 
 	// const afterQueueTick = await lix.db
-	// 	.selectFrom("change_queue")
+	// 	.selectFrom("file_queue")
 	// 	.selectAll()
 	// 	.execute();
 
@@ -149,11 +148,11 @@ test("should use queue and settled correctly", async () => {
 		.where("id", "=", "test")
 		.execute();
 
-	const queue2 = await lix.db.selectFrom("change_queue").selectAll().execute();
+	const queue2 = await lix.db.selectFrom("file_queue").selectAll().execute();
 
 	expect(queue2).toEqual([
 		// change update 1 is the same as change update 2
-		// hence, only 2 change queue entries are expected
+		// hence, only 2 fil queue entries are expected
 		expect.objectContaining({
 			id: 3,
 			file_id: "test",
@@ -161,7 +160,7 @@ test("should use queue and settled correctly", async () => {
 			metadata_after: null,
 			data_before: dataUpdate1,
 			data_after: dataUpdate2,
-		} satisfies Partial<ChangeQueueEntry>),
+		} satisfies Partial<FileQueueEntry>),
 		expect.objectContaining({
 			id: 4,
 			file_id: "test",
@@ -169,13 +168,13 @@ test("should use queue and settled correctly", async () => {
 			metadata_after: null,
 			data_before: dataUpdate2,
 			data_after: dataUpdate3,
-		} satisfies Partial<ChangeQueueEntry>),
+		} satisfies Partial<FileQueueEntry>),
 	]);
 
-	await changeQueueSettled({ lix });
+	await fileQueueSettled({ lix });
 
 	expect(
-		(await lix.db.selectFrom("change_queue").selectAll().execute()).length
+		(await lix.db.selectFrom("file_queue").selectAll().execute()).length
 	).toBe(0);
 
 	const updatedChanges = await lix.db
@@ -209,7 +208,7 @@ test("should use queue and settled correctly", async () => {
 				content: {
 					text: "insert text",
 				},
-				account_id: expect.stringMatching(/^anonymous_/),
+				account_id: expect.stringMatching(/./),
 			}),
 			expect.objectContaining({
 				entity_id: "test",
@@ -219,7 +218,7 @@ test("should use queue and settled correctly", async () => {
 				content: {
 					text: "updated text",
 				},
-				account_id: expect.stringMatching(/^anonymous_/),
+				account_id: expect.stringMatching(/./),
 			}),
 			expect.objectContaining({
 				file_id: "test",
@@ -229,7 +228,7 @@ test("should use queue and settled correctly", async () => {
 				content: {
 					text: "second text update",
 				},
-				account_id: expect.stringMatching(/^anonymous_/),
+				account_id: expect.stringMatching(/./),
 			}),
 		])
 	);
@@ -303,7 +302,7 @@ test.todo("changes should contain the author", async () => {
 		})
 		.execute();
 
-	await changeQueueSettled({ lix });
+	await fileQueueSettled({ lix });
 
 	// const changes1 = await lix.db.selectFrom("change").selectAll().execute();
 
@@ -319,7 +318,7 @@ test.todo("changes should contain the author", async () => {
 		.where("id", "=", "mock")
 		.execute();
 
-	await changeQueueSettled({ lix });
+	await fileQueueSettled({ lix });
 
 	// const changes2 = await lix.db.selectFrom("change").selectAll().execute();
 
@@ -333,7 +332,7 @@ test.todo("changes should contain the author", async () => {
 		.where("id", "=", "mock")
 		.execute();
 
-	await changeQueueSettled({ lix });
+	await fileQueueSettled({ lix });
 
 	// const changes3 = await lix.db.selectFrom("change").selectAll().execute();
 
@@ -378,7 +377,7 @@ test("should handle file deletions correctly", async () => {
 		.execute();
 
 	// Queue deletion
-	await changeQueueSettled({ lix });
+	await fileQueueSettled({ lix });
 
 	const changesAfterInsert = await lix.db
 		.selectFrom("change")
@@ -404,7 +403,7 @@ test("should handle file deletions correctly", async () => {
 	await lix.db.deleteFrom("file").where("id", "=", "file0").execute();
 
 	// Ensure the queue reflects the deletion entry
-	const queue = await lix.db.selectFrom("change_queue").selectAll().execute();
+	const queue = await lix.db.selectFrom("file_queue").selectAll().execute();
 
 	expect(queue).toEqual([
 		expect.objectContaining({
@@ -413,15 +412,15 @@ test("should handle file deletions correctly", async () => {
 			data_before: null,
 			path_after: null,
 			data_after: null,
-		} satisfies Partial<ChangeQueueEntry>),
+		} satisfies Partial<FileQueueEntry>),
 	]);
 
-	// Run the change queue settlement process
-	await changeQueueSettled({ lix });
+	// Run the fil queue settlement process
+	await fileQueueSettled({ lix });
 
-	// Verify the change queue is empty
+	// Verify the fil queue is empty
 	expect(
-		(await lix.db.selectFrom("change_queue").selectAll().execute()).length
+		(await lix.db.selectFrom("file_queue").selectAll().execute()).length
 	).toBe(0);
 
 	// Verify the changes reflect the deletion