Vue Storefront is now Alokai! Learn More
@vue-storefront/magento-types

@vue-storefront/magento-types

4.0.1

Patch Changes

  • FIX Improve Magento route types with proper union types
  • Replaced generic RoutableInterface with a new Route union type that properly represents different route variants
  • Added specific types for CategoryInterfaceRoute, CategoryTreeRoute, CmsPageRoute, and ProductRoute with their respective properties
  • Updated the route API function to use the new Route type for better type safety and IntelliSense support
  • Each route type now includes proper __typename discrimination for better runtime type checking

4.0.0

Major Changes

FEATURE

  • placeOrder unified API method: Added placeOrder method to the unified API for Magento.

CHANGED

  • placeOrder response structure: The placeOrder method now returns detailed order information using the orderV2 field instead of the basic order field. Update your code to access order data from response.data.placeOrder.orderV2 instead of response.data.placeOrder.order
  • magento schema updated: Updated Magento GraphQL schema from 2.4.6 to 2.4.8, which may introduce new types and fields or modify existing ones.
  • magento-sdk: Is now using the middlewareModule from @alokai/connect/sdk and become a Proxy SDK module to align with recent architecture changes.

3.0.0

Major Changes

  • CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:

  • Upgraded to the latest version of Node.js 22
  • Updated CI pipelines to use Node.js 22 for consistency.
  • Updated .nvmrc or .node-version files to specify Node.js version 22.14.
  • Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.

Recommendations:

  • Use Node.js version 22.14.0 or higher for optimal performance, security, and compatibility.
  • While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested.

3.0.0-rc.0

Major Changes

  • CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:

  • Upgraded to the latest version of Node.js 22
  • Updated CI pipelines to use Node.js 22 for consistency.
  • Updated .nvmrc or .node-version files to specify Node.js version 22.14.
  • Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.

Recommendations:

  • Use Node.js version 22.14.0 or higher for optimal performance, security, and compatibility.
  • While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested.

2.0.0

Major Changes

  • e4709f9a: Changed minimum Node version from 16 to 18. The condition that was forcing the Node version to be lower than 19 is also removed.

1.2.0

Minor Changes

  • 8b2a0c35: ADDED categories endpoint definition.

1.1.0

Minor Changes

  • 7ce4f9ed: CHANGED Enhanced default GQL queries
    • CategorySearchQuery new fields:
      • url_key - The url key assigned to the category.
      • children - Child categories tree.
        • include_in_menu
        • is_anchor
        • level
        • name
        • position
        • product_count
        • uid
        • url_key
        • url_path
        • url_suffix
    // get category `children` categories

const category = sdk.commerce.categorySearch();
const children = category.children;
    • CategoryListQuery new fields:
      • children.url_key - The url key assigned to the category.
    // get `url_key` of category children

const categoryList = sdk.commerce.categoryList();

for (let categoryChildren of categoryList.children) {
  const url_key = categoryChildren.url_key;
}

    // get ConfigurableProduct `variants` products

const products = sdk.commerce.products();

for (let product of products) {
  if (product.__typename === "ConfigurableProduct") {
    const variants = products.variants;
  }
}

Patch Changes

1.0.2

Patch Changes

  • 045784a6: Fixes
    • Fixed getAvailablePaymentMethods type definition. Parameter cartId is now properly typed as string.

1.0.1

Patch Changes

  • #1456 e3f329ec Thanks @bartoszherba! - Fixed a Naming Issue in productDetails Method
    We've fixed a problem where the method name used to access product details was mistakenly written as "productDetail." It's now correctly named as "productDetails." This change ensures everything is clear and accurate in the code.