@shopify/app-bridge-types 0.0.2 → 0.0.4

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/package.json

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

package/shopify.ts

@@ -2,11 +2,11 @@ export interface AppBridgeAttributes {
 }
 
 interface AppBridgeConfig {
-    host: string;
+    host?: string;
     apiKey: string;
     shop: string;
     locale: string;
-    disabledFeatures?: [string];
+    disabledFeatures?: string[];
 }
 
 export interface AppBridgeElements {
@@ -17,6 +17,7 @@ export interface AppBridgeElements {
         title?: string;
         children?: any;
     };
+    'ui-modal': UIModalAttributes;
 }
 
 export type AugmentedElement<T extends keyof AugmentedElements> = AugmentedElements[T];
@@ -90,7 +91,7 @@ interface Image_2 {
 }
 
 export interface MenuItemProperties {
-    variant?: 'primary' | undefined;
+    variant?: 'primary' | 'breadcrumb' | null | undefined;
 }
 
 type Money = string;
@@ -192,18 +193,25 @@ interface ResourcePickerOptions {
     };
 }
 
-type ResourceSelection = Product | ProductVariant | Collection;
+type ResourceSelection<Type extends keyof ResourceTypes> = ResourceTypes[Type];
+
+type ResourceTypes = {
+    product: Product;
+    variant: ProductVariant;
+    collection: Collection;
+};
 
 interface RuleSet {
     appliedDisjunctively: boolean;
     rules: CollectionRule[];
 }
 
-interface SelectPayload {
-    readonly id?: string;
-    selection: ResourceSelection[];
+interface ScannerPayload {
+    data: string;
 }
 
+type SelectPayload<Type extends keyof ResourceTypes> = WithSelection<ResourceSelection<Type>[]>;
+
 export interface ShopifyGlobal {
     config: AppBridgeConfig;
     origin: string;
@@ -216,7 +224,15 @@ export interface ShopifyGlobal {
         show(message: string, opts?: Partial<ToastOptions>): string;
         hide(id: string): void;
     };
-    resourcePicker(options?: ResourcePickerOptions): Promise<SelectPayload | undefined>;
+    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>;
+    };
 }
 
 interface ToastOptions {
@@ -227,6 +243,12 @@ interface ToastOptions {
     onDismiss: () => void;
 }
 
+interface UIModalAttributes {
+    id?: string;
+    variant?: Variant;
+    children?: any;
+}
+
 interface User {
     id: string;
     name: string;
@@ -237,6 +259,8 @@ interface User {
     accountType: string;
 }
 
+type Variant = 'small' | 'base' | 'large' | 'max';
+
 enum WeightUnit {
     Kilograms = "KILOGRAMS",
     Grams = "GRAMS",
@@ -244,4 +268,12 @@ enum WeightUnit {
     Ounces = "OUNCES"
 }
 
+type WithSelection<T> = T & {
+    /**
+     * @private
+     * @deprecated
+     */
+    selection: T;
+};
+
 export { }