fix: module type depreciacion (#1516)

* fix: type inference for the module build * chore: add changeset * Apply suggestions from code review Co-authored-by: Wojciech Sikora <[email protected]> --------- Co-authored-by: Wojciech Sikora <[email protected]>
vuestorefront · Apr 11, 2024 · ae8a741 · ae8a741
1 parent 938440e
commit ae8a741
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 6 deletions.
diff --git a/.changeset/eight-islands-scream.md b/.changeset/eight-islands-scream.md
@@ -0,0 +1,26 @@
+---
+"@vue-storefront/magento-sdk": patch
+---
+
+### 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.
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
@@ -2,15 +2,18 @@ import type { Module } from '@vue-storefront/sdk';
 import { connector } from './connector';
 import { ModuleOptions } from './types';
 
+/**
+ * @deprecated This type is deprecated and will be removed in the next major version.
+ * It is no longer necessary to use this type. Please, check documentation of `magentoModule`.
+ */
 export interface MagentoModuleType extends Module {
   connector: ReturnType<typeof connector>;
 }
 
 /**
  * Magento module.
  *
- * @example
- *
+ * @example 
  * Initialization of the Magento module.
  *
  * ```js
@@ -19,7 +22,7 @@ export interface MagentoModuleType extends Module {
  *
  * const sdkConfig = {
  *   magento:
- *     buildModule<MagentoModuleType>(
+ *     buildModule(
  *       magentoModule,
  *       {
  *         apiUrl: 'http://localhost:8181/magento',
@@ -30,10 +33,10 @@ export interface MagentoModuleType extends Module {
  * export const sdk = initSDK<typeof sdkConfig>(sdkConfig);
  * ```
  */
-export const magentoModule = (options: ModuleOptions): MagentoModuleType => {
+export const magentoModule = (options: ModuleOptions) => {
   return {
     connector: connector(options),
-  };
+  } satisfies Module;
 };
 
 export { client } from './client';

diff --git a/packages/sdk/src/types/ModuleOptions.ts b/packages/sdk/src/types/ModuleOptions.ts
@@ -10,5 +10,5 @@ export interface ModuleOptions {
   /**
    * The SSR API URL of the Magento instance
    */
-  ssrApiUrl: string;
+  ssrApiUrl?: string;
 }