@scayle/storefront-nuxt 7.85.15 → 7.86.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @scayle/storefront-nuxt
 
+## 7.86.0
+
+### Minor Changes
+
+- Add `formatPercentage` to `useFormatHelpers.ts`
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-core@7.65.9
+
+## 7.85.16
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-core@7.65.8
+
 ## 7.85.15
 
 ### Patch Changes
@@ -135,28 +155,28 @@ For example:
 ```ts
 useBrand({
   params: { brandId: 1 },
-}).data satisfies Ref<Brand>;
+}).data satisfies Ref<Brand>
 
 useBrand({
   params: { brandId: 1 },
   options: {
-    pick: ["id", "isActive"],
+    pick: ['id', 'isActive'],
   },
-}).data satisfies Ref<Brand>;
+}).data satisfies Ref<Brand>
 
 useBrand({
   params: { brandId: 1 },
   options: {
     transform: (brand) => brand.slug,
   },
-}).data satisfies Ref<Brand>;
+}).data satisfies Ref<Brand>
 
 useBrand({
   params: { brandId: 1 },
   options: {
-    default: () => "Brand not found",
+    default: () => 'Brand not found',
   },
-}).data satisfies Ref<Brand>;
+}).data satisfies Ref<Brand>
 ```
 
 **In 7.85.0**
@@ -164,28 +184,28 @@ useBrand({
 ```ts
 useBrand({
   params: { brandId: 1 },
-}).data satisfies Ref<Brand | null>;
+}).data satisfies Ref<Brand | null>
 
 useBrand({
   params: { brandId: 1 },
   options: {
-    pick: ["id", "isActive"],
+    pick: ['id', 'isActive'],
   },
-}).data satisfies Ref<Pick<Brand, "id" | "isActive"> | null>;
+}).data satisfies Ref<Pick<Brand, 'id' | 'isActive'> | null>
 
 useBrand({
   params: { brandId: 1 },
   options: {
     transform: (brand) => brand.slug,
   },
-}).data satisfies Ref<string | null>;
+}).data satisfies Ref<string | null>
 
 useBrand({
   params: { brandId: 1 },
   options: {
-    default: () => "Brand not found",
+    default: () => 'Brand not found',
   },
-}).data satisfies Ref<Brand | string>;
+}).data satisfies Ref<Brand | string>
 ```
 
 For more details on `useAsyncData` usage check out the [Nuxt Docs](https://nuxt.com/docs/api/composables/use-async-data)
@@ -219,7 +239,8 @@ For more details on `useAsyncData` usage check out the [Nuxt Docs](https://nuxt.
 
 ### Patch Changes
 
-- - Updated dependencies
+-
+  - Updated dependencies
     - @scayle/storefront-core@7.64.0
 
 ## 7.84.2
@@ -344,27 +365,27 @@ For more details on `useAsyncData` usage check out the [Nuxt Docs](https://nuxt.
   Hooks can be registered by adding a nitro plugin inside ´server/plugins/´:
 
   ```ts
-  import { defineNitroPlugin } from "#imports";
+  import { defineNitroPlugin } from '#imports'
 
   export default defineNitroPlugin((nitroApp) => {
-    nitroApp.hooks.hook("storefront:rpc:before", (rpcName, rpcContext) => {
-      rpcContext.log.debug(`Before: ${rpcName}`);
-    });
+    nitroApp.hooks.hook('storefront:rpc:before', (rpcName, rpcContext) => {
+      rpcContext.log.debug(`Before: ${rpcName}`)
+    })
 
     nitroApp.hooks.hook(
-      "storefront:rpc:after",
+      'storefront:rpc:after',
       (rpcName, rpcContext, result) => {
-        rpcContext.log.debug(`After: ${rpcName} returned ${result}`);
-      }
-    );
+        rpcContext.log.debug(`After: ${rpcName} returned ${result}`)
+      },
+    )
 
     nitroApp.hooks.hook(
-      "storefront:rpc:error",
+      'storefront:rpc:error',
       (rpcName, rpcContext, error) => {
-        rpcContext.log.error(`ERROR: ${rpcName} did throw ${error}`);
-      }
-    );
-  });
+        rpcContext.log.error(`ERROR: ${rpcName} did throw ${error}`)
+      },
+    )
+  })
   ```
 
   Added [`callHook`](https://github.com/unjs/hookable?tab=readme-ov-file#async-callhook-name-args), `callHookParallel` and [`callHookWith`](https://github.com/unjs/hookable?tab=readme-ov-file#callhookwith-name-callerfn) to `RpcContext` to allow triggering hooks within RPCs
@@ -632,20 +653,20 @@ For more details on `useAsyncData` usage check out the [Nuxt Docs](https://nuxt.
 - It is now also possible to extend the RPCContext using the `storefront:context:created` nitro runtime hook.
 
   ```ts
-  import { defineNitroPlugin } from "nitropack/runtime/plugin";
+  import { defineNitroPlugin } from 'nitropack/runtime/plugin'
   // Augment RpxContext type
-  declare module "@scayle/storefront-nuxt" {
+  declare module '@scayle/storefront-nuxt' {
     interface AdditionalRpcContext {
-      myNewProp: string;
+      myNewProp: string
     }
   }
 
   // Set new value on rpcContext
   export default defineNitroPlugin((nitroApp) => {
-    nitroApp.hooks.hook("storefront:context:created", (rpcContext) => {
-      rpcContext.myNewProp = "My campaign key";
-    });
-  });
+    nitroApp.hooks.hook('storefront:context:created', (rpcContext) => {
+      rpcContext.myNewProp = 'My campaign key'
+    })
+  })
   ```
 
 ### Patch Changes
@@ -848,8 +869,8 @@ For more details on `useAsyncData` usage check out the [Nuxt Docs](https://nuxt.
 
   ```ts
   const { data: externalIDPRedirects } = await useIDP({
-    queryParams: { redirectTo: "/account" },
-  });
+    queryParams: { redirectTo: '/account' },
+  })
   ```
 
   Please note that `code` and `state` are not supported as these are used by the SCAYLE Authentication API.
@@ -1268,16 +1289,16 @@ There is an `unwrap` function exported by this package (>=7.55.0) that can be us
   Before:
 
   ```typescript
-  toCurrency(100, { currency: "EUR" });
-  formatPrice(100, { currencyFractionDigits: 2 });
+  toCurrency(100, { currency: 'EUR' })
+  formatPrice(100, { currencyFractionDigits: 2 })
   ```
 
   After:
 
   ```typescript
-  const { formatCurrency } = useFormatHelpers();
-  formatCurrency(100, { currency: "EUR" });
-  formatCurrency(100, { style: "decimal", currencyFractionDigits: 2 });
+  const { formatCurrency } = useFormatHelpers()
+  formatCurrency(100, { currency: 'EUR' })
+  formatCurrency(100, { style: 'decimal', currencyFractionDigits: 2 })
   ```
 
 ## 7.44.1

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "7.85.15",
+  "version": "7.86.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.85.15";
+const PACKAGE_VERSION = "7.86.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {

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

@@ -10,5 +10,11 @@ type FormatCurrencyOptions = {
 };
 export declare function useFormatHelpers(): {
     formatCurrency: (value: number, options?: FormatCurrencyOptions) => string;
+    formatPercentage: (value: number, options?: {
+        locale?: string;
+        minimumFractionDigits?: number;
+        maximumFractionDigits?: number;
+        signDisplay?: Intl.NumberFormatOptions["signDisplay"];
+    }) => string;
 };
 export {};

package/dist/runtime/composables/core/useFormatHelpers.js

@@ -19,7 +19,19 @@ export function useFormatHelpers() {
       currency
     });
   };
+  const formatPercentage = (value, options) => {
+    const locale = options?.locale ?? currentShop.value.locale;
+    const minimumFractionDigits = options?.minimumFractionDigits ?? 0;
+    const maximumFractionDigits = options?.maximumFractionDigits ?? 2;
+    return value.toLocaleString(locale, {
+      style: "percent",
+      minimumFractionDigits,
+      maximumFractionDigits,
+      signDisplay: options?.signDisplay
+    });
+  };
   return {
-    formatCurrency
+    formatCurrency,
+    formatPercentage
   };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "7.85.15",
+  "version": "7.86.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -61,7 +61,7 @@
     "@nuxt/kit": "^3.12.2",
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "^0.4.1",
-    "@scayle/storefront-core": "7.65.7",
+    "@scayle/storefront-core": "7.65.9",
     "@scayle/unstorage-compression-driver": "^0.1.4",
     "@vueuse/core": "11.1.0",
     "consola": "^3.2.3",
@@ -82,17 +82,17 @@
     "@nuxt/eslint": "0.6.0",
     "@nuxt/module-builder": "0.8.4",
     "@nuxt/schema": "3.13.2",
-    "@nuxt/test-utils": "3.14.3",
+    "@nuxt/test-utils": "3.14.4",
     "@scayle/eslint-config-storefront": "4.3.2",
     "@scayle/eslint-plugin-vue-composable": "0.2.1",
-    "@types/node": "20.16.12",
-    "dprint": "0.47.2",
-    "eslint": "9.12.0",
+    "@types/node": "20.17.0",
+    "dprint": "0.47.4",
+    "eslint": "9.13.0",
     "eslint-formatter-gitlab": "5.1.0",
     "fishery": "2.2.2",
     "h3": "1.13.0",
     "node-mocks-http": "1.16.1",
-    "nuxi": "3.14.0",
+    "nuxi": "3.15.0",
     "nuxt": "3.13.2",
     "publint": "0.2.11",
     "vitest": "2.1.3",