@inlang/sdk 0.7.0 → 0.8.0

package/dist/messages/variant.test.js

@@ -8,7 +8,7 @@ describe("getVariant", () => {
         const variant = getVariant(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: { gender: "female", guestOther: "1" },
+                match: ["female", "1"],
             },
         });
         expect(variant?.pattern[0]).toStrictEqual({
@@ -21,7 +21,7 @@ describe("getVariant", () => {
         const variant = getVariant(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: { gender: "female", guestOther: "0" },
+                match: ["female", "0"],
             },
         });
         expect(variant?.pattern[0]).toStrictEqual({
@@ -29,7 +29,7 @@ describe("getVariant", () => {
             value: "{$hostName} invites {$guestName} and {$guestsOther} other people to her party.",
         });
     });
-    test("it should return undefined (but never throw an error) if selectors is an empty array", () => {
+    test("it should not throw error if selector is empty and match", () => {
         const mockMessage = {
             id: "mockMessage",
             selectors: [],
@@ -37,21 +37,44 @@ describe("getVariant", () => {
                 {
                     languageTag: "en",
                     pattern: [{ type: "Text", value: "Gender male" }],
-                    match: {
-                        gender: "male",
-                    },
+                    match: [],
+                },
+                {
+                    languageTag: "de",
+                    pattern: [{ type: "Text", value: "Veraltete Übersetzung" }],
+                    match: [],
+                },
+            ],
+        };
+        const variant = getVariant(mockMessage, {
+            where: {
+                languageTag: "en",
+                match: [],
+            },
+        });
+        expect(variant).toBeDefined();
+    });
+    test("it should not throw error if selector is empty, return undefined", () => {
+        const mockMessage = {
+            id: "mockMessage",
+            selectors: [],
+            variants: [
+                {
+                    languageTag: "en",
+                    pattern: [{ type: "Text", value: "Gender male" }],
+                    match: ["male", "*"],
                 },
                 {
                     languageTag: "de",
                     pattern: [{ type: "Text", value: "Veraltete Übersetzung" }],
-                    match: {},
+                    match: ["*", "*"],
                 },
             ],
         };
         const variant = getVariant(mockMessage, {
             where: {
                 languageTag: "fr",
-                selectors: {},
+                match: ["*", "*"],
             },
         });
         expect(variant).toBeUndefined();
@@ -61,7 +84,7 @@ describe("getVariant", () => {
         const variant = getVariant(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: { guestOther: "0" },
+                match: ["*", "0"],
             },
         });
         expect(variant?.pattern[0]).toStrictEqual({
@@ -74,7 +97,7 @@ describe("getVariant", () => {
         const variant = getVariant(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: {},
+                match: ["*", "*"],
             },
         });
         expect(variant?.pattern[0]).toStrictEqual({
@@ -87,7 +110,7 @@ describe("getVariant", () => {
         const variant = getVariant(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: { gender: "trans", guestOther: "2" },
+                match: ["trans", "2"],
             },
         });
         expect(variant?.pattern[0]).toStrictEqual({
@@ -97,7 +120,7 @@ describe("getVariant", () => {
         const variant2 = getVariant(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: { gender: "male", guestOther: "8" },
+                match: ["male", "8"],
             },
         });
         expect(variant2?.pattern[0]).toStrictEqual({
@@ -108,12 +131,12 @@ describe("getVariant", () => {
     test("should return undefined of no variant matches", () => {
         const mockMessage = getMockMessage();
         mockMessage.variants = [
-            ...mockMessage.variants.filter((v) => v.languageTag === "en" && (v.match.gender !== "*" || v.match.guestOther !== "*")),
+            ...mockMessage.variants.filter((v) => v.languageTag === "en" && (v.match[0] !== "*" || v.match[1] !== "*")),
         ];
         const variant = getVariant(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: {},
+                match: ["*", "*"],
             },
         });
         expect(variant).toBeUndefined();
@@ -123,17 +146,18 @@ describe("getVariant", () => {
         const variant = getVariant(mockMessage, {
             where: {
                 languageTag: "de",
-                selectors: { gender: "female", guestOther: "1" },
+                match: ["female", "1"],
             },
         });
         expect(variant).toBeUndefined();
     });
-    test("should return the catch all variant if no selector defined", () => {
+    test("should return undefined variant if no selector defined", () => {
         const mockMessage = {};
+        mockMessage.selectors = [];
         mockMessage.variants = [
             {
                 languageTag: "en",
-                match: {},
+                match: ["*", "*"],
                 pattern: [
                     {
                         type: "Text",
@@ -145,13 +169,46 @@ describe("getVariant", () => {
         const variant = getVariant(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: {},
+                match: ["*", "*"],
             },
         });
-        // should return the female variant
-        expect(variant?.pattern[0]).toStrictEqual({
+        // should return undefined
+        expect(variant).toBeUndefined();
+    });
+    test("should match catch all if the number of matches and selectors do not match", () => {
+        const mockMessage = getMockMessage();
+        const variant1 = getVariant(mockMessage, {
+            where: {
+                languageTag: "en",
+                match: ["12"],
+            },
+        });
+        // should return catch all
+        expect(variant1?.pattern[0]).toStrictEqual({
             type: "Text",
-            value: "test",
+            value: "{$hostName} invites {$guestName} and {$guestsOther} other people to their party.",
+        });
+        const variant2 = getVariant(mockMessage, {
+            where: {
+                languageTag: "en",
+                match: ["12", "*", "23"],
+            },
+        });
+        // should return catch all
+        expect(variant2?.pattern[0]).toStrictEqual({
+            type: "Text",
+            value: "{$hostName} invites {$guestName} and {$guestsOther} other people to their party.",
+        });
+        const variant3 = getVariant(mockMessage, {
+            where: {
+                languageTag: "en",
+                match: [],
+            },
+        });
+        // should return catch all
+        expect(variant3?.pattern[0]).toStrictEqual({
+            type: "Text",
+            value: "{$hostName} invites {$guestName} and {$guestsOther} other people to their party.",
         });
     });
 });
@@ -160,36 +217,36 @@ describe("createVariant", () => {
         const mockMessage = getMockMessage();
         const newVariant = {
             languageTag: "en",
-            match: { gender: "female", guestOther: "0" },
+            match: ["female", "0"],
             pattern: [],
         };
         const message = createVariant(mockMessage, {
             data: newVariant,
         });
         // should return the female variant
-        expect(message.data.variants.find((v) => v.languageTag === "en" && v.match.gender === "female" && v.match.guestOther === "0")?.pattern).toStrictEqual([]);
+        expect(message.data.variants.find((v) => v.languageTag === "en" && v.match[0] === "female" && v.match[1] === "0")?.pattern).toStrictEqual([]);
     });
     test("should create a variant, also if matcher are not full defined", () => {
         const mockMessage = getMockMessage();
         mockMessage.variants = [
-            ...mockMessage.variants.filter((v) => v.languageTag === "en" && (v.match.gender !== "*" || v.match.guestOther !== "*")),
+            ...mockMessage.variants.filter((v) => v.languageTag === "en" && (v.match[0] !== "*" || v.match[1] !== "*")),
         ];
         const message = createVariant(mockMessage, {
             data: {
                 languageTag: "en",
-                match: {},
+                match: ["*", "*"],
                 pattern: [],
             },
         });
         // should return the female variant
-        expect(message.data.variants.find((v) => v.languageTag === "en" && v.match.gender === "*" && v.match.guestOther === "*")?.pattern).toStrictEqual([]);
+        expect(message.data.variants.find((v) => v.languageTag === "en" && v.match[0] === "*" && v.match[1] === "*")?.pattern).toStrictEqual([]);
     });
     test("should return error if variant matches", () => {
         const mockMessage = getMockMessage();
         const variant = createVariant(mockMessage, {
             data: {
                 languageTag: "en",
-                match: { gender: "male", guestOther: "1" },
+                match: ["male", "1"],
                 pattern: [],
             },
         });
@@ -202,7 +259,7 @@ describe("createVariant", () => {
         const variant = createVariant(mockMessage, {
             data: {
                 languageTag: "de",
-                match: { gender: "female", guestOther: "1" },
+                match: ["female", "1"],
                 pattern: [],
             },
         });
@@ -217,34 +274,34 @@ describe("updateVariant", () => {
         const message = updateVariantPattern(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: { gender: "female", guestOther: "1" },
+                match: ["female", "1"],
             },
             data: [],
         });
         // should return the female variant
-        expect(message.data.variants.find((v) => v.languageTag === "en" && v.match.gender === "female" && v.match.guestOther === "1")?.pattern).toStrictEqual([]);
+        expect(message.data.variants.find((v) => v.languageTag === "en" && v.match[0] === "female" && v.match[1] === "1")?.pattern).toStrictEqual([]);
     });
     test("should update a variant, also if matcher are not full defined", () => {
         const mockMessage = getMockMessage();
         const message = updateVariantPattern(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: {},
+                match: ["*", "*"],
             },
             data: [],
         });
         // should return the female variant
-        expect(message.data.variants.find((v) => v.languageTag === "en" && v.match.gender === "*" && v.match.guestOther === "*")?.pattern).toStrictEqual([]);
+        expect(message.data.variants.find((v) => v.languageTag === "en" && v.match[0] === "*" && v.match[1] === "*")?.pattern).toStrictEqual([]);
     });
     test("should return error if no variant matches", () => {
         const mockMessage = getMockMessage();
         mockMessage.variants = [
-            ...mockMessage.variants.filter((v) => v.languageTag === "en" && (v.match.gender !== "*" || v.match.guestOther !== "*")),
+            ...mockMessage.variants.filter((v) => v.languageTag === "en" && (v.match[0] !== "*" || v.match[1] !== "*")),
         ];
         const variant = updateVariantPattern(mockMessage, {
             where: {
                 languageTag: "en",
-                selectors: {},
+                match: ["*", "*"],
             },
             data: [],
         });
@@ -257,7 +314,7 @@ describe("updateVariant", () => {
         const variant = updateVariantPattern(mockMessage, {
             where: {
                 languageTag: "de",
-                selectors: {},
+                match: ["*", "*"],
             },
             data: [],
         });
@@ -276,7 +333,7 @@ const getMockMessage = () => {
         variants: [
             {
                 languageTag: "en",
-                match: { gender: "female", guestOther: "1" },
+                match: ["female", "1"],
                 pattern: [
                     {
                         type: "Text",
@@ -286,7 +343,7 @@ const getMockMessage = () => {
             },
             {
                 languageTag: "en",
-                match: { gender: "female", guestOther: "2" },
+                match: ["female", "2"],
                 pattern: [
                     {
                         type: "Text",
@@ -296,7 +353,7 @@ const getMockMessage = () => {
             },
             {
                 languageTag: "en",
-                match: { gender: "female", guestOther: "*" },
+                match: ["female", "*"],
                 pattern: [
                     {
                         type: "Text",
@@ -306,7 +363,7 @@ const getMockMessage = () => {
             },
             {
                 languageTag: "en",
-                match: { gender: "male", guestOther: "1" },
+                match: ["male", "1"],
                 pattern: [
                     {
                         type: "Text",
@@ -316,7 +373,7 @@ const getMockMessage = () => {
             },
             {
                 languageTag: "en",
-                match: { gender: "male", guestOther: "2" },
+                match: ["male", "2"],
                 pattern: [
                     {
                         type: "Text",
@@ -326,7 +383,7 @@ const getMockMessage = () => {
             },
             {
                 languageTag: "en",
-                match: { gender: "male", guestOther: "*" },
+                match: ["male", "*"],
                 pattern: [
                     {
                         type: "Text",
@@ -336,7 +393,7 @@ const getMockMessage = () => {
             },
             {
                 languageTag: "en",
-                match: { gender: "*", guestOther: "0" },
+                match: ["*", "0"],
                 pattern: [
                     {
                         type: "Text",
@@ -346,7 +403,7 @@ const getMockMessage = () => {
             },
             {
                 languageTag: "en",
-                match: { gender: "*", guestOther: "1" },
+                match: ["*", "1"],
                 pattern: [
                     {
                         type: "Text",
@@ -356,7 +413,7 @@ const getMockMessage = () => {
             },
             {
                 languageTag: "en",
-                match: { gender: "*", guestOther: "2" },
+                match: ["*", "2"],
                 pattern: [
                     {
                         type: "Text",
@@ -366,7 +423,7 @@ const getMockMessage = () => {
             },
             {
                 languageTag: "en",
-                match: { gender: "*", guestOther: "*" },
+                match: ["*", "*"],
                 pattern: [
                     {
                         type: "Text",

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

@@ -4,7 +4,7 @@ export declare const createMessage: (id: string, patterns: Record<string, Patter
     selectors: never[];
     variants: {
         languageTag: string;
-        match: {};
+        match: never[];
         pattern: ({
             type: "Text";
             value: string;

package/dist/test-utilities/createMessage.js

@@ -3,7 +3,7 @@ export const createMessage = (id, patterns) => ({
     selectors: [],
     variants: Object.entries(patterns).map(([languageTag, patterns]) => ({
         languageTag,
-        match: {},
+        match: [],
         pattern: typeof patterns === "string"
             ? [
                 {

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

@@ -10,7 +10,7 @@ test("should create a simple message", () => {
 		  "variants": [
 		    {
 		      "languageTag": "de",
-		      "match": {},
+		      "match": [],
 		      "pattern": [
 		        {
 		          "type": "Text",
@@ -36,7 +36,7 @@ test("should create a message with pattern", () => {
 			  "variants": [
 			    {
 			      "languageTag": "en",
-			      "match": {},
+			      "match": [],
 			      "pattern": [
 			        {
 			          "type": "Text",
@@ -67,7 +67,7 @@ test("should create a message with a pattern", () => {
 			  "variants": [
 			    {
 			      "languageTag": "en",
-			      "match": {},
+			      "match": [],
 			      "pattern": [
 			        {
 			          "type": "Text",
@@ -77,7 +77,7 @@ test("should create a message with a pattern", () => {
 			    },
 			    {
 			      "languageTag": "de",
-			      "match": {},
+			      "match": [],
 			      "pattern": [
 			        {
 			          "type": "Text",

package/package.json

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

package/src/adapter/solidAdapter.test.ts

@@ -44,7 +44,7 @@ const exampleMessages: Message[] = [
 		variants: [
 			{
 				languageTag: "en",
-				match: {},
+				match: [],
 				pattern: [
 					{
 						type: "Text",
@@ -60,7 +60,7 @@ const exampleMessages: Message[] = [
 		variants: [
 			{
 				languageTag: "en",
-				match: {},
+				match: [],
 				pattern: [
 					{
 						type: "Text",
@@ -95,7 +95,7 @@ describe("config", () => {
 				nodeishFs: fs,
 				_import: $import,
 			}),
-			{ from },
+			{ from }
 		)
 
 		let counter = 0
@@ -125,7 +125,7 @@ describe("installed", () => {
 				nodeishFs: fs,
 				_import: $import,
 			}),
-			{ from },
+			{ from }
 		)
 		let counterPlugins = 0
 		let counterLint = 0
@@ -188,7 +188,7 @@ describe("messages", () => {
 				nodeishFs: fs,
 				_import: mockImport,
 			}),
-			{ from },
+			{ from }
 		)
 
 		let counter = 0
@@ -217,7 +217,7 @@ describe("messages", () => {
 				nodeishFs: fs,
 				_import: $import,
 			}),
-			{ from },
+			{ from }
 		)
 
 		let counter = 0
@@ -232,7 +232,7 @@ describe("messages", () => {
 			(
 				Object.values(messagesBefore())[0]?.variants.find((variant) => variant.languageTag === "en")
 					?.pattern[0] as Text
-			).value,
+			).value
 		).toBe("test")
 
 		project.query.messages.update({
@@ -243,7 +243,7 @@ describe("messages", () => {
 				variants: [
 					{
 						languageTag: "en",
-						match: {},
+						match: [],
 						pattern: [
 							{
 								type: "Text",
@@ -262,7 +262,7 @@ describe("messages", () => {
 			(
 				Object.values(messagesAfter())[0]?.variants.find((variant) => variant.languageTag === "en")
 					?.pattern[0] as Text
-			).value,
+			).value
 		).toBe("test2")
 	})
 })
@@ -278,7 +278,7 @@ describe("lint", () => {
 					nodeishFs: fs,
 					_import: $import,
 				}),
-				{ from },
+				{ from }
 			)
 
 			let counter = 0
@@ -316,7 +316,7 @@ describe("lint", () => {
 					nodeishFs: fs,
 					_import: $import,
 				}),
-				{ from },
+				{ from }
 			)
 
 			let counter = 0
@@ -329,7 +329,7 @@ describe("lint", () => {
 				where: { id: "a" },
 				data: {
 					...exampleMessages[0],
-					variants: [{ languageTag: "en", match: {}, pattern: [{ type: "Text", value: "new" }] }],
+					variants: [{ languageTag: "en", match: [], pattern: [{ type: "Text", value: "new" }] }],
 				},
 			})
 
@@ -342,7 +342,7 @@ describe("lint", () => {
 				where: { id: "a" },
 				data: {
 					...exampleMessages[0],
-					variants: [{ languageTag: "en", match: {}, pattern: [{ type: "Text", value: "new" }] }],
+					variants: [{ languageTag: "en", match: [], pattern: [{ type: "Text", value: "new" }] }],
 				},
 			})
 

package/src/adapter/solidAdapter.ts

@@ -6,7 +6,7 @@ export const solidAdapter = (
 	project: InlangProject,
 	arg: {
 		from: typeof solidFrom
-	},
+	}
 ): InlangProjectWithSolidAdapter => {
 	const convert = <T>(signal: () => T): (() => T) => {
 		return arg.from(observable(signal)) as () => T

package/src/api.ts

@@ -64,7 +64,7 @@ export type MessageQueryApi = {
 	get: ((args: { where: { id: Message["id"] } }) => Readonly<Message>) & {
 		subscribe: (
 			args: { where: { id: Message["id"] } },
-			callback: (message: Message) => void,
+			callback: (message: Message) => void
 		) => void
 	}
 	includedMessageIds: Subscribable<Message["id"][]>
@@ -84,7 +84,7 @@ export type MessageLintReportsQueryApi = {
 	}) => Readonly<MessageLintReport[]>) & {
 		subscribe: (
 			args: { where: { messageId: MessageLintReport["messageId"] } },
-			callback: (MessageLintRules: Readonly<MessageLintReport[]>) => void,
+			callback: (MessageLintRules: Readonly<MessageLintReport[]>) => void
 		) => void
 	}
 }

package/src/createMessageLintReportsQuery.ts

@@ -14,7 +14,7 @@ export function createMessageLintReportsQuery(
 	messages: () => Array<Message> | undefined,
 	settings: () => ProjectSettings,
 	installedMessageLintRules: () => Array<InstalledMessageLintRule>,
-	resolvedModules: () => Awaited<ReturnType<typeof resolveModules>> | undefined,
+	resolvedModules: () => Awaited<ReturnType<typeof resolveModules>> | undefined
 ): InlangProject["query"]["messageLintReports"] {
 	// @ts-expect-error
 	const index = new ReactiveMap<MessageLintReport["messageId"], MessageLintReport[]>()
@@ -34,7 +34,7 @@ export function createMessageLintReportsQuery(
 					settings: {
 						..._settings,
 						messageLintRuleLevels: Object.fromEntries(
-							installedMessageLintRules().map((rule) => [rule.id, rule.level]),
+							installedMessageLintRules().map((rule) => [rule.id, rule.level])
 						),
 					},
 					messages: _messages,
@@ -58,13 +58,13 @@ export function createMessageLintReportsQuery(
 	return {
 		getAll: createSubscribable(() => {
 			return structuredClone(
-				[...index.values()].flat().length === 0 ? [] : [...index.values()].flat(),
+				[...index.values()].flat().length === 0 ? [] : [...index.values()].flat()
 			)
 		}),
 		get: Object.assign(get, {
 			subscribe: (
 				args: Parameters<MessageLintReportsQueryApi["get"]["subscribe"]>[0],
-				callback: Parameters<MessageLintReportsQueryApi["get"]["subscribe"]>[1],
+				callback: Parameters<MessageLintReportsQueryApi["get"]["subscribe"]>[1]
 			) => createSubscribable(() => get(args)).subscribe(callback),
 		}) as any,
 	}