@swell/apps-sdk 1.0.141 → 1.0.142

package/dist/index.cjs

@@ -90,6 +90,7 @@ __export(index_exports, {
   adaptShopifyMenuData: () => adaptShopifyMenuData,
   arrayToObject: () => arrayToObject,
   cloneStorefrontResource: () => cloneStorefrontResource,
+  configureSdkLogger: () => configureSdkLogger,
   deferMenuItemUrlAndResource: () => deferMenuItemUrlAndResource,
   dehydrateSwellRefsInStorefrontResources: () => dehydrateSwellRefsInStorefrontResources,
   extractSettingsFromForm: () => extractSettingsFromForm,
@@ -213,6 +214,97 @@ var import_json52 = __toESM(require("json5"), 1);
 // src/resources.ts
 var import_lodash_es2 = require("lodash-es");
 
+// src/utils/logger.ts
+var logLevels = {
+  error: 0,
+  warn: 1,
+  info: 2,
+  debug: 3
+};
+var currentLogLevel = "warn";
+var currentTimestampFormat = "off";
+var isStructured = false;
+function configureSdkLogger(config = {}) {
+  if (config.level && logLevels[config.level] !== void 0) {
+    currentLogLevel = config.level;
+  }
+  if (config.timestamp) {
+    currentTimestampFormat = config.timestamp;
+  }
+  if (typeof config.structured === "boolean") {
+    isStructured = config.structured;
+  }
+}
+function getTimestamp() {
+  if (currentTimestampFormat === "iso") {
+    return (/* @__PURE__ */ new Date()).toISOString();
+  }
+  if (currentTimestampFormat === "unix") {
+    return Date.now();
+  }
+  return void 0;
+}
+function formatArgs(args) {
+  const timestamp = getTimestamp();
+  if (!isStructured) {
+    return timestamp !== void 0 ? [...args, `(${timestamp})`] : args;
+  }
+  let message = "";
+  let context = {};
+  const messageParts = [];
+  for (const arg of args) {
+    if (arg instanceof Error) {
+      context.error = {
+        name: arg.name,
+        message: arg.message,
+        stack: arg.stack
+      };
+    } else if (typeof arg === "object" && arg !== null && !Array.isArray(arg) && Object.getPrototypeOf(arg) === Object.prototype) {
+      Object.assign(context, arg);
+    } else {
+      messageParts.push(arg);
+    }
+  }
+  message = messageParts.map((part) => typeof part === "object" ? JSON.stringify(part) : part).join(" ");
+  const finalLogObject = {
+    message,
+    ...context,
+    ...timestamp && { timestamp }
+  };
+  return [finalLogObject];
+}
+var logger = {
+  error: (...args) => {
+    console.error(...formatArgs(args));
+  },
+  warn: (...args) => {
+    if (logLevels[currentLogLevel] >= logLevels.warn) {
+      console.warn(...formatArgs(args));
+    }
+  },
+  info: (...args) => {
+    if (logLevels[currentLogLevel] >= logLevels.info) {
+      console.info(...formatArgs(args));
+    }
+  },
+  debug: (...args) => {
+    if (logLevels[currentLogLevel] >= logLevels.debug) {
+      console.debug(...formatArgs(args));
+    }
+  }
+};
+function createTraceId(data) {
+  if (data === void 0) {
+    return Math.random().toString(36).substring(2, 10);
+  }
+  let hash = 5381;
+  for (let i = 0; i < data.length; i++) {
+    const char = data.charCodeAt(i);
+    hash = (hash << 5) + hash + char;
+  }
+  return (hash >>> 0).toString(16);
+}
+
 // src/liquid/utils.ts
 var import_liquidjs = require("liquidjs");
 
@@ -608,7 +700,7 @@ var StorefrontResource = class {
             return instance[prop];
           }
           instance._result = instance._get().catch((err) => {
-            console.log(err);
+            logger.error(err);
             return instance._getCollectionResultOrProp(instance, prop);
           });
         }
@@ -616,7 +708,7 @@ var StorefrontResource = class {
           return instance._result.then(() => {
             return instance._getCollectionResultOrProp(instance, prop);
           }).catch((err) => {
-            console.log(err);
+            logger.error(err);
             return null;
           });
         }
@@ -675,7 +767,7 @@ var StorefrontResource = class {
         }
         return result;
       }).catch((err) => {
-        console.log(err);
+        logger.error(err);
         return null;
       });
     }
@@ -853,7 +945,7 @@ var SwellStorefrontCollection = class _SwellStorefrontCollection extends SwellSt
         }
         return result;
       }).catch((err) => {
-        console.log(err);
+        logger.error(err);
         return null;
       });
     }
@@ -967,7 +1059,7 @@ var SwellStorefrontRecord = class extends SwellStorefrontResource {
         }
         return result;
       }).catch((err) => {
-        console.log(err);
+        logger.error(err);
         return null;
       });
     }
@@ -1001,15 +1093,25 @@ var SwellStorefrontSingleton = class extends SwellStorefrontResource {
   }
   async _get() {
     if (this._getter) {
+      const trace = createTraceId();
+      logger.debug("[SDK] Resource fetch start", {
+        resource: this.constructor.name,
+        hash: this._getterHash,
+        trace
+      });
       const getter = this._getter.bind(this);
       this._result = Promise.resolve().then(getter).then((result) => {
+        logger.debug("[SDK] Resource fetch end", {
+          hash: this._getterHash,
+          trace
+        });
         this._result = result;
         if (result) {
           Object.assign(this, result);
         }
         return result;
       }).catch((err) => {
-        console.log(err);
+        logger.error(err, { trace });
         return null;
       });
     }
@@ -7093,6 +7195,7 @@ var DEFAULT_OPTIONS = Object.freeze({
   ttl: DEFAULT_TTL
 });
 var NULL_VALUE = "__NULL__";
+var SWR_PROMISE_MAP = /* @__PURE__ */ new Map();
 var Cache = class {
   client;
   workerCtx;
@@ -7114,19 +7217,31 @@ var Cache = class {
    * This will always return the cached value immediately if exists
    */
   async fetchSWR(key, fetchFn, ttl = DEFAULT_SWR_TTL) {
+    const trace = createTraceId();
+    logger.debug("[SDK] Cache fetch start", { key, trace });
     const cacheValue = await this.client.get(key);
-    const promiseValue = Promise.resolve().then(fetchFn).then(resolveAsyncResources).then(async (value) => {
-      const isNull = value === null || value === void 0;
-      await this.client.set(key, isNull ? NULL_VALUE : value, ttl);
-      return value;
-    });
-    if (this.workerCtx?.waitUntil) {
-      this.workerCtx.waitUntil(promiseValue);
+    let promise = SWR_PROMISE_MAP.get(key);
+    if (promise === void 0) {
+      promise = Promise.resolve().then(fetchFn).then(resolveAsyncResources).then(async (value) => {
+        const isNull = value === null || value === void 0;
+        await this.client.set(key, isNull ? NULL_VALUE : value, ttl);
+        logger.debug("[SDK] Cache update done", { key, trace });
+        return value;
+      }).finally(() => {
+        SWR_PROMISE_MAP.delete(key);
+      });
+      SWR_PROMISE_MAP.set(key, promise);
+    }
+    if (typeof this.workerCtx?.waitUntil === "function") {
+      this.workerCtx.waitUntil(promise);
     }
     if (cacheValue !== void 0) {
+      logger.debug("[SDK] Cache check done", { status: "HIT", key, trace });
       return cacheValue === NULL_VALUE ? null : cacheValue;
     }
-    const result = await promiseValue;
+    logger.debug("[SDK] Cache check done", { status: "MISS", key, trace });
+    const result = await promise;
+    logger.debug("[SDK] Cache fetch end", { key, trace });
     return result;
   }
   async get(key) {
@@ -7501,8 +7616,12 @@ var Swell = class _Swell {
       queryParams,
       workerEnv,
       workerCtx,
+      logger: loggerConfig,
       ...clientProps
     } = params;
+    if (loggerConfig) {
+      configureSdkLogger(loggerConfig);
+    }
     this.url = url instanceof URL ? url : new URL(url || "");
     this.config = config;
     this.shopifyCompatibilityConfig = shopifyCompatibilityConfig;
@@ -7512,7 +7631,9 @@ var Swell = class _Swell {
     this.workerCtx = workerCtx;
     this.workerEnv = workerEnv;
     this.resourceLoadingIndicator = params.resourceLoadingIndicator;
-    console.log(`KV cache: ${this.workerEnv?.THEME ? "enabled" : "disabled"}`);
+    logger.info(
+      `[SDK] KV cache: ${this.workerEnv?.THEME ? "enabled" : "disabled"}`
+    );
     if (serverHeaders) {
       const { headers: headers2, swellHeaders: swellHeaders2 } = _Swell.formatHeaders(serverHeaders);
       this.headers = headers2;
@@ -7626,7 +7747,7 @@ var Swell = class _Swell {
       if (err instanceof Error) {
         err.message = `Swell: unable to load settings (${err.message})`;
       }
-      console.error(err);
+      logger.error(err);
     }
     return this.storefront.settings.get();
   }
@@ -7709,7 +7830,9 @@ var Swell = class _Swell {
           decodeURIComponent(this.swellHeaders["storefront-context"])
         );
       } catch (error) {
-        console.error("Failed to parse swell-storefront-context. Ignoring...");
+        logger.error(
+          "[SDK] Failed to parse swell-storefront-context. Ignoring..."
+        );
       }
     }
     return storefrontContext;
@@ -7739,7 +7862,7 @@ var Swell = class _Swell {
         return this.getRequestCache().fetchSWR(
           getCacheKey("request", [this.instanceId, method, url, id, data, opt]),
           () => {
-            console.log("Storefront request", { method, url, id, data });
+            logger.info("[SDK] Storefront request", { method, url, id, data });
             return storefrontRequest(method, url, id, data, opt);
           }
         );
@@ -7763,7 +7886,7 @@ var Swell = class _Swell {
    */
   getResourceCache() {
     let cache = resourceCaches.get(this.instanceId);
-    if (!cache) {
+    if (cache === void 0) {
       cache = new ResourceCache({
         kvStore: this.workerEnv?.THEME,
         workerCtx: this.workerCtx
@@ -7777,7 +7900,7 @@ var Swell = class _Swell {
    */
   getRequestCache() {
     let cache = requestCaches.get(this.instanceId);
-    if (!cache) {
+    if (cache === void 0) {
       cache = new RequestCache({
         kvStore: this.workerEnv?.THEME,
         workerCtx: this.workerCtx
@@ -7830,6 +7953,11 @@ var SwellBackendAPI = class {
     }
     const endpointUrl = String(url).startsWith("/") ? url.substring(1) : url;
     const requestUrl = `${this.apiHost}/${endpointUrl}${query}`;
+    const trace = createTraceId();
+    logger.debug("[SDK] Backend request start", {
+      query: `/${endpointUrl}${query}`,
+      trace
+    });
     const response = await fetch(requestUrl, requestOptions);
     const responseText = await response.text();
     let result;
@@ -7838,6 +7966,10 @@ var SwellBackendAPI = class {
     } catch {
       result = String(responseText || "").trim();
     }
+    logger.debug("[SDK] Backend request end", {
+      status: response.status,
+      trace
+    });
     if (response.status > 299) {
       throw new SwellError(result, {
         status: response.status,
@@ -19254,9 +19386,14 @@ var SwellTheme3 = class {
   }
   async initGlobals(pageId, altTemplate) {
     this.pageId = pageId;
+    const trace = createTraceId();
+    logger.debug("[SDK] Theme init start", { page: pageId, trace });
     await this.themeLoader.init(this.themeConfigs || void 0);
+    logger.debug("[SDK] ThemeLoader init done", { page: pageId, trace });
     const { store, session, menus, geo, configs } = await this.getSettingsAndConfigs();
+    logger.debug("[SDK] Theme settings load done", { page: pageId, trace });
     const { settings, request, page, cart, account, customer } = await this.resolvePageData(store, configs, pageId, altTemplate);
+    logger.debug("[SDK] Theme page data load done", { page: pageId, trace });
     this.page = page;
     const globals = {
       ...this.globalData,
@@ -19283,6 +19420,7 @@ var SwellTheme3 = class {
     if (this.shopifyCompatibility) {
       this.shopifyCompatibility.adaptQueryParams();
     }
+    logger.debug("[SDK] Theme init end", { page: pageId, trace });
   }
   setGlobals(globals) {
     if (this.shopifyCompatibility) {
@@ -19315,7 +19453,7 @@ var SwellTheme3 = class {
             try {
               configValue = import_json56.default.parse(config.file_data);
             } catch (err) {
-              console.error(`Error parsing ${configName} config: ${err}`);
+              logger.error(`Error parsing config`, err, { configName });
               configValue = {};
             }
             acc[configName] = configValue;
@@ -19402,7 +19540,7 @@ var SwellTheme3 = class {
           templateConfig?.file_data || "{}"
         );
       } catch (err) {
-        console.warn(err);
+        logger.warn(err);
       }
       if (pageSchema?.page) {
         const {
@@ -19707,7 +19845,7 @@ var SwellTheme3 = class {
       try {
         return import_json56.default.parse(localeConfig?.file_data || "{}");
       } catch (err) {
-        console.warn(err);
+        logger.warn(err);
       }
     }
     return {};
@@ -19876,10 +20014,20 @@ var SwellTheme3 = class {
       return "";
     }
     template = unescapeLiquidSyntax(template);
+    const trace = createTraceId();
     try {
-      return await this.liquidSwell.parseAndRender(template, data);
+      logger.debug("[SDK] Render template start", {
+        config: config.name,
+        trace
+      });
+      const result = await this.liquidSwell.parseAndRender(template, data);
+      logger.debug("[SDK] Render template end", {
+        config: config.name,
+        trace
+      });
+      return result;
     } catch (err) {
-      console.error(err);
+      logger.error(err);
       return `<!-- template render error: ${err.message} -->`;
     }
   }
@@ -19887,7 +20035,7 @@ var SwellTheme3 = class {
     try {
       return await this.liquidSwell.parseAndRender(templateString, data);
     } catch (err) {
-      console.error(err);
+      logger.error(err);
       return "";
     }
   }
@@ -19911,7 +20059,7 @@ var SwellTheme3 = class {
           );
         }
       } catch (err) {
-        console.warn(err);
+        logger.warn(err);
         return void 0;
       }
     } else if (config?.file_path?.endsWith(".liquid")) {
@@ -19964,11 +20112,10 @@ var SwellTheme3 = class {
       try {
         return import_json56.default.parse(content);
       } catch (err) {
-        console.log(
-          "Unable to render theme template",
-          config.file_path,
+        logger.error("[SDK] Unable to render theme template", {
+          file: config.file_path,
           content
-        );
+        });
         throw new PageError(err);
       }
     }
@@ -20225,7 +20372,7 @@ ${this.shopifyCompatibility.getContentForHeader()}`;
       try {
         schema = import_json56.default.parse(resolvedConfig?.file_data) || void 0;
       } catch (err) {
-        console.warn(err);
+        logger.warn(err);
       }
     }
     return schema;
@@ -20615,7 +20762,7 @@ function parseJsonConfig(config) {
   try {
     return import_json56.default.parse(config?.file_data || "{}");
   } catch (err) {
-    console.warn(err);
+    logger.warn(err);
     return {};
   }
 }
@@ -21092,6 +21239,7 @@ function getResourceQuery(slug, query) {
   adaptShopifyMenuData,
   arrayToObject,
   cloneStorefrontResource,
+  configureSdkLogger,
   deferMenuItemUrlAndResource,
   dehydrateSwellRefsInStorefrontResources,
   extractSettingsFromForm,