@shopify/app-bridge-types 0.0.11 → 0.0.13

package/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.13] - 2023-04-24
+
+- Remove incorrectly added `Symbol()` declaration causing issues with import
+
 ## [0.0.3] - 2023-07-27
 
 ### Changed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/app-bridge-types",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "Companion types library for the Shopify App Bridge script",
   "license": "ISC",
   "main": "./index.js",
@@ -22,6 +22,7 @@
     "index.d.ts",
     "shopify.ts",
     "index.mjs",
-    "index.js"
+    "index.js",
+    "CHANGELOG.md"
   ]
 }

package/shopify.ts

@@ -1,30 +1,110 @@
 interface Address {
+    /**
+     * The customer's primary address.
+     */
     address1?: string;
+    /**
+     * Any extra information associated with the address (Apartment #, Suite #, Unit #, etc.).
+     */
     address2?: string;
+    /**
+     * The name of the customer's city.
+     */
     city?: string;
+    /**
+     * The company name associated with address.
+     */
     company?: string;
+    /**
+     * The first name of the customer.
+     */
     firstName?: string;
+    /**
+     * 	The last name of the customer.
+     */
     lastName?: string;
+    /**
+     * The phone number of the customer.
+     */
     phone?: string;
+    /**
+     * The province or state of the address.
+     */
     province?: string;
+    /**
+     * The country of the address.
+     */
     country?: string;
+    /**
+     * The ZIP or postal code of the address.
+     */
     zip?: string;
+    /**
+     * The name of the address.
+     */
     name?: string;
+    /**
+     * The acronym of the province or state.
+     */
     provinceCode?: string;
+    /**
+     * The Country Code in ISO 3166-1 (alpha-2) format.
+     */
     countryCode?: string;
 }
 
+interface AdminUser {
+    /**
+     * The account access level of the logged-in user
+     */
+    accountAccess?: string;
+}
+
 export interface AppBridgeAttributes {
 }
 
-interface AppBridgeConfig {
-    host?: string;
-    apiKey: string;
-    shop: string;
-    locale: string;
-    disabledFeatures?: string[];
+interface AppBridgeConfig extends Required<Omit<_AppBridgeConfig, 'disabledFeatures' | 'appOrigins'>>, Pick<_AppBridgeConfig, 'disabledFeatures' | 'appOrigins'> {
     experimentalFeatures?: string[];
+}
+
+interface _AppBridgeConfig {
+    /**
+     * The client ID provided for your application in the Partner Dashboard.
+     *
+     * This needs to be provided by the app developer.
+     */
+    apiKey: string;
+    /**
+     * An allowlist of origins that your app can send authenticated fetch requests to.
+     *
+     * This is useful if your app needs to make authenticated requests to a different domain that you control.
+     */
     appOrigins?: string[];
+    /**
+     * The features to disable in your app.
+     *
+     * This allows app developers to opt-out of features such as <code>fetch</code>.
+     */
+    disabledFeatures?: string[];
+    /**
+     * The base64-encoded host of the shop that's embedding your app.
+     *
+     * This does not need to be provided by the app developer.
+     */
+    host?: string;
+    /**
+     * The locale of the shop that's embedding your app.
+     *
+     * This does not need to be provided by the app developer.
+     * @defaultValue 'en-US'
+     */
+    locale?: string;
+    /**
+     * The shop origin of the shop that's embedding your app.
+     *
+     * This does not need to be provided by the app developer.
+     */
+    shop?: string;
 }
 
 export interface AppBridgeElements {
@@ -41,24 +121,59 @@ export interface AugmentedElements {
     a: MenuItemProperties;
 }
 
+interface BaseElementAttributes {
+    id?: string;
+    name?: string;
+    class?: string;
+    href?: string;
+    rel?: string;
+    target?: string;
+    onclick?: string;
+    children?: string;
+}
+
 interface BaseResource extends Resource {
     variants?: Resource[];
 }
 
 interface Cart {
+    /**
+     * 	The total cost of the current cart including discounts, but before taxes and shipping. Value is based on the shop's existing currency settings.
+     */
     subtotal: string;
+    /**
+     * The sum of taxes for the current cart. Value is based on the shop's existing currency settings.
+     */
     taxTotal: string;
+    /**
+     * The total cost of the current cart, after taxes and discounts have been applied. Value is based on the shop's existing currency settings.
+     */
     grandTotal: string;
-    note?: string;
+    /**
+     * The current discount applied to the entire cart.
+     */
     cartDiscount?: Discount;
-    cartDiscounts: Discount[];
+    /**
+     * All current discounts applied to the entire cart and line items.
+     */
+    cartDiscounts?: Discount[];
+    /**
+     * The customer associated to the current cart.
+     */
     customer?: Customer;
+    /**
+     * A list of lineItem objects.
+     */
     lineItems: LineItem[];
+    /**
+     * A list of objects containing cart properties.
+     */
     properties: Record<string, string>;
 }
 
-type CartDiscountType = 'Percentage' | 'FixedAmount';
-
+/**
+ * Callback to execute when cart updates.
+ */
 type CartSubscriber = (cart: Cart) => void;
 
 interface Collection extends Resource {
@@ -103,77 +218,266 @@ enum CollectionSortOrder {
 }
 
 interface Customer {
-    id?: number;
+    /**
+     * The ID of existing customer.
+     */
+    id: number;
+    /**
+     * The email for a new customer.
+     */
     email?: string;
+    /**
+     * The first name for new customer.
+     */
     firstName?: string;
+    /**
+     * The last name for new customer.
+     */
     lastName?: string;
+    /**
+     * The note for new customer.
+     */
     note?: string;
 }
 
+interface CustomSale {
+    /**
+     * Price of line item
+     */
+    price: number;
+    /**
+     * Quantity of line item.
+     */
+    quantity: number;
+    /**
+     * Title of line item.
+     */
+    title: string;
+    /**
+     * If line item charges tax.
+     */
+    taxable: boolean;
+}
+
 interface Device {
+    /**
+     * The name of the device.
+     */
     name: string;
+    /**
+     * The unique ID associated device ID and app ID..
+     */
     serialNumber: string;
 }
 
 interface Discount {
+    /**
+     * Amount of discount. Only for fixed or percentage discounts.
+     */
     amount: number;
-    title?: string;
-    type?: CartDiscountType;
+    /**
+     * Description of discount.
+     */
+    discountDescription?: string;
+    /**
+     * Type of discount.
+     */
+    type: DiscountType;
+}
+
+type DiscountType = 'Percentage' | 'FixedAmount';
+
+interface EnvironmentApi extends Required<_EnvironmentApi> {
+}
+
+interface _EnvironmentApi {
+    /**
+     * Whether the app is running on Shopify Mobile.
+     */
+    mobile?: boolean;
+    /**
+     * Whether the app is embedded in the Shopify admin.
+     */
+    embedded?: boolean;
+    /**
+     * Whether the app is running on Shopify POS.
+     */
+    pos?: boolean;
 }
 
-interface Environment {
-    mobile: boolean;
-    embedded: boolean;
-    pos: boolean;
+interface Filters {
+    /**
+     * Whether to show hidden resources, referring to products that are not published on any sales channels.
+     * @defaultValue true
+     */
+    hidden?: boolean;
+    /**
+     * Whether to show product variants. Only applies to the Product resource type picker.
+     * @defaultValue true
+     */
+    variants?: boolean;
+    /**
+     * Whether to show [draft products](https://help.shopify.com/en/manual/products/details?shpxid=70af7d87-E0F2-4973-8B09-B972AAF0ADFD#product-availability).
+     * Only applies to the Product resource type picker.
+     * Setting this to undefined will show a badge on draft products.
+     * @defaultValue true
+     */
+    draft?: boolean | undefined;
+    /**
+     * Whether to show [archived products](https://help.shopify.com/en/manual/products/details?shpxid=70af7d87-E0F2-4973-8B09-B972AAF0ADFD#product-availability).
+     * Only applies to the Product resource type picker.
+     * Setting this to undefined will show a badge on draft products.
+     * @defaultValue true
+     */
+    archived?: boolean | undefined;
+    /**
+     * GraphQL initial search query for filtering resources available in the picker.
+     * See [search syntax](https://shopify.dev/docs/api/usage/search-syntax) for more information.
+     * This is not displayed in the search bar when the picker is opened.
+     */
+    query?: string;
 }
 
+type Finish = (data?: any) => void;
+
 enum FulfillmentServiceType {
     GiftCard = "GIFT_CARD",
     Manual = "MANUAL",
     ThirdParty = "THIRD_PARTY"
 }
 
+/**
+ * Asynchronously returns an ID token.
+ * @returns A Promise that resolves to an ID token.
+ */
+type IdTokenApi = () => Promise<string>;
+
 interface Image_2 {
     id: string;
     altText?: string;
     originalSrc: string;
 }
 
+interface Intent {
+    readonly action: string;
+    readonly type: string;
+    readonly data: {
+        [key: string]: any;
+    };
+    finish: Finish;
+}
+
+interface IntentsApi {
+    register(callback: (intent: Intent) => void): () => void;
+}
+
 interface LineItem {
+    /**
+     * Unique id of line item
+     */
     uuid: string;
+    /**
+     * Price of line item
+     */
     price?: number;
+    /**
+     * Quantity of line item.
+     */
     quantity: number;
+    /**
+     * Title of line item.
+     */
     title?: string;
+    /**
+     * Variant identifier for line item.
+     */
     variantId?: number;
+    /**
+     * Product identifier for line item.
+     */
     productId?: number;
+    /**
+     * Discount applied to line item.
+     */
     discounts: Discount[];
+    /**
+     * If line item charges tax.
+     */
     taxable: boolean;
+    /**
+     * Stock keeping unit of the line item.
+     */
     sku?: string;
+    /**
+     * Vendor of line item.
+     */
     vendor?: string;
+    /**
+     * Properties of the line item.
+     */
     properties: {
         [key: string]: string;
     };
+    /**
+     * If the line item is a gift card.
+     */
     isGiftCard: boolean;
 }
 
-interface LineItemDiscount {
-    title: string;
-    type: CartDiscountType;
-    amount: string;
-}
+/**
+ * The `Loading` API provides a method to toggle the loading indicator in the Shopify admin.
+ * @param isLoading - An optional boolean parameter. If `true`, the loading indicator is shown. If `false` or omitted, the loading indicator is hidden.
+ */
+type LoadingApi = (isLoading?: boolean) => void;
 
 interface Location_2 {
+    /**
+     * The ID of current location.
+     */
     id: number;
+    /**
+     * The status of current location.
+     */
     active: boolean;
+    /**
+     * The name of current location.
+     */
     name: string;
+    /**
+     * The type of current location.
+     */
     locationType?: string;
+    /**
+     * The primary address of current location.
+     */
     address1?: string;
+    /**
+     * Any extra information associated with the address (Apartment #, Suite #, Unit #, etc.).
+     */
     address2?: string;
+    /**
+     * The ZIP or postal code of the address.
+     */
     zip?: string;
+    /**
+     * The name of the city.
+     */
     city?: string;
+    /**
+     * TThe province or state of the address.
+     */
     province?: string;
+    /**
+     * The Country Code in ISO 3166-1 (alpha-2) format.
+     */
     countryCode?: string;
+    /**
+     * The country of the address.
+     */
     countryName?: string;
+    /**
+     * 	The phone number of the location.
+     */
     phone?: string;
 }
 
@@ -184,34 +488,162 @@ export interface MenuItemProperties {
     loading?: boolean | string;
 }
 
+interface ModalApi extends Required<_ModalApi> {
+}
+
+interface _ModalApi {
+    /**
+     * Shows the modal element. An alternative to the `show` instance method on the `ui-modal` element.
+     * @param id A unique identifier for the Modal
+     */
+    show?(id: string): Promise<void>;
+    /**
+     * Hides the modal element. An alternative to the `hide` instance method on the `ui-modal` element.
+     * @param id A unique identifier for the Modal
+     */
+    hide?(id: string): Promise<void>;
+    /**
+     * Toggles the modal element visibility. An alternative to the `toggle` instance method on the `ui-modal` element.
+     * @param id A unique identifier for the Modal
+     */
+    toggle?(id: string): Promise<void>;
+}
+
 type Money = string;
 
-interface Pos {
-    cart: {
-        fetch(): Promise<Cart>;
-        subscribe(onSubscribe: CartSubscriber): Unsubscribe;
-        setCustomer(customer: Customer): Promise<void>;
-        removeCustomer(): Promise<void>;
-        addAddress(address: Address): Promise<void>;
-        updateAddress(index: number, address: Address): Promise<void>;
-        applyCartDiscount(discount: Discount): Promise<void>;
-        applyCartCodeDiscount(code: string): Promise<void>;
-        removeCartDiscount(): Promise<void>;
-        removeAllDiscounts(disableAutomaticDiscounts: boolean): Promise<void>;
-        addCartProperties(properties: Record<string, string>): Promise<void>;
-        removeCartProperties(properties: string[]): Promise<void>;
-        clear(): Promise<void>;
-        addLineItem(variantId: number, quantity: number): Promise<void>;
-        updateLineItem(index: string, quantity: number): Promise<void>;
-        removeLineItem(index: string): Promise<void>;
-        setLineItemDiscount(index: number, discount: LineItemDiscount): Promise<void>;
-        removeLineItemDiscount(index: number): Promise<void>;
-        addLineItemProperties(index: number, properties: Record<string, string>): Promise<void>;
-        removeLineItemProperties(index: number, properties: string[]): Promise<void>;
-    };
-    close(): Promise<void>;
-    device(): Promise<Device>;
-    location(): Promise<Location_2>;
+interface PosApi {
+    cart: PosCart;
+    close: PosClose;
+    device: PosDevice;
+    location: PosLocation;
+}
+
+type PosCart = Required<_PosCart>;
+
+interface _PosCart {
+    /**
+     * Fetch the current cart.
+     */
+    fetch?(): Promise<Cart>;
+    /**
+     * Subscribe the cart changes.
+     */
+    subscribe?(onSubscribe: CartSubscriber): Unsubscribe;
+    /**
+     * Add a new or existing customer to the cart.
+     */
+    setCustomer?(customer: Customer): Promise<void>;
+    /**
+     * Remove the current customer from the cart.
+     */
+    removeCustomer?(): Promise<void>;
+    /**
+     * Add a new address to a customer.
+     */
+    addAddress?(address: Address): Promise<void>;
+    /**
+     * Update an address for a customer.
+     */
+    updateAddress?(index: number, address: Address): Promise<void>;
+    /**
+     * Apply a percentage or fixed amount discount to the whole cart.
+     */
+    applyCartDiscount?(type: DiscountType, discountDescription: string, amount: string): Promise<void>;
+    /**
+     * Apply a code discount to the whole cart.
+     */
+    applyCartCodeDiscount?(code: string): Promise<void>;
+    /**
+     * Remove the discount applied to the whole cart.
+     */
+    removeCartDiscount?(): Promise<void>;
+    /**
+     * Clears all applied discounts from the cart and optionally disables automatic discounts.
+     */
+    removeAllDiscounts?(disableAutomaticDiscounts: boolean): Promise<void>;
+    /**
+     * Add properties for the cart.
+     */
+    addCartProperties?(properties: Record<string, string>): Promise<void>;
+    /**
+     * Remove properties from the cart.
+     */
+    removeCartProperties?(keys: string[]): Promise<void>;
+    /**
+     * Add custom sale for the cart.
+     */
+    addCustomSale?(customSale: CustomSale): Promise<void>;
+    /**
+     * Clear all contents from the cart.
+     */
+    clear?(): Promise<void>;
+    /**
+     * Add a product to the cart.
+     */
+    addLineItem?(variantId: number, quantity: number): Promise<void>;
+    /**
+     * Make changes to a line item in the cart.
+     */
+    updateLineItem?(uuid: string, quantity: number): Promise<void>;
+    /**
+     * Remove a line item in the cart.
+     */
+    removeLineItem?(uuid: string): Promise<void>;
+    /**
+     * Apply a discount to a line item.
+     */
+    setLineItemDiscount?(uuid: string, type: DiscountType, discountDescription: string, amount: string): Promise<void>;
+    /**
+     * Remove a discount from a line item.
+     */
+    removeLineItemDiscount?(uuid: string): Promise<void>;
+    /**
+     * Add properties to a line item.
+     */
+    addLineItemProperties?(uuid: string, properties: Record<string, string>): Promise<void>;
+    /**
+     * Remove properties from a line item.
+     */
+    removeLineItemProperties?(uuid: string, properties: string[]): Promise<void>;
+}
+
+type PosClose = () => Promise<void>;
+
+type PosDevice = () => Promise<Device>;
+
+type PosLocation = () => Promise<Location_2>;
+
+interface POSUser {
+    /**
+     * The ID of the user's staff.
+     */
+    id?: number;
+    /**
+     * The user's first name.
+     */
+    firstName?: string;
+    /**
+     * The user's last name.
+     */
+    lastName?: string;
+    /**
+     * The user's email address.
+     */
+    email?: string;
+    /**
+     *   The account access level of the logged-in user
+     */
+    accountAccess?: string;
+    /**
+     * The user's account type.
+     */
+    accountType?: string;
+}
+
+interface PrivilegedAdminUser extends AdminUser {
+    id?: number;
+    name?: string;
+    email?: string;
 }
 
 interface Product extends Resource {
@@ -298,19 +730,39 @@ interface Resource {
     id: string;
 }
 
+type ResourcePickerApi = (options: ResourcePickerOptions) => Promise<SelectPayload<ResourcePickerOptions['type']> | undefined>;
+
 interface ResourcePickerOptions {
+    /**
+     * The type of resource you want to pick.
+     */
     type: 'product' | 'variant' | 'collection';
-    query?: string;
-    selectionIds?: BaseResource[];
+    /**
+     *  The action verb appears in the title and as the primary action of the Resource Picker.
+     * @defaultValue 'add'
+     */
     action?: 'add' | 'select';
+    /**
+     * Filters for what resource to show.
+     */
+    filter?: Filters;
+    /**
+     * Whether to allow selecting multiple items of a specific type or not. If a number is provided, then limit the selections to a maximum of that number of items. When type is Product, the user may still select multiple variants of a single product, even if multiple is false.
+     * @defaultValue false
+     */
     multiple?: boolean | number;
-    filter?: {
-        hidden?: boolean;
-        variants?: boolean;
-        draft?: boolean | undefined;
-        archived?: boolean | undefined;
-        query?: string;
-    };
+    /**
+     * GraphQL initial search query for filtering resources available in the picker. See [search syntax](https://shopify.dev/docs/api/usage/search-syntax) for more information.
+     * This is displayed in the search bar when the picker is opened and can be edited by users.
+     * For most use cases, you should use the `filter.query` option instead which doesn't show the query in the UI.
+     * @defaultValue ''
+     */
+    query?: string;
+    /**
+     * Resources that should be preselected when the picker is opened.
+     * @defaultValue []
+     */
+    selectionIds?: BaseResource[];
 }
 
 type ResourceSelection<Type extends keyof ResourceTypes> = ResourceTypes[Type];
@@ -326,6 +778,35 @@ interface RuleSet {
     rules: CollectionRule[];
 }
 
+interface SaveBarApi extends Required<_SaveBarApi> {
+}
+
+interface _SaveBarApi {
+    /**
+     * Shows the save bar element. An alternative to the `show` instance method on the `ui-save-bar` element.
+     * @param id A unique identifier for the save bar
+     */
+    show?(id: string): Promise<void>;
+    /**
+     * Hides the save bar element. An alternative to the `hide` instance method on the `ui-save-bar` element.
+     * @param id A unique identifier for the save bar
+     */
+    hide?(id: string): Promise<void>;
+    /**
+     * Toggles the save bar element visibility. An alternative to the `toggle` instance method on the `ui-save-bar` element.
+     * @param id A unique identifier for the save bar
+     */
+    toggle?(id: string): Promise<void>;
+    /**
+     * Show leave confirmation dialog if necessary. This promise is resolved when there is no visible save bar or user confirms to leave.
+     */
+    leaveConfirmation?(): Promise<void>;
+}
+
+interface ScannerApi {
+    capture(): Promise<ScannerPayload>;
+}
+
 interface ScannerPayload {
     data: string;
 }
@@ -336,106 +817,305 @@ export interface ShopifyGlobal {
     config: AppBridgeConfig;
     origin: string;
     ready: Promise<void>;
-    environment: Environment;
-    loading(isLoading?: boolean): void;
-    idToken(): Promise<string>;
-    user(): Promise<User>;
-    toast: {
-        show(message: string, opts?: Partial<ToastOptions>): string;
-        hide(id: string): void;
-    };
-    resourcePicker<Options extends ResourcePickerOptions>(options: Options): Promise<SelectPayload<Options['type']> | undefined>;
-    scanner: {
-        capture(): Promise<ScannerPayload>;
-    };
-    modal: {
-        show(id: string): Promise<void>;
-        hide(id: string): Promise<void>;
-        toggle(id: string): Promise<void>;
-    };
-    saveBar: {
-        show(id: string): Promise<void>;
-        hide(id: string): Promise<void>;
-        toggle(id: string): Promise<void>;
-        leaveConfirmation(): Promise<void>;
-    };
-    pos: Pos;
+    environment: EnvironmentApi;
+    loading: LoadingApi;
+    idToken: IdTokenApi;
+    user: UserApi;
+    toast: ToastApi;
+    resourcePicker: ResourcePickerApi;
+    scanner: ScannerApi;
+    modal: ModalApi;
+    saveBar: SaveBarApi;
+    pos: PosApi;
+    intents: IntentsApi;
 }
 
+/**
+ * The Toast API provides methods to display Toast notifications in the Shopify admin.
+ */
+interface ToastApi {
+    /**
+     * Displays a Toast notification in the Shopify admin.
+     *
+     * @param message - The message to be displayed in the Toast notification.
+     * @param opts - Options for the Toast notification.
+     *
+     * @returns The ID of the Toast notification.
+     */
+    show: ToastShow;
+    /**
+     * Hides a Toast notification in the Shopify admin.
+     *
+     * @param id - The ID of the Toast notification to be hidden.
+     */
+    hide: ToastHide;
+}
+
+type ToastHide = (id: string) => void;
+
 interface ToastOptions {
-    duration: number;
-    isError: boolean;
-    action: string;
-    onAction: () => void;
-    onDismiss: () => void;
+    /**
+     * The length of time in milliseconds the toast message should persist.
+     * @defaultValue 5000
+     */
+    duration?: number;
+    /**
+     * Display an error-styled toast.
+     * @defaultValue false
+     */
+    isError?: boolean;
+    /**
+     * Content of an action button.
+     */
+    action?: string;
+    /**
+     * Callback fired when the action button is clicked.
+     */
+    onAction?: () => void;
+    /**
+     * Callback fired when the dismiss icon is clicked
+     */
+    onDismiss?: () => void;
+}
+
+type ToastShow = (message: string, opts?: ToastOptions) => string;
+
+export interface UIModalAttributes extends _UIModalAttributes {
+    children?: any;
 }
 
-export interface UIModalAttributes {
+interface _UIModalAttributes {
+    /**
+     * A unique identifier for the Modal
+     */
     id?: string;
-    variant?: Variant;
+    /**
+     * The size of the modal.
+     *
+     * Before the Modal is shown, this can be changed to any of the provided values.
+     * After the Modal is shown, this can can only be changed between `small`, `base`, and `large`.
+     *
+     * @defaultValue "base"
+     */
+    variant?: 'small' | 'base' | 'large' | 'max';
+    /**
+     * The URL of the content to display within a Modal.
+     * If provided, the Modal will display the content from the provided URL
+     * and any children other than the [ui-title-bar](/docs/api/app-bridge-library/web-components/ui-title-bar)
+     * and [ui-save-bar](/docs/api/app-bridge-library/web-components/ui-save-bar) elements will be ignored.
+     */
     src?: string;
-    children?: any;
+    /**
+     * The content to display within a Modal.
+     * You can provide a single HTML element with children
+     * and the [ui-title-bar](/docs/api/app-bridge-library/web-components/ui-title-bar)
+     * element to configure the Modal title bar.
+     */
+    children?: HTMLCollection & UITitleBarAttributes;
 }
 
-interface UIModalElement_2 extends Omit<HTMLElement, 'addEventListener' | 'removeEventListener'> {
-    variant: Variant;
+interface _UIModalElement {
+    /**
+     * A getter/setter that is used to set modal variant.
+     */
+    variant?: Variant;
+    /**
+     * A getter/setter that is used to get the DOM content of the modal
+     * element and update the content after the modal has been opened.
+     */
     content?: HTMLElement;
+    /**
+     * A getter/setter that is used to set modal src.
+     */
     src?: string;
+    /**
+     * A getter that is used to get the Window object of the modal iframe
+     * when the modal is used with a `src` attribute. This can only be
+     * accessed when the modal is open, so it is recommended to use `await modal.show()`
+     * before accessing this property.
+     */
     readonly contentWindow?: Window | null;
-    show(): Promise<void>;
-    hide(): Promise<void>;
-    toggle(): Promise<void>;
-    addEventListener(type: 'show' | 'hide', listener: EventListenerOrEventListenerObject): void;
-    removeEventListener(type: 'show' | 'hide', listener: EventListenerOrEventListenerObject): void;
+    /**
+     * Shows the save bar element
+     */
+    show?(): Promise<void>;
+    /**
+     * Hides the save bar element
+     */
+    hide?(): Promise<void>;
+    /**
+     * Toggles the save bar element between the showing and hidden states
+     */
+    toggle?(): Promise<void>;
+    /**
+     * Add 'show' | 'hide' event listeners.
+     * @param type An event name
+     * @param listener A callback triggered when the event name happens
+     */
+    addEventListener?(type: 'show' | 'hide', listener: EventListenerOrEventListenerObject): void;
+    /**
+     * Remove 'show' | 'hide' event listeners.
+     * @param type An event name
+     * @param listener A callback to be removed
+     */
+    removeEventListener?(type: 'show' | 'hide', listener: EventListenerOrEventListenerObject): void;
+}
+
+interface UIModalElement_2 extends Omit<HTMLElement, 'addEventListener' | 'removeEventListener'>, Required<Omit<_UIModalElement, 'content' | 'src' | 'contentWindow'>>, Pick<_UIModalElement, 'content' | 'src' | 'contentWindow'> {
 }
 export type { UIModalElement_2 as UIModalElement }
 
-export interface UINavMenuAttributes {
+export interface UINavMenuAttributes extends _UINavMenuAttributes {
     children?: any;
 }
 
+interface _UINavMenuAttributes {
+    children?: [UINavMenuFirstChild, ...UINavMenuChildren[]];
+}
+
+interface UINavMenuChildren {
+    a?: {
+        href: string;
+        children: string;
+    };
+}
+
 interface UINavMenuElement_2 extends HTMLElement {
 }
 export type { UINavMenuElement_2 as UINavMenuElement }
 
-export interface UISaveBarAttributes {
+interface UINavMenuFirstChild {
+    a: {
+        rel: 'home';
+        href: string;
+        children?: string;
+    };
+}
+
+export interface UISaveBarAttributes extends _UISaveBarAttributes {
+    children?: any;
+}
+
+interface _UISaveBarAttributes {
+    /**
+     * A unique identifier for the save bar
+     */
     id?: string;
+    /**
+     * Whether to show a confirmation dialog when the discard button is clicked
+     */
     discardConfirmation?: boolean;
-    children?: any;
+    /**
+     * HTML `<button>` elements to hook into the Save
+     * and Discard buttons of the contextual save bar.
+     *
+     * The button with variant `primary` is the Save button
+     * and the button without a variant is the Discard button.
+     */
+    children?: UISaveBarChildren;
+}
+
+interface UISaveBarChildren {
+    button?: {
+        id?: string;
+        class?: string;
+        children?: string;
+        disabled?: boolean;
+        loading?: boolean;
+        name?: string;
+        onclick?: string;
+        variant?: 'primary';
+    };
 }
 
-interface UISaveBarElement_2 extends Omit<HTMLElement, 'addEventListener' | 'removeEventListener'> {
+interface _UISaveBarElement {
+    /**
+     * A getter/setter that is used to set discard confirmation.
+     */
     discardConfirmation?: boolean;
-    show(): Promise<void>;
-    hide(): Promise<void>;
-    toggle(): Promise<void>;
-    addEventListener(type: 'show' | 'hide', listener: EventListenerOrEventListenerObject): void;
-    removeEventListener(type: 'show' | 'hide', listener: EventListenerOrEventListenerObject): void;
+    /**
+     * A getter that is used to check if save bar is showing.
+     */
+    readonly showing?: boolean;
+    /**
+     * Shows the save bar element.
+     */
+    show?(): Promise<void>;
+    /**
+     * Hides the save bar element.
+     */
+    hide?(): Promise<void>;
+    /**
+     * Toggles the save bar element between the showing and hidden states.
+     */
+    toggle?(): Promise<void>;
+    /**
+     * Add 'show' | 'hide' event listeners.
+     * @param type An event name
+     * @param listener A callback triggered when the event name happens
+     */
+    addEventListener?(type: 'show' | 'hide', listener: EventListenerOrEventListenerObject): void;
+    /**
+     * Remove 'show' | 'hide' event listeners.
+     * @param type An event name
+     * @param listener A callback to be removed
+     */
+    removeEventListener?(type: 'show' | 'hide', listener: EventListenerOrEventListenerObject): void;
+}
+
+interface UISaveBarElement_2 extends Omit<HTMLElement, 'addEventListener' | 'removeEventListener'>, Required<_UISaveBarElement> {
 }
 export type { UISaveBarElement_2 as UISaveBarElement }
 
-export interface UITitleBarAttributes {
-    title?: string;
+export interface UITitleBarAttributes extends _UITitleBarAttributes {
     children?: any;
 }
 
-interface UITitleBarElement_2 extends HTMLElement {
-    title: string;
+interface _UITitleBarAttributes {
+    /**
+     * The title of the title bar. Can also be set via <code>document.title</code>.
+     */
+    title?: string;
+    /**
+     * The children of the title bar.
+     */
+    children?: UITitleBarChildren;
+}
+
+interface UITitleBarChildren {
+    a?: BaseElementAttributes & {
+        variant?: 'breadcrumb' | 'primary';
+    };
+    button?: BaseElementAttributes & {
+        variant?: 'breadcrumb' | 'primary';
+        tone?: 'critical' | 'default';
+    };
+    section?: {
+        label?: string;
+        children?: {
+            a?: BaseElementAttributes;
+            button?: BaseElementAttributes;
+        };
+    };
+}
+
+interface UITitleBarElement_2 extends Omit<HTMLElement, 'title'> {
 }
 export type { UITitleBarElement_2 as UITitleBarElement }
 
+/**
+ * Callback to unsubscribe
+ */
 type Unsubscribe = () => void;
 
-interface User {
-    id: string;
-    name: string;
-    firstName?: string;
-    lastName?: string;
-    email: string;
-    accountAccess: string;
-    accountType: string;
+export interface UseAppBridge {
 }
 
+interface User extends PrivilegedAdminUser, AdminUser, POSUser {
+}
+
+type UserApi = () => Promise<User>;
+
 type Variant = 'small' | 'base' | 'large' | 'max';
 
 enum WeightUnit {