@shopify/ui-extensions 2025.7.2 → 2025.8.0

package/build/ts/surfaces/point-of-sale/render/api/customer-api/customer-api.d.ts

@@ -1,9 +1,12 @@
+/**
+ * The `CustomerApi` object provides access to customer data in customer-specific extension contexts. Access this property through `shopify.customer` to retrieve information about the customer currently being viewed or interacted with in the POS interface.
+ */
 export interface CustomerApi {
     customer: CustomerApiContent;
 }
 export interface CustomerApiContent {
     /**
-     * The unique identifier for the customer
+     * The unique identifier for the customer. Use for customer lookups, applying customer-specific pricing, enabling personalized features, and integrating with external systems.
      */
     id: number;
 }

package/build/ts/surfaces/point-of-sale/render/api/customer-api/customer-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customer-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/customer-api/customer-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ"}
+{"version":3,"file":"customer-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/customer-api/customer-api.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ"}

package/build/ts/surfaces/point-of-sale/render/api/device-api/device-api.d.ts

@@ -1,19 +1,23 @@
 export interface DeviceApiContent {
     /**
-     * The name of the device
+     * The name of the device as configured by the merchant or system. Use for displaying device information in interfaces, logging, or support contexts where device identification is helpful.
      */
     name: string;
     /**
-     * The string ID of the device
+     * A short, unique identifier for the device, assigned by Shopify.
+     */
+    registerName: string;
+    /**
+     * Retrieves the unique string identifier for the device. Returns a promise that resolves to the device ID. Use for device-specific data storage, analytics tracking, or implementing device-based permissions and configurations.
      */
     getDeviceId(): Promise<string>;
     /**
-     * Whether the device is a tablet
+     * Determines whether the device is a tablet form factor. Returns a promise that resolves to `true` for tablets, `false` for other device types. Use for implementing responsive design, optimizing touch targets, or providing device-appropriate user experiences.
      */
     isTablet(): Promise<boolean>;
 }
 /**
- * Access information about the device, like name and ID
+ * The `DeviceApi` object provides access to device information and capabilities. Access these properties and methods through `shopify.device` to retrieve device details and check device characteristics.
  */
 export interface DeviceApi {
     device: DeviceApiContent;

package/build/ts/surfaces/point-of-sale/render/api/device-api/device-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"device-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/device-api/device-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/B;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,gBAAgB,CAAC;CAC1B"}
+{"version":3,"file":"device-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/device-api/device-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/B;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,gBAAgB,CAAC;CAC1B"}

package/build/ts/surfaces/point-of-sale/render/api/draft-order-api/draft-order-api.d.ts

@@ -1,17 +1,20 @@
+/**
+ * The `DraftOrderApi` object provides access to draft order data in draft order-specific extension contexts. Access this property through `shopify.draftOrder` to retrieve information about the draft order currently being viewed or interacted with in the POS interface.
+ */
 export interface DraftOrderApi {
     draftOrder: DraftOrderApiContent;
 }
 export interface DraftOrderApiContent {
     /**
-     * The unique identifier for the draft order
+     * The unique identifier for the draft order. Use for draft order lookups, implementing order-specific functionality, and integrating with external systems.
      */
     id: number;
     /**
-     * The name of the draft order
+     * The name of the draft order as configured by the merchant. Use for draft order identification, displays, and customer-facing interfaces.
      */
     name: string;
     /**
-     * The unique identifier of the customer associated with the draft order
+     * The unique identifier of the customer associated with the draft order. Returns `undefined` if no customer is associated. Use for customer-specific functionality and personalized experiences.
      */
     customerId?: number;
 }

package/build/ts/surfaces/point-of-sale/render/api/draft-order-api/draft-order-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"draft-order-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/draft-order-api/draft-order-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,oBAAoB,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"draft-order-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/draft-order-api/draft-order-api.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,oBAAoB,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/build/ts/surfaces/point-of-sale/render/api/locale-api/locale-api.d.ts

@@ -1,13 +1,12 @@
 import type { RemoteSubscribable } from '@remote-ui/async-subscription';
 export interface LocaleApiContent {
-    /** IETF-formatted locale at time of page load and a callback to subscribe to value changes. Current supports only one subscription.
-     * You can utilize `makeStatefulSubscribable` on a `RemoteSubscribable` to implement multiple subscriptions.
-     * Using `makeStatefulSubscribable` or the corresponding hooks counts as a subscription.
+    /**
+     * Provides the current IETF-formatted locale (for example, `"en-US"`) and allows you to subscribe to locale changes. Supports only one subscription at a time. To enable multiple subscriptions, use `makeStatefulSubscribable` on the `RemoteSubscribable` object. Using `makeStatefulSubscribable` or related hooks counts as an active subscription.
      */
     subscribable: RemoteSubscribable<string>;
 }
 /**
- * Access the merchant’s current locale (in [IETF format](https://en.wikipedia.org/wiki/IETF_language_tag)) to internationalize your extension content.
+ * The `LocaleApi` object provides access to current locale information and change notifications. Access these properties through `api.locale` to retrieve and monitor locale data.
  */
 export interface LocaleApi {
     locale: LocaleApiContent;

package/build/ts/surfaces/point-of-sale/render/api/locale-api/locale-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"locale-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/locale-api/locale-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AAEtE,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,YAAY,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,gBAAgB,CAAC;CAC1B"}
+{"version":3,"file":"locale-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/locale-api/locale-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AAEtE,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,YAAY,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,gBAAgB,CAAC;CAC1B"}

package/build/ts/surfaces/point-of-sale/render/api/navigation-api/navigation-api.d.ts

@@ -1,17 +1,19 @@
 export interface NavigationApiContent {
-    /** Navigate to a route in current navigation tree.
-     * Pushes the specified screen if it isn't present in the navigation tree, goes back to a created screen otherwise.
-     * @param screenName the name of the screen you want to navigate to.
-     * @param params the parameters you want to pass to that screen.
+    /**
+     * Navigate to a route in current navigation tree. Pushes the specified screen if it isn't present in the navigation tree, goes back to a created screen otherwise. Use for implementing multi-screen workflows with parameter passing between screens.
      */
     navigate(screenName: string, params?: any): void;
-    /** Pops the currently shown screen */
+    /**
+     * Pops the currently shown screen from the navigation stack. Use for implementing back navigation, returning to previous screens, or programmatically navigating backward in multi-screen workflows.
+     */
     pop(): void;
-    /** Dismisses the extension. */
+    /**
+     * Dismisses the extension modal completely. Use for closing the modal when workflows are complete, cancelled, or when users need to return to the main POS interface.
+     */
     dismiss(): void;
 }
 /**
- * Access the navigation API for navigation functionality from a full screen modal.
+ * The `NavigationApi` object provides screen-based navigation functionality for modal interfaces. Access these methods through `api.navigation` to manage screen navigation and modal dismissal.
  */
 export interface NavigationApi {
     navigation: NavigationApiContent;

package/build/ts/surfaces/point-of-sale/render/api/navigation-api/navigation-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"navigation-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/navigation-api/navigation-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAEjD,sCAAsC;IACtC,GAAG,IAAI,IAAI,CAAC;IAEZ,+BAA+B;IAC/B,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,oBAAoB,CAAC;CAClC"}
+{"version":3,"file":"navigation-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/navigation-api/navigation-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,GAAG,IAAI,IAAI,CAAC;IAEZ;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,oBAAoB,CAAC;CAClC"}

package/build/ts/surfaces/point-of-sale/render/api/order-api/order-api.d.ts

@@ -1,23 +1,23 @@
 /**
- * Interface to access the order
+ * The `OrderApi` object provides access to order data in order-specific extension contexts. Access this property through `shopify.order` to retrieve information about the order currently being viewed or interacted with in the POS interface.
  */
 export interface OrderApi {
     order: OrderApiContent;
 }
 /**
- * Interface for Order details
+ * The `OrderApi` object provides access to order data. Access this property through `shopify.order` to interact with the current order context.
  */
 export interface OrderApiContent {
     /**
-     * The unique identifier for the order
+     * The unique identifier for the order. Use for order lookups, implementing order-specific functionality, and integrating with external systems.
      */
     id: number;
     /**
-     * The name of the order
+     * The name of the order as configured by the merchant. Use for order identification, displays, and customer-facing interfaces.
      */
     name: string;
     /**
-     * The unique identifier of the customer associated with the order
+     * The unique identifier of the customer associated with the order. Returns `undefined` if no customer is associated. Use for customer-specific functionality and personalized experiences.
      */
     customerId?: number;
 }

package/build/ts/surfaces/point-of-sale/render/api/print-api/print-api.d.ts

@@ -3,27 +3,22 @@
  */
 export interface PrintApiContent {
     /**
-     * Trigger a print dialog.
+     * Triggers a print dialog for the specified document source. The `print()` method accepts either:
      *
-     * The src must be either:
-     * - A relative path that will be appended to your app's [application_url](/docs/apps/build/cli-for-apps/app-configuration#application_url)
+     * - A relative path that will be appended to your app's [application_url](/docs/apps/build/cli-for-apps/app-configuration)
      * - A full URL to your app's backend that will be used to return the document to print
      *
-     * Supported document types:
-     * - HTML documents (recommended for best printing experience)
-     * - Text files
-     * - Image files (PNG, JPEG, etc.)
-     * - PDF files (Note: On Android devices, PDFs will be downloaded and must be printed using an external application)
-     *
-     * @param src the source URL of the content to print.
-     * @returns Promise<void> that resolves when content is ready and native print dialog appears.
+     * Returns a promise that resolves when content is ready and the native print dialog appears. Use for printing custom documents, receipts, labels, or reports.
      */
     print(src: string): Promise<void>;
 }
 /**
- * Interface for printing
+ * The `PrintApi` object provides methods for triggering document printing. Access these methods through `api.print` to initiate print operations with various document types.
  */
 export interface PrintApi {
+    /**
+     * Provides access to print functionality for triggering the native print dialog with custom documents.
+     */
     print: PrintApiContent;
 }
 //# sourceMappingURL=print-api.d.ts.map

package/build/ts/surfaces/point-of-sale/render/api/print-api/print-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"print-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/print-api/print-api.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,eAAe,CAAC;CACxB"}
+{"version":3,"file":"print-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/print-api/print-api.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;CACxB"}

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

@@ -1,13 +1,16 @@
+/**
+ * The `ProductApi` object provides access to product and variant data in product-specific extension contexts. Access this property through `shopify.product` to retrieve information about the product or variant currently being viewed or interacted with in the POS interface.
+ */
 export interface ProductApi {
     product: ProductApiContent;
 }
 export interface ProductApiContent {
     /**
-     * The unique identifier for the product.
+     * The unique identifier for the product. Use for product lookups, implementing product-specific functionality, and integrating with external systems.
      */
     id: number;
     /**
-     * The unique identifier for the product variant.
+     * The unique identifier for the product variant. Use for variant-specific operations, cart additions, and inventory management.
      */
     variantId: number;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"product-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/product-api/product-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"product-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/product-api/product-api.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/build/ts/surfaces/point-of-sale/render/api/product-search-api/product-search-api.d.ts

@@ -3,7 +3,7 @@ import type { PaginatedResult } from '../../../types/paginated-result';
 import type { Product, ProductVariant } from '../../../types/product';
 export type ProductSortType = 'RECENTLY_ADDED' | 'RECENTLY_ADDED_ASCENDING' | 'ALPHABETICAL_A_TO_Z' | 'ALPHABETICAL_Z_TO_A';
 /**
- * Base interface for pagination.
+ * Specifies parameters for cursor-based pagination. Includes the cursor position and the number of results to retrieve per page.
  */
 export interface PaginationParams {
     /**
@@ -16,7 +16,7 @@ export interface PaginationParams {
     afterCursor?: string;
 }
 /**
- * Interface for product search
+ * Specifies the parameters for searching products. Includes query text, pagination options, and sorting preferences for product search operations.
  */
 export interface ProductSearchParams extends PaginationParams {
     /**
@@ -29,37 +29,51 @@ export interface ProductSearchParams extends PaginationParams {
     sortType?: ProductSortType;
 }
 export interface ProductSearchApiContent {
-    /** Search for products on the POS device.
+    /**
+     * Searches for products on the POS device using text queries and sorting options. Returns paginated results with up to 50 products per page. When a query string is provided, results are sorted by relevance. Use for implementing custom search interfaces, product discovery features, or filtered product listings.
+     *
      * @param searchParams The parameters for the product search.
      */
     searchProducts(searchParams: ProductSearchParams): Promise<PaginatedResult<Product>>;
-    /** Fetches a single product's details.
+    /**
+     * Retrieves detailed information for a single product by its ID. Returns `undefined` if the product doesn't exist or isn't available on the POS device. Use for displaying product details, validating product availability, or building product-specific workflows.
+     *
      * @param productId The ID of the product to lookup.
      */
     fetchProductWithId(productId: number): Promise<Product | undefined>;
-    /** Fetches multiple products' details.
+    /**
+     * Retrieves detailed information for multiple products by their IDs. Limited to 50 products maximum—additional IDs are automatically removed. Returns results with both found and not found products clearly identified. Use for bulk product lookups, building product collections, or validating product lists.
+     *
      * @param productIds Specifies the array of product IDs to lookup. This is limited to 50 products. All excess requested IDs will be removed from the array.
      */
     fetchProductsWithIds(productIds: number[]): Promise<MultipleResourceResult<Product>>;
-    /** Fetches a single product variant's details.
+    /**
+     * Retrieves detailed information for a single product variant by its ID. Returns `undefined` if the variant doesn't exist or isn't available. Use for displaying variant-specific details like pricing, inventory, or options when working with specific product configurations.
+     *
      * @param productVariantId The ID of the product variant to lookup.
      */
     fetchProductVariantWithId(productVariantId: number): Promise<ProductVariant | undefined>;
-    /** Fetches multiple product variants' details.
+    /**
+     * Retrieves detailed information for multiple product variants by their IDs. Limited to 50 variants maximum—additional IDs are automatically removed. Returns results with both found and not found variants clearly identified. Use for bulk variant lookups or building variant-specific collections.
+     *
      * @param productVariantIds Specifies the array of product variant IDs to lookup. This is limited to 50 product variants. All excess requested IDs will be removed from the array.
      */
     fetchProductVariantsWithIds(productVariantIds: number[]): Promise<MultipleResourceResult<ProductVariant>>;
-    /** Fetches all product variants associated with a product.
+    /**
+     * Retrieves all product variants associated with a specific product ID. Returns all variants at once without pagination. Use for displaying complete variant options, building variant selectors, or analyzing all available configurations for a product.
+     *
      * @param productId The product ID. All variants' details associated with this product ID are returned.
      */
     fetchProductVariantsWithProductId(productId: number): Promise<ProductVariant[]>;
-    /** Fetches a page of product variants associated with a product.
+    /**
+     * Retrieves product variants for a specific product with pagination support. Use when a product has many variants and you need to load them incrementally for better performance. Ideal for products with extensive variant collections that would be too large to load at once.
+     *
      * @param paginationParams The parameters for pagination.
      */
     fetchPaginatedProductVariantsWithProductId(productId: number, paginationParams: PaginationParams): Promise<PaginatedResult<ProductVariant>>;
 }
 /**
- * Access Point of Sale's native product search functionality.
+ * The `ProductSearchApi` object provides methods for searching and retrieving product information. Access these methods through `api.productSearch` to search products and fetch detailed product data.
  */
 export interface ProductSearchApi {
     productSearch: ProductSearchApiContent;

package/build/ts/surfaces/point-of-sale/render/api/product-search-api/product-search-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"product-search-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/product-search-api/product-search-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,yCAAyC,CAAC;AACpF,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,EAAC,OAAO,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAEpE,MAAM,MAAM,eAAe,GACvB,gBAAgB,GAChB,0BAA0B,GAC1B,qBAAqB,GACrB,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,cAAc,CACZ,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IAErC;;OAEG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAEpE;;OAEG;IACH,oBAAoB,CAClB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;IAE5C;;OAEG;IACH,yBAAyB,CACvB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAEvC;;OAEG;IACH,2BAA2B,CACzB,iBAAiB,EAAE,MAAM,EAAE,GAC1B,OAAO,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC,CAAC;IAEnD;;OAEG;IACH,iCAAiC,CAC/B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE7B;;OAEG;IACH,0CAA0C,CACxC,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,uBAAuB,CAAC;CACxC"}
+{"version":3,"file":"product-search-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/product-search-api/product-search-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,yCAAyC,CAAC;AACpF,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,EAAC,OAAO,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAEpE,MAAM,MAAM,eAAe,GACvB,gBAAgB,GAChB,0BAA0B,GAC1B,qBAAqB,GACrB,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,cAAc,CACZ,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IAErC;;;;OAIG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAEpE;;;;OAIG;IACH,oBAAoB,CAClB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;IAE5C;;;;OAIG;IACH,yBAAyB,CACvB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAEvC;;;;OAIG;IACH,2BAA2B,CACzB,iBAAiB,EAAE,MAAM,EAAE,GAC1B,OAAO,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC,CAAC;IAEnD;;;;OAIG;IACH,iCAAiC,CAC/B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE7B;;;;OAIG;IACH,0CAA0C,CACxC,SAAS,EAAE,MAAM,EACjB,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,uBAAuB,CAAC;CACxC"}

package/build/ts/surfaces/point-of-sale/render/api/scanner-api/scanner-api.d.ts

@@ -1,26 +1,38 @@
 import type { RemoteSubscribable } from '@remote-ui/async-subscription';
 /** The scanner source the POS device supports. */
 export type ScannerSource = 'camera' | 'external' | 'embedded';
+/**
+ * Represents the data from a scanner event. Contains the scanned string data and the hardware source that captured the scan.
+ */
 export interface ScannerSubscriptionResult {
-    /** The string data from the last scanner event received. */
+    /**
+     * The string data from the last scanner event received. Contains the scanned barcode, QR code, or other scannable data. Returns `undefined` when no scan data is available. Use to process scanned content and implement scan-based business logic.
+     */
     data?: string;
-    /** The scanning source from which the scan event came. */
+    /**
+     * The scanning source from which the scan event came. Returns one of the following scanner types:
+     *
+     * • `'camera'` - Device camera for scanning through the camera interface (available on most mobile POS devices)
+     * • `'external'` - External scanner hardware connected using USB, Bluetooth, or other methods (handheld scanners, dedicated devices)
+     * • `'embedded'` - Built-in scanning hardware integrated into the POS device (specialized terminals with integrated scanning)
+     *
+     * Returns `undefined` when no scan source is available. Use to implement source-specific logic or provide feedback about scanning method.
+     */
     source?: ScannerSource;
 }
 export interface ScannerApiContent {
-    /** Creates a subscription to scan events
-     * Provides an initial value and a callback to subscribe to value changes. Currently supports only one subscription.
-     * You can utilize `makeStatefulSubscribable` on a `RemoteSubscribable` to implement multiple subscriptions.
-     * Using `makeStatefulSubscribable` or the corresponding hooks counts as a subscription.
+    /**
+     * Subscribe to scan events to receive barcode and QR code data when scanned. Supports one subscription at a time. Use for receiving real-time scan results.
      */
     scannerDataSubscribable: RemoteSubscribable<ScannerSubscriptionResult>;
-    /** Creates a subscription to the scanning sources available on the POS device.
-     * Provides an initial value and a callback to subscribe to value changes. Currently supports only one subscription.
-     * You can utilize `makeStatefulSubscribable` on a `RemoteSubscribable` to implement multiple subscriptions.
-     * Using `makeStatefulSubscribable` or the corresponding hooks counts as a subscription.
+    /**
+     * Subscribe to changes in available scanner sources on the device. Supports one subscription at a time. Use to monitor which scanners are available (camera, external, or embedded).
      */
     scannerSourcesSubscribable: RemoteSubscribable<ScannerSource[]>;
 }
+/**
+ * The `ScannerApi` object provides access to scanning functionality and scanner source information. Access these properties through `api.scanner` to monitor scan events and available scanner sources.
+ */
 export interface ScannerApi {
     scanner: ScannerApiContent;
 }

package/build/ts/surfaces/point-of-sale/render/api/scanner-api/scanner-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scanner-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/scanner-api/scanner-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AAEtE,kDAAkD;AAClD,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;AAE/D,MAAM,WAAW,yBAAyB;IACxC,4DAA4D;IAC5D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0DAA0D;IAC1D,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,uBAAuB,EAAE,kBAAkB,CAAC,yBAAyB,CAAC,CAAC;IACvE;;;;OAIG;IACH,0BAA0B,EAAE,kBAAkB,CAAC,aAAa,EAAE,CAAC,CAAC;CACjE;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B"}
+{"version":3,"file":"scanner-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/scanner-api/scanner-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AAEtE,kDAAkD;AAClD,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,uBAAuB,EAAE,kBAAkB,CAAC,yBAAyB,CAAC,CAAC;IACvE;;OAEG;IACH,0BAA0B,EAAE,kBAAkB,CAAC,aAAa,EAAE,CAAC,CAAC;CACjE;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B"}

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

@@ -1,19 +1,16 @@
 import type { Session } from '../../../types/session';
 export interface SessionApiContent {
     /**
-     * Access information on the current POS session.
+     * Provides comprehensive information about the current POS session including shop details, user authentication, location data, staff member information, currency settings, and POS version. This data is static for the duration of the session and updates when users switch locations or staff members change.
      */
     currentSession: Session;
     /**
-     * Get a fresh session token for communication with your app's backend service.
-     * When the authenticated user (the user that logged into Shopify POS with their email address) doesn't have the correct app permissions enabled for your app, null will be returned. This is irrelevant of which POS Staff member is pinned in, as those are not authenticated users.
-     * For more information, see our [app permissions documentation](https://help.shopify.com/en/manual/your-account/users/roles/permissions/store-permissions#apps-and-channels-permissions).
-     * Calls to Shopify APIs must be made by your app’s backend service.
+     * Generates a fresh session token for secure communication with your app's backend service. Returns `undefined` when the authenticated user lacks proper app permissions. The token is a Shopify OpenID Connect ID Token that should be used in `Authorization` headers for backend API calls. This is based on the authenticated user, not the pinned staff member.
      */
     getSessionToken: () => Promise<string | undefined>;
 }
 /**
- * Access information on the current Session, including data on the current shop, user, staff and location.
+ * The `SessionApi` object provides access to current session information and authentication methods. Access these properties and methods through `shopify.session` to retrieve shop data and generate secure tokens. These methods enable secure API calls while maintaining user privacy and [app permissions](https://help.shopify.com/manual/your-account/users/roles/permissions/store-permissions#apps-and-channels-permissions).
  */
 export interface SessionApi {
     session: SessionApiContent;

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

@@ -1 +1 @@
-{"version":3,"file":"session-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/session-api/session-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,wBAAwB,CAAC;AAEpD,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,eAAe,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B"}
+{"version":3,"file":"session-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/session-api/session-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,wBAAwB,CAAC;AAEpD,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,eAAe,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B"}

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

@@ -1,5 +1,12 @@
 import { Storage } from '../../../types/storage';
+/**
+ * The Storage API provides persistent local storage for POS UI extensions, allowing you to store, retrieve, and manage extension data
+ * that persists across user sessions, device restarts, and extension target state changes. Access these methods through `api.storage`.
+ */
 export interface StorageApi {
+    /**
+     * Provides access to the persistent local storage methods for storing and retrieving extension data.
+     */
     storage: Storage;
 }
 //# sourceMappingURL=storage-api.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"storage-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/storage-api/storage-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,wBAAwB,CAAC;AAE/C,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"storage-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/storage-api/storage-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,wBAAwB,CAAC;AAE/C;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB"}

package/build/ts/surfaces/point-of-sale/render/api/toast-api/toast-api.d.ts

@@ -1,14 +1,24 @@
+/**
+ * Specifies configuration options for displaying toast notifications. Controls the duration and display behavior of temporary notification messages.
+ */
 export interface ShowToastOptions {
+    /**
+     * The duration in milliseconds that the toast message should remain visible before automatically dismissing. If not specified, the toast will use the default system duration. Use shorter durations for simple confirmations and longer durations for important messages that users need time to read.
+     */
     duration?: number;
 }
 export interface ToastApiContent {
     /**
-     * Show a toast.
+     * Displays a toast notification with the specified text content. The message appears as a temporary overlay that automatically dismisses after the specified duration. Use for providing immediate user feedback, confirming actions, or communicating status updates without interrupting the user's workflow.
+     *
      * @param content The text content to display.
      * @param options An object containing ShowToastOptions.
      */
     show: (content: string, options?: ShowToastOptions) => void;
 }
+/**
+ * The `ToastApi` object provides methods for displaying temporary notification messages. Access these methods through `shopify.toast` to show user feedback and status updates.
+ */
 export interface ToastApi {
     toast: ToastApiContent;
 }

package/build/ts/surfaces/point-of-sale/render/api/toast-api/toast-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toast-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/toast-api/toast-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,KAAK,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,eAAe,CAAC;CACxB"}
+{"version":3,"file":"toast-api.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/api/toast-api/toast-api.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,KAAK,IAAI,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,eAAe,CAAC;CACxB"}

package/build/ts/surfaces/point-of-sale/render/components/Badge/Badge.d.ts

@@ -1,22 +1,25 @@
 export type BadgeVariant = 'neutral' | 'critical' | 'warning' | 'success' | 'highlight';
 export type BadgeStatus = 'empty' | 'partial' | 'complete';
-/**
- * @property text - The text displayed inside the badge.
- * @property variant - The appearance and function of the badge.
- * @property status - A circle icon displaying the status of the badge.
- * @deprecated status - No longer supported as of POS 10.0.0.
- */
 export interface BadgeProps {
     /**
-     * The text displayed inside the badge.
+     * The text content displayed within the badge. Keep this concise and descriptive to clearly communicate status or category information. Examples include "Paid," "Pending," "Out of Stock," or "VIP Customer."
      */
     text: string;
     /**
-     * The appearance and function of the badge.
+     * Controls the visual styling and semantic meaning of the badge. Available options:
+     * - `'neutral'` - Gray styling for general status information that doesn't require emphasis. Use for general status updates and standard information.
+     * - `'critical'` - Red styling for errors, failures, and urgent issues requiring immediate action. Use for urgent issues that need immediate merchant attention.
+     * - `'warning'` - Orange styling for important notices that require merchant awareness. Use for situations that need attention but aren't critical.
+     * - `'success'` - Green styling for positive states, completed actions, and successful operations. Use for positive outcomes and successful processes.
+     * - `'highlight'` - Bright styling for featured content, promotions, or emphasized information. Use for featured content that should stand out.
      */
     variant: BadgeVariant;
     /**
-     * A circle icon displaying the status of the badge.
+     * Displays a circular status indicator alongside the badge text. This property is deprecated as of POS 10.0.0 and should not be used in new implementations. Available options: Use the `variant` property instead to convey status information in new implementations.
+     * - `'empty'` - Shows an empty circle indicator
+     * - `'partial'` - Shows a partially filled circle indicator
+     * - `'complete'` - Shows a completely filled circle indicator
+     *
      * @deprecated No longer supported as of POS 10.0.0.
      */
     status?: BadgeStatus;

package/build/ts/surfaces/point-of-sale/render/components/Badge/Badge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Badge.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/components/Badge/Badge.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,UAAU,GACV,SAAS,GACT,SAAS,GACT,WAAW,CAAC;AAEhB,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,eAAO,MAAM,KAAK;;;;CAAsD,CAAC"}
+{"version":3,"file":"Badge.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/components/Badge/Badge.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,UAAU,GACV,SAAS,GACT,SAAS,GACT,WAAW,CAAC;AAEhB,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,CAAC;AAC3D,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,OAAO,EAAE,YAAY,CAAC;IAEtB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,eAAO,MAAM,KAAK;;;;CAAsD,CAAC"}

package/build/ts/surfaces/point-of-sale/render/components/Banner/Banner.d.ts

@@ -1,38 +1,37 @@
 export type BannerVariant = 'confirmation' | 'alert' | 'error' | 'information';
-/**
- * @property title - The title text displayed on the banner.
- * @property variant - The variant type of the banner.
- * @property action - The text for the action button.
- * @property onPress - The callback function executed when the banner is pressed.
- * @property hideAction - Whether to hide the action button.
- * @property visible - The visibility state of the banner.
- */
 export interface BannerProps {
     /**
-     * The title text displayed on the banner.
+     * The title text displayed prominently on the banner. This should be concise and clearly communicate the main message or purpose of the banner to merchants.
      */
     title: string;
     /**
-     * The variant type of the banner.
+     * Controls the visual styling and semantic meaning of the banner. Available options:
+     * - `'confirmation'` - Green styling for positive outcomes, successful operations, and completed actions
+     * - `'alert'` - Orange styling for important notices and situations that require merchant attention
+     * - `'error'` - Red styling for critical errors, failures, and urgent issues requiring immediate action
+     * - `'information'` - Blue styling for general information, neutral updates, and helpful tips
      */
     variant: BannerVariant;
     /**
-     * The text for the action button.
+     * The text displayed on the action button within the banner. This provides a clear call-to-action for merchants to address the banner's message. Default is `'Dismiss'` if not specified.
+     *
      * @defaultValue 'Dismiss'
      */
     action?: string;
     /**
-     * The callback function executed when the banner is pressed.
+     * The callback function executed when the banner or its action button is pressed. Use this to handle user interactions such as dismissing the banner, navigating to relevant screens, or triggering specific actions. Default behavior dismisses the banner if not specified.
+     *
      * @defaultValue Callback which dismisses the banner
      */
     onPress?: () => void;
     /**
-     * Whether to hide the action button.
+     * Determines whether the action button is visible on the banner. When set to `true`, the action button is hidden, creating a display-only banner. When `false`, the action button is shown with the specified action text. Default is `true` (action button hidden).
+     *
      * @defaultValue true
      */
     hideAction?: boolean;
     /**
-     * The visibility state of the banner.
+     * Controls the visibility state of the banner. When set to `true`, the banner is displayed. When `false`, it's hidden. Use this to programmatically show or hide banners based on application state or user interactions.
      */
     visible: boolean;
 }

package/build/ts/surfaces/point-of-sale/render/components/Banner/Banner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Banner.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/components/Banner/Banner.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG,OAAO,GAAG,OAAO,GAAG,aAAa,CAAC;AAE/E;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC;IAEvB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,eAAO,MAAM,MAAM;;;;CAAyD,CAAC"}
+{"version":3,"file":"Banner.d.ts","sourceRoot":"","sources":["../../../../../../../src/surfaces/point-of-sale/render/components/Banner/Banner.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG,OAAO,GAAG,OAAO,GAAG,aAAa,CAAC;AAE/E,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,OAAO,EAAE,aAAa,CAAC;IAEvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAErB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,eAAO,MAAM,MAAM;;;;CAAyD,CAAC"}