@plentymarkets/shop-core 1.13.9 → 1.14.0

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@plentymarkets/shop-core",
   "configKey": "shopCore",
-  "version": "1.13.9",
+  "version": "1.14.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

package/dist/runtime/composables/localization/helpers/__tests__/mocks/getAllTranslationsMock.d.ts

@@ -0,0 +1,21 @@
+export declare const GetAllTranslationsMock: {
+    events: never[];
+    data: {
+        de: {
+            welcome: string;
+            auth: {
+                login: {
+                    createAccount: string;
+                };
+            };
+        };
+        en: {
+            welcome: string;
+            auth: {
+                login: {
+                    createAccount: string;
+                };
+            };
+        };
+    };
+};

package/dist/runtime/composables/localization/helpers/__tests__/mocks/getAllTranslationsMock.js

@@ -0,0 +1,21 @@
+export const GetAllTranslationsMock = {
+  "events": [],
+  "data": {
+    "de": {
+      "welcome": "Willkommen vom Backend",
+      "auth": {
+        "login": {
+          "createAccount": "Sie haben noch kein Konto? Erstellen Sie jetzt Ihr Konto!"
+        }
+      }
+    },
+    "en": {
+      "welcome": "Overridden welcome value",
+      "auth": {
+        "login": {
+          "createAccount": "Don't have an account? Sign up now!"
+        }
+      }
+    }
+  }
+};

package/dist/runtime/composables/localization/helpers/__tests__/mocks/i18nInstanceMock.d.ts

@@ -0,0 +1,2 @@
+import type { I18nInstance } from "~/src/runtime/types";
+export declare const i18nInstanceMock: I18nInstance;

package/dist/runtime/composables/localization/helpers/__tests__/mocks/i18nInstanceMock.js

@@ -0,0 +1,24 @@
+import { vi } from "vitest";
+export const i18nInstanceMock = {
+  availableLocales: ["en", "de"],
+  loadLocaleMessages: vi.fn(),
+  getLocaleMessage: vi.fn((locale) => {
+    if (locale === "en") {
+      return {
+        welcome: "Welcome",
+        "nested.key": "Nested value",
+        "translated.shouldBeSkipped": "Skip this"
+      };
+    }
+    if (locale === "de") {
+      return {
+        welcome: "Willkommen",
+        "nested.key": "Verschachtelter Wert",
+        "translated.shouldBeSkipped": "\xDCberspringe"
+      };
+    }
+    return {};
+  }),
+  te: vi.fn(),
+  t: vi.fn()
+};

package/dist/runtime/composables/localization/helpers/__tests__/mocks/i18nInstanceTranslatedMock.d.ts

@@ -0,0 +1,2 @@
+import type { I18nInstance } from "~/src/runtime/types";
+export declare const i18nInstanceTranslatedMock: I18nInstance;

package/dist/runtime/composables/localization/helpers/__tests__/mocks/i18nInstanceTranslatedMock.js

@@ -0,0 +1,33 @@
+import { vi } from "vitest";
+export const i18nInstanceTranslatedMock = {
+  availableLocales: ["en", "de"],
+  loadLocaleMessages: vi.fn(),
+  getLocaleMessage: vi.fn((locale) => {
+    if (locale === "en") {
+      return {
+        welcome: "Welcome",
+        "nested.key": "Nested value",
+        translated: {
+          "welcome": "Overridden welcome value",
+          "another.override": "Another override",
+          "nested.translated.key": "Nested translated value"
+        }
+      };
+    }
+    if (locale === "de") {
+      return {
+        welcome: "Willkommen",
+        "nested.key": "Verschachtelter Wert",
+        translated: {
+          "welcome": "\xDCberschriebener Wert f\xFCr welcome",
+          "another.override": "Weitere \xDCberschreibung",
+          "nested.translated.key": "Verschachtelter \xFCbersetzter Wert",
+          "key.thatdoesnotexist": "Dieser Schl\xFCssel existiert nur in der \xDCbersetzung"
+        }
+      };
+    }
+    return {};
+  }),
+  te: vi.fn(),
+  t: vi.fn()
+};

package/dist/runtime/composables/localization/helpers/extractKeysWithValuesHelper.d.ts

@@ -0,0 +1,17 @@
+import type { LocalizationMessage } from "~/src/module";
+/**
+ * Get translation value from compiled message or string
+ * @param value
+ */
+export declare const getTranslationValue: (value: unknown) => string | null;
+/**
+ * Check if value is a nested object (not array or compiled message)
+ * @param value
+ */
+export declare const isNestedObject: (value: unknown) => boolean;
+/**
+ * Recursively extract keys with values from nested objects
+ * @param obj
+ * @param prefix
+ */
+export declare const extractKeysWithValues: (obj: Record<string, unknown>, prefix?: string) => Record<string, LocalizationMessage>;

package/dist/runtime/composables/localization/helpers/extractKeysWithValuesHelper.js

@@ -0,0 +1,40 @@
+import { isCompiledMessage } from "./messageHelper.js";
+export const getTranslationValue = (value) => {
+  if (isCompiledMessage(value) && value) {
+    const data = value;
+    return data?.loc?.source ?? data?.b?.s ?? "";
+  }
+  if (typeof value === "string") {
+    return value;
+  }
+  return null;
+};
+export const isNestedObject = (value) => {
+  return value !== null && typeof value === "object" && !Array.isArray(value) && !isCompiledMessage(value);
+};
+export const extractKeysWithValues = (obj, prefix = "") => {
+  const result = {};
+  for (const key in obj) {
+    let fullKey = prefix ? `${prefix}.${key}` : key;
+    if (fullKey.endsWith(".body.static")) {
+      continue;
+    }
+    if (fullKey.endsWith(".loc.source")) {
+      fullKey = fullKey.substring(0, fullKey.length - ".loc.source".length);
+    }
+    const value = obj[key];
+    if (isNestedObject(value)) {
+      Object.assign(result, extractKeysWithValues(value, fullKey));
+    } else {
+      const translationValue = getTranslationValue(value);
+      if (translationValue)
+        result[fullKey] = {
+          value: translationValue,
+          default: translationValue,
+          input: translationValue,
+          isDeployed: true
+        };
+    }
+  }
+  return result;
+};

package/dist/runtime/composables/localization/{helpers.d.ts → helpers/loadKeysHelper.d.ts}

@@ -1,5 +1,4 @@
-import type { LocalizationMessage, I18nInstance } from '../../types/index.js';
-export declare const unflattenTranslations: (flat: Record<string, string>) => Record<string, any>;
+import type { LocalizationMessage, I18nInstance } from '../../../types/index.js';
 /**
  * Load default keys from i18n messages (PWA)
  * @param keysMap
@@ -8,7 +7,7 @@ export declare const unflattenTranslations: (flat: Record<string, string>) => Re
 export declare const loadDefaultKeys: (keysMap: Map<string, Record<string, LocalizationMessage>>, $i18n: I18nInstance) => Promise<void>;
 /**
  * Load translated keys from i18n messages (Module Overrides)
- * @param keysMap
+ * @param keysMap requires to have default keys already loaded with loadDefaultKeys()
  * @param $i18n
  */
 export declare const loadTranslatedKeys: (keysMap: Map<string, Record<string, LocalizationMessage>>, $i18n: I18nInstance) => void;

package/dist/runtime/composables/localization/helpers/loadKeysHelper.js

@@ -0,0 +1,70 @@
+import { useRuntimeConfig } from "nuxt/app";
+import { useSdk } from "../../useSdk.js";
+import { flattenTranslations } from "./transformationHelper.js";
+import { createEmptyMessage } from "./messageHelper.js";
+import { extractKeysWithValues } from "./extractKeysWithValuesHelper.js";
+export const loadDefaultKeys = async (keysMap, $i18n) => {
+  for (const locale of $i18n.availableLocales) {
+    await $i18n.loadLocaleMessages(locale);
+    const messages = $i18n.getLocaleMessage(locale);
+    const keysWithValues = extractKeysWithValues(messages);
+    for (const [key, value] of Object.entries(keysWithValues)) {
+      if (key.startsWith("translated.")) continue;
+      if (!keysMap.has(key)) {
+        keysMap.set(key, createEmptyMessage($i18n.availableLocales));
+      }
+      const translations = keysMap.get(key);
+      translations[locale] = value;
+    }
+  }
+};
+export const loadTranslatedKeys = (keysMap, $i18n) => {
+  for (const locale of $i18n.availableLocales) {
+    const messages = $i18n.getLocaleMessage(locale);
+    const translatedMessages = messages["translated"];
+    if (!translatedMessages) continue;
+    const keysWithValues = extractKeysWithValues(translatedMessages);
+    for (const [key, value] of Object.entries(keysWithValues)) {
+      if (!keysMap.has(key)) {
+        keysMap.set(key, createEmptyMessage($i18n.availableLocales));
+      }
+      const translations = keysMap.get(key);
+      if (translations[locale]) {
+        translations[locale].value = value.value;
+        translations[locale].input = value.input;
+      } else {
+        translations[locale] = value;
+      }
+    }
+  }
+};
+export const loadKeysFromBackend = async (keysMap, $i18n, backendLanguages) => {
+  try {
+    const config = useRuntimeConfig().public.shopCore;
+    const configId = config?.configId;
+    if (!configId) return;
+    const { data } = await useSdk().plentysystems.getAllTranslations({ configId });
+    const flattened = flattenTranslations(data);
+    for (const [lang, translations] of Object.entries(flattened)) {
+      if (backendLanguages && Object.keys(translations).length > 0) backendLanguages.add(lang);
+      for (const [key, value] of Object.entries(translations)) {
+        if (!keysMap.has(key)) {
+          keysMap.set(key, createEmptyMessage($i18n.availableLocales));
+        }
+        const localeTranslations = keysMap.get(key);
+        if (localeTranslations[lang]) {
+          localeTranslations[lang].isDeployed = localeTranslations[lang].value === value;
+          localeTranslations[lang].value = value;
+          localeTranslations[lang].input = value;
+        } else {
+          localeTranslations[lang] = {
+            value,
+            input: value,
+            isDeployed: false
+          };
+        }
+      }
+    }
+  } catch {
+  }
+};

package/dist/runtime/composables/localization/helpers/messageHelper.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Check if value is a compiled message
+ * for production and dev builds of vue-i18n
+ * @param value
+ */
+export declare const isCompiledMessage: (value: unknown) => boolean;
+/**
+ * Create an empty message object for all locales
+ * @param availableLocales
+ */
+export declare const createEmptyMessage: (availableLocales: string[]) => {};

package/dist/runtime/composables/localization/helpers/messageHelper.js

@@ -0,0 +1,17 @@
+export const isCompiledMessage = (value) => {
+  return typeof value === "object" && value !== null && ("loc" in value && typeof value.loc === "object" && value.loc !== null && "source" in value.loc && typeof value.loc.source === "string" || "b" in value && typeof value.b === "object" && value.b !== null && "s" in value.b && typeof value.b.s === "string");
+};
+export const createEmptyMessage = (availableLocales) => {
+  let data = {};
+  for (const locale of availableLocales) {
+    data = {
+      ...data,
+      [locale]: {
+        value: "",
+        input: "",
+        isDeployed: true
+      }
+    };
+  }
+  return data;
+};

package/dist/runtime/composables/localization/helpers/transformationHelper.d.ts

@@ -0,0 +1,13 @@
+import type { TranslationObject } from "@plentymarkets/shop-api";
+/**
+ * Flatten nested translation objects into dot notation
+ * e.g. { module: { key: 'value' } } => { 'module.key': 'value' }
+ * @param data
+ */
+export declare const flattenTranslations: (data: Record<string, TranslationObject>) => Record<string, Record<string, string>>;
+/**
+ * Unflatten dot notation into nested objects
+ * e.g. { 'module.key': 'value' } => { module: { key: 'value' } }
+ * @param flat
+ */
+export declare const unflattenTranslations: (flat: Record<string, string>) => Record<string, any>;

package/dist/runtime/composables/localization/helpers/transformationHelper.js

@@ -0,0 +1,34 @@
+export const flattenTranslations = (data) => {
+  const result = {};
+  function flattenObject(obj, prefix = "") {
+    const flattened = {};
+    for (const [key, value] of Object.entries(obj)) {
+      const newKey = prefix ? `${prefix}.${key}` : key;
+      if (typeof value === "string") {
+        flattened[newKey] = value;
+      } else {
+        Object.assign(flattened, flattenObject(value, newKey));
+      }
+    }
+    return flattened;
+  }
+  for (const [lang, modules] of Object.entries(data)) {
+    result[lang] = flattenObject(modules);
+  }
+  return result;
+};
+export const unflattenTranslations = (flat) => {
+  const result = {};
+  for (const [key, value] of Object.entries(flat)) {
+    const parts = key.split(".");
+    let current = result;
+    for (let i = 0; i < parts.length - 1; i++) {
+      const part = parts[i];
+      if (!current[part]) current[part] = {};
+      current = current[part];
+    }
+    const lastPart = parts[parts.length - 1];
+    current[lastPart] = value;
+  }
+  return result;
+};

package/dist/runtime/composables/localization/useEditorLocalizationKeys.js

@@ -1,8 +1,9 @@
 import { useState, useNuxtApp, useRuntimeConfig } from "nuxt/app";
 import { toRefs } from "vue";
-import { loadDefaultKeys, loadTranslatedKeys, loadKeysFromBackend, unflattenTranslations } from "./helpers.js";
+import { loadDefaultKeys, loadTranslatedKeys, loadKeysFromBackend } from "./helpers/loadKeysHelper.js";
 import { useSdk, useNotification, useEditorLocalizationLocales } from "#imports";
 import { allLanguages } from "./useEditorLocalizationLocales.js";
+import { unflattenTranslations } from "./helpers/transformationHelper.js";
 export const useEditorLocalizationKeys = () => {
   const state = useState("useEditorLocalizationKeys", () => ({
     keys: [],

package/dist/runtime/composables/localization/useEditorLocalizationLocales.d.ts

@@ -9,15 +9,15 @@ export declare const allLanguages: {
     nl: string;
     pl: string;
     pt: string;
-    no: string;
+    nn: string;
     ro: string;
     da: string;
-    sv: string;
-    cs: string;
+    se: string;
+    cz: string;
     ru: string;
     sk: string;
-    zh: string;
-    vi: string;
+    cn: string;
+    vn: string;
 };
 export declare const useEditorLocalizationLocales: () => {
     allLanguages: {
@@ -31,15 +31,15 @@ export declare const useEditorLocalizationLocales: () => {
         nl: string;
         pl: string;
         pt: string;
-        no: string;
+        nn: string;
         ro: string;
         da: string;
-        sv: string;
-        cs: string;
+        se: string;
+        cz: string;
         ru: string;
         sk: string;
-        zh: string;
-        vi: string;
+        cn: string;
+        vn: string;
     };
     selectLocale: (locale: string) => void;
     removeLocale: (locale: string) => void;

package/dist/runtime/composables/localization/useEditorLocalizationLocales.js

@@ -1,8 +1,8 @@
 import { useState } from "#app";
 import { toRefs } from "vue";
 export const allLanguages = {
-  de: "German (default)",
-  en: "English (default)",
+  de: "German",
+  en: "English",
   bg: "Bulgarian",
   fr: "French",
   it: "Italian",
@@ -11,15 +11,24 @@ export const allLanguages = {
   nl: "Dutch",
   pl: "Polish",
   pt: "Portuguese",
-  no: "Norwegian",
+  nn: "Norwegian",
   ro: "Romanian",
   da: "Danish",
-  sv: "Swedish",
-  cs: "Czech",
+  se: "Swedish",
+  cz: "Czech",
   ru: "Russian",
   sk: "Slovak",
-  zh: "Chinese",
-  vi: "Vietnamese"
+  cn: "Chinese",
+  vn: "Vietnamese"
+  /*
+  fi: 'Finnish',
+  ga: 'Irish',
+  lt: 'Lithuanian',
+  lv: 'Latvian',
+  et: 'Estonian',
+  hr: 'Croatian',
+  hu: 'Hungarian',
+   */
 };
 export const useEditorLocalizationLocales = () => {
   const state = useState("useEditorLocalizationLocales", () => ({

package/dist/runtime/utils/cookieBarHelper.js

@@ -2,11 +2,18 @@ const convertToDays = (daysInString) => {
   return Number.parseInt(daysInString.split(" ")[0]);
 };
 const getMinimumLifeSpan = (cookieJsonFromConfig) => {
-  const minimum = cookieJsonFromConfig.flatMap((group) => group.cookies).filter((cookie) => cookie.accepted && cookie.Lifespan).reduce((min, cookie) => {
-    const lifespanDays = convertToDays(cookie.Lifespan);
-    return Math.min(lifespanDays, min);
-  }, 999999);
-  return minimum * 24 * 60 * 60;
+  let minimum = 999999;
+  cookieJsonFromConfig.forEach((group) => {
+    const accepted = group.cookies.filter((cookie) => {
+      return cookie.accepted;
+    });
+    accepted.forEach((cookie) => {
+      if (cookie.Lifespan && minimum > convertToDays(cookie.Lifespan)) {
+        minimum = convertToDays(cookie.Lifespan);
+      }
+    });
+  });
+  return 60 * 60 * 24 * minimum;
 };
 export const cookieBarHelper = () => {
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plentymarkets/shop-core",
-  "version": "1.13.9",
+  "version": "1.14.0",
   "description": "Core module for PlentyONE Shop",
   "repository": {
     "type": "git",
@@ -45,7 +45,7 @@
     "test:types": "vue-tsc --noEmit"
   },
   "dependencies": {
-    "@plentymarkets/shop-api": "^0.145.0",
+    "@plentymarkets/shop-api": "^0.147.0",
     "@vue-storefront/sdk": "^3.4.1",
     "cookie": "^1.0.2",
     "js-sha256": "^0.11.0",

package/dist/runtime/composables/localization/helpers.js

@@ -1,157 +0,0 @@
-import { useRuntimeConfig } from "nuxt/app";
-import { useSdk } from "#imports";
-function flattenTranslations(data) {
-  const result = {};
-  function flattenObject(obj, prefix = "") {
-    const flattened = {};
-    for (const [key, value] of Object.entries(obj)) {
-      const newKey = prefix ? `${prefix}.${key}` : key;
-      if (typeof value === "string") {
-        flattened[newKey] = value;
-      } else {
-        Object.assign(flattened, flattenObject(value, newKey));
-      }
-    }
-    return flattened;
-  }
-  for (const [lang, modules] of Object.entries(data)) {
-    result[lang] = flattenObject(modules);
-  }
-  return result;
-}
-export const unflattenTranslations = (flat) => {
-  const result = {};
-  for (const [key, value] of Object.entries(flat)) {
-    const parts = key.split(".");
-    let current = result;
-    for (let i = 0; i < parts.length - 1; i++) {
-      const part = parts[i];
-      if (!current[part]) current[part] = {};
-      current = current[part];
-    }
-    const lastPart = parts[parts.length - 1];
-    current[lastPart] = value;
-  }
-  return result;
-};
-const isCompiledMessage = (value) => {
-  return typeof value === "object" && value !== null && ("loc" in value && typeof value.loc === "object" && value.loc !== null && "source" in value.loc && typeof value.loc.source === "string" || "b" in value && typeof value.b === "object" && value.b !== null && "s" in value.b && typeof value.b.s === "string");
-};
-const createEmptyMessage = (availableLocales) => {
-  let data = {};
-  for (const locale of availableLocales) {
-    data = {
-      ...data,
-      [locale]: {
-        value: "",
-        input: "",
-        isDeployed: true
-      }
-    };
-  }
-  return data;
-};
-const getTranslationValue = (value) => {
-  if (isCompiledMessage(value) && value) {
-    const data = value;
-    return data?.loc?.source ?? data?.b?.s ?? "";
-  }
-  if (typeof value === "string") {
-    return value;
-  }
-  return null;
-};
-const isNestedObject = (value) => {
-  return value !== null && typeof value === "object" && !Array.isArray(value) && !isCompiledMessage(value);
-};
-const extractKeysWithValues = (obj, prefix = "") => {
-  const result = {};
-  for (const key in obj) {
-    let fullKey = prefix ? `${prefix}.${key}` : key;
-    if (fullKey.endsWith(".body.static")) {
-      continue;
-    }
-    if (fullKey.endsWith(".loc.source")) {
-      fullKey = fullKey.substring(0, fullKey.length - ".loc.source".length);
-    }
-    const value = obj[key];
-    if (isNestedObject(value)) {
-      Object.assign(result, extractKeysWithValues(value, fullKey));
-    } else {
-      const translationValue = getTranslationValue(value);
-      if (translationValue)
-        result[fullKey] = {
-          value: translationValue,
-          default: translationValue,
-          input: translationValue,
-          isDeployed: true
-        };
-    }
-  }
-  return result;
-};
-export const loadDefaultKeys = async (keysMap, $i18n) => {
-  for (const locale of $i18n.availableLocales) {
-    await $i18n.loadLocaleMessages(locale);
-    const messages = $i18n.getLocaleMessage(locale);
-    const keysWithValues = extractKeysWithValues(messages);
-    for (const [key, value] of Object.entries(keysWithValues)) {
-      if (key.startsWith("translated.")) continue;
-      if (!keysMap.has(key)) {
-        keysMap.set(key, createEmptyMessage($i18n.availableLocales));
-      }
-      const translations = keysMap.get(key);
-      translations[locale] = value;
-    }
-  }
-};
-export const loadTranslatedKeys = (keysMap, $i18n) => {
-  for (const locale of $i18n.availableLocales) {
-    const messages = $i18n.getLocaleMessage(locale);
-    const translatedMessages = messages["translated"];
-    if (!translatedMessages) continue;
-    const keysWithValues = extractKeysWithValues(translatedMessages);
-    for (const [key, value] of Object.entries(keysWithValues)) {
-      if (!keysMap.has(key)) {
-        keysMap.set(key, createEmptyMessage($i18n.availableLocales));
-      }
-      const translations = keysMap.get(key);
-      if (translations[locale]) {
-        translations[locale].value = value.value;
-        translations[locale].input = value.input;
-      } else {
-        translations[locale] = value;
-      }
-    }
-  }
-};
-export const loadKeysFromBackend = async (keysMap, $i18n, backendLanguages) => {
-  try {
-    const config = useRuntimeConfig().public.shopCore;
-    const configId = config?.configId;
-    if (!configId) return;
-    const { data } = await useSdk().plentysystems.getAllTranslations({ configId });
-    const flattened = flattenTranslations(data);
-    for (const [lang, translations] of Object.entries(flattened)) {
-      if (backendLanguages && Object.keys(translations).length > 0) backendLanguages.add(lang);
-      for (const [key, value] of Object.entries(translations)) {
-        if (!keysMap.has(key)) {
-          keysMap.set(key, createEmptyMessage($i18n.availableLocales));
-        }
-        const localeTranslations = keysMap.get(key);
-        if (localeTranslations[lang]) {
-          localeTranslations[lang].isDeployed = localeTranslations[lang].value === value;
-          localeTranslations[lang].value = value;
-          localeTranslations[lang].input = value;
-        } else {
-          localeTranslations[lang] = {
-            value,
-            input: value,
-            isDeployed: false
-          };
-        }
-      }
-    }
-  } catch {
-  }
-};