@inlang/sdk 0.36.2 → 2.0.0-prerelease.0

package/dist/plugin/errors.js

@@ -0,0 +1,48 @@
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="80038c16-cc9c-5214-8c46-54bb2f3bc458")}catch(e){}}();
+export class PluginError extends Error {
+    plugin;
+    constructor(message, options) {
+        super(message);
+        this.name = "PluginError";
+        this.plugin = options.plugin;
+        this.cause = options.cause;
+    }
+}
+/**
+ * Error when a plugin cannot be imported.
+ */
+export class PluginImportError extends PluginError {
+    constructor(options) {
+        super(`Couldn't import the plugin "${options.plugin}":\n\n${options.cause}`, options);
+        this.name = "PluginImportError";
+    }
+}
+export class PluginSettingsAreInvalidError extends PluginError {
+    constructor(options) {
+        super(`The settings of "${options.plugin}" are invalid:\n\n${options.errors
+            .map((error) => `Path "${error.path}" with value "${JSON.stringify(error.value, undefined, 2)}": "${error.message}"`)
+            .join("\n")}`, options);
+        this.name = "PluginSettingsAreInvalidError";
+    }
+}
+/**
+ * Error when a plugin does not implement a required function
+ */
+export class PluginDoesNotImplementFunctionError extends PluginError {
+    constructor(options) {
+        super(`The plugin "${options.plugin}" does not implement the "${options.function}" function.`, options);
+        this.name = "PluginDoesNotImplementFunction";
+    }
+}
+/**
+ * Error when a plugin was expected to exist, but doesn't
+ */
+export class PluginMissingError extends PluginError {
+    constructor(options) {
+        super(`The plugin "${options.plugin}" does not exist`, options);
+        this.name = "PluginMissingError";
+    }
+}
+//# sourceMappingURL=errors.js.map
+//# debugId=80038c16-cc9c-5214-8c46-54bb2f3bc458

package/dist/plugin/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sources":["plugin/errors.ts"],"sourceRoot":"/","sourcesContent":["import type { ValueError } from \"@sinclair/typebox/errors\";\n\nexport class PluginError extends Error {\n\tpublic readonly plugin: string;\n\n\tconstructor(message: string, options: { plugin: string; cause?: Error }) {\n\t\tsuper(message);\n\t\tthis.name = \"PluginError\";\n\t\tthis.plugin = options.plugin;\n\t\tthis.cause = options.cause;\n\t}\n}\n\n/**\n * Error when a plugin cannot be imported.\n */\nexport class PluginImportError extends PluginError {\n\tconstructor(options: { plugin: string; cause: Error }) {\n\t\tsuper(\n\t\t\t`Couldn't import the plugin \"${options.plugin}\":\\n\\n${options.cause}`,\n\t\t\toptions\n\t\t);\n\t\tthis.name = \"PluginImportError\";\n\t}\n}\n\nexport class PluginSettingsAreInvalidError extends PluginError {\n\tconstructor(options: { plugin: string; errors: ValueError[] }) {\n\t\tsuper(\n\t\t\t`The settings of \"${options.plugin}\" are invalid:\\n\\n${options.errors\n\t\t\t\t.map(\n\t\t\t\t\t(error) =>\n\t\t\t\t\t\t`Path \"${error.path}\" with value \"${JSON.stringify(\n\t\t\t\t\t\t\terror.value,\n\t\t\t\t\t\t\tundefined,\n\t\t\t\t\t\t\t2\n\t\t\t\t\t\t)}\": \"${error.message}\"`\n\t\t\t\t)\n\t\t\t\t.join(\"\\n\")}`,\n\t\t\toptions\n\t\t);\n\t\tthis.name = \"PluginSettingsAreInvalidError\";\n\t}\n}\n\n/**\n * Error when a plugin does not implement a required function\n */\nexport class PluginDoesNotImplementFunctionError extends PluginError {\n\tconstructor(options: { plugin: string; function: string }) {\n\t\tsuper(\n\t\t\t`The plugin \"${options.plugin}\" does not implement the \"${options.function}\" function.`,\n\t\t\toptions\n\t\t);\n\t\tthis.name = \"PluginDoesNotImplementFunction\";\n\t}\n}\n\n/**\n * Error when a plugin was expected to exist, but doesn't\n */\nexport class PluginMissingError extends PluginError {\n\tconstructor(options: { plugin: string }) {\n\t\tsuper(`The plugin \"${options.plugin}\" does not exist`, options);\n\t\tthis.name = \"PluginMissingError\";\n\t}\n}\n"],"names":[],"mappings":";;AAEA,MAAM,OAAO,WAAY,SAAQ,KAAK;IACrB,MAAM,CAAS;IAE/B,YAAY,OAAe,EAAE,OAA0C;QACtE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAC5B,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IACjD,YAAY,OAAyC;QACpD,KAAK,CACJ,+BAA+B,OAAO,CAAC,MAAM,SAAS,OAAO,CAAC,KAAK,EAAE,EACrE,OAAO,CACP,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IACjC,CAAC;CACD;AAED,MAAM,OAAO,6BAA8B,SAAQ,WAAW;IAC7D,YAAY,OAAiD;QAC5D,KAAK,CACJ,oBAAoB,OAAO,CAAC,MAAM,qBAAqB,OAAO,CAAC,MAAM;aACnE,GAAG,CACH,CAAC,KAAK,EAAE,EAAE,CACT,SAAS,KAAK,CAAC,IAAI,iBAAiB,IAAI,CAAC,SAAS,CACjD,KAAK,CAAC,KAAK,EACX,SAAS,EACT,CAAC,CACD,OAAO,KAAK,CAAC,OAAO,GAAG,CACzB;aACA,IAAI,CAAC,IAAI,CAAC,EAAE,EACd,OAAO,CACP,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,+BAA+B,CAAC;IAC7C,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,mCAAoC,SAAQ,WAAW;IACnE,YAAY,OAA6C;QACxD,KAAK,CACJ,eAAe,OAAO,CAAC,MAAM,6BAA6B,OAAO,CAAC,QAAQ,aAAa,EACvF,OAAO,CACP,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,gCAAgC,CAAC;IAC9C,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAClD,YAAY,OAA2B;QACtC,KAAK,CAAC,eAAe,OAAO,CAAC,MAAM,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAChE,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IAClC,CAAC;CACD","debug_id":"80038c16-cc9c-5214-8c46-54bb2f3bc458"}

package/dist/plugin/importPlugins.d.ts

@@ -0,0 +1,19 @@
+import type { Lix } from "@lix-js/sdk";
+import type { ProjectSettings } from "../json-schema/settings.js";
+import { PluginError } from "./errors.js";
+import type { InlangPlugin } from "./schema.js";
+/**
+ * Function that preprocesses the plugin before importing it.
+ *
+ * - used by sherlock to convert ESM to CJS
+ */
+export type PreprocessPluginBeforeImportFunction = (moduleText: string) => Promise<string> | string;
+export declare function importPlugins(args: {
+    lix: Lix;
+    settings: ProjectSettings;
+    preprocessPluginBeforeImport?: PreprocessPluginBeforeImportFunction;
+}): Promise<{
+    plugins: InlangPlugin[];
+    errors: PluginError[];
+}>;
+//# sourceMappingURL=importPlugins.d.ts.map

package/dist/plugin/importPlugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"importPlugins.d.ts","sourceRoot":"/","sources":["plugin/importPlugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAqB,MAAM,aAAa,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAGhD;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,GAAG,CAClD,UAAU,EAAE,MAAM,KACd,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAE9B,wBAAsB,aAAa,CAAC,IAAI,EAAE;IACzC,GAAG,EAAE,GAAG,CAAC;IACT,QAAQ,EAAE,eAAe,CAAC;IAC1B,4BAA4B,CAAC,EAAE,oCAAoC,CAAC;CACpE,GAAG,OAAO,CAAC;IACX,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,MAAM,EAAE,WAAW,EAAE,CAAC;CACtB,CAAC,CAyBD"}

package/dist/plugin/importPlugins.js

@@ -0,0 +1,43 @@
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="922b0ccf-6503-5077-b1ae-ef03acdecbf1")}catch(e){}}();
+import { PluginError, PluginImportError } from "./errors.js";
+import { withCache } from "./cache.js";
+export async function importPlugins(args) {
+    const plugins = [];
+    const errors = [];
+    for (const uri of args.settings.modules ?? []) {
+        try {
+            let moduleAsText = await withCache(fetchPlugin, args.lix)(uri);
+            if (args.preprocessPluginBeforeImport) {
+                moduleAsText = await args.preprocessPluginBeforeImport(moduleAsText);
+            }
+            const moduleWithMimeType = "data:application/javascript," + encodeURIComponent(moduleAsText);
+            const { default: module } = await import(
+            /* @vite-ignore */ moduleWithMimeType);
+            // old legacy message lint rules are not supported
+            // and ingored for backwards compatibility
+            if (module.id?.includes("messageLintRule")) {
+                continue;
+            }
+            plugins.push(module);
+        }
+        catch (e) {
+            errors.push(new PluginImportError({ plugin: uri, cause: e }));
+        }
+    }
+    return { plugins, errors };
+}
+async function fetchPlugin(uri) {
+    try {
+        const response = await fetch(uri);
+        return await response.text();
+    }
+    catch (error) {
+        throw new PluginImportError({
+            plugin: uri,
+            cause: error,
+        });
+    }
+}
+//# sourceMappingURL=importPlugins.js.map
+//# debugId=922b0ccf-6503-5077-b1ae-ef03acdecbf1

package/dist/plugin/importPlugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"importPlugins.js","sources":["plugin/importPlugins.ts"],"sourceRoot":"/","sourcesContent":["import type { Lix } from \"@lix-js/sdk\";\nimport type { ProjectSettings } from \"../json-schema/settings.js\";\nimport { PluginError, PluginImportError } from \"./errors.js\";\nimport type { InlangPlugin } from \"./schema.js\";\nimport { withCache } from \"./cache.js\";\n\n/**\n * Function that preprocesses the plugin before importing it.\n *\n * - used by sherlock to convert ESM to CJS\n */\nexport type PreprocessPluginBeforeImportFunction = (\n\tmoduleText: string\n) => Promise<string> | string;\n\nexport async function importPlugins(args: {\n\tlix: Lix;\n\tsettings: ProjectSettings;\n\tpreprocessPluginBeforeImport?: PreprocessPluginBeforeImportFunction;\n}): Promise<{\n\tplugins: InlangPlugin[];\n\terrors: PluginError[];\n}> {\n\tconst plugins: InlangPlugin[] = [];\n\tconst errors: PluginError[] = [];\n\tfor (const uri of args.settings.modules ?? []) {\n\t\ttry {\n\t\t\tlet moduleAsText = await withCache(fetchPlugin, args.lix)(uri);\n\t\t\tif (args.preprocessPluginBeforeImport) {\n\t\t\t\tmoduleAsText = await args.preprocessPluginBeforeImport(moduleAsText);\n\t\t\t}\n\t\t\tconst moduleWithMimeType =\n\t\t\t\t\"data:application/javascript,\" + encodeURIComponent(moduleAsText);\n\t\t\tconst { default: module } = await import(\n\t\t\t\t/* @vite-ignore */ moduleWithMimeType\n\t\t\t);\n\t\t\t// old legacy message lint rules are not supported\n\t\t\t// and ingored for backwards compatibility\n\t\t\tif (module.id?.includes(\"messageLintRule\")) {\n\t\t\t\tcontinue;\n\t\t\t}\n\t\t\tplugins.push(module);\n\t\t} catch (e) {\n\t\t\terrors.push(new PluginImportError({ plugin: uri, cause: e as Error }));\n\t\t}\n\t}\n\treturn { plugins, errors };\n}\n\nasync function fetchPlugin(uri: string): Promise<string> {\n\ttry {\n\t\tconst response = await fetch(uri);\n\t\treturn await response.text();\n\t} catch (error) {\n\t\tthrow new PluginImportError({\n\t\t\tplugin: uri,\n\t\t\tcause: error as Error,\n\t\t});\n\t}\n}\n"],"names":[],"mappings":";;AAEA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAWvC,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAInC;IAIA,MAAM,OAAO,GAAmB,EAAE,CAAC;IACnC,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QAC/C,IAAI,CAAC;YACJ,IAAI,YAAY,GAAG,MAAM,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAC/D,IAAI,IAAI,CAAC,4BAA4B,EAAE,CAAC;gBACvC,YAAY,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAAC,YAAY,CAAC,CAAC;YACtE,CAAC;YACD,MAAM,kBAAkB,GACvB,8BAA8B,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;YACnE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM;YACvC,kBAAkB,CAAC,kBAAkB,CACrC,CAAC;YACF,kDAAkD;YAClD,0CAA0C;YAC1C,IAAI,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBAC5C,SAAS;YACV,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,CAAU,EAAE,CAAC,CAAC,CAAC;QACxE,CAAC;IACF,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AAC5B,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,GAAW;IACrC,IAAI,CAAC;QACJ,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,IAAI,iBAAiB,CAAC;YAC3B,MAAM,EAAE,GAAG;YACX,KAAK,EAAE,KAAc;SACrB,CAAC,CAAC;IACJ,CAAC;AACF,CAAC","debug_id":"922b0ccf-6503-5077-b1ae-ef03acdecbf1"}

package/dist/plugin/importPlugins.test.d.ts

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

package/dist/plugin/importPlugins.test.d.ts.map

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

package/dist/plugin/importPlugins.test.js

@@ -0,0 +1,95 @@
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="df00fa76-3eb4-5842-9f9d-4f593257ee7e")}catch(e){}}();
+import { test, expect, vi } from "vitest";
+import { importPlugins } from "./importPlugins.js";
+import { PluginImportError } from "./errors.js";
+import { newLixFile, openLixInMemory } from "@lix-js/sdk";
+test("it should preprocess a plugin", async () => {
+    global.fetch = vi.fn().mockResolvedValue({
+        ok: true,
+        text: vi.fn().mockResolvedValue("export default { key: 'mock' }"),
+    });
+    const lix = await openLixInMemory({ blob: await newLixFile() });
+    const result = await importPlugins({
+        lix,
+        settings: {
+            baseLocale: "en",
+            locales: ["en"],
+            modules: ["https://mock.com/module.js"],
+        },
+        preprocessPluginBeforeImport: async (moduleText) => {
+            return moduleText.replace("mock", "preprocessed");
+        },
+    });
+    expect(global.fetch).toHaveBeenCalledTimes(1);
+    expect(result.plugins.length).toBe(1);
+    expect(result.errors.length).toBe(0);
+    expect(result.plugins[0]?.key).toBe("preprocessed");
+});
+test("if a fetch fails, a plugin import error is expected", async () => {
+    global.fetch = vi.fn().mockResolvedValue({
+        ok: false,
+        statusText: "HTTP 404",
+    });
+    const lix = await openLixInMemory({ blob: await newLixFile() });
+    const result = await importPlugins({
+        lix,
+        settings: {
+            baseLocale: "en",
+            locales: ["en"],
+            modules: ["https://mock.com/module.js"],
+        },
+    });
+    expect(global.fetch).toHaveBeenCalledTimes(1);
+    expect(result.plugins.length).toBe(0);
+    expect(result.errors.length).toBe(1);
+    expect(result.errors[0]).toBeInstanceOf(PluginImportError);
+});
+test("it should filter message lint rules for legacy reasons", async () => {
+    global.fetch = vi.fn().mockResolvedValue({
+        ok: true,
+        text: vi
+            .fn()
+            .mockResolvedValue("export default { id: 'messageLintRule.something' }"),
+    });
+    const lix = await openLixInMemory({ blob: await newLixFile() });
+    const result = await importPlugins({
+        lix,
+        settings: {
+            baseLocale: "en",
+            locales: ["en"],
+            modules: ["https://mock.com/module.js"],
+        },
+    });
+    expect(result.plugins.length).toBe(0);
+    expect(result.errors.length).toBe(0);
+});
+// more tests are found in cache.test.ts
+test("cache should work", async () => {
+    global.fetch = vi.fn().mockResolvedValue({
+        ok: false,
+    });
+    const mockModulePath = "https://mock.com/module.js";
+    const mockModuleCachePath = "/cache/plugins/31i1etp0l413h";
+    const lix = await openLixInMemory({ blob: await newLixFile() });
+    await lix.db
+        .insertInto("file")
+        .values({
+        path: mockModuleCachePath,
+        data: new TextEncoder().encode("export default { key: 'mock' }"),
+    })
+        .execute();
+    const result = await importPlugins({
+        lix,
+        settings: {
+            baseLocale: "en",
+            locales: ["en"],
+            modules: [mockModulePath],
+        },
+    });
+    expect(result.errors).lengthOf(0);
+    expect(result.plugins).lengthOf(1);
+    expect(result.plugins[0]?.key).toBe("mock");
+});
+//# sourceMappingURL=importPlugins.test.js.map
+//# debugId=df00fa76-3eb4-5842-9f9d-4f593257ee7e

package/dist/plugin/importPlugins.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"importPlugins.test.js","sources":["plugin/importPlugins.test.ts"],"sourceRoot":"/","sourcesContent":["import { test, expect, vi } from \"vitest\";\nimport { importPlugins } from \"./importPlugins.js\";\nimport { PluginImportError } from \"./errors.js\";\nimport { newLixFile, openLixInMemory } from \"@lix-js/sdk\";\n\ntest(\"it should preprocess a plugin\", async () => {\n\tglobal.fetch = vi.fn().mockResolvedValue({\n\t\tok: true,\n\t\ttext: vi.fn().mockResolvedValue(\"export default { key: 'mock' }\"),\n\t});\n\n\tconst lix = await openLixInMemory({ blob: await newLixFile() });\n\tconst result = await importPlugins({\n\t\tlix,\n\t\tsettings: {\n\t\t\tbaseLocale: \"en\",\n\t\t\tlocales: [\"en\"],\n\t\t\tmodules: [\"https://mock.com/module.js\"],\n\t\t},\n\t\tpreprocessPluginBeforeImport: async (moduleText) => {\n\t\t\treturn moduleText.replace(\"mock\", \"preprocessed\");\n\t\t},\n\t});\n\n\texpect(global.fetch).toHaveBeenCalledTimes(1);\n\texpect(result.plugins.length).toBe(1);\n\texpect(result.errors.length).toBe(0);\n\texpect(result.plugins[0]?.key).toBe(\"preprocessed\");\n});\n\ntest(\"if a fetch fails, a plugin import error is expected\", async () => {\n\tglobal.fetch = vi.fn().mockResolvedValue({\n\t\tok: false,\n\t\tstatusText: \"HTTP 404\",\n\t});\n\tconst lix = await openLixInMemory({ blob: await newLixFile() });\n\n\tconst result = await importPlugins({\n\t\tlix,\n\t\tsettings: {\n\t\t\tbaseLocale: \"en\",\n\t\t\tlocales: [\"en\"],\n\t\t\tmodules: [\"https://mock.com/module.js\"],\n\t\t},\n\t});\n\n\texpect(global.fetch).toHaveBeenCalledTimes(1);\n\texpect(result.plugins.length).toBe(0);\n\texpect(result.errors.length).toBe(1);\n\texpect(result.errors[0]).toBeInstanceOf(PluginImportError);\n});\n\ntest(\"it should filter message lint rules for legacy reasons\", async () => {\n\tglobal.fetch = vi.fn().mockResolvedValue({\n\t\tok: true,\n\t\ttext: vi\n\t\t\t.fn()\n\t\t\t.mockResolvedValue(\"export default { id: 'messageLintRule.something' }\"),\n\t});\n\n\tconst lix = await openLixInMemory({ blob: await newLixFile() });\n\n\tconst result = await importPlugins({\n\t\tlix,\n\t\tsettings: {\n\t\t\tbaseLocale: \"en\",\n\t\t\tlocales: [\"en\"],\n\t\t\tmodules: [\"https://mock.com/module.js\"],\n\t\t},\n\t});\n\n\texpect(result.plugins.length).toBe(0);\n\texpect(result.errors.length).toBe(0);\n});\n\n// more tests are found in cache.test.ts\ntest(\"cache should work\", async () => {\n\tglobal.fetch = vi.fn().mockResolvedValue({\n\t\tok: false,\n\t});\n\n\tconst mockModulePath = \"https://mock.com/module.js\";\n\tconst mockModuleCachePath = \"/cache/plugins/31i1etp0l413h\";\n\n\tconst lix = await openLixInMemory({ blob: await newLixFile() });\n\n\tawait lix.db\n\t\t.insertInto(\"file\")\n\t\t.values({\n\t\t\tpath: mockModuleCachePath,\n\t\t\tdata: new TextEncoder().encode(\"export default { key: 'mock' }\"),\n\t\t})\n\t\t.execute();\n\n\tconst result = await importPlugins({\n\t\tlix,\n\t\tsettings: {\n\t\t\tbaseLocale: \"en\",\n\t\t\tlocales: [\"en\"],\n\t\t\tmodules: [mockModulePath],\n\t\t},\n\t});\n\n\texpect(result.errors).lengthOf(0);\n\texpect(result.plugins).lengthOf(1);\n\texpect(result.plugins[0]?.key).toBe(\"mock\");\n});\n"],"names":[],"mappings":";;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE1D,IAAI,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;IAChD,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;QACxC,EAAE,EAAE,IAAI;QACR,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,gCAAgC,CAAC;KACjE,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,MAAM,eAAe,CAAC,EAAE,IAAI,EAAE,MAAM,UAAU,EAAE,EAAE,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;QAClC,GAAG;QACH,QAAQ,EAAE;YACT,UAAU,EAAE,IAAI;YAChB,OAAO,EAAE,CAAC,IAAI,CAAC;YACf,OAAO,EAAE,CAAC,4BAA4B,CAAC;SACvC;QACD,4BAA4B,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;YAClD,OAAO,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QACnD,CAAC;KACD,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;IACtE,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;QACxC,EAAE,EAAE,KAAK;QACT,UAAU,EAAE,UAAU;KACtB,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,MAAM,eAAe,CAAC,EAAE,IAAI,EAAE,MAAM,UAAU,EAAE,EAAE,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;QAClC,GAAG;QACH,QAAQ,EAAE;YACT,UAAU,EAAE,IAAI;YAChB,OAAO,EAAE,CAAC,IAAI,CAAC;YACf,OAAO,EAAE,CAAC,4BAA4B,CAAC;SACvC;KACD,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;AAC5D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;IACzE,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;QACxC,EAAE,EAAE,IAAI;QACR,IAAI,EAAE,EAAE;aACN,EAAE,EAAE;aACJ,iBAAiB,CAAC,oDAAoD,CAAC;KACzE,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,MAAM,eAAe,CAAC,EAAE,IAAI,EAAE,MAAM,UAAU,EAAE,EAAE,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;QAClC,GAAG;QACH,QAAQ,EAAE;YACT,UAAU,EAAE,IAAI;YAChB,OAAO,EAAE,CAAC,IAAI,CAAC;YACf,OAAO,EAAE,CAAC,4BAA4B,CAAC;SACvC;KACD,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC,CAAC,CAAC;AAEH,wCAAwC;AACxC,IAAI,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;IACpC,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;QACxC,EAAE,EAAE,KAAK;KACT,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,4BAA4B,CAAC;IACpD,MAAM,mBAAmB,GAAG,8BAA8B,CAAC;IAE3D,MAAM,GAAG,GAAG,MAAM,eAAe,CAAC,EAAE,IAAI,EAAE,MAAM,UAAU,EAAE,EAAE,CAAC,CAAC;IAEhE,MAAM,GAAG,CAAC,EAAE;SACV,UAAU,CAAC,MAAM,CAAC;SAClB,MAAM,CAAC;QACP,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,gCAAgC,CAAC;KAChE,CAAC;SACD,OAAO,EAAE,CAAC;IAEZ,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;QAClC,GAAG;QACH,QAAQ,EAAE;YACT,UAAU,EAAE,IAAI;YAChB,OAAO,EAAE,CAAC,IAAI,CAAC;YACf,OAAO,EAAE,CAAC,cAAc,CAAC;SACzB;KACD,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC","debug_id":"df00fa76-3eb4-5842-9f9d-4f593257ee7e"}

package/dist/plugin/meta/ideExtension.d.ts

@@ -0,0 +1,54 @@
+interface Position {
+    line: number;
+    character: number;
+}
+interface MessageReferenceMatch {
+    bundleId: string;
+    position: {
+        start: Position;
+        end: Position;
+    };
+}
+interface IdeExtensionConfigSchema {
+    /**
+     * Defines matchers for message references inside the code.
+     *
+     * @param args - Represents the data to conduct the search on.
+     * @returns A promise with matched message references.
+     */
+    messageReferenceMatchers: Array<(args: {
+        documentText: string;
+    }) => Promise<MessageReferenceMatch[]>>;
+    /**
+     * Defines options to extract messages.
+     */
+    extractMessageOptions: Array<{
+        /**
+         * Function which is called when the user finishes the message extraction command.
+         *
+         * @param args - Contains messageId and selection.
+         * @returns The code which is inserted into the document.
+         */
+        callback: (args: {
+            bundleId: string;
+            selection: string;
+        }) => {
+            bundleId: string;
+            messageReplacement: string;
+        };
+    }>;
+    /**
+     * An array of Visual Studio Code DocumentSelectors.
+     *
+     * The document selectors specify for which files/programming languages
+     * (typescript, svelte, etc.) the extension should be activated.
+     *
+     * See https://code.visualstudio.com/api/references/document-selector
+     */
+    documentSelectors?: Array<{
+        language?: string;
+    }>;
+}
+export type IdeExtensionConfig = IdeExtensionConfigSchema;
+export {};
+//# sourceMappingURL=ideExtension.d.ts.map

package/dist/plugin/meta/ideExtension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ideExtension.d.ts","sourceRoot":"/","sources":["plugin/meta/ideExtension.ts"],"names":[],"mappings":"AACA,UAAU,QAAQ;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CAClB;AAGD,UAAU,qBAAqB;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE;QACT,KAAK,EAAE,QAAQ,CAAC;QAChB,GAAG,EAAE,QAAQ,CAAC;KACd,CAAC;CACF;AAGD,UAAU,wBAAwB;IACjC;;;;;OAKG;IACH,wBAAwB,EAAE,KAAK,CAC9B,CAAC,IAAI,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,qBAAqB,EAAE,CAAC,CACpE,CAAC;IAEF;;OAEG;IACH,qBAAqB,EAAE,KAAK,CAAC;QAC5B;;;;;WAKG;QACH,QAAQ,EAAE,CAAC,IAAI,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAA;SAAE,KAAK;YAC5D,QAAQ,EAAE,MAAM,CAAC;YACjB,kBAAkB,EAAE,MAAM,CAAC;SAC3B,CAAC;KACF,CAAC,CAAC;IAEH;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjD;AAGD,MAAM,MAAM,kBAAkB,GAAG,wBAAwB,CAAC"}

package/dist/plugin/meta/ideExtension.js

@@ -0,0 +1,5 @@
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="6b094482-1e1c-5a82-b9ff-edb0247348e7")}catch(e){}}();
+export {};
+//# sourceMappingURL=ideExtension.js.map
+//# debugId=6b094482-1e1c-5a82-b9ff-edb0247348e7

package/dist/plugin/meta/ideExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ideExtension.js","sources":["plugin/meta/ideExtension.ts"],"sourceRoot":"/","sourcesContent":["// Basic structure for a position in the document\ninterface Position {\n\tline: number;\n\tcharacter: number;\n}\n\n// Basic structure for a message reference match\ninterface MessageReferenceMatch {\n\tbundleId: string;\n\tposition: {\n\t\tstart: Position;\n\t\tend: Position;\n\t};\n}\n\n// Main IDE extension configuration schema\ninterface IdeExtensionConfigSchema {\n\t/**\n\t * Defines matchers for message references inside the code.\n\t *\n\t * @param args - Represents the data to conduct the search on.\n\t * @returns A promise with matched message references.\n\t */\n\tmessageReferenceMatchers: Array<\n\t\t(args: { documentText: string }) => Promise<MessageReferenceMatch[]>\n\t>;\n\n\t/**\n\t * Defines options to extract messages.\n\t */\n\textractMessageOptions: Array<{\n\t\t/**\n\t\t * Function which is called when the user finishes the message extraction command.\n\t\t *\n\t\t * @param args - Contains messageId and selection.\n\t\t * @returns The code which is inserted into the document.\n\t\t */\n\t\tcallback: (args: { bundleId: string; selection: string }) => {\n\t\t\tbundleId: string;\n\t\t\tmessageReplacement: string;\n\t\t};\n\t}>;\n\n\t/**\n\t * An array of Visual Studio Code DocumentSelectors.\n\t *\n\t * The document selectors specify for which files/programming languages\n\t * (typescript, svelte, etc.) the extension should be activated.\n\t *\n\t * See https://code.visualstudio.com/api/references/document-selector\n\t */\n\tdocumentSelectors?: Array<{ language?: string }>;\n}\n\n// Export the type for external use\nexport type IdeExtensionConfig = IdeExtensionConfigSchema;\n"],"names":[],"mappings":"","debug_id":"6b094482-1e1c-5a82-b9ff-edb0247348e7"}

package/dist/plugin/schema.d.ts

@@ -0,0 +1,152 @@
+import type { TObject } from "@sinclair/typebox";
+import type { MessageV1 } from "../json-schema/old-v1-message/schemaV1.js";
+import type { ProjectSettings } from "../json-schema/settings.js";
+import type { Bundle, Message, NewBundle, NewMessage, NewVariant, Variant } from "../database/schema.js";
+import type { ExportFile, ImportFile } from "../project/api.js";
+export type InlangPlugin<ExternalSettings extends Record<string, any> | unknown = unknown> = {
+    /**
+     * @deprecated Use `key` instead.
+     */
+    id?: string;
+    /**
+     * The key of the plugin.
+     */
+    key: string;
+    settingsSchema?: TObject;
+    /**
+     * @deprecated Use `importFiles` instead.
+     */
+    loadMessages?: (args: {
+        settings: ProjectSettings;
+        nodeishFs: NodeFsPromisesSubsetLegacy;
+    }) => Promise<MessageV1[]> | MessageV1[];
+    /**
+     * @deprecated Use `exportFiles` instead.
+     */
+    saveMessages?: (args: {
+        messages: MessageV1[];
+        settings: ProjectSettings;
+        nodeishFs: NodeFsPromisesSubsetLegacy;
+    }) => Promise<void> | void;
+    /**
+     * Files that should be imported by the inlang SDK.
+     *
+     * - `metadata` is optional and can be used to store additional information
+     *   that is accessible in `importFiles` via `toBeImportedMetadata`. See
+     *   https://github.com/opral/inlang-sdk/issues/218 for more info.
+     *
+     */
+    toBeImportedFiles?: (args: {
+        settings: ProjectSettings & ExternalSettings;
+    }) => MaybePromise<Array<{
+        path: string;
+        locale: string;
+        metadata?: Record<string, any>;
+    }>>;
+    importFiles?: (args: {
+        files: ImportFile[];
+        settings: ProjectSettings & ExternalSettings;
+    }) => MaybePromise<{
+        bundles: BundleImport[];
+        messages: MessageImport[];
+        variants: VariantImport[];
+    }>;
+    exportFiles?: (args: {
+        bundles: Bundle[];
+        messages: Message[];
+        variants: Variant[];
+        settings: ProjectSettings & ExternalSettings;
+    }) => MaybePromise<Array<ExportFile>>;
+    /**
+     * @deprecated Use the `meta` field instead.
+     */
+    addCustomApi?: (args: {
+        settings: ProjectSettings & ExternalSettings;
+    }) => Record<string, unknown>;
+    /**
+     * Define app-specific APIs under a `meta` field.
+     *
+     * @example
+     * meta: {
+     *   "app.inlang.ide-extension": {
+     *     documentPaths: ["*.json"]
+     *   }
+     * }
+     */
+    meta?: Record<string, Record<string, unknown>>;
+};
+/**
+ * Exposing only a subset to ease mapping of fs functions.
+ *
+ * https://github.com/opral/inlang-sdk/issues/136
+ */
+export type NodeFsPromisesSubsetLegacy = {
+    readFile: ((path: string) => Promise<ArrayBuffer>) | ((path: string, options?: {
+        encoding: "utf-8";
+    }) => Promise<string>);
+    readdir: (path: string) => Promise<string[]>;
+    writeFile: (path: string, data: ArrayBuffer | string) => Promise<void>;
+    mkdir: (path: string) => Promise<void>;
+};
+/**
+ * A to be imported bundle.
+ */
+export type BundleImport = NewBundle;
+/**
+ * A to be imported message.
+ *
+ * The `id` property is omitted because it is generated by the SDK.
+ */
+export type MessageImport = Omit<NewMessage, "id"> & {
+    /**
+     * If the id is not provided, the SDK will generate one.
+     */
+    id?: string;
+};
+/**
+ * A to be imported variant.
+ *
+ * - The `id` and `messageId` properties are omitted because they are generated by the SDK.
+ * - The `bundleId` and `locale` properties are added to the import variant to match the variant
+ *   with a message.
+ */
+export type VariantImport = (NewVariant & {
+    /**
+     * If the id is not provided, the SDK will generate one.
+     */
+    id: string;
+    /**
+     * If the messageId is not provided, the SDK will match the variant
+     * with a message based on the `messageBundleId` and `messageLocale` properties.
+     */
+    messageId: string;
+    /**
+     * Required to match the variant with a message in case the `id` and `messageId` are undefined.
+     */
+    messageBundleId?: undefined;
+    /**
+     * Required to match the variant with a message in case the `id` and `messageId` are undefined.
+     */
+    messageLocale?: undefined;
+}) | (Omit<NewVariant, "id" | "messageId"> & {
+    /**
+     * If the id is not provided, the SDK will generate one.
+     */
+    id?: undefined;
+    /**
+     * If the messageId is not provided, the SDK will match the variant
+     * with a message based on the `messageBundleId` and `messageLocale` properties.
+     */
+    messageId?: undefined;
+    /**
+     * Required to match the variant with a message in case the `id` and `messageId` are undefined.
+     */
+    messageBundleId: string;
+    /**
+     * Required to match the variant with a message in case the `id` and `messageId` are undefined.
+     */
+    messageLocale: string;
+});
+type MaybePromise<T> = T | Promise<T>;
+export {};
+//# sourceMappingURL=schema.d.ts.map

package/dist/plugin/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"/","sources":["plugin/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2CAA2C,CAAC;AAC3E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EACX,MAAM,EACN,OAAO,EACP,SAAS,EACT,UAAU,EACV,UAAU,EACV,OAAO,EACP,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEhE,MAAM,MAAM,YAAY,CACvB,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,GAAG,OAAO,IAC7D;IACH;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE;QACrB,QAAQ,EAAE,eAAe,CAAC;QAC1B,SAAS,EAAE,0BAA0B,CAAC;KACtC,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE;QACrB,QAAQ,EAAE,SAAS,EAAE,CAAC;QACtB,QAAQ,EAAE,eAAe,CAAC;QAC1B,SAAS,EAAE,0BAA0B,CAAC;KACtC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC3B;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE;QAC1B,QAAQ,EAAE,eAAe,GAAG,gBAAgB,CAAC;KAC7C,KAAK,YAAY,CACjB,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,CAAC,CACvE,CAAC;IACF,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE;QACpB,KAAK,EAAE,UAAU,EAAE,CAAC;QACpB,QAAQ,EAAE,eAAe,GAAG,gBAAgB,CAAC;KAC7C,KAAK,YAAY,CAAC;QAClB,OAAO,EAAE,YAAY,EAAE,CAAC;QACxB,QAAQ,EAAE,aAAa,EAAE,CAAC;QAC1B,QAAQ,EAAE,aAAa,EAAE,CAAC;KAC1B,CAAC,CAAC;IACH,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE;QACpB,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,QAAQ,EAAE,OAAO,EAAE,CAAC;QACpB,QAAQ,EAAE,OAAO,EAAE,CAAC;QACpB,QAAQ,EAAE,eAAe,GAAG,gBAAgB,CAAC;KAC7C,KAAK,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE;QACrB,QAAQ,EAAE,eAAe,GAAG,gBAAgB,CAAC;KAC7C,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC/C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACxC,QAAQ,EACL,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC,GACxC,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,EAAE,OAAO,CAAA;KAAE,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACxE,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7C,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,CAAC;AAErC;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG;IACpD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GACtB,CAAC,UAAU,GAAG;IACd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC;CACzB,CAAC,GACF,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,WAAW,CAAC,GAAG;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,SAAS,CAAC;IACf;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACrB,CAAC,CAAC;AAEN,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC"}

package/dist/plugin/schema.js

@@ -0,0 +1,5 @@
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="4dbbc1bc-ac41-5301-b32c-65db7bd6cf85")}catch(e){}}();
+export {};
+//# sourceMappingURL=schema.js.map
+//# debugId=4dbbc1bc-ac41-5301-b32c-65db7bd6cf85

package/dist/plugin/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sources":["plugin/schema.ts"],"sourceRoot":"/","sourcesContent":["import type { TObject } from \"@sinclair/typebox\";\nimport type { MessageV1 } from \"../json-schema/old-v1-message/schemaV1.js\";\nimport type { ProjectSettings } from \"../json-schema/settings.js\";\nimport type {\n\tBundle,\n\tMessage,\n\tNewBundle,\n\tNewMessage,\n\tNewVariant,\n\tVariant,\n} from \"../database/schema.js\";\nimport type { ExportFile, ImportFile } from \"../project/api.js\";\n\nexport type InlangPlugin<\n\tExternalSettings extends Record<string, any> | unknown = unknown,\n> = {\n\t/**\n\t * @deprecated Use `key` instead.\n\t */\n\tid?: string;\n\t/**\n\t * The key of the plugin.\n\t */\n\tkey: string;\n\tsettingsSchema?: TObject;\n\t/**\n\t * @deprecated Use `importFiles` instead.\n\t */\n\tloadMessages?: (args: {\n\t\tsettings: ProjectSettings;\n\t\tnodeishFs: NodeFsPromisesSubsetLegacy;\n\t}) => Promise<MessageV1[]> | MessageV1[];\n\t/**\n\t * @deprecated Use `exportFiles` instead.\n\t */\n\tsaveMessages?: (args: {\n\t\tmessages: MessageV1[];\n\t\tsettings: ProjectSettings;\n\t\tnodeishFs: NodeFsPromisesSubsetLegacy;\n\t}) => Promise<void> | void;\n\t/**\n\t * Files that should be imported by the inlang SDK.\n\t *\n\t * - `metadata` is optional and can be used to store additional information\n\t *   that is accessible in `importFiles` via `toBeImportedMetadata`. See\n\t *   https://github.com/opral/inlang-sdk/issues/218 for more info.\n\t *\n\t */\n\ttoBeImportedFiles?: (args: {\n\t\tsettings: ProjectSettings & ExternalSettings;\n\t}) => MaybePromise<\n\t\tArray<{ path: string; locale: string; metadata?: Record<string, any> }>\n\t>;\n\timportFiles?: (args: {\n\t\tfiles: ImportFile[];\n\t\tsettings: ProjectSettings & ExternalSettings; // we expose the settings in case the importFunction needs to access the plugin config\n\t}) => MaybePromise<{\n\t\tbundles: BundleImport[];\n\t\tmessages: MessageImport[];\n\t\tvariants: VariantImport[];\n\t}>;\n\texportFiles?: (args: {\n\t\tbundles: Bundle[];\n\t\tmessages: Message[];\n\t\tvariants: Variant[];\n\t\tsettings: ProjectSettings & ExternalSettings;\n\t}) => MaybePromise<Array<ExportFile>>;\n\t/**\n\t * @deprecated Use the `meta` field instead.\n\t */\n\taddCustomApi?: (args: {\n\t\tsettings: ProjectSettings & ExternalSettings;\n\t}) => Record<string, unknown>;\n\t/**\n\t * Define app-specific APIs under a `meta` field.\n\t *\n\t * @example\n\t * meta: {\n\t *   \"app.inlang.ide-extension\": {\n\t *     documentPaths: [\"*.json\"]\n\t *   }\n\t * }\n\t */\n\tmeta?: Record<string, Record<string, unknown>>;\n};\n\n/**\n * Exposing only a subset to ease mapping of fs functions.\n *\n * https://github.com/opral/inlang-sdk/issues/136\n */\nexport type NodeFsPromisesSubsetLegacy = {\n\treadFile:\n\t\t| ((path: string) => Promise<ArrayBuffer>)\n\t\t| ((path: string, options?: { encoding: \"utf-8\" }) => Promise<string>);\n\treaddir: (path: string) => Promise<string[]>;\n\twriteFile: (path: string, data: ArrayBuffer | string) => Promise<void>;\n\tmkdir: (path: string) => Promise<void>;\n};\n\n/**\n * A to be imported bundle.\n */\nexport type BundleImport = NewBundle;\n\n/**\n * A to be imported message.\n *\n * The `id` property is omitted because it is generated by the SDK.\n */\nexport type MessageImport = Omit<NewMessage, \"id\"> & {\n\t/**\n\t * If the id is not provided, the SDK will generate one.\n\t */\n\tid?: string;\n};\n\n/**\n * A to be imported variant.\n *\n * - The `id` and `messageId` properties are omitted because they are generated by the SDK.\n * - The `bundleId` and `locale` properties are added to the import variant to match the variant\n *   with a message.\n */\nexport type VariantImport =\n\t| (NewVariant & {\n\t\t\t/**\n\t\t\t * If the id is not provided, the SDK will generate one.\n\t\t\t */\n\t\t\tid: string;\n\t\t\t/**\n\t\t\t * If the messageId is not provided, the SDK will match the variant\n\t\t\t * with a message based on the `messageBundleId` and `messageLocale` properties.\n\t\t\t */\n\t\t\tmessageId: string;\n\t\t\t/**\n\t\t\t * Required to match the variant with a message in case the `id` and `messageId` are undefined.\n\t\t\t */\n\t\t\tmessageBundleId?: undefined;\n\t\t\t/**\n\t\t\t * Required to match the variant with a message in case the `id` and `messageId` are undefined.\n\t\t\t */\n\t\t\tmessageLocale?: undefined;\n\t  })\n\t| (Omit<NewVariant, \"id\" | \"messageId\"> & {\n\t\t\t/**\n\t\t\t * If the id is not provided, the SDK will generate one.\n\t\t\t */\n\t\t\tid?: undefined;\n\t\t\t/**\n\t\t\t * If the messageId is not provided, the SDK will match the variant\n\t\t\t * with a message based on the `messageBundleId` and `messageLocale` properties.\n\t\t\t */\n\t\t\tmessageId?: undefined;\n\t\t\t/**\n\t\t\t * Required to match the variant with a message in case the `id` and `messageId` are undefined.\n\t\t\t */\n\t\t\tmessageBundleId: string;\n\t\t\t/**\n\t\t\t * Required to match the variant with a message in case the `id` and `messageId` are undefined.\n\t\t\t */\n\t\t\tmessageLocale: string;\n\t  });\n\ntype MaybePromise<T> = T | Promise<T>;\n"],"names":[],"mappings":"","debug_id":"4dbbc1bc-ac41-5301-b32c-65db7bd6cf85"}

package/dist/project/api.d.ts

@@ -0,0 +1,78 @@
+import type { Kysely } from "kysely";
+import type { InlangDatabaseSchema } from "../database/schema.js";
+import type { InlangPlugin } from "../plugin/schema.js";
+import type { ProjectSettings } from "../json-schema/settings.js";
+import type { Lix } from "@lix-js/sdk";
+import type { SqliteDatabase } from "sqlite-wasm-kysely";
+export type InlangProject = {
+    db: Kysely<InlangDatabaseSchema>;
+    /**
+     * @deprecated Don't use this. Only an internal hack to unblock
+     * fink v2.
+     *
+     * TODO remove this
+     */
+    _sqlite: SqliteDatabase;
+    id: {
+        get: () => Promise<string>;
+        subscribe: Subscription<string>;
+    };
+    plugins: {
+        get: () => Promise<readonly InlangPlugin[]>;
+        subscribe: Subscription<readonly InlangPlugin[]>;
+    };
+    errors: {
+        get: () => Promise<readonly Error[]>;
+        subscribe: Subscription<readonly Error[]>;
+    };
+    settings: {
+        get: () => Promise<ProjectSettings>;
+        set: (settings: ProjectSettings) => Promise<void>;
+        subscribe: Subscription<ProjectSettings>;
+    };
+    lix: Lix;
+    importFiles: (args: {
+        pluginKey: InlangPlugin["key"];
+        files: ImportFile[];
+    }) => Promise<void>;
+    exportFiles: (args: {
+        pluginKey: InlangPlugin["key"];
+    }) => Promise<ExportFile[]>;
+    close: () => Promise<void>;
+    toBlob: () => Promise<Blob>;
+};
+export type ImportFile = {
+    /** The locale of the resource file */
+    locale: string;
+    /** The binary content of the resource */
+    content: Uint8Array;
+    /**
+     * The metadata of the file to be imported.
+     *
+     * Used to store additional information that is accessible in `importFiles` via `toBeImportedFilesMetadata`.
+     * https://github.com/opral/inlang-sdk/issues/218
+     */
+    toBeImportedFilesMetadata?: Record<string, any>;
+};
+export type ExportFile = {
+    /** The locale of the resource file */
+    locale: string;
+    /**
+     * The name of the file.
+     *
+     * @example
+     *   "en.json"
+     *   "common-de.json"
+     *
+     */
+    name: string;
+    /** The binary content of the resource */
+    content: Uint8Array;
+};
+/**
+ * Minimal RxJS compatible (generic) subscription type.
+ */
+export type Subscription<T> = (callback: (value: T) => void) => {
+    unsubscribe: () => void;
+};
+//# sourceMappingURL=api.d.ts.map

package/dist/project/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"/","sources":["project/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,MAAM,MAAM,aAAa,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;OAKG;IACH,OAAO,EAAE,cAAc,CAAC;IACxB,EAAE,EAAE;QACH,GAAG,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3B,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;KAChC,CAAC;IACF,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,OAAO,CAAC,SAAS,YAAY,EAAE,CAAC,CAAC;QAC5C,SAAS,EAAE,YAAY,CAAC,SAAS,YAAY,EAAE,CAAC,CAAC;KACjD,CAAC;IACF,MAAM,EAAE;QACP,GAAG,EAAE,MAAM,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC;QACrC,SAAS,EAAE,YAAY,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC;KAC1C,CAAC;IACF,QAAQ,EAAE;QACT,GAAG,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC,CAAC;QACpC,GAAG,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QAClD,SAAS,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC;KACzC,CAAC;IACF,GAAG,EAAE,GAAG,CAAC;IACT,WAAW,EAAE,CAAC,IAAI,EAAE;QACnB,SAAS,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,EAAE,UAAU,EAAE,CAAC;KACpB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,WAAW,EAAE,CAAC,IAAI,EAAE;QACnB,SAAS,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;KAC/B,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAC5B,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACxB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,OAAO,EAAE,UAAU,CAAC;IACpB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACxB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,OAAO,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,KAAK;IAC/D,WAAW,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC"}

package/dist/project/api.js

@@ -0,0 +1,5 @@
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="af6a2f36-b55c-58e8-9b4c-56650939516b")}catch(e){}}();
+export {};
+//# sourceMappingURL=api.js.map
+//# debugId=af6a2f36-b55c-58e8-9b4c-56650939516b

package/dist/project/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sources":["project/api.ts"],"sourceRoot":"/","sourcesContent":["import type { Kysely } from \"kysely\";\nimport type { InlangDatabaseSchema } from \"../database/schema.js\";\nimport type { InlangPlugin } from \"../plugin/schema.js\";\nimport type { ProjectSettings } from \"../json-schema/settings.js\";\nimport type { Lix } from \"@lix-js/sdk\";\nimport type { SqliteDatabase } from \"sqlite-wasm-kysely\";\n\nexport type InlangProject = {\n\tdb: Kysely<InlangDatabaseSchema>;\n\t/**\n\t * @deprecated Don't use this. Only an internal hack to unblock\n\t * fink v2.\n\t *\n\t * TODO remove this\n\t */\n\t_sqlite: SqliteDatabase;\n\tid: {\n\t\tget: () => Promise<string>;\n\t\tsubscribe: Subscription<string>;\n\t};\n\tplugins: {\n\t\tget: () => Promise<readonly InlangPlugin[]>;\n\t\tsubscribe: Subscription<readonly InlangPlugin[]>;\n\t};\n\terrors: {\n\t\tget: () => Promise<readonly Error[]>;\n\t\tsubscribe: Subscription<readonly Error[]>;\n\t};\n\tsettings: {\n\t\tget: () => Promise<ProjectSettings>;\n\t\tset: (settings: ProjectSettings) => Promise<void>;\n\t\tsubscribe: Subscription<ProjectSettings>;\n\t};\n\tlix: Lix;\n\timportFiles: (args: {\n\t\tpluginKey: InlangPlugin[\"key\"];\n\t\tfiles: ImportFile[];\n\t}) => Promise<void>;\n\texportFiles: (args: {\n\t\tpluginKey: InlangPlugin[\"key\"];\n\t}) => Promise<ExportFile[]>;\n\tclose: () => Promise<void>;\n\ttoBlob: () => Promise<Blob>;\n};\n\nexport type ImportFile = {\n\t/** The locale of the resource file */\n\tlocale: string;\n\t/** The binary content of the resource */\n\tcontent: Uint8Array;\n\t/**\n\t * The metadata of the file to be imported.\n\t *\n\t * Used to store additional information that is accessible in `importFiles` via `toBeImportedFilesMetadata`.\n\t * https://github.com/opral/inlang-sdk/issues/218\n\t */\n\ttoBeImportedFilesMetadata?: Record<string, any>;\n};\n\nexport type ExportFile = {\n\t/** The locale of the resource file */\n\tlocale: string;\n\t/**\n\t * The name of the file.\n\t *\n\t * @example\n\t *   \"en.json\"\n\t *   \"common-de.json\"\n\t *\n\t */\n\tname: string;\n\t/** The binary content of the resource */\n\tcontent: Uint8Array;\n};\n\n/**\n * Minimal RxJS compatible (generic) subscription type.\n */\nexport type Subscription<T> = (callback: (value: T) => void) => {\n\tunsubscribe: () => void;\n};\n"],"names":[],"mappings":"","debug_id":"af6a2f36-b55c-58e8-9b4c-56650939516b"}

package/dist/project/initHandleSaveToLixOnChange.d.ts

@@ -0,0 +1,14 @@
+import { Kysely } from "kysely";
+import { type SqliteDatabase } from "sqlite-wasm-kysely";
+import type { Lix } from "@lix-js/sdk";
+import type { InlangDatabaseSchema } from "../database/schema.js";
+/**
+ * Saves updates of the database (file) to lix.
+ */
+export declare function initHandleSaveToLixOnChange(args: {
+    sqlite: SqliteDatabase;
+    db: Kysely<InlangDatabaseSchema>;
+    lix: Lix;
+    pendingPromises: Promise<unknown>[];
+}): Promise<void>;
+//# sourceMappingURL=initHandleSaveToLixOnChange.d.ts.map

package/dist/project/initHandleSaveToLixOnChange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"initHandleSaveToLixOnChange.d.ts","sourceRoot":"/","sources":["project/initHandleSaveToLixOnChange.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAO,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAuB,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC9E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAElE;;GAEG;AACH,wBAAsB,2BAA2B,CAAC,IAAI,EAAE;IACvD,MAAM,EAAE,cAAc,CAAC;IACvB,EAAE,EAAE,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACjC,GAAG,EAAE,GAAG,CAAC;IACT,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;CACpC,iBA0EA"}