@lix-js/sdk 0.5.1 → 0.6.0-preview.0

package/src/filesystem/file/materialize-file-data-at-commit.ts

@@ -1,203 +0,0 @@
-import type { LixEngine } from "../../engine/boot.js";
-import type { LixFile } from "./schema.js";
-import type { LixChange } from "../../change/schema-definition.js";
-import { lixUnknownFileFallbackPlugin } from "./unknown-file-fallback-plugin.js";
-import {
-	readFileDescriptorAtCommit,
-	composeFilePathAtCommit,
-} from "./descriptor-utils.js";
-import { matchesGlob } from "../util/glob.js";
-import { internalQueryBuilder } from "../../engine/internal-query-builder.js";
-
-export function materializeFileDataAtCommit(args: {
-	engine: Pick<LixEngine, "getAllPluginsSync" | "executeSync">;
-	file: Pick<LixFile, "id" | "path"> &
-		Partial<Omit<LixFile, "id" | "path" | "data">>;
-	rootCommitId: string;
-	depth: number;
-}): Uint8Array {
-	const plugins = args.engine.getAllPluginsSync();
-	const historicalSnapshot = readFileDescriptorAtCommit({
-		engine: args.engine,
-		fileId: args.file.id,
-		rootCommitId: args.rootCommitId,
-		depth: args.depth,
-	});
-	if (!historicalSnapshot) {
-		throw new Error(
-			`[materializeFileDataAtCommit] Missing descriptor snapshot for file ${args.file.id} at commit ${args.rootCommitId}`
-		);
-	}
-
-	const historicalPath =
-		composeFilePathAtCommit({
-			engine: args.engine,
-			directoryId: historicalSnapshot.directory_id,
-			name: historicalSnapshot.name,
-			extension: historicalSnapshot.extension ?? null,
-			rootCommitId: args.rootCommitId,
-			depth: args.depth,
-		}) ?? args.file.path;
-
-	const initialData = (args.file as Partial<LixFile>).data ?? new Uint8Array();
-
-	const descriptor: LixFile = {
-		id: args.file.id,
-		path: historicalPath,
-		directory_id: historicalSnapshot.directory_id,
-		name: historicalSnapshot.name,
-		extension: historicalSnapshot.extension ?? null,
-		metadata: args.file.metadata ?? historicalSnapshot.metadata ?? null,
-		hidden: historicalSnapshot.hidden,
-		data: initialData,
-	};
-
-	// First, try to find a specific plugin that can handle this file (excluding fallback)
-	for (const plugin of plugins) {
-		if (
-			!plugin.detectChangesGlob ||
-			!matchesGlob({
-				engine: args.engine,
-				path: descriptor.path,
-				pattern: plugin.detectChangesGlob,
-			})
-		) {
-			continue;
-		}
-
-		if (!plugin.applyChanges) {
-			continue;
-		}
-
-		// Get plugin changes from state_history table
-		const rows = args.engine.executeSync(
-			selectFileChanges({
-				pluginKey: plugin.key,
-				fileId: descriptor.id,
-				rootCommitId: args.rootCommitId,
-				depth: args.depth,
-			}).compile()
-		).rows;
-
-		const formattedChanges = mapHistoryRowsToLixChanges(rows);
-
-		const file = plugin.applyChanges({
-			file: descriptor,
-			changes: formattedChanges,
-		});
-
-		return file.fileData;
-	}
-
-	// If no specific plugin matched, use the fallback plugin
-	const fallbackRows = args.engine.executeSync(
-		selectFileChanges({
-			pluginKey: lixUnknownFileFallbackPlugin.key,
-			fileId: descriptor.id,
-			rootCommitId: args.rootCommitId,
-			depth: args.depth,
-		}).compile()
-	).rows;
-
-	const formattedChanges = mapHistoryRowsToLixChanges(fallbackRows);
-
-	if (formattedChanges.length === 0) {
-		throw new Error(
-			`[materializeFileDataAtCommit] No changes found for file ${args.file.id} with plugin ${lixUnknownFileFallbackPlugin.key} at root commit ${args.rootCommitId} depth ${args.depth}. Cannot materialize file data.`
-		);
-	}
-
-	const file = lixUnknownFileFallbackPlugin.applyChanges!({
-		file: descriptor,
-		changes: formattedChanges,
-	});
-
-	return file.fileData;
-}
-
-function selectFileChanges(args: {
-	pluginKey: string;
-	fileId: string;
-	rootCommitId: string;
-	depth: number;
-}) {
-	return internalQueryBuilder
-		.selectFrom("state_history as sh1")
-		.where("sh1.plugin_key", "=", args.pluginKey)
-		.where("sh1.file_id", "=", args.fileId)
-		.where("sh1.root_commit_id", "=", args.rootCommitId)
-		.where("sh1.depth", ">=", args.depth)
-		.where("sh1.depth", "=", (eb: any) =>
-			// This subquery finds the "leaf state" for each entity at the requested depth in history.
-			//
-			// What this does: "For each entity in the file, find its most recent state that existed
-			// at or before the requested depth. Some entities might have changed at depth 0, others
-			// might be unchanged since depth 5 - we need all of them to reconstruct the complete file."
-			//
-			// Example: Requesting depth=1 for a JSON file
-			// - "name" entity: last changed at depth=3 (unchanged for 3 changesets)
-			// - "value" entity: last changed at depth=1 (changed 1 changeset ago)
-			// - "description" entity: last changed at depth=0 (just changed)
-			//
-			// Result: We get "name" from depth=3 and "value" from depth=1 (ignoring "description" at depth=0)
-			//
-			// args.depth: The depth we want to reconstruct the file at (0=current, higher=further back in history)
-			// >= args.depth: Go backwards in history to find all entities that existed at or before this point
-			// min(depth): For each entity, get its most recent state (leaf) at or after the requested depth
-			eb
-				.selectFrom("state_history as sh2")
-				.select((eb: any) => eb.fn.min("sh2.depth").as("min_depth"))
-				.whereRef("sh2.entity_id", "=", "sh1.entity_id")
-				.whereRef("sh2.file_id", "=", "sh1.file_id")
-				.whereRef("sh2.plugin_key", "=", "sh1.plugin_key")
-				.whereRef("sh2.root_commit_id", "=", "sh1.root_commit_id")
-				.where("sh2.depth", ">=", args.depth)
-		)
-		.select([
-			"sh1.entity_id",
-			"sh1.schema_key",
-			"sh1.schema_version",
-			"sh1.file_id",
-			"sh1.plugin_key",
-			"sh1.snapshot_content",
-			"sh1.metadata",
-			"sh1.change_id",
-		]);
-}
-
-function mapHistoryRowsToLixChanges(rows: any[]): LixChange[] {
-	return rows.map((row) => {
-		const snapshotValue = row.snapshot_content;
-		const snapshot =
-			typeof snapshotValue === "string"
-				? JSON.parse(snapshotValue)
-				: (snapshotValue ?? null);
-
-		const metadataValue = row.metadata;
-		let metadata: Record<string, any> | null = null;
-		if (metadataValue != null) {
-			if (typeof metadataValue === "string") {
-				try {
-					metadata = JSON.parse(metadataValue);
-				} catch {
-					metadata = null;
-				}
-			} else if (typeof metadataValue === "object") {
-				metadata = metadataValue as Record<string, any>;
-			}
-		}
-
-		return {
-			id: (row.change_id as string | undefined) ?? (row.entity_id as string),
-			entity_id: row.entity_id as string,
-			schema_key: row.schema_key as string,
-			schema_version: row.schema_version as string,
-			file_id: row.file_id as string,
-			plugin_key: row.plugin_key as string,
-			metadata,
-			created_at:
-				(row.created_at as string | undefined) ?? new Date(0).toISOString(),
-			snapshot_content: snapshot as Record<string, any> | null,
-		};
-	});
-}

package/src/filesystem/file/materialize-file-data.test.ts

@@ -1,123 +0,0 @@
-import { test, expect } from "vitest";
-import { openLix } from "../../lix/open-lix.js";
-import { materializeFileData } from "./materialize-file-data.js";
-import type { LixPlugin } from "../../plugin/lix-plugin.js";
-import type { LixSchemaDefinition } from "../../schema-definition/definition.js";
-
-const testFileSchema = {
-	"x-lix-key": "test_schema",
-	"x-lix-version": "1.0",
-	type: "object",
-	additionalProperties: false,
-	properties: {
-		value: { type: "string" },
-	},
-	required: ["value"],
-} as const satisfies LixSchemaDefinition;
-
-test("materializeFileData with plugin that has changes", async () => {
-	const mockPlugin: LixPlugin = {
-		key: "test-plugin-2",
-		detectChangesGlob: "*.txt",
-		detectChanges: () => [],
-		applyChanges: ({ changes }) => {
-			// Create content based on the changes
-			const changeIds = changes.map((c) => c.entity_id).join(",");
-			return {
-				fileData: new TextEncoder().encode(`processed-${changeIds}`),
-			};
-		},
-	};
-
-	const lix = await openLix({
-		providePlugins: [mockPlugin],
-	});
-	await lix.db
-		.insertInto("stored_schema")
-		.values({ value: testFileSchema })
-		.execute();
-
-	const activeVersion = await lix.db
-		.selectFrom("active_version")
-		.select("version_id")
-		.executeTakeFirstOrThrow();
-
-	// Insert a file
-	await lix.db
-		.insertInto("file")
-		.values({
-			id: "test-file-2",
-			data: new TextEncoder().encode("initial-data"),
-			path: "/test.txt",
-		})
-		.execute();
-
-	// Manually insert some state data to simulate plugin changes
-	await lix.db
-		.insertInto("state_by_version")
-		.values({
-			entity_id: "entity1",
-			schema_key: "test_schema",
-			file_id: "test-file-2",
-			plugin_key: "test-plugin-2",
-			snapshot_content: { value: "test-content" },
-			schema_version: "1.0",
-			version_id: activeVersion.version_id,
-		})
-		.execute();
-
-	const file = await lix.db
-		.selectFrom("file")
-		.where("id", "=", "test-file-2")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	// Test that materializeFileData processes the changes
-	const result = materializeFileData({
-		engine: lix.engine!,
-		file: {
-			id: file.id,
-			path: file.path,
-			metadata: file.metadata,
-		},
-		versionId: activeVersion.version_id,
-	});
-
-	expect(result).toBeInstanceOf(Uint8Array);
-	expect(new TextDecoder().decode(result)).toBe("processed-entity1");
-});
-
-test("materializeFileData throws when plugin has no applyChanges", async () => {
-	const mockPlugin: LixPlugin = {
-		key: "test-plugin-no-apply",
-		detectChangesGlob: "*.txt",
-		detectChanges: () => [],
-		// No applyChanges method - this should cause materialization to fail
-	};
-
-	const lix = await openLix({
-		providePlugins: [mockPlugin],
-	});
-
-	// Insert a file that the plugin will match but cannot materialize
-	await lix.db
-		.insertInto("file")
-		.values({
-			id: "test-file-no-apply",
-			data: new TextEncoder().encode("initial-data"),
-			path: "/test.txt",
-		})
-		.execute();
-
-	// Test that selecting the file throws when plugin cannot materialize
-	await expect(
-		async () =>
-			await lix.db
-				.selectFrom("file")
-				.where("id", "=", "test-file-no-apply")
-				.selectAll()
-				.executeTakeFirstOrThrow()
-	).rejects.toThrow(
-		"[materializeFileData] No changes found for file test-file-no-apply with plugin lix_unknown_file_fallback_plugin. Cannot materialize file data."
-	);
-});

package/src/filesystem/file/materialize-file-data.ts

@@ -1,140 +0,0 @@
-import type { LixEngine } from "../../engine/boot.js";
-import type { LixFile } from "./schema.js";
-import type { LixChange } from "../../change/schema-definition.js";
-import { lixUnknownFileFallbackPlugin } from "./unknown-file-fallback-plugin.js";
-import { ensureCompleteDescriptor } from "./descriptor-utils.js";
-import { matchesGlob } from "../util/glob.js";
-import { internalQueryBuilder } from "../../engine/internal-query-builder.js";
-
-export function materializeFileData(args: {
-	engine: Pick<LixEngine, "getAllPluginsSync" | "executeSync">;
-	file: Pick<LixFile, "id" | "path"> &
-		Partial<Omit<LixFile, "id" | "path" | "data">>;
-	versionId: string;
-}): Uint8Array {
-	const plugins = args.engine.getAllPluginsSync();
-	const descriptor = ensureCompleteDescriptor({
-		engine: args.engine,
-		versionId: args.versionId,
-		file: args.file,
-	});
-
-	// First, try to find a specific plugin that can handle this file (excluding fallback)
-	for (const plugin of plugins) {
-		if (
-			!plugin.detectChangesGlob ||
-			!matchesGlob({
-				engine: args.engine,
-				path: descriptor.path,
-				pattern: plugin.detectChangesGlob,
-			})
-		) {
-			continue;
-		}
-
-		if (!plugin.applyChanges) {
-			continue;
-		}
-
-		const rows = args.engine.executeSync(
-			internalQueryBuilder
-				.selectFrom("state_by_version")
-				.where("plugin_key", "=", plugin.key)
-				.where("file_id", "=", descriptor.id)
-				.where("version_id", "=", args.versionId)
-				.select([
-					"entity_id",
-					"schema_key",
-					"schema_version",
-					"file_id",
-					"plugin_key",
-					"snapshot_content",
-					"metadata",
-					"created_at",
-					"change_id",
-				])
-				.compile()
-		).rows;
-
-		const formattedChanges = mapStateRowsToLixChanges(rows);
-
-		const file = plugin.applyChanges({
-			file: descriptor,
-			changes: formattedChanges,
-		});
-
-		return file.fileData;
-	}
-
-	// If no specific plugin matched, use the fallback plugin
-	const fallbackRows = args.engine.executeSync(
-		internalQueryBuilder
-			.selectFrom("state_by_version")
-			.where("plugin_key", "=", lixUnknownFileFallbackPlugin.key)
-			.where("file_id", "=", descriptor.id)
-			.where("version_id", "=", args.versionId)
-			.select([
-				"entity_id",
-				"schema_key",
-				"schema_version",
-				"file_id",
-				"plugin_key",
-				"snapshot_content",
-				"metadata",
-				"created_at",
-				"change_id",
-			])
-			.compile()
-	).rows;
-
-	const formattedChanges = mapStateRowsToLixChanges(fallbackRows);
-
-	if (formattedChanges.length === 0) {
-		throw new Error(
-			`[materializeFileData] No changes found for file ${args.file.id} with plugin ${lixUnknownFileFallbackPlugin.key}. Cannot materialize file data.`
-		);
-	}
-
-	const file = lixUnknownFileFallbackPlugin.applyChanges!({
-		file: descriptor,
-		changes: formattedChanges,
-	});
-
-	return file.fileData;
-}
-
-function mapStateRowsToLixChanges(rows: any[]): LixChange[] {
-	return rows.map((row) => {
-		const snapshotValue = row.snapshot_content;
-		const snapshot =
-			typeof snapshotValue === "string"
-				? JSON.parse(snapshotValue)
-				: (snapshotValue ?? null);
-
-		const metadataValue = row.metadata;
-		let metadata: Record<string, any> | null = null;
-		if (metadataValue != null) {
-			if (typeof metadataValue === "string") {
-				try {
-					metadata = JSON.parse(metadataValue);
-				} catch {
-					metadata = null;
-				}
-			} else if (typeof metadataValue === "object") {
-				metadata = metadataValue as Record<string, any>;
-			}
-		}
-
-		return {
-			id: (row.change_id as string | undefined) ?? (row.entity_id as string),
-			entity_id: row.entity_id as string,
-			schema_key: row.schema_key as string,
-			schema_version: row.schema_version as string,
-			file_id: row.file_id as string,
-			plugin_key: row.plugin_key as string,
-			metadata,
-			created_at: row.created_at as string,
-			snapshot_content: snapshot as Record<string, any> | null,
-		};
-	});
-}

package/src/filesystem/file/schema-definition.ts

@@ -1,49 +0,0 @@
-import type {
-	FromLixSchemaDefinition,
-	LixSchemaDefinition,
-} from "../../schema-definition/definition.js";
-
-export type LixFileDescriptor = FromLixSchemaDefinition<
-	typeof LixFileDescriptorSchema
->;
-
-export const LixFileDescriptorSchema = {
-	"x-lix-key": "lix_file_descriptor",
-	"x-lix-version": "1.0",
-	"x-lix-primary-key": ["/id"],
-	"x-lix-unique": [["/directory_id", "/name", "/extension"]],
-	"x-lix-override-lixcols": {
-		lixcol_file_id: '"lix"',
-		lixcol_plugin_key: '"lix_sdk"',
-	},
-	type: "object",
-	properties: {
-		id: { type: "string", "x-lix-default": "lix_uuid_v7()" },
-		directory_id: {
-			type: "string",
-			nullable: true,
-			description:
-				"Identifier of the directory containing the file. Null indicates the virtual root directory.",
-		},
-		name: {
-			type: "string",
-			pattern: "^[^/\\\\]+$",
-			description: "File name without directory segments.",
-		},
-		extension: {
-			type: "string",
-			nullable: true,
-			pattern: "^[^./\\\\]+$",
-			description:
-				"File extension without the leading dot. Null when no extension is present.",
-		},
-		metadata: {
-			type: "object",
-			nullable: true,
-		},
-		hidden: { type: "boolean", "x-lix-default": "false" },
-	},
-	required: ["id", "directory_id", "name", "extension"],
-	additionalProperties: false,
-} as const;
-LixFileDescriptorSchema satisfies LixSchemaDefinition;