@inlang/sdk 0.7.0 → 0.9.0

package/dist/adapter/solidAdapter.test.js

@@ -32,7 +32,7 @@ const exampleMessages = [
         variants: [
             {
                 languageTag: "en",
-                match: {},
+                match: [],
                 pattern: [
                     {
                         type: "Text",
@@ -48,7 +48,7 @@ const exampleMessages = [
         variants: [
             {
                 languageTag: "en",
-                match: {},
+                match: [],
                 pattern: [
                     {
                         type: "Text",
@@ -143,7 +143,7 @@ describe("messages", () => {
             description: {
                 en: "wo",
             },
-            loadMessages: ({ languageTags }) => (languageTags.length ? exampleMessages : []),
+            loadMessages: ({ settings }) => (settings.languageTags.length ? exampleMessages : []),
             saveMessages: () => undefined,
         };
         const mockImport = async () => ({ default: mockPlugin });
@@ -190,7 +190,7 @@ describe("messages", () => {
                 variants: [
                     {
                         languageTag: "en",
-                        match: {},
+                        match: [],
                         pattern: [
                             {
                                 type: "Text",
@@ -254,7 +254,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" }] }],
                 },
             });
             expect(counter).toBe(1);
@@ -264,7 +264,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" }] }],
                 },
             });
             expect(counter).toBe(6);

package/dist/createMessagesQuery.test.js

@@ -276,6 +276,15 @@ describe("reactivity", () => {
             expect(Object.values(messages)[0].variants.find((variant) => variant.languageTag === "en")
                 .pattern[0].value).toBe("after");
         });
+        it("should not mutate messages signal outside the query when using the query", async () => {
+            const [inputMessages] = createSignal([createMessage("1", { en: "before" })]);
+            const query = createMessagesQuery(inputMessages);
+            let messages = undefined;
+            await createChangeListener(() => (messages = query.getAll()));
+            expect(Object.values(messages)).toHaveLength(1);
+            query.create({ data: createMessage("2", { en: "" }) });
+            expect(inputMessages().length).toBe(1);
+        });
     });
 });
 it("instances should not share state", async () => {

package/dist/loadProject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loadProject.d.ts","sourceRoot":"","sources":["../src/loadProject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,aAAa,EAGb,YAAY,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,4BAA4B,CAAA;AAahF,OAAO,EAA4B,KAAK,uBAAuB,EAAE,MAAM,0BAA0B,CAAA;AAMjG;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;sBACL,MAAM;eACb,uBAAuB;;qBAElB,MAAM,SAAS,OAAO,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;MAC5D,QAAQ,aAAa,CAiLxB,CAAA;AAsGD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQtE"}
+{"version":3,"file":"loadProject.d.ts","sourceRoot":"","sources":["../src/loadProject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,aAAa,EAGb,YAAY,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,4BAA4B,CAAA;AAahF,OAAO,EAA4B,KAAK,uBAAuB,EAAE,MAAM,0BAA0B,CAAA;AAMjG;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;sBACL,MAAM;eACb,uBAAuB;;qBAElB,MAAM,SAAS,OAAO,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;MAC5D,QAAQ,aAAa,CAqLxB,CAAA;AAsGD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQtE"}

package/dist/loadProject.js

@@ -25,7 +25,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);
@@ -75,8 +77,7 @@ export const loadProject = async (args) => {
                 return;
             }
             makeTrulyAsync(_resolvedModules.resolvedPluginApi.loadMessages({
-                languageTags: settingsValue.languageTags,
-                sourceLanguageTag: settingsValue.sourceLanguageTag,
+                settings: settingsValue,
             }))
                 .then((messages) => {
                 setMessages(messages);
@@ -115,7 +116,10 @@ export const loadProject = async (args) => {
         const lintReportsQuery = createMessageLintReportsQuery(messages, settings, installedMessageLintRules, resolvedModules);
         const debouncedSave = skipFirst(debounce(500, async (newMessages) => {
             try {
-                await resolvedModules()?.resolvedPluginApi.saveMessages({ messages: newMessages });
+                await resolvedModules()?.resolvedPluginApi.saveMessages({
+                    settings: settingsValue,
+                    messages: newMessages,
+                });
             }
             catch (err) {
                 throw new PluginSaveMessagesError("Error in saving messages", {

package/dist/loadProject.test.js

@@ -41,7 +41,7 @@ const exampleMessages = [
         variants: [
             {
                 languageTag: "en",
-                match: {},
+                match: [],
                 pattern: [
                     {
                         type: "Text",
@@ -57,7 +57,7 @@ const exampleMessages = [
         variants: [
             {
                 languageTag: "en",
-                match: {},
+                match: [],
                 pattern: [
                     {
                         type: "Text",
@@ -399,14 +399,15 @@ describe("functionality", () => {
     describe("query", () => {
         it("should call saveMessages() on updates", async () => {
             const fs = createNodeishMemoryFs();
-            await fs.writeFile("./project.inlang.json", JSON.stringify({
+            const settings = {
                 sourceLanguageTag: "en",
                 languageTags: ["en", "de"],
                 modules: ["plugin.js"],
                 "plugin.project.json": {
                     pathPattern: "./resources/{languageTag}.json",
                 },
-            }));
+            };
+            await fs.writeFile("./project.inlang.json", JSON.stringify(settings));
             await fs.mkdir("./resources");
             const mockSaveFn = vi.fn();
             const _mockPlugin = {
@@ -434,7 +435,7 @@ describe("functionality", () => {
                     variants: [
                         {
                             languageTag: "en",
-                            match: {},
+                            match: [],
                             pattern: [
                                 {
                                     type: "Text",
@@ -444,7 +445,7 @@ describe("functionality", () => {
                         },
                         {
                             languageTag: "de",
-                            match: {},
+                            match: [],
                             pattern: [
                                 {
                                     type: "Text",
@@ -463,7 +464,7 @@ describe("functionality", () => {
                     variants: [
                         {
                             languageTag: "en",
-                            match: {},
+                            match: [],
                             pattern: [
                                 {
                                     type: "Text",
@@ -473,7 +474,7 @@ describe("functionality", () => {
                         },
                         {
                             languageTag: "de",
-                            match: {},
+                            match: [],
                             pattern: [
                                 {
                                     type: "Text",
@@ -486,9 +487,7 @@ describe("functionality", () => {
             });
             await new Promise((resolve) => setTimeout(resolve, 510));
             expect(mockSaveFn.mock.calls.length).toBe(1);
-            expect(mockSaveFn.mock.calls[0][0].settings).toStrictEqual({
-                pathPattern: "./resources/{languageTag}.json",
-            });
+            expect(mockSaveFn.mock.calls[0][0].settings).toStrictEqual(settings);
             expect(Object.values(mockSaveFn.mock.calls[0][0].messages)).toStrictEqual([
                 {
                     id: "a",
@@ -496,7 +495,7 @@ describe("functionality", () => {
                     variants: [
                         {
                             languageTag: "en",
-                            match: {},
+                            match: [],
                             pattern: [
                                 {
                                     type: "Text",
@@ -506,7 +505,7 @@ describe("functionality", () => {
                         },
                         {
                             languageTag: "de",
-                            match: {},
+                            match: [],
                             pattern: [
                                 {
                                     type: "Text",
@@ -522,7 +521,7 @@ describe("functionality", () => {
                     variants: [
                         {
                             languageTag: "en",
-                            match: {},
+                            match: [],
                             pattern: [
                                 {
                                     type: "Text",
@@ -532,7 +531,7 @@ describe("functionality", () => {
                         },
                         {
                             languageTag: "de",
-                            match: {},
+                            match: [],
                             pattern: [
                                 {
                                     type: "Text",

package/dist/messages/variant.d.ts

@@ -9,12 +9,12 @@ import { MessagePatternsForLanguageTagDoNotExistError, MessageVariantAlreadyExis
  * (if it exists).
  *
  * @example
- * 	const variant = getVariant(message, { where: { languageTag: "en", selectors: { gender: "male" }}});
+ * 	const variant = getVariant(message, { where: { languageTag: "en", match: ["male"]}});
  */
 export declare function getVariant(message: Message, args: {
     where: {
         languageTag: LanguageTag;
-        selectors?: Variant["match"];
+        match?: Variant["match"];
     };
 }): Variant | undefined;
 /**
@@ -34,12 +34,12 @@ export declare function createVariant(message: Message, args: {
  * 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 declare function updateVariantPattern(message: Message, args: {
     where: {
         languageTag: LanguageTag;
-        selectors: Record<string, string>;
+        match: Variant["match"];
     };
     data: Variant["pattern"];
 }): Result<Message, MessageVariantDoesNotExistError | MessagePatternsForLanguageTagDoNotExistError>;

package/dist/messages/variant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"variant.d.ts","sourceRoot":"","sources":["../../src/messages/variant.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAC9E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,EACN,4CAA4C,EAC5C,gCAAgC,EAChC,+BAA+B,EAC/B,MAAM,aAAa,CAAA;AAEpB;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CACzB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE;IACL,KAAK,EAAE;QACN,WAAW,EAAE,WAAW,CAAA;QACxB,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;KAC5B,CAAA;CACD,GACC,OAAO,GAAG,SAAS,CASrB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC5B,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE;IACL,IAAI,EAAE,OAAO,CAAA;CACb,GACC,MAAM,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAcnD;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CACnC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE;IACL,KAAK,EAAE;QACN,WAAW,EAAE,WAAW,CAAA;QACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACjC,CAAA;IACD,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;CACxB,GACC,MAAM,CAAC,OAAO,EAAE,+BAA+B,GAAG,4CAA4C,CAAC,CAqBjG"}
+{"version":3,"file":"variant.d.ts","sourceRoot":"","sources":["../../src/messages/variant.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAC9E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,EACN,4CAA4C,EAC5C,gCAAgC,EAChC,+BAA+B,EAC/B,MAAM,aAAa,CAAA;AAEpB;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CACzB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE;IACL,KAAK,EAAE;QACN,WAAW,EAAE,WAAW,CAAA;QACxB,KAAK,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;KACxB,CAAA;CACD,GACC,OAAO,GAAG,SAAS,CASrB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC5B,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE;IACL,IAAI,EAAE,OAAO,CAAA;CACb,GACC,MAAM,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAanD;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CACnC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE;IACL,KAAK,EAAE;QACN,WAAW,EAAE,WAAW,CAAA;QACxB,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;KACvB,CAAA;IACD,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;CACxB,GACC,MAAM,CAAC,OAAO,EAAE,+BAA+B,GAAG,4CAA4C,CAAC,CAqBjG"}

package/dist/messages/variant.js

@@ -7,10 +7,10 @@ import { MessagePatternsForLanguageTagDoNotExistError, MessageVariantAlreadyExis
  * (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, args) {
-    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
@@ -33,10 +33,9 @@ export function createVariant(message, args) {
     if (matchVariant(copy, args.data.languageTag, args.data.match)) {
         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 };
 }
@@ -46,7 +45,7 @@ export function createVariant(message, args) {
  * 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, args) {
     const copy = structuredClone(message);
@@ -56,7 +55,7 @@ export function updateVariantPattern(message, args) {
             error: new MessagePatternsForLanguageTagDoNotExistError(message.id, args.where.languageTag),
         };
     }
-    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) };
     }
@@ -70,21 +69,24 @@ export function updateVariantPattern(message, args) {
  * 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, languageTag, selectors) => {
-    // resolve preferenceSelectors to match length and order of message selectors
-    const resolvedSelectors = resolveSelector(message.selectors, selectors);
+const matchVariant = (message, languageTag, match) => {
     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;
@@ -98,47 +100,61 @@ const matchVariant = (message, languageTag, selectors) => {
  * @example
  *  const variant = matchMostSpecificVariant(message, languageTag: "en", selectors: { gender: "male" })
  */
-const matchMostSpecificVariant = (message, languageTag, selectors) => {
-    // make selector undefined if empty object
-    selectors = JSON.stringify(selectors) === "{}" ? undefined : selectors;
+const matchMostSpecificVariant = (message, languageTag, match) => {
     // resolve preferenceSelectors to match length and order of message selectors
-    const resolvedSelectors = resolveSelector(message.selectors, selectors);
     const index = {};
     for (const variant of message.variants) {
         if (variant.languageTag !== languageTag)
             continue;
         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, currentKeys, 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);
+            function recursiveAddToIndex(currentIndex, selectorIndex, selectorLength, 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);
+            recursiveAddToIndex(index, 0, message.selectors ? message.selectors.length - 1 : 0, variant);
         }
-        else if (isMatch && !selectors) {
+        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 = [];
+        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, selectors) => {
         const keys = Object.keys(index);
@@ -156,21 +172,5 @@ const matchMostSpecificVariant = (message, languageTag, selectors) => {
         }
         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, selectors) => {
-    const resolvedSelectors = {};
-    if (!selectors)
-        return {};
-    for (const messageSelector of messageSelectors) {
-        resolvedSelectors[messageSelector.name] = selectors[messageSelector.name] ?? "*";
-    }
-    return resolvedSelectors;
+    return findOptimalMatch(index, match || []);
 };