@scayle/storefront-nuxt 8.18.0 → 8.19.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @scayle/storefront-nuxt
 
+## 8.19.0
+
+### Minor Changes
+
+- Add a new `output` option to the log config. It controls where server-side logs are sent and can be set to `stderr`, `stdout` or `auto`. `stderr` and `stdout` will send all logs to the configured steam, while `auto` will send error logs `stderr` and other logs to `stdout`. `auto` is the default value.
+- Add a new `json` option to the log config. When this is enabled via the nuxt.config or setting `NUXT_PUBLIC_STOREFRONT_LOG_JSON=true` in the `.env`, logs will be output in a JSON format.
+
+### Patch Changes
+
+- Updated dependency `@vueuse/core@13.0.0` to `@vueuse/core@13.1.0`
+
+**@scayle/storefront-core v8.19.0**
+
+**Dependencies**
+
 ## 8.18.0
 
 ### Patch Changes

package/dist/module.json

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

package/dist/module.mjs

@@ -53,7 +53,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.18.0";
+const PACKAGE_VERSION = "8.19.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {
@@ -257,7 +257,9 @@ const module = defineNuxtModule({
     nuxt.options.runtimeConfig.public.storefront = defu(nuxt.options.runtimeConfig.public.storefront, {
       log: {
         name: "storefront-nuxt",
-        level: "info"
+        level: "info",
+        json: false,
+        output: "auto"
       }
     });
     extendViteConfig((config) => {

package/dist/runtime/JSONReporter.d.ts

@@ -0,0 +1,17 @@
+import type { LogObject, ConsolaReporter, FormatOptions, ConsolaOptions } from 'consola';
+/**
+ * This custom Consola reporter formats log objects in a JSON string.
+ * It is a modified version of the built-in BasicReporter
+ * https://github.com/unjs/consola/blob/main/src/reporters/basic.ts
+ */
+export declare class JSONReporter implements ConsolaReporter {
+    formatStack(stack: string, message: string, opts: FormatOptions): string;
+    formatError(err: object, opts: FormatOptions): string;
+    formatArgs(args: unknown[], opts: FormatOptions): string;
+    formatDate(date: Date, opts: FormatOptions): string;
+    filterAndJoin(arr: (string | undefined | null)[]): string;
+    formatLogObj(logObj: LogObject, opts: FormatOptions): string;
+    log(logObj: LogObject, ctx: {
+        options: ConsolaOptions;
+    }): boolean;
+}

package/dist/runtime/JSONReporter.js

@@ -0,0 +1,55 @@
+import { formatWithOptions } from "node:util";
+import { sep } from "node:path";
+function parseStack(stack, message) {
+  const cwd = process.cwd() + sep;
+  const lines = stack.split("\n").splice(message.split("\n").length).map((l) => l.trim().replace("file://", "").replace(cwd, ""));
+  return lines;
+}
+export class JSONReporter {
+  formatStack(stack, message, opts) {
+    const indent = "  ".repeat((opts?.errorLevel || 0) + 1);
+    return indent + parseStack(stack, message).join(`
+${indent}`);
+  }
+  formatError(err, opts) {
+    const message = "message" in err && err.message && typeof err.message === "string" ? err.message : formatWithOptions(opts, err);
+    const stack = "stack" in err && err.stack && typeof err.stack === "string" ? this.formatStack(err.stack, message, opts) : "";
+    const level = opts?.errorLevel || 0;
+    const causedPrefix = level > 0 ? `${"  ".repeat(level)}[cause]: ` : "";
+    const causedError = "cause" in err && err.cause ? "\n\n" + this.formatError(err.cause, { ...opts, errorLevel: level + 1 }) : "";
+    return causedPrefix + message + "\n" + stack + causedError;
+  }
+  formatArgs(args, opts) {
+    const _args = args.map((arg) => {
+      if (arg && arg instanceof Error) {
+        return this.formatError(arg, opts);
+      }
+      return arg;
+    });
+    return formatWithOptions(opts, ..._args);
+  }
+  formatDate(date, opts) {
+    return opts.date ? date.toLocaleTimeString() : "";
+  }
+  filterAndJoin(arr) {
+    return arr.filter(Boolean).join(" ");
+  }
+  formatLogObj(logObj, opts) {
+    const message = this.formatArgs(logObj.args, opts);
+    return JSON.stringify({
+      timestamp: logObj.date.toISOString(),
+      message,
+      severity: logObj.type
+    });
+  }
+  log(logObj, ctx) {
+    const line = this.formatLogObj(logObj, {
+      columns: ctx.options.stdout?.columns || 0,
+      ...ctx.options.formatOptions,
+      colors: false,
+      compact: true
+    });
+    const stream = logObj.level < 2 ? ctx.options.stderr || process.stderr : ctx.options.stdout || process.stdout;
+    return stream.write(line + "\n");
+  }
+}

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

@@ -2,10 +2,20 @@ import { createConsola } from "consola";
 import { defineNitroPlugin } from "nitropack/runtime/plugin";
 import { useRuntimeConfig } from "#imports";
 import createLog from "../../createLog.js";
+import { JSONReporter } from "../../JSONReporter.js";
 export default defineNitroPlugin((nitroApp) => {
   const config = useRuntimeConfig();
   const logConfig = config.public.storefront.log;
-  const log = createLog(createConsola, logConfig.name, logConfig.level);
+  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
+  );
   log.info(`Logger instance created. Level: ${logConfig.level}`);
   nitroApp.hooks.hook("request", (event) => {
     event.context.$log = log;

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

@@ -4,6 +4,7 @@ import {
   STORAGE_MOUNT_SESSION
 } from "../../server/utils/cacheStorage.js";
 import createLog from "../../createLog.js";
+import { JSONReporter } from "../../JSONReporter.js";
 import drivers from "#virtual/storage-drivers";
 import { defineNitroPlugin } from "nitropack/runtime/plugin";
 import { useStorage } from "nitropack/runtime/storage";
@@ -38,7 +39,16 @@ export default defineNitroPlugin(() => {
   const config = useRuntimeConfig();
   const { shops } = config.storefront;
   const logConfig = config.public.storefront.log;
-  const log = createLog(createConsola, logConfig.name, logConfig.level);
+  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
+  );
   try {
     const globalCacheConfig = config.storefront.storage?.cache;
     mountStorage(storage, {

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

@@ -1028,12 +1028,18 @@ declare const PublicRuntimeConfigSchema: z.ZodObject<{
     log: z.ZodObject<{
         name: z.ZodString;
         level: z.ZodType<LogLevel, z.ZodTypeDef, LogLevel>;
+        json: z.ZodOptional<z.ZodBoolean>;
+        output: z.ZodDefault<z.ZodEnum<["stdout", "stderr", "auto"]>>;
     }, "strip", z.ZodTypeAny, {
         name: string;
         level: LogLevel;
+        output: "stdout" | "stderr" | "auto";
+        json?: boolean | undefined;
     }, {
         name: string;
         level: LogLevel;
+        json?: boolean | undefined;
+        output?: "stdout" | "stderr" | "auto" | undefined;
     }>;
     /** Collection of feature flags regarding legacy features and functionalities */
     legacy: z.ZodOptional<z.ZodObject<{
@@ -1047,6 +1053,8 @@ declare const PublicRuntimeConfigSchema: z.ZodObject<{
     log: {
         name: string;
         level: LogLevel;
+        output: "stdout" | "stderr" | "auto";
+        json?: boolean | undefined;
     };
     legacy?: {
         enableDefaultGetCachedDataOverride?: boolean | undefined;
@@ -1055,6 +1063,8 @@ declare const PublicRuntimeConfigSchema: z.ZodObject<{
     log: {
         name: string;
         level: LogLevel;
+        json?: boolean | undefined;
+        output?: "stdout" | "stderr" | "auto" | undefined;
     };
     legacy?: {
         enableDefaultGetCachedDataOverride?: boolean | undefined;
@@ -2130,12 +2140,18 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
             log: z.ZodObject<{
                 name: z.ZodString;
                 level: z.ZodType<LogLevel, z.ZodTypeDef, LogLevel>;
+                json: z.ZodOptional<z.ZodBoolean>;
+                output: z.ZodDefault<z.ZodEnum<["stdout", "stderr", "auto"]>>;
             }, "strip", z.ZodTypeAny, {
                 name: string;
                 level: LogLevel;
+                output: "stdout" | "stderr" | "auto";
+                json?: boolean | undefined;
             }, {
                 name: string;
                 level: LogLevel;
+                json?: boolean | undefined;
+                output?: "stdout" | "stderr" | "auto" | undefined;
             }>;
             /** Collection of feature flags regarding legacy features and functionalities */
             legacy: z.ZodOptional<z.ZodObject<{
@@ -2149,6 +2165,8 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
             log: {
                 name: string;
                 level: LogLevel;
+                output: "stdout" | "stderr" | "auto";
+                json?: boolean | undefined;
             };
             legacy?: {
                 enableDefaultGetCachedDataOverride?: boolean | undefined;
@@ -2157,6 +2175,8 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
             log: {
                 name: string;
                 level: LogLevel;
+                json?: boolean | undefined;
+                output?: "stdout" | "stderr" | "auto" | undefined;
             };
             legacy?: {
                 enableDefaultGetCachedDataOverride?: boolean | undefined;
@@ -2167,6 +2187,8 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
             log: {
                 name: string;
                 level: LogLevel;
+                output: "stdout" | "stderr" | "auto";
+                json?: boolean | undefined;
             };
             legacy?: {
                 enableDefaultGetCachedDataOverride?: boolean | undefined;
@@ -2177,6 +2199,8 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
             log: {
                 name: string;
                 level: LogLevel;
+                json?: boolean | undefined;
+                output?: "stdout" | "stderr" | "auto" | undefined;
             };
             legacy?: {
                 enableDefaultGetCachedDataOverride?: boolean | undefined;
@@ -2351,6 +2375,8 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
             log: {
                 name: string;
                 level: LogLevel;
+                output: "stdout" | "stderr" | "auto";
+                json?: boolean | undefined;
             };
             legacy?: {
                 enableDefaultGetCachedDataOverride?: boolean | undefined;
@@ -2525,6 +2551,8 @@ export declare const RuntimeConfigSchema: z.ZodObject<{
             log: {
                 name: string;
                 level: LogLevel;
+                json?: boolean | undefined;
+                output?: "stdout" | "stderr" | "auto" | undefined;
             };
             legacy?: {
                 enableDefaultGetCachedDataOverride?: boolean | undefined;

package/dist/runtime/utils/zodSchema.js

@@ -145,7 +145,9 @@ const logLevel = z.enum(["debug", "info", "warn", "error"]);
 const PublicRuntimeConfigSchema = z.object({
   log: z.object({
     name: z.string(),
-    level: logLevel
+    level: logLevel,
+    json: z.boolean().optional(),
+    output: z.enum(["stdout", "stderr", "auto"]).default("auto")
   }),
   /** Collection of feature flags regarding legacy features and functionalities */
   legacy: z.object({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.18.0",
+  "version": "8.19.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -81,10 +81,10 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "0.6.0",
-    "@scayle/storefront-core": "8.18.0",
+    "@scayle/storefront-core": "8.19.0",
     "@scayle/unstorage-compression-driver": "^0.2.6",
     "@vercel/nft": "0.29.2",
-    "@vueuse/core": "13.0.0",
+    "@vueuse/core": "13.1.0",
     "consola": "^3.2.3",
     "core-js": "^3.37.1",
     "defu": "^6.1.4",