@inlang/sdk 0.36.4 → 2.0.0-beta.1

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

@@ -1,56 +0,0 @@
-import type { Plugin } from "@inlang/plugin"
-import type { ValueError } from "@sinclair/typebox/errors"
-
-export class PluginHasInvalidIdError extends Error {
-	constructor(options: { id: Plugin["id"] }) {
-		super(
-			`Plugin "${options.id}" has an invalid id. The id must:\n1) Start with "plugin."\n2) camelCase\n3) Contain a namespace.\nAn example would be "plugin.namespace.myPlugin".`
-		)
-		this.name = "PluginHasInvalidIdError"
-	}
-}
-
-export class PluginHasInvalidSchemaError extends Error {
-	constructor(options: { id: Plugin["id"]; errors: ValueError[] }) {
-		super(
-			`Plugin "${options.id}" has an invalid schema:\n\n${options.errors
-				.map((error) => `Path "${error.path}" with value "${error.value}": "${error.message}"`)
-				.join("\n")})}\n\nPlease refer to the documentation for the correct schema.`
-		)
-		this.name = "PluginHasInvalidSchemaError"
-	}
-}
-
-export class PluginLoadMessagesFunctionAlreadyDefinedError extends Error {
-	constructor(options: { id: Plugin["id"] }) {
-		super(
-			`Plugin "${options.id}" defines the \`loadMessages()\` function, but it was already defined by another plugin.\n\nInlang only allows one plugin to define the \`loadMessages()\` function.`
-		)
-		this.name = "PluginLoadMessagesFunctionAlreadyDefinedError"
-	}
-}
-
-export class PluginSaveMessagesFunctionAlreadyDefinedError extends Error {
-	constructor(options: { id: Plugin["id"] }) {
-		super(
-			`Plugin "${options.id}" defines the \`saveMessages()\` function, but it was already defined by another plugin.\n\nInlang only allows one plugin to define the \`saveMessages()\` function.`
-		)
-		this.name = "PluginSaveMessagesFunctionAlreadyDefinedError"
-	}
-}
-
-export class PluginReturnedInvalidCustomApiError extends Error {
-	constructor(options: { id: Plugin["id"]; cause: ErrorOptions["cause"] }) {
-		super(`Plugin "${options.id}" returned an invalid custom API:\n\n${options.cause}`, options)
-		this.name = "PluginReturnedInvalidCustomApiError"
-	}
-}
-
-export class PluginsDoNotProvideLoadOrSaveMessagesError extends Error {
-	constructor() {
-		super(
-			`No plugin provides a \`loadMessages()\` or \`saveMessages()\` function\n\nIn case no plugin threw an error, you likely forgot to add a plugin that handles the loading and saving of messages. Refer to the marketplace for available plugins https://inlang.com/marketplace.`
-		)
-		this.name = "PluginsDoNotProvideLoadOrSaveMessagesError"
-	}
-}

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

@@ -1,301 +0,0 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { describe, expect, it } from "vitest"
-import { resolvePlugins } from "./resolvePlugins.js"
-import {
-	PluginLoadMessagesFunctionAlreadyDefinedError,
-	PluginSaveMessagesFunctionAlreadyDefinedError,
-	PluginHasInvalidIdError,
-	PluginReturnedInvalidCustomApiError,
-	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,
-	})
-
-	expect(resolved.errors[0]).toBeInstanceOf(PluginHasInvalidIdError)
-})
-
-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, nodeishFs: {} as any })
-	await resolved.data.saveMessages!({ settings, messages: [], nodeishFs: {} as any })
-})
-
-describe("loadMessages", () => {
-	it("should load messages from a local source", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namespace.placeholder",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			loadMessages: async () => [
-				{ id: "test", alias: {}, expressions: [], selectors: [], variants: [] },
-			],
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin],
-			settings: {} as any,
-			nodeishFs: {} as any,
-		})
-
-		expect(
-			await resolved.data.loadMessages!({
-				settings: {} as any,
-				nodeishFs: {} as any,
-			})
-		).toEqual([{ id: "test", alias: {}, expressions: [], selectors: [], variants: [] }])
-	})
-
-	it("should collect an error if function is defined twice in multiple plugins", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namepsace.loadMessagesFirst",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-
-			loadMessages: async () => undefined as any,
-		}
-		const mockPlugin2: Plugin = {
-			id: "plugin.namepsace.loadMessagesSecond",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-
-			loadMessages: async () => undefined as any,
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin, mockPlugin2],
-			nodeishFs: {} as any,
-			settings: {} as any,
-		})
-
-		expect(resolved.errors[0]).toBeInstanceOf(PluginLoadMessagesFunctionAlreadyDefinedError)
-	})
-
-	it("should return an error if no plugin defines loadMessages", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namepsace.loadMessagesFirst",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-
-			saveMessages: async () => undefined as any,
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin],
-			nodeishFs: {} as any,
-			settings: {} as any,
-		})
-
-		expect(resolved.errors).toHaveLength(1)
-		expect(resolved.errors[0]).toBeInstanceOf(PluginsDoNotProvideLoadOrSaveMessagesError)
-	})
-})
-
-describe("saveMessages", () => {
-	it("should save messages to a local source", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namespace.placeholder",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			loadMessages: async () => undefined as any,
-			saveMessages: async () => undefined as any,
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin],
-			nodeishFs: {} as any,
-			settings: {} as any,
-		})
-
-		expect(resolved.errors).toHaveLength(0)
-	})
-
-	it("should collect an error if function is defined twice in multiple plugins", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namepsace.saveMessages",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			saveMessages: async () => undefined as any,
-		}
-		const mockPlugin2: Plugin = {
-			id: "plugin.namepsace.saveMessages2",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			saveMessages: async () => undefined as any,
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin, mockPlugin2],
-			settings: {} as any,
-			nodeishFs: {} as any,
-		})
-
-		expect(resolved.errors[0]).toBeInstanceOf(PluginSaveMessagesFunctionAlreadyDefinedError)
-	})
-
-	it("should return an error if no plugin defines saveMessages", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namepsace.loadMessagesFirst",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-
-			loadMessages: async () => undefined as any,
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin],
-			nodeishFs: {} as any,
-			settings: {} as any,
-		})
-		expect(resolved.errors).toHaveLength(1)
-		expect(resolved.errors[0]).toBeInstanceOf(PluginsDoNotProvideLoadOrSaveMessagesError)
-	})
-})
-
-describe("addCustomApi", () => {
-	it("it should resolve app specific api", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namespace.placeholder",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			addCustomApi: () => ({
-				"my-app": {
-					messageReferenceMatcher: () => undefined as any,
-				},
-			}),
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin],
-			settings: {} as any,
-			nodeishFs: {} as any,
-		})
-
-		expect(resolved.data.customApi).toHaveProperty("my-app")
-	})
-
-	it("it should resolve multiple app specific apis", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namespace.placeholder",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			addCustomApi: () => ({
-				"my-app-1": {
-					functionOfMyApp1: () => undefined as any,
-				},
-				"my-app-2": {
-					functionOfMyApp2: () => undefined as any,
-				},
-			}),
-		}
-		const mockPlugin2: Plugin = {
-			id: "plugin.namespace.placeholder2",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			addCustomApi: () => ({
-				"my-app-3": {
-					functionOfMyApp3: () => undefined as any,
-				},
-			}),
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin, mockPlugin2],
-			settings: {} as any,
-			nodeishFs: {} as any,
-		})
-
-		expect(resolved.data.customApi).toHaveProperty("my-app-1")
-		expect(resolved.data.customApi).toHaveProperty("my-app-2")
-		expect(resolved.data.customApi).toHaveProperty("my-app-3")
-	})
-
-	it("it should throw an error if return value is not an object", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namespace.placeholder",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			// @ts-expect-error - invalid return type
-			addCustomApi: () => undefined,
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin],
-			settings: {} as any,
-			nodeishFs: {} as any,
-		})
-
-		expect(resolved.errors[0]).toBeInstanceOf(PluginReturnedInvalidCustomApiError)
-	})
-
-	it("it should throw an error if the passed options are not defined inside customApi", async () => {
-		const mockPlugin: Plugin = {
-			id: "plugin.namepsace.placeholder",
-			description: { en: "My plugin description" },
-			displayName: { en: "My plugin" },
-			addCustomApi: () => ({
-				"app.inlang.placeholder": {
-					messageReferenceMatcher: () => {
-						return { hello: "world" }
-					},
-				},
-			}),
-		}
-
-		const resolved = await resolvePlugins({
-			plugins: [mockPlugin],
-			settings: {} as any,
-			nodeishFs: {} as any,
-		})
-
-		expect(resolved.data.customApi).toHaveProperty("app.inlang.placeholder")
-		expect(
-			(resolved.data.customApi?.["app.inlang.placeholder"] as any).messageReferenceMatcher()
-		).toEqual({
-			hello: "world",
-		})
-	})
-})

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

@@ -1,129 +0,0 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-import type { ResolvePluginsFunction } from "./types.js"
-import { Plugin } from "@inlang/plugin"
-import {
-	PluginReturnedInvalidCustomApiError,
-	PluginLoadMessagesFunctionAlreadyDefinedError,
-	PluginSaveMessagesFunctionAlreadyDefinedError,
-	PluginsDoNotProvideLoadOrSaveMessagesError,
-	PluginHasInvalidIdError,
-	PluginHasInvalidSchemaError,
-} from "./errors.js"
-import { deepmerge } from "deepmerge-ts"
-import { TypeCompiler } from "@sinclair/typebox/compiler"
-import { tryCatch } from "@inlang/result"
-
-import _debug from "debug"
-const debug = _debug("sdk:resolvePlugins")
-
-// @ts-ignore - type mismatch error
-const PluginCompiler = TypeCompiler.Compile(Plugin)
-
-export const resolvePlugins: ResolvePluginsFunction = async (args) => {
-	const result: Awaited<ReturnType<ResolvePluginsFunction>> = {
-		data: {
-			loadMessages: undefined as any,
-			saveMessages: undefined as any,
-			customApi: {},
-		},
-		errors: [],
-	}
-
-	const experimentalPersistence = !!args.settings.experimental?.persistence
-	if (experimentalPersistence) {
-		debug("Using experimental persistence")
-	}
-
-	for (const plugin of args.plugins) {
-		const errors = [...PluginCompiler.Errors(plugin)]
-
-		/**
-		 * -------------- RESOLVE PLUGIN --------------
-		 */
-
-		// -- INVALID ID in META --
-		const hasInvalidId = errors.some((error) => error.path === "/id")
-		if (hasInvalidId) {
-			result.errors.push(new PluginHasInvalidIdError({ id: plugin.id }))
-		}
-
-		// -- USES INVALID SCHEMA --
-		if (errors.length > 0) {
-			result.errors.push(
-				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({ id: plugin.id }))
-		}
-
-		if (typeof plugin.saveMessages === "function" && result.data.saveMessages !== undefined) {
-			result.errors.push(new PluginSaveMessagesFunctionAlreadyDefinedError({ id: plugin.id }))
-		}
-
-		// --- ADD APP SPECIFIC API ---
-		if (typeof plugin.addCustomApi === "function") {
-			// 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,
-				})
-			)
-			if (error) {
-				result.errors.push(new PluginReturnedInvalidCustomApiError({ id: plugin.id, cause: error }))
-			} else if (typeof customApi !== "object") {
-				result.errors.push(
-					new PluginReturnedInvalidCustomApiError({
-						id: plugin.id,
-						cause: new Error(`The return value must be an object. Received "${typeof customApi}".`),
-					})
-				)
-			}
-		}
-
-		// -- CONTINUE IF ERRORS --
-		if (result.errors.length > 0) {
-			continue
-		}
-
-		/**
-		 * -------------- BEGIN ADDING TO RESULT --------------
-		 */
-
-		if (typeof plugin.loadMessages === "function") {
-			result.data.loadMessages = plugin.loadMessages
-		}
-
-		if (typeof plugin.saveMessages === "function") {
-			result.data.saveMessages = plugin.saveMessages
-		}
-
-		if (typeof plugin.addCustomApi === "function") {
-			const { data: customApi } = tryCatch(() =>
-				plugin.addCustomApi!({
-					settings: args.settings,
-				})
-			)
-			if (customApi) {
-				result.data.customApi = deepmerge(result.data.customApi, customApi)
-			}
-		}
-	}
-
-	// --- LOADMESSAGE / SAVEMESSAGE NOT DEFINED ---
-
-	if (
-		!experimentalPersistence &&
-		(typeof result.data.loadMessages !== "function" ||
-			typeof result.data.saveMessages !== "function")
-	) {
-		result.errors.push(new PluginsDoNotProvideLoadOrSaveMessagesError())
-	}
-
-	return result
-}

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

@@ -1,53 +0,0 @@
-import { ProjectSettings } from "@inlang/project-settings"
-import { Value } from "@sinclair/typebox/value"
-import { describe, test, expect } from "vitest"
-import { expectType } from "tsd"
-import { Plugin } from "@inlang/plugin"
-
-describe("Plugin", () => {
-	test("meta.id should enforce plugin.namespace.* patterns", () => {
-		expectType<`plugin.${string}.${string}`>("" as Plugin["id"])
-
-		const mockPlugin: Plugin = {
-			id: "plugin.namespace.placeholder",
-			displayName: { en: "" },
-			description: { en: "" },
-		}
-
-		const passCases = ["plugin.namespace.helloWorld", "plugin.namespace.i18n"]
-		const failCases = [
-			"namespace.hello_World",
-			"plugin.namespace-HelloWorld",
-			"lintRule.namespace.coolPlugin",
-		]
-
-		for (const pass of passCases) {
-			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.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 settings: ProjectSettings = {
-			sourceLanguageTag: "en",
-			languageTags: ["en", "de"],
-			modules: [],
-		}
-		const cases = ["plugin.namespace.helloWorld", "plugin.namespace.i18n"]
-
-		for (const _case of cases) {
-			const mergedSettings = { ...settings, [_case]: {} }
-			expect(Value.Check(ProjectSettings, mergedSettings)).toBe(true)
-			// @ts-ignore - type mismatch error. fix after refactor
-			expect(Value.Check(Plugin["properties"]["id"], _case)).toBe(true)
-		}
-	})
-})

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

@@ -1,76 +0,0 @@
-import type { NodeishFilesystem } from "@lix-js/fs"
-import type {
-	PluginReturnedInvalidCustomApiError,
-	PluginLoadMessagesFunctionAlreadyDefinedError,
-	PluginSaveMessagesFunctionAlreadyDefinedError,
-	PluginHasInvalidIdError,
-	PluginHasInvalidSchemaError,
-	PluginsDoNotProvideLoadOrSaveMessagesError,
-} from "./errors.js"
-import type { Message } from "@inlang/message"
-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.
- *
- * - only uses minimally required functions to decrease the API footprint on the ecosystem.
- */
-export type NodeishFilesystemSubset = Pick<
-	NodeishFilesystem,
-	"readFile" | "readdir" | "mkdir" | "writeFile" | "watch"
->
-
-/**
- * Function that resolves (imports and initializes) the plugins.
- */
-export type ResolvePluginsFunction = (args: {
-	plugins: Array<Plugin>
-	settings: ProjectSettings
-	nodeishFs: NodeishFilesystemSubset
-}) => Promise<{
-	data: ResolvedPluginApi
-	errors: Array<
-		| PluginReturnedInvalidCustomApiError
-		| PluginLoadMessagesFunctionAlreadyDefinedError
-		| PluginSaveMessagesFunctionAlreadyDefinedError
-		| PluginHasInvalidIdError
-		| PluginHasInvalidSchemaError
-		| PluginsDoNotProvideLoadOrSaveMessagesError
-	>
-}>
-
-/**
- * The API after resolving the plugins.
- */
-export type ResolvedPluginApi = {
-	loadMessages: (args: {
-		settings: ProjectSettings
-		nodeishFs: NodeishFilesystemSubset
-	}) => Promise<Message[]> | Message[]
-	saveMessages: (args: {
-		settings: ProjectSettings
-		messages: Message[]
-		nodeishFs: NodeishFilesystemSubset
-	}) => Promise<void> | void
-	/**
-	 * App specific APIs.
-	 *
-	 * @example
-	 *  // define
-	 *  customApi: ({ settings }) => ({
-	 * 	 "app.inlang.ide-extension": {
-	 * 	   messageReferenceMatcher: () => {
-	 * 		 // use settings
-	 * 		 settings.pathPattern
-	 * 		return
-	 * 	   }
-	 * 	 }
-	 *  })
-	 *  // use
-	 *  customApi['app.inlang.ide-extension'].messageReferenceMatcher()
-	 */
-	customApi: Record<`app.${string}.${string}` | `library.${string}.${string}`, unknown> & {
-		"app.inlang.ideExtension"?: CustomApiInlangIdeExtension
-	}
-}