CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format base on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

[1.0-rc.3] - 2020.04.28

Added

• Add Product.breadcrumbsand Category.breadcrumbs - @gibkigonzo (#71)

Fixed

• fix semver for packages, add uniq names for docker containers, remove vips partial install in Dockerfile - @gibkigonzo (#65)
• added missing parramenter to error handler for invalid requests - @gibkigonzo (#66)
• added "useWorkspaces" to the lerna config - @resubaka (#73)

[1.0-rc.2] - 2020.04.10

Added

• Create attribute service that allows to fetch attributes with specific options - used for products aggregates - @gibkigonzo (vuestorefront/vue-storefront#4001, vuestorefront/mage2vuestorefront#99)
• Add resetPasswordUsingResetToken to magento1 platform - @cewald (#415)
• Fix MSI default stock id value - @Inicorena (#417)
• Add product processor to new URL mapper endpoint #401 - @cewald (#401, #403)
• Add ElasticSearch client support for HTTP authentication - @cewald (#397)
• Support for save_in_addressbook added - @lucasqm (#394)
• Magento2 / Create password endpoint - @fifciu (#366)
• API and Platform comments for all the REST endpoints added with the links to the official docs - @pkarw
• Added global logger which you can change the instance of to use every logger you want to use - @resubaka (#24)
• Added better typescript annotation/new types - @resubaka (#24)
• Added that graphql resolver are loaded with js or ts ending - @resubaka (#24)
• The lib folder is moved to a package - @resubaka (#30)
• Added hooks implementation from vue-storefront as a package - @resubaka (#30)
• Added the integration tests - @resubaka (#35)
• Add url module - @gibkigonzo (#3942)
• Add fallback for sourcePriceInclTax and finalPriceInclTax in magento1 platform - @cewald (#398)
• moved server logic into packages/core @resubaka (#47)
• Update to storefront-query-builder version 1.0.0 - @cewald (#51, #52, #53)
• Add error handling for catalog and add header 'X-VS-Cache-Tags' to response - @gibkigonzo

Changed / Improved

• The response_format query parameter to the /api/catalog endpoint. Currently there is just one additional format supported: response_format=compact. When used, the response format got optimized by: a) remapping the results, removing the _source from the hits.hits; b) compressing the JSON fields names according to the config.products.fieldsToCompact; c) removing the JSON fields from the product.configurable_children when their values === parent product values; overall response size reduced over -70% - @pkarw
• The support for SearchQuery instead of the ElasticSearch DSL as for the input to /api/catalog - using storefront-query-builder package - @pkarw - vuestorefront/vue-storefront#2167
• updated yarn.lock to remove a lot possible vulnerabilities - @resubaka - vuestorefront/storefront-api#55

Fixed

• Taxcalc backport - special_prices (vuestorefront/vue-storefront-api#380) - @resubaka
• Check message property instead of errorMessage in apiError function - @cdshotels-liborpansky (#378)
• Replaced the old crop function call which has been removed from Sharp image processor - @grimasod (#381)
• Fixed that you can now run the dist folder output and don't get errors with module can't be loaded - @resubaka (#24)
• Changed that only one redis and elasticsearch client is created - @resubaka (#35)
• Send /reset-password with undefined websiteId as default - @gibkigonzo (#382)
• Fixed the restore command restore command of elastic7.ts so it exits when it finished - @resubaka (#35)
• Fixed the restore command restore command of elastic7.ts so it does not crash when it can't find the file it wants to upload - @resubaka (#35)
• Fix misplaced parenthesis for taxClasses.find - @resubaka (#39)
• Added missing build decencies for native decencies @alexshchur (#43)
• now all packages work when you install them from a registry @resubaka (#47)
• disable showing stack for invalid requests - @gibkigonzo vuestorefront/vue-storefront-api#431
• update alpine version in node image (#64)

Docs

• added basic example how to use the npm packages @resubaka (#56)

[1.0-rc.1] - The New Beginning as Storefront API - 2019.12.06

We've restarted the version numbering as the product architecture and brand changed.

Added

• New modular architecture introduced - read more,
• Default vue-storefront-api features moved to default-vsf, default-catalog and default-img modules,
• GraphQL Schemas extended, typed, new query types added to Product and Category entities,
• New documentation,
• The vue-storefront-integration-sdk merged in.

The Vue Storefront API changelog

This project has been founded on the roots of vue-storefront-api

[1.11.0-rc.1] - 2019.10.03

Added

• Experimental Elastic 7 support - @pkarw (#342)
• Output cache support with tagging and cache invalidate requests forwarding - @pkarw @resubaka (vuestorefront/vue-storefront#3367, #333)
• Constant for Mailchimp subscription status - @KonstantinSoelch (#294)
• mage2vs import now has optional --generate-unique-url-keys parameter which defaults to false to enable/disable the url key generation with name and id for categories - @rain2o (#232)
• extensions/elastic-stock module added which is a drop-in replacement for stock; the difference is that it's getting the stock information from Elastic, not from e-Commerce backend directly; to use it - please just make sure your config/local.json file has elastic-stock in the registeredExtensions collection; then please make sure in the vue-storefront to change the config.stock.ednpoint from http://<your-api-host>/api/stock to http://<your-api-host>/api/ext/elastic-stock
• Added eslint config from vue-storefront so we have the same config and in both repos typescript support - @resubaka (#320)
• Added jest support - @resubaka (#321)
• Added caching factory and action factory for the image endpoint. This gives the possibility to use other services for caching or image processing - @resubaka (#317, #315)
• Added support for tax calculation where the values from customer_tax_class_ids is used - @resubaka (#307)
• The db context object - passed to every api endpoint now has two usefull methods: getElasticClient and getRedisClient for accesing the data stores - @pkarw (#328)
• The lib/utils got two new methods getStoreCode(req: Express.Request) and getStoreView(code: string) for getting the current multistore context from vue-storefront frontend requests - @pkarw

Removed

• The scripts/seo.js tool has been removed, the legacy migrations scripts have been removed, the unused legacy extensions (gls-parcelshop-dk, postnord-parcelshop-dk) - @pkarw (#342)

Fixed

• The way Elastic and Redis clients have been fixed and code duplication removed across the app - @pkarw (#327)
• The product.price_* fields have been normalized with the backward compatibility support (see config.tax.deprecatedPriceFieldsSupport which is by default true) - @pkarw (#289)
• The product.final_price field is now being taken into product price calcualtion. Moreover, we've added the config.tax.finalPriceIncludesTax - which is set to true by default. All the price, original_price and special_price fields are calculated accordingly. It was required as Magento2 uses final_price to set the catalog pricing rules after-prices - @pkarw (#289)
• Force ES connections to use protocol config option - @cewald (#303, #304)
• Better handling of HTTP error codes provided by API client - #3151

Changed

• Error responses for mailchimp - @andrzejewsky (#3337)
• Replaced function arguments to object destructuring in calculateProductTax - @andrzejewsky (#3337)
• Refactor taxcalc.js similar to frontend - @gibkigonzo (#356)

[1.10.0] - 2019.08.12

Added

• Typescript support - @ResuBaka (#210, #242)
• Multi Stock Inventory (Magento MSI) support - @aleron75, @dimasch (#226)
• Import of magento 2 cms pages and blocks to the full import - @toh82 (#235)
• Information about magento 2 cms pages and blocks import to the readme - @toh82 (#235)
• Introduce orderNumber to order creation endpoint - @Flyingmana (#251)
• Optional Redis Auth functionality. - @rain2o (#267)
• Extensions have ability to modify Elasticsearch results. - @grimasod (#269)
• Refactored Travis build config - @Tjitse-E (#273)
• Multistore support for magento1-platform using magento1-vsbridge - @cewald (#276)
• Support self signed certificates - @lukeromanowicz (#287)

Changed

• Sharp dependency has been updated. It might require reinstalling yarn dependencies - @lukeromanowicz
• Replaced index property value not_analyzed with true for options field in attribute schema - @adityasharma7 (#334)

Fixed

• Missing res and req parameters are now passed to ProductProcessor - @jahvi (#218)
• Moving of graphql files to the dist folder - @ResuBaka (#242)
• Moving of schema files to the dist folder - @ResuBaka (#244)
• Missing assetPath config for magento1 - @ResuBaka (#245)
• New payload for magento1 stock check endpoint - @cewald (#261)
• yarn dev:inspect command and extract nodemon config to nodemon.json - @Tjitse-E, @cewald (#272, #279)
• Include Magento Currency Code in mage2vs import and productsdelta if available - @rain2o (#281)
• Better handling of HTTP error codes provided by API client - @pkarw (#3151)

[1.9.6] - 2019.07.11

• Dependencies update to avoid lodash security issues.

[1.9.5] - 2019.06.17

• Dependencies update to avoid js-yaml security issues.

[1.9.4] - 2019.06.03

• Extension schemas in src/models are not required anymore - @EmilsM, @lukeromanowicz (#259, #263)

[1.9.3] - 2019.05.27

• Change min postal code length in user profile to 3 so it's sames as in orders - @lukeromanowicz (#253)

[1.9.2] - 2019.05.20

• Fix failing o2m when parsing order schema - @lukeromanowicz (#248)

[1.9.1] - 2019.05.10

• Mount ElasticSearch data to docker/elasticsearch/data directory - @dimasch, @lukeromanowicz (#237, #241)
• Fix product schema and importer in migration process - @lukeromanowicz (#239)

[1.9.0] - 2019.05.06

• Changed location of magento1 platform js client. Moved from src/platform/magento1/module to magento1-vsbridge-client - @mtarld (#195)
• Update Babel from 6 to 7 - @lukeromanowicz (#202)
• Support unicode characters in order requests - @lukeromanowicz (#201)
• TravisCI configured for building and linting - @lukeromanowicz (#204)
• Use Redis database from configuration in mage2vs - @Cyclonecode (#211)
• Requests with invalid body result in HTTP code 400 instead of 500 - @AndreiBelokopytov (#220)
• src/models/order.schema.json was moved to src/models/order.schema.js to support regex transformation - @lukeromanowicz (#201)

[1.8.4] - 2019.04.17

• Use encrypted token for user authentication - @pkarw (#215)

[1.8.3] - 2019.03.05

• Use store id from configuration in mage2vs import - @boehsermoe (#179)

[1.8.2] - 2019.03.04

• Magento 1 bridge client - @afirlejczyk (#190)
• configurable ElasticSearch apiVersion - @Resubaka (#192)

[1.8.1] - 2019.02.11

• Fixed apiVersion property for ElasticSearch driver - now it's available thru config/*.json - @mdanilowicz (#185)