@scayle/omnichannel-nuxt 3.0.1 → 3.0.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scayle/omnichannel-nuxt
 
+## 3.0.2
+
+### Patch Changes
+
+- Refactored composables to use named exports rather than default exports to be inline with how `@scayle/storefront-nuxt` composables are structured
+
 ## 3.0.1
 
 ### Patch Changes

package/README.md

@@ -58,8 +58,12 @@ which can be used to call the following methods:
 
 ## List of composables
 
+When using Nuxt 3, composables are automatically registered and do not need to be imported explicitly.
+The Nuxt 3 composables can optionally be imported using the import alias `#omnichannel/composables`.
+
 [note]
-When using Nuxt 3, composables are automatically registered and do not need to be imported explicitly. [/note]
+When using Nuxt 2, composables can directly be imported from '@scayle/omnichannel-nuxt'.
+[/note]
 
 ### [useStoreLocator](./src/composables/useStoreLocator.ts)
 
@@ -68,7 +72,8 @@ Getting `storesData` based on a provided address
 Example:
 
 ```typescript
-import { useStoreLocator } from '@scayle/omnichannel-nuxt'
+// import { useStoreLocator } from '@scayle/omnichannel-nuxt' // Nuxt 2
+import { useStoreLocator } from '#omnichannel/composables'
 
 const { storesData, refreshStores } = useStoreLocator('useStoreLocator', [
   'openingTimes',
@@ -82,7 +87,8 @@ Getting `variantStoresData` based on a provided address
 Example:
 
 ```typescript
-import { useStoreLocator } from '@scayle/omnichannel-nuxt'
+// import { useStoreLocator } from '@scayle/omnichannel-nuxt' // Nuxt 2
+import { useStoreLocator } from '#omnichannel/composables'
 
 const { variantStoresData, refreshVariantStores } = useStoreLocator(
   'useStoreLocator',
@@ -98,7 +104,8 @@ Getting `storeVariantData` based on a provided store ID and variant ID
 Example:
 
 ```typescript
-import { useStoreLocator } from '@scayle/omnichannel-nuxt'
+// import { useStoreLocator } from '@scayle/omnichannel-nuxt' // Nuxt 2
+import { useStoreLocator } from '#omnichannel/composables'
 
 const { storeVariantData, refreshStoreVariant } = useStoreLocator(
   'useStoreLocator',

package/dist/module.json

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

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

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

package/dist/runtime/composables/useStoreLocator.mjs

@@ -1,7 +1,7 @@
-import useStoreVariantById from "./useStoreVariantById.mjs";
-import useStores from "./useStores.mjs";
-import useVariantStores from "./useVariantStores.mjs";
-export default (key = "useStoreLocator", withProperties = []) => {
+import { useStoreVariantById } from "./useStoreVariantById.mjs";
+import { useStores } from "./useStores.mjs";
+import { useVariantStores } from "./useVariantStores.mjs";
+export function useStoreLocator(key = "useStoreLocator", withProperties = []) {
   const { data: storesData, getData: refreshStores } = useStores(
     `${key}-stores`,
     withProperties
@@ -16,4 +16,4 @@ export default (key = "useStoreLocator", withProperties = []) => {
     variantStoresData,
     refreshVariantStores
   };
-};
+}

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

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

package/dist/runtime/composables/useStoreVariantById.mjs

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

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

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

package/dist/runtime/composables/useStores.mjs

@@ -1,5 +1,5 @@
 import { useState, computed } from "#imports";
-export default (key = "useStores", withProperties = []) => {
+export function useStores(key = "useStores", withProperties = []) {
   const response = useState(key, () => null);
   const getData = async (searchParams) => {
     response.value = await $fetch(
@@ -11,4 +11,4 @@ export default (key = "useStores", withProperties = []) => {
     data: computed(() => response.value?.data),
     getData
   };
-};
+}

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

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

package/dist/runtime/composables/useVariantStores.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/omnichannel-nuxt",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Collection of essential utilities to work with omnichannel",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",