@shopify/ui-extensions 2025.10.0-rc.4 → 2025.10.0-rc.41

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

@@ -0,0 +1,15 @@
+export interface ActionApiContent {
+    /** Presents the `action-overlay.render` extension target on top of present view.
+     *
+     * For example: if we are calling presentModal() from pos.purchase.post.action.menu-item.render,
+     * it should present pos.purchase.post.action.render.
+     */
+    presentModal(): void;
+}
+/**
+ * Access the Action API to present your app in a full screen modal.
+ */
+export interface ActionApi {
+    action: ActionApiContent;
+}
+//# sourceMappingURL=action-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"action-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/action-api/action-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,YAAY,IAAI,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,gBAAgB,CAAC;CAC1B"}

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

@@ -0,0 +1,8 @@
+import { ScannerApi } from '../scanner-api/scanner-api';
+import { StandardApi } from '../standard/standard-api';
+export type ActionTargetApi<T> = {
+    [key: string]: any;
+} & {
+    extensionPoint: T;
+} & StandardApi<T> & ScannerApi;
+//# sourceMappingURL=action-target-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"action-target-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/action-target-api/action-target-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErD,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,GAAG;IACtD,cAAc,EAAE,CAAC,CAAC;CACnB,GAAG,WAAW,CAAC,CAAC,CAAC,GAChB,UAAU,CAAC"}

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

@@ -0,0 +1,182 @@
+import type { ReadonlySignalLike } from '../../../../shared';
+import type { Address, Cart, CartUpdateInput, Customer, CustomSale, SetLineItemDiscountInput, SetLineItemPropertiesInput, SetLineItemSellingPlanInput } from '../../types/cart';
+/**
+ * Access and modify the merchant’s current cart.
+ */
+export interface CartApi {
+    cart: CartApiContent;
+}
+export type CartDiscountType = 'Percentage' | 'FixedAmount' | 'Code';
+export type LineItemDiscountType = 'Percentage' | 'FixedAmount';
+export interface CartApiContent {
+    /**
+     * Provides read-only access to the current cart state and allows subscribing to cart changes.
+     * The `value` property provides the current cart state, and `subscribe` allows listening to changes.
+     */
+    current: ReadonlySignalLike<Cart>;
+    /** Bulk update the cart
+     *
+     * @param cartState the cart state to set
+     * @returns the updated cart
+     */
+    bulkCartUpdate(cartState: CartUpdateInput): Promise<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>;
+    /**
+     * Add a code discount to the cart
+     *
+     * @param code the code for the discount to add to the cart
+     */
+    addCartCodeDiscount(code: string): Promise<void>;
+    /**
+     * Remove the cart discount
+     */
+    removeCartDiscount(): Promise<void>;
+    /**
+     * Remove all cart and line item discounts
+     *
+     * @param disableAutomaticDiscounts Whether or not automatic discounts should be enabled after removing the discounts.
+     */
+    removeAllDiscounts(disableAutomaticDiscounts: boolean): 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
+     * @returns {string} the uuid of the line item added
+     */
+    addCustomSale(customSale: CustomSale): Promise<string>;
+    /**
+     * Add a line item by variant ID to the cart.
+     * Returns the uuid of the line item added, or the empty string if the user dismissed an oversell guard modal without adding anything.
+     * Throws if POS fails to add the line item. Throws if POS fails to add the line item.
+     *
+     * @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
+     * @returns {string} the uuid of the line item added, or the empty string if the user dismissed an oversell guard modal
+     * @throws {Error} if POS fails to add the line item
+     */
+    addLineItem(variantId: number, quantity: number): Promise<string>;
+    /**
+     * 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>;
+    /**
+     * Add a selling plan to a line item in the cart.
+     *
+     * @param uuid the uuid of the line item that should receive the selling plan
+     * @param sellingPlanId the ID of the selling plan to add to the line item
+     */
+    addLineItemSellingPlan(input: SetLineItemSellingPlanInput): Promise<void>;
+    /**
+     * Remove the selling plan from a line item in the cart.
+     *
+     * @param uuid the uuid of the line item whose selling plan should be removed
+     */
+    removeLineItemSellingPlan(uuid: string): 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,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EACV,OAAO,EACP,IAAI,EACJ,eAAe,EACf,QAAQ,EACR,UAAU,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,EAC5B,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG,aAAa,GAAG,MAAM,CAAC;AAErE,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG,aAAa,CAAC;AAEhE,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAElC;;;;OAIG;IACH,cAAc,CAAC,SAAS,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;;;OAKG;IACH,iBAAiB,CACf,IAAI,EAAE,gBAAgB,EACtB,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;OAIG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;OAIG;IACH,kBAAkB,CAAC,yBAAyB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvD;;;;;;;;;OASG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAElE;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;OAIG;IACH,iBAAiB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;;;;OAIG;IACH,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;;OAKG;IACH,qBAAqB,CACnB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACjC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;OAIG;IACH,yBAAyB,CACvB,kBAAkB,EAAE,0BAA0B,EAAE,GAC/C,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;;;;;;OAOG;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;;;;OAIG;IACH,wBAAwB,CACtB,iBAAiB,EAAE,wBAAwB,EAAE,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;OAIG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;;OAKG;IACH,4BAA4B,CAC1B,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;OAIG;IACH,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;OAIG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;OAIG;IACH,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;;;OAKG;IACH,sBAAsB,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1E;;;;OAIG;IACH,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxD"}

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

@@ -0,0 +1,11 @@
+import type { LineItem } from '../../types/cart';
+/**
+ * Access to the selected line item in the merchant’s current cart.
+ */
+export interface CartLineItemApi {
+    /**
+     * The selected line item in the merchant’s current cart.
+     */
+    cartLineItem: LineItem;
+}
+//# sourceMappingURL=cart-line-item-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cart-line-item-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,EAAE,QAAQ,CAAC;CACxB"}

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

@@ -0,0 +1,22 @@
+import type { ReadonlySignalLike } from '../../../../shared';
+export type ConnectivityStateSeverity = 'Connected' | 'Disconnected';
+export interface ConnectivityState {
+    /**
+     * Whether the device is connected to the internet
+     */
+    internetConnected: ConnectivityStateSeverity;
+}
+export interface ConnectivityApiContent {
+    /**
+     * Provides read-only access to the current connectivity state and allows subscribing to connectivity changes.
+     * The `value` property provides the current connectivity state, and `subscribe` allows listening to changes.
+     */
+    current: ReadonlySignalLike<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,oBAAoB,CAAC;AAE3D,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,OAAO,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,sBAAsB,CAAC;CACtC"}

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

@@ -0,0 +1,10 @@
+export interface CustomerApi {
+    customer: CustomerApiContent;
+}
+export interface CustomerApiContent {
+    /**
+     * The unique identifier for the customer
+     */
+    id: number;
+}
+//# sourceMappingURL=customer-api.d.ts.map

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

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

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/draft-order-api/draft-order-api.d.ts

@@ -0,0 +1,18 @@
+export interface DraftOrderApi {
+    draftOrder: DraftOrderApiContent;
+}
+export interface DraftOrderApiContent {
+    /**
+     * The unique identifier for the draft order
+     */
+    id: number;
+    /**
+     * The name of the draft order
+     */
+    name: string;
+    /**
+     * The unique identifier of the customer associated with the draft order
+     */
+    customerId?: number;
+}
+//# sourceMappingURL=draft-order-api.d.ts.map

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

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

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

@@ -0,0 +1,15 @@
+import type { ReadonlySignalLike } from '../../../../shared';
+export interface LocaleApiContent {
+    /**
+     * Provides read-only access to the current IETF-formatted locale and allows subscribing to locale changes.
+     * The `value` property provides the current locale, and `subscribe` allows listening to changes.
+     */
+    current: ReadonlySignalLike<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,oBAAoB,CAAC;AAE3D,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;CACrC;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,54 @@
+export interface NavigationNavigateOptions {
+    /**
+     * Developer-defined information to be stored in the associated NavigationHistoryEntry once the navigation is complete, retrievable via getState().
+     */
+    state?: unknown;
+}
+/**
+ * The NavigationHistoryEntry interface of the Navigation API represents a single navigation history entry.
+ */
+export interface NavigationHistoryEntry {
+    /** Returns the key of the history entry. This is a unique, UA-generated value that represents the history entry's slot in the entries list rather than the entry itself. */
+    key: string;
+    /**
+     * Returns the URL of this history entry.
+     */
+    url: string | null;
+    /**
+     * Returns a clone of the available state associated with this history entry.
+     */
+    getState(): unknown;
+}
+/**
+ * The NavigationCurrentEntryChangeEvent interface of the Navigation API is the event object for the currententrychange event, which fires when the Navigation.currentEntry has changed.
+ */
+export interface NavigationCurrentEntryChangeEvent {
+    /**
+     * Returns the NavigationHistoryEntry that was navigated from.
+     */
+    from: NavigationHistoryEntry;
+}
+export interface Navigation {
+    /**
+     * The navigate() method navigates to a specific URL, updating any provided state in the history entries list.
+     */
+    navigate: NavigateFunction;
+    /**
+     * The currentEntry read-only property of the Navigation interface returns a NavigationHistoryEntry object representing the location the user is currently navigated to right now.
+     */
+    currentEntry: NavigationHistoryEntry;
+    /**
+     * The back() method of the Navigation interface navigates to the previous entry in the history list.
+     */
+    back(): void;
+    addEventListener(type: 'currententrychange', cb: (event: NavigationCurrentEntryChangeEvent) => void): void;
+    removeEventListener(type: 'currententrychange', cb: (event: NavigationCurrentEntryChangeEvent) => void): void;
+}
+export interface NavigateFunction {
+    /**
+     * Navigates to a specific URL, updating any provided state in the history entries list.
+     * @param url The destination URL to navigate to.
+     */
+    (url: string, options?: NavigationNavigateOptions): void;
+}
+//# 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,yBAAyB;IACxC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,4KAA4K;IAC5K,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC;IAC3B;;OAEG;IACH,YAAY,EAAE,sBAAsB,CAAC;IACrC;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IACb,gBAAgB,CACd,IAAI,EAAE,oBAAoB,EAC1B,EAAE,EAAE,CAAC,KAAK,EAAE,iCAAiC,KAAK,IAAI,GACrD,IAAI,CAAC;IACR,mBAAmB,CACjB,IAAI,EAAE,oBAAoB,EAC1B,EAAE,EAAE,CAAC,KAAK,EAAE,iCAAiC,KAAK,IAAI,GACrD,IAAI,CAAC;CACT;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,IAAI,CAAC;CAC1D"}

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

@@ -0,0 +1,24 @@
+/**
+ * Interface to access the order
+ */
+export interface OrderApi {
+    order: OrderApiContent;
+}
+/**
+ * Interface for Order details
+ */
+export interface OrderApiContent {
+    /**
+     * The unique identifier for the order
+     */
+    id: number;
+    /**
+     * The name of the order
+     */
+    name: string;
+    /**
+     * The unique identifier of the customer associated with the order
+     */
+    customerId?: number;
+}
+//# sourceMappingURL=order-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"order-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/order-api/order-api.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,eAAe,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;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/api/pin-pad-api.d.ts

@@ -0,0 +1,17 @@
+import { PinPadOptions, PinValidationResult } from '../types/pin-pad';
+export interface PinPadApiContent {
+    /** Shows a pin pad to the user in a modal dialog.
+     *
+     * @param onSubmit the function to be called when the PIN is submitted.
+     * The callback should be used to validate the PIN and return `accept` or `reject`.
+     * @param options the options for the pin pad
+     */
+    showPinPad(onSubmit: (pin: number[]) => Promise<PinValidationResult> | PinValidationResult, options?: PinPadOptions): void;
+}
+/**
+ * Access the Pin Pad API for pin pad functionality in a modal.
+ */
+export interface PinPadApi {
+    pinPad: PinPadApiContent;
+}
+//# sourceMappingURL=pin-pad-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pin-pad-api.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/api/pin-pad-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,mBAAmB,EAAC,MAAM,kBAAkB,CAAC;AAEpE,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,UAAU,CACR,QAAQ,EAAE,CACR,GAAG,EAAE,MAAM,EAAE,KACV,OAAO,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,EACvD,OAAO,CAAC,EAAE,aAAa,GACtB,IAAI,CAAC;CACT;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,gBAAgB,CAAC;CAC1B"}

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

@@ -0,0 +1,29 @@
+/**
+ * Access the print API for printing functionality
+ */
+export interface PrintApiContent {
+    /**
+     * Trigger a print dialog.
+     *
+     * 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 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.
+     */
+    print(src: string): Promise<void>;
+}
+/**
+ * Interface for printing
+ */
+export interface PrintApi {
+    print: PrintApiContent;
+}
+//# sourceMappingURL=print-api.d.ts.map

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

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

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

@@ -0,0 +1,14 @@
+export interface ProductApi {
+    product: ProductApiContent;
+}
+export interface ProductApiContent {
+    /**
+     * The unique identifier for the product.
+     */
+    id: number;
+    /**
+     * The unique identifier for the product variant.
+     */
+    variantId: number;
+}
+//# sourceMappingURL=product-api.d.ts.map

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

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

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

@@ -0,0 +1,67 @@
+import type { MultipleResourceResult } from '../../types/multiple-resource-result';
+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.
+ */
+export interface PaginationParams {
+    /**
+     * Specifies the number of results to be returned in this page. The maximum number of items that will be returned is 50.
+     */
+    first?: number;
+    /**
+     * Specifies the page cursor. Items after this cursor will be returned.
+     */
+    afterCursor?: string;
+}
+/**
+ * Interface for product search
+ */
+export interface ProductSearchParams extends PaginationParams {
+    /**
+     * The search term to be used to search for POS products.
+     */
+    queryString?: 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[]>;
+    /** Fetches a page of product variants associated with a product.
+     * @param paginationParams The parameters for pagination.
+     */
+    fetchPaginatedProductVariantsWithProductId(productId: number, paginationParams: PaginationParams): Promise<PaginatedResult<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,sBAAsB,EAAC,MAAM,sCAAsC,CAAC;AACjF,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAClE,OAAO,KAAK,EAAC,OAAO,EAAE,cAAc,EAAC,MAAM,qBAAqB,CAAC;AAEjE,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"}

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

@@ -0,0 +1,37 @@
+import type { ReadonlySignalLike } from '../../../../shared';
+/** 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 ScannerSources {
+    /**
+     * The current available scanner sources.
+     * The `value` property provides the current sources, and `subscribe` allows listening to changes.
+     */
+    current: ReadonlySignalLike<ScannerSource[]>;
+}
+export interface ScannerData {
+    /**
+     * The current scan data.
+     * The `value` property provides the current scan result, and `subscribe` allows listening to new scans.
+     */
+    current: ReadonlySignalLike<ScannerSubscriptionResult>;
+}
+export interface ScannerApiContent {
+    /**
+     * Provides read-only access to scanner data and allows subscribing to new scan events.
+     */
+    scannerData: ScannerData;
+    /**
+     * Provides read-only access to the available scanner sources on the POS device.
+     */
+    sources: ScannerSources;
+}
+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,oBAAoB,CAAC;AAE3D,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,cAAc;IAC7B;;;OAGG;IACH,OAAO,EAAE,kBAAkB,CAAC,aAAa,EAAE,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,OAAO,EAAE,kBAAkB,CAAC,yBAAyB,CAAC,CAAC;CACxD;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B"}