@liquidcommerce/elements-sdk 2.7.13 → 2.7.14

package/dist/types/core/client/actions/base-action.service.d.ts

@@ -3,6 +3,7 @@ import { LoggerFactory } from '@/core/logger/logger-factory';
 import { PubSubService } from '@/core/pubsub/pubsub.service';
 import { StoreService } from '@/core/store/store.service';
 import type { ILocation } from '@/interfaces/api/address.interface';
+import type { IProductSizeEngraving, IProductVariant } from '@/interfaces/api/product.interface';
 import { ThemeProviderService } from '@/modules/theme-provider/theme-provider.service';
 export declare abstract class BaseActionService {
     protected readonly pubSub: PubSubService;
@@ -12,4 +13,10 @@ export declare abstract class BaseActionService {
     protected readonly logger: ReturnType<typeof LoggerFactory.get>;
     constructor(loggerName: string);
     protected getLocation(): ILocation | undefined;
+    protected sanitizeEngravingInput(rawLines: string[] | undefined, identifier: string): string[] | undefined;
+    protected clampEngravingToSizeLimits(requestedLines: string[], sizeEngraving: IProductSizeEngraving | undefined, identifier: string): string[] | undefined;
+    protected findVariantForFulfillment(variants: (IProductVariant | undefined)[], wantsEngraving: boolean): {
+        variant: IProductVariant | null;
+        engravingDropped: boolean;
+    };
 }

package/dist/types/core/client/actions/client-cart-action.service.d.ts

@@ -5,6 +5,7 @@ export interface IAddProductParams {
     identifier: string;
     fulfillmentType: FulfillmentType;
     quantity: number;
+    engravingLines?: string[];
 }
 export interface ICartActions {
     openCart: () => void;

package/dist/types/modules/product/product.commands.d.ts

@@ -13,6 +13,7 @@ export declare class ProductCommands extends BaseCommand {
     createProductInstance(productId: string, firstTime?: boolean): Promise<void>;
     loadMultipleProducts(productIds: string[]): Promise<void>;
     loadProduct(productId: string, customProductData?: IProductAvailabilityResponse | null): Promise<void>;
+    cacheProductFromApiData(identifier: string, apiData: IProductAvailabilityResponse): void;
     selectSize(productId: string, sizeId: string): Promise<void>;
     selectFulfillment(productId: string, selectedFulfillmentId: string): Promise<void>;
     updateQuantity(productId: string, delta: number): Promise<void>;

package/docs/v1/api/actions/cart-actions.md

@@ -81,9 +81,20 @@ interface IAddProductParams {
   identifier: string;      // Product UPC, SKU, or ID
   fulfillmentType: FulfillmentType;  // 'shipping' or 'onDemand'
   quantity: number;        // Number of items
+  engravingLines?: string[]; // Optional engraving (see below)
 }
 ```
 
+#### `engravingLines` (optional)
+
+Pre-fills an engraving for the added item. The SDK enforces the product's engraving rules and degrades silently rather than failing the call:
+
+- Non-string-array input is ignored (warning logged).
+- Blank/whitespace-only entries are stripped; an empty result is treated as no engraving.
+- If the product/size doesn't support engraving, lines are dropped.
+- Lines beyond `maxLines` are sliced off; any line longer than `maxCharsPerLine` is truncated.
+- If no engravable variant is available for the chosen fulfillment, lines are dropped and the item is still added.
+
 ### Example
 
 ```javascript
@@ -109,6 +120,16 @@ await window.LiquidCommerce.elements.actions.cart.addProduct([
     quantity: 1
   }
 ]);
+
+// Add a product with engraving
+await window.LiquidCommerce.elements.actions.cart.addProduct([
+  {
+    identifier: '00619947000020',
+    fulfillmentType: 'shipping',
+    quantity: 1,
+    engravingLines: ['Happy Birthday', 'Love, Sam']
+  }
+], true);
 ```
 
 ### Address Requirement

package/docs/v1/api/actions/checkout-actions.md

@@ -62,6 +62,8 @@ addProduct(params: IAddProductParams[], openCheckout?: boolean): Promise<void>
 
 Add products directly to checkout, bypassing the cart.
 
+`IAddProductParams.engravingLines?: string[]` — optional engraving. Same rules as [`actions.cart.addProduct()`](./cart-actions.md#actionscartaddproduct): invalid input is ignored, blanks stripped, lines clamped to the product's `maxLines` / `maxCharsPerLine`, and engraving is dropped (without failing) when the product, variant, or fulfillment doesn't support it.
+
 ```javascript
 await window.LiquidCommerce.elements.actions.checkout.addProduct([
   {
@@ -70,6 +72,16 @@ await window.LiquidCommerce.elements.actions.checkout.addProduct([
     quantity: 1
   }
 ], true);  // Open checkout after adding
+
+// With engraving
+await window.LiquidCommerce.elements.actions.checkout.addProduct([
+  {
+    identifier: '00619947000020',
+    fulfillmentType: 'shipping',
+    quantity: 1,
+    engravingLines: ['For Dad']
+  }
+], true);
 ```
 
 ### actions.checkout.addAnonymousProduct()

package/package.json

@@ -3,7 +3,7 @@
   "description": "LiquidCommerce Elements SDK",
   "license": "UNLICENSED",
   "author": "LiquidCommerce Team",
-  "version": "2.7.13",
+  "version": "2.7.14",
   "homepage": "https://docs.liquidcommerce.co/elements-sdk",
   "repository": {
     "type": "git",
@@ -78,8 +78,8 @@
   ],
   "devDependencies": {
     "@biomejs/biome": "^2.4.13",
-    "@commitlint/cli": "^20.5.0",
-    "@commitlint/config-conventional": "^20.5.0",
+    "@commitlint/cli": "^20.5.3",
+    "@commitlint/config-conventional": "^20.5.3",
     "@rollup/plugin-alias": "^6.0.0",
     "@rollup/plugin-commonjs": "^29.0.2",
     "@rollup/plugin-json": "^6.1.0",