@scayle/storefront-core 8.45.1 → 8.46.0

package/CHANGELOG.md

@@ -1,5 +1,61 @@
 # @scayle/storefront-core
 
+## 8.46.0
+
+### Minor Changes
+
+- Added `getAttributeValuesByGroupId` function to the `attributeHelpers` helper for retrieving attribute values by their numeric attribute group ID.
+
+  This function allows you to retrieve attribute values filtered by a specific attribute group ID, providing a more targeted approach when working with grouped product attributes.
+  The existing `getAttributeValues` function has been renamed to `getAttributeValuesByName` to better differentiate between the two lookup methods.
+
+  ### Usage Examples
+
+  Both functions return an array of values for consistency, making them safe to use in iterations. For single-select attributes, the value is wrapped in an array. For multi-select attributes, the array is returned directly.
+
+  #### Looking up by name (existing, now renamed):
+
+  ```typescript
+  import { getAttributeValuesByName } from '@scayle/storefront-core'
+
+  // Single-select attribute
+  const sizes = getAttributeValuesByName(product.attributes, 'size')
+  // Returns: [{ id: 1, label: 'M', value: 'medium' }]
+
+  // Multi-select attribute
+  const colors = getAttributeValuesByName(product.attributes, 'color')
+  // Returns: [{ id: 1, label: 'Red' }, { id: 2, label: 'Blue' }]
+
+  // Non-existent attribute
+  const missing = getAttributeValuesByName(product.attributes, 'doesNotExist')
+  // Returns: []
+  ```
+
+  #### Looking up by group ID (new):
+
+  ```typescript
+  import { getAttributeValuesByGroupId } from '@scayle/storefront-core'
+
+  // Look up attribute by its numeric ID from the SCAYLE API
+  const promotionValues = getAttributeValuesByGroupId(product.attributes, 42)
+  // Returns: [{ id: 123, label: 'Summer Sale', value: 'summer-2024' }]
+
+  // Non-existent attribute group
+  const missing = getAttributeValuesByGroupId(product.attributes, 9999)
+  // Returns: []
+  ```
+
+  ### When to Use Each Function
+
+  - **`getAttributeValuesByName`**: Use when you know the attribute name key (e.g., 'color', 'size'). This is the most common use case in application code.
+  - **`getAttributeValuesByGroupId`**: Use when you have the numeric attribute group ID from the SCAYLE API, such as when processing API configurations, handling dynamic attribute mappings, or working with attribute group references.
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@18.17.0
+
 ## 8.45.1
 
 ### Patch Changes

package/dist/helpers/attributeHelpers.d.ts

@@ -1,5 +1,64 @@
 import type { Attributes, Value } from '@scayle/storefront-api';
-import { getAttributeValues, getFirstAttributeValue } from '@scayle/storefront-api';
+/**
+ * Returns the first value of an attribute.
+ * This function is useful when you need to get the first value of an attribute.
+ *
+ * This returns undefined, if the attribute doesn't exist or if it doesn't have any values.
+ *
+ * @param attributes - The product attributes object
+ * @param attributeName - The name of the attribute to look up
+ *
+ * @returns The first value of the attribute, or undefined if the attribute doesn't exist or has no values
+ *
+ * @example
+ * ```typescript
+ * const firstColor = getFirstAttributeValue(product.attributes, 'color')
+ * // Returns: { id: 1, label: 'Red', value: 'red' }
+ * ```
+ */
+export declare const getFirstAttributeValue: (attributes: Attributes | undefined, attributeName: string) => Value | undefined;
+/**
+ * Returns all values of an attribute group by its name key.
+ * This function always returns an array, making it safe to use in iterations.
+ * For single-select attributes, the value is wrapped in an array.
+ * For multi-select attributes, the array is returned directly.
+ *
+ * @param attributes - The product attributes object
+ * @param name - The name key of the attribute group to look up (e.g., 'color', 'size')
+ *
+ * @returns An array of values, or an empty array if the attribute doesn't exist or has no values
+ *
+ * @example
+ * ```typescript
+ * // Single-select attribute
+ * const sizes = getAttributeValuesByName(product.attributes, 'size')
+ * // Returns: [{ id: 1, label: 'M', value: 'medium' }]
+ *
+ * // Multi-select attribute
+ * const colors = getAttributeValuesByName(product.attributes, 'color')
+ * // Returns: [{ id: 1, label: 'Red' }, { id: 2, label: 'Blue' }]
+ * ```
+ */
+export declare const getAttributeValuesByName: (attributes: Attributes | undefined, name: string) => Value[];
+/**
+ * Returns all values of an attribute group by its numeric ID.
+ *
+ * This function searches through all attribute groups to find one matching the given ID.
+ * This is useful when you need to look up attributes by their SCAYLE API identifier rather than by name.
+ * Like {@link getAttributeValuesByName}, this always returns an array for consistency.
+ *
+ * @param attributes - The product attributes object
+ * @param groupId - The numeric ID of the attribute group to look up
+ * @returns An array of values, or an empty array if the attribute doesn't exist or has no values
+ *
+ * @example
+ * ```typescript
+ * // Look up by attribute group ID instead of name
+ * const promotionValues = getAttributeValuesByGroupId(product.attributes, 42)
+ * // Returns: [{ id: 123, label: 'Summer Sale', value: 'summer-2024' }]
+ * ```
+ */
+export declare const getAttributeValuesByGroupId: (attributes: Attributes | undefined, groupId: number) => Value[];
 /**
  * Retrieves the value or label of the first attribute value for a given attribute name.
  *
@@ -18,4 +77,7 @@ export declare const getAttributeValue: (attributes: Attributes | undefined, att
  * @returns An array of attribute values, filtered to remove any null or undefined values.
  */
 export declare const getManyAttributeValueTuples: (attributes: Attributes | undefined, attributeNames: string[]) => Value[];
-export { getAttributeValues as getAttributeValueTuples, getFirstAttributeValue };
+/**
+ * @deprecated This function will be removed in the next major version. Use {@link getAttributeValuesByName} instead.
+ */
+export { getAttributeValuesByName as getAttributeValueTuples };

package/dist/helpers/attributeHelpers.mjs

@@ -1,7 +1,36 @@
-import {
-  getAttributeValues,
-  getFirstAttributeValue
-} from "@scayle/storefront-api";
+export const getFirstAttributeValue = (attributes, attributeName) => {
+  const attribute = attributes && attributes[attributeName];
+  if (!attribute || !attribute.values) {
+    return;
+  }
+  if (attribute.multiSelect) {
+    return attribute.values.length > 0 ? attribute.values[0] : void 0;
+  }
+  return attribute.values;
+};
+export const getAttributeValuesByName = (attributes, name) => {
+  const attribute = attributes && attributes[name];
+  if (!attribute || !attribute.values) {
+    return [];
+  }
+  if (attribute.multiSelect) {
+    return attribute.values;
+  }
+  return [attribute.values];
+};
+export const getAttributeValuesByGroupId = (attributes, groupId) => {
+  if (!attributes) {
+    return [];
+  }
+  const attribute = Object.values(attributes).find((attribute2) => attribute2?.id === groupId);
+  if (!attribute || !attribute.values) {
+    return [];
+  }
+  if (attribute.multiSelect) {
+    return attribute.values;
+  }
+  return [attribute.values];
+};
 export const getAttributeValue = (attributes, attributeName) => {
   const values = getFirstAttributeValue(attributes, attributeName);
   return values?.value ?? values?.label;
@@ -9,4 +38,4 @@ export const getAttributeValue = (attributes, attributeName) => {
 export const getManyAttributeValueTuples = (attributes, attributeNames) => {
   return attributeNames.map((key) => getFirstAttributeValue(attributes, key)).filter((entry) => !!entry);
 };
-export { getAttributeValues as getAttributeValueTuples, getFirstAttributeValue };
+export { getAttributeValuesByName as getAttributeValueTuples };

package/dist/rpc/methods/checkout/checkout.mjs

@@ -33,7 +33,7 @@ export const getCheckoutToken = defineRpcHandler(async (jwtPayload = {}, context
     carrier,
     basketId: context.basketKey,
     campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.45.1"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.46.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.45.1",
+  "version": "8.46.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -48,26 +48,26 @@
     "ufo": "^1.5.3",
     "uncrypto": "^0.1.3",
     "utility-types": "^3.11.0",
-    "@scayle/storefront-api": "18.16.1",
+    "@scayle/storefront-api": "18.17.0",
     "@scayle/unstorage-scayle-kv-driver": "2.0.6"
   },
   "devDependencies": {
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.18.11",
+    "@types/node": "22.18.12",
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "3.2.4",
     "dprint": "0.50.2",
     "eslint-formatter-gitlab": "6.0.1",
-    "eslint": "9.37.0",
+    "eslint": "9.38.0",
     "fishery": "2.3.1",
-    "publint": "0.3.14",
+    "publint": "0.3.15",
     "rimraf": "6.0.1",
     "typescript": "5.9.3",
     "unbuild": "3.6.1",
     "unstorage": "1.17.1",
     "vitest": "3.2.4",
-    "@scayle/eslint-config-storefront": "4.7.10",
-    "@scayle/vitest-config-storefront": "1.0.0"
+    "@scayle/vitest-config-storefront": "1.0.0",
+    "@scayle/eslint-config-storefront": "4.7.10"
   },
   "volta": {
     "node": "22.20.0"