@plentymarkets/shop-core 1.2.1 → 1.3.0

package/dist/module.d.mts

@@ -1,6 +1,9 @@
 import * as _nuxt_schema from '@nuxt/schema';
 export { Cookie, CookieGroup, CookieGroupFromNuxtConfig } from '../dist/runtime/types/index.js';
 
-declare const _default: _nuxt_schema.NuxtModule<_nuxt_schema.ModuleOptions, _nuxt_schema.ModuleOptions, false>;
+interface ModuleOptions {
+    apiUrl: string;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
-export { _default as default };
+export { type ModuleOptions, _default as default };

package/dist/module.d.ts

@@ -1,6 +1,9 @@
 import * as _nuxt_schema from '@nuxt/schema';
 export { Cookie, CookieGroup, CookieGroupFromNuxtConfig } from '../dist/runtime/types/index.js';
 
-declare const _default: _nuxt_schema.NuxtModule<_nuxt_schema.ModuleOptions, _nuxt_schema.ModuleOptions, false>;
+interface ModuleOptions {
+    apiUrl: string;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
-export { _default as default };
+export { type ModuleOptions, _default as default };

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "shop-core",
   "configKey": "shopCore",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -7,8 +7,14 @@ const module = defineNuxtModule({
   },
   // Default configuration options of the Nuxt module
   defaults: {},
-  setup(_options, _nuxt) {
+  async setup(_options, _nuxt) {
     const resolver = createResolver(import.meta.url);
+    _nuxt.options.runtimeConfig.public.shopCore = _options;
+    addImports({
+      name: "useSdk",
+      as: "useSdk",
+      from: resolver.resolve("./runtime/composables/useSdk")
+    });
     addImports({
       name: "usePlentyEvent",
       as: "usePlentyEvent",

package/dist/runtime/composables/__tests__/useCookieConsent.spec.js

@@ -1,4 +1,4 @@
-import { describe, it, expect } from "vitest";
+import { describe, it, expect, beforeEach } from "vitest";
 import { useRuntimeConfig } from "nuxt/app";
 import { useCookieConsent } from "../useCookieConsent.js";
 import { useCookieBar } from "../useCookieBar.js";

package/dist/runtime/composables/__tests__/useCsrfToken.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/runtime/composables/__tests__/useCsrfToken.spec.js

@@ -0,0 +1,9 @@
+import { describe, expect, it } from "vitest";
+import { useCsrfToken } from "../useCsrfToken.js";
+describe("useCsrfToken", () => {
+  it("should set and csrf token", () => {
+    const { token } = useCsrfToken();
+    token.value = "test";
+    expect(token.value).toBe("test");
+  });
+});

package/dist/runtime/composables/__tests__/useRegisterCookie.spec.js

@@ -1,4 +1,5 @@
 import { useRuntimeConfig } from "nuxt/app";
+import { describe, it, vi } from "vitest";
 import { useRegisterCookie } from "../useRegisterCookie.js";
 vi.mock("nuxt/app", () => ({
   useRuntimeConfig: vi.fn()

package/dist/runtime/composables/__tests__/useSdk.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/runtime/composables/__tests__/useSdk.spec.js

@@ -0,0 +1,26 @@
+import { describe } from "node:test";
+import { expect, it, vi } from "vitest";
+import { mockNuxtImport } from "@nuxt/test-utils/runtime";
+import { useSdk } from "../useSdk.js";
+const { useRuntimeConfig } = vi.hoisted(() => {
+  return {
+    useRuntimeConfig: vi.fn().mockImplementation(() => {
+      return {
+        public: {
+          shopCore: {
+            apiUrl: "https://example.com"
+          }
+        }
+      };
+    })
+  };
+});
+mockNuxtImport("useRuntimeConfig", () => {
+  return useRuntimeConfig;
+});
+describe("useSdk", () => {
+  it("should return sdk", () => {
+    const sdk = useSdk();
+    expect(sdk.plentysystems.getCategoryTree).toBeDefined();
+  });
+});

package/dist/runtime/composables/sdk.client.d.ts

@@ -0,0 +1,2 @@
+import type { AxiosRequestConfig } from 'axios';
+export declare const httpClient: (url: string, params: unknown, config: AxiosRequestConfig<unknown> | undefined) => Promise<any>;

package/dist/runtime/composables/sdk.client.js

@@ -0,0 +1,55 @@
+import axios from "axios";
+import { ApiError } from "@plentymarkets/shop-api";
+import { updateVsfLocale } from "../utils/sdkClientHelper.js";
+import { useCsrfToken } from "./useCsrfToken.js";
+import { tryUseNuxtApp, useCookie, useNuxtApp, useRuntimeConfig } from "#imports";
+const createHttpClient = () => {
+  const client = axios.create({ withCredentials: true });
+  if (tryUseNuxtApp()) {
+    const { token } = useCsrfToken();
+    const { $router, $i18n } = useNuxtApp();
+    const locale = $i18n.locale.value;
+    const runtimeConfig = useRuntimeConfig();
+    const referrerId = $router.currentRoute.value.query?.ReferrerID?.toString() ?? "";
+    const noCache = runtimeConfig.public.noCache || $router.currentRoute.value.query?.noCache?.toString() || "";
+    const configId = runtimeConfig.public.configId;
+    const pwaHashCookie = useCookie("pwa");
+    client.interceptors.request.use((request) => {
+      if (token.value) request.headers["x-csrf-token"] = token.value;
+      if (referrerId) request.headers["referrerID"] = referrerId;
+      if (noCache) request.headers["noCache"] = noCache;
+      if (configId) request.headers["x-config-id"] = configId;
+      if (pwaHashCookie.value) request.headers["x-pwa-edit-hash"] = pwaHashCookie.value;
+      if (import.meta.server) {
+        request.headers["cookie"] = updateVsfLocale(request.headers["cookie"], locale);
+      }
+      return request;
+    });
+    client.interceptors.response.use((response) => {
+      if (response.headers["x-csrf-token"]) token.value = response.headers["x-csrf-token"];
+      return response;
+    });
+  }
+  return client;
+};
+const handleHttpError = (error) => {
+  const axiosError = error;
+  const data = axiosError?.response?.data?.data || axiosError?.response?.data;
+  const events = axiosError?.response?.data?.events;
+  throw new ApiError({
+    key: data?.key || "unknownError",
+    code: axiosError?.response?.data?.error?.code ?? axiosError?.response?.status ?? axiosError.status,
+    message: data?.message ?? axiosError.message ?? "",
+    cause: data?.errors ?? {},
+    events
+  });
+};
+export const httpClient = async (url, params, config) => {
+  try {
+    const client = createHttpClient();
+    const { data } = await client(url, { ...config, data: params });
+    return data;
+  } catch (error) {
+    handleHttpError(error);
+  }
+};

package/dist/runtime/composables/useCookieBar.js

@@ -115,7 +115,7 @@ export const useCookieBar = () => {
 export const fetchScripts = (scripts) => {
   scripts.forEach((script) => {
     try {
-      if (checkIfScriptIsExternal(script)) {
+      if (checkIfScriptIsExternal(script) && document) {
         const scriptElement = document.createElement("script");
         scriptElement.setAttribute("src", script);
         scriptElement.setAttribute("type", "text/javascript");

package/dist/runtime/composables/useCsrfToken.d.ts

@@ -0,0 +1,3 @@
+export declare const useCsrfToken: () => {
+    token: import("vue").Ref<string, string>;
+};

package/dist/runtime/composables/useCsrfToken.js

@@ -0,0 +1,10 @@
+import { useState } from "nuxt/app";
+import { toRefs } from "vue";
+export const useCsrfToken = () => {
+  const state = useState(`useCsrfToken`, () => ({
+    token: ""
+  }));
+  return {
+    ...toRefs(state.value)
+  };
+};

package/dist/runtime/composables/useSdk.d.ts

@@ -0,0 +1,8 @@
+export declare const useSdk: () => import("@vue-storefront/sdk").SDKApi<{
+    plentysystems: {
+        connector: import("@vue-storefront/sdk").Methods<import("@vue-storefront/middleware").WithoutContext<typeof import("@plentymarkets/shop-api/lib/api")>>;
+        context: {
+            requestSender: import("@vue-storefront/sdk").RequestSender;
+        };
+    } & object;
+}>;

package/dist/runtime/composables/useSdk.js

@@ -0,0 +1,16 @@
+import { initSDK, buildModule, middlewareModule } from "@vue-storefront/sdk";
+import { httpClient } from "./sdk.client.js";
+import { useRequestHeaders, useRuntimeConfig } from "#imports";
+export const useSdk = () => {
+  const config = useRuntimeConfig().public.shopCore;
+  const sdkConfig = {
+    plentysystems: buildModule(middlewareModule, {
+      apiUrl: config.apiUrl + "/plentysystems",
+      defaultRequestConfig: {
+        headers: useRequestHeaders()
+      },
+      httpClient
+    })
+  };
+  return initSDK(sdkConfig);
+};

package/dist/runtime/utils/__tests__/sdkClientHelper.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/runtime/utils/__tests__/sdkClientHelper.spec.js

@@ -0,0 +1,22 @@
+import { describe, expect, it } from "vitest";
+import { updateVsfLocale } from "../sdkClientHelper.js";
+describe("sdk client helper", () => {
+  it("should update the locale", () => {
+    const cookie = "vsf-locale=en";
+    const locale = "fr";
+    const result = updateVsfLocale(cookie, locale);
+    expect(result).toBe("vsf-locale=fr");
+  });
+  it("should update the cookie in existing cookie string", () => {
+    const cookie = "vsf-locale=en; test=123";
+    const locale = "de";
+    const result = updateVsfLocale(cookie, locale);
+    expect(result).toBe("vsf-locale=de;  test=123");
+  });
+  it("should update the locale when cookie is empty", () => {
+    const cookie = "";
+    const locale = "de";
+    const result = updateVsfLocale(cookie, locale);
+    expect(result).toBe("; vsf-locale=de");
+  });
+});

package/dist/runtime/utils/sdkClientHelper.d.ts

@@ -0,0 +1 @@
+export declare const updateVsfLocale: (cookie: string, locale: string) => string;

package/dist/runtime/utils/sdkClientHelper.js

@@ -0,0 +1,16 @@
+const VSL_LOCALE_COOKIE = "vsf-locale";
+export const updateVsfLocale = (cookie, locale) => {
+  let cookieExists = false;
+  const cookies = (cookie ?? "").split(";");
+  const cookiesArray = cookies.map((cookie2) => {
+    if (cookie2.trim().includes(VSL_LOCALE_COOKIE)) {
+      cookieExists = true;
+      return `${VSL_LOCALE_COOKIE}=${locale}`;
+    }
+    return cookie2;
+  });
+  if (!cookieExists) {
+    cookiesArray.push(`${VSL_LOCALE_COOKIE}=${locale}`);
+  }
+  return cookiesArray.join("; ");
+};

package/dist/types.d.mts

@@ -1,7 +1 @@
-import type { NuxtModule } from '@nuxt/schema'
-
-import type { default as Module } from './module.js'
-
-export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
-
 export { type Cookie, type CookieGroup, type CookieGroupFromNuxtConfig } from './module.js'

package/dist/types.d.ts

@@ -1,7 +1 @@
-import type { NuxtModule } from '@nuxt/schema'
-
-import type { default as Module } from './module'
-
-export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
-
 export { type Cookie, type CookieGroup, type CookieGroupFromNuxtConfig } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plentymarkets/shop-core",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Core module for PlentyONE Shop",
   "repository": {
     "type": "git",
@@ -41,16 +41,18 @@
     "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
   },
   "dependencies": {
-    "@plentymarkets/shop-api": "^0.88.0",
+    "@plentymarkets/shop-api": "^0.94.1",
+    "@vue-storefront/sdk": "^3.4.1",
     "mitt": "^3.0.1"
   },
   "devDependencies": {
     "@nuxt/devtools": "^1.7.0",
     "@nuxt/eslint-config": "^0.7.5",
-    "@nuxt/kit": "^3.15.1",
+    "@nuxt/kit": "^3.16.0",
     "@nuxt/module-builder": "^0.8.4",
-    "@nuxt/schema": "^3.15.1",
+    "@nuxt/schema": "^3.16.0",
     "@nuxt/test-utils": "^3.15.4",
+    "@nuxtjs/i18n": "9.3.1",
     "@types/node": "latest",
     "@vitest/coverage-v8": "2.1.8",
     "@vue-storefront/eslint-config": "^4.1.0",