@scayle/storefront-nuxt 7.85.6 → 7.85.8

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @scayle/storefront-nuxt
 
+## 7.85.8
+
+### Patch Changes
+
+- Correct the types of `useOrder` and `useOrderConfirmation`
+  **Dependencies**
+
+- Updated dependency to @scayle/storefront-core@7.65.4
+
+## 7.85.7
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-core@7.65.3
+
 ## 7.85.6
 
 ### Patch Changes

package/README.md

@@ -36,15 +36,16 @@ npm install --save-dev @scayle/storefront-nuxt
 
 ## Getting Started
 
-Visit the [Quickstart Guide](https://scayle.dev/en/dev/storefront-core/getting-started-sfb) to get started with Storefront Nuxt.
+Visit the [Quickstart Guide](https://scayle.dev/en/storefront-guide/developer-guide/getting-started/setup-your-storefront) to get started with Storefront Nuxt.
 
 Visit the [Docs](https://scayle.dev) to learn more about our system requirements.
 
 ## 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.
+[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/dev/getting-started/introduction) and [commerce modules](https://scayle.dev/en/dev/getting-started/introduction) in the Docs.
+Learn more about [SCAYLE’s architecture](https://scayle.dev/en/developer-guide) and commerce modules in the docs.
 
 ## Other channels
 
@@ -53,15 +54,4 @@ Learn more about [Scayle’s architecture](https://scayle.dev/en/dev/getting-sta
 
 ## License
 
-Licensed under the [MIT](https://opensource.org/license/mit/)
-
-<!-- Badges -->
-
-[npm-version-src]: https://img.shields.io/npm/v/@scayle/storefront-nuxt/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
-[npm-version-href]: https://npmjs.com/package/@scayle/storefront-nuxt
-[npm-downloads-src]: https://img.shields.io/npm/dm/@scayle/storefront-nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D
-[npm-downloads-href]: https://npmjs.com/package/@scayle/storefront-nuxt
-[license-src]: https://img.shields.io/npm/l/@scayle/storefront-nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D
-[license-href]: https://npmjs.com/package/@scayle/storefront-nuxt
-[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
-[nuxt-href]: https://nuxt.com
+Licensed under the [MIT License](https://opensource.org/license/mit/)

package/dist/module.json

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

package/dist/module.mjs

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

package/dist/runtime/composables/core/useRpc.d.ts

@@ -13,11 +13,11 @@ export type NormalizedRpcResponse<N extends RpcMethodName> = Exclude<Awaited<Rpc
 /**
  * Extend AsyncDataOptions with autoFetch (deprecated) and lazy (unused)
  */
-export type UseRpcOptions<N extends RpcMethodName, DataT = NormalizedRpcResponse<N>, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null> = RpcOptions & AsyncDataOptions<NormalizedRpcResponse<N>, DataT, PickKeys, DefaultT>;
+export type UseRpcOptions<N extends RpcMethodName, DataT = NormalizedRpcResponse<N>, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null, ResponseT = NormalizedRpcResponse<N>> = RpcOptions & AsyncDataOptions<ResponseT, DataT, PickKeys, DefaultT>;
 /**
  * The return type of a composable based on useRpc
  */
-export type UseRpcReturn<N extends RpcMethodName, DataT = NormalizedRpcResponse<N>, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null> = ExtendedAsyncData<NormalizedRpcResponse<N>, unknown, DataT, PickKeys, DefaultT>;
+export type UseRpcReturn<N extends RpcMethodName, DataT = NormalizedRpcResponse<N>, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null, ResponseT = NormalizedRpcResponse<N>> = ExtendedAsyncData<ResponseT, unknown, DataT, PickKeys, DefaultT>;
 export type Status = 'idle' | 'pending' | 'success' | 'error';
 type AsyncData<ResT, ErrorT = unknown, DataT = ResT, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null> = ReturnType<typeof useAsyncData<ResT, ErrorT, DataT, PickKeys, DefaultT>>;
 type AwaitedAsyncData<ResT, ErrorT = unknown, DataT = ResT, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null> = Awaited<AsyncData<ResT, ErrorT, DataT, PickKeys, DefaultT>>;
@@ -50,5 +50,5 @@ export type ExtendedAsyncData<ResT, ErrorT = unknown, DataT = ResT, PickKeys ext
  * But anything passed here will take precedence.
  * @see {@link https://nuxt.com/docs/api/composables/use-async-data#params}
  */
-export declare function useRpc<N extends RpcMethodName, DataT = NormalizedRpcResponse<N>, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null>(method: N, key: string, params?: MaybeRefOrGetter<RpcMethodParameters<N> extends RpcContext ? undefined : RpcMethodParameters<N>>, options?: UseRpcOptions<N, DataT, PickKeys, DefaultT>): ExtendedAsyncData<NormalizedRpcResponse<N>, unknown, DataT, PickKeys, DefaultT>;
+export declare function useRpc<N extends RpcMethodName, DataT = NormalizedRpcResponse<N>, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null, ResponseT = NormalizedRpcResponse<N>>(method: N, key: string, params?: MaybeRefOrGetter<RpcMethodParameters<N> extends RpcContext ? undefined : RpcMethodParameters<N>>, options?: UseRpcOptions<N, DataT, PickKeys, DefaultT, ResponseT>): ExtendedAsyncData<ResponseT, unknown, DataT, PickKeys, DefaultT>;
 export {};

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

@@ -1,25 +1,26 @@
 import type { RpcMethodParameters, Order } from '@scayle/storefront-core';
-import { type RpcOptions, type UseRpcReturn } from '../core/useRpc';
-import type { Ref, MaybeRefOrGetter } from 'vue';
-type Options = Partial<{
-    params: MaybeRefOrGetter<RpcMethodParameters<'getOrderById'>>;
-    options: RpcOptions;
-    /** @deprecated use the second argument of the composable to define the key */
-    key: string;
-}>;
+import type { AsyncDataOptions } from 'nuxt/app';
+import { type RpcOptions, type KeysOf, type ExtendedAsyncData } from '../core/useRpc';
+import type { MaybeRefOrGetter } from 'vue';
 type ItemsType = Exclude<Order['items'], undefined>;
 type NewItemsType<P, V> = Exclude<ItemsType[number], 'product' | 'variant'> & {
     product: P;
     variant: V;
 };
-type UserOrderBaseReturn<P, V> = Pick<Awaited<UseRpcReturn<'getOrderById'>>, 'error' | 'status' | 'fetch' | 'fetching' | 'refresh'> & {
-    data: Ref<Order & {
-        items?: NewItemsType<P, V>[];
-    }>;
-};
 export declare function useOrder<P = {
     [k: string]: unknown;
 }, V = {
     [k: string]: unknown;
-}>({ params, options, key: _key }?: Options, key?: string): UserOrderBaseReturn<P, V> & Promise<UserOrderBaseReturn<P, V>>;
+}, DataT = Order & {
+    items?: NewItemsType<P, V>[];
+}, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null>({ params, options, key: _key }?: {
+    params?: MaybeRefOrGetter<RpcMethodParameters<'getOrderById'>>;
+    options?: RpcOptions & AsyncDataOptions<Order & {
+        items?: NewItemsType<P, V>[];
+    }, DataT, PickKeys, DefaultT>;
+    /** @deprecated use the second argument of the composable to define the key */
+    key?: string;
+}, key?: string): ExtendedAsyncData<Order & {
+    items?: NewItemsType<P, V>[];
+}, unknown, DataT, PickKeys, DefaultT>;
 export {};

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

@@ -1,27 +1,11 @@
-import { useRpc } from "../core/useRpc.mjs";
-import { extendPromise } from "../../utils/promise.mjs";
+import {
+  useRpc
+} from "../core/useRpc.mjs";
 export function useOrder({ params, options, key: _key } = {}, key) {
-  const promise = useRpc(
+  return useRpc(
     "getOrderById",
     _key ?? key ?? "useOrder",
     params,
     options
   );
-  const {
-    data,
-    fetch,
-    fetching,
-    error,
-    refresh,
-    status
-  } = promise;
-  const _data = data;
-  return extendPromise(promise.then(() => ({})), {
-    data: _data,
-    fetch,
-    fetching,
-    error,
-    refresh,
-    status
-  });
 }

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

@@ -1,25 +1,26 @@
 import type { RpcMethodParameters, Order } from '@scayle/storefront-core';
-import type { RpcOptions, UseRpcReturn } from '../core/useRpc';
-import type { Ref, MaybeRefOrGetter } from 'vue';
-type Options = Partial<{
-    params: MaybeRefOrGetter<RpcMethodParameters<'getOrderDataByCbd'>>;
-    options: RpcOptions;
-    /** @deprecated use the second argument of the composable to define the key */
-    key: string;
-}>;
+import type { AsyncDataOptions } from 'nuxt/app';
+import type { RpcOptions, ExtendedAsyncData, KeysOf } from '../core/useRpc';
+import type { MaybeRefOrGetter } from 'vue';
 type ItemsType = Exclude<Order['items'], undefined>;
 type NewItemsType<P, V> = Exclude<ItemsType[number], 'product' | 'variant'> & {
     product: P;
     variant: V;
 };
-type UseOrderConfirmationBaseReturn<P, V> = Pick<Awaited<UseRpcReturn<'getOrderDataByCbd'>>, 'error' | 'status' | 'fetch' | 'fetching' | 'refresh'> & {
-    data: Ref<Order & {
-        items?: NewItemsType<P, V>[];
-    }>;
-};
 export declare function useOrderConfirmation<P = {
     [k: string]: unknown;
 }, V = {
     [k: string]: unknown;
-}>({ params, options, key: _key }?: Options, key?: string): UseOrderConfirmationBaseReturn<P, V> & Promise<UseOrderConfirmationBaseReturn<P, V>>;
+}, DataT = Order & {
+    items?: NewItemsType<P, V>[];
+}, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null>({ params, options, key: _key }?: {
+    params?: MaybeRefOrGetter<RpcMethodParameters<'getOrderDataByCbd'>>;
+    options?: RpcOptions & AsyncDataOptions<Order & {
+        items?: NewItemsType<P, V>[];
+    }, DataT, PickKeys, DefaultT>;
+    /** @deprecated use the second argument of the composable to define the key */
+    key?: string;
+}, key?: string): ExtendedAsyncData<Order & {
+    items?: NewItemsType<P, V>[];
+}, unknown, DataT, PickKeys, DefaultT>;
 export {};

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

@@ -1,27 +1,9 @@
 import { useRpc } from "../core/useRpc.mjs";
-import { extendPromise } from "../../utils/promise.mjs";
 export function useOrderConfirmation({ params, options, key: _key } = {}, key) {
-  const promise = useRpc(
+  return useRpc(
     "getOrderDataByCbd",
     _key ?? key ?? "useOrderConfirmation",
     params,
     options
   );
-  const {
-    data,
-    fetch,
-    fetching,
-    error,
-    refresh,
-    status
-  } = promise;
-  const _data = data;
-  return extendPromise(promise.then(() => ({})), {
-    fetch,
-    fetching,
-    error,
-    refresh,
-    status,
-    data: _data
-  });
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "7.85.6",
+  "version": "7.85.8",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -9,6 +9,7 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
+  "website": "https://scayle.dev/en/storefront-guide/developer-guide/getting-started/about-storefront",
   "sideEffects": false,
   "exports": {
     "./rpc": {
@@ -60,7 +61,7 @@
     "@nuxt/kit": "^3.12.2",
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "^0.4.0",
-    "@scayle/storefront-core": "7.65.2",
+    "@scayle/storefront-core": "7.65.4",
     "@scayle/unstorage-compression-driver": "^0.1.3",
     "@vueuse/core": "11.1.0",
     "consola": "^3.2.3",
@@ -84,9 +85,9 @@
     "@nuxt/test-utils": "3.14.2",
     "@scayle/eslint-config-storefront": "4.3.0",
     "@scayle/eslint-plugin-vue-composable": "0.2.0",
-    "@types/node": "20.16.5",
+    "@types/node": "20.16.6",
     "dprint": "0.47.2",
-    "eslint": "9.10.0",
+    "eslint": "9.11.1",
     "eslint-formatter-gitlab": "5.1.0",
     "fishery": "2.2.2",
     "h3": "1.12.0",