@vue-storefront/nuxt 6.1.0 → 6.2.0

package/README.md

@@ -32,8 +32,8 @@ export default defineNuxtConfig({
   modules: ["@vue-storefront/nuxt"],
   vsf: {
     middleware: {
-      apiUrl: "http://localhost:4000"
-    }
+      apiUrl: "http://localhost:4000",
+    },
   },
 });
 ```

package/dist/module.d.mts

@@ -27,11 +27,17 @@ interface MultistoreConfig {
      */
     enabled: boolean;
 }
-interface SdkModuleOptions {
+type LogVerbosity = "emergency" | "alert" | "critical" | "error" | "warning" | "notice" | "info" | "debug";
+type LoggerOptions = Partial<{
+    verbosity: LogVerbosity;
+    includeStackTrace: boolean;
+}>;
+interface AlokaiModuleOptions {
     middleware: MiddlewareConfig;
     multistore?: MultistoreConfig;
+    logger?: LoggerOptions;
 }
 
-declare const _default: _nuxt_schema.NuxtModule<SdkModuleOptions>;
+declare const _default: _nuxt_schema.NuxtModule<AlokaiModuleOptions>;
 
 export { _default as default };

package/dist/module.d.ts

@@ -27,11 +27,17 @@ interface MultistoreConfig {
      */
     enabled: boolean;
 }
-interface SdkModuleOptions {
+type LogVerbosity = "emergency" | "alert" | "critical" | "error" | "warning" | "notice" | "info" | "debug";
+type LoggerOptions = Partial<{
+    verbosity: LogVerbosity;
+    includeStackTrace: boolean;
+}>;
+interface AlokaiModuleOptions {
     middleware: MiddlewareConfig;
     multistore?: MultistoreConfig;
+    logger?: LoggerOptions;
 }
 
-declare const _default: _nuxt_schema.NuxtModule<SdkModuleOptions>;
+declare const _default: _nuxt_schema.NuxtModule<AlokaiModuleOptions>;
 
 export { _default as default };

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "6.1.0",
+  "version": "6.2.0",
   "builder": {
     "@nuxt/module-builder": "0.7.1",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -17,6 +17,10 @@ const module = defineNuxtModule({
     },
     multistore: {
       enabled: false
+    },
+    logger: {
+      includeStackTrace: false,
+      verbosity: "debug"
     }
   },
   async setup(options, nuxt) {
@@ -76,10 +80,26 @@ export type SdkConfig = ${genInlineTypeImport(
       filename: "useSfState.ts",
       write: true
     });
+    addTemplate({
+      src: localResolver.resolve("./runtime/logger.template"),
+      filename: "logger.ts",
+      write: true,
+      options: {
+        moduleConfig: JSON.stringify(options)
+      }
+    });
+    addTemplate({
+      src: localResolver.resolve("./runtime/errorHandler.template"),
+      filename: "errorHandler.ts",
+      write: true
+    });
     addPluginTemplate({
       src: localResolver.resolve("./runtime/plugin.template"),
-      filename: "alokaiSdkPlugin.ts",
-      write: true
+      filename: "alokaiPlugin.ts",
+      write: true,
+      options: {
+        moduleConfig: JSON.stringify(options)
+      }
     });
     addImportsSources([
       {
@@ -93,6 +113,10 @@ export type SdkConfig = ${genInlineTypeImport(
       {
         imports: ["useSfState"],
         from: buildDirectoryResolver.resolve("useSfState.ts")
+      },
+      {
+        imports: ["logger"],
+        from: buildDirectoryResolver.resolve("logger.ts")
       }
     ]);
   }

package/dist/runtime/defineSdkConfig.template

@@ -1,6 +1,6 @@
 import { buildModule, middlewareModule } from "@vue-storefront/sdk";
 import { composeMiddlewareUrl, useNuxtApp, useRequestHeaders, getDefaultMethodsRequestConfig } from "#imports";
-import { SdkModuleOptions } from "./alokaiModule";
+import type { AlokaiModuleOptions } from "./alokaiModule";
 
 type InjectedContext = {
   buildModule: typeof buildModule;
@@ -30,7 +30,7 @@ type InjectedContext = {
 
 type Config<TConfig> = (context: InjectedContext) => TConfig;
 
-const moduleConfig: SdkModuleOptions = <%= options.moduleConfig %>;
+const moduleConfig: AlokaiModuleOptions = <%= options.moduleConfig %>;
 
 /**
   * Define SDK config function
@@ -55,7 +55,7 @@ const moduleConfig: SdkModuleOptions = <%= options.moduleConfig %>;
   *     }),
   *     contentful: buildModule(contentfulModule, {
   *       apiUrl: config.middlewareUrl + "/cntf",
-  *     }),
+  *     })
   *   }),
   * );
   * ```
@@ -93,9 +93,9 @@ export function defineSdkConfig<TConfig>(config: Config<TConfig>) {
 }
 
 function resolveOptions(
-  input: SdkModuleOptions,
+  input: Omit<AlokaiModuleOptions, 'logger'>,
   options: Partial<ResolveSdkOptionsConfig> = {}
-): SdkModuleOptions {
+): AlokaiModuleOptions {
   if (input?.multistore?.enabled) {
     return {
       middleware: {

package/dist/runtime/errorHandler.template

@@ -0,0 +1,5 @@
+export default defineNuxtPlugin((nuxtApp) => {
+  nuxtApp.hook('vue:error', (error) => {
+    logger.error(error);
+  });
+});

package/dist/runtime/logger.template

@@ -0,0 +1,37 @@
+import { LoggerFactory, LoggerType, type LoggerInterface } from "@vue-storefront/logger";
+import type { AlokaiModuleOptions, LoggerOptions } from "./alokaiModule";
+
+function injectMetadata(
+  logger: LoggerInterface,
+  externalData: Record<string, any>,
+): LoggerInterface {
+  return new Proxy(logger, {
+    get(target, prop) {
+      const targetProp = target[prop as keyof LoggerInterface];
+      if (typeof targetProp === "function") {
+        return (...args: Parameters<typeof targetProp>[]) => {
+          const [logData, metadata] = args;
+          targetProp(logData, {
+            ...metadata,
+            ...externalData,
+          });
+        };
+      }
+      return targetProp;
+    },
+  });
+}
+
+const moduleConfig: AlokaiModuleOptions = <%= options.moduleConfig %>;
+
+const createLogger = (options?: LoggerOptions) => {
+  const logger = LoggerFactory.create(LoggerType.ConsolaGcp, options);
+
+  return injectMetadata(logger, {
+    alokai: {
+      context: "storefront",
+    },
+  });
+};
+
+export const logger = createLogger(moduleConfig.logger);

package/dist/runtime/types.template

@@ -27,7 +27,23 @@ export interface MultistoreConfig {
   enabled: boolean;
 }
 
-export interface SdkModuleOptions {
+type LogVerbosity =
+  | "emergency"
+  | "alert"
+  | "critical"
+  | "error"
+  | "warning"
+  | "notice"
+  | "info"
+  | "debug";
+
+export type LoggerOptions = Partial<{
+  verbosity: LogVerbosity;
+  includeStackTrace: boolean;
+}>;
+
+export interface AlokaiModuleOptions {
   middleware: MiddlewareConfig;
   multistore?: MultistoreConfig;
+  logger?: LoggerOptions;
 }

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

@@ -1,6 +1,6 @@
-import { SdkModuleOptions } from "~/src/types";
+import type { AlokaiModuleOptions } from "~/src/types";
 interface ComposeMiddlewareUrlParams {
-    options: SdkModuleOptions;
+    options: AlokaiModuleOptions;
     headers: Record<string, string | string[]>;
 }
 /**

package/dist/types.d.mts

@@ -14,6 +14,14 @@ import type {  } from './module.js'
   /** @default false */
   enabled: boolean,
  },
+
+ logger: {
+  /** @default false */
+  includeStackTrace: boolean,
+
+  /** @default "debug" */
+  verbosity: string,
+ },
 }
 
 declare module '@nuxt/schema' {

package/dist/types.d.ts

@@ -14,6 +14,14 @@ import type {  } from './module'
   /** @default false */
   enabled: boolean,
  },
+
+ logger: {
+  /** @default false */
+  includeStackTrace: boolean,
+
+  /** @default "debug" */
+  verbosity: string,
+ },
 }
 
 declare module '@nuxt/schema' {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vue-storefront/nuxt",
-  "version": "6.1.0",
-  "description": "Vue Storefront dedicated features for Nuxt",
+  "version": "6.2.0",
+  "description": "Alokai dedicated features for Nuxt",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -18,13 +18,8 @@
   ],
   "scripts": {
     "build": "nuxt-module-build build",
-    "build:app": "cd __tests__/app && yarn build",
-    "dev": "cd __tests__/app && yarn dev",
-    "dev:middleware": "cd ../shared/src/__tests__/middleware && yarn dev",
-    "lint": "eslint --ext .vue,.js,.ts .",
-    "test:e2e:run": "start-server-and-test dev:middleware localhost:4000/test_integration/getSuccess dev localhost:3000/ssr \"yarn test:e2e\"",
-    "test:e2e": "cd ../shared/ && yarn test:e2e",
-    "test:watch": "vitest watch",
+    "lint": "biome ci .",
+    "format": "prettier --write .",
     "prepare": "nuxi prepare"
   },
   "dependencies": {
@@ -33,20 +28,22 @@
     "@pinia/nuxt": "^0.5.1",
     "defu": "^6.0.0",
     "knitwork": "^1.0.0",
-    "pinia": "^2.1.7"
+    "pinia": "^2.1.7",
+    "@vue-storefront/logger": "1.0.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.17",
-    "@nuxt/devtools": "1.3.3",
+    "@nuxt/devtools": "1.3.8",
     "@nuxt/module-builder": "0.7.1",
-    "@nuxt/test-utils": "3.13.1",
-    "@vue-storefront/sdk": "^3.1.0",
-    "@vue-storefront/unified-data-model": "^2.0.0",
-    "nuxt": "3.12.2",
-    "start-server-and-test": "^2.0.3",
-    "vitest": "1.6.0"
+    "@vue-storefront/sdk": "3.3.0",
+    "@vue-storefront/unified-data-model": "*",
+    "@biomejs/biome": "1.9.2",
+    "nuxt": "3.12.2"
   },
   "peerDependencies": {
-    "@vue-storefront/sdk": "^3.1.0"
+    "@vue-storefront/sdk": "3.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }