@scayle/storefront-nuxt 8.36.0 → 8.37.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @scayle/storefront-nuxt
 
+## 8.37.0
+
+### Minor Changes
+
+- Created the composable `useCampaign` which uses the RPC `getCampaign` to fetch the first active campaign
+
+### Patch Changes
+
+**Dependencies**
+
+**@scayle/storefront-core v8.37.0**
+
+- Minor
+  - The `where` parameter for the `getProductsByCategory` and `getProductsCount` RPCs was extended to include the previously missing options `sellableAt`, `hasCampaignReduction`, and `containsSearch`.
+- Patch
+  - Added missing export of the RPC `getCampaign`
+
 ## 8.36.0
 
 ### Patch Changes

package/dist/module.json

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

package/dist/module.mjs

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

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

@@ -10,7 +10,7 @@
  *
  * @returns The result of the RPC call or a `Response` object with an error status.
  */
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string | boolean | void | string[] | import("@scayle/storefront-core").ShopUser | Record<string, string> | Response | import("@scayle/storefront-api").Product | import("@scayle/storefront-api").Product[] | import("@scayle/storefront-core").FetchProductsCountResponse | import("@scayle/storefront-core").FetchFiltersResponse | import("@scayle/storefront-core").FetchProductsByCategoryResponse | {
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string | boolean | void | string[] | import("@scayle/storefront-api").Campaign | import("@scayle/storefront-core").ShopUser | Record<string, string> | Response | import("@scayle/storefront-api").Product | import("@scayle/storefront-api").Product[] | import("@scayle/storefront-core").FetchProductsCountResponse | import("@scayle/storefront-core").FetchFiltersResponse | import("@scayle/storefront-core").FetchProductsByCategoryResponse | {
     basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
 } | {
     fromBasketKey: string;

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

@@ -10,6 +10,7 @@ export * from './core/useUser.js';
 export * from './storefront/useBasket.js';
 export * from './storefront/useBrand.js';
 export * from './storefront/useBrands.js';
+export * from './storefront/useCampaign.js';
 export * from './storefront/useCategories.js';
 export * from './storefront/useCategoryById.js';
 export * from './storefront/useCategoryByPath.js';

package/dist/runtime/composables/index.js

@@ -10,6 +10,7 @@ export * from "./core/useUser.js";
 export * from "./storefront/useBasket.js";
 export * from "./storefront/useBrand.js";
 export * from "./storefront/useBrands.js";
+export * from "./storefront/useCampaign.js";
 export * from "./storefront/useCategories.js";
 export * from "./storefront/useCategoryById.js";
 export * from "./storefront/useCategoryByPath.js";

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

@@ -0,0 +1,18 @@
+import type { UseRpcOptions, UseRpcReturn, NormalizedRpcResponse, KeysOf } from '../core/useRpc.js';
+/**
+ * Retrieves the first active campaign.
+ *
+ * This function acts as a wrapper around the `useRpc` composable,
+ * simplifying the process of fetching data. It internally calls `useRpc`
+ * with the provided parameters and options.
+ *
+ * @param params An object containing parameters and options for the `getCampaign` RPC call.
+ * @param params.options The options for the underlying `useRpc` call, controlling data handling and loading state.
+ * @param key A unique key for this RPC call. Used internally by `useRpc` for caching and state management.
+ *
+ * @returns The result of the `useRpc` call, which includes the fetched campaign data,
+ *          loading state, and any error information.
+ */
+export declare function useCampaign<DataT = NormalizedRpcResponse<'getCampaign'>, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null>({ options, }?: Partial<{
+    options: UseRpcOptions<'getCampaign', DataT, PickKeys, DefaultT>;
+}>, key?: string): UseRpcReturn<'getCampaign', DataT, PickKeys, DefaultT>;

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

@@ -0,0 +1,11 @@
+import { useRpc } from "../core/useRpc.js";
+export function useCampaign({
+  options
+} = {}, key = "useCampaign") {
+  return useRpc(
+    "getCampaign",
+    key,
+    void 0,
+    options
+  );
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.36.0",
+  "version": "8.37.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -90,7 +90,7 @@
     "utility-types": "^3.11.0",
     "vue-router": "^4.4.0",
     "zod": "^4.0.0",
-    "@scayle/storefront-core": "8.36.0",
+    "@scayle/storefront-core": "8.37.0",
     "@scayle/unstorage-compression-driver": "1.0.0"
   },
   "devDependencies": {