@plentymarkets/shop-core 1.21.14 → 1.22.0

package/dist/module.json

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

package/dist/module.mjs

@@ -113,6 +113,7 @@ export type ShopCoreConfig = ${genInlineTypeImport(projectRootResolver.resolve("
       filePath: buildDirectoryResolver.resolve("ModuleComponentRendering.vue")
     });
     addPlugin(resolver.resolve("./runtime/plugins/sdk"));
+    addPlugin(resolver.resolve("./runtime/plugins/cache-control.server.ts"));
     addImports({
       name: "useSdk",
       as: "useSdk",

package/dist/runtime/plugins/cache-control.server.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Server-only plugin that sets Cache-Control response headers per request.
+ */
+declare const _default: import("#app").Plugin<Record<string, unknown>> & import("#app").ObjectPlugin<Record<string, unknown>>;
+export default _default;

package/dist/runtime/plugins/cache-control.server.js

@@ -0,0 +1,24 @@
+import { defineNuxtPlugin, useCookie, useRequestEvent, useRuntimeConfig } from "#imports";
+import { setResponseHeader } from "h3";
+import { getCacheControlMeta } from "../utils/cacheHelper.js";
+import { isServer } from "../utils/runtime.js";
+export default defineNuxtPlugin({
+  name: "shop-core:cache-control",
+  enforce: "post",
+  setup(nuxtApp) {
+    if (!isServer()) return;
+    const event = useRequestEvent();
+    if (!event) return;
+    const runtimeConfig = useRuntimeConfig();
+    const pwaCookie = useCookie("pwa");
+    const cacheControlValue = getCacheControlMeta(nuxtApp.$router);
+    const isPreview = !!pwaCookie.value || !!runtimeConfig.public.isPreview;
+    if (cacheControlValue && !isPreview) {
+      setResponseHeader(event, "Cache-Control", cacheControlValue);
+    } else {
+      setResponseHeader(event, "Cache-Control", "no-cache, no-store, must-revalidate");
+      setResponseHeader(event, "Pragma", "no-cache");
+      setResponseHeader(event, "Expires", "0");
+    }
+  }
+});

package/dist/runtime/plugins/sdk.js

@@ -6,6 +6,7 @@ import { createSdkLogger } from "../utils/sdk/sdk.logger.js";
 import { createSdkRequestHeaders, getI18nLocale } from "../utils/sdk/sdk.request.headers.js";
 import { handleSdkResponse } from "../utils/sdk/sdk.response.headers.js";
 import { setSSRMetrics } from "../utils/ssrMetricsHelper.js";
+import { getCacheControlMeta } from "../utils/cacheHelper.js";
 export default defineNuxtPlugin((nuxtApp) => {
   const runtimeConfig = useRuntimeConfig();
   const moduleConfig = runtimeConfig.public.shopCore;
@@ -17,7 +18,7 @@ export default defineNuxtPlugin((nuxtApp) => {
     );
   const noCache = runtimeConfig.public.noCache || nuxtApp.$router.currentRoute.value.query?.noCache?.toString() || "";
   const referrerId = nuxtApp.$router.currentRoute.value.query?.ReferrerID?.toString() ?? "";
-  const shouldSkipCookiesSSR = nuxtApp.$router.currentRoute.value.meta?.skipCookiesSSR ?? false;
+  const isCacheable = getCacheControlMeta(nuxtApp.$router);
   const { token: csrfToken } = useCsrfToken();
   const ssrCookie = ref([]);
   logger.log("\u{1F680} initializing SDK plugin");
@@ -35,7 +36,7 @@ export default defineNuxtPlugin((nuxtApp) => {
       noCache,
       requestHeaders,
       ssrCookie: ssrCookie.value,
-      shouldSkipCookiesSSR
+      shouldSkipCookiesSSR: !!isCacheable
     });
     logger.verbose(`\u{1F4EC} prepared headers: `, JSON.stringify(headers));
     return {

package/dist/runtime/templates/types.template

@@ -7,8 +7,12 @@ declare module '#app' {
     };
   }
   interface PageMeta {
-    /** When true, the x-without-session-cookie header is sent for all SDK requests on this page during SSR. */
-    skipCookiesSSR?: boolean;
+    /** Cache-Control header value to set for this page, e.g. { type: 'public', maxAge: 30, staleWhileRevalidate: 900 } */
+    cacheControl?: {
+      maxAge: number;
+      staleWhileRevalidate: number;
+      type: 'public' | 'private'
+    };
   }
 }
 

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

@@ -0,0 +1 @@
+export declare const getCacheControlMeta: (route: any) => string | false;

package/dist/runtime/utils/cacheHelper.js

@@ -0,0 +1,7 @@
+export const getCacheControlMeta = (route) => {
+  const cacheControl = route?.currentRoute?.value?.meta?.cacheControl;
+  if (!cacheControl || typeof cacheControl !== "object") return false;
+  const { type, maxAge, staleWhileRevalidate } = cacheControl;
+  if (typeof type !== "string" || typeof maxAge !== "number" || typeof staleWhileRevalidate !== "number") return false;
+  return `${type}, max-age=${maxAge}, stale-while-revalidate=${staleWhileRevalidate}`;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plentymarkets/shop-core",
-  "version": "1.21.14",
+  "version": "1.22.0",
   "description": "Core module for PlentyONE Shop",
   "repository": {
     "type": "git",