@shopify/shop-minis-platform 0.8.5 → 0.10.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.10.0",
   "description": "Shared type definitions for Shop Minis Platform",
   "main": "src/index.ts",
   "exports": {

package/src/actions/actions.ts

@@ -42,6 +42,7 @@ import {
   AddProductListParams,
   RemoveProductListParams,
   RenameProductListParams,
+  SetProductListVisibilityParams,
   AddProductListItemParams,
   RemoveProductListItemParams,
   GetRecommendedProductsParams,
@@ -73,6 +74,8 @@ import {
   GetProductVariantsResponse,
   GetProductMediaParams,
   GetProductMediaResponse,
+  GetProductReviewsParams,
+  GetProductReviewsResponse,
   GetShopParams,
   GetShopResponse,
   GetRecentShopsParams,
@@ -163,6 +166,10 @@ export interface ShopActionEvents {
   ADD_PRODUCT_LIST: ShopAction<AddProductListParams, ProductList>
   REMOVE_PRODUCT_LIST: ShopAction<RemoveProductListParams, void>
   RENAME_PRODUCT_LIST: ShopAction<RenameProductListParams, ProductList>
+  SET_PRODUCT_LIST_VISIBILITY: ShopAction<
+    SetProductListVisibilityParams,
+    ProductList
+  >
   ADD_PRODUCT_LIST_ITEM: ShopAction<AddProductListItemParams, void>
   REMOVE_PRODUCT_LIST_ITEM: ShopAction<RemoveProductListItemParams, void>
   GET_RECOMMENDED_PRODUCTS: ShopAction<
@@ -208,6 +215,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

@@ -5,7 +5,9 @@ import {
   Product,
   ProductFilters,
   ProductList,
+  ProductListPrivacyStatus,
   ProductMedia,
+  ProductReview,
   ProductSearchSortBy,
   ProductVariant,
   Shop,
@@ -386,6 +388,10 @@ export interface AddProductListParams {
    * A description of the product list.
    */
   description?: string
+  /**
+   * The privacy status of the product list. Defaults to 'PRIVATE'.
+   */
+  privacyStatus?: ProductListPrivacyStatus
 }
 
 export interface RemoveProductListParams {
@@ -405,6 +411,22 @@ export interface RenameProductListParams {
    */
   name: string
 }
+
+export interface SetProductListVisibilityParams {
+  /**
+   * The GID of the product list. E.g. `gid://shopapp/ProductList/123`.
+   */
+  id: string
+  /**
+   * The name of the product list. Required to preserve the existing name.
+   */
+  name: string
+  /**
+   * The privacy status to set for the product list.
+   */
+  privacyStatus: ProductListPrivacyStatus
+}
+
 export interface AddProductListItemParams {
   /**
    * The GID of the shop. E.g. `gid://shopify/Shop/42`.
@@ -515,6 +537,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
@@ -85,10 +95,13 @@ export interface Product {
   referral?: boolean
 }
 
+export type ProductListPrivacyStatus = 'PRIVATE' | 'PUBLIC'
+
 export interface ProductList {
   id: string
   publicId: string | null
   name: string | null
+  privacyStatus: ProductListPrivacyStatus
   products: Product[]
 }