@swell/apps-sdk 1.0.143 → 1.0.145

package/README.md

@@ -138,7 +138,7 @@ class Swell {
   post<T>(url: string, data: SwellData): Promise<T>;
   put<T>(url: string, data: SwellData): Promise<T>;
   delete<T>(url: string, data?: SwellData): Promise<T>;
-  getCachedResource<T>(key: string, args: unknown[], handler: () => T): Promise<T>;
+  getCachedResource<T>(key: string, args: unknown[], handler: () => T, isCacheble = true): Promise<T>;
 }
 ```
 

package/dist/index.cjs

@@ -649,6 +649,12 @@ async function forEachKeyDeep(obj, fn) {
 }
 
 // src/resources.ts
+var NOT_CACHEBLE_COLLECTIONS = Object.freeze(
+  /* @__PURE__ */ new Set(["accounts:addresses", "accounts:orders", "accounts:subscriptions"])
+);
+function isResourceCacheble(name) {
+  return !NOT_CACHEBLE_COLLECTIONS.has(name);
+}
 var MAX_QUERY_PAGE_LIMIT = 100;
 var DEFAULT_QUERY_PAGE_LIMIT = 15;
 var StorefrontResource = class {
@@ -935,7 +941,8 @@ var SwellStorefrontCollection = class _SwellStorefrontCollection extends SwellSt
           this._swell.queryParams,
           this._getterHash
         ],
-        getter
+        getter,
+        isResourceCacheble(this._collection)
       ).then((result) => {
         this._result = result;
         if (result) {
@@ -1049,7 +1056,8 @@ var SwellStorefrontRecord = class extends SwellStorefrontResource {
           this._swell.queryParams,
           this._getterHash
         ],
-        getter
+        getter,
+        isResourceCacheble(this._collection)
       ).then((result) => {
         return this._transformResult(result);
       }).then((result) => {
@@ -7216,16 +7224,18 @@ var Cache = class {
    *
    * This will always return the cached value immediately if exists
    */
-  async fetchSWR(key, fetchFn, ttl = DEFAULT_SWR_TTL) {
+  async fetchSWR(key, fetchFn, ttl = DEFAULT_SWR_TTL, isCacheble = true) {
     const trace = createTraceId();
     logger.debug("[SDK] Cache fetch start", { key, trace });
-    const cacheValue = await this.client.get(key);
+    const cacheValue = isCacheble ? await this.client.get(key) : void 0;
     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 });
+        if (isCacheble) {
+          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);
@@ -7376,9 +7386,25 @@ var SwellPage = class extends SwellStorefrontRecord {
 };
 
 // src/resources/product_helpers.ts
+function isGiftcard(product) {
+  return product.type === "giftcard";
+}
+function isOptionAvailable(product, option) {
+  if (isGiftcard(product)) {
+    return true;
+  }
+  return Boolean(option.active && option.name);
+}
+function isProductAvailable(product, variant) {
+  if (product.stock_purchasable) {
+    return true;
+  }
+  const stockStatus = (variant || product).stock_status;
+  return !stockStatus || stockStatus === "in_stock";
+}
 function getAvailableVariants(product) {
   return (product.variants?.results?.slice()?.reverse() || []).filter(
-    (variant) => variant.stock_status === "in_stock" || !variant.stock_status
+    (variant) => isProductAvailable(product, variant)
   );
 }
 function isOptionValueAvailable(option, value, product, availableVariants) {
@@ -7445,7 +7471,7 @@ function getSelectedVariantOptionValues(product, queryParams, variant) {
       return acc;
     }
     const hasOptionValues = option.values.length > 0;
-    if (!option.active || !hasOptionValues) {
+    if (!isOptionAvailable(product, option) || !hasOptionValues) {
       return acc;
     }
     const value = option.values.find(
@@ -7731,9 +7757,14 @@ var Swell = class _Swell {
    * Fetches a resource.
    * First attempts to fetch from cache.
    */
-  async getCachedResource(key, args, handler) {
+  async getCachedResource(key, args, handler, isCacheble = true) {
     const cacheKey = getCacheKey(key, [this.instanceId, args]);
-    return this.getResourceCache().fetchSWR(cacheKey, handler);
+    return this.getResourceCache().fetchSWR(
+      cacheKey,
+      handler,
+      void 0,
+      isCacheble
+    );
   }
   async getAppSettings() {
     const settings = await this.get(
@@ -7745,15 +7776,16 @@ var Swell = class _Swell {
     return settings || {};
   }
   async getStorefrontSettings(force = false) {
+    const storefrontSettings = this.storefront.settings;
     try {
-      const { settings, menus, payments, subscriptions, session } = await this.storefront.request(
+      const allSettings = await this.storefront.request(
         "get",
         "/settings/all",
         void 0,
         force ? { $cache: false } : void 0,
         { force }
       );
-      const storefrontSettings = this.storefront.settings;
+      const { settings, menus, payments, subscriptions, session } = allSettings;
       storefrontSettings.localizedState = {};
       storefrontSettings.set({
         value: settings
@@ -7781,7 +7813,7 @@ var Swell = class _Swell {
       }
       logger.error(err);
     }
-    return this.storefront.settings.get();
+    return storefrontSettings;
   }
   getStorefrontMenus() {
     const menus = this.storefront.settings.getState(
@@ -14257,8 +14289,8 @@ function ShopifyVariant(instance, variant, productIn, depth = 0) {
   return new ShopifyResource({
     ...swellVariant,
     available: deferWith(
-      variant,
-      (variant2) => Boolean(variant2.stock_status === "in_stock" || !variant2.stock_status)
+      [product, variant],
+      (product2, variant2) => isProductAvailable(product2, variant2)
     ),
     barcode: void 0,
     compare_at_price: defer(() => variant.orig_price),
@@ -14347,7 +14379,7 @@ function ShopifyVariant(instance, variant, productIn, depth = 0) {
     requires_selling_plan: false,
     requires_shipping: deferWith(
       product,
-      (product2) => Boolean(product2.delivery?.contains("shipment"))
+      (product2) => Boolean(product2.delivery?.includes("shipment"))
     ),
     selected: false,
     selected_selling_plan_allocation: void 0,
@@ -14416,7 +14448,7 @@ function ShopifyProduct(instance, product, depth = 0) {
   return new ShopifyResource({
     available: deferWith(
       product,
-      (product2) => product2.stock_status === "in_stock" || !product2.stock_status
+      (product2) => isProductAvailable(product2)
     ),
     collections: [],
     // TODO: need to support this in the resource class somehow
@@ -14441,7 +14473,7 @@ function ShopifyProduct(instance, product, depth = 0) {
       const variant = getSelectedVariant(product2, {});
       return variant ? ShopifyVariant(instance, variant, product2, depth + 1) : void 0;
     }),
-    "gift_card?": deferWith(product, (product2) => product2.type === "giftcard"),
+    "gift_card?": deferWith(product, isGiftcard),
     handle: defer(() => product.slug),
     // indicates that product has any options
     has_only_default_variant: deferWith(
@@ -14473,7 +14505,9 @@ function ShopifyProduct(instance, product, depth = 0) {
       if (!Array.isArray(product2.options)) {
         return [];
       }
-      return product2.options.filter((option) => option.active && option.name).map((option) => option.name);
+      return product2.options.filter(
+        (option) => isOptionAvailable(product2, option)
+      ).map((option) => option.name);
     }),
     options_by_name: deferWith(product, (product2) => {
       if (!Array.isArray(product2.options)) {
@@ -14484,7 +14518,7 @@ function ShopifyProduct(instance, product, depth = 0) {
       const variant = getSelectedVariant(product2, queryParams);
       return product2.options.reduce(
         (acc, option, index) => {
-          if (!option.active || !option.name) {
+          if (!isOptionAvailable(product2, option)) {
             return acc;
           }
           acc[option.name.toLowerCase()] = getOption(
@@ -14510,7 +14544,7 @@ function ShopifyProduct(instance, product, depth = 0) {
         const { queryParams } = instance.swell;
         const variants = getAvailableVariants(product2);
         const variant = getSelectedVariant(product2, queryParams);
-        return product2.options.filter((option) => option.active && option.name).map(
+        return product2.options.filter((option) => isOptionAvailable(product2, option)).map(
           (option, index) => getOption(
             option,
             index,
@@ -14683,7 +14717,7 @@ function ShopifyLineItem(instance, item, cart, options = {}) {
       : undefined, */
     fulfillment_service: "manual",
     // TODO
-    gift_card: item.delivery === "giftcard",
+    gift_card: isGiftcard(item.product),
     grams: item.shipment_weight,
     id: item.id,
     image: deferWith(
@@ -15213,6 +15247,9 @@ function ShopifyAddress(instance, address, account) {
   if (address instanceof StorefrontResource) {
     address = cloneStorefrontResource(address);
   }
+  if (!address) {
+    address = {};
+  }
   return new ShopifyResource({
     address1: defer(() => address.address1),
     address2: defer(() => address.address2),
@@ -16687,6 +16724,10 @@ ${injects.join("\n")}</script>`;
             pageId = "account/order";
             urlParams.id = segment3;
             break;
+          case "subscriptions":
+            pageId = "account/subscription";
+            urlParams.id = segment3;
+            break;
           case "register":
             pageId = "account/login";
             break;
@@ -19434,14 +19475,15 @@ var SwellTheme3 = class {
     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();
+    const { store, session, menus, geo, configs, storefrontSettings } = 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,
-      store,
+      // return all storefront settings in the store
+      store: { ...storefrontSettings, ...store },
       settings,
       session,
       request,
@@ -19507,7 +19549,10 @@ var SwellTheme3 = class {
         {}
       )
     };
-    const session = await this.swell.storefront.settings.session();
+    const [session, storeSettings] = await Promise.all([
+      storefrontSettings.session(),
+      storefrontSettings.get()
+    ]);
     if (configs.translations) {
       configs.language = configs.translations;
     }
@@ -19520,11 +19565,13 @@ var SwellTheme3 = class {
     await this.setCompatibilityConfigs(configs);
     const menus = await this.resolveMenuSettings();
     return {
-      store: storefrontSettings?.store,
+      store: storeSettings?.store,
       session,
       menus,
       geo,
-      configs
+      configs,
+      // all settings
+      storefrontSettings
     };
   }
   async resolvePageData(store, configs, pageId, altTemplate) {
@@ -19613,7 +19660,8 @@ var SwellTheme3 = class {
       this.fetchSingletonResourceCached(
         "account",
         () => this.fetchAccount(),
-        () => null
+        () => null,
+        false
       )
     ]);
     if (!cart) {
@@ -19633,7 +19681,7 @@ var SwellTheme3 = class {
       // Shopify only
     };
   }
-  async fetchSingletonResourceCached(key, handler, defaultValue) {
+  async fetchSingletonResourceCached(key, handler, defaultValue, isCacheble = true) {
     const cacheKey = this.swell.storefront.session.getCookie();
     if (!cacheKey) {
       return defaultValue();
@@ -19641,7 +19689,8 @@ var SwellTheme3 = class {
     const result = await this.swell.getCachedResource(
       `${key}-${cacheKey}`,
       [],
-      handler
+      handler,
+      isCacheble
     );
     return result ?? defaultValue();
   }
@@ -21172,6 +21221,7 @@ function createStorefrontRecord(resource, swell, path, parent_slug, parent_query
 }
 function createCollection(resource, swell, path, parent_slug, parent_query) {
   const query = getResourceQuery(parent_slug, parent_query);
+  query.$resource_path = path;
   return new SwellStorefrontCollection(
     swell,
     resource,