@scayle/storefront-nuxt 8.11.11 → 8.12.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scayle/storefront-nuxt
 
+## 8.12.0
+
+### Minor Changes
+
+- `OrderItem` and `Order` now accept generics: Both `OrderItem` and `Order` interfaces now accept generic type parameters for `Product` and `Variant`. Previously, these were implicitly typed as `Record<string, unknown>`. This change allows to strongly type the `product` and `variant` data within orders and order items, leading to better type checking and potentially fewer runtime errors. This allows for compile-time checks and autocompletion when working with `product` and `variant` properties of `OrderItem` and items property of `Order`.
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-core@8.14.0
+
 ## 8.11.11
 
 ### Patch Changes

package/dist/module.json

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

package/dist/module.mjs

@@ -53,7 +53,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.11.11";
+const PACKAGE_VERSION = "8.12.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {

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

@@ -28,7 +28,7 @@ declare const _default: import("h3").EventHandler<import("h3").EventHandlerReque
 } | import("@scayle/storefront-api").Category | {
     categories: import("@scayle/storefront-api").Category;
     activeNode: import("@scayle/storefront-api").Category;
-} | import("@scayle/storefront-core").Order | import("@scayle/storefront-api").SearchV2SuggestionsEndpointResponseData | import("@scayle/storefront-api").SearchEntity | import("@scayle/storefront-api").ShopConfiguration | {
+} | import("@scayle/storefront-core").Order<Record<string, unknown>, Record<string, unknown>> | 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-core").ShopUserAddress[] | import("@scayle/storefront-api").NavigationAllEndpointResponseData | import("@scayle/storefront-api").NavigationTree | {
     success: true;

package/dist/runtime/composables/storefront/useOrder.d.ts

@@ -2,11 +2,6 @@ import type { RpcMethodParameters, Order } from '@scayle/storefront-core';
 import type { AsyncDataOptions } from 'nuxt/app';
 import { type KeysOf, type ExtendedAsyncData } from '../core/useRpc.js';
 import type { MaybeRefOrGetter } from 'vue';
-type ItemsType = Exclude<Order['items'], undefined>;
-type NewItemsType<P, V> = Exclude<ItemsType[number], 'product' | 'variant'> & {
-    product: P;
-    variant: V;
-};
 /**
  * Retrieves order data by ID using the `getOrderById` RPC method.
  *
@@ -19,7 +14,7 @@ type NewItemsType<P, V> = Exclude<ItemsType[number], 'product' | 'variant'> & {
  *
  * @template P The type of the `product` property within the order items. Defaults to an object with any keys.
  * @template V The type of the `variant` property within the order items. Defaults to an object with any keys.
- * @template DataT The type of the transformed data. Defaults to `Order & { items?: NewItemsType<P, V>[] }`.
+ * @template DataT The type of the transformed data. Defaults to `Order<P, V>`.
  * @template PickKeys  Keys of the `DataT` type that will be present. This defaults to all keys of DataT.
  * @template DefaultT The default return type. Useful for showing loading skeletons. Defaults to `null`.
  *
@@ -30,18 +25,7 @@ type NewItemsType<P, V> = Exclude<ItemsType[number], 'product' | 'variant'> & {
  *
  * @returns An extended async data object containing the order data.
  */
-export declare function useOrder<P = {
-    [k: string]: unknown;
-}, V = {
-    [k: string]: unknown;
-}, DataT = Order & {
-    items?: NewItemsType<P, V>[];
-}, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null>({ params, options }?: {
+export declare function useOrder<P = Record<string, unknown>, V = Record<string, unknown>, DataT = Order<P, V>, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null>({ params, options, }?: {
     params?: MaybeRefOrGetter<RpcMethodParameters<'getOrderById'>>;
-    options?: AsyncDataOptions<Order & {
-        items?: NewItemsType<P, V>[];
-    }, DataT, PickKeys, DefaultT>;
-}, key?: string): ExtendedAsyncData<Order & {
-    items?: NewItemsType<P, V>[];
-}, unknown, DataT, PickKeys, DefaultT>;
-export {};
+    options?: AsyncDataOptions<Order<P, V>, DataT, PickKeys, DefaultT>;
+}, key?: string): ExtendedAsyncData<Order<P, V>, unknown, DataT, PickKeys, DefaultT>;

package/dist/runtime/composables/storefront/useOrder.js

@@ -1,5 +1,8 @@
 import { useRpc } from "../core/useRpc.js";
-export function useOrder({ params, options } = {}, key = "useOrder") {
+export function useOrder({
+  params,
+  options
+} = {}, key = "useOrder") {
   return useRpc(
     "getOrderById",
     key,

package/dist/runtime/composables/storefront/useOrderConfirmation.d.ts

@@ -2,11 +2,6 @@ import type { RpcMethodParameters, Order } from '@scayle/storefront-core';
 import type { AsyncDataOptions } from 'nuxt/app';
 import type { ExtendedAsyncData, KeysOf } from '../core/useRpc.js';
 import type { MaybeRefOrGetter } from 'vue';
-type ItemsType = Exclude<Order['items'], undefined>;
-type NewItemsType<P, V> = Exclude<ItemsType[number], 'product' | 'variant'> & {
-    product: P;
-    variant: V;
-};
 /**
  * Retrieves order data by ID using the `getOrderDataByCbd RPC method.
  *
@@ -17,7 +12,7 @@ type NewItemsType<P, V> = Exclude<ItemsType[number], 'product' | 'variant'> & {
  *
  * @template P The type of the `product` property within the order items. Defaults to an object with any keys.
  * @template V The type of the `variant` property within the order items. Defaults to an object with any keys.
- * @template DataT The type of the transformed data. Defaults to `Order & { items?: NewItemsType<P, V>[] }`.
+ * @template DataT The type of the transformed data. Defaults to `Order<P, V>`.
  * @template PickKeys  Keys of the `DataT` type that will be present. This defaults to all keys of DataT.
  * @template DefaultT The default return type. Useful for showing loading skeletons. Defaults to `null`.
  *
@@ -28,18 +23,7 @@ type NewItemsType<P, V> = Exclude<ItemsType[number], 'product' | 'variant'> & {
  *
  * @returns An extended async data object containing the order data.
  */
-export declare function useOrderConfirmation<P = {
-    [k: string]: unknown;
-}, V = {
-    [k: string]: unknown;
-}, DataT = Order & {
-    items?: NewItemsType<P, V>[];
-}, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null>({ params, options }?: {
+export declare function useOrderConfirmation<P = Record<string, unknown>, V = Record<string, unknown>, DataT = Order<P, V>, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null>({ params, options, }?: {
     params?: MaybeRefOrGetter<RpcMethodParameters<'getOrderDataByCbd'>>;
-    options?: AsyncDataOptions<Order & {
-        items?: NewItemsType<P, V>[];
-    }, DataT, PickKeys, DefaultT>;
-}, key?: string): ExtendedAsyncData<Order & {
-    items?: NewItemsType<P, V>[];
-}, unknown, DataT, PickKeys, DefaultT>;
-export {};
+    options?: AsyncDataOptions<Order<P, V>, DataT, PickKeys, DefaultT>;
+}, key?: string): ExtendedAsyncData<Order<P, V>, unknown, DataT, PickKeys, DefaultT>;

package/dist/runtime/composables/storefront/useOrderConfirmation.js

@@ -1,5 +1,8 @@
 import { useRpc } from "../core/useRpc.js";
-export function useOrderConfirmation({ params, options } = {}, key = "useOrderConfirmation") {
+export function useOrderConfirmation({
+  params,
+  options
+} = {}, key = "useOrderConfirmation") {
   return useRpc(
     "getOrderDataByCbd",
     key,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.11.11",
+  "version": "8.12.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -78,7 +78,7 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "0.6.0",
-    "@scayle/storefront-core": "8.13.0",
+    "@scayle/storefront-core": "8.14.0",
     "@scayle/unstorage-compression-driver": "^0.2.4",
     "@vercel/nft": "0.29.2",
     "@vueuse/core": "13.0.0",