@swell/apps-sdk 1.0.141 → 1.0.143

package/dist/index.js

@@ -107,6 +107,97 @@
   // 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");
 
@@ -502,7 +593,7 @@
               return instance[prop];
             }
             instance._result = instance._get().catch((err) => {
-              console.log(err);
+              logger.error(err);
               return instance._getCollectionResultOrProp(instance, prop);
             });
           }
@@ -510,7 +601,7 @@
             return instance._result.then(() => {
               return instance._getCollectionResultOrProp(instance, prop);
             }).catch((err) => {
-              console.log(err);
+              logger.error(err);
               return null;
             });
           }
@@ -569,7 +660,7 @@
           }
           return result;
         }).catch((err) => {
-          console.log(err);
+          logger.error(err);
           return null;
         });
       }
@@ -747,7 +838,7 @@
           }
           return result;
         }).catch((err) => {
-          console.log(err);
+          logger.error(err);
           return null;
         });
       }
@@ -861,7 +952,7 @@
           }
           return result;
         }).catch((err) => {
-          console.log(err);
+          logger.error(err);
           return null;
         });
       }
@@ -895,15 +986,25 @@
     }
     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;
         });
       }
@@ -6987,6 +7088,7 @@
     ttl: DEFAULT_TTL
   });
   var NULL_VALUE = "__NULL__";
+  var SWR_PROMISE_MAP = /* @__PURE__ */ new Map();
   var Cache = class {
     client;
     workerCtx;
@@ -7008,19 +7110,31 @@
      * 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) {
@@ -7315,6 +7429,16 @@
   }
 
   // src/resources/product.ts
+  var SORT_OPTIONS = [
+    { value: "", name: "Featured" },
+    { value: "popularity", name: "Popularity", query: "popularity desc" },
+    { value: "price_asc", name: "Price, low to high", query: "price asc" },
+    { value: "price_desc", name: "Price, high to low", query: "price desc" },
+    { value: "date_asc", name: "Date, old to new", query: "date asc" },
+    { value: "date_desc", name: "Date, new to old", query: "date desc" },
+    { value: "name_asc", name: "Product name, A-Z", query: "name asc" },
+    { value: "name_desc", name: "Product name, Z-A", query: "name desc" }
+  ];
   function transformSwellProduct(params, product) {
     if (!product) {
       return product;
@@ -7351,6 +7475,28 @@
       return res;
     }
   };
+  function productQueryWithFilters(swell, query = {}) {
+    const sortBy = swell.queryParams.sort || "";
+    const filters2 = Object.entries(swell.queryParams).reduce(
+      (acc, [key, value]) => {
+        if (key.startsWith("filter_")) {
+          const qkey = key.replace("filter_", "");
+          if (value?.gte !== void 0 || value?.lte !== void 0) {
+            acc[qkey] = [value.gte || 0, value.lte || void 0];
+          } else {
+            acc[qkey] = value;
+          }
+        }
+        return acc;
+      },
+      {}
+    );
+    return {
+      sort: SORT_OPTIONS.find((option) => option.value === sortBy)?.query || void 0,
+      $filters: filters2,
+      ...query
+    };
+  }
 
   // src/api.ts
   var DEFAULT_API_HOST = "https://api.schema.io";
@@ -7395,8 +7541,12 @@
         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;
@@ -7406,7 +7556,9 @@
       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;
@@ -7520,7 +7672,7 @@
         if (err instanceof Error) {
           err.message = `Swell: unable to load settings (${err.message})`;
         }
-        console.error(err);
+        logger.error(err);
       }
       return this.storefront.settings.get();
     }
@@ -7603,7 +7755,9 @@
             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;
@@ -7633,7 +7787,7 @@
           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);
             }
           );
@@ -7657,7 +7811,7 @@
      */
     getResourceCache() {
       let cache = resourceCaches.get(this.instanceId);
-      if (!cache) {
+      if (cache === void 0) {
         cache = new ResourceCache({
           kvStore: this.workerEnv?.THEME,
           workerCtx: this.workerCtx
@@ -7671,7 +7825,7 @@
      */
     getRequestCache() {
       let cache = requestCaches.get(this.instanceId);
-      if (!cache) {
+      if (cache === void 0) {
         cache = new RequestCache({
           kvStore: this.workerEnv?.THEME,
           workerCtx: this.workerCtx
@@ -7724,6 +7878,11 @@
       }
       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;
@@ -7732,6 +7891,10 @@
       } 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,
@@ -14774,9 +14937,11 @@ ${formattedMessage}`;
     if (category instanceof StorefrontResource) {
       category = cloneStorefrontResource(category);
     }
+    const productMapper = (product) => ShopifyProduct(instance, product);
     const resolveProducts = makeProductsCollectionResolve(
+      instance,
       category,
-      (product) => ShopifyProduct(instance, product)
+      productMapper
     );
     return new ShopifyResource({
       all_products_count: defer(
@@ -14828,8 +14993,9 @@ ${formattedMessage}`;
         category,
         (category2) => getFirstImage(instance, category2)
       ),
-      filters: defer(
-        async () => ((await resolveProducts())?.filter_options ?? []).map(
+      filters: deferWith(
+        category,
+        (category2) => (category2?.filter_options ?? []).map(
           (filter) => ShopifyFilter(instance, filter)
         )
       ),
@@ -14839,9 +15005,7 @@ ${formattedMessage}`;
       metafields: {},
       next_product: void 0,
       previous_product: void 0,
-      products: defer(async () => {
-        return (await resolveProducts())?.results ?? [];
-      }),
+      products: getProducts(instance, category, productMapper),
       products_count: defer(
         async () => (await resolveProducts())?.results?.length || 0
       ),
@@ -14880,28 +15044,35 @@ ${formattedMessage}`;
         return "manual";
     }
   }
-  function makeProductsCollectionResolve(object, mapper) {
-    const productResults = deferWith(object, (object2) => {
-      if (object2.products) {
-        if (object2.products instanceof SwellStorefrontCollection) {
-          return object2.products._cloneWithCompatibilityResult((products) => {
-            return {
-              ...products,
-              results: products.results.map(mapper)
-            };
-          });
+  function getProducts(instance, object, mapper) {
+    return deferWith(object, (object2) => {
+      const { page, limit: limit2 } = instance.swell.queryParams;
+      const categoryFilter = object2.id && object2.id !== "all" ? object2.id : void 0;
+      const productQuery = categoryFilter ? { category: categoryFilter, $variants: true } : { $variants: true };
+      const filterQuery = productQueryWithFilters(instance.swell, productQuery);
+      const products = new SwellStorefrontCollection(
+        instance.swell,
+        "products",
+        {
+          page,
+          limit: limit2,
+          ...filterQuery
+        },
+        async function() {
+          return this._defaultGetter().call(this);
         }
-        if (Array.isArray(object2.products?.results)) {
-          return {
-            ...object2.products,
-            results: object2.products.results.map(mapper)
-          };
+      );
+      return products._cloneWithCompatibilityResult(
+        (products2) => {
+          return { ...products2, results: products2.results.map(mapper) };
         }
-      }
-      return null;
+      );
     });
+  }
+  function makeProductsCollectionResolve(instance, object, mapper) {
+    const products = getProducts(instance, object, mapper);
     async function resolveProducts() {
-      const resolved = await productResults.resolve();
+      const resolved = await products.resolve();
       if (resolved && "_resolve" in resolved) {
         return resolved._resolve();
       }
@@ -15665,11 +15836,15 @@ ${formattedMessage}`;
     if (search instanceof ShopifyResource) {
       return search.clone();
     }
-    const resolveProducts = makeProductsCollectionResolve(search, (product) => {
-      const shopifyProduct = ShopifyProduct(instance, product);
-      shopifyProduct.object_type = "product";
-      return shopifyProduct;
-    });
+    const resolveProducts = makeProductsCollectionResolve(
+      instance,
+      search,
+      (product) => {
+        const shopifyProduct = ShopifyProduct(instance, product);
+        shopifyProduct.object_type = "product";
+        return shopifyProduct;
+      }
+    );
     return new ShopifyResource({
       default_sort_by: deferWith(
         search,
@@ -19148,9 +19323,14 @@ ${injects.join("\n")}<\/script>`;
     }
     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,
@@ -19177,6 +19357,7 @@ ${injects.join("\n")}<\/script>`;
       if (this.shopifyCompatibility) {
         this.shopifyCompatibility.adaptQueryParams();
       }
+      logger.debug("[SDK] Theme init end", { page: pageId, trace });
     }
     setGlobals(globals) {
       if (this.shopifyCompatibility) {
@@ -19209,7 +19390,7 @@ ${injects.join("\n")}<\/script>`;
               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;
@@ -19296,7 +19477,7 @@ ${injects.join("\n")}<\/script>`;
             templateConfig?.file_data || "{}"
           );
         } catch (err) {
-          console.warn(err);
+          logger.warn(err);
         }
         if (pageSchema?.page) {
           const {
@@ -19601,7 +19782,7 @@ ${injects.join("\n")}<\/script>`;
         try {
           return import_json56.default.parse(localeConfig?.file_data || "{}");
         } catch (err) {
-          console.warn(err);
+          logger.warn(err);
         }
       }
       return {};
@@ -19770,10 +19951,20 @@ ${injects.join("\n")}<\/script>`;
         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} -->`;
       }
     }
@@ -19781,7 +19972,7 @@ ${injects.join("\n")}<\/script>`;
       try {
         return await this.liquidSwell.parseAndRender(templateString, data);
       } catch (err) {
-        console.error(err);
+        logger.error(err);
         return "";
       }
     }
@@ -19805,7 +19996,7 @@ ${injects.join("\n")}<\/script>`;
             );
           }
         } catch (err) {
-          console.warn(err);
+          logger.warn(err);
           return void 0;
         }
       } else if (config?.file_path?.endsWith(".liquid")) {
@@ -19858,11 +20049,10 @@ ${injects.join("\n")}<\/script>`;
         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);
         }
       }
@@ -20119,7 +20309,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;
@@ -20509,7 +20699,7 @@ ${this.shopifyCompatibility.getContentForHeader()}`;
     try {
       return import_json56.default.parse(config?.file_data || "{}");
     } catch (err) {
-      console.warn(err);
+      logger.warn(err);
       return {};
     }
   }