@inlang/sdk 0.7.0 → 0.8.0

package/src/createMessagesQuery.test.ts

@@ -54,10 +54,10 @@ describe("get", () => {
 		const message2 = query.get({ where: { id: "first-message" } })!
 
 		expect(
-			(message1.variants.find((v) => v.languageTag === "en")!.pattern![0]! as Text).value,
+			(message1.variants.find((v) => v.languageTag === "en")!.pattern![0]! as Text).value
 		).toBe("Hello World 2")
 		expect(
-			(message2.variants.find((v) => v.languageTag === "en")!.pattern![0]! as Text).value,
+			(message2.variants.find((v) => v.languageTag === "en")!.pattern![0]! as Text).value
 		).toBe("Hello World")
 	})
 })
@@ -94,7 +94,7 @@ describe("getAll", () => {
 			(
 				Object.values(query.getAll()!)[0]!.variants.find((v) => v.languageTag === "en")!
 					.pattern![0]! as Text
-			).value,
+			).value
 		).toBe("Hello World")
 	})
 })
@@ -194,13 +194,13 @@ describe("reactivity", () => {
 				expect(message).toBeDefined()
 				expect(
 					(message?.variants.find((variant) => variant.languageTag === "en")?.pattern[0] as Text)
-						.value,
+						.value
 				).toBe("before")
 
 				query.update({ where: { id: "1" }, data: createMessage("1", { en: "after" }) })
 				expect(
 					(message?.variants.find((variant) => variant.languageTag === "en")?.pattern[0] as Text)
-						.value,
+						.value
 				).toBe("after")
 			})
 		})
@@ -217,13 +217,13 @@ describe("reactivity", () => {
 				expect(message).toBeDefined()
 				expect(
 					(message?.variants.find((variant) => variant.languageTag === "en")?.pattern[0] as Text)
-						.value,
+						.value
 				).toBe("before")
 
 				query.upsert({ where: { id: "1" }, data: createMessage("1", { en: "after" }) })
 				expect(
 					(message?.variants.find((variant) => variant.languageTag === "en")?.pattern[0] as Text)
-						.value,
+						.value
 				).toBe("after")
 			})
 		})
@@ -254,14 +254,14 @@ describe("reactivity", () => {
 			expect(message).toBeDefined()
 			expect(
 				(message!.variants.find((variant) => variant.languageTag === "en")?.pattern[0] as Text)
-					.value,
+					.value
 			).toBe("before")
 
 			setMessages([createMessage("1", { en: "after" })])
 			expect(message).toBeDefined()
 			expect(
 				(message!.variants.find((variant) => variant.languageTag === "en")?.pattern[0] as Text)
-					.value,
+					.value
 			).toBe("after")
 		})
 	})
@@ -301,7 +301,7 @@ describe("reactivity", () => {
 					(
 						Object.values(messages!)![0]!.variants.find((variant) => variant.languageTag === "en")!
 							.pattern[0]! as Text
-					).value,
+					).value
 				).toBe("before")
 
 				query.update({ where: { id: "1" }, data: createMessage("1", { en: "after" }) })
@@ -310,7 +310,7 @@ describe("reactivity", () => {
 					(
 						Object.values(messages!)![0]!.variants.find((variant) => variant.languageTag === "en")!
 							.pattern[0]! as Text
-					).value,
+					).value
 				).toBe("after")
 			})
 		})
@@ -329,7 +329,7 @@ describe("reactivity", () => {
 					(
 						Object.values(messages!)![0]!.variants.find((variant) => variant.languageTag === "en")!
 							.pattern[0]! as Text
-					).value,
+					).value
 				).toBe("before")
 
 				query.upsert({ where: { id: "1" }, data: createMessage("1", { en: "after" }) })
@@ -337,7 +337,7 @@ describe("reactivity", () => {
 					(
 						Object.values(messages!)![0]!.variants.find((variant) => variant.languageTag === "en")!
 							.pattern[0]! as Text
-					).value,
+					).value
 				).toBe("after")
 			})
 		})
@@ -385,7 +385,7 @@ describe("reactivity", () => {
 				(
 					Object.values(messages!)![0]!.variants.find((variant) => variant.languageTag === "en")!
 						.pattern[0]! as Text
-				).value,
+				).value
 			).toBe("before")
 
 			setMessages([createMessage("1", { en: "after" })])
@@ -394,9 +394,22 @@ describe("reactivity", () => {
 				(
 					Object.values(messages!)![0]!.variants.find((variant) => variant.languageTag === "en")!
 						.pattern[0]! as Text
-				).value,
+				).value
 			).toBe("after")
 		})
+
+		it("should not mutate messages signal outside the query when using the query", async () => {
+			const [inputMessages] = createSignal<Message[]>([createMessage("1", { en: "before" })])
+			const query = createMessagesQuery(inputMessages)
+
+			let messages: Readonly<Message[]> | undefined = undefined
+			await createChangeListener(() => (messages = query.getAll()))
+			expect(Object.values(messages!)).toHaveLength(1)
+
+			query.create({ data: createMessage("2", { en: "" }) })
+
+			expect(inputMessages().length).toBe(1)
+		})
 	})
 })
 
@@ -421,11 +434,11 @@ it("instances should not share state", async () => {
 		query1.update({ where: { id: "1" }, data: createMessage("1", { en: "after" }) })
 		expect(
 			(message1!.variants.find((variant) => variant.languageTag === "en")!.pattern[0]! as Text)
-				.value,
+				.value
 		).toBe("after")
 		expect(
 			(message2!.variants.find((variant) => variant.languageTag === "en")!.pattern[0]! as Text)
-				.value,
+				.value
 		).toBe("before")
 
 		query1.delete({ where: { id: "1" } })

package/src/createMessagesQuery.ts

@@ -8,7 +8,7 @@ import type { InlangProject, MessageQueryApi } from "./api.js"
  * Creates a reactive query API for messages.
  */
 export function createMessagesQuery(
-	messages: () => Array<Message>,
+	messages: () => Array<Message>
 ): InlangProject["query"]["messages"] {
 	// @ts-expect-error
 	const index = new ReactiveMap<string, Message>()
@@ -31,7 +31,7 @@ export function createMessagesQuery(
 		get: Object.assign(get, {
 			subscribe: (
 				args: Parameters<MessageQueryApi["get"]["subscribe"]>[0],
-				callback: Parameters<MessageQueryApi["get"]["subscribe"]>[1],
+				callback: Parameters<MessageQueryApi["get"]["subscribe"]>[1]
 			) => createSubscribable(() => get(args)).subscribe(callback),
 		}) as any,
 		includedMessageIds: createSubscribable(() => {

package/src/lint/message/lintMessages.ts

@@ -13,7 +13,7 @@ export const lintMessages = async (args: {
 		lintSingleMessage({
 			...args,
 			message,
-		}),
+		})
 	)
 
 	const results = await Promise.all(promises)

package/src/lint/message/lintSingleMessage.test.ts

@@ -44,7 +44,7 @@ describe("lintSingleMessage", async () => {
 					messages,
 					message: message1,
 					rules: [lintRule1],
-				}),
+				})
 			)
 			expect(result.error).toBeDefined()
 			expect(result.data).toBeUndefined()

package/src/lint/message/lintSingleMessage.ts

@@ -42,8 +42,8 @@ export const lintSingleMessage = async (args: {
 			errors.push(
 				new MessagedLintRuleThrowedError(
 					`Lint rule '${rule.id}' throwed while linting message "${args.message.id}".`,
-					{ cause: error },
-				),
+					{ cause: error }
+				)
 			)
 		}
 	})

package/src/loadProject.test.ts

@@ -53,7 +53,7 @@ const exampleMessages: Message[] = [
 		variants: [
 			{
 				languageTag: "en",
-				match: {},
+				match: [],
 				pattern: [
 					{
 						type: "Text",
@@ -69,7 +69,7 @@ const exampleMessages: Message[] = [
 		variants: [
 			{
 				languageTag: "en",
-				match: {},
+				match: [],
 				pattern: [
 					{
 						type: "Text",
@@ -363,7 +363,7 @@ describe("functionality", () => {
 					sourceLanguageTag: "en",
 					languageTags: ["en"],
 					modules: ["plugin.js", "lintRule.js"],
-				} satisfies ProjectSettings),
+				} satisfies ProjectSettings)
 			)
 
 			const _import: ImportFunction = async (name) => {
@@ -411,7 +411,7 @@ describe("functionality", () => {
 					sourceLanguageTag: "en",
 					languageTags: ["en"],
 					modules: ["plugin.js", "lintRule.js"],
-				} satisfies ProjectSettings),
+				} satisfies ProjectSettings)
 			)
 			const _import: ImportFunction = async (name) => {
 				return {
@@ -428,7 +428,7 @@ describe("functionality", () => {
 			await new Promise((resolve) => setTimeout(resolve, 510))
 
 			expect(
-				project.query.messageLintReports.get({ where: { messageId: "some-message" } }),
+				project.query.messageLintReports.get({ where: { messageId: "some-message" } })
 			).toHaveLength(1)
 		})
 	})
@@ -491,7 +491,7 @@ describe("functionality", () => {
 					"plugin.project.json": {
 						pathPattern: "./resources/{languageTag}.json",
 					},
-				}),
+				})
 			)
 
 			await fs.mkdir("./resources")
@@ -526,7 +526,7 @@ describe("functionality", () => {
 					variants: [
 						{
 							languageTag: "en",
-							match: {},
+							match: [],
 							pattern: [
 								{
 									type: "Text",
@@ -536,7 +536,7 @@ describe("functionality", () => {
 						},
 						{
 							languageTag: "de",
-							match: {},
+							match: [],
 							pattern: [
 								{
 									type: "Text",
@@ -556,7 +556,7 @@ describe("functionality", () => {
 					variants: [
 						{
 							languageTag: "en",
-							match: {},
+							match: [],
 							pattern: [
 								{
 									type: "Text",
@@ -567,7 +567,7 @@ describe("functionality", () => {
 
 						{
 							languageTag: "de",
-							match: {},
+							match: [],
 							pattern: [
 								{
 									type: "Text",
@@ -594,7 +594,7 @@ describe("functionality", () => {
 					variants: [
 						{
 							languageTag: "en",
-							match: {},
+							match: [],
 							pattern: [
 								{
 									type: "Text",
@@ -604,7 +604,7 @@ describe("functionality", () => {
 						},
 						{
 							languageTag: "de",
-							match: {},
+							match: [],
 							pattern: [
 								{
 									type: "Text",
@@ -620,7 +620,7 @@ describe("functionality", () => {
 					variants: [
 						{
 							languageTag: "en",
-							match: {},
+							match: [],
 							pattern: [
 								{
 									type: "Text",
@@ -630,7 +630,7 @@ describe("functionality", () => {
 						},
 						{
 							languageTag: "de",
-							match: {},
+							match: [],
 							pattern: [
 								{
 									type: "Text",

package/src/loadProject.ts

@@ -47,7 +47,9 @@ export const loadProject = async (args: {
 			loadSettings({ settingsFilePath: args.settingsFilePath, nodeishFs: args.nodeishFs })
 				.then((settings) => {
 					setSettings(settings)
-					args._capture?.("SDK used settings", settings)
+					// rename settings to get a convenient access to the data in Posthog
+					const project_settings = settings
+					args._capture?.("SDK used settings", { project_settings })
 				})
 				.catch((err) => {
 					markInitAsFailed(err)
@@ -56,7 +58,7 @@ export const loadProject = async (args: {
 		// TODO: create FS watcher and update settings on change
 
 		const writeSettingsToDisk = skipFirst((settings: ProjectSettings) =>
-			_writeSettingsToDisk({ nodeishFs: args.nodeishFs, settings }),
+			_writeSettingsToDisk({ nodeishFs: args.nodeishFs, settings })
 		)
 
 		const setSettings = (settings: ProjectSettings): Result<void, ProjectSettingsInvalidError> => {
@@ -113,14 +115,14 @@ export const loadProject = async (args: {
 				_resolvedModules.resolvedPluginApi.loadMessages({
 					languageTags: settingsValue!.languageTags,
 					sourceLanguageTag: settingsValue!.sourceLanguageTag,
-				}),
+				})
 			)
 				.then((messages) => {
 					setMessages(messages)
 					markInitAsComplete()
 				})
 				.catch((err) =>
-					markInitAsFailed(new PluginLoadMessagesError("Error in load messages", { cause: err })),
+					markInitAsFailed(new PluginLoadMessagesError("Error in load messages", { cause: err }))
 				)
 		})
 
@@ -139,7 +141,7 @@ export const loadProject = async (args: {
 							"Unknown module. You stumbled on a bug in inlang's source code. Please open an issue.",
 						// default to warning, see https://github.com/inlang/monorepo/issues/1254
 						level: settingsValue["messageLintRuleLevels"]?.[rule.id] ?? "warning",
-					} satisfies InstalledMessageLintRule),
+					} satisfies InstalledMessageLintRule)
 			) satisfies Array<InstalledMessageLintRule>
 		}
 
@@ -164,7 +166,7 @@ export const loadProject = async (args: {
 			messages,
 			settings as () => ProjectSettings,
 			installedMessageLintRules,
-			resolvedModules,
+			resolvedModules
 		)
 
 		const debouncedSave = skipFirst(
@@ -185,8 +187,8 @@ export const loadProject = async (args: {
 						setMessages(newMessages)
 					}
 				},
-				{ atBegin: false },
-			),
+				{ atBegin: false }
+			)
 		)
 
 		createEffect(() => {
@@ -224,14 +226,14 @@ const loadSettings = async (args: {
 	nodeishFs: NodeishFilesystemSubset
 }) => {
 	const { data: settingsFile, error: settingsFileError } = await tryCatch(
-		async () => await args.nodeishFs.readFile(args.settingsFilePath, { encoding: "utf-8" }),
+		async () => await args.nodeishFs.readFile(args.settingsFilePath, { encoding: "utf-8" })
 	)
 	if (settingsFileError)
 		throw new ProjectSettingsFileNotFoundError(
 			`Could not locate settings file in (${args.settingsFilePath}).`,
 			{
 				cause: settingsFileError,
-			},
+			}
 		)
 
 	const json = tryCatch(() => JSON.parse(settingsFile!))
@@ -263,14 +265,14 @@ const _writeSettingsToDisk = async (args: {
 }) => {
 	const { data: serializedSettings, error: serializeSettingsError } = tryCatch(() =>
 		// TODO: this will probably not match the original formatting
-		JSON.stringify(args.settings, undefined, 2),
+		JSON.stringify(args.settings, undefined, 2)
 	)
 	if (serializeSettingsError) {
 		throw serializeSettingsError
 	}
 
 	const { error: writeSettingsError } = await tryCatch(async () =>
-		args.nodeishFs.writeFile("./project.inlang.json", serializedSettings),
+		args.nodeishFs.writeFile("./project.inlang.json", serializedSettings)
 	)
 
 	if (writeSettingsError) {
@@ -292,7 +294,7 @@ const createAwaitable = () => {
 	return [promise, resolve!, reject!] as [
 		awaitable: Promise<void>,
 		resolve: () => void,
-		reject: (e: unknown) => void,
+		reject: (e: unknown) => void
 	]
 }
 

package/src/messages/errors.ts

@@ -3,7 +3,7 @@ export class MessageVariantDoesNotExistError extends Error {
 
 	constructor(messageId: string, languageTag: string) {
 		super(
-			`For message '${messageId}' and '${languageTag}', there doesn't exist a variant for this specific matchers.`,
+			`For message '${messageId}' and '${languageTag}', there doesn't exist a variant for this specific matchers.`
 		)
 	}
 }
@@ -12,7 +12,7 @@ export class MessageVariantAlreadyExistsError extends Error {
 
 	constructor(messageId: string, languageTag: string) {
 		super(
-			`For message '${messageId}' and '${languageTag}', there already exists a variant for this specific matchers.`,
+			`For message '${messageId}' and '${languageTag}', there already exists a variant for this specific matchers.`
 		)
 	}
 }