fix: type inference for the module build

vuestorefront · Apr 11, 2024 · f721636 · f721636
1 parent 633b422
commit f721636
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
@@ -2,24 +2,26 @@ 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
- *
- * Initialization of the Magento module.
+ * @example Initialization of the Magento module.
  *
  * ```js
  * import { initSDK, buildModule } from '@vue-storefront/sdk';
  * import { magentoModule, MagentoModuleType } from '@vue-storefront/magento2-sdk'
  *
  * const sdkConfig = {
  *   magento:
- *     buildModule<MagentoModuleType>(
+ *     buildModule(
  *       magentoModule,
  *       {
  *         apiUrl: 'http://localhost:8181/magento',
@@ -30,7 +32,7 @@ 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),
   };

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;
 }