@plentymarkets/shop-core 1.15.0 → 1.16.0

package/dist/module.d.mts

@@ -5,6 +5,13 @@ interface ModuleOptions {
     apiUrl: string;
     apiEndpoint: string;
     configId: number;
+    logger?: {
+        sdkPlugin?: {
+            enabled: boolean;
+            verbose: boolean;
+            serverOnly: boolean;
+        };
+    };
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 

package/dist/module.json

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

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { defineNuxtModule, createResolver, addImports } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, addPlugin, addImports } from '@nuxt/kit';
 import { ofetch } from 'ofetch';
 import { access, mkdir, writeFile } from 'fs/promises';
 import { join } from 'path';
@@ -31,7 +31,14 @@ const module$1 = defineNuxtModule({
     const resolver = createResolver(import.meta.url);
     nuxt.options.runtimeConfig.public.shopCore = {
       apiUrl: _options.apiUrl,
-      configId: _options.configId
+      configId: _options.configId,
+      logger: {
+        sdkPlugin: {
+          enabled: _options.logger?.sdkPlugin?.enabled ?? false,
+          verbose: _options.logger?.sdkPlugin?.verbose ?? false,
+          serverOnly: _options.logger?.sdkPlugin?.serverOnly ?? true
+        }
+      }
     };
     const overridesDir = resolver.resolve("./runtime/lang/overrides");
     const allLocalesForOverride = [];
@@ -67,6 +74,7 @@ const module$1 = defineNuxtModule({
         });
       }
     });
+    addPlugin(resolver.resolve("./runtime/plugins/sdk"));
     addImports({
       name: "useSdk",
       as: "useSdk",

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

@@ -1,6 +1,6 @@
 import type { Endpoints } from '@plentymarkets/shop-api';
 /**
- * @description Composable for using the SDK.
+ * @description Composable for wrapping $sdk plugin.
  */
 export declare const useSdk: () => {
     plentysystems: Endpoints;

package/dist/runtime/composables/useSdk.js

@@ -1,84 +1,5 @@
-import { initSDK, buildModule, middlewareModule } from "@vue-storefront/sdk";
-import { httpClient } from "./sdk.client.js";
-import { updateSsrCookie } from "../utils/sdk.helper.js";
-import { useCookie, useNuxtApp, useRequestHeaders, useRuntimeConfig, useState } from "#imports";
-import { useCsrfToken } from "./useCsrfToken.js";
+import { useNuxtApp } from "#imports";
 export const useSdk = () => {
-  const nuxtApp = useNuxtApp();
-  if (nuxtApp._sdk) {
-    return nuxtApp._sdk;
-  }
-  const runtimeConfig = useRuntimeConfig();
-  const moduleConfig = runtimeConfig.public.shopCore;
-  const { $router, $i18n } = useNuxtApp();
-  const { token } = useCsrfToken();
-  const requestHeaders = useRequestHeaders(["cookie"]);
-  const ssrCookie = useState("ssr-cookie", () => requestHeaders.cookie ?? "");
-  const getFreshHeaders = () => {
-    const locale = $i18n.locale.value;
-    const referrerId = $router.currentRoute.value.query?.ReferrerID?.toString() ?? "";
-    const noCache = runtimeConfig.public.noCache || $router.currentRoute.value.query?.noCache?.toString() || "";
-    const configId = runtimeConfig.public.configId?.toString();
-    const pwaHashCookie = useCookie("pwa");
-    const headers = {
-      ...configId && { "x-config-id": configId },
-      ...token.value && { "x-csrf-token": token.value },
-      ...pwaHashCookie.value && { "x-pwa-edit-hash": pwaHashCookie.value },
-      ...locale && { locale },
-      ...referrerId && { referrerID: referrerId },
-      ...noCache && { noCache },
-      ...useRequestHeaders(),
-      ...import.meta.server && ssrCookie.value && { cookie: ssrCookie.value }
-    };
-    return {
-      ...headers
-    };
-  };
-  const headersProxy = new Proxy(
-    {},
-    {
-      get(_target, prop, receiver) {
-        return Reflect.get(getFreshHeaders(), prop, receiver);
-      },
-      ownKeys() {
-        return Reflect.ownKeys(getFreshHeaders());
-      },
-      getOwnPropertyDescriptor() {
-        return {
-          enumerable: true,
-          configurable: true
-        };
-      }
-    }
-  );
-  const sdkConfig = {
-    plentysystems: buildModule(
-      middlewareModule,
-      {
-        apiUrl: moduleConfig.apiUrl + "/plentysystems",
-        defaultRequestConfig: {
-          headers: headersProxy
-        },
-        httpClient
-      },
-      () => ({
-        subscribers: {
-          "*_after": (payload) => {
-            const { ssrContext } = useNuxtApp();
-            if (payload.csrfToken) {
-              token.value = payload.csrfToken;
-            }
-            if (import.meta.server && payload.setCookie && ssrContext?.event?.node?.res) {
-              updateSsrCookie(ssrCookie, payload.setCookie);
-              ssrContext.event.node.res.setHeader("Access-Control-Expose-Headers", "Set-Cookie");
-              ssrContext.event.node.res.setHeader("Set-Cookie", payload.setCookie);
-            }
-          }
-        }
-      })
-    )
-  };
-  const sdk = initSDK(sdkConfig);
-  nuxtApp._sdk = sdk;
-  return sdk;
+  const { $sdk } = useNuxtApp();
+  return $sdk;
 };

package/dist/runtime/plugins/sdk.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Plugin to provide the SDK instance globally via $sdk singleton
+ * The SDK is initialized once and reused across requests using the NuxtApp instance
+ */
+declare const _default: import("#app").Plugin<{
+    sdk: 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;
+    }>;
+}> & import("#app").ObjectPlugin<{
+    sdk: 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;
+    }>;
+}>;
+export default _default;

package/dist/runtime/plugins/sdk.js

@@ -0,0 +1,66 @@
+import { defineNuxtPlugin, ref, useCookie, useRequestHeaders, useRuntimeConfig } from "#imports";
+import { useCsrfToken } from "../composables/useCsrfToken.js";
+import { buildModule, initSDK, middlewareModule } from "@vue-storefront/sdk";
+import { httpClient as OriginalHttpClient } from "../utils/sdk/sdk.client.js";
+import { createSdkLogger } from "../utils/sdk/sdk.logger.js";
+import { buildSdkHeaders, handleSdkResponse } from "../utils/sdk/sdk.header.js";
+export default defineNuxtPlugin((nuxtApp) => {
+  const runtimeConfig = useRuntimeConfig();
+  const moduleConfig = runtimeConfig.public.shopCore;
+  const logger = createSdkLogger({ ...moduleConfig.logger?.sdkPlugin, prefix: "[shop-core][sdk plugin]: " });
+  const configId = runtimeConfig.public.configId?.toString();
+  const noCache = runtimeConfig.public.noCache || nuxtApp.$router.currentRoute.value.query?.noCache?.toString() || "";
+  const referrerId = nuxtApp.$router.currentRoute.value.query?.ReferrerID?.toString() ?? "";
+  const { token: csrfToken } = useCsrfToken();
+  const ssrCookie = ref("");
+  logger.log("\u{1F680} initializing SDK plugin");
+  const getHeaders = () => {
+    logger.log("\u{1F9FE} generating fresh headers for SDK request");
+    const requestHeaders = useRequestHeaders(["cookie"]);
+    const pwaHashCookie = useCookie("pwa");
+    const locale = nuxtApp.$i18n.locale.value ?? "en";
+    const headers = buildSdkHeaders({
+      configId,
+      csrfToken: csrfToken.value,
+      pwaHash: pwaHashCookie.value ?? "",
+      locale,
+      referrerId,
+      noCache,
+      requestHeaders,
+      ssrCookie: ssrCookie.value
+    });
+    logger.verbose(`\u{1F4EC} prepared headers: `, JSON.stringify(headers));
+    return {
+      ...headers
+    };
+  };
+  const sdkConfig = {
+    plentysystems: buildModule(middlewareModule, {
+      apiUrl: moduleConfig.apiUrl + "/plentysystems",
+      httpClient: async (url, params, config) => {
+        return nuxtApp.runWithContext(async () => {
+          logger.log(`\u{1F4E1} making SDK request to ${url}`);
+          const freshHeaders = getHeaders();
+          const response = await OriginalHttpClient(url, params, {
+            ...config,
+            headers: { ...config?.headers, ...freshHeaders }
+          });
+          handleSdkResponse({
+            response,
+            csrfToken,
+            ssrCookie,
+            ssrContext: nuxtApp.ssrContext,
+            logger
+          });
+          return response;
+        });
+      }
+    })
+  };
+  const sdk = initSDK(sdkConfig);
+  return {
+    provide: {
+      sdk
+    }
+  };
+});

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

@@ -1 +1,2 @@
 export declare const isClient: () => boolean;
+export declare const isServer: () => boolean;

package/dist/runtime/utils/runtime.js

@@ -1 +1,2 @@
 export const isClient = () => import.meta.client;
+export const isServer = () => import.meta.server;

package/dist/runtime/utils/sdk/sdk.header.d.ts

@@ -0,0 +1,3 @@
+import type { HandleSdkResponseContext, SdkHeaderContext } from './types.js';
+export declare const buildSdkHeaders: (context: SdkHeaderContext) => Record<string, string>;
+export declare const handleSdkResponse: (context: HandleSdkResponseContext) => void;

package/dist/runtime/utils/sdk/sdk.header.js

@@ -0,0 +1,29 @@
+import { isServer } from "../runtime.js";
+import { updateSsrCookie } from "./sdk.helper.js";
+export const buildSdkHeaders = (context) => {
+  const headers = {
+    ...context.configId && { "x-config-id": context.configId },
+    ...context.csrfToken && { "x-csrf-token": context.csrfToken },
+    ...context.pwaHash && { "x-pwa-edit-hash": context.pwaHash },
+    ...context.locale && { locale: context.locale },
+    ...context.referrerId && { referrerID: context.referrerId },
+    ...context.noCache && { noCache: context.noCache },
+    ...context.requestHeaders,
+    ...isServer() && context.ssrCookie && { cookie: context.ssrCookie }
+  };
+  return headers;
+};
+export const handleSdkResponse = (context) => {
+  if (context.response?.csrfToken) {
+    context.logger.verbose("\u{1F510} updating CSRF token from response", context.response.csrfToken);
+    context.csrfToken.value = context.response.csrfToken;
+  }
+  if (isServer() && context.response?.setCookie) {
+    context.logger.verbose("\u{1F36A} updating SSR cookies from response", JSON.stringify(context.response?.setCookie));
+    if (context.ssrContext?.event?.node?.res) {
+      updateSsrCookie(context.ssrCookie, context.response.setCookie);
+      context.ssrContext.event.node.res.setHeader("Access-Control-Expose-Headers", "Set-Cookie");
+      context.ssrContext.event.node.res.setHeader("Set-Cookie", context.response.setCookie);
+    }
+  }
+};

package/dist/runtime/utils/sdk/sdk.logger.d.ts

@@ -0,0 +1,9 @@
+export declare const createSdkLogger: (options: {
+    enabled?: boolean;
+    verbose?: boolean;
+    prefix?: string;
+    serverOnly?: boolean;
+}) => {
+    log: (message: string, args?: string) => void;
+    verbose: (message: string, args?: string) => void;
+};

package/dist/runtime/utils/sdk/sdk.logger.js

@@ -0,0 +1,35 @@
+export const createSdkLogger = (options) => {
+  const config = {
+    enabled: options.enabled ?? false,
+    verbose: options.verbose ?? false,
+    prefix: options.prefix ?? "",
+    serverOnly: options.serverOnly ?? true
+  };
+  if (!config.enabled || config.serverOnly && !import.meta.server) {
+    return {
+      log: () => {
+      },
+      verbose: () => {
+      }
+    };
+  }
+  const log = (message, args = "") => {
+    try {
+      console.log(config.prefix + message, args);
+    } catch {
+    }
+  };
+  const verbose = (message, args = "") => {
+    if (!config.verbose) {
+      return;
+    }
+    try {
+      console.debug(config.prefix + message, args);
+    } catch {
+    }
+  };
+  return {
+    log,
+    verbose
+  };
+};

package/dist/runtime/utils/sdk/types.d.ts

@@ -0,0 +1,19 @@
+import type { Ref } from '#imports';
+import type { createSdkLogger } from './sdk.logger.js';
+export interface SdkHeaderContext {
+    configId?: string;
+    csrfToken?: string;
+    pwaHash?: string;
+    locale?: string;
+    referrerId?: string;
+    noCache?: string;
+    requestHeaders?: Record<string, string>;
+    ssrCookie?: string;
+}
+export interface HandleSdkResponseContext {
+    response: any;
+    csrfToken: Ref<string>;
+    ssrCookie: Ref<string>;
+    ssrContext: any;
+    logger: ReturnType<typeof createSdkLogger>;
+}

package/package.json

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