@scayle/storefront-nuxt 8.24.2 → 8.25.0

package/CHANGELOG.md

@@ -1,6 +1,58 @@
 # @scayle/storefront-nuxt
 
-## 8.24.2
+## 8.25.0
+
+### Minor Changes
+
+- This change introduces the ability for the host application to define its own storage mounts, enhancing the flexibility of managing cache and session storage options within the Nuxt project.
+  To provide preconfigured storage mounts, the host application needs to mount storage drivers with specific names. The names `storefront-session` and `storefront-cache` are used for general cache and session storage, respectively. Additionally, shop-specific cache and session drivers can be configured by appending `:<shopId>` to the name, such as `storefront-session:1001` and `storefront-cache:1001`.
+
+  Preconfigured storage mounts can be implemented via a Nuxt server plugin within `./server/plugins`. If necessary, the `runtimeConfig` can be utilized to store the drivers' configuration:
+
+  ```ts
+  import fsDriver from 'unstorage/drivers/fs'
+  import compressionDriver from "@scayle/unstorage-compression-driver"
+  import { defineNitroPlugin, useStorage } from '#imports'
+
+  export default defineNitroPlugin(() => {
+    const storage = useStorage()
+    const config = useRuntimeConfig()
+    // Configure global storage (used as base config for all shops)
+    storage.mount('storefront-session', fsDriver({
+      base: config.sessionStorageBase,
+    }))
+    storage.mount('storefront-cache', fsDriver({
+      base: './cache',
+    }))
+
+    // The storage configuration can be overwritten on shop level if needed
+    storage.mount('storefront-cache:1001', compressionDriver(
+      encoding: 'brotli',
+      passthroughDriver: fsDriver({ base: './cache_1001' })
+    ))
+  })
+  ```
+
+  In scenarios where the build must not be runtime agnostic, the storage can also be configured statically in the `nuxt.config.ts` file. However, this is not the recommended approach:
+
+  ```ts
+  export default defineNuxtConfig({
+    nitro: {
+      storage: {
+        redis: {
+          driver: 'redis',
+          host: 'localhost',
+        },
+        db: {
+          driver: 'fs',
+          base: './.data/db',
+        },
+      },
+    },
+  })
+  ```
+
+  With the introduction of the new approach for configuring storefront storage mounts, the global and shop-specific `storage` option within the `@scayle/storefront-nuxt` runtime configuration has been deprecated.
 
 ### Patch Changes
 
@@ -11,7 +63,7 @@
 
 - Updated dependency to @scayle/h3-session@0.6.1
 
-**@scayle/storefront-core v8.24.2**
+**@scayle/storefront-core v8.25.0**
 
 - Patch
   - **\[Code Style\]** Refactored brands and navigation tree RPCs to avoid destructuring the RPC context within function signatures

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "8.24.2",
+  "version": "8.25.0",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"

package/dist/module.mjs

@@ -54,7 +54,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.24.2";
+const PACKAGE_VERSION = "8.25.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {
@@ -89,7 +89,7 @@ function createRpcMethodTypeDeclaration(customRpcImports) {
     }
     export {}`;
 }
-async function nitroSetup(nitroConfig, config) {
+async function nitroSetup(nitroConfig, config, moduleOptions) {
   const { resolve, resolvePath } = createResolver(import.meta.url);
   const { apiBasePath, customRpcImports, coreMethodNames, usedDrivers } = config;
   nitroConfig.replace = nitroConfig.replace || {};
@@ -139,9 +139,13 @@ async function nitroSetup(nitroConfig, config) {
   nitroConfig.plugins = nitroConfig.plugins ?? [];
   nitroConfig.plugins.push(resolve("./runtime/nitro/plugins/nitroLogger"));
   nitroConfig.plugins.push(resolve("./runtime/nitro/plugins/redirectOnError"));
-  nitroConfig.plugins.push(
-    resolve("./runtime/nitro/plugins/nitroRuntimeStorageConfig")
-  );
+  if (!!moduleOptions?.storage || Object.values(moduleOptions?.shops || {}).some(
+    (shopConfig) => !!shopConfig.storage
+  )) {
+    nitroConfig.plugins.push(
+      resolve("./runtime/nitro/plugins/nitroLegacyStorageConfig")
+    );
+  }
   nitroConfig.plugins.push(
     resolve("./runtime/nitro/plugins/internalFetch")
   );
@@ -179,6 +183,16 @@ async function nitroSetup(nitroConfig, config) {
   nitroConfig.externals.inline = nitroConfig.externals.inline ?? [];
   nitroConfig.externals.inline.push(...tracedImports);
 }
+async function nitroPostInit(moduleOptions, nitroApp) {
+  const { resolve } = createResolver(import.meta.url);
+  if (!moduleOptions?.storage && !Object.values(moduleOptions?.shops || {}).some(
+    (shopConfig) => !!shopConfig.storage
+  )) {
+    nitroApp.options.plugins.push(
+      resolve("./runtime/nitro/plugins/nitroStorageConfig")
+    );
+  }
+}
 function validateRpcMethodOverrides(rpcMethodOverrides, customRpcNames, coreRpcNames) {
   const overriddenRPCMethodNames = new Set(rpcMethodOverrides);
   for (const rpcMethodName of customRpcNames) {
@@ -340,9 +354,10 @@ const module = defineNuxtModule({
         customRpcImports,
         coreMethodNames: [...rpcMethodNames],
         usedDrivers: getUsedDrivers(nuxt.options.runtimeConfig.storefront)
-      });
+      }, nuxt.options.runtimeConfig.storefront);
     });
-    nuxt.hooks.hook("nitro:init", (nitro) => {
+    nuxt.hooks.hook("nitro:init", async (nitro) => {
+      await nitroPostInit(nuxt.options.runtimeConfig.storefront, nitro);
       nitro.hooks.hook("rollup:before", (_nitro, rollupConfig) => {
         const existingHandler = rollupConfig.onwarn;
         rollupConfig.onwarn = (warning, handler) => {

package/dist/runtime/nitro/plugins/{nitroRuntimeStorageConfig.js → nitroLegacyStorageConfig.js}

@@ -9,6 +9,7 @@ import drivers from "#virtual/storage-drivers";
 import { defineNitroPlugin } from "nitropack/runtime/plugin";
 import { useStorage } from "nitropack/runtime/storage";
 import { useRuntimeConfig } from "#imports";
+import { getAvailableMounts } from "../../utils/storage.js";
 function createMountDriver(options) {
   if (options?.driver) {
     const compression = options?.compression;
@@ -25,7 +26,7 @@ function createMountDriver(options) {
 }
 function mountStorage(storage, options) {
   const { config, base } = options;
-  const mounts = storage.getMounts().map((existingMount) => existingMount.base.replace(":", ""));
+  const mounts = getAvailableMounts(storage);
   if (!mounts.includes(base)) {
     if (config) {
       storage.mount(base, createMountDriver(config));

package/dist/runtime/nitro/plugins/nitroStorageConfig.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This plugin expects a `storefront-cache` and `storefront-session` mount point to be provided.
+ * It will then mount a shop-specific storage mounts for each shop in the configuration.
+ * When a shop-specific mount is already provided, it will not be overridden.
+ */
+declare const _default: import("nitropack").NitroAppPlugin;
+export default _default;

package/dist/runtime/nitro/plugins/nitroStorageConfig.js

@@ -0,0 +1,57 @@
+import { createConsola } from "consola";
+import {
+  STORAGE_MOUNT_CACHE,
+  STORAGE_MOUNT_SESSION
+} from "../../server/utils/cacheStorage.js";
+import createLog from "../../createLog.js";
+import { JSONReporter } from "../../JSONReporter.js";
+import { defineNitroPlugin } from "nitropack/runtime/plugin";
+import { useStorage } from "nitropack/runtime/storage";
+import { useRuntimeConfig } from "#imports";
+import { getAvailableMounts, mountStorage } from "../../utils/storage.js";
+export default defineNitroPlugin(async () => {
+  const storage = useStorage();
+  const config = useRuntimeConfig();
+  const { shops } = config.storefront;
+  const logConfig = config.public.storefront.log;
+  const log = createLog(
+    (opts) => createConsola({
+      ...logConfig.json ? { reporters: [new JSONReporter()] } : void 0,
+      stderr: logConfig.output === "stdout" ? process.stdout : process.stderr,
+      stdout: logConfig.output === "stderr" ? process.stderr : process.stdout,
+      ...opts
+    }),
+    logConfig.name,
+    logConfig.level
+  );
+  const availableMounts = getAvailableMounts(storage);
+  if (!availableMounts.includes(STORAGE_MOUNT_SESSION)) {
+    log.warn(
+      `${STORAGE_MOUNT_SESSION} storage mount not provided. Falling back to memory driver.`
+    );
+  }
+  if (!availableMounts.includes(STORAGE_MOUNT_CACHE)) {
+    log.warn(
+      `${STORAGE_MOUNT_CACHE} storage mount not provided. Falling back to memory driver.`
+    );
+  }
+  const mountShopStorage = async (shopId, mount) => {
+    try {
+      if (!availableMounts.includes(mount)) {
+        await mountStorage(storage, mount);
+      }
+    } catch (error) {
+      log.error(
+        `Unable to create required storage mount '${mount}'.`,
+        error
+      );
+    }
+  };
+  for (const shop of Object.values(shops)) {
+    await mountShopStorage(shop.shopId, `${STORAGE_MOUNT_CACHE}:${shop.shopId}`);
+    await mountShopStorage(
+      shop.shopId,
+      `${STORAGE_MOUNT_SESSION}:${shop.shopId}`
+    );
+  }
+});

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

@@ -0,0 +1,19 @@
+import type { Storage } from 'unstorage';
+/**
+ * Returns a list of available mount points for the provided storage instance.
+ * The mount points are normalized by removing the tailing `:`.
+ * @param storage - The storage instance.
+ * @returns List of available mount points.
+ */
+export declare const getAvailableMounts: (storage: Storage) => string[];
+/**
+ * Mounts a {@link Storage | storage}.
+ *
+ * It checks if a mount with the given base path already exists and
+ * mounts a new storage instance if not. It prioritizes a provided configuration,
+ * falling back to the default memory driver.
+ *
+ * @param storage - The storage instance to mount to.
+ * @param mount - Mount name.
+ */
+export declare const mountStorage: (storage: Storage, mount: string) => Promise<void>;

package/dist/runtime/utils/storage.js

@@ -0,0 +1,13 @@
+export const getAvailableMounts = (storage) => {
+  return storage.getMounts().map((existingMount) => existingMount.base.replace(/:$/, ""));
+};
+export const mountStorage = async (storage, mount) => {
+  const mounts = getAvailableMounts(storage);
+  if (!mounts.includes(mount)) {
+    const { driver: baseDriver } = storage.getMount(mount);
+    storage.mount(
+      mount,
+      baseDriver
+    );
+  }
+};

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

@@ -251,6 +251,7 @@ declare const ShopConfigSchema: z.ZodObject<{
         host: string;
         token: string;
     }>>;
+    /** @deprecated The `storage` option within `shopConfig` is deprecated. Consider using nuxt storage configuration instead.  */
     storage: z.ZodOptional<z.ZodObject<{
         session: z.ZodOptional<z.ZodDiscriminatedUnion<"driver", [z.ZodObject<{
             driver: z.ZodEnum<[BuiltinDriverName, ...BuiltinDriverName[]]>;
@@ -615,6 +616,7 @@ declare const StorefrontConfigSchema: z.ZodObject<{
         secret?: string | string[] | undefined;
         domain?: string | undefined;
     }>>;
+    /** @deprecated The `storage` option within `storefront` is deprecated. Consider using nuxt storage configuration instead.  */
     storage: z.ZodOptional<z.ZodObject<{
         session: z.ZodOptional<z.ZodDiscriminatedUnion<"driver", [z.ZodObject<{
             driver: z.ZodEnum<[BuiltinDriverName, ...BuiltinDriverName[]]>;
@@ -1194,6 +1196,7 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
                 host: string;
                 token: string;
             }>>;
+            /** @deprecated The `storage` option within `shopConfig` is deprecated. Consider using nuxt storage configuration instead.  */
             storage: z.ZodOptional<z.ZodObject<{
                 session: z.ZodOptional<z.ZodDiscriminatedUnion<"driver", [z.ZodObject<{
                     driver: z.ZodEnum<[BuiltinDriverName, ...BuiltinDriverName[]]>;
@@ -1726,6 +1729,7 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
             secret?: string | string[] | undefined;
             domain?: string | undefined;
         }>>;
+        /** @deprecated The `storage` option within `storefront` is deprecated. Consider using nuxt storage configuration instead.  */
         storage: z.ZodOptional<z.ZodObject<{
             session: z.ZodOptional<z.ZodDiscriminatedUnion<"driver", [z.ZodObject<{
                 driver: z.ZodEnum<[BuiltinDriverName, ...BuiltinDriverName[]]>;

package/dist/runtime/utils/zodSchema.js

@@ -102,6 +102,7 @@ const ShopConfigSchema = z.object({
   isEnabled: z.boolean().optional(),
   sessionConfig: SessionSchema.optional(),
   sapi: SapiSchema.optional(),
+  /** @deprecated The `storage` option within `shopConfig` is deprecated. Consider using nuxt storage configuration instead.  */
   storage: z.object({
     session: StorageSchema.optional(),
     cache: StorageSchema.optional()
@@ -118,6 +119,7 @@ const CacheSchema = z.object({
 const ShopSelectorSchema = z.enum(["path", "domain", "path_or_default"]);
 const StorefrontConfigSchema = z.object({
   session: SessionSchema.optional(),
+  /** @deprecated The `storage` option within `storefront` is deprecated. Consider using nuxt storage configuration instead.  */
   storage: z.object({
     session: StorageSchema.optional(),
     cache: StorageSchema.optional()

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.24.2",
+  "version": "8.25.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -81,7 +81,7 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "0.6.1",
-    "@scayle/storefront-core": "8.24.2",
+    "@scayle/storefront-core": "8.25.0",
     "@scayle/unstorage-compression-driver": "^0.2.6",
     "@vercel/nft": "0.29.2",
     "@vueuse/core": "13.1.0",