ci: release

vuestorefront · Apr 22, 2024 · c52d84d · c52d84d
1 parent 2380b78
commit c52d84d
Show file tree

Hide file tree

Showing 9 changed files with 158 additions and 111 deletions.
diff --git a/.changeset/eighty-papayas-occur.md b/.changeset/eighty-papayas-occur.md
diff --git a/.changeset/gorgeous-news-notice.md b/.changeset/gorgeous-news-notice.md
diff --git a/docs/content/5.api/magento-api.api.json b/docs/content/5.api/magento-api.api.json
diff --git a/docs/content/6.reference/changelogs/vue-storefront-magento-api.md b/docs/content/6.reference/changelogs/vue-storefront-magento-api.md
@@ -1,5 +1,11 @@
 # @vue-storefront/magento-api
 
+## 3.0.1
+
+### Patch Changes
+
+- 6672edfb: [CHANGED] Update TSDocs of API methods. Now, they contain examples of usage.
+
 ## 3.0.0
 
 ### Major Changes

diff --git a/docs/content/6.reference/changelogs/vue-storefront-magento-sdk.md b/docs/content/6.reference/changelogs/vue-storefront-magento-sdk.md
@@ -1,5 +1,44 @@
 # @vue-storefront/magento-sdk
 
+## 2.3.2
+
+### Patch Changes
+
+- 6672edfb: [CHANGED] `magentoModule` has been deprecated. Use `middlewareModule` from `@vue-storefront/sdk` package instead.
+
+  ```diff
+  - import { initSDK, buildModule } from '@vue-storefront/sdk';
+  - import { magentoModule } from '@vsf-enterprise/magento-sdk'
+  + import { initSDK, buildModule, middlewareModule } from '@vue-storefront/sdk';
+  + import { Endpoints as MagentoEndpoints } from '@vsf-enterprise/sapcc-api'; // In Alokai Storefront you should import it from `storefront-middleware/types.ts`
+
+  const sdkConfig = {
+    magento:
+      buildModule(
+  -      magentoModule,
+  +      middlewareModule<MagentoEndpoints>,
+        { apiUrl: 'http://localhost:8181/magento' }
+      )
+  };
+  ```
+
+  Updating your `magentoModule` to this version should not disrupt your existing code; however, switching to `middlewareModule` will require certain modifications.
+
+  To migrate:
+
+  - Use custom query as a second argument of `middlewareModule` function.
+
+  ```diff
+  const customQuery = {
+    cart: 'cart-custom-query',
+    metadata: {
+      fields: 'id items { uid }'
+    }
+  };
+  - const cart = await sdk.magento.cart({ cartId: '123'}, { customQuery });
+  + const cart = await sdk.magento.cart({ cartId: '123'}, customQuery);
+  ```
+
 ## 2.3.1
 
 ### Patch Changes

diff --git a/packages/api-client/CHANGELOG.md b/packages/api-client/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @vue-storefront/magento-api
 
+## 3.0.1
+
+### Patch Changes
+
+- 6672edfb: [CHANGED] Update TSDocs of API methods. Now, they contain examples of usage.
+
 ## 3.0.0
 
 ### Major Changes

diff --git a/packages/api-client/package.json b/packages/api-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@vue-storefront/magento-api",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "sideEffects": false,
   "homepage": "https://github.com/vuestorefront/magento2",
   "bugs": {

diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md
@@ -1,5 +1,44 @@
 # @vue-storefront/magento-sdk
 
+## 2.3.2
+
+### Patch Changes
+
+- 6672edfb: [CHANGED] `magentoModule` has been deprecated. Use `middlewareModule` from `@vue-storefront/sdk` package instead.
+
+  ```diff
+  - import { initSDK, buildModule } from '@vue-storefront/sdk';
+  - import { magentoModule } from '@vsf-enterprise/magento-sdk'
+  + import { initSDK, buildModule, middlewareModule } from '@vue-storefront/sdk';
+  + import { Endpoints as MagentoEndpoints } from '@vsf-enterprise/sapcc-api'; // In Alokai Storefront you should import it from `storefront-middleware/types.ts`
+
+  const sdkConfig = {
+    magento:
+      buildModule(
+  -      magentoModule,
+  +      middlewareModule<MagentoEndpoints>,
+        { apiUrl: 'http://localhost:8181/magento' }
+      )
+  };
+  ```
+
+  Updating your `magentoModule` to this version should not disrupt your existing code; however, switching to `middlewareModule` will require certain modifications.
+
+  To migrate:
+
+  - Use custom query as a second argument of `middlewareModule` function.
+
+  ```diff
+  const customQuery = {
+    cart: 'cart-custom-query',
+    metadata: {
+      fields: 'id items { uid }'
+    }
+  };
+  - const cart = await sdk.magento.cart({ cartId: '123'}, { customQuery });
+  + const cart = await sdk.magento.cart({ cartId: '123'}, customQuery);
+  ```
+
 ## 2.3.1
 
 ### Patch Changes

diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@vue-storefront/magento-sdk",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "main": "lib/index.cjs.js",
   "module": "lib/index.es.js",
   "types": "lib/index.d.ts",