@shopify/shop-minis-platform 0.15.1 → 0.17.0

package/package.json

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

package/src/actions/actions.ts

@@ -96,6 +96,9 @@ import {
   RequestPermissionResponse,
   CheckPermissionParams,
   CheckPermissionResponse,
+  CheckScopesConsentParams,
+  CheckScopesConsentResponse,
+  RequestScopesConsentResponse,
   ReportErrorParams,
   ReportFetchParams,
 } from './params'
@@ -239,6 +242,11 @@ export interface ShopActionEvents {
     RequestPermissionResponse
   >
   CHECK_PERMISSION: ShopAction<CheckPermissionParams, CheckPermissionResponse>
+  CHECK_SCOPES_CONSENT: ShopAction<
+    CheckScopesConsentParams,
+    {data: CheckScopesConsentResponse}
+  >
+  REQUEST_SCOPES_CONSENT: ShopAction<void, RequestScopesConsentResponse>
   REPORT_ERROR: ShopAction<ReportErrorParams, void>
   REPORT_FETCH: ShopAction<ReportFetchParams, void>
   INVOKE_INTENT: ShopAction<InvokeIntentParams, InvokeIntentResponse>

package/src/actions/params.ts

@@ -61,6 +61,20 @@ export interface CheckPermissionResponse {
   errorMessage?: string
 }
 
+export interface CheckScopesConsentParams {
+  fetchPolicy?: DataHookFetchPolicy
+}
+
+export interface CheckScopesConsentResponse {
+  requiredScopes: string[]
+  grantedScopes: string[]
+  status: 'granted' | 'partially_granted' | 'not_granted'
+}
+
+export interface RequestScopesConsentResponse {
+  granted: boolean
+}
+
 export interface FavoriteParams {
   shopId: string
   productId: string
@@ -304,19 +318,22 @@ export interface PaginatedResponse<T> {
   pageInfo: PaginationInfo
 }
 
-export interface GetProductListsResponse
-  extends PaginatedResponse<ProductList[]> {}
-export interface GetProductListResponse
-  extends PaginatedResponse<ProductList | null> {}
+export interface GetProductListsResponse extends PaginatedResponse<
+  ProductList[]
+> {}
+export interface GetProductListResponse extends PaginatedResponse<ProductList | null> {}
 
-export interface GetRecommendedProductsResponse
-  extends PaginatedResponse<Product[]> {}
+export interface GetRecommendedProductsResponse extends PaginatedResponse<
+  Product[]
+> {}
 
-export interface GetRecommendedShopsResponse
-  extends PaginatedResponse<Shop[]> {}
+export interface GetRecommendedShopsResponse extends PaginatedResponse<
+  Shop[]
+> {}
 
-export interface SearchProductsByShopResponse
-  extends PaginatedResponse<Product[]> {}
+export interface SearchProductsByShopResponse extends PaginatedResponse<
+  Product[]
+> {}
 
 export interface GetBuyerAttributesResponse {
   data: {
@@ -546,8 +563,9 @@ export interface GetPopularProductsParams {
   fetchPolicy?: DataHookFetchPolicy
 }
 
-export interface GetPopularProductsResponse
-  extends PaginatedResponse<Product[]> {}
+export interface GetPopularProductsResponse extends PaginatedResponse<
+  Product[]
+> {}
 
 export interface PreviewProductInARParams {
   id: string
@@ -561,8 +579,9 @@ export interface GetProductMediaParams {
   fetchPolicy?: DataHookFetchPolicy
 }
 
-export interface GetProductMediaResponse
-  extends PaginatedResponse<ProductMedia[]> {}
+export interface GetProductMediaResponse extends PaginatedResponse<
+  ProductMedia[]
+> {}
 
 export interface GetProductReviewsParams {
   id: string
@@ -571,8 +590,9 @@ export interface GetProductReviewsParams {
   fetchPolicy?: DataHookFetchPolicy
 }
 
-export interface GetProductReviewsResponse
-  extends PaginatedResponse<ProductReview[]> {}
+export interface GetProductReviewsResponse extends PaginatedResponse<
+  ProductReview[]
+> {}
 
 export interface GetShopParams {
   id: string
@@ -646,8 +666,9 @@ export interface GetSavedProductsParams {
   fetchPolicy?: DataHookFetchPolicy
 }
 
-export interface GetSavedProductsResponse
-  extends PaginatedResponse<Product[]> {}
+export interface GetSavedProductsResponse extends PaginatedResponse<
+  Product[]
+> {}
 
 export interface GetRecentProductsParams {
   includeSensitive?: boolean
@@ -656,8 +677,9 @@ export interface GetRecentProductsParams {
   fetchPolicy?: DataHookFetchPolicy
 }
 
-export interface GetRecentProductsResponse
-  extends PaginatedResponse<Product[]> {}
+export interface GetRecentProductsResponse extends PaginatedResponse<
+  Product[]
+> {}
 
 export interface GetProductSearchParams {
   query: string
@@ -669,8 +691,9 @@ export interface GetProductSearchParams {
   fetchPolicy?: DataHookFetchPolicy
 }
 
-export interface GetProductSearchResponse
-  extends PaginatedResponse<Product[]> {}
+export interface GetProductSearchResponse extends PaginatedResponse<
+  Product[]
+> {}
 
 export interface GetProductVariantsParams {
   id: string
@@ -679,8 +702,9 @@ export interface GetProductVariantsParams {
   fetchPolicy?: DataHookFetchPolicy
 }
 
-export interface GetProductVariantsResponse
-  extends PaginatedResponse<ProductVariant[]> {}
+export interface GetProductVariantsResponse extends PaginatedResponse<
+  ProductVariant[]
+> {}
 
 export interface CreateContentParams {
   title: string

package/src/types/product.ts

@@ -17,6 +17,13 @@ export interface ProductVariant {
   id: string
   title: string
   isFavorited: boolean
+  /**
+   * Whether the variant can be purchased. When `false`, calls to add the variant
+   * to cart or buy it through the SDK will fail. UI should be gated on this flag.
+   * May be `undefined` if the variant was sourced from an API that does not
+   * expose stock state.
+   */
+  availableForSale: boolean
   image?: ProductImage | null
   price: Money
   compareAtPrice?: Money | null