@shopify/app-bridge-types 0.0.2 → 0.0.3

package/package.json

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

package/shopify.ts

@@ -90,7 +90,7 @@ interface Image_2 {
 }
 
 export interface MenuItemProperties {
-    variant?: 'primary' | undefined;
+    variant?: 'primary' | 'breadcrumb' | null | undefined;
 }
 
 type Money = string;
@@ -192,17 +192,20 @@ 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[];
-}
+type SelectPayload<Type extends keyof ResourceTypes> = WithSelection<ResourceSelection<Type>[]>;
 
 export interface ShopifyGlobal {
     config: AppBridgeConfig;
@@ -216,7 +219,7 @@ 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>;
 }
 
 interface ToastOptions {
@@ -244,4 +247,12 @@ enum WeightUnit {
     Ounces = "OUNCES"
 }
 
+type WithSelection<T> = T & {
+    /**
+     * @private
+     * @deprecated
+     */
+    selection: T;
+};
+
 export { }