@inlang/sdk 2.0.0 → 2.0.1

package/src/json-schema/settings.test.ts

@@ -0,0 +1,26 @@
+import { TypeCompiler } from "@sinclair/typebox/compiler";
+import { ProjectSettings } from "./settings.js";
+import { test, expect } from "vitest";
+
+const C = TypeCompiler.Compile(ProjectSettings);
+
+test("valid settings file", () => {
+	const settings: ProjectSettings = {
+		baseLocale: "en",
+		locales: ["en", "de"],
+		modules: [
+			"https://cdn.jsdelivr.net/npm/@inlang/plugin-i18next@3/dist/index.js",
+			"https://cdn.jsdelivr.net/npm/@inlang/plugin-csv@1/dist/index.js",
+		],
+		"plugin.something": {
+			key: "value",
+			nested: {
+				moreNested: {},
+			},
+		},
+	};
+
+	const errors = [...C.Errors(settings)];
+
+	expect(errors).toEqual([]);
+});

package/src/json-schema/settings.ts

@@ -1,9 +1,4 @@
-import {
-	type Static,
-	Type,
-	type TTemplateLiteral,
-	type TLiteral,
-} from "@sinclair/typebox";
+import { type Static, Type } from "@sinclair/typebox";
 
 const SDKSettings = Type.Object({
 	// TODO SDK-v2 SETTINGS do we need to generate a settings v2 schema?
@@ -59,10 +54,6 @@ const SDKSettings = Type.Object({
 					description: "The module must end with `.js`.",
 					pattern: ".*\\.js$",
 				}),
-				Type.String({
-					description: "The module can only contain a major version number.",
-					pattern: "^(?!.*@\\d\\.)[^]*$",
-				}),
 			]),
 			{
 				uniqueItems: true,
@@ -100,30 +91,6 @@ const SDKSettings = Type.Object({
 	 */
 });
 
-/**
- * Settings defined via apps, plugins, lint rules, etc.
- *
- * Using external settings to only allow `plugin.*` keys
- * and don't block the SDK from adding new settings.
- */
-const ExternalSettings = Type.Record(
-	Type.String({
-		pattern: `^((plugin)\\.([a-z][a-zA-Z0-9]*(?:[A-Z][a-z0-9]*)*)|\\$schema|${
-			// pattern must include the settings properties
-			Object.keys(SDKSettings.properties)
-				.map((key) => key.replaceAll(".", "\\."))
-				.join("|")
-		})$`,
-		description: "The key must be conform to `plugin.*`.",
-		examples: ["plugin.csv-importer", "plugin.i18next"],
-	}) as unknown as TTemplateLiteral<[TLiteral<`${"plugin"}.${string}`>]>,
-	// Using JSON (array and object) as a workaround to make the
-	// intersection between `InternalSettings`, which contains an array,
-	// and `ExternalSettings` which are objects possible
-	Type.Record(Type.String(), Type.Any()),
-	{ description: "Settings defined by apps, plugins, etc." }
-);
-
 export type ProjectSettings = Omit<
 	Static<typeof ProjectSettings>,
 	"languageTags" | "sourceLanguageTag"
@@ -134,5 +101,5 @@ export type ProjectSettings = Omit<
 	languageTags?: string[];
 	/** @deprecated This will soon be replaced by `Lix Validation Rules` */
 	messageLintRuleLevels?: Record<string, "error" | "warning">;
-};
-export const ProjectSettings = Type.Intersect([SDKSettings, ExternalSettings]);
+} & Record<string, any>;
+export const ProjectSettings = SDKSettings;

package/src/plugin/importPlugins.test.ts

@@ -22,7 +22,6 @@ test("it should preprocess a plugin", async () => {
 		},
 	});
 
-	expect(global.fetch).toHaveBeenCalledTimes(1);
 	expect(result.plugins.length).toBe(1);
 	expect(result.errors.length).toBe(0);
 	expect(result.plugins[0]?.key).toBe("preprocessed");

package/src/project/loadProjectFromDirectory.test.ts

@@ -658,7 +658,6 @@ test("it should pass toBeImportedMetadata on import", async () => {
 		expect.objectContaining({
 			files: [
 				expect.objectContaining({
-					name: "en.json",
 					toBeImportedFilesMetadata: {
 						foo: "bar",
 					},
@@ -852,3 +851,72 @@ test("it can import plugins via http", async () => {
 		"expecting the plugin to be cached"
 	).toBe(true);
 });
+
+test("plugins that provide both loadMessages and importFiles should be allowed and the importFiles should be called", async () => {
+	const mockRepo = {
+		"/project.inlang/settings.json": JSON.stringify({
+			baseLocale: "en",
+			locales: ["en"],
+			modules: [],
+		} satisfies ProjectSettings),
+	};
+
+	const fs = Volume.fromJSON(mockRepo);
+
+	const mockPlugin: InlangPlugin = {
+		key: "mock-plugin",
+		loadMessages: vi.fn(async () => []),
+		importFiles: vi.fn(async () => {
+			return { bundles: [], messages: [], variants: [] };
+		}),
+	};
+
+	const project = await loadProjectFromDirectory({
+		fs: fs as any,
+		path: "/project.inlang",
+		providePlugins: [mockPlugin],
+	});
+
+	expect(mockPlugin.importFiles).toHaveBeenCalled();
+	expect(mockPlugin.loadMessages).not.toHaveBeenCalled();
+});
+
+test("providing multiple plugins that have legacy loadMessages and saveMessages function should be possible if they have import/export functions", async () => {
+	const mockRepo = {
+		"/project.inlang/settings.json": JSON.stringify({
+			baseLocale: "en",
+			locales: ["en"],
+			modules: [],
+		} satisfies ProjectSettings),
+	};
+
+	const fs = Volume.fromJSON(mockRepo);
+
+	const mockPlugin1: InlangPlugin = {
+		key: "mock-plugin1",
+		loadMessages: vi.fn(async () => []),
+		importFiles: vi.fn(async () => {
+			return { bundles: [], messages: [], variants: [] };
+		}),
+	};
+
+	const mockPlugin2: InlangPlugin = {
+		key: "mock-plugin2",
+		loadMessages: vi.fn(async () => []),
+		importFiles: vi.fn(async () => {
+			return { bundles: [], messages: [], variants: [] };
+		}),
+	};
+
+	const project = await loadProjectFromDirectory({
+		fs: fs as any,
+		path: "/project.inlang",
+		providePlugins: [mockPlugin1, mockPlugin2],
+	});
+
+	expect(mockPlugin1.importFiles).toHaveBeenCalled();
+	expect(mockPlugin1.loadMessages).not.toHaveBeenCalled();
+
+	expect(mockPlugin2.importFiles).toHaveBeenCalled();
+	expect(mockPlugin2.loadMessages).not.toHaveBeenCalled();
+});

package/src/project/loadProjectFromDirectory.ts

@@ -1,9 +1,7 @@
 import { newProject } from "./newProject.js";
 import { loadProjectInMemory } from "./loadProjectInMemory.js";
 import { type Lix } from "@lix-js/sdk";
-
 import fs from "node:fs";
-
 import nodePath from "node:path";
 import type {
 	InlangPlugin,
@@ -14,6 +12,7 @@ import type { ProjectSettings } from "../json-schema/settings.js";
 import type { PreprocessPluginBeforeImportFunction } from "../plugin/importPlugins.js";
 import { PluginImportError } from "../plugin/errors.js";
 import { upsertBundleNestedMatchByProperties } from "../import-export/upsertBundleNestedMatchByProperties.js";
+import type { ImportFile } from "./api.js";
 
 /**
  * Loads a project from a directory.
@@ -62,69 +61,39 @@ export async function loadProjectFromDirectory(
 		syncInterval: args.syncInterval,
 	});
 
-	const {
-		loadMessagesPlugins,
-		saveMessagesPlugins,
-		importPlugins,
-		exportPlugins,
-	} = categorizePlugins(await project.plugins.get());
+	const allPlugins = await project.plugins.get();
+	const { loadSavePlugins, importExportPlugins } =
+		categorizePlugins(allPlugins);
 
 	// TODO i guess we should move this validation logic into sdk2/src/project/loadProject.ts
 	// Two scenarios could arise:
 	// 1. set settings is called from an app - it should detect and reject the setting of settings -> app need to be able to validate before calling set
 	// 2. the settings file loaded from disc here is corrupted -> user has to fix the file on disc
-	if (loadMessagesPlugins.length > 1 || saveMessagesPlugins.length > 1) {
+	if (loadSavePlugins.length > 1) {
 		throw new Error(
 			"Max one loadMessages (found: " +
-				loadMessagesPlugins.length +
+				loadSavePlugins.length +
 				") and one saveMessages plugins (found: " +
-				saveMessagesPlugins.length +
+				loadSavePlugins.length +
 				") are allowed "
 		);
 	}
 	const importedResourceFileErrors: Error[] = [];
 
-	if (
-		(loadMessagesPlugins.length > 0 || saveMessagesPlugins.length > 0) &&
-		(exportPlugins.length > 0 || importPlugins.length > 0)
-	) {
-		throw new Error(
-			"Plugins for loadMessages (found: " +
-				loadMessagesPlugins.length +
-				") and saveMessages plugins (found: " +
-				saveMessagesPlugins.length +
-				") must not coexist with import (found: " +
-				importPlugins.length +
-				") or export (found: " +
-				exportPlugins.length +
-				") "
-		);
-	} else if (loadMessagesPlugins.length > 1 || saveMessagesPlugins.length > 1) {
-		throw new Error(
-			"Max one loadMessages (found: " +
-				loadMessagesPlugins.length +
-				") and one saveMessages plugins (found: " +
-				saveMessagesPlugins.length +
-				") are allowed "
-		);
-	} else if (importPlugins[0]) {
-		const importer = importPlugins[0];
-		const files = [];
-
-		if (importer.toBeImportedFiles) {
-			const toBeImportedFiles = await importer.toBeImportedFiles({
+	// import files from local fs
+	for (const plugin of importExportPlugins) {
+		const files: ImportFile[] = [];
+		if (plugin.toBeImportedFiles) {
+			const toBeImportedFiles = await plugin.toBeImportedFiles({
 				settings: await project.settings.get(),
 			});
 			for (const toBeImported of toBeImportedFiles) {
 				const absolute = absolutePathFromProject(args.path, toBeImported.path);
 				try {
 					const data = await args.fs.promises.readFile(absolute);
-					const name = nodePath.basename(toBeImported.path);
 					files.push({
-						name,
 						locale: toBeImported.locale,
 						content: data,
-						pluginKey: importer.key,
 						toBeImportedFilesMetadata: toBeImported.metadata,
 					});
 				} catch (e) {
@@ -143,17 +112,18 @@ export async function loadProjectFromDirectory(
 		}
 
 		await project.importFiles({
-			pluginKey: importer.key,
-			files: files as any,
+			pluginKey: plugin.key,
+			files,
 		});
-	} else if (loadMessagesPlugins[0] !== undefined) {
-		// TODO create resource files from loadMessageFn call - to poll?
+	}
+
+	for (const plugin of loadSavePlugins) {
 		await loadLegacyMessages({
 			project,
+			pluginKey: plugin.key ?? plugin.id,
+			loadMessagesFn: plugin.loadMessages!,
 			projectPath: args.path,
 			fs: args.fs,
-			pluginKey: loadMessagesPlugins[0].key ?? loadMessagesPlugins[0].id,
-			loadMessagesFn: loadMessagesPlugins[0].loadMessages,
 		});
 	}
 
@@ -569,9 +539,14 @@ async function upsertFileInLix(
 	path: string,
 	data: ArrayBuffer
 ) {
-	// file is in known state with lix - means we have only changes on the fs - easy
-	// NOTE we use file_internal for now see: https://linear.app/opral/issue/LIXDK-102/re-visit-simplifying-the-change-queue-implementation#comment-65eb3485
-	// This means we don't see changes for the file we update via this method!
+	// force posix path when upserting into lix
+	// https://github.com/opral/inlang-sdk/issues/229
+	let posixPath = path.split(nodePath.win32.sep).join(nodePath.posix.sep);
+
+	if (posixPath.startsWith("/") === false) {
+		posixPath = "/" + posixPath;
+	}
+
 	await args.lix.db
 		.insertInto("file") // change queue
 		.values({
@@ -583,52 +558,28 @@ async function upsertFileInLix(
 		)
 		.execute();
 }
+/**
+ * Filters legacy load and save messages plugins.
+ *
+ * Legacy plugins are plugins that implement loadMessages and saveMessages but not importFiles and exportFiles.
+ */
+function categorizePlugins(plugins: readonly InlangPlugin[]) {
+	const loadSavePlugins: InlangPlugin[] = [];
+	const importExportPlugins: InlangPlugin[] = [];
+
+	for (const plugin of plugins) {
+		if (
+			plugin.loadMessages &&
+			plugin.saveMessages &&
+			!(plugin.importFiles && plugin.exportFiles)
+		) {
+			loadSavePlugins.push(plugin);
+		} else if (plugin.importFiles || plugin.exportFiles) {
+			importExportPlugins.push(plugin);
+		}
+	}
 
-// TODO i guess we should move this validation logic into sdk2/src/project/loadProject.ts
-function categorizePlugins(plugins: readonly InlangPlugin[]): {
-	loadMessagesPlugins: (InlangPlugin &
-		Required<Pick<InlangPlugin, "loadMessages">>)[];
-	saveMessagesPlugins: (InlangPlugin &
-		Required<Pick<InlangPlugin, "saveMessages">>)[];
-	importPlugins: (InlangPlugin &
-		Required<Pick<InlangPlugin, "importFiles" | "toBeImportedFiles">>)[];
-	exportPlugins: (InlangPlugin & Required<Pick<InlangPlugin, "exportFiles">>)[];
-} {
-	const loadMessagesPlugins = plugins.filter(
-		(
-			plugin
-		): plugin is InlangPlugin & Required<Pick<InlangPlugin, "loadMessages">> =>
-			plugin.loadMessages !== undefined
-	);
-
-	const saveMessagesPlugins = plugins.filter(
-		(
-			plugin
-		): plugin is InlangPlugin & Required<Pick<InlangPlugin, "saveMessages">> =>
-			plugin.saveMessages !== undefined
-	);
-
-	const importPlugins = plugins.filter(
-		(
-			plugin
-		): plugin is InlangPlugin &
-			Required<Pick<InlangPlugin, "importFiles" | "toBeImportedFiles">> =>
-			plugin.importFiles !== undefined && plugin.toBeImportedFiles !== undefined
-	);
-
-	const exportPlugins = plugins.filter(
-		(
-			plugin
-		): plugin is InlangPlugin & Required<Pick<InlangPlugin, "exportFiles">> =>
-			plugin.exportFiles !== undefined
-	);
-
-	return {
-		loadMessagesPlugins,
-		saveMessagesPlugins,
-		importPlugins,
-		exportPlugins,
-	};
+	return { loadSavePlugins, importExportPlugins };
 }
 
 /**