@scayle/omnichannel-nuxt 2.1.4 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @scayle/omnichannel-nuxt
 
+## 3.0.0
+
+### Major Changes
+
+- Support new version of the SCAYLE Omnichannel API
+
+  This release implements compatibility with the latest version of the Omnichannel API. The major change is that much of the Store data is no longer included in API responses. Instead, API clients must explicitly request additional data through a `with` parameter.
+
+  This means that the `openingTimes`, `images`, `settings` and `customData` properties on the `Store` type are now potentially `undefined` and must be checked before usage.
+
+  If your application depends on these properties, the `with` parameter can be passed to the Omnichannel API through the composables.
+
+  For example:
+
+  ```ts
+  const {
+    storesData,
+    refreshStores,
+    storeVariantData,
+    refreshStoreVariant,
+    variantStoresData,
+    refreshVariantStores,
+  } = useStoreLocator("useStoreLocator", ["openingTimes", "setttings"]);
+  ```
+
 ## 2.1.4
 
 ### Patch Changes

package/README.md

@@ -70,7 +70,9 @@ Example:
 ```typescript
 import { useStoreLocator } from '@scayle/omnichannel-nuxt'
 
-const { storesData, refreshStores } = useStoreLocator()
+const { storesData, refreshStores } = useStoreLocator('useStoreLocator', [
+  'openingTimes',
+])
 const address = 'Hamburg'
 await refreshStores(address)
 ```
@@ -82,7 +84,10 @@ Example:
 ```typescript
 import { useStoreLocator } from '@scayle/omnichannel-nuxt'
 
-const { variantStoresData, refreshVariantStores } = useStoreLocator()
+const { variantStoresData, refreshVariantStores } = useStoreLocator(
+  'useStoreLocator',
+  ['openingTimes'],
+)
 const address = 'Hamburg'
 const storeId = 12
 await refreshVariantStores(storeId, { address: address })
@@ -95,7 +100,10 @@ Example:
 ```typescript
 import { useStoreLocator } from '@scayle/omnichannel-nuxt'
 
-const { storeVariantData, refreshStoreVariant } = useStoreLocator()
+const { storeVariantData, refreshStoreVariant } = useStoreLocator(
+  'useStoreLocator',
+  ['openingTimes'],
+)
 const variantId = 1
 const storeId = 12
 await refreshStoreVariant(variantId, storeId)

package/dist/chunks/createOmnichannelHandler.mjs

@@ -41,9 +41,10 @@ class OmnichannelClient {
         ...options.filters,
         radius: options.filters.radius ?? DEFAULT_SEARCH_RADIUS
       },
-      perPage: options.perPage
+      perPage: options.perPage,
+      with: options.with
     };
-    const params = qs.stringify(fetchOptions, { arrayFormat: "brackets" });
+    const params = qs.stringify(fetchOptions, { arrayFormat: "comma" });
     const response = await fetch(`${this.host}/stores/locator?${params}`, {
       headers: this.headers
     });
@@ -58,17 +59,24 @@ class OmnichannelClient {
         radius: options.filters.radius ?? DEFAULT_SEARCH_RADIUS
       },
       variantId: options.variantId,
-      perPage: 10
+      perPage: 10,
+      with: options.with
     };
-    const params = qs.stringify(fetchOptions, { arrayFormat: "brackets" });
+    const params = qs.stringify({
+      ...fetchOptions,
+      with: options.with?.map((property) => `store.${property}`)
+    }, { arrayFormat: "comma" });
     const response = await fetch(`${this.host}/variants/locator?${params}`, {
       headers: this.headers
     });
     return await this.handleResponse(response);
   }
   async getStoreVariantById(options) {
+    const params = qs.stringify({
+      with: options.with?.map((property) => `store.${property}`)
+    }, { arrayFormat: "comma" });
     const response = await fetch(
-      `${this.host}/stores/${options.storeId}/variants/${options.variantId}`,
+      `${this.host}/stores/${options.storeId}/variants/${options.variantId}?${params}`,
       { headers: this.headers }
     );
     return await this.handleResponse(response);
@@ -96,7 +104,8 @@ const getStoresForVariant = async function getStoresForVariant2(options, storeLo
       radius: options.filters.radius
     },
     variantId: options.variantId,
-    perPage: 10
+    perPage: 10,
+    with: options.with
   };
   const omnichannelClient = init(storeLocator);
   if (!omnichannelClient) {

package/dist/index.d.mts

@@ -1,18 +1,18 @@
-import { S as StoreLocationResponse, a as StoreLocatorSearchParams, b as StoreAvailabilityCheck, V as VariantLocation, c as VariantLocatorSearchParams } from './shared/omnichannel-nuxt.9b492196.mjs';
-export { F as FiltersAddressParams, r as FiltersCoordinatesParams, G as GeoPoint, m as OmnichannelLinks, l as OmnichannelMeta, e as OpeningTimeException, O as OpeningTimeInterval, j as OpeningTimes, k as Store, g as StoreAddress, p as StoreAvailabilityCheckResponse, f as StoreImage, i as StoreItem, h as StoreItemVariant, n as StoreLocation, d as StoreLocatorConfig, o as StoreVariantLocation, q as VariantLocationResponse } from './shared/omnichannel-nuxt.9b492196.mjs';
+import { S as StoreWithProperty, a as StoreLocationResponse, b as StoreLocatorSearchParams, c as StoreAvailabilityCheck, V as VariantLocation, d as VariantLocatorSearchParams } from './shared/omnichannel-nuxt.773770bd.mjs';
+export { u as FetchStoreVariantByIdParams, t as FetchStoresForVariantParams, F as FiltersAddressParams, s as FiltersCoordinatesParams, G as GeoPoint, n as OmnichannelLinks, m as OmnichannelMeta, f as OpeningTimeException, O as OpeningTimeInterval, k as OpeningTimes, l as Store, h as StoreAddress, q as StoreAvailabilityCheckResponse, g as StoreImage, j as StoreItem, i as StoreItemVariant, o as StoreLocation, e as StoreLocatorConfig, p as StoreVariantLocation, r as VariantLocationResponse } from './shared/omnichannel-nuxt.773770bd.mjs';
 import { ValuesType } from 'utility-types';
 
-declare const _default$3: (key?: string) => {
+declare const _default$3: (key?: string, withProperties?: StoreWithProperty[]) => {
     data: globalThis.ComputedRef<StoreLocationResponse | null>;
     getData: (searchParams: StoreLocatorSearchParams) => Promise<void>;
 };
 
-declare const _default$2: (key?: string) => {
+declare const _default$2: (key?: string, withProperties?: StoreWithProperty[]) => {
     data: globalThis.ComputedRef<StoreAvailabilityCheck | null>;
     getData: (variantId: number, storeId: number) => Promise<void>;
 };
 
-declare const _default$1: (key?: string) => {
+declare const _default$1: (key?: string, withProperties?: StoreWithProperty[]) => {
     data: globalThis.ComputedRef<VariantLocation | null>;
     getData: (searchParams: VariantLocatorSearchParams) => Promise<void>;
 };
@@ -37,4 +37,4 @@ declare const OpeningTime: {
 };
 type OpeningTime = ValuesType<typeof OpeningTime>;
 
-export { OpeningTime, StoreAvailabilityCheck, StoreLocationResponse, StoreLocatorSearchParams, VariantLocation, VariantLocatorSearchParams, _default as useStoreLocator, _default$2 as useStoreVariantById, _default$3 as useStores, _default$1 as useVariantStores };
+export { OpeningTime, StoreAvailabilityCheck, StoreLocationResponse, StoreLocatorSearchParams, StoreWithProperty, VariantLocation, VariantLocatorSearchParams, _default as useStoreLocator, _default$2 as useStoreVariantById, _default$3 as useStores, _default$1 as useVariantStores };

package/dist/index.d.ts

@@ -1,18 +1,18 @@
-import { S as StoreLocationResponse, a as StoreLocatorSearchParams, b as StoreAvailabilityCheck, V as VariantLocation, c as VariantLocatorSearchParams } from './shared/omnichannel-nuxt.9b492196.js';
-export { F as FiltersAddressParams, r as FiltersCoordinatesParams, G as GeoPoint, m as OmnichannelLinks, l as OmnichannelMeta, e as OpeningTimeException, O as OpeningTimeInterval, j as OpeningTimes, k as Store, g as StoreAddress, p as StoreAvailabilityCheckResponse, f as StoreImage, i as StoreItem, h as StoreItemVariant, n as StoreLocation, d as StoreLocatorConfig, o as StoreVariantLocation, q as VariantLocationResponse } from './shared/omnichannel-nuxt.9b492196.js';
+import { S as StoreWithProperty, a as StoreLocationResponse, b as StoreLocatorSearchParams, c as StoreAvailabilityCheck, V as VariantLocation, d as VariantLocatorSearchParams } from './shared/omnichannel-nuxt.773770bd.js';
+export { u as FetchStoreVariantByIdParams, t as FetchStoresForVariantParams, F as FiltersAddressParams, s as FiltersCoordinatesParams, G as GeoPoint, n as OmnichannelLinks, m as OmnichannelMeta, f as OpeningTimeException, O as OpeningTimeInterval, k as OpeningTimes, l as Store, h as StoreAddress, q as StoreAvailabilityCheckResponse, g as StoreImage, j as StoreItem, i as StoreItemVariant, o as StoreLocation, e as StoreLocatorConfig, p as StoreVariantLocation, r as VariantLocationResponse } from './shared/omnichannel-nuxt.773770bd.js';
 import { ValuesType } from 'utility-types';
 
-declare const _default$3: (key?: string) => {
+declare const _default$3: (key?: string, withProperties?: StoreWithProperty[]) => {
     data: globalThis.ComputedRef<StoreLocationResponse | null>;
     getData: (searchParams: StoreLocatorSearchParams) => Promise<void>;
 };
 
-declare const _default$2: (key?: string) => {
+declare const _default$2: (key?: string, withProperties?: StoreWithProperty[]) => {
     data: globalThis.ComputedRef<StoreAvailabilityCheck | null>;
     getData: (variantId: number, storeId: number) => Promise<void>;
 };
 
-declare const _default$1: (key?: string) => {
+declare const _default$1: (key?: string, withProperties?: StoreWithProperty[]) => {
     data: globalThis.ComputedRef<VariantLocation | null>;
     getData: (searchParams: VariantLocatorSearchParams) => Promise<void>;
 };
@@ -37,4 +37,4 @@ declare const OpeningTime: {
 };
 type OpeningTime = ValuesType<typeof OpeningTime>;
 
-export { OpeningTime, StoreAvailabilityCheck, StoreLocationResponse, StoreLocatorSearchParams, VariantLocation, VariantLocatorSearchParams, _default as useStoreLocator, _default$2 as useStoreVariantById, _default$3 as useStores, _default$1 as useVariantStores };
+export { OpeningTime, StoreAvailabilityCheck, StoreLocationResponse, StoreLocatorSearchParams, StoreWithProperty, VariantLocation, VariantLocatorSearchParams, _default as useStoreLocator, _default$2 as useStoreVariantById, _default$3 as useStores, _default$1 as useVariantStores };

package/dist/index.mjs

@@ -11,11 +11,14 @@ function sharedRef(value, key) {
   return newRef;
 }
 
-const useStores = (key = "useStores") => {
+const useStores = (key = "useStores", withProperties = []) => {
   const response = sharedRef(null, key);
   const getData = async (searchParams) => {
     response.value = await fetch("/api/omnichannel/stores", {
-      body: JSON.stringify(searchParams),
+      body: JSON.stringify({
+        with: withProperties,
+        searchParams
+      }),
       method: "POST",
       headers: {
         "Content-Type": "application/json"
@@ -28,11 +31,12 @@ const useStores = (key = "useStores") => {
   };
 };
 
-const useStoreVariantById = (key = "useStoreVariantById") => {
+const useStoreVariantById = (key = "useStoreVariantById", withProperties = []) => {
   const response = sharedRef(null, key);
   const getData = async (variantId, storeId) => {
     response.value = (await fetch("/api/omnichannel/storeVariantById", {
       body: JSON.stringify({
+        with: withProperties,
         storeId,
         variantId
       }),
@@ -50,11 +54,14 @@ const useStoreVariantById = (key = "useStoreVariantById") => {
   };
 };
 
-const useVariantStores = (key = "useVariantStores") => {
+const useVariantStores = (key = "useVariantStores", withProperties = []) => {
   const response = sharedRef(null, key);
   const getData = async (searchParams) => {
     response.value = (await fetch("/api/omnichannel/variantStores", {
-      body: JSON.stringify(searchParams),
+      body: JSON.stringify({
+        with: withProperties,
+        searchParams
+      }),
       method: "POST",
       headers: {
         "Content-Type": "application/json"

package/dist/module.d.mts

@@ -1,5 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { d as StoreLocatorConfig } from './shared/omnichannel-nuxt.9b492196.mjs';
+import { e as StoreLocatorConfig } from './shared/omnichannel-nuxt.773770bd.mjs';
 
 declare const _default: _nuxt_schema.NuxtModule<StoreLocatorConfig>;
 

package/dist/module.d.ts

@@ -1,5 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { d as StoreLocatorConfig } from './shared/omnichannel-nuxt.9b492196.js';
+import { e as StoreLocatorConfig } from './shared/omnichannel-nuxt.773770bd.js';
 
 declare const _default: _nuxt_schema.NuxtModule<StoreLocatorConfig>;
 

package/dist/module.json

@@ -1,4 +1,4 @@
 {
   "name": "@scayle/omnichannel-nuxt",
-  "version": "2.1.3"
+  "version": "2.1.4"
 }

package/dist/runtime/composables/useStoreLocator.d.ts

@@ -1,4 +1,5 @@
-declare const _default: (key?: string) => {
+import type { StoreWithProperty } from '../../types';
+declare const _default: (key?: string, withProperties?: StoreWithProperty[]) => {
     storesData: any;
     refreshStores: (searchParams: import("../../types").StoreLocatorSearchParams) => Promise<void>;
     storeVariantData: any;

package/dist/runtime/composables/useStoreLocator.mjs

@@ -1,12 +1,13 @@
 import useStoreVariantById from "./useStoreVariantById.mjs";
 import useStores from "./useStores.mjs";
 import useVariantStores from "./useVariantStores.mjs";
-export default (key = "useStoreLocator") => {
+export default (key = "useStoreLocator", withProperties = []) => {
   const { data: storesData, getData: refreshStores } = useStores(
-    `${key}-stores`
+    `${key}-stores`,
+    withProperties
   );
-  const { data: variantStoresData, getData: refreshVariantStores } = useVariantStores(`${key}-variant-stores`);
-  const { data: storeVariantData, getData: refreshStoreVariant } = useStoreVariantById(`${key}-variant-by-id`);
+  const { data: variantStoresData, getData: refreshVariantStores } = useVariantStores(`${key}-variant-stores`, withProperties);
+  const { data: storeVariantData, getData: refreshStoreVariant } = useStoreVariantById(`${key}-variant-by-id`, withProperties);
   return {
     storesData,
     refreshStores,

package/dist/runtime/composables/useStoreVariantById.d.ts

@@ -1,4 +1,5 @@
-declare const _default: (key?: string) => {
+import type { StoreWithProperty } from '../../types';
+declare const _default: (key?: string, withProperties?: StoreWithProperty[]) => {
     data: any;
     getData: (variantId: number, storeId: number) => Promise<void>;
 };

package/dist/runtime/composables/useStoreVariantById.mjs

@@ -1,5 +1,5 @@
 import { computed, useState } from "#imports";
-export default (key = "useStoreVariantById") => {
+export default (key = "useStoreVariantById", withProperties = []) => {
   const response = useState(key, () => null);
   const getData = async (variantId, storeId) => {
     response.value = (await $fetch(
@@ -7,7 +7,8 @@ export default (key = "useStoreVariantById") => {
       {
         body: {
           storeId,
-          variantId
+          variantId,
+          with: withProperties
         },
         method: "POST"
       }

package/dist/runtime/composables/useStores.d.ts

@@ -1,5 +1,5 @@
-import type { StoreLocatorSearchParams } from '../../types';
-declare const _default: (key?: string) => {
+import type { StoreLocatorSearchParams, StoreWithProperty } from '../../types';
+declare const _default: (key?: string, withProperties?: StoreWithProperty[]) => {
     data: any;
     getData: (searchParams: StoreLocatorSearchParams) => Promise<void>;
 };

package/dist/runtime/composables/useStores.mjs

@@ -1,10 +1,10 @@
 import { useState, computed } from "#imports";
-export default (key = "useStores") => {
+export default (key = "useStores", withProperties = []) => {
   const response = useState(key, () => null);
   const getData = async (searchParams) => {
     response.value = await $fetch(
       "/api/omnichannel/stores",
-      { body: searchParams, method: "POST" }
+      { body: { ...searchParams, with: withProperties }, method: "POST" }
     );
   };
   return {

package/dist/runtime/composables/useVariantStores.d.ts

@@ -1,5 +1,5 @@
-import type { VariantLocatorSearchParams } from '../../types';
-declare const _default: (key?: string) => {
+import type { VariantLocatorSearchParams, StoreWithProperty } from '../../types';
+declare const _default: (key?: string, withProperties?: StoreWithProperty[]) => {
     data: any;
     getData: (searchParams: VariantLocatorSearchParams) => Promise<void>;
 };

package/dist/runtime/composables/useVariantStores.mjs

@@ -1,9 +1,9 @@
 import { useState, computed } from "#imports";
-export default (key = "useVariantStores") => {
+export default (key = "useVariantStores", withProperties = []) => {
   const response = useState(key, () => null);
   const getData = async (searchParams) => {
     response.value = (await $fetch("/api/omnichannel/variantStores", {
-      body: searchParams,
+      body: { ...searchParams, with: withProperties },
       method: "POST"
     })).data;
   };

package/dist/runtime/lib/init.d.ts

@@ -1,5 +1,4 @@
-import type { StoreLocation, StoreLocatorSearchParams, StoreAvailabilityCheckResponse, VariantLocationResponse } from '../types';
-import type { FetchOptions, FetchStoreVariantByIdParams } from '../rpc/storeLocator';
+import type { StoreLocation, StoreLocatorSearchParams, StoreAvailabilityCheckResponse, VariantLocationResponse, FetchStoresForVariantParams, FetchStoreVariantByIdParams } from '../types';
 export interface PaginatedResponse<DataType> {
     nextPage: null;
     data: DataType;
@@ -20,7 +19,7 @@ export declare class OmnichannelClient {
     get headers(): HeadersInit;
     private handleResponse;
     getStores(options: StoreLocatorSearchParams): Promise<PaginatedResponse<StoreLocation[]>>;
-    getStoresForVariant(options: FetchOptions): Promise<PaginatedResponse<VariantLocationResponse>>;
+    getStoresForVariant(options: FetchStoresForVariantParams): Promise<PaginatedResponse<VariantLocationResponse>>;
     getStoreVariantById(options: FetchStoreVariantByIdParams): Promise<StoreAvailabilityCheckResponse>;
 }
 export declare const init: (config?: any) => OmnichannelClient | null;

package/dist/runtime/lib/init.mjs

@@ -38,9 +38,10 @@ export class OmnichannelClient {
         ...options.filters,
         radius: options.filters.radius ?? DEFAULT_SEARCH_RADIUS
       },
-      perPage: options.perPage
+      perPage: options.perPage,
+      with: options.with
     };
-    const params = qs.stringify(fetchOptions, { arrayFormat: "brackets" });
+    const params = qs.stringify(fetchOptions, { arrayFormat: "comma" });
     const response = await fetch(`${this.host}/stores/locator?${params}`, {
       headers: this.headers
     });
@@ -55,17 +56,24 @@ export class OmnichannelClient {
         radius: options.filters.radius ?? DEFAULT_SEARCH_RADIUS
       },
       variantId: options.variantId,
-      perPage: 10
+      perPage: 10,
+      with: options.with
     };
-    const params = qs.stringify(fetchOptions, { arrayFormat: "brackets" });
+    const params = qs.stringify({
+      ...fetchOptions,
+      with: options.with?.map((property) => `store.${property}`)
+    }, { arrayFormat: "comma" });
     const response = await fetch(`${this.host}/variants/locator?${params}`, {
       headers: this.headers
     });
     return await this.handleResponse(response);
   }
   async getStoreVariantById(options) {
+    const params = qs.stringify({
+      with: options.with?.map((property) => `store.${property}`)
+    }, { arrayFormat: "comma" });
     const response = await fetch(
-      `${this.host}/stores/${options.storeId}/variants/${options.variantId}`,
+      `${this.host}/stores/${options.storeId}/variants/${options.variantId}?${params}`,
       { headers: this.headers }
     );
     return await this.handleResponse(response);

package/dist/runtime/rpc/storeLocator.d.ts

@@ -1,24 +1,4 @@
-import type { StoreLocatorConfig, StoreLocatorSearchParams } from '../../types';
-export interface FetchStoresForVariantParams {
-    variantId: number;
-    filters: {
-        address: string;
-        radius: number;
-    };
-    perPage?: number;
-}
-export interface FetchStoreVariantByIdParams {
-    storeId: number;
-    variantId: number;
-}
-export interface FetchOptions {
-    filters: {
-        address: string;
-        radius: number;
-    };
-    variantId?: number;
-    perPage: number;
-}
+import type { StoreLocatorConfig, StoreLocatorSearchParams, FetchStoresForVariantParams, FetchStoreVariantByIdParams } from '../../types';
 export declare const getStores: (options: StoreLocatorSearchParams, storeLocator: StoreLocatorConfig) => Promise<import("../lib/init").PaginatedResponse<StoreLocation[]>>;
 export declare const getStoresForVariant: (options: FetchStoresForVariantParams, storeLocator: StoreLocatorConfig) => Promise<import("../lib/init").PaginatedResponse<VariantLocationResponse>>;
 export declare const getStoreVariantById: (options: FetchStoreVariantByIdParams, storeLocator: StoreLocatorConfig) => Promise<StoreAvailabilityCheckResponse>;

package/dist/runtime/rpc/storeLocator.mjs

@@ -14,7 +14,8 @@ export const getStoresForVariant = async function getStoresForVariant2(options,
       radius: options.filters.radius
     },
     variantId: options.variantId,
-    perPage: 10
+    perPage: 10,
+    with: options.with
   };
   const omnichannelClient = init(storeLocator);
   if (!omnichannelClient) {

package/dist/shared/{omnichannel-nuxt.9b492196.d.mts → omnichannel-nuxt.773770bd.d.mts}

@@ -63,16 +63,17 @@ interface Store {
     name: string;
     email: string;
     address: StoreAddress;
-    openingTimes: OpeningTimes;
+    openingTimes?: OpeningTimes;
     geoPoint: GeoPoint;
-    customData: object;
-    settings: {
+    customData?: object;
+    settings?: {
         shipFromStore: boolean;
         clickAndCollect: boolean;
     };
     isActive: boolean;
-    images: StoreImage;
+    images?: StoreImage;
 }
+type StoreWithProperty = 'openingTimes' | 'customData' | 'images' | 'settings';
 interface OmnichannelMeta {
     path: string;
     currentPage: number;
@@ -136,11 +137,27 @@ interface FiltersCoordinatesParams {
 interface StoreLocatorSearchParams {
     filters: FiltersAddressParams | FiltersCoordinatesParams;
     perPage?: number;
+    with?: StoreWithProperty[];
 }
 interface VariantLocatorSearchParams {
     variantId: number;
     filters: FiltersAddressParams | FiltersCoordinatesParams;
     perPage?: number;
+    with?: StoreWithProperty[];
+}
+interface FetchStoresForVariantParams {
+    variantId: number;
+    filters: {
+        address: string;
+        radius: number;
+    };
+    perPage?: number;
+    with?: StoreWithProperty[];
+}
+interface FetchStoreVariantByIdParams {
+    storeId: number;
+    variantId: number;
+    with?: StoreWithProperty[];
 }
 
-export type { FiltersAddressParams as F, GeoPoint as G, OpeningTimeInterval as O, StoreLocationResponse as S, VariantLocation as V, StoreLocatorSearchParams as a, StoreAvailabilityCheck as b, VariantLocatorSearchParams as c, StoreLocatorConfig as d, OpeningTimeException as e, StoreImage as f, StoreAddress as g, StoreItemVariant as h, StoreItem as i, OpeningTimes as j, Store as k, OmnichannelMeta as l, OmnichannelLinks as m, StoreLocation as n, StoreVariantLocation as o, StoreAvailabilityCheckResponse as p, VariantLocationResponse as q, FiltersCoordinatesParams as r };
+export type { FiltersAddressParams as F, GeoPoint as G, OpeningTimeInterval as O, StoreWithProperty as S, VariantLocation as V, StoreLocationResponse as a, StoreLocatorSearchParams as b, StoreAvailabilityCheck as c, VariantLocatorSearchParams as d, StoreLocatorConfig as e, OpeningTimeException as f, StoreImage as g, StoreAddress as h, StoreItemVariant as i, StoreItem as j, OpeningTimes as k, Store as l, OmnichannelMeta as m, OmnichannelLinks as n, StoreLocation as o, StoreVariantLocation as p, StoreAvailabilityCheckResponse as q, VariantLocationResponse as r, FiltersCoordinatesParams as s, FetchStoresForVariantParams as t, FetchStoreVariantByIdParams as u };

package/dist/shared/{omnichannel-nuxt.9b492196.d.ts → omnichannel-nuxt.773770bd.d.ts}

@@ -63,16 +63,17 @@ interface Store {
     name: string;
     email: string;
     address: StoreAddress;
-    openingTimes: OpeningTimes;
+    openingTimes?: OpeningTimes;
     geoPoint: GeoPoint;
-    customData: object;
-    settings: {
+    customData?: object;
+    settings?: {
         shipFromStore: boolean;
         clickAndCollect: boolean;
     };
     isActive: boolean;
-    images: StoreImage;
+    images?: StoreImage;
 }
+type StoreWithProperty = 'openingTimes' | 'customData' | 'images' | 'settings';
 interface OmnichannelMeta {
     path: string;
     currentPage: number;
@@ -136,11 +137,27 @@ interface FiltersCoordinatesParams {
 interface StoreLocatorSearchParams {
     filters: FiltersAddressParams | FiltersCoordinatesParams;
     perPage?: number;
+    with?: StoreWithProperty[];
 }
 interface VariantLocatorSearchParams {
     variantId: number;
     filters: FiltersAddressParams | FiltersCoordinatesParams;
     perPage?: number;
+    with?: StoreWithProperty[];
+}
+interface FetchStoresForVariantParams {
+    variantId: number;
+    filters: {
+        address: string;
+        radius: number;
+    };
+    perPage?: number;
+    with?: StoreWithProperty[];
+}
+interface FetchStoreVariantByIdParams {
+    storeId: number;
+    variantId: number;
+    with?: StoreWithProperty[];
 }
 
-export type { FiltersAddressParams as F, GeoPoint as G, OpeningTimeInterval as O, StoreLocationResponse as S, VariantLocation as V, StoreLocatorSearchParams as a, StoreAvailabilityCheck as b, VariantLocatorSearchParams as c, StoreLocatorConfig as d, OpeningTimeException as e, StoreImage as f, StoreAddress as g, StoreItemVariant as h, StoreItem as i, OpeningTimes as j, Store as k, OmnichannelMeta as l, OmnichannelLinks as m, StoreLocation as n, StoreVariantLocation as o, StoreAvailabilityCheckResponse as p, VariantLocationResponse as q, FiltersCoordinatesParams as r };
+export type { FiltersAddressParams as F, GeoPoint as G, OpeningTimeInterval as O, StoreWithProperty as S, VariantLocation as V, StoreLocationResponse as a, StoreLocatorSearchParams as b, StoreAvailabilityCheck as c, VariantLocatorSearchParams as d, StoreLocatorConfig as e, OpeningTimeException as f, StoreImage as g, StoreAddress as h, StoreItemVariant as i, StoreItem as j, OpeningTimes as k, Store as l, OmnichannelMeta as m, OmnichannelLinks as n, StoreLocation as o, StoreVariantLocation as p, StoreAvailabilityCheckResponse as q, VariantLocationResponse as r, FiltersCoordinatesParams as s, FetchStoresForVariantParams as t, FetchStoreVariantByIdParams as u };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/omnichannel-nuxt",
-  "version": "2.1.4",
+  "version": "3.0.0",
   "description": "Collection of essential utilities to work with omnichannel",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -52,34 +52,34 @@
     "test:ci": "jest --passWithNoTests --runInBand --coverage --reporters=default --reporters=jest-junit"
   },
   "peerDependencies": {
-    "@nuxtjs/composition-api": "0.33.1",
+    "@nuxtjs/composition-api": "0.34.0",
     "express": "4.19.2"
   },
   "dependencies": {
     "@nuxt/kit": "3.11.1",
     "body-parser": "1.20.2",
-    "qs": "6.12.0",
+    "qs": "6.12.1",
     "utility-types": "3.11.0"
   },
   "devDependencies": {
     "@nuxt/module-builder": "0.5.5",
     "@nuxt/schema": "3.11.1",
     "@nuxt/types": "2.17.3",
-    "@nuxtjs/composition-api": "0.33.1",
+    "@nuxtjs/composition-api": "0.34.0",
     "@scayle/eslint-config-storefront": "3.2.7",
     "@types/body-parser": "1.19.5",
     "@types/express": "4.17.21",
-    "@types/node": "20.12.6",
-    "@types/qs": "6.9.14",
+    "@types/node": "20.12.7",
+    "@types/qs": "6.9.15",
     "dprint": "0.45.1",
     "eslint": "8.57.0",
     "eslint-formatter-gitlab": "5.1.0",
     "h3": "1.11.1",
     "nuxi": "3.11.1",
-    "typescript": "5.4.4",
+    "typescript": "5.4.5",
     "vue": "2.7.16"
   },
   "volta": {
-    "node": "20.12.1"
+    "node": "20.12.2"
   }
 }