@inlang/sdk 0.3.0 → 0.5.0

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

@@ -41,23 +41,23 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 		 */
 
 		// -- INVALID ID in META --
-		const hasInvalidId = errors.some((error) => error.path === "/meta/id")
+		const hasInvalidId = errors.some((error) => error.path === "/id")
 		if (hasInvalidId) {
 			result.errors.push(
 				new PluginHasInvalidIdError(
-					`Plugin ${plugin.meta.id} has an invalid id "${plugin.meta.id}". It must be kebap-case and contain a namespace like project.my-plugin.`,
-					{ plugin: plugin.meta.id },
+					`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 },
 				),
 			)
 		}
 
 		// -- USES RESERVED NAMESPACE --
-		if (plugin.meta.id.includes("inlang") && !whitelistedPlugins.includes(plugin.meta.id)) {
+		if (plugin.id.includes("inlang") && !whitelistedPlugins.includes(plugin.id)) {
 			result.errors.push(
 				new PluginUsesReservedNamespaceError(
-					`Plugin ${plugin.meta.id} uses reserved namespace 'inlang'.`,
+					`Plugin ${plugin.id} uses reserved namespace 'inlang'.`,
 					{
-						plugin: plugin.meta.id,
+						plugin: plugin.id,
 					},
 				),
 			)
@@ -67,9 +67,9 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 		if (errors.length > 0) {
 			result.errors.push(
 				new PluginHasInvalidSchemaError(
-					`Plugin ${plugin.meta.id} uses an invalid schema. Please check the documentation for the correct Plugin type.`,
+					`Plugin ${plugin.id} uses an invalid schema. Please check the documentation for the correct Plugin type.`,
 					{
-						plugin: plugin.meta.id,
+						plugin: plugin.id,
 						cause: errors,
 					},
 				),
@@ -80,8 +80,8 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 		if (typeof plugin.loadMessages === "function" && result.data.loadMessages !== undefined) {
 			result.errors.push(
 				new PluginLoadMessagesFunctionAlreadyDefinedError(
-					`Plugin ${plugin.meta.id} defines the loadMessages function, but it was already defined by another plugin.`,
-					{ plugin: plugin.meta.id },
+					`Plugin ${plugin.id} defines the loadMessages function, but it was already defined by another plugin.`,
+					{ plugin: plugin.id },
 				),
 			)
 		}
@@ -89,8 +89,8 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 		if (typeof plugin.saveMessages === "function" && result.data.saveMessages !== undefined) {
 			result.errors.push(
 				new PluginSaveMessagesFunctionAlreadyDefinedError(
-					`Plugin ${plugin.meta.id} defines the saveMessages function, but it was already defined by another plugin.`,
-					{ plugin: plugin.meta.id },
+					`Plugin ${plugin.id} defines the saveMessages function, but it was already defined by another plugin.`,
+					{ plugin: plugin.id },
 				),
 			)
 		}
@@ -100,7 +100,7 @@ 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.meta.id] ?? {},
+					settings: args.settings?.[plugin.id] ?? {},
 				}),
 			)
 			if (error) {
@@ -111,8 +111,8 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 			if (typeof customApi !== "object") {
 				result.errors.push(
 					new PluginReturnedInvalidCustomApiError(
-						`Plugin ${plugin.meta.id} defines the addCustomApi function, but it does not return an object.`,
-						{ plugin: plugin.meta.id, cause: error },
+						`Plugin ${plugin.id} defines the addCustomApi function, but it does not return an object.`,
+						{ plugin: plugin.id, cause: error },
 					),
 				)
 			}
@@ -131,7 +131,7 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 			result.data.loadMessages = (_args) =>
 				plugin.loadMessages!({
 					..._args,
-					settings: args.settings?.[plugin.meta.id] ?? {},
+					settings: args.settings?.[plugin.id] ?? {},
 					nodeishFs: args.nodeishFs,
 				})
 		}
@@ -140,14 +140,14 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 			result.data.saveMessages = (_args) =>
 				plugin.saveMessages!({
 					..._args,
-					settings: args.settings?.[plugin.meta.id] ?? {},
+					settings: args.settings?.[plugin.id] ?? {},
 					nodeishFs: args.nodeishFs,
 				})
 		}
 
 		if (typeof plugin.detectedLanguageTags === "function") {
 			const detectedLangugeTags = await plugin.detectedLanguageTags!({
-				settings: args.settings?.[plugin.meta.id] ?? {},
+				settings: args.settings?.[plugin.id] ?? {},
 				nodeishFs: args.nodeishFs,
 			})
 			result.data.detectedLanguageTags = [
@@ -158,7 +158,7 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 		if (typeof plugin.addCustomApi === "function") {
 			const { data: customApi } = tryCatch(() =>
 				plugin.addCustomApi!({
-					settings: args.settings?.[plugin.meta.id] ?? {},
+					settings: args.settings?.[plugin.id] ?? {},
 				}),
 			)
 			if (customApi) {

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

@@ -1,4 +1,4 @@
-import { ProjectConfig } from "@inlang/project-config"
+import { ProjectSettings } from "@inlang/project-settings"
 import { Value } from "@sinclair/typebox/value"
 import { describe, test, expect } from "vitest"
 import { expectType } from "tsd"
@@ -6,14 +6,12 @@ import { Plugin } from "@inlang/plugin"
 
 describe("Plugin", () => {
 	test("meta.id should enforce plugin.namespace.* patterns", () => {
-		expectType<`plugin.${string}.${string}`>("" as Plugin["meta"]["id"])
+		expectType<`plugin.${string}.${string}`>("" as Plugin["id"])
 
 		const mockPlugin: Plugin = {
-			meta: {
-				id: "plugin.namespace.placeholder",
-				displayName: { en: "" },
-				description: { en: "" },
-			},
+			id: "plugin.namespace.placeholder",
+			displayName: { en: "" },
+			description: { en: "" },
 		}
 
 		const passCases = ["plugin.namespace.helloWorld", "plugin.namespace.i18n"]
@@ -24,34 +22,32 @@ describe("Plugin", () => {
 		]
 
 		for (const pass of passCases) {
-			mockPlugin.meta.id = pass as any
+			mockPlugin.id = pass as any
 
 			// @ts-ignore - type mismatch error. fix after refactor
 			expect(Value.Check(Plugin, mockPlugin)).toBe(true)
 		}
 
 		for (const fail of failCases) {
-			mockPlugin.meta.id = fail as any
+			mockPlugin.id = fail as any
 			// @ts-ignore - type mismatch error. fix after refactor
 			expect(Value.Check(Plugin, mockPlugin)).toBe(false)
 		}
 	})
 
 	test("meta.id should be a valid inlang.config.setting key", () => {
-		const mockConfig: ProjectConfig = {
+		const settings: ProjectSettings = {
 			sourceLanguageTag: "en",
 			languageTags: ["en", "de"],
 			modules: [],
-			settings: {},
 		}
 		const cases = ["plugin.namespace.helloWorld", "plugin.namespace.i18n"]
 
 		for (const _case of cases) {
-			const config = { ...mockConfig, settings: { [_case]: {} } }
+			const mergedSettings = { ...settings, [_case]: {} }
+			expect(Value.Check(ProjectSettings, mergedSettings)).toBe(true)
 			// @ts-ignore - type mismatch error. fix after refactor
-			expect(Value.Check(ProjectConfig, config)).toBe(true)
-			// @ts-ignore - type mismatch error. fix after refactor
-			expect(Value.Check(Plugin["properties"]["meta"]["properties"]["id"], _case)).toBe(true)
+			expect(Value.Check(Plugin["properties"]["id"], _case)).toBe(true)
 		}
 	})
 })

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

@@ -28,7 +28,7 @@ export type NodeishFilesystemSubset = Pick<
  */
 export type ResolvePluginsFunction = (args: {
 	plugins: Array<Plugin>
-	settings: Record<Plugin["meta"]["id"], JSONObject>
+	settings: Record<Plugin["id"], JSONObject>
 	nodeishFs: NodeishFilesystemSubset
 }) => Promise<{
 	data: ResolvedPluginApi

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

@@ -9,23 +9,22 @@ import {
 	ModuleImportError,
 } from "./errors.js"
 import { resolveModules } from "./resolveModules.js"
-import type { ProjectConfig } from "@inlang/project-config"
+import type { ProjectSettings } from "@inlang/project-settings"
 import type { InlangModule } from "@inlang/module"
 
 it("should return an error if a plugin cannot be imported", async () => {
-	const config: ProjectConfig = {
+	const settings: ProjectSettings = {
 		sourceLanguageTag: "en",
 		languageTags: ["de", "en"],
 		modules: ["https://myplugin.com/index.js"],
-		settings: {},
 	}
 
 	const resolved = await resolveModules({
-		config,
+		settings,
 		nodeishFs: {} as any,
 		_import: () => {
 			throw new ModuleImportError("Could not import", {
-				module: config.modules[0]!,
+				module: settings.modules[0]!,
 				cause: new Error("Could not import"),
 			})
 		},
@@ -37,11 +36,9 @@ it("should return an error if a plugin cannot be imported", async () => {
 it("should resolve plugins and message lint rules successfully", async () => {
 	// Define mock data
 	const mockPlugin: Plugin = {
-		meta: {
-			id: "plugin.namespace.mock",
-			description: { en: "Mock plugin description" },
-			displayName: { en: "Mock Plugin" },
-		},
+		id: "plugin.namespace.mock",
+		description: { en: "Mock plugin description" },
+		displayName: { en: "Mock Plugin" },
 		loadMessages: () => undefined as any,
 		saveMessages: () => undefined as any,
 		addCustomApi: () => ({
@@ -52,19 +49,16 @@ it("should resolve plugins and message lint rules successfully", async () => {
 	}
 
 	const mockMessageLintRule: MessageLintRule = {
-		meta: {
-			id: "messageLintRule.namespace.mock",
-			description: { en: "Mock lint rule description" },
-			displayName: { en: "Mock Lint Rule" },
-		},
-		message: () => undefined,
+		id: "messageLintRule.namespace.mock",
+		description: { en: "Mock lint rule description" },
+		displayName: { en: "Mock Lint Rule" },
+		run: () => undefined,
 	}
 
-	const config: ProjectConfig = {
+	const settings: ProjectSettings = {
 		sourceLanguageTag: "en",
 		languageTags: ["de", "en"],
 		modules: ["lint-rule.js", "plugin.js"],
-		settings: {},
 	}
 
 	const _import = async (name: string) => {
@@ -80,88 +74,80 @@ it("should resolve plugins and message lint rules successfully", async () => {
 	}
 
 	// Call the function
-	const resolved = await resolveModules({ config, _import, nodeishFs: {} as any })
+	const resolved = await resolveModules({ settings, _import, nodeishFs: {} as any })
 
 	// Assert results
 	expect(resolved.errors).toHaveLength(0)
 	// Check for the meta data of the plugin
-	expect(resolved.plugins.some((module) => module.meta.id === mockPlugin.meta.id)).toBeDefined()
+	expect(resolved.plugins.some((module) => module.id === mockPlugin.id)).toBeDefined()
 	// Check for the app specific api
 	expect(resolved.resolvedPluginApi["customApi"]?.["app.inlang.ideExtension"]).toBeDefined()
 	// Check for the lint rule
-	expect(resolved.messageLintRules[0]?.meta.id).toBe(mockMessageLintRule.meta.id)
+	expect(resolved.messageLintRules[0]?.id).toBe(mockMessageLintRule.id)
 })
 
 it("should return an error if a module cannot be imported", async () => {
-	const config: ProjectConfig = {
+	const settings: ProjectSettings = {
 		sourceLanguageTag: "en",
 		languageTags: ["de", "en"],
 		modules: ["https://myplugin.com/index.js"],
-		settings: {},
 	}
 
 	const _import = async () => {
 		throw new ModuleImportError("Could not import", {
-			module: config.modules[0]!,
+			module: settings.modules[0]!,
 			cause: new Error(),
 		})
 	}
 
 	// Call the function
-	const resolved = await resolveModules({ config, _import, nodeishFs: {} as any })
+	const resolved = await resolveModules({ settings, _import, nodeishFs: {} as any })
 
 	// Assert results
 	expect(resolved.errors[0]).toBeInstanceOf(ModuleImportError)
 })
 
-it("should return an error if a module does not export any plugins or lint rules", async () => {
-	const config: ProjectConfig = {
+it("should return an error if a module does not export anything", async () => {
+	const settings: ProjectSettings = {
 		sourceLanguageTag: "en",
 		languageTags: ["de", "en"],
 		modules: ["https://myplugin.com/index.js"],
-		settings: {},
 	}
 
-	const _import = async () => ({
-		default: {},
-	})
+	const _import = async () => ({})
 
 	// Call the function
-	const resolved = await resolveModules({ config, _import, nodeishFs: {} as any })
+	const resolved = await resolveModules({ settings, _import, nodeishFs: {} as any })
 
 	// Assert results
 	expect(resolved.errors[0]).toBeInstanceOf(ModuleHasNoExportsError)
 })
 
 it("should return an error if a module exports an invalid plugin or lint rule", async () => {
-	const config: ProjectConfig = {
+	const settings: ProjectSettings = {
 		sourceLanguageTag: "en",
 		languageTags: ["de", "en"],
 		modules: ["https://myplugin.com/index.js"],
-		settings: {},
 	}
 	const _import = async () =>
 		({
+			// @ts-expect-error - invalid meta of a plugin
 			default: {
-				// @ts-expect-error - invalid meta of a plugin
-				meta: {
-					id: "plugin.namespace.mock",
-					description: { en: "Mock plugin description" },
-				},
+				id: "plugin.namespace.mock",
+				description: { en: "Mock plugin description" },
 			},
 		} satisfies InlangModule)
 
-	const resolved = await resolveModules({ config, _import, nodeishFs: {} as any })
+	const resolved = await resolveModules({ settings, _import, nodeishFs: {} as any })
 	expect(resolved.errors[0]).toBeInstanceOf(ModuleExportIsInvalidError)
 })
 
 it("should handle other unhandled errors during plugin resolution", async () => {
 	const errorMessage = "Unhandled error during plugin resolution"
-	const config: ProjectConfig = {
+	const settings: ProjectSettings = {
 		sourceLanguageTag: "en",
 		languageTags: ["de", "en"],
 		modules: ["https://myplugin.com/index.js"],
-		settings: {},
 	}
 
 	const _import = async () => {
@@ -169,7 +155,7 @@ it("should handle other unhandled errors during plugin resolution", async () =>
 	}
 
 	// Call the function
-	const resolved = await resolveModules({ config, _import, nodeishFs: {} as any })
+	const resolved = await resolveModules({ settings, _import, nodeishFs: {} as any })
 
 	// Assert results
 	expect(resolved.errors[0]).toBeInstanceOf(ModuleError)

package/src/resolve-modules/resolveModules.ts

@@ -25,7 +25,7 @@ export const resolveModules: ResolveModuleFunction = async (args) => {
 
 	const meta: Awaited<ReturnType<ResolveModuleFunction>>["meta"] = []
 
-	for (const module of args.config.modules) {
+	for (const module of args.settings.modules) {
 		/**
 		 * -------------- BEGIN SETUP --------------
 		 */
@@ -43,8 +43,8 @@ export const resolveModules: ResolveModuleFunction = async (args) => {
 			continue
 		}
 
-		// -- MODULE DOES NOT EXPORT PLUGINS OR LINT RULES --
-		if (importedModule.data?.default?.meta?.id === undefined) {
+		// -- MODULE DOES NOT EXPORT ANYTHING --
+		if (importedModule.data?.default === undefined) {
 			moduleErrors.push(
 				new ModuleHasNoExportsError(`Module "${module}" has no exports.`, {
 					module: module,
@@ -56,9 +56,11 @@ export const resolveModules: ResolveModuleFunction = async (args) => {
 		const isValidModule = ModuleCompiler.Check(importedModule.data)
 
 		if (isValidModule === false) {
-			const errors = [...ModuleCompiler.Errors(importedModule.data)]
+			const errors = [...ModuleCompiler.Errors(importedModule.data)].map(
+				(e) => `${e.path} ${e.message}`,
+			)
 			moduleErrors.push(
-				new ModuleExportIsInvalidError(`Module "${module}" is invalid: ` + errors, {
+				new ModuleExportIsInvalidError(`Module "${module}" is invalid: ` + errors.join("\n"), {
 					module: module,
 				}),
 			)
@@ -67,12 +69,12 @@ export const resolveModules: ResolveModuleFunction = async (args) => {
 
 		meta.push({
 			module: module,
-			id: importedModule.data.default.meta.id,
+			id: importedModule.data.default.id,
 		})
 
-		if (importedModule.data.default.meta.id.startsWith("plugin.")) {
+		if (importedModule.data.default.id.startsWith("plugin.")) {
 			allPlugins.push(importedModule.data.default as Plugin)
-		} else if (importedModule.data.default.meta.id.startsWith("messageLintRule.")) {
+		} else if (importedModule.data.default.id.startsWith("messageLintRule.")) {
 			allMessageLintRules.push(importedModule.data.default as MessageLintRule)
 		} else {
 			throw new Error(`Unimplemented module type. Must start with "plugin." or "messageLintRule.`)
@@ -81,7 +83,7 @@ export const resolveModules: ResolveModuleFunction = async (args) => {
 
 	const resolvedPlugins = await resolvePlugins({
 		plugins: allPlugins,
-		settings: args.config.settings,
+		settings: args.settings,
 		nodeishFs: args.nodeishFs,
 	})
 

package/src/resolve-modules/types.ts

@@ -1,4 +1,4 @@
-import type { ProjectConfig } from "@inlang/project-config"
+import type { ProjectSettings } from "@inlang/project-settings"
 import type { MessageLintRule } from "@inlang/message-lint-rule"
 import type { Plugin } from "@inlang/plugin"
 import type {
@@ -16,7 +16,7 @@ import type { resolveMessageLintRules } from "./message-lint-rules/resolveMessag
  * Pass a custom `_import` function to override the default import function.
  */
 export type ResolveModuleFunction = (args: {
-	config: ProjectConfig
+	settings: ProjectSettings
 	nodeishFs: NodeishFilesystemSubset
 	_import?: ImportFunction
 }) => Promise<{
@@ -39,7 +39,7 @@ export type ResolveModuleFunction = (args: {
 		/**
 		 * The resolved item id of the module.
 		 */
-		id: Plugin["meta"]["id"] | MessageLintRule["meta"]["id"]
+		id: Plugin["id"] | MessageLintRule["id"]
 	}>
 	/**
 	 * The resolved plugins.

package/src/versionedInterfaces.ts

@@ -5,5 +5,5 @@ export * from "@inlang/language-tag"
 export * from "@inlang/message-lint-rule"
 export * from "@inlang/message"
 export * from "@inlang/plugin"
-export * from "@inlang/project-config"
+export * from "@inlang/project-settings"
 export * from "@inlang/translatable"

package/dist/openInlangProject.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"openInlangProject.d.ts","sourceRoot":"","sources":["../src/openInlangProject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,aAAa,EAGb,YAAY,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,4BAA4B,CAAA;AAchF,OAAO,EAA0B,KAAK,uBAAuB,EAAE,MAAM,0BAA0B,CAAA;AAK/F;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB;qBACZ,MAAM;eACZ,uBAAuB;;qBAElB,MAAM,SAAS,OAAO,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;MAC5D,QAAQ,aAAa,CAiLxB,CAAA;AAyGD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQtE"}

package/dist/openInlangProject.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=openInlangProject.test.d.ts.map

package/dist/openInlangProject.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"openInlangProject.test.d.ts","sourceRoot":"","sources":["../src/openInlangProject.test.ts"],"names":[],"mappings":""}