@inlang/sdk 0.1.0

package/dist/resolve-modules/resolveModules.test.js

@@ -0,0 +1,143 @@
+import { expect, it } from "vitest";
+import { ModuleError, ModuleExportIsInvalidError, ModuleHasNoExportsError, ModuleImportError, } from "./errors.js";
+import { resolveModules } from "./resolveModules.js";
+it("should return an error if a plugin cannot be imported", async () => {
+    const config = {
+        sourceLanguageTag: "en",
+        languageTags: ["de", "en"],
+        modules: ["https://myplugin.com/index.js"],
+        settings: {},
+    };
+    const resolved = await resolveModules({
+        config,
+        nodeishFs: {},
+        _import: () => {
+            throw new ModuleImportError("Could not import", {
+                module: config.modules[0],
+                cause: new Error("Could not import"),
+            });
+        },
+    });
+    expect(resolved.errors[0]).toBeInstanceOf(ModuleImportError);
+});
+it("should resolve plugins and message lint rules successfully", async () => {
+    // Define mock data
+    const mockPlugin = {
+        meta: {
+            id: "plugin.namespace.mock",
+            description: { en: "Mock plugin description" },
+            displayName: { en: "Mock Plugin" },
+        },
+        loadMessages: () => undefined,
+        saveMessages: () => undefined,
+        addCustomApi: () => ({
+            "app.inlang.ideExtension": {
+                messageReferenceMatcher: () => undefined,
+            },
+        }),
+    };
+    const mockMessageLintRule = {
+        meta: {
+            id: "messageLintRule.namespace.mock",
+            description: { en: "Mock lint rule description" },
+            displayName: { en: "Mock Lint Rule" },
+        },
+        message: () => undefined,
+    };
+    const config = {
+        sourceLanguageTag: "en",
+        languageTags: ["de", "en"],
+        modules: ["lint-rule.js", "plugin.js"],
+        settings: {},
+    };
+    const _import = async (name) => {
+        if (name === "lint-rule.js") {
+            return {
+                default: mockMessageLintRule,
+            };
+        }
+        else {
+            return {
+                default: mockPlugin,
+            };
+        }
+    };
+    // Call the function
+    const resolved = await resolveModules({ config, _import, nodeishFs: {} });
+    // 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();
+    // 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);
+});
+it("should return an error if a module cannot be imported", async () => {
+    const config = {
+        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],
+            cause: new Error(),
+        });
+    };
+    // Call the function
+    const resolved = await resolveModules({ config, _import, nodeishFs: {} });
+    // 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 = {
+        sourceLanguageTag: "en",
+        languageTags: ["de", "en"],
+        modules: ["https://myplugin.com/index.js"],
+        settings: {},
+    };
+    const _import = async () => ({
+        default: {},
+    });
+    // Call the function
+    const resolved = await resolveModules({ config, _import, nodeishFs: {} });
+    // 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 = {
+        sourceLanguageTag: "en",
+        languageTags: ["de", "en"],
+        modules: ["https://myplugin.com/index.js"],
+        settings: {},
+    };
+    const _import = async () => ({
+        default: {
+            // @ts-expect-error - invalid meta of a plugin
+            meta: {
+                id: "plugin.namespace.mock",
+                description: { en: "Mock plugin description" },
+            },
+        },
+    });
+    const resolved = await resolveModules({ config, _import, nodeishFs: {} });
+    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 = {
+        sourceLanguageTag: "en",
+        languageTags: ["de", "en"],
+        modules: ["https://myplugin.com/index.js"],
+        settings: {},
+    };
+    const _import = async () => {
+        throw new Error(errorMessage);
+    };
+    // Call the function
+    const resolved = await resolveModules({ config, _import, nodeishFs: {} });
+    // Assert results
+    expect(resolved.errors[0]).toBeInstanceOf(ModuleError);
+});

package/dist/resolve-modules/types.d.ts

@@ -0,0 +1,62 @@
+import type { ProjectConfig } from "@inlang/project-config";
+import type { MessageLintRule } from "@inlang/message-lint-rule";
+import type { Plugin } from "@inlang/plugin";
+import type { NodeishFilesystemSubset, ResolvePluginsFunction, ResolvedPluginApi } from "./plugins/types.js";
+import type { ModuleHasNoExportsError, ModuleImportError } from "./errors.js";
+import type { ImportFunction } from "./import.js";
+import type { resolveMessageLintRules } from "./message-lint-rules/resolveMessageLintRules.js";
+/**
+ * Function that resolves modules from the config.
+ *
+ * Pass a custom `_import` function to override the default import function.
+ */
+export type ResolveModuleFunction = (args: {
+    config: ProjectConfig;
+    nodeishFs: NodeishFilesystemSubset;
+    _import?: ImportFunction;
+}) => Promise<{
+    /**
+     * Metadata about the resolved module.
+     *
+     * @example
+     * [{
+     * 	  id: "plugin.inlang.json",
+     * 	  module: "https://myplugin.com/index.js"
+     * }]
+     */
+    meta: Array<{
+        /**
+         * The module link.
+         *
+         * @example "https://myplugin.com/index.js"
+         */
+        module: string;
+        /**
+         * The resolved item id of the module.
+         */
+        id: Plugin["meta"]["id"] | MessageLintRule["meta"]["id"];
+    }>;
+    /**
+     * The resolved plugins.
+     */
+    plugins: Array<Plugin>;
+    /**
+     * The resolved message lint rules.
+     */
+    messageLintRules: Array<MessageLintRule>;
+    /**
+     * The resolved api provided by plugins.
+     */
+    resolvedPluginApi: ResolvedPluginApi;
+    /**
+     * Errors during the resolution process.
+     *
+     * This includes errors from:
+     * - importing module
+     * - resolving plugins
+     * - resolving lint rules
+     * - resolving the runtime plugin api
+     */
+    errors: Array<ModuleHasNoExportsError | ModuleImportError | Awaited<ReturnType<ResolvePluginsFunction>>["errors"][number] | Awaited<ReturnType<typeof resolveMessageLintRules>>["errors"][number]>;
+}>;
+//# sourceMappingURL=types.d.ts.map

package/dist/resolve-modules/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/resolve-modules/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EACX,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iDAAiD,CAAA;AAE9F;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,IAAI,EAAE;IAC1C,MAAM,EAAE,aAAa,CAAA;IACrB,SAAS,EAAE,uBAAuB,CAAA;IAClC,OAAO,CAAC,EAAE,cAAc,CAAA;CACxB,KAAK,OAAO,CAAC;IACb;;;;;;;;OAQG;IACH,IAAI,EAAE,KAAK,CAAC;QACX;;;;WAIG;QACH,MAAM,EAAE,MAAM,CAAA;QACd;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAA;KACxD,CAAC,CAAA;IACF;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACtB;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;IACxC;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAA;IACpC;;;;;;;;OAQG;IACH,MAAM,EAAE,KAAK,CACV,uBAAuB,GACvB,iBAAiB,GACjB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAC7D,OAAO,CAAC,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CACvE,CAAA;CACD,CAAC,CAAA"}

package/dist/resolve-modules/types.js

@@ -0,0 +1 @@
+export {};

package/dist/test-utilities/createMessage.d.ts

@@ -0,0 +1,17 @@
+import type { Pattern } from "@inlang/message";
+export declare const createMessage: (id: string, patterns: Record<string, Pattern | string>) => {
+    id: string;
+    selectors: never[];
+    variants: {
+        languageTag: string;
+        match: {};
+        pattern: ({
+            type: "Text";
+            value: string;
+        } | {
+            name: string;
+            type: "VariableReference";
+        })[];
+    }[];
+};
+//# sourceMappingURL=createMessage.d.ts.map

package/dist/test-utilities/createMessage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMessage.d.ts","sourceRoot":"","sources":["../../src/test-utilities/createMessage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAW,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAEvD,eAAO,MAAM,aAAa,OAAQ,MAAM,YAAY,OAAO,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC;;;;;;;;;;;;;;CAiB/D,CAAA"}

package/dist/test-utilities/createMessage.js

@@ -0,0 +1,16 @@
+export const createMessage = (id, patterns) => ({
+    id,
+    selectors: [],
+    variants: Object.entries(patterns).map(([languageTag, patterns]) => ({
+        languageTag,
+        match: {},
+        pattern: typeof patterns === "string"
+            ? [
+                {
+                    type: "Text",
+                    value: patterns,
+                },
+            ]
+            : patterns,
+    })),
+});

package/dist/test-utilities/createMessage.test.d.ts

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

package/dist/test-utilities/createMessage.test.d.ts.map

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

package/dist/test-utilities/createMessage.test.js

@@ -0,0 +1,91 @@
+import { expect, test } from "vitest";
+import { createMessage } from "./createMessage.js";
+test("should create a simple message", () => {
+    expect(createMessage("welcome", {
+        de: "Hallo inlang",
+    })).toMatchInlineSnapshot(`
+		{
+		  "id": "welcome",
+		  "selectors": [],
+		  "variants": [
+		    {
+		      "languageTag": "de",
+		      "match": {},
+		      "pattern": [
+		        {
+		          "type": "Text",
+		          "value": "Hallo inlang",
+		        },
+		      ],
+		    },
+		  ],
+		}
+	`);
+});
+test("should create a message with pattern", () => {
+    expect(createMessage("greeting", {
+        en: [
+            { type: "Text", value: "Hi " },
+            { type: "VariableReference", name: "name" },
+            { type: "Text", value: '"' },
+        ],
+    })).toMatchInlineSnapshot(`
+			{
+			  "id": "greeting",
+			  "selectors": [],
+			  "variants": [
+			    {
+			      "languageTag": "en",
+			      "match": {},
+			      "pattern": [
+			        {
+			          "type": "Text",
+			          "value": "Hi ",
+			        },
+			        {
+			          "name": "name",
+			          "type": "VariableReference",
+			        },
+			        {
+			          "type": "Text",
+			          "value": "\\"",
+			        },
+			      ],
+			    },
+			  ],
+			}
+		`);
+});
+test("should create a message with a pattern", () => {
+    expect(createMessage("welcome", {
+        en: "hello inlang",
+        de: [{ type: "Text", value: "Hallo inlang" }],
+    })).toMatchInlineSnapshot(`
+			{
+			  "id": "welcome",
+			  "selectors": [],
+			  "variants": [
+			    {
+			      "languageTag": "en",
+			      "match": {},
+			      "pattern": [
+			        {
+			          "type": "Text",
+			          "value": "hello inlang",
+			        },
+			      ],
+			    },
+			    {
+			      "languageTag": "de",
+			      "match": {},
+			      "pattern": [
+			        {
+			          "type": "Text",
+			          "value": "Hallo inlang",
+			        },
+			      ],
+			    },
+			  ],
+			}
+		`);
+});

package/dist/test-utilities/index.d.ts

@@ -0,0 +1,2 @@
+export { createMessage } from "./createMessage.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/test-utilities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test-utilities/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA"}

package/dist/test-utilities/index.js

@@ -0,0 +1 @@
+export { createMessage } from "./createMessage.js";

package/dist/versionedInterfaces.d.ts

@@ -0,0 +1,8 @@
+export * from "@inlang/json-types";
+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/translatable";
+//# sourceMappingURL=versionedInterfaces.d.ts.map

package/dist/versionedInterfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"versionedInterfaces.d.ts","sourceRoot":"","sources":["../src/versionedInterfaces.ts"],"names":[],"mappings":"AAEA,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA"}

package/dist/versionedInterfaces.js

@@ -0,0 +1,8 @@
+// Re-exporting for easier importing
+export * from "@inlang/json-types";
+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/translatable";

package/package.json

@@ -0,0 +1,58 @@
+{
+	"name": "@inlang/sdk",
+	"type": "module",
+	"version": "0.1.0",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"access": "public"
+	},
+	"exports": {
+		".": "./dist/index.js",
+		"./test-utilities": "./dist/test-utilities/index.js",
+		"./lint": "./dist/lint/index.js",
+		"./messages": "./dist/messages/index.js"
+	},
+	"files": [
+		"./dist",
+		"./src"
+	],
+	"scripts": {
+		"build": "tsc --build",
+		"dev": "tsc --watch",
+		"test": "tsc --noEmit && vitest run --passWithNoTests --coverage",
+		"lint": "eslint ./src --fix",
+		"format": "prettier ./src --write",
+		"clean": "rm -rf ./dist ./.turbo ./node_modules"
+	},
+	"engines": {
+		"node": ">=18.0.0"
+	},
+	"dependencies": {
+		"@inlang/json-types": "*",
+		"@inlang/translatable": "*",
+		"@inlang/message-lint-rule": "*",
+		"@inlang/module": "*",
+		"@inlang/language-tag": "*",
+		"@inlang/message": "*",
+		"@inlang/plugin": "*",
+		"@inlang/project-config": "*",
+		"@inlang/result": "*",
+		"@lix-js/fs": "*",
+		"@sinclair/typebox": "^0.31.0",
+		"deepmerge-ts": "^5.1.0",
+		"solid-js": "1.6.12",
+		"throttle-debounce": "5.0.0",
+		"ts-dedent": "2.2.0"
+	},
+	"devDependencies": {
+		"@placeholder-company/js-code-style": "*",
+		"@lix-js/fs": "*",
+		"@types/throttle-debounce": "5.0.0",
+		"@vitest/coverage-v8": "^0.33.0",
+		"jsdom": "22.1.0",
+		"patch-package": "6.5.1",
+		"tsd": "^0.25.0",
+		"typescript": "5.2.2",
+		"vitest": "^0.33.0"
+	}
+}