@scayle/omnichannel-nuxt 4.1.0 → 4.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scayle/omnichannel-nuxt
 
+## 4.3.0
+
+### Minor Changes
+
+- Update to `@nuxt/module-builder@1`. This version of Nuxt Module Builder is ESM-only, so CommonJS (`.cjs`) files will no longer be built or distributed with the package. However as of Nuxt 3, only esm is used so this should not have any impact as this module does not support Nuxt 2.
+
+## 4.2.0
+
+### Minor Changes
+
+- Remove explicit inline external for runtime helpers
+
 ## 4.1.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { ValuesType } from 'utility-types';
+export * from '../dist/runtime/types/index.js';
 
 declare const OpeningTime: {
     readonly MONDAY: "mon";
@@ -11,158 +12,4 @@ declare const OpeningTime: {
 };
 type OpeningTime = ValuesType<typeof 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 FetchStoreVariantByIdParams {
-    storeId: number;
-    variantId: number;
-    with?: StoreWithProperty[];
-}
-
-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 };
+export { OpeningTime };

package/dist/index.mjs

@@ -1,3 +1,5 @@
+export * from '../dist/runtime/types/index.js';
+
 const OpeningTime = {
   MONDAY: "mon",
   TUESDAY: "tue",

package/dist/module.json

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

package/dist/module.mjs

@@ -1,7 +1,7 @@
 import { defineNuxtModule, isNuxtMajorVersion, createResolver, addImportsDir } from '@nuxt/kit';
 
 const PACKAGE_NAME = "@scayle/omnichannel-nuxt";
-const PACKAGE_VERSION = "4.1.0";
+const PACKAGE_VERSION = "4.3.0";
 const module = defineNuxtModule({
   meta: {
     name: PACKAGE_NAME,
@@ -25,11 +25,6 @@ const module = defineNuxtModule({
           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/lib/init"));
-      });
       nuxt.options.alias["#omnichannel/composables"] = resolve(
         "./runtime/composables"
       );

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

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

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-import type { StoreLocationResponse, StoreLocatorConfig, StoreLocatorSearchParams, StoreAvailabilityCheckResponse, VariantLocationResponse, VariantLocatorSearchParams, FetchStoreVariantByIdParams } from '../../types/index.js';
+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

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

@@ -1,5 +1,5 @@
 import type { RpcContext } from '@scayle/storefront-nuxt';
-import type { StoreLocatorSearchParams, VariantLocatorSearchParams, FetchStoreVariantByIdParams, VariantLocationResponse, StoreAvailabilityCheckResponse, StoreLocationResponse } from '../../types/index.js';
+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/{index.d.ts → runtime/types/index.d.ts}

@@ -1,65 +1,52 @@
-import { ValuesType } from 'utility-types';
-
-declare const OpeningTime: {
-    readonly MONDAY: "mon";
-    readonly TUESDAY: "tue";
-    readonly WEDNESDAY: "wed";
-    readonly THURSDAY: "thu";
-    readonly FRIDAY: "fri";
-    readonly SATURDAY: "sat";
-    readonly SUNDAY: "sun";
-};
-type OpeningTime = ValuesType<typeof OpeningTime>;
-
-interface StoreLocatorConfig {
+export interface StoreLocatorConfig {
     token: string;
     host: string;
     companyId?: number;
     googleApiKey?: string;
     additionalHeaders?: HeadersInit;
 }
-interface GeoPoint {
+export interface GeoPoint {
     lat: number;
     lng: number;
 }
-interface OpeningTimeInterval {
+export interface OpeningTimeInterval {
     timeFrom: string;
     timeUntil: string;
 }
-interface OpeningTimeException {
+export interface OpeningTimeException {
     exceptionDate: string;
     exceptionName: string;
     exceptionType: 'open' | 'closed';
     timeFrom: string;
     timeUntil: string;
 }
-interface StoreImage {
+export interface StoreImage {
     id: number;
     name: string;
     damKey: string;
     url: string;
     customData: object;
 }
-interface StoreAddress {
+export interface StoreAddress {
     street: string;
     houseNumber: string;
     zipCode: string;
     city: string;
     countryCode: string;
 }
-interface StoreItemVariant {
+export interface StoreItemVariant {
     variantId: number;
     variantReferenceKey: string;
     quantity: number;
 }
-interface StoreItem {
+export interface StoreItem {
     productId: number;
     productReferenceKey: string;
     name: object;
     image: string;
     variants: StoreItemVariant[];
 }
-interface OpeningTimes {
+export interface OpeningTimes {
     mon: OpeningTimeInterval[];
     tue: OpeningTimeInterval[];
     wed: OpeningTimeInterval[];
@@ -71,7 +58,7 @@ interface OpeningTimes {
     currentlyOpen: boolean;
     minutesUntilClosed: number;
 }
-interface Store {
+export interface Store {
     id: number;
     referenceKey: string;
     name: string;
@@ -87,8 +74,8 @@ interface Store {
     isActive: boolean;
     images?: StoreImage;
 }
-type StoreWithProperty = 'openingTimes' | 'customData' | 'images' | 'settings';
-interface OmnichannelMeta {
+export type StoreWithProperty = 'openingTimes' | 'customData' | 'images' | 'settings';
+export interface OmnichannelMeta {
     path: string;
     currentPage: number;
     lastPage: number;
@@ -101,32 +88,32 @@ interface OmnichannelMeta {
     prevPageUrl: string | null;
     nextPageUrl: string | null;
 }
-interface OmnichannelLinks {
+export interface OmnichannelLinks {
     first: string | null;
     last: string | null;
     prev: string | null;
     next: string | null;
 }
-interface StoreLocation extends Store {
+export interface StoreLocation extends Store {
     distance: number;
 }
-interface StoreLocationResponse {
+export interface StoreLocationResponse {
     data: StoreLocation[];
     meta: {
         searchAddress: GeoPoint;
     };
 }
-interface StoreVariantLocation extends StoreLocation {
+export interface StoreVariantLocation extends StoreLocation {
     quantity: number;
 }
-interface StoreAvailabilityCheck extends Store {
+export interface StoreAvailabilityCheck extends Store {
     items: StoreItem[];
 }
-interface StoreAvailabilityCheckResponse {
+export interface StoreAvailabilityCheckResponse {
     data: StoreAvailabilityCheck;
     meta: OmnichannelMeta;
 }
-interface VariantLocation {
+export interface VariantLocation {
     name: object;
     productId: number;
     variantId: number;
@@ -136,33 +123,31 @@ interface VariantLocation {
     additionalData: object;
     stores: StoreVariantLocation[];
 }
-interface VariantLocationResponse {
+export interface VariantLocationResponse {
     data: VariantLocation;
     meta: OmnichannelMeta;
 }
-interface FiltersAddressParams {
+export interface FiltersAddressParams {
     address: string;
     radius: number;
 }
-interface FiltersCoordinatesParams {
+export interface FiltersCoordinatesParams {
     geoPoint: GeoPoint;
     radius: number;
 }
-interface StoreLocatorSearchParams {
+export interface StoreLocatorSearchParams {
     filters: FiltersAddressParams | FiltersCoordinatesParams;
     perPage?: number;
     with?: StoreWithProperty[];
 }
-interface VariantLocatorSearchParams {
+export interface VariantLocatorSearchParams {
     variantId: number;
     filters: FiltersAddressParams | FiltersCoordinatesParams;
     perPage?: number;
     with?: StoreWithProperty[];
 }
-interface FetchStoreVariantByIdParams {
+export interface FetchStoreVariantByIdParams {
     storeId: number;
     variantId: number;
     with?: StoreWithProperty[];
 }
-
-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/types.d.mts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/omnichannel-nuxt",
-  "version": "4.1.0",
+  "version": "4.3.0",
   "description": "Collection of essential utilities to work with omnichannel",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -11,13 +11,16 @@
   "website": "https://scayle.dev/en/extensions/omnichannel/user-guide",
   "exports": {
     "./module": {
-      "types": "./dist/module.d.ts",
-      "require": "./dist/module.cjs",
+      "types": "./dist/module.d.mts",
       "import": "./dist/module.mjs"
     },
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/index.d.mts",
       "import": "./dist/index.mjs"
+    },
+    "./composables": {
+      "types": "./dist/runtime/composables/index.d.ts",
+      "import": "./dist/runtime/composables/index.js"
     }
   },
   "imports": {
@@ -25,7 +28,6 @@
   },
   "main": "./dist/index.mjs",
   "type": "module",
-  "types": "./dist/index.d.ts",
   "files": [
     "CHANGELOG.md",
     "dist/**"
@@ -44,9 +46,11 @@
     "prep": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
     "format": "dprint check",
     "format:fix": "dprint fmt",
-    "lint": "eslint . --format gitlab",
+    "lint": "eslint .",
+    "lint:ci": "eslint . --format gitlab",
     "lint:fix": "eslint . --fix",
     "package:lint": "publint",
+    "verify-packaging": "attw --pack . --profile esm-only",
     "typecheck": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
     "test": "vitest --run --passWithNoTests",
     "test:watch": "vitest --passWithNoTests",
@@ -61,24 +65,27 @@
     "utility-types": "^3.11.0"
   },
   "devDependencies": {
-    "@nuxt/eslint": "1.0.1",
-    "@nuxt/module-builder": "0.8.4",
-    "@nuxt/schema": "3.14.1592",
-    "@scayle/eslint-config-storefront": "4.4.1",
-    "@scayle/storefront-nuxt": "8.9.1",
-    "@types/node": "22.13.4",
+    "@arethetypeswrong/cli": "0.17.4",
+    "@nuxt/eslint": "1.3.0",
+    "@nuxt/module-builder": "1.0.1",
+    "@nuxt/schema": "3.15.4",
+    "@scayle/eslint-config-storefront": "4.5.0",
+    "@scayle/storefront-nuxt": "8.24.0",
+    "@types/node": "22.14.1",
     "@types/qs": "6.9.18",
-    "dprint": "0.49.0",
-    "eslint": "9.20.1",
+    "dprint": "0.49.1",
     "eslint-formatter-gitlab": "5.1.0",
+    "eslint": "9.24.0",
     "h3": "1.15.0",
-    "nuxi": "3.21.1",
-    "nuxt": "3.14.1592",
-    "typescript": "5.7.3",
-    "vitest": "2.1.9",
-    "vue-tsc": "2.2.0"
+    "nuxi": "3.24.1",
+    "nuxt": "3.15.4",
+    "typescript": "5.8.3",
+    "unbuild": "2.0.0",
+    "vitest": "3.1.1",
+    "vue-tsc": "2.2.8",
+    "vue": "3.5.13"
   },
   "volta": {
-    "node": "22.13.1"
+    "node": "22.14.0"
   }
 }

package/dist/module.cjs

@@ -1,5 +0,0 @@
-module.exports = function(...args) {
-  return import('./module.mjs').then(m => m.default.call(this, ...args))
-}
-const _meta = module.exports.meta = require('./module.json')
-module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.ts

@@ -1,21 +0,0 @@
-import * as _nuxt_schema from '@nuxt/schema';
-
-type ModuleOptions = {
-    token: string;
-    host: string;
-    internalAccessHeader?: string | undefined;
-};
-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/types.d.ts

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