@scayle/omnichannel-nuxt 4.0.4 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scayle/omnichannel-nuxt
 
+## 4.1.0
+
+### Minor Changes
+
+- Refactored the module to use `@scayle/storefront-nuxt` custom RPC methods.
+
+  This internal change simplifies server interactions by using RPC methods instead of manually adding server handlers. No functional changes are expected for the exported composables, however `@scayle/storefront-nuxt@^8.7.1` is now required as a peer dependency.
+
+### Patch Changes
+
+- Remove the `FetchStoresForVariantParams` type as it is a duplicate of `VariantLocatorSearchParams`
+
 ## 4.0.4
 
 ### Patch Changes

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 SCAYLE GmbH
+Copyright (c) 2025 SCAYLE GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/index.d.mts

@@ -159,19 +159,10 @@ interface VariantLocatorSearchParams {
     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 FetchStoreVariantByIdParams, type FetchStoresForVariantParams, type FiltersAddressParams, type FiltersCoordinatesParams, type GeoPoint, type OmnichannelLinks, type OmnichannelMeta, OpeningTime, type OpeningTimeException, type OpeningTimeInterval, type OpeningTimes, type Store, type StoreAddress, type StoreAvailabilityCheck, type StoreAvailabilityCheckResponse, type StoreImage, type StoreItem, type StoreItemVariant, type StoreLocation, type StoreLocationResponse, type StoreLocatorConfig, type StoreLocatorSearchParams, type StoreVariantLocation, type StoreWithProperty, type VariantLocation, type VariantLocationResponse, type VariantLocatorSearchParams };
+export { type FetchStoreVariantByIdParams, type FiltersAddressParams, type FiltersCoordinatesParams, type GeoPoint, type OmnichannelLinks, type OmnichannelMeta, OpeningTime, type OpeningTimeException, type OpeningTimeInterval, type OpeningTimes, type Store, type StoreAddress, type StoreAvailabilityCheck, type StoreAvailabilityCheckResponse, type StoreImage, type StoreItem, type StoreItemVariant, type StoreLocation, type StoreLocationResponse, type StoreLocatorConfig, type StoreLocatorSearchParams, type StoreVariantLocation, type StoreWithProperty, type VariantLocation, type VariantLocationResponse, type VariantLocatorSearchParams };

package/dist/index.d.ts

@@ -159,19 +159,10 @@ interface VariantLocatorSearchParams {
     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 FetchStoreVariantByIdParams, type FetchStoresForVariantParams, type FiltersAddressParams, type FiltersCoordinatesParams, type GeoPoint, type OmnichannelLinks, type OmnichannelMeta, OpeningTime, type OpeningTimeException, type OpeningTimeInterval, type OpeningTimes, type Store, type StoreAddress, type StoreAvailabilityCheck, type StoreAvailabilityCheckResponse, type StoreImage, type StoreItem, type StoreItemVariant, type StoreLocation, type StoreLocationResponse, type StoreLocatorConfig, type StoreLocatorSearchParams, type StoreVariantLocation, type StoreWithProperty, type VariantLocation, type VariantLocationResponse, type VariantLocatorSearchParams };
+export { type FetchStoreVariantByIdParams, type FiltersAddressParams, type FiltersCoordinatesParams, type GeoPoint, type OmnichannelLinks, type OmnichannelMeta, OpeningTime, type OpeningTimeException, type OpeningTimeInterval, type OpeningTimes, type Store, type StoreAddress, type StoreAvailabilityCheck, type StoreAvailabilityCheckResponse, type StoreImage, type StoreItem, type StoreItemVariant, type StoreLocation, type StoreLocationResponse, type StoreLocatorConfig, type StoreLocatorSearchParams, type StoreVariantLocation, type StoreWithProperty, type VariantLocation, type VariantLocationResponse, type VariantLocatorSearchParams };

package/dist/module.d.mts

@@ -7,4 +7,15 @@ type ModuleOptions = {
 };
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
+interface OmnichannelRuntimeConfig {
+    apiHost: string;
+    apiToken: string;
+    internalAccessHeader?: string;
+}
+declare module '@nuxt/schema' {
+    interface RuntimeConfig {
+        omnichannel: OmnichannelRuntimeConfig;
+    }
+}
+
 export { _default as default };

package/dist/module.d.ts

@@ -7,4 +7,15 @@ type ModuleOptions = {
 };
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
+interface OmnichannelRuntimeConfig {
+    apiHost: string;
+    apiToken: string;
+    internalAccessHeader?: string;
+}
+declare module '@nuxt/schema' {
+    interface RuntimeConfig {
+        omnichannel: OmnichannelRuntimeConfig;
+    }
+}
+
 export { _default as default };

package/dist/module.json

@@ -1,9 +1,9 @@
 {
   "name": "@scayle/omnichannel-nuxt",
-  "version": "4.0.4",
+  "version": "4.1.0",
   "configKey": "@scayle/omnichannel-nuxt",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
-    "unbuild": "3.2.0"
+    "unbuild": "3.3.1"
   }
 }

package/dist/module.mjs

@@ -1,40 +1,34 @@
-import { defineNuxtModule, isNuxt2, createResolver, addServerHandler, addImportsDir } from '@nuxt/kit';
+import { defineNuxtModule, isNuxtMajorVersion, createResolver, addImportsDir } from '@nuxt/kit';
 
 const PACKAGE_NAME = "@scayle/omnichannel-nuxt";
-const PACKAGE_VERSION = "4.0.4";
+const PACKAGE_VERSION = "4.1.0";
 const module = defineNuxtModule({
   meta: {
     name: PACKAGE_NAME,
     version: PACKAGE_VERSION
   },
   async setup(moduleOptions, nuxt) {
-    if (isNuxt2()) {
+    if (isNuxtMajorVersion(2, nuxt)) {
       throw new Error(
         "Nuxt 2 is not supported in this version of @scayle/omnichannel-nuxt"
       );
     } else {
-      const { resolve } = createResolver(import.meta.url);
+      const { resolve, resolvePath } = createResolver(import.meta.url);
       nuxt.options.runtimeConfig.omnichannel = {
         apiToken: moduleOptions.token ?? "",
         apiHost: moduleOptions.host ?? "",
         internalAccessHeader: moduleOptions.internalAccessHeader ?? ""
       };
-      addServerHandler({
-        route: `/api/omnichannel/**`,
-        handler: resolve("./runtime/handler"),
-        method: "post"
+      nuxt.hook("storefront:custom-rpc:extend", async (customRpcs) => {
+        customRpcs.push({
+          source: await resolvePath("./runtime/rpc/storeLocator"),
+          names: ["getStores", "getStoresForVariant", "getStoreVariantById"]
+        });
       });
       nuxt.hooks.hook("nitro:config", (nitroConfig) => {
         nitroConfig.externals = nitroConfig.externals || {};
         nitroConfig.externals.inline = nitroConfig.externals.inline || [];
-        nitroConfig.externals.inline.push(resolve("./runtime/rpc/storeLocator"));
         nitroConfig.externals.inline.push(resolve("./runtime/lib/init"));
-        nitroConfig.externals.inline.push(
-          resolve("./runtime/error/errorHandler")
-        );
-        nitroConfig.externals.inline.push(
-          resolve("./runtime/constants/httpStatus")
-        );
       });
       nuxt.options.alias["#omnichannel/composables"] = resolve(
         "./runtime/composables"

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

@@ -1,6 +1,6 @@
 import type { StoreWithProperty } from '../../types/index.js';
 export declare function useStoreLocator(key?: string, withProperties?: StoreWithProperty[]): {
-    storesData: import("vue").ComputedRef<import("../../types").StoreLocation[] | undefined>;
+    storesData: import("vue").ComputedRef<import("../../types").StoreLocation[] | null>;
     refreshStores: (searchParams: import("../../types").StoreLocatorSearchParams) => Promise<void>;
     storeVariantData: import("vue").ComputedRef<import("../../types").StoreAvailabilityCheck | null>;
     refreshStoreVariant: (variantId: number, storeId: number) => Promise<void>;

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

@@ -1,5 +1,5 @@
 import type { StoreAvailabilityCheck, StoreWithProperty } from '../../types/index.js';
 export declare function useStoreVariantById(key?: string, withProperties?: StoreWithProperty[]): {
-    data: import("#imports").ComputedRef<StoreAvailabilityCheck | null>;
+    data: import("vue").ComputedRef<StoreAvailabilityCheck | null>;
     getData: (variantId: number, storeId: number) => Promise<void>;
 };

package/dist/runtime/composables/useStoreVariantById.js

@@ -1,18 +1,14 @@
 import { computed, useState } from "#imports";
+import { useRpcCall } from "@scayle/storefront-nuxt/composables";
 export function useStoreVariantById(key = "useStoreVariantById", withProperties = []) {
   const response = useState(key, () => null);
+  const rpcCall = useRpcCall("getStoreVariantById");
   const getData = async (variantId, storeId) => {
-    response.value = (await $fetch(
-      "/api/omnichannel/storeVariantById",
-      {
-        body: {
-          storeId,
-          variantId,
-          with: withProperties
-        },
-        method: "POST"
-      }
-    )).data;
+    response.value = (await rpcCall({
+      storeId,
+      variantId,
+      with: withProperties
+    })).data;
   };
   return {
     data: computed(() => response.value),

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

@@ -1,5 +1,5 @@
-import type { StoreLocatorSearchParams, StoreWithProperty } from '../../types/index.js';
+import type { StoreLocatorSearchParams, StoreLocation, StoreWithProperty } from '../../types/index.js';
 export declare function useStores(key?: string, withProperties?: StoreWithProperty[]): {
-    data: import("#imports").ComputedRef<import("../../types").StoreLocation[] | undefined>;
+    data: import("vue").ComputedRef<StoreLocation[] | null>;
     getData: (searchParams: StoreLocatorSearchParams) => Promise<void>;
 };

package/dist/runtime/composables/useStores.js

@@ -1,14 +1,13 @@
 import { useState, computed } from "#imports";
+import { useRpcCall } from "@scayle/storefront-nuxt/composables";
 export function useStores(key = "useStores", withProperties = []) {
   const response = useState(key, () => null);
+  const rpcCall = useRpcCall("getStores");
   const getData = async (searchParams) => {
-    response.value = await $fetch(
-      "/api/omnichannel/stores",
-      { body: { ...searchParams, with: withProperties }, method: "POST" }
-    );
+    response.value = (await rpcCall({ ...searchParams, with: withProperties })).data;
   };
   return {
-    data: computed(() => response.value?.data),
+    data: computed(() => response.value),
     getData
   };
 }

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

@@ -1,5 +1,5 @@
 import type { VariantLocatorSearchParams, VariantLocation, StoreWithProperty } from '../../types/index.js';
 export declare function useVariantStores(key?: string, withProperties?: StoreWithProperty[]): {
-    data: import("#imports").ComputedRef<VariantLocation | null>;
+    data: import("vue").ComputedRef<VariantLocation | null>;
     getData: (searchParams: VariantLocatorSearchParams) => Promise<void>;
 };

package/dist/runtime/composables/useVariantStores.js

@@ -1,11 +1,10 @@
 import { useState, computed } from "#imports";
+import { useRpcCall } from "@scayle/storefront-nuxt/composables";
 export function useVariantStores(key = "useVariantStores", withProperties = []) {
   const response = useState(key, () => null);
+  const rpcCall = useRpcCall("getStoresForVariant");
   const getData = async (searchParams) => {
-    response.value = (await $fetch("/api/omnichannel/variantStores", {
-      body: { ...searchParams, with: withProperties },
-      method: "POST"
-    })).data;
+    response.value = (await rpcCall({ ...searchParams, with: withProperties })).data;
   };
   return {
     data: computed(() => response.value),

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

@@ -1,8 +1,4 @@
-import type { StoreLocation, StoreLocatorConfig, StoreLocatorSearchParams, StoreAvailabilityCheckResponse, VariantLocationResponse, FetchStoresForVariantParams, FetchStoreVariantByIdParams } from '../../types/index.js';
-export interface PaginatedResponse<DataType> {
-    nextPage: null;
-    data: DataType;
-}
+import type { StoreLocationResponse, StoreLocatorConfig, StoreLocatorSearchParams, StoreAvailabilityCheckResponse, VariantLocationResponse, VariantLocatorSearchParams, FetchStoreVariantByIdParams } from '../../types/index.js';
 /**
  * A custom Error type for errors that occur in a fetch() request
  * Contains the Response object from the request, and optionally the response data
@@ -12,6 +8,7 @@ export declare class FetchError extends Error {
     data?: unknown;
     constructor(response: Response, data?: unknown);
 }
+type DistributiveOmit<T, K extends PropertyKey> = T extends T ? Omit<T, K> : never;
 export declare class OmnichannelClient {
     private readonly host;
     private readonly token;
@@ -19,8 +16,13 @@ export declare class OmnichannelClient {
     constructor(host: string, token: string, additionalHeaders?: HeadersInit);
     get headers(): HeadersInit;
     private handleResponse;
-    getStores(options: StoreLocatorSearchParams): Promise<PaginatedResponse<StoreLocation[]>>;
-    getStoresForVariant(options: FetchStoresForVariantParams): Promise<PaginatedResponse<VariantLocationResponse>>;
+    getStores(options: StoreLocatorSearchParams): Promise<StoreLocationResponse>;
+    getStoresForVariant(options: Omit<VariantLocatorSearchParams, 'filters'> & {
+        filters: DistributiveOmit<VariantLocatorSearchParams['filters'], 'radius'> & {
+            radius?: number;
+        };
+    }): Promise<VariantLocationResponse>;
     getStoreVariantById(options: FetchStoreVariantByIdParams): Promise<StoreAvailabilityCheckResponse>;
 }
 export declare const init: (config?: StoreLocatorConfig) => OmnichannelClient | null;
+export {};

package/dist/runtime/lib/init.js

@@ -55,7 +55,7 @@ export class OmnichannelClient {
   async getStoresForVariant(options) {
     const fetchOptions = {
       filters: {
-        address: options.filters.address,
+        ...options.filters,
         radius: options.filters.radius ?? DEFAULT_SEARCH_RADIUS
       },
       variantId: options.variantId,

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

@@ -1,4 +1,5 @@
-import type { StoreLocatorConfig, StoreLocatorSearchParams, FetchStoresForVariantParams, FetchStoreVariantByIdParams } from '../../types/index.js';
-export declare const getStores: (options: StoreLocatorSearchParams, storeLocator: StoreLocatorConfig) => Promise<import("../lib/init").PaginatedResponse<import("../../types").StoreLocation[]>>;
-export declare const getStoresForVariant: (options: FetchStoresForVariantParams, storeLocator: StoreLocatorConfig) => Promise<import("../lib/init").PaginatedResponse<import("../../types").VariantLocationResponse>>;
-export declare const getStoreVariantById: (options: FetchStoreVariantByIdParams, storeLocator: StoreLocatorConfig) => Promise<import("../../types").StoreAvailabilityCheckResponse>;
+import type { RpcContext } from '@scayle/storefront-nuxt';
+import type { StoreLocatorSearchParams, VariantLocatorSearchParams, FetchStoreVariantByIdParams, VariantLocationResponse, StoreAvailabilityCheckResponse, StoreLocationResponse } from '../../types/index.js';
+export declare const getStores: (options: StoreLocatorSearchParams, context: RpcContext) => Promise<StoreLocationResponse>;
+export declare const getStoresForVariant: (options: VariantLocatorSearchParams, context: RpcContext) => Promise<VariantLocationResponse>;
+export declare const getStoreVariantById: (options: FetchStoreVariantByIdParams, context: RpcContext) => Promise<StoreAvailabilityCheckResponse>;

package/dist/runtime/rpc/storeLocator.js

@@ -1,18 +1,38 @@
 import { init } from "../lib/init.js";
 const noClientMessage = "Client not configured";
-export const getStores = async function getStores2(options, storeLocator) {
+function getOmnichannelConfig(runtimeConfig) {
+  const config = runtimeConfig.omnichannel;
+  if (!config || !config.apiHost || !config.apiToken) {
+    console.error(
+      "[Omnichannel] Token and host must be set in the runtimeConfig",
+      { config }
+    );
+    throw new Error("Token and host must be set in the runtimeConfig");
+  }
+  return {
+    host: config.apiHost,
+    token: config.apiToken,
+    additionalHeaders: config.internalAccessHeader ? {
+      "x-internal-access": config.internalAccessHeader
+    } : {}
+  };
+}
+export const getStores = async function getStores2(options, context) {
+  const storeLocator = getOmnichannelConfig(
+    context.runtimeConfiguration
+  );
   const omnichannelClient = init(storeLocator);
   if (!omnichannelClient) {
     throw new Error(noClientMessage);
   }
   return await omnichannelClient.getStores(options);
 };
-export const getStoresForVariant = async function getStoresForVariant2(options, storeLocator) {
+export const getStoresForVariant = async function getStoresForVariant2(options, context) {
+  const storeLocator = getOmnichannelConfig(
+    context.runtimeConfiguration
+  );
   const fetchOptions = {
-    filters: {
-      address: options.filters.address,
-      radius: options.filters.radius
-    },
+    filters: options.filters,
     variantId: options.variantId,
     perPage: 10,
     with: options.with
@@ -23,7 +43,10 @@ export const getStoresForVariant = async function getStoresForVariant2(options,
   }
   return await omnichannelClient.getStoresForVariant(fetchOptions);
 };
-export const getStoreVariantById = async function getStoreVariantById2(options, storeLocator) {
+export const getStoreVariantById = async function getStoreVariantById2(options, context) {
+  const storeLocator = getOmnichannelConfig(
+    context.runtimeConfiguration
+  );
   const omnichannelClient = init(storeLocator);
   if (!omnichannelClient) {
     throw new Error(noClientMessage);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/omnichannel-nuxt",
-  "version": "4.0.4",
+  "version": "4.1.0",
   "description": "Collection of essential utilities to work with omnichannel",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -50,7 +50,10 @@
     "typecheck": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
     "test": "vitest --run --passWithNoTests",
     "test:watch": "vitest --passWithNoTests",
-    "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit --outputFile=./junit.xml"
+    "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit --outputFile=./coverage/junit.xml"
+  },
+  "peerDependencies": {
+    "@scayle/storefront-nuxt": "^8.7.1"
   },
   "dependencies": {
     "@nuxt/kit": "^3.12.2",
@@ -58,23 +61,24 @@
     "utility-types": "^3.11.0"
   },
   "devDependencies": {
-    "@nuxt/eslint": "0.7.4",
+    "@nuxt/eslint": "1.0.1",
     "@nuxt/module-builder": "0.8.4",
     "@nuxt/schema": "3.14.1592",
-    "@scayle/eslint-config-storefront": "4.4.0",
-    "@types/node": "22.10.5",
-    "@types/qs": "6.9.17",
-    "dprint": "0.48.0",
-    "eslint": "9.17.0",
+    "@scayle/eslint-config-storefront": "4.4.1",
+    "@scayle/storefront-nuxt": "8.9.1",
+    "@types/node": "22.13.4",
+    "@types/qs": "6.9.18",
+    "dprint": "0.49.0",
+    "eslint": "9.20.1",
     "eslint-formatter-gitlab": "5.1.0",
-    "h3": "1.13.0",
-    "nuxi": "3.19.1",
+    "h3": "1.15.0",
+    "nuxi": "3.21.1",
     "nuxt": "3.14.1592",
     "typescript": "5.7.3",
-    "vitest": "2.1.8",
+    "vitest": "2.1.9",
     "vue-tsc": "2.2.0"
   },
   "volta": {
-    "node": "22.12.0"
+    "node": "22.13.1"
   }
 }