@inlang/sdk 0.7.0 → 0.8.0

package/src/messages/variant.test.ts

@@ -15,7 +15,7 @@ describe("getVariant", () => {
 		const variant = getVariant(mockMessage, {
 			where: {
 				languageTag: "en",
-				selectors: { gender: "female", guestOther: "1" },
+				match: ["female", "1"],
 			},
 		})
 
@@ -31,7 +31,7 @@ describe("getVariant", () => {
 		const variant = getVariant(mockMessage, {
 			where: {
 				languageTag: "en",
-				selectors: { gender: "female", guestOther: "0" },
+				match: ["female", "0"],
 			},
 		})
 		expect(variant?.pattern[0]).toStrictEqual({
@@ -40,7 +40,7 @@ describe("getVariant", () => {
 		})
 	})
 
-	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: Message = {
 			id: "mockMessage",
 			selectors: [],
@@ -48,21 +48,45 @@ describe("getVariant", () => {
 				{
 					languageTag: "en",
 					pattern: [{ type: "Text", value: "Gender male" }],
-					match: {
-						gender: "male",
-					},
+					match: [],
 				},
 				{
 					languageTag: "de",
 					pattern: [{ type: "Text", value: "Veraltete Übersetzung" }],
-					match: {},
+					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: Message = {
+			id: "mockMessage",
+			selectors: [],
+			variants: [
+				{
+					languageTag: "en",
+					pattern: [{ type: "Text", value: "Gender male" }],
+					match: ["male", "*"],
+				},
+				{
+					languageTag: "de",
+					pattern: [{ type: "Text", value: "Veraltete Übersetzung" }],
+					match: ["*", "*"],
 				},
 			],
 		}
 		const variant = getVariant(mockMessage, {
 			where: {
 				languageTag: "fr",
-				selectors: {},
+				match: ["*", "*"],
 			},
 		})
 		expect(variant).toBeUndefined()
@@ -74,7 +98,7 @@ describe("getVariant", () => {
 		const variant = getVariant(mockMessage, {
 			where: {
 				languageTag: "en",
-				selectors: { guestOther: "0" },
+				match: ["*", "0"],
 			},
 		})
 		expect(variant?.pattern[0]).toStrictEqual({
@@ -89,7 +113,7 @@ describe("getVariant", () => {
 		const variant = getVariant(mockMessage, {
 			where: {
 				languageTag: "en",
-				selectors: {},
+				match: ["*", "*"],
 			},
 		})
 		expect(variant?.pattern[0]).toStrictEqual({
@@ -104,7 +128,7 @@ describe("getVariant", () => {
 		const variant = getVariant(mockMessage, {
 			where: {
 				languageTag: "en",
-				selectors: { gender: "trans", guestOther: "2" },
+				match: ["trans", "2"],
 			},
 		})
 		expect(variant?.pattern[0]).toStrictEqual({
@@ -115,7 +139,7 @@ describe("getVariant", () => {
 		const variant2 = getVariant(mockMessage, {
 			where: {
 				languageTag: "en",
-				selectors: { gender: "male", guestOther: "8" },
+				match: ["male", "8"],
 			},
 		})
 		expect(variant2?.pattern[0]).toStrictEqual({
@@ -128,14 +152,14 @@ describe("getVariant", () => {
 		const mockMessage: Message = getMockMessage()
 		mockMessage.variants = [
 			...mockMessage.variants!.filter(
-				(v) => v.languageTag === "en" && (v.match.gender !== "*" || v.match.guestOther !== "*"),
+				(v) => v.languageTag === "en" && (v.match[0] !== "*" || v.match[1] !== "*")
 			),
 		]
 
 		const variant = getVariant(mockMessage, {
 			where: {
 				languageTag: "en",
-				selectors: {},
+				match: ["*", "*"],
 			},
 		})
 		expect(variant).toBeUndefined()
@@ -147,18 +171,19 @@ 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: Message = {} as any
+		mockMessage.selectors = []
 		mockMessage.variants = [
 			{
 				languageTag: "en",
-				match: {},
+				match: ["*", "*"],
 				pattern: [
 					{
 						type: "Text",
@@ -171,13 +196,52 @@ 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: Message = 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.",
 		})
 	})
 })
@@ -188,7 +252,7 @@ describe("createVariant", () => {
 
 		const newVariant: Variant = {
 			languageTag: "en",
-			match: { gender: "female", guestOther: "0" },
+			match: ["female", "0"],
 			pattern: [],
 		}
 		const message = createVariant(mockMessage, {
@@ -197,8 +261,8 @@ describe("createVariant", () => {
 		// should return the female variant
 		expect(
 			message.data!.variants.find(
-				(v) => v.languageTag === "en" && v.match.gender === "female" && v.match.guestOther === "0",
-			)?.pattern,
+				(v) => v.languageTag === "en" && v.match[0] === "female" && v.match[1] === "0"
+			)?.pattern
 		).toStrictEqual([])
 	})
 
@@ -206,22 +270,22 @@ describe("createVariant", () => {
 		const mockMessage: Message = getMockMessage()
 		mockMessage.variants = [
 			...mockMessage.variants!.filter(
-				(v) => v.languageTag === "en" && (v.match.gender !== "*" || v.match.guestOther !== "*"),
+				(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,
+				(v) => v.languageTag === "en" && v.match[0] === "*" && v.match[1] === "*"
+			)?.pattern
 		).toStrictEqual([])
 	})
 
@@ -231,7 +295,7 @@ describe("createVariant", () => {
 		const variant = createVariant(mockMessage, {
 			data: {
 				languageTag: "en",
-				match: { gender: "male", guestOther: "1" },
+				match: ["male", "1"],
 				pattern: [],
 			},
 		})
@@ -246,7 +310,7 @@ describe("createVariant", () => {
 		const variant = createVariant(mockMessage, {
 			data: {
 				languageTag: "de",
-				match: { gender: "female", guestOther: "1" },
+				match: ["female", "1"],
 				pattern: [],
 			},
 		})
@@ -263,15 +327,15 @@ 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,
+				(v) => v.languageTag === "en" && v.match[0] === "female" && v.match[1] === "1"
+			)?.pattern
 		).toStrictEqual([])
 	})
 
@@ -281,15 +345,15 @@ describe("updateVariant", () => {
 		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,
+				(v) => v.languageTag === "en" && v.match[0] === "*" && v.match[1] === "*"
+			)?.pattern
 		).toStrictEqual([])
 	})
 
@@ -298,14 +362,14 @@ describe("updateVariant", () => {
 
 		mockMessage.variants = [
 			...mockMessage.variants!.filter(
-				(v) => v.languageTag === "en" && (v.match.gender !== "*" || v.match.guestOther !== "*"),
+				(v) => v.languageTag === "en" && (v.match[0] !== "*" || v.match[1] !== "*")
 			),
 		]
 
 		const variant = updateVariantPattern(mockMessage, {
 			where: {
 				languageTag: "en",
-				selectors: {},
+				match: ["*", "*"],
 			},
 			data: [],
 		})
@@ -320,7 +384,7 @@ describe("updateVariant", () => {
 		const variant = updateVariantPattern(mockMessage, {
 			where: {
 				languageTag: "de",
-				selectors: {},
+				match: ["*", "*"],
 			},
 			data: [],
 		})
@@ -340,7 +404,7 @@ const getMockMessage = (): Message => {
 		variants: [
 			{
 				languageTag: "en",
-				match: { gender: "female", guestOther: "1" },
+				match: ["female", "1"],
 				pattern: [
 					{
 						type: "Text",
@@ -350,7 +414,7 @@ const getMockMessage = (): Message => {
 			},
 			{
 				languageTag: "en",
-				match: { gender: "female", guestOther: "2" },
+				match: ["female", "2"],
 				pattern: [
 					{
 						type: "Text",
@@ -360,7 +424,7 @@ const getMockMessage = (): Message => {
 			},
 			{
 				languageTag: "en",
-				match: { gender: "female", guestOther: "*" },
+				match: ["female", "*"],
 				pattern: [
 					{
 						type: "Text",
@@ -370,7 +434,7 @@ const getMockMessage = (): Message => {
 			},
 			{
 				languageTag: "en",
-				match: { gender: "male", guestOther: "1" },
+				match: ["male", "1"],
 				pattern: [
 					{
 						type: "Text",
@@ -380,7 +444,7 @@ const getMockMessage = (): Message => {
 			},
 			{
 				languageTag: "en",
-				match: { gender: "male", guestOther: "2" },
+				match: ["male", "2"],
 				pattern: [
 					{
 						type: "Text",
@@ -390,7 +454,7 @@ const getMockMessage = (): Message => {
 			},
 			{
 				languageTag: "en",
-				match: { gender: "male", guestOther: "*" },
+				match: ["male", "*"],
 				pattern: [
 					{
 						type: "Text",
@@ -400,7 +464,7 @@ const getMockMessage = (): Message => {
 			},
 			{
 				languageTag: "en",
-				match: { gender: "*", guestOther: "0" },
+				match: ["*", "0"],
 				pattern: [
 					{
 						type: "Text",
@@ -410,7 +474,7 @@ const getMockMessage = (): Message => {
 			},
 			{
 				languageTag: "en",
-				match: { gender: "*", guestOther: "1" },
+				match: ["*", "1"],
 				pattern: [
 					{
 						type: "Text",
@@ -420,7 +484,7 @@ const getMockMessage = (): Message => {
 			},
 			{
 				languageTag: "en",
-				match: { gender: "*", guestOther: "2" },
+				match: ["*", "2"],
 				pattern: [
 					{
 						type: "Text",
@@ -430,7 +494,7 @@ const getMockMessage = (): Message => {
 			},
 			{
 				languageTag: "en",
-				match: { gender: "*", guestOther: "*" },
+				match: ["*", "*"],
 				pattern: [
 					{
 						type: "Text",

package/src/messages/variant.ts

@@ -14,18 +14,18 @@ import {
  * (if it exists).
  *
  * @example
- * 	const variant = getVariant(message, { where: { languageTag: "en", selectors: { gender: "male" }}});
+ * 	const variant = getVariant(message, { where: { languageTag: "en", match: ["male"]}});
  */
 export function getVariant(
 	message: Message,
 	args: {
 		where: {
 			languageTag: LanguageTag
-			selectors?: Variant["match"]
+			match?: Variant["match"]
 		}
-	},
+	}
 ): Variant | undefined {
-	const variant = matchMostSpecificVariant(message, args.where.languageTag, args.where.selectors)
+	const variant = matchMostSpecificVariant(message, args.where.languageTag, args.where.match)
 	if (variant) {
 		//! do not return a reference to the message in a resource
 		//! modifications to the returned message will leak into the
@@ -47,7 +47,7 @@ export function createVariant(
 	message: Message,
 	args: {
 		data: Variant
-	},
+	}
 ): Result<Message, MessageVariantAlreadyExistsError> {
 	const copy = structuredClone(message)
 
@@ -56,10 +56,9 @@ export function createVariant(
 		return { error: new MessageVariantAlreadyExistsError(message.id, args.data.languageTag) }
 	}
 
-	// need to resolve selectors to match length and order of message selectors
 	copy.variants.push({
 		...args.data,
-		match: resolveSelector(copy.selectors, args.data.match),
+		match: args.data.match,
 	})
 	return { data: copy }
 }
@@ -70,22 +69,22 @@ export function createVariant(
  * All actions are immutable.
  *
  * @example
- *  const message = updateVariant(message, { languageTag: "en", selectors: { gender: "male" }, pattern: []})
+ *  const message = updateVariant(message, { languageTag: "en", match: ["male"], pattern: []})
  */
 export function updateVariantPattern(
 	message: Message,
 	args: {
 		where: {
 			languageTag: LanguageTag
-			selectors: Record<string, string>
+			match: Variant["match"]
 		}
 		data: Variant["pattern"]
-	},
+	}
 ): Result<Message, MessageVariantDoesNotExistError | MessagePatternsForLanguageTagDoNotExistError> {
 	const copy = structuredClone(message)
 
 	const containsLanguageTag = message.variants.some(
-		(variant) => variant.languageTag === args.where.languageTag,
+		(variant) => variant.languageTag === args.where.languageTag
 	)
 	if (!containsLanguageTag) {
 		return {
@@ -93,7 +92,7 @@ export function updateVariantPattern(
 		}
 	}
 
-	const variant = matchVariant(copy, args.where.languageTag, args.where.selectors)
+	const variant = matchVariant(copy, args.where.languageTag, args.where.match)
 	if (variant === undefined) {
 		return { error: new MessageVariantDoesNotExistError(message.id, args.where.languageTag) }
 	}
@@ -108,27 +107,31 @@ export function updateVariantPattern(
  * Returns the specific variant defined by selectors or undefined
  *
  * @example
- *  const variant = matchVariant(message, languageTag: "en", selectors: { gender: "male" })
+ *  const variant = matchVariant(message, languageTag: "en", match: ["male"])
  */
 const matchVariant = (
 	message: Message,
 	languageTag: LanguageTag,
-	selectors: Record<string, string>,
+	match: Variant["match"]
 ): Variant | undefined => {
-	// resolve preferenceSelectors to match length and order of message selectors
-	const resolvedSelectors = resolveSelector(message.selectors, selectors)
-
 	const languageVariants = message.variants.filter((variant) => variant.languageTag === languageTag)
 	if (languageVariants.length === 0) return undefined
 
 	for (const variant of languageVariants) {
 		let isMatch = true
 		//check if vaiant is a match
-		for (const [key, value] of Object.entries(variant.match)) {
-			if (resolvedSelectors[key] !== value) {
-				isMatch = false
-			}
+		if (variant.match.length > 0) {
+			variant.match.map((value, index) => {
+				if (match && match[index] !== value) {
+					isMatch = false
+				}
+			})
 		}
+
+		if (!message.selectors || !match || match.length !== message.selectors.length) {
+			isMatch = false
+		}
+
 		if (isMatch) {
 			return variant
 		}
@@ -145,13 +148,9 @@ const matchVariant = (
 const matchMostSpecificVariant = (
 	message: Message,
 	languageTag: LanguageTag,
-	selectors?: Record<string, string>,
+	match?: Variant["match"]
 ): Variant | undefined => {
-	// make selector undefined if empty object
-	selectors = JSON.stringify(selectors) === "{}" ? undefined : selectors
-
 	// resolve preferenceSelectors to match length and order of message selectors
-	const resolvedSelectors = resolveSelector(message.selectors, selectors)
 	const index: Record<string, any> = {}
 
 	for (const variant of message.variants) {
@@ -159,44 +158,70 @@ const matchMostSpecificVariant = (
 
 		let isMatch = true
 
+		// if slector and stored match are not the same throw error
+		if (variant.match.length !== message.selectors.length) {
+			return undefined
+		}
+
 		//check if variant is a match
-		for (const [key, value] of Object.entries(variant.match)) {
-			if (resolvedSelectors[key] !== value && value !== "*") {
-				isMatch = false
-			}
+		if (variant.match.length > 0) {
+			variant.match.map((value, index) => {
+				if (match && match[index] !== value && value !== "*") {
+					isMatch = false
+				}
+			})
 		}
-		if (isMatch && selectors) {
-			// add variant to nested index
+		if (isMatch && match && match.length > 0) {
 			// eslint-disable-next-line no-inner-declarations
 			function recursiveAddToIndex(
 				currentIndex: Record<string, any>,
-				currentKeys: Message["selectors"],
-				variant: Variant,
+				selectorIndex: number,
+				selectorLength: number,
+				variant: Variant
 			) {
-				if (currentKeys[0]?.name) {
-					const key = variant.match[currentKeys[0].name]
-					if (key) {
-						if (currentKeys.length === 1) {
-							currentIndex[key] = variant
-						} else {
-							if (!currentIndex[key]) {
-								currentIndex[key] = {}
-							}
-							recursiveAddToIndex(currentIndex[key], currentKeys.slice(1), variant)
+				const key = variant.match[selectorIndex]
+				if (key) {
+					if (selectorIndex === 1) {
+						currentIndex[key] = variant
+					} else {
+						if (!currentIndex[key]) {
+							currentIndex[key] = {}
 						}
+						recursiveAddToIndex(currentIndex[key], selectorIndex + 1, selectorLength, variant)
 					}
 				}
 			}
-			recursiveAddToIndex(index, message.selectors, variant)
-		} else if (isMatch && !selectors) {
+			recursiveAddToIndex(index, 0, message.selectors ? message.selectors.length - 1 : 0, variant)
+		} else if (isMatch && !match) {
 			return variant
 		}
 	}
 
+	// if number of selectors and numver of required match is not the same match catch all
+	if (!message.selectors || !match || match.length !== message.selectors.length) {
+		const catchAllMatcher: Array<string> = []
+		const selectorCount = message.selectors.length
+		catchAllMatcher.push("*")
+		for (let i = 0; i < selectorCount - 1; i++) {
+			catchAllMatcher.push("*")
+		}
+		return message.variants.find(
+			(v) =>
+				v.languageTag === languageTag && JSON.stringify(v.match) === JSON.stringify(catchAllMatcher)
+		)
+	}
+
+	// if selector is empty match empty variant match
+	if (message.selectors && message.selectors.length === 0) {
+		return message.variants.find(
+			(v) => v.languageTag === languageTag && JSON.stringify(v.match) === "[]"
+		)
+	}
+
 	//find the most specific variant
 	const findOptimalMatch = (
 		index: Record<string, any>,
-		selectors: string[],
+		selectors: string[]
 	): Variant | undefined => {
 		const keys = Object.keys(index)
 
@@ -218,24 +243,5 @@ const matchMostSpecificVariant = (
 		return undefined
 	}
 
-	return findOptimalMatch(index, Object.values(resolvedSelectors))
-}
-
-/**
- * Returns resolved selector.
- * -> Adds all possible selectors, if not defined it adds '*'. Order is determined by messageSelectors
- *
- * @example
- *  const variant = resolveSelector(["gender","count"], selector: {count: "2"})
- */
-const resolveSelector = (
-	messageSelectors: Message["selectors"],
-	selectors?: Record<string, string>,
-): Record<string, string> => {
-	const resolvedSelectors: Record<string, string> = {}
-	if (!selectors) return {}
-	for (const messageSelector of messageSelectors) {
-		resolvedSelectors[messageSelector.name] = selectors[messageSelector.name] ?? "*"
-	}
-	return resolvedSelectors
+	return findOptimalMatch(index, match || [])
 }

package/src/parseConfig.ts

@@ -16,7 +16,7 @@ export class ParseConfigError extends Error {
 const ConfigCompiler = TypeCompiler.Compile(ProjectSettings)
 
 export const parseSettings = (
-	config: ProjectSettings,
+	config: ProjectSettings
 ): Result<ProjectSettings, ParseConfigError> => {
 	if (ConfigCompiler.Check(config)) {
 		return {
@@ -27,7 +27,7 @@ export const parseSettings = (
 		return {
 			error: new ParseConfigError(
 				"The inlang config is not valid.",
-				[...ConfigCompiler.Errors(config)].toString(),
+				[...ConfigCompiler.Errors(config)].toString()
 			),
 			data: undefined as never,
 		}