@inlang/sdk 2.2.1 → 2.3.0

package/dist/services/env-variables/index.js

@@ -1,6 +1,6 @@
 export const ENV_VARIABLES = {
     PUBLIC_POSTHOG_TOKEN: "phc_m5yJZCxjOGxF8CJvP5sQ3H0d76xpnLrsmiZHduT4jDz",
     PUBLIC_INLANG_SDK_SENTRY_DSN: "https://c3d92d5d011122e525e9f9b368e0905d@o4504345873285120.ingest.us.sentry.io/4507903389335553",
-    SDK_VERSION: "2.2.1",
+    SDK_VERSION: "2.3.0",
 };
 //# sourceMappingURL=index.js.map

package/dist/services/env-variables/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"/","sources":["services/env-variables/index.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,oBAAoB,EAAE,iDAAiD;IACxE,4BAA4B,EAAE,iGAAiG;IAC/H,WAAW,EAAE,OAAO;CACpB,CAAA","sourcesContent":["\nexport const ENV_VARIABLES = {\n  PUBLIC_POSTHOG_TOKEN: \"phc_m5yJZCxjOGxF8CJvP5sQ3H0d76xpnLrsmiZHduT4jDz\",\n\tPUBLIC_INLANG_SDK_SENTRY_DSN: \"https://c3d92d5d011122e525e9f9b368e0905d@o4504345873285120.ingest.us.sentry.io/4507903389335553\",\n\tSDK_VERSION: \"2.2.1\",\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"/","sources":["services/env-variables/index.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,oBAAoB,EAAE,iDAAiD;IACxE,4BAA4B,EAAE,iGAAiG;IAC/H,WAAW,EAAE,OAAO;CACpB,CAAA","sourcesContent":["\nexport const ENV_VARIABLES = {\n  PUBLIC_POSTHOG_TOKEN: \"phc_m5yJZCxjOGxF8CJvP5sQ3H0d76xpnLrsmiZHduT4jDz\",\n\tPUBLIC_INLANG_SDK_SENTRY_DSN: \"https://c3d92d5d011122e525e9f9b368e0905d@o4504345873285120.ingest.us.sentry.io/4507903389335553\",\n\tSDK_VERSION: \"2.3.0\",\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inlang/sdk",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -29,7 +29,7 @@
     "@sinclair/typebox": "^0.31.17",
     "kysely": "^0.27.4",
     "uuid": "^10.0.0",
-    "@lix-js/sdk": "0.4.0",
+    "@lix-js/sdk": "0.4.1",
     "sqlite-wasm-kysely": "0.3.0"
   },
   "devDependencies": {
@@ -38,9 +38,10 @@
     "@types/uuid": "^10.0.0",
     "@vitest/coverage-v8": "^2.0.5",
     "eslint": "^9.12.0",
-    "typescript-eslint": "^8.9.0",
     "memfs": "4.6.0",
+    "prettier": "^3.5.1",
     "typescript": "^5.5.2",
+    "typescript-eslint": "^8.9.0",
     "vitest": "^2.0.5",
     "@opral/tsconfig": "1.1.0"
   },

package/src/json-schema/pattern.ts

@@ -38,7 +38,7 @@ export const Text = Type.Object({
 	value: Type.String(),
 });
 
-export type LocalVariable = Static<typeof VariableReference>;
+export type LocalVariable = Static<typeof LocalVariable>;
 export const LocalVariable = Type.Object({
 	type: Type.Literal("local-variable"),
 	name: Type.String(),

package/src/project/loadProjectFromDirectory.test.ts

@@ -966,3 +966,69 @@ test("providing multiple plugins that have legacy loadMessages and saveMessages
 	expect(mockPlugin2.importFiles).toHaveBeenCalled();
 	expect(mockPlugin2.loadMessages).not.toHaveBeenCalled();
 });
+
+// https://github.com/opral/inlang-sdk/issues/228
+test("the lix id should be stable between loadings of the same project", async () => {
+	const mockRepo = {
+		"/project.inlang/settings.json": JSON.stringify({
+			baseLocale: "en",
+			locales: ["en"],
+			modules: [],
+		} satisfies ProjectSettings),
+	};
+
+	const fs = Volume.fromJSON(mockRepo);
+
+	const project1 = await loadProjectFromDirectory({
+		fs: fs as any,
+		path: "/project.inlang",
+	});
+
+	const inlangId = await project1.id.get();
+
+	const { value: lixId } = await project1.lix.db
+		.selectFrom("key_value")
+		.where("key", "=", "lix_id")
+		.selectAll()
+		.executeTakeFirstOrThrow();
+
+	// the project_id file does not exist on the first load
+	await saveProjectToDirectory({
+		fs: fs.promises as any,
+		path: "/project.inlang",
+		project: project1,
+	});
+
+	const project2 = await loadProjectFromDirectory({
+		fs: fs as any,
+		path: "/project.inlang",
+	});
+
+	const inlangId2 = await project2.id.get();
+
+	const { value: lixId2 } = await project2.lix.db
+		.selectFrom("key_value")
+		.where("key", "=", "lix_id")
+		.selectAll()
+		.executeTakeFirstOrThrow();
+
+	const project3 = await loadProjectFromDirectory({
+		fs: fs as any,
+		path: "/project.inlang",
+	});
+
+	const inlangId3 = await project3.id.get();
+	const { value: lixId3 } = await project3.lix.db
+		.selectFrom("key_value")
+		.where("key", "=", "lix_id")
+		.selectAll()
+		.executeTakeFirstOrThrow();
+
+	expect(inlangId).not.toBeUndefined();
+	expect(inlangId).toBe(inlangId2);
+	expect(inlangId).toBe(inlangId3);
+
+	expect(lixId).not.toBeUndefined();
+	expect(lixId).toBe(lixId2);
+	expect(lixId).toBe(lixId3);
+});

package/src/project/loadProjectFromDirectory.ts

@@ -31,6 +31,22 @@ export async function loadProjectFromDirectory(
 		await args.fs.promises.readFile(settingsPath, "utf8")
 	) as ProjectSettings;
 
+	let inlangId: string | undefined = undefined;
+
+	try {
+		inlangId = await args.fs.promises.readFile(
+			nodePath.join(args.path, "project_id"),
+			"utf8"
+		);
+	} catch {
+		// await args.fs.promises.writeFile(
+		// 	nodePath.join(args.path, "project_id"),
+		// 	,
+		// 	{ encoding: "utf8" }
+		// );
+		// file doesn't exist yet
+	}
+
 	const localImport = await importLocalPlugins({
 		fs: args.fs,
 		settings,
@@ -49,6 +65,10 @@ export async function loadProjectFromDirectory(
 	const project = await loadProjectInMemory({
 		...args,
 		providePlugins: providePluginsWithLocalPlugins,
+		lixKeyValues: inlangId
+			? // reversing the id to have distinguishable lix ids from inlang ids
+				[{ key: "lix_id", value: inlangId }]
+			: undefined,
 		blob: await newProject({
 			settings,
 		}),
@@ -446,9 +466,20 @@ async function syncLixFsFiles(args: {
 				if (lixState.state == "unknown") {
 					// ADD TO FS (6)
 					// create directory if not exists
-					args.fs.mkdirSync(nodePath.dirname(nodePath.join(args.path, path)), {
-						recursive: true,
-					});
+					try {
+						args.fs.mkdirSync(
+							nodePath.dirname(nodePath.join(args.path, path)),
+							{
+								recursive: true,
+							}
+						);
+					} catch (e) {
+						// ignore if directory already exists
+						// https://github.com/opral/inlang-paraglide-js/issues/377
+						if ((e as any)?.code !== "EEXIST") {
+							throw e;
+						}
+					}
 					// write file
 					args.fs.writeFileSync(
 						nodePath.join(args.path, path),

package/src/project/loadProjectInMemory.ts

@@ -1,4 +1,4 @@
-import { openLixInMemory } from "@lix-js/sdk";
+import { openLixInMemory, type NewKeyValue } from "@lix-js/sdk";
 import { createInMemoryDatabase, importDatabase } from "sqlite-wasm-kysely";
 import { loadProject } from "./loadProject.js";
 
@@ -8,11 +8,13 @@ import { loadProject } from "./loadProject.js";
 export async function loadProjectInMemory(
 	args: {
 		blob: Blob;
+		lixKeyValues?: NewKeyValue[];
 	} & Omit<Parameters<typeof loadProject>[0], "sqlite" | "lix">
 ) {
 	const lix = await openLixInMemory({
 		blob: args.blob,
 		account: args.account,
+		keyValues: args.lixKeyValues,
 		providePlugins: [
 			// inlangLixPluginV1
 		],

package/src/project/newProject.test.ts

@@ -1,7 +1,6 @@
 import { expect, test } from "vitest";
 import { defaultProjectSettings, newProject } from "./newProject.js";
 import { loadProjectInMemory } from "./loadProjectInMemory.js";
-import { validate } from "uuid";
 
 test("it should be possible to provide settings for testing or other purposes", async () => {
 	const project = await loadProjectInMemory({
@@ -26,11 +25,20 @@ test("it should be possible to create a project with default settings", async ()
 	expect(settings).toStrictEqual(defaultProjectSettings);
 });
 
-test("it should have a uuid as project id", async () => {
+// for historical reasons, inlang files introduced a project id
+// before lix'es got their own id. having two ids for the same
+// file is not needed anymore.
+test("it should have the lix id as project id", async () => {
 	const project = await loadProjectInMemory({
 		blob: await newProject(),
 	});
+	const { value: lixId } = await project.lix.db
+		.selectFrom("key_value")
+		.select("value")
+		.where("key", "=", "lix_id")
+		.executeTakeFirstOrThrow();
+
 	const projectId = await project.id.get();
 	expect(projectId).toBeDefined();
-	expect(validate(projectId)).toBe(true);
+	expect(projectId).toBe(lixId);
 });

package/src/project/newProject.ts

@@ -1,5 +1,4 @@
 import { newLixFile, openLixInMemory, toBlob } from "@lix-js/sdk";
-import { v4 } from "uuid";
 import type { ProjectSettings } from "../json-schema/settings.js";
 import {
 	contentFromDatabase,
@@ -26,6 +25,12 @@ export async function newProject(args?: {
 
 		const lix = await openLixInMemory({ blob: await newLixFile() });
 
+		const { value: lixId } = await lix.db
+			.selectFrom("key_value")
+			.select("value")
+			.where("key", "=", "lix_id")
+			.executeTakeFirstOrThrow();
+
 		// write files to lix
 		await lix.db
 			.insertInto("file")
@@ -46,7 +51,7 @@ export async function newProject(args?: {
 				},
 				{
 					path: "/project_id",
-					data: new TextEncoder().encode(v4()),
+					data: new TextEncoder().encode(lixId),
 				},
 			])
 			.execute();

package/src/project/saveProjectToDirectory.test.ts

@@ -329,43 +329,43 @@ test("adds a gitignore file if it doesn't exist", async () => {
 	expect(gitignore).toBe("cache");
 });
 
- test("uses exportFiles when both exportFiles and saveMessages are defined", async () => {
-		const exportFilesSpy = vi.fn().mockResolvedValue([]);
-		const saveMessagesSpy = vi.fn();
-		const mockPlugin: InlangPlugin = {
-			key: "mock",
-			exportFiles: exportFilesSpy,
-			saveMessages: saveMessagesSpy,
-		};
-		const volume = Volume.fromJSON({});
-		const project = await loadProjectInMemory({
-			blob: await newProject(),
-			providePlugins: [mockPlugin],
-		});
-		await saveProjectToDirectory({
-			path: "/foo/project.inlang",
-			fs: volume.promises as any,
-			project,
-		});
-		expect(exportFilesSpy).toHaveBeenCalled();
-		expect(saveMessagesSpy).not.toHaveBeenCalled();
- });
+test("uses exportFiles when both exportFiles and saveMessages are defined", async () => {
+	const exportFilesSpy = vi.fn().mockResolvedValue([]);
+	const saveMessagesSpy = vi.fn();
+	const mockPlugin: InlangPlugin = {
+		key: "mock",
+		exportFiles: exportFilesSpy,
+		saveMessages: saveMessagesSpy,
+	};
+	const volume = Volume.fromJSON({});
+	const project = await loadProjectInMemory({
+		blob: await newProject(),
+		providePlugins: [mockPlugin],
+	});
+	await saveProjectToDirectory({
+		path: "/foo/project.inlang",
+		fs: volume.promises as any,
+		project,
+	});
+	expect(exportFilesSpy).toHaveBeenCalled();
+	expect(saveMessagesSpy).not.toHaveBeenCalled();
+});
 
- test("uses saveMessages when exportFiles is not defined", async () => {
-		const saveMessagesSpy = vi.fn().mockResolvedValue([]);
-		const mockPlugin: InlangPlugin = {
-			key: "mock",
-			saveMessages: saveMessagesSpy,
-		};
-		const volume = Volume.fromJSON({});
-		const project = await loadProjectInMemory({
-			blob: await newProject(),
-			providePlugins: [mockPlugin],
-		});
-		await saveProjectToDirectory({
-			path: "/foo/project.inlang",
-			fs: volume.promises as any,
-			project,
-		});
-		expect(saveMessagesSpy).toHaveBeenCalled();
- });
+test("uses saveMessages when exportFiles is not defined", async () => {
+	const saveMessagesSpy = vi.fn().mockResolvedValue([]);
+	const mockPlugin: InlangPlugin = {
+		key: "mock",
+		saveMessages: saveMessagesSpy,
+	};
+	const volume = Volume.fromJSON({});
+	const project = await loadProjectInMemory({
+		blob: await newProject(),
+		providePlugins: [mockPlugin],
+	});
+	await saveProjectToDirectory({
+		path: "/foo/project.inlang",
+		fs: volume.promises as any,
+		project,
+	});
+	expect(saveMessagesSpy).toHaveBeenCalled();
+});