@scayle/omnichannel-nuxt 4.0.0 → 4.0.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scayle/omnichannel-nuxt
 
+## 4.0.2
+
+### Patch Changes
+
+- Support internal access header
+
+## 4.0.1
+
+### Patch Changes
+
+- Update @nuxt/module-builder to 0.8.4
+
 ## 4.0.0
 
 ### Major Changes

package/README.md

@@ -84,3 +84,19 @@ const variantId = 1
 const storeId = 12
 await refreshStoreVariant(variantId, storeId)
 ```
+
+## What is SCAYLE?
+
+[SCAYLE](https://scayle.com) is a full-featured e-commerce software solution that comes with flexible APIs.
+Within SCAYLE, you can manage all aspects of your shop, such as products, stocks, customers, and transactions.
+
+Learn more about [SCAYLE’s architecture](https://scayle.dev/en/developer-guide) and commerce modules in the docs.
+
+## Other channels
+
+- [LinkedIn](https://www.linkedin.com/company/scaylecommerce/)
+- [Jobs](https://careers.smartrecruiters.com/ABOUTYOUGmbH/scayle)
+
+## License
+
+Licensed under the [MIT License](https://opensource.org/license/mit/)

package/dist/index.d.mts

@@ -1,5 +1,4 @@
 import { ValuesType } from 'utility-types';
-export { u as FetchStoreVariantByIdParams, t as FetchStoresForVariantParams, F as FiltersAddressParams, q as FiltersCoordinatesParams, G as GeoPoint, j as OmnichannelLinks, i as OmnichannelMeta, a as OpeningTimeException, O as OpeningTimeInterval, f as OpeningTimes, g as Store, c as StoreAddress, n as StoreAvailabilityCheck, o as StoreAvailabilityCheckResponse, b as StoreImage, e as StoreItem, d as StoreItemVariant, k as StoreLocation, l as StoreLocationResponse, S as StoreLocatorConfig, r as StoreLocatorSearchParams, m as StoreVariantLocation, h as StoreWithProperty, V as VariantLocation, p as VariantLocationResponse, s as VariantLocatorSearchParams } from './shared/omnichannel-nuxt.270bfbda.mjs';
 
 declare const OpeningTime: {
     readonly MONDAY: "mon";
@@ -12,4 +11,167 @@ declare const OpeningTime: {
 };
 type OpeningTime = ValuesType<typeof OpeningTime>;
 
-export { OpeningTime };
+interface StoreLocatorConfig {
+    token: string;
+    host: string;
+    companyId?: number;
+    googleApiKey?: string;
+    additionalHeaders?: HeadersInit;
+}
+interface GeoPoint {
+    lat: number;
+    lng: number;
+}
+interface OpeningTimeInterval {
+    timeFrom: string;
+    timeUntil: string;
+}
+interface OpeningTimeException {
+    exceptionDate: string;
+    exceptionName: string;
+    exceptionType: 'open' | 'closed';
+    timeFrom: string;
+    timeUntil: string;
+}
+interface StoreImage {
+    id: number;
+    name: string;
+    damKey: string;
+    url: string;
+    customData: object;
+}
+interface StoreAddress {
+    street: string;
+    houseNumber: string;
+    zipCode: string;
+    city: string;
+    countryCode: string;
+}
+interface StoreItemVariant {
+    variantId: number;
+    variantReferenceKey: string;
+    quantity: number;
+}
+interface StoreItem {
+    productId: number;
+    productReferenceKey: string;
+    name: object;
+    image: string;
+    variants: StoreItemVariant[];
+}
+interface OpeningTimes {
+    mon: OpeningTimeInterval[];
+    tue: OpeningTimeInterval[];
+    wed: OpeningTimeInterval[];
+    thu: OpeningTimeInterval[];
+    fri: OpeningTimeInterval[];
+    sat: OpeningTimeInterval[];
+    sun: OpeningTimeInterval[];
+    exceptions: OpeningTimeException[];
+    currentlyOpen: boolean;
+    minutesUntilClosed: number;
+}
+interface Store {
+    id: number;
+    referenceKey: string;
+    name: string;
+    email: string;
+    address: StoreAddress;
+    openingTimes?: OpeningTimes;
+    geoPoint: GeoPoint;
+    customData?: object;
+    settings?: {
+        shipFromStore: boolean;
+        clickAndCollect: boolean;
+    };
+    isActive: boolean;
+    images?: StoreImage;
+}
+type StoreWithProperty = 'openingTimes' | 'customData' | 'images' | 'settings';
+interface OmnichannelMeta {
+    path: string;
+    currentPage: number;
+    lastPage: number;
+    from: number;
+    to: number;
+    perPage: number;
+    total: number;
+    firstPageUrl: string;
+    lastPageUrl: string;
+    prevPageUrl: string | null;
+    nextPageUrl: string | null;
+}
+interface OmnichannelLinks {
+    first: string | null;
+    last: string | null;
+    prev: string | null;
+    next: string | null;
+}
+interface StoreLocation extends Store {
+    distance: number;
+}
+interface StoreLocationResponse {
+    data: StoreLocation[];
+    meta: {
+        searchAddress: GeoPoint;
+    };
+}
+interface StoreVariantLocation extends StoreLocation {
+    quantity: number;
+}
+interface StoreAvailabilityCheck extends Store {
+    items: StoreItem[];
+}
+interface StoreAvailabilityCheckResponse {
+    data: StoreAvailabilityCheck;
+    meta: OmnichannelMeta;
+}
+interface VariantLocation {
+    name: object;
+    productId: number;
+    variantId: number;
+    productReferenceKey: string;
+    variantReferenceKey: string;
+    image: string;
+    additionalData: object;
+    stores: StoreVariantLocation[];
+}
+interface VariantLocationResponse {
+    data: VariantLocation;
+    meta: OmnichannelMeta;
+}
+interface FiltersAddressParams {
+    address: string;
+    radius: number;
+}
+interface FiltersCoordinatesParams {
+    geoPoint: GeoPoint;
+    radius: number;
+}
+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 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 };

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { ValuesType } from 'utility-types';
-export { u as FetchStoreVariantByIdParams, t as FetchStoresForVariantParams, F as FiltersAddressParams, q as FiltersCoordinatesParams, G as GeoPoint, j as OmnichannelLinks, i as OmnichannelMeta, a as OpeningTimeException, O as OpeningTimeInterval, f as OpeningTimes, g as Store, c as StoreAddress, n as StoreAvailabilityCheck, o as StoreAvailabilityCheckResponse, b as StoreImage, e as StoreItem, d as StoreItemVariant, k as StoreLocation, l as StoreLocationResponse, S as StoreLocatorConfig, r as StoreLocatorSearchParams, m as StoreVariantLocation, h as StoreWithProperty, V as VariantLocation, p as VariantLocationResponse, s as VariantLocatorSearchParams } from './shared/omnichannel-nuxt.270bfbda.js';
 
 declare const OpeningTime: {
     readonly MONDAY: "mon";
@@ -12,4 +11,167 @@ declare const OpeningTime: {
 };
 type OpeningTime = ValuesType<typeof OpeningTime>;
 
-export { OpeningTime };
+interface StoreLocatorConfig {
+    token: string;
+    host: string;
+    companyId?: number;
+    googleApiKey?: string;
+    additionalHeaders?: HeadersInit;
+}
+interface GeoPoint {
+    lat: number;
+    lng: number;
+}
+interface OpeningTimeInterval {
+    timeFrom: string;
+    timeUntil: string;
+}
+interface OpeningTimeException {
+    exceptionDate: string;
+    exceptionName: string;
+    exceptionType: 'open' | 'closed';
+    timeFrom: string;
+    timeUntil: string;
+}
+interface StoreImage {
+    id: number;
+    name: string;
+    damKey: string;
+    url: string;
+    customData: object;
+}
+interface StoreAddress {
+    street: string;
+    houseNumber: string;
+    zipCode: string;
+    city: string;
+    countryCode: string;
+}
+interface StoreItemVariant {
+    variantId: number;
+    variantReferenceKey: string;
+    quantity: number;
+}
+interface StoreItem {
+    productId: number;
+    productReferenceKey: string;
+    name: object;
+    image: string;
+    variants: StoreItemVariant[];
+}
+interface OpeningTimes {
+    mon: OpeningTimeInterval[];
+    tue: OpeningTimeInterval[];
+    wed: OpeningTimeInterval[];
+    thu: OpeningTimeInterval[];
+    fri: OpeningTimeInterval[];
+    sat: OpeningTimeInterval[];
+    sun: OpeningTimeInterval[];
+    exceptions: OpeningTimeException[];
+    currentlyOpen: boolean;
+    minutesUntilClosed: number;
+}
+interface Store {
+    id: number;
+    referenceKey: string;
+    name: string;
+    email: string;
+    address: StoreAddress;
+    openingTimes?: OpeningTimes;
+    geoPoint: GeoPoint;
+    customData?: object;
+    settings?: {
+        shipFromStore: boolean;
+        clickAndCollect: boolean;
+    };
+    isActive: boolean;
+    images?: StoreImage;
+}
+type StoreWithProperty = 'openingTimes' | 'customData' | 'images' | 'settings';
+interface OmnichannelMeta {
+    path: string;
+    currentPage: number;
+    lastPage: number;
+    from: number;
+    to: number;
+    perPage: number;
+    total: number;
+    firstPageUrl: string;
+    lastPageUrl: string;
+    prevPageUrl: string | null;
+    nextPageUrl: string | null;
+}
+interface OmnichannelLinks {
+    first: string | null;
+    last: string | null;
+    prev: string | null;
+    next: string | null;
+}
+interface StoreLocation extends Store {
+    distance: number;
+}
+interface StoreLocationResponse {
+    data: StoreLocation[];
+    meta: {
+        searchAddress: GeoPoint;
+    };
+}
+interface StoreVariantLocation extends StoreLocation {
+    quantity: number;
+}
+interface StoreAvailabilityCheck extends Store {
+    items: StoreItem[];
+}
+interface StoreAvailabilityCheckResponse {
+    data: StoreAvailabilityCheck;
+    meta: OmnichannelMeta;
+}
+interface VariantLocation {
+    name: object;
+    productId: number;
+    variantId: number;
+    productReferenceKey: string;
+    variantReferenceKey: string;
+    image: string;
+    additionalData: object;
+    stores: StoreVariantLocation[];
+}
+interface VariantLocationResponse {
+    data: VariantLocation;
+    meta: OmnichannelMeta;
+}
+interface FiltersAddressParams {
+    address: string;
+    radius: number;
+}
+interface FiltersCoordinatesParams {
+    geoPoint: GeoPoint;
+    radius: number;
+}
+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 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 };

package/dist/module.d.mts

@@ -1,6 +1,10 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { S as StoreLocatorConfig } from './shared/omnichannel-nuxt.270bfbda.mjs';
 
-declare const _default: _nuxt_schema.NuxtModule<StoreLocatorConfig>;
+type ModuleOptions = {
+    token: string;
+    host: string;
+    internalAccessHeader?: string | undefined;
+};
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 export { _default as default };

package/dist/module.d.ts

@@ -1,6 +1,10 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { S as StoreLocatorConfig } from './shared/omnichannel-nuxt.270bfbda.js';
 
-declare const _default: _nuxt_schema.NuxtModule<StoreLocatorConfig>;
+type ModuleOptions = {
+    token: string;
+    host: string;
+    internalAccessHeader?: string | undefined;
+};
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 export { _default as default };

package/dist/module.json

@@ -1,4 +1,8 @@
 {
   "name": "@scayle/omnichannel-nuxt",
-  "version": "4.0.0"
+  "version": "4.0.2",
+  "builder": {
+    "@nuxt/module-builder": "0.8.4",
+    "unbuild": "2.0.0"
+  }
 }

package/dist/module.mjs

@@ -2,13 +2,18 @@ import { defineNuxtModule, isNuxt2, createResolver, addServerHandler, addImports
 
 const module = defineNuxtModule({
   meta: {},
-  async setup(_moduleOptions, nuxt) {
+  async setup(moduleOptions, nuxt) {
     if (isNuxt2()) {
       throw new Error(
         "Nuxt 2 is not supported in this version of @scayle/omnichannel-nuxt"
       );
     } else {
       const { resolve } = 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"),

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

@@ -1,4 +1,4 @@
-export * from './useStoreLocator';
-export * from './useStores';
-export * from './useStoreVariantById';
-export * from './useVariantStores';
+export * from './useStoreLocator.js';
+export * from './useStores.js';
+export * from './useStoreVariantById.js';
+export * from './useVariantStores.js';

package/dist/runtime/composables/index.js

@@ -0,0 +1,4 @@
+export * from "./useStoreLocator.js";
+export * from "./useStores.js";
+export * from "./useStoreVariantById.js";
+export * from "./useVariantStores.js";

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

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

package/dist/runtime/composables/{useStoreLocator.mjs → useStoreLocator.js}

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

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

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

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

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

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

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

package/dist/runtime/constants/httpStatus.d.ts

@@ -195,7 +195,7 @@ declare const HttpStatusCode: {
     /**
      * The request is larger than the server is willing or able to process. Previously called "Request Entity Too Large".
      */
-    readonly PAYLOAD_TOO_LARGE: 413;
+    readonly CONTENT_TOO_LARGE: 413;
     /**
      * The URI provided was too long for the server to process. Often the result of too much data being encoded as a query-string of a GET request,
      * in which case it should be converted to a POST request.
@@ -230,7 +230,7 @@ declare const HttpStatusCode: {
     /**
      * The request was well-formed but was unable to be followed due to semantic errors.
      */
-    readonly UNPROCESSABLE_ENTITY: 422;
+    readonly UNPROCESSABLE_CONTENT: 422;
     /**
      * The resource that is being accessed is locked.
      */
@@ -509,7 +509,7 @@ declare const HttpStatusMessage: {
     /**
      * The request is larger than the server is willing or able to process. Previously called "Request Entity Too Large".
      */
-    readonly PAYLOAD_TOO_LARGE: "PAYLOAD TOO LARGE";
+    readonly CONTENT_TOO_LARGE: "CONTENT TOO LARGE";
     /**
      * The URI provided was too long for the server to process. Often the result of too much data being encoded as a query-string of a GET request,
      * in which case it should be converted to a POST request.
@@ -544,7 +544,7 @@ declare const HttpStatusMessage: {
     /**
      * The request was well-formed but was unable to be followed due to semantic errors.
      */
-    readonly UNPROCESSABLE_ENTITY: "UNPROCESSABLE ENTITY";
+    readonly UNPROCESSABLE_CONTENT: "UNPROCESSABLE CONTENT";
     /**
      * The resource that is being accessed is locked.
      */

package/dist/runtime/constants/{httpStatus.mjs → httpStatus.js}

@@ -194,7 +194,7 @@ const HttpStatusCode = {
   /**
    * The request is larger than the server is willing or able to process. Previously called "Request Entity Too Large".
    */
-  PAYLOAD_TOO_LARGE: 413,
+  CONTENT_TOO_LARGE: 413,
   /**
    * The URI provided was too long for the server to process. Often the result of too much data being encoded as a query-string of a GET request,
    * in which case it should be converted to a POST request.
@@ -229,7 +229,7 @@ const HttpStatusCode = {
   /**
    * The request was well-formed but was unable to be followed due to semantic errors.
    */
-  UNPROCESSABLE_ENTITY: 422,
+  UNPROCESSABLE_CONTENT: 422,
   /**
    * The resource that is being accessed is locked.
    */
@@ -508,7 +508,7 @@ const HttpStatusMessage = {
   /**
    * The request is larger than the server is willing or able to process. Previously called "Request Entity Too Large".
    */
-  PAYLOAD_TOO_LARGE: "PAYLOAD TOO LARGE",
+  CONTENT_TOO_LARGE: "CONTENT TOO LARGE",
   /**
    * The URI provided was too long for the server to process. Often the result of too much data being encoded as a query-string of a GET request,
    * in which case it should be converted to a POST request.
@@ -543,7 +543,7 @@ const HttpStatusMessage = {
   /**
    * The request was well-formed but was unable to be followed due to semantic errors.
    */
-  UNPROCESSABLE_ENTITY: "UNPROCESSABLE ENTITY",
+  UNPROCESSABLE_CONTENT: "UNPROCESSABLE CONTENT",
   /**
    * The resource that is being accessed is locked.
    */

package/dist/runtime/error/errorHandler.d.ts

@@ -1,4 +1,4 @@
-import { HttpStatusCode } from '../constants/httpStatus';
+import { HttpStatusCode } from '../constants/httpStatus.js';
 declare const parseErrorData: (error: unknown) => {
     statusCode: HttpStatusCode;
     message: string;

package/dist/runtime/error/{errorHandler.mjs → errorHandler.js}

@@ -1,5 +1,5 @@
-import { HttpStatusCode, HttpStatusMessage } from "../constants/httpStatus.mjs";
-import { FetchError } from "../lib/init.mjs";
+import { HttpStatusCode, HttpStatusMessage } from "../constants/httpStatus.js";
+import { FetchError } from "../lib/init.js";
 const parseErrorData = (error) => {
   if (error instanceof FetchError) {
     return {

package/dist/runtime/handler.d.ts

@@ -1,2 +1,7 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+import { HttpStatusCode } from './constants/httpStatus.js';
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<import("../types").StoreAvailabilityCheckResponse | import("./lib/init").PaginatedResponse<import("../types").StoreLocation[]> | import("./lib/init").PaginatedResponse<import("../types").VariantLocationResponse> | {
+    statusCode: HttpStatusCode;
+    message: string;
+    url?: string;
+} | undefined>>;
 export default _default;

package/dist/runtime/{handler.mjs → handler.js}

@@ -1,11 +1,11 @@
 import { defineEventHandler, readBody, setResponseStatus } from "h3";
-import { HttpStatusCode } from "./constants/httpStatus.mjs";
+import { HttpStatusCode } from "./constants/httpStatus.js";
 import {
   getStores,
   getStoreVariantById,
   getStoresForVariant
-} from "./rpc/storeLocator.mjs";
-import { parseErrorData } from "./error/errorHandler.mjs";
+} from "./rpc/storeLocator.js";
+import { parseErrorData } from "./error/errorHandler.js";
 import { useRuntimeConfig } from "#imports";
 export default defineEventHandler(async (event) => {
   const path = event.path.split("/").reverse()[0];
@@ -24,7 +24,10 @@ export default defineEventHandler(async (event) => {
   }
   const options = {
     host: config.apiHost,
-    token: config.apiToken
+    token: config.apiToken,
+    additionalHeaders: config.internalAccessHeader ? {
+      "x-internal-access": config.internalAccessHeader
+    } : {}
   };
   try {
     switch (path) {

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

@@ -1,4 +1,4 @@
-import type { StoreLocation, StoreLocatorSearchParams, StoreAvailabilityCheckResponse, VariantLocationResponse, FetchStoresForVariantParams, FetchStoreVariantByIdParams } from '../types';
+import type { StoreLocation, StoreLocatorConfig, StoreLocatorSearchParams, StoreAvailabilityCheckResponse, VariantLocationResponse, FetchStoresForVariantParams, FetchStoreVariantByIdParams } from '../../types/index.js';
 export interface PaginatedResponse<DataType> {
     nextPage: null;
     data: DataType;
@@ -15,11 +15,12 @@ export declare class FetchError extends Error {
 export declare class OmnichannelClient {
     private readonly host;
     private readonly token;
-    constructor(host: string, token: string);
+    private readonly additionalHeaders;
+    constructor(host: string, token: string, additionalHeaders?: HeadersInit);
     get headers(): HeadersInit;
     private handleResponse;
     getStores(options: StoreLocatorSearchParams): Promise<PaginatedResponse<StoreLocation[]>>;
     getStoresForVariant(options: FetchStoresForVariantParams): Promise<PaginatedResponse<VariantLocationResponse>>;
     getStoreVariantById(options: FetchStoreVariantByIdParams): Promise<StoreAvailabilityCheckResponse>;
 }
-export declare const init: (config?: any) => OmnichannelClient | null;
+export declare const init: (config?: StoreLocatorConfig) => OmnichannelClient | null;

package/dist/runtime/lib/{init.mjs → init.js}

@@ -15,15 +15,18 @@ export class FetchError extends Error {
 export class OmnichannelClient {
   host;
   token;
-  constructor(host, token) {
+  additionalHeaders;
+  constructor(host, token, additionalHeaders) {
     this.host = host;
     this.token = token;
+    this.additionalHeaders = additionalHeaders;
   }
   get headers() {
     return {
       Authorization: `Bearer ${this.token}`,
       Accept: "application/json",
-      "Content-Type": "application/json"
+      "Content-Type": "application/json",
+      ...this.additionalHeaders
     };
   }
   async handleResponse(response) {

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

@@ -1,4 +1,4 @@
-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>;
+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>;

package/dist/runtime/rpc/{storeLocator.mjs → storeLocator.js}

@@ -1,4 +1,4 @@
-import { init } from "../lib/init.mjs";
+import { init } from "../lib/init.js";
 const noClientMessage = "Client not configured";
 export const getStores = async function getStores2(options, storeLocator) {
   const omnichannelClient = init(storeLocator);

package/dist/types.d.mts

@@ -1,8 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
 
-import type {  } from './module.js'
+import type { default as Module } from './module.js'
 
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
 
-
-
-
-export type { default } from './module.js'
+export { default } from './module.js'

package/dist/types.d.ts

@@ -1,8 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
 
-import type {  } from './module'
+import type { default as Module } from './module'
 
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
 
-
-
-
-export type { default } from './module'
+export { default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/omnichannel-nuxt",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Collection of essential utilities to work with omnichannel",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -8,6 +8,7 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
+  "website": "https://scayle.dev/en/extensions/omnichannel/user-guide",
   "exports": {
     "./module": {
       "types": "./dist/module.d.ts",
@@ -33,14 +34,14 @@
     "node": ">= 18.15.0"
   },
   "compatibility": {
-    "nuxt": "^2.17.3 || ^3.9.0"
+    "nuxt": "^3.9.0"
   },
   "scripts": {
     "clean": "rimraf ./dist",
     "build": "nuxt-module-build build",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
-    "prep": "nuxi prepare playground",
+    "prep": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
     "format": "dprint check",
     "format:fix": "dprint fmt",
     "lint": "eslint . --format gitlab",
@@ -56,24 +57,22 @@
     "utility-types": "^3.11.0"
   },
   "devDependencies": {
-    "@nuxt/eslint": "0.5.0",
-    "@nuxt/module-builder": "0.5.5",
-    "@nuxt/schema": "3.12.4",
-    "@nuxt/types": "2.18.1",
-    "@nuxtjs/composition-api": "0.34.0",
-    "@scayle/eslint-config-storefront": "4.3.0",
-    "@types/node": "20.14.14",
-    "@types/qs": "6.9.15",
+    "@nuxt/eslint": "0.6.0",
+    "@nuxt/module-builder": "0.8.4",
+    "@nuxt/schema": "3.13.2",
+    "@scayle/eslint-config-storefront": "4.3.2",
+    "@types/node": "20.16.11",
+    "@types/qs": "6.9.16",
     "dprint": "0.47.2",
-    "eslint": "9.8.0",
+    "eslint": "9.12.0",
     "eslint-formatter-gitlab": "5.1.0",
-    "h3": "1.12.0",
-    "nuxi": "3.12.0",
-    "typescript": "5.5.4",
-    "vitest": "2.0.5",
-    "vue": "2.7.16"
+    "h3": "1.13.0",
+    "nuxi": "3.14.0",
+    "nuxt": "3.13.2",
+    "typescript": "5.6.3",
+    "vitest": "2.1.3"
   },
   "volta": {
-    "node": "20.16.0"
+    "node": "20.18.0"
   }
 }

package/dist/runtime/composables/index.mjs

@@ -1,4 +0,0 @@
-export * from "./useStoreLocator.mjs";
-export * from "./useStores.mjs";
-export * from "./useStoreVariantById.mjs";
-export * from "./useVariantStores.mjs";

package/dist/shared/omnichannel-nuxt.270bfbda.d.mts

@@ -1,163 +0,0 @@
-interface StoreLocatorConfig {
-    token: string;
-    host: string;
-    companyId?: number;
-    googleApiKey?: string;
-}
-interface GeoPoint {
-    lat: number;
-    lng: number;
-}
-interface OpeningTimeInterval {
-    timeFrom: string;
-    timeUntil: string;
-}
-interface OpeningTimeException {
-    exceptionDate: string;
-    exceptionName: string;
-    exceptionType: 'open' | 'closed';
-    timeFrom: string;
-    timeUntil: string;
-}
-interface StoreImage {
-    id: number;
-    name: string;
-    damKey: string;
-    url: string;
-    customData: object;
-}
-interface StoreAddress {
-    street: string;
-    houseNumber: string;
-    zipCode: string;
-    city: string;
-    countryCode: string;
-}
-interface StoreItemVariant {
-    variantId: number;
-    variantReferenceKey: string;
-    quantity: number;
-}
-interface StoreItem {
-    productId: number;
-    productReferenceKey: string;
-    name: object;
-    image: string;
-    variants: StoreItemVariant[];
-}
-interface OpeningTimes {
-    mon: OpeningTimeInterval[];
-    tue: OpeningTimeInterval[];
-    wed: OpeningTimeInterval[];
-    thu: OpeningTimeInterval[];
-    fri: OpeningTimeInterval[];
-    sat: OpeningTimeInterval[];
-    sun: OpeningTimeInterval[];
-    exceptions: OpeningTimeException[];
-    currentlyOpen: boolean;
-    minutesUntilClosed: number;
-}
-interface Store {
-    id: number;
-    referenceKey: string;
-    name: string;
-    email: string;
-    address: StoreAddress;
-    openingTimes?: OpeningTimes;
-    geoPoint: GeoPoint;
-    customData?: object;
-    settings?: {
-        shipFromStore: boolean;
-        clickAndCollect: boolean;
-    };
-    isActive: boolean;
-    images?: StoreImage;
-}
-type StoreWithProperty = 'openingTimes' | 'customData' | 'images' | 'settings';
-interface OmnichannelMeta {
-    path: string;
-    currentPage: number;
-    lastPage: number;
-    from: number;
-    to: number;
-    perPage: number;
-    total: number;
-    firstPageUrl: string;
-    lastPageUrl: string;
-    prevPageUrl: string | null;
-    nextPageUrl: string | null;
-}
-interface OmnichannelLinks {
-    first: string | null;
-    last: string | null;
-    prev: string | null;
-    next: string | null;
-}
-interface StoreLocation extends Store {
-    distance: number;
-}
-interface StoreLocationResponse {
-    data: StoreLocation[];
-    meta: {
-        searchAddress: GeoPoint;
-    };
-}
-interface StoreVariantLocation extends StoreLocation {
-    quantity: number;
-}
-interface StoreAvailabilityCheck extends Store {
-    items: StoreItem[];
-}
-interface StoreAvailabilityCheckResponse {
-    data: StoreAvailabilityCheck;
-    meta: OmnichannelMeta;
-}
-interface VariantLocation {
-    name: object;
-    productId: number;
-    variantId: number;
-    productReferenceKey: string;
-    variantReferenceKey: string;
-    image: string;
-    additionalData: object;
-    stores: StoreVariantLocation[];
-}
-interface VariantLocationResponse {
-    data: VariantLocation;
-    meta: OmnichannelMeta;
-}
-interface FiltersAddressParams {
-    address: string;
-    radius: number;
-}
-interface FiltersCoordinatesParams {
-    geoPoint: GeoPoint;
-    radius: number;
-}
-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, StoreLocatorConfig as S, VariantLocation as V, OpeningTimeException as a, StoreImage as b, StoreAddress as c, StoreItemVariant as d, StoreItem as e, OpeningTimes as f, Store as g, StoreWithProperty as h, OmnichannelMeta as i, OmnichannelLinks as j, StoreLocation as k, StoreLocationResponse as l, StoreVariantLocation as m, StoreAvailabilityCheck as n, StoreAvailabilityCheckResponse as o, VariantLocationResponse as p, FiltersCoordinatesParams as q, StoreLocatorSearchParams as r, VariantLocatorSearchParams as s, FetchStoresForVariantParams as t, FetchStoreVariantByIdParams as u };

package/dist/shared/omnichannel-nuxt.270bfbda.d.ts

@@ -1,163 +0,0 @@
-interface StoreLocatorConfig {
-    token: string;
-    host: string;
-    companyId?: number;
-    googleApiKey?: string;
-}
-interface GeoPoint {
-    lat: number;
-    lng: number;
-}
-interface OpeningTimeInterval {
-    timeFrom: string;
-    timeUntil: string;
-}
-interface OpeningTimeException {
-    exceptionDate: string;
-    exceptionName: string;
-    exceptionType: 'open' | 'closed';
-    timeFrom: string;
-    timeUntil: string;
-}
-interface StoreImage {
-    id: number;
-    name: string;
-    damKey: string;
-    url: string;
-    customData: object;
-}
-interface StoreAddress {
-    street: string;
-    houseNumber: string;
-    zipCode: string;
-    city: string;
-    countryCode: string;
-}
-interface StoreItemVariant {
-    variantId: number;
-    variantReferenceKey: string;
-    quantity: number;
-}
-interface StoreItem {
-    productId: number;
-    productReferenceKey: string;
-    name: object;
-    image: string;
-    variants: StoreItemVariant[];
-}
-interface OpeningTimes {
-    mon: OpeningTimeInterval[];
-    tue: OpeningTimeInterval[];
-    wed: OpeningTimeInterval[];
-    thu: OpeningTimeInterval[];
-    fri: OpeningTimeInterval[];
-    sat: OpeningTimeInterval[];
-    sun: OpeningTimeInterval[];
-    exceptions: OpeningTimeException[];
-    currentlyOpen: boolean;
-    minutesUntilClosed: number;
-}
-interface Store {
-    id: number;
-    referenceKey: string;
-    name: string;
-    email: string;
-    address: StoreAddress;
-    openingTimes?: OpeningTimes;
-    geoPoint: GeoPoint;
-    customData?: object;
-    settings?: {
-        shipFromStore: boolean;
-        clickAndCollect: boolean;
-    };
-    isActive: boolean;
-    images?: StoreImage;
-}
-type StoreWithProperty = 'openingTimes' | 'customData' | 'images' | 'settings';
-interface OmnichannelMeta {
-    path: string;
-    currentPage: number;
-    lastPage: number;
-    from: number;
-    to: number;
-    perPage: number;
-    total: number;
-    firstPageUrl: string;
-    lastPageUrl: string;
-    prevPageUrl: string | null;
-    nextPageUrl: string | null;
-}
-interface OmnichannelLinks {
-    first: string | null;
-    last: string | null;
-    prev: string | null;
-    next: string | null;
-}
-interface StoreLocation extends Store {
-    distance: number;
-}
-interface StoreLocationResponse {
-    data: StoreLocation[];
-    meta: {
-        searchAddress: GeoPoint;
-    };
-}
-interface StoreVariantLocation extends StoreLocation {
-    quantity: number;
-}
-interface StoreAvailabilityCheck extends Store {
-    items: StoreItem[];
-}
-interface StoreAvailabilityCheckResponse {
-    data: StoreAvailabilityCheck;
-    meta: OmnichannelMeta;
-}
-interface VariantLocation {
-    name: object;
-    productId: number;
-    variantId: number;
-    productReferenceKey: string;
-    variantReferenceKey: string;
-    image: string;
-    additionalData: object;
-    stores: StoreVariantLocation[];
-}
-interface VariantLocationResponse {
-    data: VariantLocation;
-    meta: OmnichannelMeta;
-}
-interface FiltersAddressParams {
-    address: string;
-    radius: number;
-}
-interface FiltersCoordinatesParams {
-    geoPoint: GeoPoint;
-    radius: number;
-}
-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, StoreLocatorConfig as S, VariantLocation as V, OpeningTimeException as a, StoreImage as b, StoreAddress as c, StoreItemVariant as d, StoreItem as e, OpeningTimes as f, Store as g, StoreWithProperty as h, OmnichannelMeta as i, OmnichannelLinks as j, StoreLocation as k, StoreLocationResponse as l, StoreVariantLocation as m, StoreAvailabilityCheck as n, StoreAvailabilityCheckResponse as o, VariantLocationResponse as p, FiltersCoordinatesParams as q, StoreLocatorSearchParams as r, VariantLocatorSearchParams as s, FetchStoresForVariantParams as t, FetchStoreVariantByIdParams as u };