@shopify/app-bridge-types 0.0.3 → 0.0.5

package/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.3] - 2023-07-27
+
+### Changed
+
+- Correct `resourcePicker()` return value and TS types to return the Array of selected entities directly. For the time being, the Array has a `.selection` property for backwards compatibility with the interface we launched with. ([#131](https://github.com/Shopify/app-bridge-next/pull/131))
+
 ## [0.0.2] - 2023-07-19
 
 ### Added

package/index.d.ts

@@ -3,6 +3,9 @@ import type {
   AugmentedElement,
   AppBridgeElements,
   AppBridgeAttributes,
+  UIModalElement as BaseUIModalElement,
+  UINavMenuElement as BaseUINavMenuElement,
+  UITitleBarElement as BaseUITitleBarElement,
 } from './shopify';
 
 export {ShopifyGlobal};
@@ -14,6 +17,10 @@ declare global {
   interface HTMLButtonElement extends AugmentedElement<'button'> {}
   interface HTMLAnchorElement extends AugmentedElement<'a'> {}
 
+  interface UIModalElement extends BaseUIModalElement {}
+  interface UINavMenuElement extends BaseUINavMenuElement {}
+  interface UITitleBarElement extends BaseUITitleBarElement {}
+
   // Install property augmentations onto ReactElement prop definitions
   namespace React {
     interface ButtonHTMLAttributes<T> extends AugmentedElement<'button'> {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/app-bridge-types",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Companion types library for the Shopify App Bridge script",
   "license": "ISC",
   "main": "./index.js",

package/shopify.ts

@@ -1,22 +1,35 @@
+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?: string;
+}
+
 export interface AppBridgeAttributes {
 }
 
 interface AppBridgeConfig {
-    host: string;
+    host?: string;
     apiKey: string;
     shop: string;
     locale: string;
-    disabledFeatures?: [string];
+    disabledFeatures?: string[];
+    experimentalFeatures?: string[];
 }
 
 export interface AppBridgeElements {
-    'ui-nav-menu': {
-        children?: any;
-    };
-    'ui-title-bar': {
-        title?: string;
-        children?: any;
-    };
+    'ui-modal': UIModalAttributes;
+    'ui-nav-menu': UINavMenuAttributes;
+    'ui-title-bar': UITitleBarAttributes;
 }
 
 export type AugmentedElement<T extends keyof AugmentedElements> = AugmentedElements[T];
@@ -30,6 +43,19 @@ interface BaseResource extends Resource {
     variants?: Resource[];
 }
 
+interface Cart {
+    subtotal: string;
+    taxTotal: string;
+    grandTotal: string;
+    note?: string;
+    cartDiscount?: Discount;
+    customer?: Customer;
+    lineItems: LineItem[];
+    properties: Record<string, string>;
+}
+
+type CartSubscriber = (cart: Cart) => void;
+
 interface Collection extends Resource {
     availablePublicationCount: number;
     description: string;
@@ -71,6 +97,25 @@ enum CollectionSortOrder {
     MostRelevant = "MOST_RELEVANT"
 }
 
+interface Customer {
+    id?: number;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    note?: string;
+}
+
+interface Device {
+    name: string;
+    serialNumber: string;
+}
+
+interface Discount {
+    amount: number;
+    title?: string;
+    type?: string;
+}
+
 interface Environment {
     mobile: boolean;
     embedded: boolean;
@@ -89,12 +134,76 @@ interface Image_2 {
     originalSrc: string;
 }
 
+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;
+}
+
+interface LineItemDiscount {
+    title: string;
+    type: 'Percentage' | 'FixedAmount';
+    amount: string;
+}
+
+interface Location_2 {
+    id: number;
+    active: boolean;
+    name: string;
+    locationType?: string;
+    address1?: string;
+    address2?: string;
+    zip?: string;
+    city?: string;
+    province?: string;
+    countryCode?: string;
+    countryName?: string;
+    phone?: string;
+}
+
 export interface MenuItemProperties {
     variant?: 'primary' | 'breadcrumb' | null | undefined;
 }
 
 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>;
+        removeCartDiscount(): 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 Product extends Resource {
     availablePublicationCount: number;
     createdAt: string;
@@ -189,6 +298,7 @@ interface ResourcePickerOptions {
         variants?: boolean;
         draft?: boolean | undefined;
         archived?: boolean | undefined;
+        query?: string;
     };
 }
 
@@ -205,6 +315,10 @@ interface RuleSet {
     rules: CollectionRule[];
 }
 
+interface ScannerPayload {
+    data: string;
+}
+
 type SelectPayload<Type extends keyof ResourceTypes> = WithSelection<ResourceSelection<Type>[]>;
 
 export interface ShopifyGlobal {
@@ -220,6 +334,15 @@ export interface ShopifyGlobal {
         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>;
+    };
+    pos: Pos;
 }
 
 interface ToastOptions {
@@ -230,6 +353,43 @@ interface ToastOptions {
     onDismiss: () => void;
 }
 
+interface UIModalAttributes {
+    id?: string;
+    variant?: Variant;
+    children?: any;
+}
+
+interface UIModalElement_2 extends Omit<HTMLElement, 'addEventListener' | 'removeEventListener'> {
+    variant: Variant;
+    content: HTMLElement;
+    show(): Promise<void>;
+    hide(): Promise<void>;
+    toggle(): Promise<void>;
+    addEventListener(type: 'show' | 'hide', listener: EventListenerOrEventListenerObject): void;
+    removeEventListener(type: 'show' | 'hide', listener: EventListenerOrEventListenerObject): void;
+}
+export type { UIModalElement_2 as UIModalElement }
+
+interface UINavMenuAttributes {
+    children?: any;
+}
+
+interface UINavMenuElement_2 extends HTMLElement {
+}
+export type { UINavMenuElement_2 as UINavMenuElement }
+
+interface UITitleBarAttributes {
+    title?: string;
+    children?: any;
+}
+
+interface UITitleBarElement_2 extends HTMLElement {
+    title: string;
+}
+export type { UITitleBarElement_2 as UITitleBarElement }
+
+type Unsubscribe = () => void;
+
 interface User {
     id: string;
     name: string;
@@ -240,6 +400,8 @@ interface User {
     accountType: string;
 }
 
+type Variant = 'small' | 'base' | 'large' | 'max';
+
 enum WeightUnit {
     Kilograms = "KILOGRAMS",
     Grams = "GRAMS",