ci: release (#1518)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
vuestorefront · Apr 11, 2024 · 8138228 · 8138228
1 parent ae8a741
commit 8138228
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 29 deletions.
diff --git a/.changeset/eight-islands-scream.md b/.changeset/eight-islands-scream.md
diff --git a/docs/content/5.api/magento-sdk.api.json b/docs/content/5.api/magento-sdk.api.json
@@ -6848,7 +6848,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "ssrApiUrl: "
+                  "text": "ssrApiUrl?: "
                 },
                 {
                   "kind": "Content",
@@ -6859,7 +6859,7 @@
                   "text": ";"
                 }
               ],
-              "isOptional": false,
+              "isOptional": true,
               "releaseTag": "Public",
               "name": "ssrApiUrl",
               "propertyTypeTokenRange": {

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,31 @@
 # @vue-storefront/magento-sdk
 
+## 2.3.1
+
+### Patch Changes
+
+- ae8a741d: ### Change Log
+
+  - [CHANGED] Deprecated the `MagentoModuleType` interface in `index.ts`. It is no longer necessary to use this type. Please, check documentation of `magentoModule` for alternatives. Below you can find a snippet of the new way of using `magentoModule`. Pay attention to the `buildModule` function that is used to create a module instance, it no longer requires the `MagentoModuleType` type as a generic parameter.
+
+  ```ts
+  import { initSDK, buildModule } from "@vue-storefront/sdk";
+  import {
+    magentoModule,
+    MagentoModuleType,
+  } from "@vue-storefront/magento2-sdk";
+
+  const sdkConfig = {
+    magento: buildModule(magentoModule, {
+      apiUrl: "http://localhost:8181/magento",
+    }),
+  };
+
+  export const sdk = initSDK(sdkConfig);
+  ```
+
+  - [CHANGED] Made the `ssrApiUrl` property in `ModuleOptions.ts` optional.
+
 ## 2.3.0
 
 ### Minor Changes

diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md
@@ -1,5 +1,31 @@
 # @vue-storefront/magento-sdk
 
+## 2.3.1
+
+### Patch Changes
+
+- ae8a741d: ### Change Log
+
+  - [CHANGED] Deprecated the `MagentoModuleType` interface in `index.ts`. It is no longer necessary to use this type. Please, check documentation of `magentoModule` for alternatives. Below you can find a snippet of the new way of using `magentoModule`. Pay attention to the `buildModule` function that is used to create a module instance, it no longer requires the `MagentoModuleType` type as a generic parameter.
+
+  ```ts
+  import { initSDK, buildModule } from "@vue-storefront/sdk";
+  import {
+    magentoModule,
+    MagentoModuleType,
+  } from "@vue-storefront/magento2-sdk";
+
+  const sdkConfig = {
+    magento: buildModule(magentoModule, {
+      apiUrl: "http://localhost:8181/magento",
+    }),
+  };
+
+  export const sdk = initSDK(sdkConfig);
+  ```
+
+  - [CHANGED] Made the `ssrApiUrl` property in `ModuleOptions.ts` optional.
+
 ## 2.3.0
 
 ### Minor 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.0",
+  "version": "2.3.1",
   "main": "lib/index.cjs.js",
   "module": "lib/index.es.js",
   "types": "lib/index.d.ts",