@inlang/sdk 0.16.0 → 0.17.0

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

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/resolve-modules/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAC1D,cAAc,qBAAqB,CAAA;AACnC,cAAc,gCAAgC,CAAA;AAE9C,qBAAa,WAAY,SAAQ,KAAK;IACrC,SAAgB,MAAM,EAAE,MAAM,CAAA;gBAElB,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE;CAMvE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,WAAW;gBAC3C,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE;CAOtD;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;gBACrC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE;CAIrD;AAED,qBAAa,0BAA2B,SAAQ,WAAW;gBAC9C,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,UAAU,EAAE,CAAA;KAAE;CAS7D;AAED,qBAAa,6BAA8B,SAAQ,WAAW;gBACjD,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,UAAU,EAAE,CAAA;KAAE;CAS7D"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/resolve-modules/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAC1D,cAAc,qBAAqB,CAAA;AACnC,cAAc,gCAAgC,CAAA;AAE9C,qBAAa,WAAY,SAAQ,KAAK;IACrC,SAAgB,MAAM,EAAE,MAAM,CAAA;gBAElB,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE;CAMvE;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,WAAW;gBAC3C,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE;CAOtD;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;gBACrC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE;CAIrD;AAED,qBAAa,0BAA2B,SAAQ,WAAW;gBAC9C,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,UAAU,EAAE,CAAA;KAAE;CAY7D;AAED,qBAAa,6BAA8B,SAAQ,WAAW;gBACjD,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,UAAU,EAAE,CAAA;KAAE;CAc7D"}

package/dist/resolve-modules/errors.js

@@ -30,15 +30,15 @@ export class ModuleImportError extends ModuleError {
 export class ModuleExportIsInvalidError extends ModuleError {
     constructor(options) {
         super(`The export(s) of "${options.module}" are invalid:\n\n${options.errors
-            .map((error) => `"${error.path}" "${error.value}": "${error.message}"`)
+            .map((error) => `"${error.path}" "${JSON.stringify(error.value, undefined, 2)}": "${error.message}"`)
             .join("\n")}`, options);
         this.name = "ModuleExportIsInvalidError";
     }
 }
 export class ModuleSettingsAreInvalidError extends ModuleError {
     constructor(options) {
-        super(`The settings are invalid of "${module}" are invalid:\n\n${options.errors
-            .map((error) => `Path "${error.path}" with value "${error.value}": "${error.message}"`)
+        super(`The settings are invalid of "${options.module}" 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 = "ModuleSettingsAreInvalidError";
     }

package/dist/resolve-modules/plugins/resolvePlugins.test.js

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import { describe, expect, it } from "vitest";
 import { resolvePlugins } from "./resolvePlugins.js";
-import { PluginLoadMessagesFunctionAlreadyDefinedError, PluginSaveMessagesFunctionAlreadyDefinedError, PluginHasInvalidIdError, PluginReturnedInvalidCustomApiError, PluginHasInvalidSchemaError, PluginsDoNotProvideLoadOrSaveMessagesError, } from "./errors.js";
+import { PluginLoadMessagesFunctionAlreadyDefinedError, PluginSaveMessagesFunctionAlreadyDefinedError, PluginHasInvalidIdError, PluginReturnedInvalidCustomApiError, PluginsDoNotProvideLoadOrSaveMessagesError, } from "./errors.js";
 it("should return an error if a plugin uses an invalid id", async () => {
     const mockPlugin = {
         // @ts-expect-error - invalid id
@@ -18,25 +18,6 @@ it("should return an error if a plugin uses an invalid id", async () => {
     });
     expect(resolved.errors[0]).toBeInstanceOf(PluginHasInvalidIdError);
 });
-it("should return an error if a plugin uses APIs that are not available", async () => {
-    const mockPlugin = {
-        id: "plugin.namespace.undefinedApi",
-        description: { en: "My plugin description" },
-        displayName: { en: "My plugin" },
-        // @ts-expect-error the key is not available in type
-        nonExistentKey: {
-            nonexistentOptions: "value",
-        },
-        loadMessages: () => undefined,
-        saveMessages: () => undefined,
-    };
-    const resolved = await resolvePlugins({
-        plugins: [mockPlugin],
-        settings: {},
-        nodeishFs: {},
-    });
-    expect(resolved.errors[0]).toBeInstanceOf(PluginHasInvalidSchemaError);
-});
 it("should expose the project settings including the plugin settings", async () => {
     const settings = {
         sourceLanguageTag: "en",

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

@@ -7,12 +7,16 @@ import { validatedModuleSettings } from "./validatedModuleSettings.js";
 const mockPluginSchema = Type.Object({
     pathPattern: Type.Union([
         Type.String({
-            pattern: "^[^*]*\\{languageTag\\}[^*]*\\.json",
-            description: "The PluginSettings must contain `{languageTag}` and end with `.json`.",
+            pattern: "^(\\./|\\../|/)[^*]*\\{languageTag\\}[^*]*\\.json",
+            description: "The pathPattern must contain `{languageTag}` and end with `.json`.",
         }),
-        Type.Record(Type.String({}), Type.String({
-            pattern: "^[^*]*\\{languageTag\\}[^*]*\\.json",
-            description: "The PluginSettings must contain `{languageTag}` and end with `.json`.",
+        Type.Record(Type.String({
+            pattern: "^[^.]+$",
+            description: "Dots are not allowd ",
+            examples: ["website", "app", "homepage"],
+        }), Type.String({
+            pattern: "^(\\./|\\../|/)[^*]*\\{languageTag\\}[^*]*\\.json",
+            description: "The pathPattern must contain `{languageTag}` and end with `.json`.",
         })),
     ]),
     variableReferencePattern: Type.Array(Type.String()),
@@ -33,14 +37,19 @@ test("if PluginSchema does match with the moduleSettings", async () => {
     });
     expect(isValid).toBe("isValid");
 });
-test("if invalid module settings would pass", async () => {
+test("if namespace settings are valide", async () => {
     const isValid = validatedModuleSettings({
         settingsSchema: mockPluginSchema,
         moduleSettings: {
-            pathPattern: "./examples/example01/{languageTag}.json",
+            pathPattern: {
+                website: "./{languageTag}examplerFolder/ExampleFile.json",
+                app: "../{languageTag}examplerFolder/ExampleFile.json",
+                footer: "./{languageTag}examplerFolder/ExampleFile.json",
+            },
+            variableReferencePattern: ["{", "}"],
         },
     });
-    expect(isValid).not.toBe("isValid");
+    expect(isValid).toBe("isValid");
 });
 test(" if MessageLintRuleSchema  match with the settings", async () => {
     const isValid = await validatedModuleSettings({

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

@@ -1 +1 @@
-{"version":3,"file":"validatedModuleSettings.d.ts","sourceRoot":"","sources":["../../src/resolve-modules/validatedModuleSettings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAG,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAEnD,OAAO,EAAS,KAAK,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEhE,eAAO,MAAM,uBAAuB,SAAU;IAC7C,cAAc,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAA;IACzD,cAAc,EAAE,OAAO,CAAA;CACvB,KAAG,SAAS,GAAG,UAAU,EAWzB,CAAA"}
+{"version":3,"file":"validatedModuleSettings.d.ts","sourceRoot":"","sources":["../../src/resolve-modules/validatedModuleSettings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAElD,OAAO,EAAS,KAAK,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEhE,eAAO,MAAM,uBAAuB,SAAU;IAC7C,cAAc,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAA;IACzD,cAAc,EAAE,OAAO,CAAA;CACvB,KAAG,SAAS,GAAG,UAAU,EAWzB,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@inlang/sdk",
 	"type": "module",
-	"version": "0.16.0",
+	"version": "0.17.0",
 	"license": "Apache-2.0",
 	"publishConfig": {
 		"access": "public"

package/src/resolve-modules/errors.ts

@@ -40,7 +40,10 @@ export class ModuleExportIsInvalidError extends ModuleError {
 	constructor(options: { module: string; errors: ValueError[] }) {
 		super(
 			`The export(s) of "${options.module}" are invalid:\n\n${options.errors
-				.map((error) => `"${error.path}" "${error.value}": "${error.message}"`)
+				.map(
+					(error) =>
+						`"${error.path}" "${JSON.stringify(error.value, undefined, 2)}": "${error.message}"`
+				)
 				.join("\n")}`,
 			options
 		)
@@ -51,8 +54,13 @@ export class ModuleExportIsInvalidError extends ModuleError {
 export class ModuleSettingsAreInvalidError extends ModuleError {
 	constructor(options: { module: string; errors: ValueError[] }) {
 		super(
-			`The settings are invalid of "${module}" are invalid:\n\n${options.errors
-				.map((error) => `Path "${error.path}" with value "${error.value}": "${error.message}"`)
+			`The settings are invalid of "${options.module}" are invalid:\n\n${options.errors
+				.map(
+					(error) =>
+						`Path "${error.path}" with value "${JSON.stringify(error.value, undefined, 2)}": "${
+							error.message
+						}"`
+				)
 				.join("\n")}`,
 			options
 		)

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

@@ -6,7 +6,6 @@ import {
 	PluginSaveMessagesFunctionAlreadyDefinedError,
 	PluginHasInvalidIdError,
 	PluginReturnedInvalidCustomApiError,
-	PluginHasInvalidSchemaError,
 	PluginsDoNotProvideLoadOrSaveMessagesError,
 } from "./errors.js"
 import type { Plugin } from "@inlang/plugin"
@@ -31,28 +30,6 @@ it("should return an error if a plugin uses an invalid id", async () => {
 	expect(resolved.errors[0]).toBeInstanceOf(PluginHasInvalidIdError)
 })
 
-it("should return an error if a plugin uses APIs that are not available", async () => {
-	const mockPlugin: Plugin = {
-		id: "plugin.namespace.undefinedApi",
-		description: { en: "My plugin description" },
-		displayName: { en: "My plugin" },
-		// @ts-expect-error the key is not available in type
-		nonExistentKey: {
-			nonexistentOptions: "value",
-		},
-		loadMessages: () => undefined as any,
-		saveMessages: () => undefined as any,
-	}
-
-	const resolved = await resolvePlugins({
-		plugins: [mockPlugin],
-		settings: {} as any,
-		nodeishFs: {} as any,
-	})
-
-	expect(resolved.errors[0]).toBeInstanceOf(PluginHasInvalidSchemaError)
-})
-
 it("should expose the project settings including the plugin settings", async () => {
 	const settings: ProjectSettings = {
 		sourceLanguageTag: "en",

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

@@ -8,14 +8,18 @@ import { validatedModuleSettings } from "./validatedModuleSettings.js"
 const mockPluginSchema: Plugin["settingsSchema"] = Type.Object({
 	pathPattern: Type.Union([
 		Type.String({
-			pattern: "^[^*]*\\{languageTag\\}[^*]*\\.json",
-			description: "The PluginSettings must contain `{languageTag}` and end with `.json`.",
+			pattern: "^(\\./|\\../|/)[^*]*\\{languageTag\\}[^*]*\\.json",
+			description: "The pathPattern must contain `{languageTag}` and end with `.json`.",
 		}),
 		Type.Record(
-			Type.String({}),
 			Type.String({
-				pattern: "^[^*]*\\{languageTag\\}[^*]*\\.json",
-				description: "The PluginSettings must contain `{languageTag}` and end with `.json`.",
+				pattern: "^[^.]+$",
+				description: "Dots are not allowd ",
+				examples: ["website", "app", "homepage"],
+			}),
+			Type.String({
+				pattern: "^(\\./|\\../|/)[^*]*\\{languageTag\\}[^*]*\\.json",
+				description: "The pathPattern must contain `{languageTag}` and end with `.json`.",
 			})
 		),
 	]),
@@ -43,14 +47,19 @@ test("if PluginSchema does match with the moduleSettings", async () => {
 	expect(isValid).toBe("isValid")
 })
 
-test("if invalid module settings would pass", async () => {
+test("if namespace settings are valide", async () => {
 	const isValid = validatedModuleSettings({
 		settingsSchema: mockPluginSchema,
 		moduleSettings: {
-			pathPattern: "./examples/example01/{languageTag}.json",
+			pathPattern: {
+				website: "./{languageTag}examplerFolder/ExampleFile.json",
+				app: "../{languageTag}examplerFolder/ExampleFile.json",
+				footer: "./{languageTag}examplerFolder/ExampleFile.json",
+			},
+			variableReferencePattern: ["{", "}"],
 		},
 	})
-	expect(isValid).not.toBe("isValid")
+	expect(isValid).toBe("isValid")
 })
 
 test(" if MessageLintRuleSchema  match with the settings", async () => {

package/src/resolve-modules/validatedModuleSettings.ts

@@ -1,4 +1,4 @@
-import type {  InlangModule } from "@inlang/module"
+import type { InlangModule } from "@inlang/module"
 import type { TSchema } from "@sinclair/typebox"
 import { Value, type ValueError } from "@sinclair/typebox/value"