Sync release-2.4 with release/next (#6237)

package.json

@@ -7,7 +7,10 @@
   "scripts": {
     "build:docs": "cd packages/core/docs && yarn build",
     "dev:docs": "cd packages/core/docs && yarn dev",
-    "build:core": "cd packages/core/core && yarn build && cd ../middleware && yarn build",
+    "build:core": "yarn build:core:core && yarn build:core:cache && yarn build:core:middleware",
+    "build:core:core": "cd packages/core/core && yarn build",
+    "build:core:cache": "cd packages/core/cache && yarn build",
+    "build:core:middleware": "cd packages/core/middleware && yarn build",
     "build:spr:api-client": "cd packages/spryker/api-client && yarn build",
     "build:spr:composables": "cd packages/spryker/composables && yarn build",
     "build:spr:tools": "yarn build:core && yarn build:spr:api-client && yarn build:spr:composables",

packages/commercetools/api-client/api-extractor.json

@@ -1,6 +1,6 @@
 {
   "extends": "../../api-extractor.base.json",
-  "mainEntryPointFilePath": "./lib/index.d.ts",
+  "mainEntryPointFilePath": "./lib/api-extractor-data.d.ts",
   "dtsRollup": {
     "untrimmedFilePath": "./lib/<unscopedPackageName>.d.ts"
   },

packages/commercetools/api-client/src/api-extractor-data.ts

@@ -0,0 +1,15 @@
+/**
+ * `api-client` for commercetools integration for Vue Storefront 2.
+ *
+ * @remarks
+ * The `@vue-storefront/commercetools-api` library includes everything needed to fetch data from the
+ * commercetools eCommerce platform. This includes API client configuration, API endpoints, and
+ * GraphQL types and fragments.
+ *
+ * @packageDocumentation
+ */
+
+import * as apiMethods from './api';
+
+export * from './index';
+export { apiMethods };

packages/commercetools/composables/api-extractor.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../api-extractor.base.json",
+  "mainEntryPointFilePath": "./lib/index.d.ts",
+  "dtsRollup": {
+    "untrimmedFilePath": "./lib/<unscopedPackageName>.d.ts"
+  },
+  "docModel": {
+    "apiJsonFilePath": "<projectFolder>/core/docs/commercetools/api-reference/<unscopedPackageName>.api.json"
+  }
+}

packages/commercetools/composables/src/getters/storeGetters.ts

@@ -3,10 +3,6 @@ import { Store, Channel, Address } from '../types/GraphQL';
 import { StoresData } from '../types';
 import { FilterCriteriaRecord, Localized, filterArrayByCriteriaRecord } from '../helpers/internals';
 
-/**
- * Types
- */
-
 interface StoreFilterCriteria {
   store?: FilterCriteriaRecord<Store>;
   channel?: FilterCriteriaRecord<Channel>
@@ -16,10 +12,6 @@ type StoreChannelSetKeys =
   'distributionChannels' |
   'supplyChannels';
 
-/**
- * Helpers
- */
-
 function mapToAddress(address: Address): AgnosticAddress {
   return {
     addressLine1: `${address?.country ?? ''} ${address?.city ?? ''} ${address?.postalCode ?? ''}`.trim(),
@@ -94,10 +86,6 @@ function gainAgnosticStoreItems (criteria?: FilterCriteriaRecord<Channel>) {
   };
 }
 
-/**
- * Getters
- */
-
 function getItems (stores: StoresData, criteria: StoreFilterCriteria = {}): AgnosticStore[] {
   return filterArrayByCriteriaRecord<Store>(
     stores?.results,
@@ -109,10 +97,6 @@ function getSelected (stores: StoresData): AgnosticStore | undefined {
   return getItems(stores, { store: { key: (stores?._selectedStore ?? '') }})[0];
 }
 
-/**
- * Export
- */
-
 const storeGetters: UseStoreGetters<StoresData, StoreFilterCriteria> = {
   getItems,
   getSelected

packages/commercetools/composables/src/index.ts

@@ -1,3 +1,14 @@
+/**
+ * `composables` for commercetools integration for Vue Storefront 2.
+ *
+ * @remarks
+ * The `@vue-storefront/commercetools` library includes everything needed to fetch data from the
+ * Server Middleware and display them in agnostic and formatted form. This includes composables
+ * and getters.
+ *
+ * @packageDocumentation
+ */
+
 /* istanbul ignore file */
 import { track } from '@vue-storefront/core';
 
@@ -21,3 +32,4 @@ export { useForgotPassword, useForgotPasswordFactoryParams } from './useForgotPa
 export { useStore, useStoreFactoryParams } from './useStore';
 
 export * from './getters';
+export * from './types';

packages/commercetools/composables/src/useStore/factoryParams.ts

@@ -16,7 +16,6 @@ export interface CtUseStoreFactoryParams<STORES> extends UseStoreFactoryParams<S
   changeChannel(context: Context, params: UseStoreFactoryChangeChannelParamArguments): Promise<STORES>
 }
 
-// Load param
 async function load (context: Context, params: UseStoreFactoryLoadParamArguments): Promise<StoresData> {
   const { api, config } = context.$ct;
   const { customQuery } = params;
@@ -27,14 +26,12 @@ async function load (context: Context, params: UseStoreFactoryLoadParamArguments
   };
 }
 
-// Change param
 async function change (context: Context, { store }: UseStoreFactoryChangeParamArguments) {
   context.$ct.config.storeService.changeCurrentStore(`${store.key}`);
   window.location.reload();
   return null as StoresData;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
 async function changeChannel (context: Context, { channel }: UseStoreFactoryChangeChannelParamArguments) {
   context.$ct.config.storeService.changeCurrentStore(`${(channel.distributtionChannel || 'null')}-${(channel.supplyChannel || 'null')}`);
   window.location.reload();

packages/core/cache/api-extractor.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../api-extractor.base.json",
+  "mainEntryPointFilePath": "./lib/index.d.ts",
+  "dtsRollup": {
+    "untrimmedFilePath": "./lib/<unscopedPackageName>.d.ts"
+  },
+  "docModel": {
+    "apiJsonFilePath": "<projectFolder>/core/docs/core/api-reference/<unscopedPackageName>.api.json"
+  }
+}

packages/core/cache/src/index.ts

@@ -1,3 +1,14 @@
+/**
+ * Core Vue Storefront 2 library for enabling Server Side Rendering (SSR) cache.
+ *
+ * @remarks
+ * The `@vue-storefront/cache` library is a Nuxt.js module, that is core piece required
+ * to enable Server Side Rendering (SSR) cache in Vue Storefront 2. It uses drivers
+ * to integration with specific caching solutions.
+ *
+ * @packageDocumentation
+ */
+
 export { default as useCache } from './composables/useCache';
 
 export enum CacheTagPrefix {

packages/core/cache/tsconfig.json

@@ -16,5 +16,6 @@
     "strict": false,
     "allowJs": true
   },
-  "exclude": ["node_modules", "**/*.spec.ts"]
+  "exclude": ["node_modules", "**/*.spec.ts"],
+  "include": ["src"],
 }

packages/core/core/src/index.ts

@@ -1,5 +1,15 @@
-/* istanbul ignore file */
+/**
+ * Core Vue Storefront 2 library.
+ *
+ * @remarks
+ * The `@vue-storefront/core` library is a core of the whole Vue Storefront 2 application.
+ * It defines common interfaces for all eCommerce integrations, factories for creating
+ * composables, logger, SSR helpers and more.
+ *
+ * @packageDocumentation
+ */
 
+/* istanbul ignore file */
 export * from './utils';
 export * from './factories';
 export * from './types';

packages/core/core/src/types.ts

@@ -901,7 +901,7 @@ export interface UseStoreFactoryLoadParamArguments {
 
 export interface UseStoreFactoryParams<STORES> extends FactoryParams {
   load(context: Context, params: UseStoreFactoryLoadParamArguments): Promise<STORES>
-  change(context: Context, parmas: UseStoreFactoryChangeParamArguments): Promise<STORES>
+  change(context: Context, params: UseStoreFactoryChangeParamArguments): Promise<STORES>
 }
 export interface UseStoreInterface<STORES> {
   change(params: UseStoreFactoryChangeParamArguments): Promise<void>;

packages/core/docs/.vuepress/components/PersonTile.vue

@@ -3,13 +3,13 @@
     <img :src="photo" />
     <div><b> {{ name }} </b></div>
     <div class="gap">{{ company }} </div>
-    <div><b><a href="https://slack.vuestorefront.io">Slack:</a></b> @{{ slack }} </div>
+    <div><b><a href="https://discord.vuestorefront.io">Discord:</a></b> {{ discord }} </div>
   </div>
 </template>
 
 <script>
 export default {
-  props: ['name', 'company', 'slack', 'photo']
+  props: ['name', 'company', 'discord', 'photo']
 }
 </script>
 

packages/core/docs/.vuepress/config.js

@@ -164,29 +164,29 @@ module.exports = {
           title: 'Composables',
           collapsable: false,
           children: [
-            ['/commercetools/composables/use-product', 'useProduct'],
-            ['/commercetools/composables/use-review', 'useReview '],
-            ['/commercetools/composables/use-user', 'useUser'],
-            ['/commercetools/composables/use-user-shipping', 'useUserShipping'],
-            ['/commercetools/composables/use-user-billing', 'useUserBilling'],
-            ['/commercetools/composables/use-user-order', 'useUserOrder'],
-            ['/commercetools/composables/use-facet', 'useFacet'],
+            ['/commercetools/composables/use-billing', 'useBilling'],
             ['/commercetools/composables/use-cart', 'useCart'],
-            ['/commercetools/composables/use-wishlist', 'useWishlist'],
             ['/commercetools/composables/use-category', 'useCategory'],
-            ['/commercetools/composables/use-shipping', 'useShipping'],
-            ['/commercetools/composables/use-shipping-provider', 'useShippingProvider'],
-            ['/commercetools/composables/use-billing', 'useBilling'],
-            ['/commercetools/composables/use-make-order', 'useMakeOrder'],
+            ['/commercetools/composables/use-facet', 'useFacet'],
             ['/commercetools/composables/use-forgot-password', 'useForgotPassword'],
-						['/commercetools/composables/use-store', 'useStore']
+            ['/commercetools/composables/use-make-order', 'useMakeOrder'],
+            ['/commercetools/composables/use-product', 'useProduct'],
+            ['/commercetools/composables/use-review', 'useReview'],
+            ['/commercetools/composables/use-shipping-provider', 'useShippingProvider'],
+            ['/commercetools/composables/use-shipping', 'useShipping'],
+            ['/commercetools/composables/use-store', 'useStore'],
+            ['/commercetools/composables/use-user-billing', 'useUserBilling'],
+            ['/commercetools/composables/use-user-order', 'useUserOrder'],
+            ['/commercetools/composables/use-user-shipping', 'useUserShipping'],
+            ['/commercetools/composables/use-user', 'useUser'],
+            ['/commercetools/composables/use-wishlist', 'useWishlist']
           ]
         },
         {
-          title: 'API Client',
+          title: 'API Reference',
           collapsable: false,
           children: [
-            ['/commercetools/api-reference/', 'Methods reference']
+            ['/commercetools/api-reference/', 'API Reference']
           ]
         },
         {

packages/core/docs/.vuepress/integrations.js

@@ -53,6 +53,16 @@ const INTEGRATIONS = {
         { name: 'Vue Storefront', link: 'https://vuestorefront.io/' },
       ]
     },
+    {
+      name: 'SAP Commerce Cloud',
+      link: '',
+      image: '/v2/integrations-logos/sap.svg',
+      status: STATUSES.WIP,
+      availability: AVAILABILITY.ENTERPRISE,
+      maintainedBy: [
+        { name: 'Vue Storefront', link: 'https://vuestorefront.io/' },
+      ]
+    },
     {
       name: 'Spryker',
       link: 'https://docs.vuestorefront.io/spryker',
@@ -107,6 +117,42 @@ const INTEGRATIONS = {
         { name: 'BitBag', link: 'https://bitbag.io/' },
       ]
     },
+    {
+      name: 'WooCommerce',
+      link: '',
+      image: '/v2/integrations-logos/woocommerce.svg',
+      status: STATUSES.WIP,
+      availability: AVAILABILITY.OPEN_SOURCE,
+      maintainedBy: []
+    },
+    {
+      name: 'OpenCart',
+      link: '',
+      image: '/v2/integrations-logos/opencart.svg',
+      status: STATUSES.WIP,
+      availability: AVAILABILITY.OPEN_SOURCE,
+      maintainedBy: []
+    },
+    {
+      name: 'Vendure',
+      link: '',
+      image: '/v2/integrations-logos/vendure.png',
+      status: STATUSES.WIP,
+      availability: AVAILABILITY.OPEN_SOURCE,
+      maintainedBy: [
+        { name: 'Jakub Andrzejewski', link: 'https://www.linkedin.com/in/jakub-andrzejewski/' },
+      ]
+    },
+    {
+      name: 'Odoo',
+      link: '',
+      image: '/v2/integrations-logos/odoo.svg',
+      status: STATUSES.WIP,
+      availability: AVAILABILITY.OPEN_SOURCE,
+      maintainedBy: [
+        { name: 'OdooGap', link: 'https://www.odoogap.com/' }
+      ]
+    }
   ],
   other: [
     {
@@ -238,7 +284,7 @@ const INTEGRATIONS = {
       maintainedBy: [
         { name: 'Vue Storefront', link: 'https://vuestorefront.io/' },
       ],
-      categories: [ CATEGORIES.AUTH ],
+      categories: [ CATEGORIES.CMS ],
       compatibility: []
     },
     {
@@ -250,7 +296,7 @@ const INTEGRATIONS = {
       maintainedBy: [
         { name: 'Vue Storefront', link: 'https://vuestorefront.io/' },
       ],
-      categories: [ CATEGORIES.AUTH ],
+      categories: [ CATEGORIES.CMS ],
       compatibility: []
     },
     {
@@ -275,6 +321,19 @@ const INTEGRATIONS = {
         { name: 'Vue Storefront', link: 'https://vuestorefront.io/' },
       ],
       categories: [ CATEGORIES.SEARCH ],
+      compatibility: [ 'commercetools' ]
+    },
+
+    {
+      name: 'Constructor.io',
+      link: '',
+      image: '/v2/integrations-logos/constructor-io.svg',
+      status: STATUSES.BETA,
+      availability: AVAILABILITY.ENTERPRISE,
+      maintainedBy: [
+        { name: 'Vue Storefront', link: 'https://vuestorefront.io/' },
+      ],
+      categories: [ CATEGORIES.SEARCH ],
       compatibility: []
     },
     {