@shopify/ui-extensions 2023.7.2 → 2024.1.0

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

@@ -0,0 +1,113 @@
+import type { RemoteSubscribable } from '@remote-ui/async-subscription';
+import type { Address, Cart, Customer, CustomSale, SetLineItemDiscountInput, SetLineItemPropertiesInput } from '../types/cart';
+/**
+ * Access and modify the merchant’s current cart.
+ */
+export interface CartApi {
+    cart: CartApiContent;
+}
+/**
+ * @deprecated
+ * PriceOverride is no longer supported. Code discounts are only supported at the Cart level.
+ * Please migrate to using CartDiscountType and LineItemDiscountType as soon as possible.
+ */
+export type DiscountType = 'Percentage' | 'FixedAmount' | 'PriceOverride' | 'Code';
+export type CartDiscountType = 'Percentage' | 'FixedAmount' | 'Code';
+export type LineItemDiscountType = 'Percentage' | 'FixedAmount';
+export interface CartApiContent {
+    /** Provides a subscription to POS cart changes.
+     * Provides an initial value and a callback to subsribe 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.
+     */
+    subscribable: RemoteSubscribable<Cart>;
+    /** Apply a cart level discount
+     * @param type the type of discount applied (example: 'Percentage')
+     * @param title the title attributed with the discount
+     * @param amount the percentage or fixed monetary amount deducted with the discount. Pass in `undefined` if using discount codes.
+     */
+    applyCartDiscount(type: CartDiscountType, title: string, amount?: string): Promise<void>;
+    /** Remove the cart discount */
+    removeCartDiscount(): Promise<void>;
+    /** Clear the cart */
+    clearCart(): Promise<void>;
+    /** Set the customer in the cart
+     * @param customer the customer object to add to the cart
+     */
+    setCustomer(customer: Customer): Promise<void>;
+    /** Remove the current customer from the cart */
+    removeCustomer(): Promise<void>;
+    /** Add a custom sale to the cart
+     * @param customSale the custom sale object to add to the cart
+     */
+    addCustomSale(customSale: CustomSale): Promise<void>;
+    /** Add a line item by variant ID to the cart
+     * @param variantId the product variant's numeric ID to add to the cart
+     * @param quantity the number of this variant to add to the cart
+     */
+    addLineItem(variantId: number, quantity: number): Promise<void>;
+    /** Remove the line item at this uuid from the cart
+     * @param uuid the uuid of the line item that should be removed
+     */
+    removeLineItem(uuid: string): Promise<void>;
+    /** Adds custom properties to the cart
+     * @param properties the custom key to value object to attribute to the cart
+     */
+    addCartProperties(properties: Record<string, string>): Promise<void>;
+    /** Removes the specified cart properties
+     * @param keys the collection of keys to be removed from the cart properties
+     */
+    removeCartProperties(keys: string[]): Promise<void>;
+    /** Adds custom properties to the specified line item
+     * @param uuid the uuid of the line item to which the properties should be stringd
+     * @param properties the custom key to value object to attribute to the line item
+     */
+    addLineItemProperties(uuid: string, properties: Record<string, string>): Promise<void>;
+    /** Adds custom properties to multiple line items at the same time.
+     * @param lineItemProperties the collection of custom line item properties to apply to their respective line items.
+     */
+    bulkAddLineItemProperties(lineItemProperties: SetLineItemPropertiesInput[]): Promise<void>;
+    /** Removes the specified line item properties
+     * @param uuid the uuid of the line item to which the properties should be removed
+     * @param keys the collection of keys to be removed from the line item properties
+     */
+    removeLineItemProperties(uuid: string, keys: string[]): Promise<void>;
+    /** Add a discount on a line item to the cart
+     * @param uuid the uuid of the line item that should receive a discount
+     * @param type the type of discount applied (example: 'Percentage')
+     * @param title the title attributed with the discount
+     * @param amount the percentage or fixed monetary amount deducted with the discout
+     */
+    setLineItemDiscount(uuid: string, type: LineItemDiscountType, title: string, amount: string): Promise<void>;
+    /** Set line item discounts to multiple line items at the same time.
+     * @param lineItemDiscounts a map of discounts to add. They key is the uuid of the line item you want to add the discount to. The value is the discount input.
+     */
+    bulkSetLineItemDiscounts(lineItemDiscounts: SetLineItemDiscountInput[]): Promise<void>;
+    /** Sets an attributed staff to all line items in the cart.
+     * @param staffId the ID of the staff. Providing undefined will clear the attributed staff from all line items.
+     */
+    setAttributedStaff(staffId: number | undefined): Promise<void>;
+    /** Sets an attributed staff to a specific line items in the cart.
+     * @param staffId the ID of the staff. Providing undefined will clear the attributed staff on the line item.
+     * @param lineItemUuid the UUID of the line item.
+     */
+    setAttributedStaffToLineItem(staffId: number | undefined, lineItemUuid: string): Promise<void>;
+    /** Remove all discounts from a line item
+     * @param uuid the uuid of the line item whose discounts should be removed
+     */
+    removeLineItemDiscount(uuid: string): Promise<void>;
+    /** Add an address to the customer (Customer must be present)
+     * @param address the address object to add to the customer in cart
+     */
+    addAddress(address: Address): Promise<void>;
+    /**
+     * Delete an address from the customer (Customer must be present)
+     * @param addressId the address ID to delete
+     */
+    deleteAddress(addressId: number): Promise<void>;
+    /** Update the default address for the customer (Customer must be present)
+     * @param addressId the address ID to set as the default address
+     */
+    updateDefaultAddress(addressId: number): Promise<void>;
+}
+//# sourceMappingURL=cart-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cart-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/cart-api/cart-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EACV,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,eAAe,CAAC;AAEvB;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,cAAc,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GACpB,YAAY,GACZ,aAAa,GACb,eAAe,GACf,MAAM,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG,aAAa,GAAG,MAAM,CAAC;AAErE,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG,aAAa,CAAC;AAEhE,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,YAAY,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAEvC;;;;OAIG;IACH,iBAAiB,CACf,IAAI,EAAE,gBAAgB,EACtB,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB,+BAA+B;IAC/B,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC,qBAAqB;IACrB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C,gDAAgD;IAChD,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC;;OAEG;IACH,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;;OAGG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;OAEG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;OAEG;IACH,iBAAiB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;;OAEG;IACH,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;OAGG;IACH,qBAAqB,CACnB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACjC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;OAEG;IACH,yBAAyB,CACvB,kBAAkB,EAAE,0BAA0B,EAAE,GAC/C,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;OAGG;IACH,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;;;;OAKG;IACH,mBAAmB,CACjB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,oBAAoB,EAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;OAEG;IACH,wBAAwB,CACtB,iBAAiB,EAAE,wBAAwB,EAAE,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;OAEG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;OAGG;IACH,4BAA4B,CAC1B,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;OAEG;IACH,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;OAGG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;OAEG;IACH,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxD"}

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

@@ -0,0 +1,22 @@
+import type { RemoteSubscribable } from '@remote-ui/async-subscription';
+export type ConnectivityStateSeverity = 'Connected' | 'Disconnected';
+export interface ConnectivityState {
+    /**
+     * Whether the device is connected to the internet
+     */
+    internetConnected: ConnectivityStateSeverity;
+}
+export interface ConnectivityApiContent {
+    /**
+     * Creates a subscription to changes in connectivity.
+     * Provides an initial value and a callback to subscribe to value changes.
+     */
+    subscribable: RemoteSubscribable<ConnectivityState>;
+}
+/**
+ * Access information about the device connectivity
+ */
+export interface ConnectivityApi {
+    connectivity: ConnectivityApiContent;
+}
+//# sourceMappingURL=connectivity-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"connectivity-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/connectivity-api/connectivity-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AAEtE,MAAM,MAAM,yBAAyB,GAAG,WAAW,GAAG,cAAc,CAAC;AAErE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,iBAAiB,EAAE,yBAAyB,CAAC;CAC9C;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,YAAY,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,sBAAsB,CAAC;CACtC"}

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

@@ -0,0 +1,21 @@
+export interface DeviceApiContent {
+    /**
+     * The name of the device
+     */
+    name: string;
+    /**
+     * The string ID of the device
+     */
+    getDeviceId(): Promise<string>;
+    /**
+     * Whether the device is a tablet
+     */
+    isTablet(): Promise<boolean>;
+}
+/**
+ * Access information about the device, like name and ID
+ */
+export interface DeviceApi {
+    device: DeviceApiContent;
+}
+//# sourceMappingURL=device-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"device-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/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"}

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

@@ -0,0 +1,15 @@
+import type { RemoteSubscribable } from '@remote-ui/async-subscription';
+export interface LocaleApiContent {
+    /** IETF-formatted locale at time of page load and a callback to subsribe 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.
+     */
+    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.
+ */
+export interface LocaleApi {
+    locale: LocaleApiContent;
+}
+//# sourceMappingURL=locale-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"locale-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/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"}

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

@@ -0,0 +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(screenName: string, params?: any): void;
+    /** Pops the currently shown screen */
+    pop(): void;
+    /** Dismisses the modal highest on the stack */
+    dismiss(): void;
+}
+/**
+ * Access the navigation API for navigation functionality from a full screen modal.
+ */
+export interface NavigationApi {
+    navigation: NavigationApiContent;
+}
+//# sourceMappingURL=navigation-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"navigation-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/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,+CAA+C;IAC/C,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,oBAAoB,CAAC;CAClC"}

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

@@ -0,0 +1,58 @@
+import type { Product, ProductVariant } from '../types/product';
+import { MultipleResourceResult } from '../types/multiple-resource-result';
+import { PaginatedResult } from '../types/paginated-result';
+export type ProductSortType = 'RECENTLY_ADDED' | 'RECENTLY_ADDED_ASCENDING' | 'ALPHABETICAL_A_TO_Z' | 'ALPHABETICAL_Z_TO_A';
+/**
+ * Parameters for using the searchProducts function.
+ */
+export interface ProductSearchParams {
+    /**
+     * The search term to be used to search for POS products.
+     */
+    queryString?: string;
+    /**
+     * Specifies the number of results to be returned in this page of products. The maximum number of products that will be returned is 50.
+     */
+    first?: number;
+    /**
+     * Specifies the page cursor. Products after this cursor will be returned.
+     */
+    afterCursor?: string;
+    /**
+     * Specifies the order in which products should be sorted. When a `queryString` is provided, sortType will not have any effect, as the results will be returned in order by relevance to the `queryString`.
+     */
+    sortType?: ProductSortType;
+}
+export interface ProductSearchApiContent {
+    /** Search for products on the POS device.
+     * @param searchParams The parameters for the product search.
+     */
+    searchProducts(searchParams: ProductSearchParams): Promise<PaginatedResult<Product>>;
+    /** Fetches a single product's details.
+     * @param productId The ID of the product to lookup.
+     */
+    fetchProductWithId(productId: number): Promise<Product | undefined>;
+    /** Fetches multiple products' details.
+     * @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.
+     * @param productVariantId The ID of the product variant to lookup.
+     */
+    fetchProductVariantWithId(productVariantId: number): Promise<ProductVariant | undefined>;
+    /** Fetches multiple product variants' details.
+     * @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.
+     * @param productId The product ID. All variants' details associated with this product ID are returned.
+     */
+    fetchProductVariantsWithProductId(productId: number): Promise<ProductVariant[]>;
+}
+/**
+ * Access Point of Sale's native product search functionality.
+ */
+export interface ProductSearchApi {
+    productSearch: ProductSearchApiContent;
+}
+//# sourceMappingURL=product-search-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"product-search-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/product-search-api/product-search-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAE,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAC,sBAAsB,EAAC,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAC,eAAe,EAAC,MAAM,2BAA2B,CAAC;AAE1D,MAAM,MAAM,eAAe,GACvB,gBAAgB,GAChB,0BAA0B,GAC1B,qBAAqB,GACrB,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;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;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,uBAAuB,CAAC;CACxC"}

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

@@ -0,0 +1,27 @@
+import type { RemoteSubscribable } from '@remote-ui/async-subscription';
+/** The scanner source the POS device supports. */
+export type ScannerSource = 'camera' | 'external' | 'embedded';
+export interface ScannerSubscriptionResult {
+    /** The string data from the last scanner event received. */
+    data?: string;
+    /** The scanning source from which the scan event came. */
+    source?: ScannerSource;
+}
+export interface ScannerApiContent {
+    /** Creates a subscription to scan events
+     * Provides an initial value and a callback to subsribe 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.
+     */
+    scannerDataSubscribable: RemoteSubscribable<ScannerSubscriptionResult>;
+    /** Creates a subscription to the scanning sources available on the POS device.
+     * Provides an initial value and a callback to subsribe 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.
+     */
+    scannerSourcesSubscribable: RemoteSubscribable<ScannerSource[]>;
+}
+export interface ScannerApi {
+    scanner: ScannerApiContent;
+}
+//# sourceMappingURL=scanner-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scanner-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/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"}

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

@@ -0,0 +1,19 @@
+import type { Session } from '../types/session';
+export interface SessionApiContent {
+    /**
+     * Access information on the current POS session.
+     */
+    currentSession: Session;
+    /**
+     * Get a fresh session token for communication with your app's backend service.
+     * Calls to Shopify APIs must be made by your app’s backend service.
+     */
+    getSessionToken: () => Promise<string | undefined>;
+}
+/**
+ * Access information on the current Session, including data on the current shop, user, staff and location.
+ */
+export interface SessionApi {
+    session: SessionApiContent;
+}
+//# sourceMappingURL=session-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"session-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/session-api/session-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,kBAAkB,CAAC;AAE9C,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;;OAGG;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/api/smartgrid-api/smartgrid-api.d.ts

@@ -0,0 +1,12 @@
+export interface SmartGridApiContent {
+    /** Presents the `pos.home.modal.render` extension point on top of the Smart Grid.
+     */
+    presentModal(): void;
+}
+/**
+ * Access the SmartGrid API to present your app in a full screen modal.
+ */
+export interface SmartGridApi {
+    smartGrid: SmartGridApiContent;
+}
+//# sourceMappingURL=smartgrid-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"smartgrid-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/smartgrid-api/smartgrid-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAClC;OACG;IACH,YAAY,IAAI,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,mBAAmB,CAAC;CAChC"}

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

@@ -0,0 +1,13 @@
+import type { CartApi } from '../cart-api/cart-api';
+import type { ConnectivityApi } from '../connectivity-api/connectivity-api';
+import type { DeviceApi } from '../device-api/device-api';
+import type { LocaleApi } from '../locale-api/locale-api';
+import type { SessionApi } from '../session-api/session-api';
+import type { ToastApi } from '../toast-api/toast-api';
+import type { ProductSearchApi } from '../product-search-api/product-search-api';
+export type StandardApi<T> = {
+    [key: string]: any;
+} & {
+    extensionPoint: T;
+} & LocaleApi & CartApi & ToastApi & SessionApi & ProductSearchApi & DeviceApi & ConnectivityApi;
+//# sourceMappingURL=standard-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"standard-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/standard/standard-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,sCAAsC,CAAC;AAC1E,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACxD,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACxD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AAC3D,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,0CAA0C,CAAC;AAE/E,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,GAAG;IAClD,cAAc,EAAE,CAAC,CAAC;CACnB,GAAG,SAAS,GACX,OAAO,GACP,QAAQ,GACR,UAAU,GACV,gBAAgB,GAChB,SAAS,GACT,eAAe,CAAC"}

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

@@ -0,0 +1,15 @@
+export interface ShowToastOptions {
+    duration?: number;
+}
+export interface ToastApiContent {
+    /**
+     * Show a toast.
+     * @param content The text content to display.
+     * @param options An object containing ShowToastOptions.
+     */
+    show: (content: string, options?: ShowToastOptions) => void;
+}
+export interface ToastApi {
+    toast: ToastApiContent;
+}
+//# sourceMappingURL=toast-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"toast-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/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"}

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

@@ -0,0 +1,101 @@
+import { CountryCode } from './country-code';
+export interface Cart {
+    subtotal: string;
+    taxTotal: string;
+    grandTotal: string;
+    note?: string;
+    cartDiscount?: Discount;
+    customer?: Customer;
+    lineItems: LineItem[];
+    properties: Record<string, string>;
+}
+export interface Customer {
+    id: number;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    note?: string;
+}
+export interface LineItem {
+    uuid: string;
+    price?: number;
+    quantity: number;
+    title?: string;
+    variantId?: number;
+    productId?: number;
+    discounts: Discount[];
+    taxable: boolean;
+    sku?: string;
+    vendor?: string;
+    properties: {
+        [key: string]: string;
+    };
+    isGiftCard: boolean;
+}
+export interface Discount {
+    amount: number;
+    discountDescription?: string;
+    type?: string;
+}
+/**
+ * Parameters for adding custom properties to a line item.
+ */
+export interface SetLineItemPropertiesInput {
+    /**
+     * The uuid belonging to the line item which should receive the custom properties.
+     */
+    lineItemUuid: string;
+    /**
+     * The custom properties to apply to the line item.
+     */
+    properties: Record<string, string>;
+}
+/**
+ * Parameters for adding a line item discount.
+ */
+export interface SetLineItemDiscountInput {
+    /**
+     * The uuid belonging to the line item which should receive the discount.
+     */
+    lineItemUuid: string;
+    /**
+     * The discount to be applied to the line item.
+     */
+    lineItemDiscount: LineItemDiscount;
+}
+export interface LineItemDiscount {
+    /**
+     * The title of the line item discount.
+     */
+    title: string;
+    /**
+     * The discount type.
+     */
+    type: 'Percentage' | 'FixedAmount';
+    /**
+     * The percentage or fixed amount for the discount.
+     */
+    amount: string;
+}
+export interface CustomSale {
+    quantity: number;
+    title: string;
+    price: string;
+    taxable: boolean;
+}
+export interface Address {
+    address1?: string;
+    address2?: string;
+    city?: string;
+    company?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    province?: string;
+    country?: string;
+    zip?: string;
+    name?: string;
+    provinceCode?: string;
+    countryCode?: CountryCode;
+}
+//# sourceMappingURL=cart.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cart.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/types/cart.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE3C,MAAM,WAAW,IAAI;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;IACpC,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,YAAY,GAAG,aAAa,CAAC;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B"}