@shopify/ui-extensions 2025.10.8 → 2025.10.9

package/build/ts/surfaces/point-of-sale/types/payment.d.ts

@@ -1,7 +1,22 @@
+/**
+ * The available payment method types for POS transactions.
+ */
 export type PaymentMethod = 'Cash' | 'Custom' | 'CreditCard' | 'CardPresentRefund' | 'StripeCardPresentRefund' | 'GiftCard' | 'StripeCreditCard' | 'ShopPay' | 'StoreCredit' | 'Unknown';
+/**
+ * Represents a payment applied to a transaction, including the amount, currency, and payment method type.
+ */
 export interface Payment {
+    /**
+     * The payment amount.
+     */
     amount: number;
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code associated with the location currently active on POS.
+     */
     currency: string;
+    /**
+     * The payment method type.
+     */
     type: PaymentMethod;
 }
 //# sourceMappingURL=payment.d.ts.map

package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payment.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/payment.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GACrB,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,mBAAmB,GACnB,yBAAyB,GACzB,UAAU,GACV,kBAAkB,GAClB,SAAS,GACT,aAAa,GACb,SAAS,CAAC;AACd,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,aAAa,CAAC;CACrB"}
+{"version":3,"file":"payment.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/payment.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,mBAAmB,GACnB,yBAAyB,GACzB,UAAU,GACV,kBAAkB,GAClB,SAAS,GACT,aAAa,GACb,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB"}

package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts

@@ -1,70 +1,90 @@
+/**
+ * Represents the result of a PIN pad interaction, indicating whether PIN entry was completed and providing the entered PIN if available.
+ */
 export interface PinPadResult {
     /**
-     * Whether the PIN entry was completed (not cancelled)
+     * Whether the PIN entry was completed successfully. When `true`, the user entered a PIN and submitted it (or it was auto-submitted). When `false`, the user canceled the PIN pad modal without completing entry, typically by clicking a cancel button or dismissing the modal.
      */
     completed: boolean;
     /**
-     * The entered PIN (only present if completed is true)
+     * The entered PIN as an array of individual digits (for example, `[1, 2, 3, 4]` for PIN "1234"). Each element is a number from 0-9. This array's length will be between `minPinLength` and `maxPinLength` inclusive. Only present when `completed` is `true`—when `completed` is `false`, this field is `undefined` since no PIN was entered.
      */
     pin?: number[];
 }
 /**
- * Represents the result of the pin pad onSubmit function.
- * @typedef {{result: 'accept'} | {result: 'reject'; errorMessage?: string}} PinValidationResult
+ * Represents the validation outcome for an entered PIN. Indicates whether the PIN should be accepted or rejected, with optional error messaging for rejected PINs.
  */
-export type PinValidationResult = {
+export type PinValidationResult = 
+/** The validation result indicating the PIN should be accepted for valid PINs. */
+{
     result: 'accept';
-} | {
+}
+/** The validation result indicating the PIN should be rejected. Optionally includes an error message to display to the user explaining why the PIN was rejected. For example, "Invalid PIN" or "PIN expired". */
+ | {
     result: 'reject';
     errorMessage?: string;
 };
+/**
+ * The valid PIN length values (4-10 digits). Commonly used to configure minimum and maximum PIN length requirements.
+ */
 export type PinLength = 4 | 5 | 6 | 7 | 8 | 9 | 10;
+/**
+ * Defines a custom action button for the PIN pad interface with a label and click handler.
+ */
 export interface PinPadActionType {
+    /**
+     * The content for the prompt on the pin pad. Use to provide clear instructions or context about what the PIN is being used for.
+     */
     label: string;
+    /**
+     * Called when the action button is clicked. Can return the PIN digits directly as an array of numbers, or return a Promise that resolves to the PIN array. Use for implementing custom PIN retrieval logic or validation workflows.
+     */
     onClick: () => Promise<number[]> | number[];
 }
+/**
+ * Specifies configuration options for displaying the PIN pad interface. Includes callback functions for PIN entry events, dismissal handling, and customizable labels and messaging.
+ */
 export interface PinPadOptions {
     /**
-     * The function to be called whenever the entered PIN is updated
+     * The function to be called when a pin is entered. Use for real-time PIN validation, progress feedback, or implementing custom PIN entry handling logic.
      */
     onPinEntry?: (pin: number[]) => void;
     /**
-     * The function to be called when the PIN pad modal is dismissed
+     * The function to be called when the pin pad modal is dismissed. Receives a `PinPadResult` indicating whether PIN entry was completed and the entered PIN if available. Use for handling modal dismissal and processing final PIN results.
      */
     onDismissed?: (result: PinPadResult) => void;
     /**
-     * The content for the prompt on the PIN pad. This will be overridden by any
-     * `errorMessage` provided when rejecting a PIN from the `onSubmit` callback.
+     * The content for the prompt on the pin pad. Use to provide clear instructions or context about what the PIN is being used for.
      */
     label?: string;
     /**
-     * Whether the entered PIN should be masked
+     * Whether the entered PIN should be masked for security. When `true`, PIN digits are hidden from view. Use for secure PIN entry where visual privacy is important.
      *
      * @default true
      */
     masked?: boolean;
     /**
-     * The minimum length of the PIN
+     * The minimum length of the PIN (4-10 digits). Use to enforce PIN length requirements based on your security policies or authentication system requirements.
      *
      * @default 4
      */
     minPinLength?: PinLength;
     /**
-     * The maximum length of the PIN
+     * The maximum length of the PIN (4-10 digits). Use to limit PIN length based on your security policies or authentication system constraints.
      *
      * @default 6
      */
     maxPinLength?: PinLength;
     /**
-     * The call to action between the entry view and the keypad
+     * The call to action between the entry view and the keypad, consisting of a label and function that returns the pin. Use for custom PIN entry workflows or implementing specific authentication patterns.
      */
     pinPadAction?: PinPadActionType;
     /**
-     * Title shown in the modal header
+     * The title shown in the modal header. Use to provide context about the PIN entry purpose or identify the specific authentication requirement.
      */
     title?: string;
     /**
-     * Whether the PIN should be automatically submitted when the user has entered the maximum PIN length
+     * Whether the pin should be automatically submitted when the user has entered the maximum PIN length. Use for PIN entry experiences where users don't need to manually submit after entering the required digits.
      *
      * @default false
      */

package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pin-pad.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/pin-pad.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IAAC,MAAM,EAAE,QAAQ,CAAA;CAAC,GAClB;IAAC,MAAM,EAAE,QAAQ,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAE9C,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;AAEnD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAC;IAC7C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}
+{"version":3,"file":"pin-pad.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/pin-pad.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB;AAC7B,kFAAkF;AAChF;IAAC,MAAM,EAAE,QAAQ,CAAA;CAAC;AACpB,iNAAiN;GAC/M;IAAC,MAAM,EAAE,QAAQ,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAC;IAC7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/build/ts/surfaces/point-of-sale/types/product.d.ts

@@ -1,61 +1,231 @@
+/**
+ * Represents comprehensive product information including metadata, pricing, variants, and availability. Contains all data needed to display and work with products in the POS interface.
+ */
 export interface Product {
+    /**
+     * The unique identifier for the product. Use this ID for product-specific operations, API calls, or linking to product details. This ID is consistent across all Shopify systems and can be used for external integrations.
+     */
     id: number;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the product was created. Use for sorting products by creation date, implementing "new product" features, or tracking product catalog growth over time.
+     */
     createdAt: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the product was last updated. Use for cache invalidation, tracking recent changes, or implementing "recently updated" product features.
+     */
     updatedAt: string;
+    /**
+     * The product's display name as configured by the merchant. Use for product listings, search results, and customer-facing displays. This is the primary product identifier that customers will recognize.
+     */
     title: string;
+    /**
+     * The product's plain text description without HTML formatting. Use for displaying product information in contexts where HTML is not supported or when you need clean text content for processing.
+     */
     description: string;
+    /**
+     * The product's description with HTML formatting preserved. Use when you need to display rich text content with formatting, links, or other HTML elements in your extension interface.
+     */
     descriptionHtml: string;
+    /**
+     * The URL of the product's featured image, if one is set. Returns `undefined` if no featured image is configured. Use for displaying product images in search results, product listings, or detailed product views.
+     */
     featuredImage?: string;
+    /**
+     * Whether this product is a gift card. Gift cards have special handling requirements and different business logic. Use to implement gift card-specific workflows, validation, or display special gift card interfaces.
+     */
     isGiftCard: boolean;
+    /**
+     * Whether inventory tracking is enabled for this product. When `false`, inventory quantities may not be accurate or meaningful. Use to determine whether to display inventory information or implement inventory-based business logic.
+     */
     tracksInventory: boolean;
+    /**
+     * The product's vendor or brand name as configured by the merchant. Use for filtering products by brand, displaying vendor information, or organizing products by supplier.
+     */
     vendor: string;
+    /**
+     * The lowest price among all product variants, formatted as a string. Use for displaying price ranges, implementing price-based filtering, or showing starting prices in product listings.
+     */
     minVariantPrice: string;
+    /**
+     * The highest price among all product variants, formatted as a string. Use for displaying price ranges, implementing price-based filtering, or showing complete pricing information for products with multiple variants.
+     */
     maxVariantPrice: string;
+    /**
+     * The product type category as defined by the merchant (For example, "T-Shirt," "Electronics," "Books"). Use for product categorization, filtering, or implementing category-specific business logic.
+     */
     productType: string;
+    /**
+     * The standardized product category classification. Use for product categorization, implementing category-specific business logic, or organizing products by standardized categories.
+     */
     productCategory: string;
+    /**
+     * An array of tags associated with the product for categorization and organization. Use for product filtering, search enhancement, or implementing tag-based business logic and promotions.
+     */
     tags: string[];
+    /**
+     * The total number of variants available for this product. Use to determine whether to show variant selection interfaces, implement variant-specific logic, or optimize variant loading strategies.
+     */
     numVariants: number;
+    /**
+     * The total available inventory across all variants and locations, if tracking is enabled. Returns `undefined` when inventory tracking is disabled. Use for availability checks, stock level displays, or implementing low-stock alerts.
+     */
     totalAvailableInventory?: number;
+    /**
+     * The total inventory count across all variants and locations for this product. Use for inventory management, stock level displays, or implementing low-stock warnings and alerts.
+     */
     totalInventory: number;
+    /**
+     * An array of all product variants associated with this product. Each variant contains detailed information including pricing, inventory, and options. Use for building variant selectors, displaying inventory information, or implementing variant-specific functionality.
+     */
     variants: ProductVariant[];
+    /**
+     * An array of product options that define available variant configurations. For example, size and color. Each option includes available values. Use for building variant selection interfaces or understanding product configuration possibilities.
+     */
     options: ProductOption[];
+    /**
+     * Whether the product has only a default variant (no custom options). When `true`, the product doesn't require variant selection. Use to simplify product interfaces and skip variant selection steps for single-variant products.
+     */
     hasOnlyDefaultVariant: boolean;
+    /**
+     * Whether the product has any variants currently in stock. Returns `undefined` when inventory information is not available. Use for stock status displays, availability filtering, or implementing out-of-stock product handling.
+     */
     hasInStockVariants?: boolean;
+    /**
+     * The URL of the product on the online store, if available. Returns `undefined` when the product is not published online or the store doesn't have an online presence. Use for linking to online product pages or sharing product information.
+     */
     onlineStoreUrl?: string;
+    /**
+     * Indicates whether this product or line item requires a selling plan (subscription) to be purchased. When `true`, the customer must select a subscription or payment plan before adding to cart. When `false`, the item can be purchased as a one-time purchase without a selling plan.
+     */
     requiresSellingPlan?: boolean;
+    /**
+     * Indicates whether this product or line item has selling plan groups (subscription options) available. When `true`, the product offers subscription or recurring payment options that customers can select. When `false`, the product is only available for one-time purchase without subscription options.
+     */
     hasSellingPlanGroups?: boolean;
 }
+/**
+ * Represents a specific variant of a product with its own SKU, price, and inventory. Contains variant-specific attributes including options, availability, and identification data.
+ */
 export interface ProductVariant {
+    /**
+     * The unique identifier for the product variant. Use this ID for variant-specific operations, cart additions, or inventory lookups. This ID is consistent across all Shopify systems.
+     */
     id: number;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the product variant was created. Use for sorting variants by creation date, implementing "new product" features, or tracking product catalog changes over time.
+     */
     createdAt: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the product variant was last updated. Use for cache invalidation, tracking recent changes, or implementing "recently updated" product features.
+     */
     updatedAt: string;
+    /**
+     * The variant's display title, typically showing the option combinations. For example, `"Large / Blue"`. Use for variant selection interfaces, cart displays, or anywhere users need to distinguish between variants.
+     */
     title: string;
+    /**
+     * The variant's selling price formatted as a string. Use for price displays, cart calculations, or implementing pricing logic. This represents the current selling price for the variant.
+     */
     price: string;
+    /**
+     * The variant's compare-at price (original or MSRP price) formatted as a string, if set. Returns `undefined` when no compare-at price is configured. Use for displaying discounts, sale pricing, or savings calculations.
+     */
     compareAtPrice?: string;
+    /**
+     * Whether this variant is subject to tax calculations. Use for tax computation logic, pricing displays, or implementing tax-exempt product handling.
+     */
     taxable: boolean;
+    /**
+     * The variant's Stock Keeping Unit (SKU) identifier, if configured. Returns `undefined` when no SKU is set. Use for inventory management, product identification, or integration with external systems that use SKU-based tracking.
+     */
     sku?: string;
+    /**
+     * The variant's barcode identifier, if configured. Returns `undefined` when no barcode is set. Use for barcode scanning functionality, inventory tracking, or integration with barcode-based systems.
+     */
     barcode?: string;
+    /**
+     * The variant's formatted display name for user interfaces. This may differ from the title and is optimized for display purposes. Use for customer-facing variant names in product listings, cart items, or receipt displays.
+     */
     displayName: string;
+    /**
+     * The URL of the variant-specific image, if one is configured. Returns `undefined` when no variant image is set. Use for displaying variant-specific images in selection interfaces or product galleries.
+     */
     image?: string;
+    /**
+     * Whether inventory tracking is enabled for this specific variant. When `false`, inventory quantities may not be accurate. Use to determine whether to display inventory information or implement inventory-based business logic for this variant.
+     */
     inventoryIsTracked: boolean;
+    /**
+     * The inventory quantity available at the current POS location, if inventory tracking is enabled. Returns `undefined` when inventory tracking is disabled. Use for location-specific inventory displays, stock availability checks, or local inventory management.
+     */
     inventoryAtLocation?: number;
+    /**
+     * The total inventory quantity across all locations for this variant, if available. Returns `undefined` when this information is not available. Use for comprehensive inventory views, transfer planning, or multi-location inventory management.
+     */
     inventoryAtAllLocations?: number;
+    /**
+     * The inventory policy for this variant, either "DENY" (prevent sales when out of stock) or "CONTINUE" (allow sales when out of stock). Use to implement inventory validation logic and determine whether to allow purchases of out-of-stock items.
+     */
     inventoryPolicy: ProductVariantInventoryPolicy;
+    /**
+     * Whether this variant currently has inventory in stock. Returns `undefined` when inventory information is not available. Use for stock status displays, availability checks, or filtering in-stock variants.
+     */
     hasInStockVariants?: boolean;
+    /**
+     * An array of option name-value pairs that define this variant's configuration. For example, `[{name: "Size," value: "Large"}, {name: "Color," value: "Blue"}]`. Returns `undefined` for products with only default variants. Use for displaying variant options, building variant selectors, or implementing variant-based logic.
+     */
     options?: ProductVariantOption[];
+    /**
+     * Reference to the parent Product object that this variant belongs to. Returns `undefined` in some contexts to avoid circular references. Use when you need access to product-level information from a variant context.
+     */
     product?: Product;
+    /**
+     * The ID of the parent product that this variant belongs to. Use for linking variants back to their parent product, implementing product-level operations, or organizing variants by product.
+     */
     productId: number;
+    /**
+     * The variant's position order within the product's variant list. Use for maintaining consistent variant ordering in selection interfaces or implementing custom variant sorting logic.
+     */
     position: number;
 }
+/**
+ * Represents a single option selection for a product variant, showing one chosen value from a product's configuration options. For example, if a product has Size and Color options, a variant might have one option for Size=Large and another for Color=Blue.
+ */
 export interface ProductVariantOption {
+    /**
+     * The option category name (for example, "Size", "Color", "Material", "Style", "Flavor"). This is the attribute or dimension along which the product varies. Each product can have up to 3 option names, and each option name can have multiple values. The name is visible to customers in variant selection interfaces. Commonly used for displaying option labels in variant selectors ("Select Size:", "Choose Color:"), building dynamic product configuration UI, or organizing product variations by attribute type.
+     */
     name: string;
+    /**
+     * The selected value for this option that defines this specific variant (for example, "Large", "Blue", "Cotton", "V-Neck"). This is the specific choice from the available option values that characterizes this variant. For example, if `name` is "Size", the `value` might be "Large" or "Small". Values are set at the variant level—each variant has a unique combination of option values. Commonly used for displaying the variant's configuration ("Size: Large, Color: Blue"), building variant selection dropdowns, or matching user selections to variants.
+     */
     value: string;
 }
+/**
+ * The inventory policy determining whether sales can continue when a variant has no inventory available:
+ * - `'DENY'`: Sales are prevented when inventory reaches zero. Customers can't purchase out-of-stock variants. The "Add to cart" action is disabled or shows "Out of stock". This is the default and recommended policy for most physical products to prevent overselling.
+ * - `'CONTINUE'`: Sales are allowed even when inventory is zero or negative. Customers can purchase out-of-stock variants, creating backorders. This enables pre-orders, made-to-order products, or drop-shipped items where inventory tracking is less critical.
+ */
 export type ProductVariantInventoryPolicy = 'DENY' | 'CONTINUE';
+/**
+ * Represents a product option definition showing one of the configurable attributes for a product (like Size, Color, Material) along with all the possible values customers can choose from. Products can have up to 3 options.
+ */
 export interface ProductOption {
+    /**
+     * The unique numeric identifier for this product option configuration. This ID identifies the option definition itself (not a specific option value or variant). Commonly used for option-specific operations, tracking option configurations, or linking options in external systems.
+     */
     id: number;
+    /**
+     * The option category name (for example, "Size", "Color", "Material", "Style", "Flavor"). This is the attribute or dimension along which the product varies. Each product can have up to 3 option names, and each option name can have multiple values. The name is visible to customers in variant selection interfaces. Commonly used for displaying option labels in variant selectors ("Select Size:", "Choose Color:"), building dynamic product configuration UI, or organizing product variations by attribute type.
+     */
     name: string;
+    /**
+     * An array of all available values for this option that customers can choose from (for example, `["Small", "Medium", "Large", "X-Large"]` for a Size option, or `["Red", "Blue", "Green", "Black"]` for a Color option). The order of values in this array typically represents the display order in variant selectors. Each combination of option values across all options creates a unique variant. For example, a product with Size: [Small, Large] and Color: [Red, Blue] would have 4 variants (Small/Red, Small/Blue, Large/Red, Large/Blue). Commonly used for building variant selection dropdowns, radio buttons, or swatches, validating user selections, or displaying all available choices for an attribute.
+     */
     optionValues: string[];
+    /**
+     * The unique numeric identifier of the parent product to which this option belongs. This links the option definition back to the product it configures. Commonly used for linking options to their parent product, organizing options by product, or implementing product-level option management.
+     */
     productId: number;
 }
 //# sourceMappingURL=product.d.ts.map

package/build/ts/surfaces/point-of-sale/types/product.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"product.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/product.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB,EAAE,OAAO,CAAC;IAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,eAAe,EAAE,6BAA6B,CAAC;IAC/C,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,6BAA6B,GAAG,MAAM,GAAG,UAAU,CAAC;AAEhE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"product.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/product.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACH,eAAe,EAAE,6BAA6B,CAAC;IAC/C;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,GAAG,UAAU,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/build/ts/surfaces/point-of-sale/types/session.d.ts

@@ -1,4 +1,7 @@
 import type { CurrencyCode } from '../../../shared';
+/**
+ * Defines information about the current POS session.
+ */
 export interface Session {
     /**
      * The shop ID associated with the shop currently logged into POS.
@@ -13,20 +16,19 @@ export interface Session {
      */
     shopDomain: string;
     /**
-     * The location ID associated with the POS' current location.
+     * The location ID associated with the POS device's current location.
      */
     locationId: number;
     /**
-     * The staff ID who is currently pinned into the POS.
-     * Note that this staff member ID may be different to the User ID, as the staff member who enters their PIN may be different to the User who logged onto POS.
+     * The staff ID of the staff member currently pinned into the POS. This may differ from the user ID if the pinned staff member is different from the logged-in user.
      */
     staffMemberId?: number;
     /**
-     * The currency code associated with the location currently in on POS.
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code associated with the location currently active on POS.
      */
     currency: CurrencyCode;
     /**
-     * The POS version.
+     * The version of [the POS app](https://apps.shopify.com/shopify-pos) currently running.
      */
     posVersion: string;
 }

package/build/ts/surfaces/point-of-sale/types/session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/session.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAElD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB"}
+{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/session.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts

@@ -1,16 +1,48 @@
 import type { Money } from './money';
 import type { TaxLine } from './tax-line';
+/**
+ * Represents a shipping charge applied to an order, including the price and applicable taxes.
+ */
 export interface ShippingLine {
+    /**
+     * The handle identifier for the shipping method.
+     */
     handle?: string;
+    /**
+     * The price of the shipping as a Money object.
+     */
     price: Money;
+    /**
+     * The display title of the shipping method.
+     */
     title?: string;
+    /**
+     * An array of individual tax lines showing tax breakdown.
+     */
     taxLines?: TaxLine[];
 }
+/**
+ * Represents a calculated shipping line with specific shipping or retail method type.
+ */
 export interface CalculatedShippingLine extends ShippingLine {
+    /**
+     * The type identifier for calculated shipping. This is always `'Calculated'` to distinguish from custom shipping lines. Calculated shipping rates are determined by carrier APIs, zone-based rules, or automated shipping calculators.
+     */
     type: 'Calculated';
+    /**
+     * The shipping method category indicating whether this is standard shipping delivery or in-store retail pickup:
+     * - `'SHIPPING'`: Traditional carrier-based shipping where items are delivered to a customer address.
+     * - `'RETAIL'`: In-store pickup or buy-online-pickup-in-store (BOPIS) where customers collect items at a physical location.
+     */
     methodType: 'SHIPPING' | 'RETAIL';
 }
+/**
+ * Represents a custom shipping line with merchant-defined shipping charges.
+ */
 export interface CustomShippingLine extends ShippingLine {
+    /**
+     * The type identifier for custom shipping. This is always `'Custom'` to distinguish from calculated shipping lines. Custom shipping rates are manually set by merchants rather than calculated by carrier APIs or automated systems.
+     */
     type: 'Custom';
 }
 //# sourceMappingURL=shipping-line.d.ts.map

package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-line.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/shipping-line.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AAExC,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,UAAU,GAAG,QAAQ,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,QAAQ,CAAC;CAChB"}
+{"version":3,"file":"shipping-line.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/shipping-line.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IACnB;;;;OAIG;IACH,UAAU,EAAE,UAAU,GAAG,QAAQ,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB"}

package/build/ts/surfaces/point-of-sale/types/storage.d.ts

@@ -3,40 +3,42 @@ export declare class StorageError extends Error {
     name: string;
     constructor(code: 'RecordsCount' | 'RecordSize' | 'KeyType' | 'KeySize', message: string);
 }
+/**
+ * Defines the storage interface for persisting extension data across sessions.
+ */
 export interface Storage<BaseStorageTypes extends Record<string, any> = Record<string, unknown>> {
     /**
-     * Sets the value of a key in the storage.
+     * Stores a value under the specified key, overwriting any existing value. Values must be JSON-serializable and return `StorageError` when storage limits are exceeded. Commonly used for storing user preferences, caching API responses, or passing contextual data from tiles to modals.
      *
      * @param key - The key to set the value for.
      * @param value - The value to set for the key.
-     * Can be any primitive type supported by `JSON.stringify`.
      * @throws StorageError when:
-     *    the extension exceeds its allotted storage limit.
-     *    the value exceeds its allotted storage limit.
-     *    the key is not a string or exceeds its allotted size.
+     * - Maximum number of records is exceeded (`code: 'RecordsCount'`)
+     * - Individual record size exceeds the limit (`code: 'RecordSize'`)
+     * - Key is not a string (`code: 'KeyType'`)
+     * - Key size exceeds the limit (`code: 'KeySize'`)
      */
     set<StorageTypes extends BaseStorageTypes = BaseStorageTypes, Keys extends keyof StorageTypes = keyof StorageTypes>(key: Keys, value: StorageTypes[Keys]): Promise<void>;
     /**
-     * Gets the value of a key in the storage.
+     * Retrieves the value associated with a key, returning `undefined` if the key doesn't exist. Always handle the `undefined` case by providing fallback values or conditional logic. Commonly used for loading user preferences, retrieving cached data, or accessing contextual information passed between extension targets.
      *
      * @param key - The key to get the value for.
      * @returns The value of the key.
-     * If no value for the key exists, the resolved value is undefined.
-     * @throws StorageError when the key is not a string or exceeds its allotted size.
+     * @throws StorageError when the key isn't a string or exceeds its allotted size.
      */
     get<StorageTypes extends BaseStorageTypes = BaseStorageTypes, Keys extends keyof StorageTypes = keyof StorageTypes>(key: Keys): Promise<StorageTypes[Keys] | undefined>;
     /**
-     * Clears the storage.
+     * Clears all data from storage, removing all key-value pairs.
      */
     clear: () => Promise<void>;
     /**
-     * Deletes a key from the storage.
+     * Deletes a specific key from storage and returns `true` if the key existed, `false` if it didn't exist. Returns `false` for non-existent keys rather than throwing an error. Commonly used for cleaning up temporary workflow data, removing expired cache entries, or handling user preference changes.
      *
      * @param key - The key to delete.
      */
     delete<StorageTypes extends BaseStorageTypes = BaseStorageTypes, Keys extends keyof StorageTypes = keyof StorageTypes>(key: Keys): Promise<boolean>;
     /**
-     * Gets all the keys and values in the storage.
+     * Retrieves all stored key-value pairs as an array of tuples, preserving original data types. Returns all data at once which may impact memory usage with large datasets. Commonly used for debugging storage contents, implementing data export features, or performing bulk operations across stored data.
      *
      * @returns An array containing all the keys and values in the storage.
      */

package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/storage.ts"],"names":[],"mappings":"AAAA,qBAAa,YAAa,SAAQ,KAAK;IAG5B,IAAI,EAAE,cAAc,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS;IAF7D,IAAI,SAAkB;gBAEpB,IAAI,EAAE,cAAc,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,EAClE,OAAO,EAAE,MAAM;CAIlB;AACD,MAAM,WAAW,OAAO,CACtB,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEtE;;;;;;;;;;OAUG;IACH,GAAG,CACD,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,EACT,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,GACxB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;;OAOG;IACH,GAAG,CACD,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;IAE3C;;OAEG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CACJ,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB;;;;OAIG;IACH,OAAO,CACL,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,KACjD,OAAO,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;CAC5C"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/storage.ts"],"names":[],"mappings":"AAAA,qBAAa,YAAa,SAAQ,KAAK;IAG5B,IAAI,EAAE,cAAc,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS;IAF7D,IAAI,SAAkB;gBAEpB,IAAI,EAAE,cAAc,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,EAClE,OAAO,EAAE,MAAM;CAIlB;AACD;;GAEG;AACH,MAAM,WAAW,OAAO,CACtB,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEtE;;;;;;;;;;OAUG;IACH,GAAG,CACD,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,EACT,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,GACxB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;OAMG;IACH,GAAG,CACD,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;IAE3C;;OAEG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CACJ,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB;;;;OAIG;IACH,OAAO,CACL,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,KACjD,OAAO,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;CAC5C"}

package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts

@@ -1,13 +1,34 @@
 import type { Money } from './money';
+/**
+ * Represents a tax line applied to an item or transaction.
+ */
 export interface TaxLine {
+    /**
+     * The title or name of the tax.
+     */
     title: string;
+    /**
+     * The tax amount as a Money object.
+     */
     price: Money;
+    /**
+     * The tax rate as a decimal number.
+     */
     rate: number;
+    /**
+     * The unique identifier for this tax line.
+     */
     uuid?: string;
+    /**
+     * The range of tax rates if applicable.
+     */
     rateRange?: {
         min: number;
         max: number;
     };
+    /**
+     * Whether this tax is currently enabled.
+     */
     enabled?: boolean;
 }
 //# sourceMappingURL=tax-line.d.ts.map

package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tax-line.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/tax-line.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAEnC,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,CAAC;IACvC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}
+{"version":3,"file":"tax-line.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/tax-line.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,CAAC;IACvC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}

package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts

@@ -1,2 +1,9 @@
+/**
+ * The types of transactions that can be processed in POS:
+ * - `'Sale'`: A new sale transaction where a customer purchases products or services. This creates a new order and processes payment. The most common transaction type in POS operations.
+ * - `'Return'`: A return transaction where a customer returns previously purchased items for a refund. This credits back payment to the customer and returns items to inventory.
+ * - `'Exchange'`: An exchange transaction where a customer returns items and simultaneously purchases replacement items. This combines return and sale operations in a single transaction, often with a price adjustment.
+ * - `'Reprint'`: A receipt reprint operation where an existing transaction's receipt is reprinted. No new transaction is created—this only regenerates the receipt document for an existing sale, return, or exchange.
+ */
 export type TransactionType = 'Sale' | 'Return' | 'Exchange' | 'Reprint';
 //# sourceMappingURL=transaction-type.d.ts.map

package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction-type.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/transaction-type.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC"}
+{"version":3,"file":"transaction-type.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/transaction-type.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC"}