@scayle/omnichannel-nuxt 1.1.19 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @scayle/omnichannel-nuxt
 
+## 2.1.0
+
+### Minor Changes
+
+- Updated to `nuxt@3.10.1` (_For more details check the [Nuxt 3.10.1 Release Notes](https://nuxt.com/blog/v3-10)_)
+
+## 2.0.0
+
+### Major Changes
+
+- Remove `useGeocode` composable
+- Add support for Nuxt 3
+- **BREAKING**: Change structure of data returned in `useStoreVariantById`, `useStores` and `useVariantStores`
+
+  The `data` property returned by these composables was previously wrapped in an `AxiosResponse`. This is no longer, the case so to update remove the extra property access. This also affects `useStoreLocator` because it depends on these composables. The typing of these composables has also been fixed, so manual assertions are no longer necessary.
+
+  Before:
+
+  ```
+  const { variantStoresData } = useStoreLocator()
+  const stores = computed(() => variantStoresData.value?.data.stores as StoreLocation[])
+  ```
+
+  After:
+
+  ```
+  const { variantStoresData } = useStoreLocator()
+  const stores = computed(() => variantStoresData.value?.stores)
+  ```
+
+- **BREAKING**: Update Nuxt module registration entrypoint
+
+  When installing this release, you must update your Nuxt config and replace `@scayle/omnichannel-nuxt/dist/module/register` with `@scayle/omnichannel-nuxt/module`
+
 ## 1.1.19
 
 ### Patch Changes

package/README.md

@@ -1,13 +1,15 @@
 # Omnichannel
 
-This is the basis for setting up a new Omnichannel Add On based on nuxt.
+This is the basis for setting up a new Omnichannel Add On based on Nuxt.
 It provides a reusable composable, that can be used in the actual shop project.
 
 ## Getting started
 
-To start working with `omnichannel-nuxt`, make sure to
+To start working with `@scayle/omnichannel-nuxt`, make sure to
 register it as a module in your nuxt.config.ts file:
 
+Nuxt 2
+
 ```typescript
 import { NuxtConfig } from '@nuxt/types'
 
@@ -17,11 +19,10 @@ const config: NuxtConfig & { storefront: ModuleOptions } = {
   modules: [
     // ...
     [
-      '@scayle/omnichannel-nuxt/dist/module/register',
+      '@scayle/omnichannel-nuxt/dist/module',
       {
         host: environment.OMNICHANNEL_API_HOST,
         token: environment.OMNICHANNEL_API_TOKEN,
-        googleApiKey: environment.OMNICHANNEL_GOOGLE_API_KEY,
       },
     ],
   ],
@@ -32,6 +33,21 @@ const config: NuxtConfig & { storefront: ModuleOptions } = {
 export default config
 ```
 
+Nuxt 3
+
+```typescript
+export default defineNuxtConfig({
+  modules: ['@scayle/omnichannel-nuxt/module'],
+  runtimeConfig: {
+    /** Omnichannel runtime configuration */
+    omnichannel: {
+      apiHost: '', // Override: NUXT_OMNICHANNEL_API_HOST
+      apiToken: '', // Override: NUXT_OMNICHANNEL_API_TOKEN
+    },
+  },
+})
+```
+
 ## Architecture
 
 The Omnichannel Add-On package provides `useStoreLocator` composable,
@@ -41,11 +57,11 @@ which can be used to call the following methods:
 - `refreshVariantStores` to get `variantStoresData` based on provided store ID
 - `refreshStoreVariant` to get `storeVariantData` based on provided store ID and variant ID
 
-The Omnichannel Add-On package provides also `useGeocode` composable,
-which can be used to call `getData` to get city location based on given params
-
 ## List of composables
 
+[note]
+When using Nuxt 3, composables are automatically registered and do not need to be imported explicitly. [/note]
+
 ### [useStoreLocator](./src/composables/useStoreLocator.ts)
 
 Getting `storesData` based on provided address
@@ -85,31 +101,3 @@ const variantId = 1
 const storeId = 12
 await refreshStores(variantId, storeId)
 ```
-
-### [useGeocode](./src/composables/useGeocode.ts)
-
-Getting `data` (city) based on provided params
-
-- latitude and longitude OR
-- address, zipcode
-
-Example 1:
-
-```typescript
-import { useGeocode } from '@scayle/omnichannel-nuxt'
-
-const { data, getData } = useGeocode()
-const address = 'Berlin'
-await getData(address)
-```
-
-Example 2:
-
-```typescript
-import { useGeocode } from '@scayle/omnichannel-nuxt'
-
-const { data, getData } = useGeocode()
-const lat = 52.520006
-const lng = 13.404954
-await getData({ lat, lng })
-```