@shopify/app-bridge-types 0.0.17 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.1.0
+
+### Minor Changes
+
+- [#518](https://github.com/Shopify/extensibility/pull/518) [`bc1af9034c8cca66ebd7a44474aa7a11de7013e9`](https://github.com/Shopify/extensibility/commit/bc1af9034c8cca66ebd7a44474aa7a11de7013e9) Thanks [@SammyJoeOsborne](https://github.com/SammyJoeOsborne)! - Adding types for reviews plugin api.
+
+## 0.0.18
+
+### Patch Changes
+
+- [#325](https://github.com/Shopify/extensibility/pull/325) [`dfac2e4a775102b81488155dc4b00c8132988a22`](https://github.com/Shopify/extensibility/commit/dfac2e4a775102b81488155dc4b00c8132988a22) Thanks [@elanalynn](https://github.com/elanalynn)! - Expose ResourcePicker and Toast types
+
 ## 0.0.17
 
 ### Patch Changes

package/dist/index.d.ts

@@ -11,6 +11,10 @@ import type {
   UINavMenuAttributes,
   UITitleBarAttributes,
   UISaveBarAttributes,
+  ToastOptions,
+  Product,
+  ProductVariant,
+  Collection,
 } from './shopify';
 
 export {
@@ -19,6 +23,10 @@ export {
   UINavMenuAttributes,
   UITitleBarAttributes,
   UISaveBarAttributes,
+  ToastOptions,
+  Product,
+  ProductVariant,
+  Collection,
 };
 
 declare global {

package/dist/shopify.ts

@@ -194,7 +194,7 @@ interface Cart {
  */
 type CartSubscriber = (cart: Cart) => void;
 
-interface Collection extends Resource {
+export interface Collection extends Resource {
     availablePublicationCount: number;
     description: string;
     descriptionHtml: string;
@@ -747,7 +747,7 @@ interface PrivilegedAdminUser extends AdminUser {
     email?: string;
 }
 
-interface Product extends Resource {
+export interface Product extends Resource {
     availablePublicationCount: number;
     createdAt: string;
     descriptionHtml: string;
@@ -780,7 +780,7 @@ enum ProductStatus {
     Draft = "DRAFT"
 }
 
-interface ProductVariant extends Resource {
+export interface ProductVariant extends Resource {
     availableForSale: boolean;
     barcode?: string | null;
     compareAtPrice?: Money | null;
@@ -876,6 +876,26 @@ type ResourceTypes = {
     collection: Collection;
 };
 
+type ReviewRequestDeclinedCode = 'mobile-app' | 'already-reviewed' | 'annual-limit-reached' | 'cooldown-period' | 'merchant-ineligible';
+
+interface ReviewRequestDeclinedResponse {
+    success: false;
+    code: ReviewRequestDeclinedCode;
+    message: string;
+}
+
+type ReviewRequestResponse = ReviewRequestSuccessResponse | ReviewRequestDeclinedResponse;
+
+interface ReviewRequestSuccessResponse {
+    success: true;
+    code: 'success';
+    message: 'Review modal shown successfully';
+}
+
+interface ReviewsApi {
+    request(): Promise<ReviewRequestResponse>;
+}
+
 interface RuleSet {
     appliedDisjunctively: boolean;
     rules: CollectionRule[];
@@ -982,6 +1002,7 @@ export interface ShopifyGlobal {
     intents: IntentsApi;
     webVitals: WebVitalsApi;
     support: SupportApi;
+    reviews: ReviewsApi;
     scopes: Scopes;
     picker: PickerApi;
 }
@@ -1015,7 +1036,7 @@ interface ToastApi {
 
 type ToastHide = (id: string) => void;
 
-interface ToastOptions {
+export interface ToastOptions {
     /**
      * The length of time in milliseconds the toast message should persist.
      * @defaultValue 5000

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/app-bridge-types",
-  "version": "0.0.17",
+  "version": "0.1.0",
   "description": "Companion types library for the Shopify App Bridge script",
   "private": false,
   "publishConfig": {