@shopify/shop-minis-platform 0.8.5 → 0.9.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shopify/shop-minis-platform",
   "license": "SEE LICENSE IN LICENSE.txt",
-  "version": "0.8.5",
+  "version": "0.9.0",
   "description": "Shared type definitions for Shop Minis Platform",
   "main": "src/index.ts",
   "exports": {

package/src/actions/actions.ts

@@ -73,6 +73,8 @@ import {
   GetProductVariantsResponse,
   GetProductMediaParams,
   GetProductMediaResponse,
+  GetProductReviewsParams,
+  GetProductReviewsResponse,
   GetShopParams,
   GetShopResponse,
   GetRecentShopsParams,
@@ -208,6 +210,10 @@ export interface ShopActionEvents {
     GetProductVariantsResponse
   >
   GET_PRODUCT_MEDIA: ShopAction<GetProductMediaParams, GetProductMediaResponse>
+  GET_PRODUCT_REVIEWS: ShopAction<
+    GetProductReviewsParams,
+    GetProductReviewsResponse
+  >
   GET_SHOP: ShopAction<GetShopParams, GetShopResponse>
   GET_RECENT_SHOPS: ShopAction<GetRecentShopsParams, GetRecentShopsResponse>
   GET_FOLLOWED_SHOPS: ShopAction<

package/src/actions/params.ts

@@ -6,6 +6,7 @@ import {
   ProductFilters,
   ProductList,
   ProductMedia,
+  ProductReview,
   ProductSearchSortBy,
   ProductVariant,
   Shop,
@@ -515,6 +516,16 @@ export interface GetProductMediaParams {
 export interface GetProductMediaResponse
   extends PaginatedResponse<ProductMedia[]> {}
 
+export interface GetProductReviewsParams {
+  id: string
+  first?: number
+  after?: string
+  fetchPolicy?: DataHookFetchPolicy
+}
+
+export interface GetProductReviewsResponse
+  extends PaginatedResponse<ProductReview[]> {}
+
 export interface GetShopParams {
   id: string
   fetchPolicy?: DataHookFetchPolicy

package/src/types/product.ts

@@ -22,6 +22,16 @@ export interface ProductVariant {
   compareAtPrice?: Money | null
 }
 
+export interface ProductReview {
+  id: string
+  rating: number
+  title?: string | null
+  body?: string | null
+  submittedAt: string
+  merchantReply?: string | null
+  merchantRepliedAt?: string | null
+}
+
 export interface ProductShop {
   id: string
   name: string