@inlang/sdk 0.8.0 → 0.10.0

package/src/resolve-modules/plugins/resolvePlugins.test.ts

@@ -11,65 +11,98 @@ import {
 	PluginsDoNotProvideLoadOrSaveMessagesError,
 } from "./errors.js"
 import type { Plugin } from "@inlang/plugin"
+import type { ProjectSettings } from "@inlang/project-settings"
+
+it("should return an error if a plugin uses an invalid id", async () => {
+	const mockPlugin: Plugin = {
+		// @ts-expect-error - invalid id
+		id: "no-namespace",
+		description: { en: "My plugin description" },
+		displayName: { en: "My plugin" },
+		loadMessages: () => undefined as any,
+		saveMessages: () => undefined as any,
+	}
+
+	const resolved = await resolvePlugins({
+		plugins: [mockPlugin],
+		settings: {} as any as any,
+		nodeishFs: {} as any,
+	})
 
-describe("generally", () => {
-	it("should return an error if a plugin uses an invalid id", async () => {
-		const mockPlugin: Plugin = {
-			// @ts-expect-error - invalid id
-			id: "no-namespace",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			loadMessages: () => undefined as any,
-			saveMessages: () => undefined as any,
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin],
-			settings: {},
-			nodeishFs: {} as any,
-		})
+	expect(resolved.errors[0]).toBeInstanceOf(PluginHasInvalidIdError)
+})
 
-		expect(resolved.errors[0]).toBeInstanceOf(PluginHasInvalidIdError)
+it("should return an error if a plugin uses APIs that are not available", async () => {
+	const mockPlugin: Plugin = {
+		id: "plugin.namespace.undefinedApi",
+		description: { en: "My plugin description" },
+		displayName: { en: "My plugin" },
+		// @ts-expect-error the key is not available in type
+		nonExistentKey: {
+			nonexistentOptions: "value",
+		},
+		loadMessages: () => undefined as any,
+		saveMessages: () => undefined as any,
+	}
+
+	const resolved = await resolvePlugins({
+		plugins: [mockPlugin],
+		settings: {} as any,
+		nodeishFs: {} as any,
 	})
 
-	it("should return an error if a plugin uses APIs that are not available", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namespace.undefinedApi",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			// @ts-expect-error the key is not available in type
-			nonExistentKey: {
-				nonexistentOptions: "value",
-			},
-			loadMessages: () => undefined as any,
-			saveMessages: () => undefined as any,
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin],
-			settings: {},
-			nodeishFs: {} as any,
-		})
+	expect(resolved.errors[0]).toBeInstanceOf(PluginHasInvalidSchemaError)
+})
 
-		expect(resolved.errors[0]).toBeInstanceOf(PluginHasInvalidSchemaError)
+it("should not initialize a plugin that uses the 'inlang' namespace except for inlang whitelisted plugins", async () => {
+	const mockPlugin: Plugin = {
+		id: "plugin.inlang.notWhitelisted",
+		description: { en: "My plugin description" },
+		displayName: { en: "My plugin" },
+		loadMessages: () => undefined as any,
+	}
+
+	const resolved = await resolvePlugins({
+		plugins: [mockPlugin],
+		settings: {} as any,
+		nodeishFs: {} as any,
 	})
 
-	it("should not initialize a plugin that uses the 'inlang' namespace except for inlang whitelisted plugins", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.inlang.notWhitelisted",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			loadMessages: () => undefined as any,
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin],
-			settings: {},
-			nodeishFs: {} as any,
-		})
+	expect(resolved.errors[0]).toBeInstanceOf(PluginUsesReservedNamespaceError)
+})
 
-		expect(resolved.errors[0]).toBeInstanceOf(PluginUsesReservedNamespaceError)
+it("should expose the project settings including the plugin settings", async () => {
+	const settings: ProjectSettings = {
+		sourceLanguageTag: "en",
+		languageTags: ["en", "de"],
+		modules: [],
+		"plugin.namespace.placeholder": {
+			myPluginSetting: "value",
+		},
+	}
+	const mockPlugin: Plugin = {
+		id: "plugin.namespace.placeholder",
+		description: { en: "My plugin description" },
+		displayName: { en: "My plugin" },
+		saveMessages: async ({ settings }) => {
+			expect(settings).toStrictEqual(settings)
+		},
+		addCustomApi: ({ settings }) => {
+			expect(settings).toStrictEqual(settings)
+			return {}
+		},
+		loadMessages: async ({ settings }) => {
+			expect(settings).toStrictEqual(settings)
+			return []
+		},
+	}
+	const resolved = await resolvePlugins({
+		plugins: [mockPlugin],
+		settings: settings,
+		nodeishFs: {} as any,
 	})
+	await resolved.data.loadMessages!({ settings })
+	await resolved.data.saveMessages!({ settings, messages: [] })
 })
 
 describe("loadMessages", () => {
@@ -83,14 +116,13 @@ describe("loadMessages", () => {
 
 		const resolved = await resolvePlugins({
 			plugins: [mockPlugin],
-			settings: {},
+			settings: {} as any,
 			nodeishFs: {} as any,
 		})
 
 		expect(
 			await resolved.data.loadMessages!({
-				languageTags: ["en"],
-				sourceLanguageTag: "en",
+				settings: {} as any,
 			})
 		).toEqual([{ id: "test", expressions: [], selectors: [], variants: [] }])
 	})
@@ -112,7 +144,7 @@ describe("loadMessages", () => {
 		const resolved = await resolvePlugins({
 			plugins: [mockPlugin, mockPlugin2],
 			nodeishFs: {} as any,
-			settings: {},
+			settings: {} as any,
 		})
 
 		expect(resolved.errors[0]).toBeInstanceOf(PluginLoadMessagesFunctionAlreadyDefinedError)
@@ -129,7 +161,7 @@ describe("loadMessages", () => {
 		const resolved = await resolvePlugins({
 			plugins: [mockPlugin],
 			nodeishFs: {} as any,
-			settings: {},
+			settings: {} as any,
 		})
 
 		expect(resolved.errors).toHaveLength(1)
@@ -150,7 +182,7 @@ describe("saveMessages", () => {
 		const resolved = await resolvePlugins({
 			plugins: [mockPlugin],
 			nodeishFs: {} as any,
-			settings: {},
+			settings: {} as any,
 		})
 
 		expect(resolved.errors).toHaveLength(0)
@@ -173,7 +205,7 @@ describe("saveMessages", () => {
 
 		const resolved = await resolvePlugins({
 			plugins: [mockPlugin, mockPlugin2],
-			settings: {},
+			settings: {} as any,
 			nodeishFs: {} as any,
 		})
 
@@ -191,7 +223,7 @@ describe("saveMessages", () => {
 		const resolved = await resolvePlugins({
 			plugins: [mockPlugin],
 			nodeishFs: {} as any,
-			settings: {},
+			settings: {} as any,
 		})
 		expect(resolved.errors).toHaveLength(1)
 		expect(resolved.errors[0]).toBeInstanceOf(PluginsDoNotProvideLoadOrSaveMessagesError)
@@ -214,7 +246,7 @@ describe("addCustomApi", () => {
 
 		const resolved = await resolvePlugins({
 			plugins: [mockPlugin],
-			settings: {},
+			settings: {} as any,
 			nodeishFs: {} as any,
 		})
 
@@ -249,7 +281,7 @@ describe("addCustomApi", () => {
 
 		const resolved = await resolvePlugins({
 			plugins: [mockPlugin, mockPlugin2],
-			settings: {},
+			settings: {} as any,
 			nodeishFs: {} as any,
 		})
 
@@ -269,7 +301,7 @@ describe("addCustomApi", () => {
 
 		const resolved = await resolvePlugins({
 			plugins: [mockPlugin],
-			settings: {},
+			settings: {} as any,
 			nodeishFs: {} as any,
 		})
 
@@ -292,7 +324,7 @@ describe("addCustomApi", () => {
 
 		const resolved = await resolvePlugins({
 			plugins: [mockPlugin],
-			settings: {},
+			settings: {} as any,
 			nodeishFs: {} as any,
 		})
 

package/src/resolve-modules/plugins/resolvePlugins.ts

@@ -42,56 +42,35 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 		// -- INVALID ID in META --
 		const hasInvalidId = errors.some((error) => error.path === "/id")
 		if (hasInvalidId) {
-			result.errors.push(
-				new PluginHasInvalidIdError(
-					`Plugin ${plugin.id} has an invalid id "${plugin.id}". It must be kebap-case and contain a namespace like project.my-plugin.`,
-					{ plugin: plugin.id }
-				)
-			)
+			result.errors.push(new PluginHasInvalidIdError({ id: plugin.id }))
 		}
 
 		// -- USES RESERVED NAMESPACE --
 		if (plugin.id.includes("inlang") && !whitelistedPlugins.includes(plugin.id)) {
 			result.errors.push(
-				new PluginUsesReservedNamespaceError(
-					`Plugin ${plugin.id} uses reserved namespace 'inlang'.`,
-					{
-						plugin: plugin.id,
-					}
-				)
+				new PluginUsesReservedNamespaceError({
+					id: plugin.id,
+				})
 			)
 		}
 
 		// -- USES INVALID SCHEMA --
 		if (errors.length > 0) {
 			result.errors.push(
-				new PluginHasInvalidSchemaError(
-					`Plugin ${plugin.id} uses an invalid schema. Please check the documentation for the correct Plugin type.`,
-					{
-						plugin: plugin.id,
-						cause: errors,
-					}
-				)
+				new PluginHasInvalidSchemaError({
+					id: plugin.id,
+					errors: errors,
+				})
 			)
 		}
 
 		// -- ALREADY DEFINED LOADMESSAGES / SAVEMESSAGES / DETECTEDLANGUAGETAGS --
 		if (typeof plugin.loadMessages === "function" && result.data.loadMessages !== undefined) {
-			result.errors.push(
-				new PluginLoadMessagesFunctionAlreadyDefinedError(
-					`Plugin ${plugin.id} defines the loadMessages function, but it was already defined by another plugin.`,
-					{ plugin: plugin.id }
-				)
-			)
+			result.errors.push(new PluginLoadMessagesFunctionAlreadyDefinedError({ id: plugin.id }))
 		}
 
 		if (typeof plugin.saveMessages === "function" && result.data.saveMessages !== undefined) {
-			result.errors.push(
-				new PluginSaveMessagesFunctionAlreadyDefinedError(
-					`Plugin ${plugin.id} defines the saveMessages function, but it was already defined by another plugin.`,
-					{ plugin: plugin.id }
-				)
-			)
+			result.errors.push(new PluginSaveMessagesFunctionAlreadyDefinedError({ id: plugin.id }))
 		}
 
 		// --- ADD APP SPECIFIC API ---
@@ -99,20 +78,17 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 			// TODO: why do we call this function 2 times (here for validation and later for retrieving the actual value)?
 			const { data: customApi, error } = tryCatch(() =>
 				plugin.addCustomApi!({
-					settings: args.settings?.[plugin.id] ?? {},
+					settings: args.settings,
 				})
 			)
 			if (error) {
-				// @ts-ignore
-				delete error.stack
-				result.errors.push(error as any) // TODO: add correct error type
-			}
-			if (typeof customApi !== "object") {
+				result.errors.push(new PluginReturnedInvalidCustomApiError({ id: plugin.id, cause: error }))
+			} else if (typeof customApi !== "object") {
 				result.errors.push(
-					new PluginReturnedInvalidCustomApiError(
-						`Plugin ${plugin.id} defines the addCustomApi function, but it does not return an object.`,
-						{ plugin: plugin.id, cause: error }
-					)
+					new PluginReturnedInvalidCustomApiError({
+						id: plugin.id,
+						cause: new Error(`The return value must be an object. Received "${typeof customApi}".`),
+					})
 				)
 			}
 		}
@@ -130,7 +106,6 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 			result.data.loadMessages = (_args) =>
 				plugin.loadMessages!({
 					..._args,
-					settings: args.settings?.[plugin.id] ?? {},
 					nodeishFs: args.nodeishFs,
 				})
 		}
@@ -139,7 +114,6 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 			result.data.saveMessages = (_args) =>
 				plugin.saveMessages!({
 					..._args,
-					settings: args.settings?.[plugin.id] ?? {},
 					nodeishFs: args.nodeishFs,
 				})
 		}
@@ -147,7 +121,7 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 		if (typeof plugin.addCustomApi === "function") {
 			const { data: customApi } = tryCatch(() =>
 				plugin.addCustomApi!({
-					settings: args.settings?.[plugin.id] ?? {},
+					settings: args.settings,
 				})
 			)
 			if (customApi) {
@@ -161,12 +135,7 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 		typeof result.data.loadMessages !== "function" ||
 		typeof result.data.saveMessages !== "function"
 	) {
-		result.errors.push(
-			new PluginsDoNotProvideLoadOrSaveMessagesError(
-				"It seems you did not install any plugin that handles messages. Please add one to make inlang work. See https://inlang.com/documentation/plugins/registry.",
-				{ plugin: undefined }
-			)
-		)
+		result.errors.push(new PluginsDoNotProvideLoadOrSaveMessagesError())
 	}
 
 	return result

package/src/resolve-modules/plugins/types.ts

@@ -1,4 +1,3 @@
-import type { LanguageTag } from "@inlang/language-tag"
 import type { NodeishFilesystem as LisaNodeishFilesystem } from "@lix-js/fs"
 import type {
 	PluginReturnedInvalidCustomApiError,
@@ -10,8 +9,8 @@ import type {
 	PluginsDoNotProvideLoadOrSaveMessagesError,
 } from "./errors.js"
 import type { Message } from "@inlang/message"
-import type { JSONObject } from "@inlang/json-types"
 import type { CustomApiInlangIdeExtension, Plugin } from "@inlang/plugin"
+import type { ProjectSettings } from "@inlang/project-settings"
 
 /**
  * The filesystem is a subset of project lisa's nodeish filesystem.
@@ -28,7 +27,7 @@ export type NodeishFilesystemSubset = Pick<
  */
 export type ResolvePluginsFunction = (args: {
 	plugins: Array<Plugin>
-	settings: Record<Plugin["id"], JSONObject>
+	settings: ProjectSettings
 	nodeishFs: NodeishFilesystemSubset
 }) => Promise<{
 	data: ResolvedPluginApi
@@ -47,11 +46,8 @@ export type ResolvePluginsFunction = (args: {
  * The API after resolving the plugins.
  */
 export type ResolvedPluginApi = {
-	loadMessages: (args: {
-		languageTags: LanguageTag[]
-		sourceLanguageTag: LanguageTag
-	}) => Promise<Message[]> | Message[]
-	saveMessages: (args: { messages: Message[] }) => Promise<void> | void
+	loadMessages: (args: { settings: ProjectSettings }) => Promise<Message[]> | Message[]
+	saveMessages: (args: { settings: ProjectSettings; messages: Message[] }) => Promise<void> | void
 	/**
 	 * App specific APIs.
 	 *

package/src/resolve-modules/resolveModules.test.ts

@@ -23,7 +23,7 @@ it("should return an error if a plugin cannot be imported", async () => {
 		settings,
 		nodeishFs: {} as any,
 		_import: () => {
-			throw new ModuleImportError("Could not import", {
+			throw new ModuleImportError({
 				module: settings.modules[0]!,
 				cause: new Error("Could not import"),
 			})
@@ -94,7 +94,7 @@ it("should return an error if a module cannot be imported", async () => {
 	}
 
 	const _import = async () => {
-		throw new ModuleImportError("Could not import", {
+		throw new ModuleImportError({
 			module: settings.modules[0]!,
 			cause: new Error(),
 		})

package/src/resolve-modules/resolveModules.ts

@@ -35,7 +35,7 @@ export const resolveModules: ResolveModuleFunction = async (args) => {
 		// -- IMPORT MODULE --
 		if (importedModule.error) {
 			moduleErrors.push(
-				new ModuleImportError(`Couldn't import the plugin "${module}"`, {
+				new ModuleImportError({
 					module: module,
 					cause: importedModule.error as Error,
 				})
@@ -46,7 +46,7 @@ export const resolveModules: ResolveModuleFunction = async (args) => {
 		// -- MODULE DOES NOT EXPORT ANYTHING --
 		if (importedModule.data?.default === undefined) {
 			moduleErrors.push(
-				new ModuleHasNoExportsError(`Module "${module}" has no exports.`, {
+				new ModuleHasNoExportsError({
 					module: module,
 				})
 			)
@@ -56,12 +56,11 @@ export const resolveModules: ResolveModuleFunction = async (args) => {
 		const isValidModule = ModuleCompiler.Check(importedModule.data)
 
 		if (isValidModule === false) {
-			const errors = [...ModuleCompiler.Errors(importedModule.data)].map(
-				(e) => `${e.path} ${e.message}`
-			)
+			const errors = [...ModuleCompiler.Errors(importedModule.data)]
 			moduleErrors.push(
-				new ModuleExportIsInvalidError(`Module "${module}" is invalid: ` + errors.join("\n"), {
+				new ModuleExportIsInvalidError({
 					module: module,
+					errors,
 				})
 			)
 			continue