Skip to main content

V7 Migration

This document outlines the changes introduced in recent versions of the Gesso packages. Please review these changes carefully and update your code accordingly.

Major Changes (Breaking Changes)​

These changes require code modifications to ensure continued functionality.

@acromedia/gesso-core​

  • Brand Type: Removed isSelected and productCount properties. Update your code to no longer rely on these properties.
  • FacetType Type: Removed BrandSearchFilter, ProductAttributeSearchFilter, ProductPriceFilter, and CategorySearchFilter. Use subFacets for filtering.
  • Facet Type: Removed attributes and brands properties. Use subFacets instead.
  • Removed Attribute Interface: If you were using this interface directly, update your code to use the new subFacets approach.

@acromedia/gesso-bigcommerce​

  • subFacets: Replaced entityId with id. Update your code to use the id property.
  • subFacets: Removed type property. Pass tags as an argument to useProductSearch and useFacet instead.

@acromedia/gesso-cms​

  • Content Type: Replaced Content[] with ContentSearchResult. Update your code to handle the new return type of getContentSearch.
  • getContentSearch: Now always returns a ContentSearchResult.

@acromedia/gesso-drupal-commerce & @acromedia/gesso-commerce & @acromedia/gesso-next​

  • useCustomer: Removed the generic update function. Use the following more specific functions instead:
    • updateName
    • updateEmail
    • updatePassword
    • addAddress
    • updateAddress
    • updatePrimaryAddress
    • deleteAddress

@acromedia/gesso-commerce​

  • Next.js App Router Feature Flag: Removed the feature flag for opting into the Next.js App Router. If you were relying on this flag, you'll need to adjust your application to work with the App Router directly.

@acromedia/gesso-erp​

  • UseAccountPlugin: No longer accepts id or accountOptions. Update your code to remove these parameters.
  • UseAccount: No longer accepts accountOptions. Update your code to remove this parameter.
  • GetAccount: No longer accepts accountOptions. Update your code to remove this parameter.

@acromedia/gesso-shopify & @acromedia/gesso-shopify-middleware​

  • Deprecated Shopify API Attributes: Removed deprecated Shopify API attributes. Refer to the Shopify API documentation for the latest attribute names and usage.

@acromedia/gesso-drupal​

  • Field Naming: Removed support for old field naming that did not include _gesso_. Ensure all your field names include the _gesso_ suffix.
  • Regression Testing: Removed regression testing for old field names.

@acromedia/gesso​

This package aggregates changes from other Gesso packages. Refer to the individual package changelogs for details. Specifically, this includes changes for @acromedia/gesso-core, @acromedia/gesso-bigcommerce, @acromedia/gesso-cms, @acromedia/gesso-drupal-commerce, @acromedia/gesso-shopify, @acromedia/gesso-commerce, and @acromedia/gesso-next.

Patch Changes​

These changes are backwards compatible and should not require code modifications, but it's always good to be aware of them.

All Packages (axios update)​

  • Updated axios dependency. This is a patch update and should not introduce breaking changes. However, it's always recommended to test your application after any dependency update.

General Guidance​

  • Thorough Testing: After making these changes, thoroughly test your application to ensure everything works as expected.
  • Package Updates: Ensure all your Gesso packages are updated to the latest versions.
  • Refer to Documentation: Consult the individual package documentation for more detailed information on specific changes.

This migration guide should help you update your code to be compatible with the latest Gesso releases. If you encounter any issues, please don't hesitate to reach out for support.