@scayle/storefront-nuxt 7.92.0 → 7.94.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @scayle/storefront-nuxt
 
+## 7.94.0
+
+### Minor Changes
+
+- Move `vitest` to dev dependencies
+
+### Patch Changes
+
+- Removed dependency `vitest@2.1.4`
+- Add `useNavigationTreeById` and `useNavigationTreeByName` to the list of keyed composables
+
+## 7.93.0
+
+### Minor Changes
+
+- Test factories are now exported via package source root (`./src/index.ts`).
+  Now, all test factories can be imported as follows:
+
+  ```ts
+  import { categoryFactory } from '@scayle/storefront-nuxt'
+  ```
+
+- Add `product`, `variant`, `price`, `attribute` and `route` test factories.
+
+### Patch Changes
+
+- Added dependency `vitest@2.1.4`
+
 ## 7.92.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -1,15 +1,44 @@
-export { e as AdditionalShopConfig, A as AppKeys, B as BapiConfig, i as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, j as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, d as SapiConfig, a as SessionConfig, f as ShopConfig, g as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, h as StorefrontConfig } from './shared/storefront-nuxt.80aa5060.mjs';
+import { M as ModuleBaseOptions, f as ShopConfig } from './shared/storefront-nuxt.80aa5060.mjs';
+export { e as AdditionalShopConfig, A as AppKeys, B as BapiConfig, i as CheckoutEvent, C as CheckoutShopConfig, j as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, d as SapiConfig, a as SessionConfig, g as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, h as StorefrontConfig } from './shared/storefront-nuxt.80aa5060.mjs';
 export { rpcCall } from '../dist/runtime/rpc/rpcCall.js';
 export { extendPromise } from '../dist/runtime/utils/promise.js';
 export * from '../dist/runtime/utils/seo.js';
+import { Category, Product, Variant, AttributeGroup, AdvancedAttribute, Price, RpcContext } from '@scayle/storefront-core';
 export * from '@scayle/storefront-core';
 export { LogLevel } from '@scayle/storefront-core';
+import { Factory } from 'fishery';
+import { RouteLocationNormalizedLoadedGeneric } from 'vue-router';
 export { unwrap } from '@scayle/storefront-core/dist/utils/response';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 import '../dist/runtime/utils/zodSchema.js';
 import '@nuxt/schema';
 
+declare const categoryFactory: Factory<Category, any, Category>;
+
+declare const productFactory: Factory<Product, any, Product>;
+
+declare const variantFactory: Factory<Variant, any, Variant>;
+
+declare const attributeGroupFactory: Factory<AttributeGroup, any, AttributeGroup>;
+declare const advancedAttributeFactory: Factory<AdvancedAttribute, any, AdvancedAttribute>;
+
+declare const priceFactory: Factory<Price, any, Price>;
+
+interface ModuleOptionsFactoryParams {
+    shops: ShopConfig[];
+}
+declare const moduleOptionsFactory: Factory<ModuleBaseOptions, ModuleOptionsFactoryParams, ModuleBaseOptions>;
+
+declare const shopConfigFactory: Factory<ShopConfig, any, ShopConfig>;
+
+interface RpcContextFactoryParams {
+    isLoggedIn: boolean;
+}
+declare const rpcContextFactory: Factory<RpcContext, RpcContextFactoryParams, RpcContext>;
+
+declare const routeFactory: Factory<RouteLocationNormalizedLoadedGeneric, any, RouteLocationNormalizedLoadedGeneric>;
+
 interface RpcMethodsStorefront {
 }
 declare module '@scayle/storefront-core' {
@@ -17,4 +46,4 @@ declare module '@scayle/storefront-core' {
     }
 }
 
-export type { RpcMethodsStorefront };
+export { ModuleBaseOptions, type RpcMethodsStorefront, ShopConfig, advancedAttributeFactory, attributeGroupFactory, categoryFactory, moduleOptionsFactory, priceFactory, productFactory, routeFactory, rpcContextFactory, shopConfigFactory, variantFactory };

package/dist/index.d.ts

@@ -1,15 +1,44 @@
-export { e as AdditionalShopConfig, A as AppKeys, B as BapiConfig, i as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, j as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, d as SapiConfig, a as SessionConfig, f as ShopConfig, g as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, h as StorefrontConfig } from './shared/storefront-nuxt.80aa5060.js';
+import { M as ModuleBaseOptions, f as ShopConfig } from './shared/storefront-nuxt.80aa5060.js';
+export { e as AdditionalShopConfig, A as AppKeys, B as BapiConfig, i as CheckoutEvent, C as CheckoutShopConfig, j as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, d as SapiConfig, a as SessionConfig, g as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, h as StorefrontConfig } from './shared/storefront-nuxt.80aa5060.js';
 export { rpcCall } from '../dist/runtime/rpc/rpcCall.js';
 export { extendPromise } from '../dist/runtime/utils/promise.js';
 export * from '../dist/runtime/utils/seo.js';
+import { Category, Product, Variant, AttributeGroup, AdvancedAttribute, Price, RpcContext } from '@scayle/storefront-core';
 export * from '@scayle/storefront-core';
 export { LogLevel } from '@scayle/storefront-core';
+import { Factory } from 'fishery';
+import { RouteLocationNormalizedLoadedGeneric } from 'vue-router';
 export { unwrap } from '@scayle/storefront-core/dist/utils/response';
 import '@scayle/unstorage-compression-driver';
 import 'unstorage';
 import '../dist/runtime/utils/zodSchema.js';
 import '@nuxt/schema';
 
+declare const categoryFactory: Factory<Category, any, Category>;
+
+declare const productFactory: Factory<Product, any, Product>;
+
+declare const variantFactory: Factory<Variant, any, Variant>;
+
+declare const attributeGroupFactory: Factory<AttributeGroup, any, AttributeGroup>;
+declare const advancedAttributeFactory: Factory<AdvancedAttribute, any, AdvancedAttribute>;
+
+declare const priceFactory: Factory<Price, any, Price>;
+
+interface ModuleOptionsFactoryParams {
+    shops: ShopConfig[];
+}
+declare const moduleOptionsFactory: Factory<ModuleBaseOptions, ModuleOptionsFactoryParams, ModuleBaseOptions>;
+
+declare const shopConfigFactory: Factory<ShopConfig, any, ShopConfig>;
+
+interface RpcContextFactoryParams {
+    isLoggedIn: boolean;
+}
+declare const rpcContextFactory: Factory<RpcContext, RpcContextFactoryParams, RpcContext>;
+
+declare const routeFactory: Factory<RouteLocationNormalizedLoadedGeneric, any, RouteLocationNormalizedLoadedGeneric>;
+
 interface RpcMethodsStorefront {
 }
 declare module '@scayle/storefront-core' {
@@ -17,4 +46,4 @@ declare module '@scayle/storefront-core' {
     }
 }
 
-export type { RpcMethodsStorefront };
+export { ModuleBaseOptions, type RpcMethodsStorefront, ShopConfig, advancedAttributeFactory, attributeGroupFactory, categoryFactory, moduleOptionsFactory, priceFactory, productFactory, routeFactory, rpcContextFactory, shopConfigFactory, variantFactory };

package/dist/index.mjs

@@ -1,5 +1,245 @@
 export { rpcCall } from '../dist/runtime/rpc/rpcCall.js';
 export { extendPromise } from '../dist/runtime/utils/promise.js';
 export * from '../dist/runtime/utils/seo.js';
+import { HashAlgorithm, StorefrontAPIClient, Log } from '@scayle/storefront-core';
 export * from '@scayle/storefront-core';
 export { unwrap } from '@scayle/storefront-core/dist/utils/response';
+import { Factory } from 'fishery';
+
+const categoryFactory = Factory.define(() => {
+  return {
+    id: 1,
+    path: "/women",
+    name: "women",
+    slug: "test",
+    parentId: 2048,
+    rootlineIds: [2045, 2048, 2058],
+    childrenIds: [],
+    properties: [],
+    isHidden: false,
+    depth: 3,
+    supportedFilter: ["color", "brand", "size"],
+    shopLevelCustomData: {},
+    countryLevelCustomData: {}
+  };
+});
+
+const attributeGroupFactory = Factory.define(() => {
+  return {
+    id: 1,
+    key: "name",
+    label: "Test Attribute",
+    type: null,
+    multiSelect: false,
+    values: {
+      label: "Test Attribute"
+    }
+  };
+});
+const advancedAttributeFactory = Factory.define(
+  () => ({
+    id: 553,
+    key: "productName",
+    label: "Produktname",
+    type: "",
+    values: [
+      {
+        fieldSet: [[{ value: "Jacke 'Premium Essentials'" }]],
+        groupSet: []
+      }
+    ]
+  })
+);
+
+const priceFactory = Factory.define(() => {
+  return {
+    currencyCode: "USD",
+    tax: { vat: { amount: 1, rate: 0 } },
+    withoutTax: 2,
+    withTax: 100,
+    appliedReductions: []
+  };
+});
+
+const variantFactory = Factory.define(() => ({
+  id: 1,
+  lowestPriorPrice: {
+    withTax: 23,
+    relativeDifferenceToPrice: null
+  },
+  stock: { warehouseId: 1, quantity: 2 },
+  createdAt: "",
+  updatedAt: "",
+  price: priceFactory.build()
+}));
+
+const productFactory = Factory.define((options) => {
+  const attributes = {
+    name: attributeGroupFactory.build({
+      key: "name",
+      label: "Test Product",
+      values: {
+        label: "Test Product"
+      }
+    }),
+    brand: attributeGroupFactory.build({
+      key: "brand",
+      label: "Brand",
+      type: "string",
+      values: {
+        label: "Brand Name",
+        id: 101,
+        value: "brand-name"
+      }
+    }),
+    color: attributeGroupFactory.build({
+      key: "color",
+      label: "Color",
+      type: "",
+      values: {
+        id: 6,
+        label: "Wei\xDF",
+        value: "weiss"
+      }
+    })
+  };
+  return {
+    id: 1,
+    attributes: options.params.attributes ?? attributes,
+    isActive: true,
+    isSoldOut: false,
+    isNew: false,
+    createdAt: "",
+    updatedAt: "",
+    images: [{ hash: "test image" }],
+    siblings: [
+      {
+        id: 5,
+        attributes: options.params.attributes ?? attributes,
+        isActive: true,
+        isSoldOut: false,
+        isNew: false,
+        createdAt: "",
+        updatedAt: "",
+        images: []
+      }
+    ],
+    variants: [
+      variantFactory.build({ id: 1 }),
+      variantFactory.build({ id: 2 })
+    ]
+  };
+});
+
+const moduleOptionsFactory = Factory.define(({ transientParams }) => {
+  return {
+    sapi: {
+      host: "sapiHost",
+      token: "sapiToken"
+    },
+    oauth: {
+      apiHost: "oauthHost",
+      clientId: "clientId",
+      clientSecret: "clientSecret"
+    },
+    appKeys: {
+      basketKey: "basketKey",
+      wishlistKey: "wishlistKey",
+      hashAlgorithm: HashAlgorithm.MD5
+    },
+    shopSelector: "path",
+    shops: (transientParams?.shops || []).reduce((acc, curr) => {
+      return {
+        [curr.shopId]: curr,
+        ...acc
+      };
+    }, {})
+  };
+});
+
+const shopConfigFactory = Factory.define(() => {
+  return {
+    shopId: 1,
+    domain: "localhost",
+    locale: "en-US",
+    currency: "USD",
+    checkout: {
+      host: "checkoutHost",
+      secret: "checkoutSecret",
+      token: "checkoutToken",
+      user: "checkoutUser"
+    },
+    auth: {
+      resetPasswordUrl: "resetPasswordUrl"
+    },
+    paymentProviders: []
+  };
+});
+
+const rpcContextFactory = Factory.define(({ transientParams }) => {
+  return {
+    locale: "de",
+    checkout: {
+      url: "",
+      token: "",
+      secret: "",
+      user: ""
+    },
+    bapiClient: new StorefrontAPIClient({ host: "", shopId: 1001 }),
+    sapiClient: new StorefrontAPIClient({ host: "", shopId: 1001 }),
+    cached: (fn, _options) => {
+      return async (...args) => {
+        return await fn(...args);
+      };
+    },
+    isCmsPreview: false,
+    shopId: 1001,
+    domain: "localhost",
+    destroySessionsForUserId: () => Promise.resolve(),
+    generateBasketKeyForUserId: (userId) => Promise.resolve(`basket-${userId}`),
+    generateWishlistKeyForUserId: (userId) => Promise.resolve(`wishlist-${userId}`),
+    log: new Log(),
+    auth: {},
+    runtimeConfiguration: {},
+    headers: new Headers(),
+    ...transientParams.isLoggedIn ? {
+      wishlistKey: "wishlistKey",
+      basketKey: "basketKey",
+      sessionId: "sessionId",
+      user: void 0,
+      accessToken: void 0,
+      refreshToken: void 0,
+      destroySession: () => Promise.resolve(),
+      createUserBoundSession: () => Promise.resolve(),
+      updateUser: () => Promise.resolve(),
+      updateTokens: () => Promise.resolve()
+    } : {
+      wishlistKey: void 0,
+      basketKey: void 0,
+      sessionId: void 0,
+      user: void 0,
+      accessToken: void 0,
+      refreshToken: void 0,
+      destroySession: void 0,
+      createUserBoundSession: void 0,
+      updateUser: void 0,
+      updateTokens: void 0
+    }
+  };
+});
+
+const routeFactory = Factory.define(
+  () => ({
+    name: "test",
+    params: {},
+    matched: [],
+    path: "/test",
+    fullPath: "/test",
+    redirectedFrom: void 0,
+    hash: "",
+    meta: { test: "" },
+    query: {}
+  })
+);
+
+export { advancedAttributeFactory, attributeGroupFactory, categoryFactory, moduleOptionsFactory, priceFactory, productFactory, routeFactory, rpcContextFactory, shopConfigFactory, variantFactory };

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "7.92.0",
+  "version": "7.94.0",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"

package/dist/module.mjs

@@ -48,7 +48,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "7.92.0";
+const PACKAGE_VERSION = "7.94.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {
@@ -322,6 +322,8 @@ Missing RPC Overrides: ${Array.from(overridenRPCMethodNames).map((name) => `'${n
       "useFilters",
       "useIDP",
       "useNavigationTree",
+      "useNavigationTreeById",
+      "useNavigationTreeByName",
       "useNavigationTrees",
       "useOrder",
       "useOrderConfirmation",

package/dist/runtime/api/rpcHandler.d.ts

@@ -1,4 +1,4 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string | true | string[] | import("@scayle/storefront-core").ShopUser | Response | import("@scayle/storefront-api").Product | import("@scayle/storefront-api").Product[] | {
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string | true | import("@scayle/storefront-core").ShopUser | string[] | import("@scayle/storefront-api").Product | import("@scayle/storefront-api").Product[] | {
     count: number;
 } | {
     filters: import("@scayle/storefront-api").FiltersEndpointResponseData;
@@ -34,7 +34,7 @@ declare const _default: import("h3").EventHandler<import("h3").EventHandlerReque
     activeNode: import("@scayle/storefront-api").Category;
 } | import("@scayle/storefront-core").Order | import("@scayle/storefront-api").TypeaheadSuggestionsEndpointResponseData | import("@scayle/storefront-api").SearchV2SuggestionsEndpointResponseData | import("@scayle/storefront-api").SearchEntity | import("@scayle/storefront-api").ShopConfiguration | {
     user: import("@scayle/storefront-core").ShopUser | undefined;
-} | import("@scayle/storefront-api").Wishlist | import("@scayle/storefront-core").ShopUserAddress[] | {
+} | import("@scayle/storefront-api").Wishlist | Response | import("@scayle/storefront-core").ShopUserAddress[] | {
     accessToken: string;
     checkoutJwt: string;
 } | import("@scayle/storefront-api").VariantDetail[] | import("@scayle/storefront-api").NavigationAllEndpointResponseData | import("@scayle/storefront-api").NavigationTree | {

package/dist/runtime/plugin/shop.d.ts

@@ -1,8 +1,8 @@
 declare const _default: import("nuxt/app").Plugin<{
-    currentShop: import("../..").PublicShopConfig;
-    availableShops: import("../..").PublicShopConfig[];
+    currentShop: import("../../module").PublicShopConfig;
+    availableShops: import("../../module").PublicShopConfig[];
 }> & import("nuxt/app").ObjectPlugin<{
-    currentShop: import("../..").PublicShopConfig;
-    availableShops: import("../..").PublicShopConfig[];
+    currentShop: import("../../module").PublicShopConfig;
+    availableShops: import("../../module").PublicShopConfig[];
 }>;
 export default _default;