@shopify/shop-minis-platform 0.12.1 → 0.14.1

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@shopify/shop-minis-platform",
   "license": "SEE LICENSE IN LICENSE.txt",
-  "version": "0.12.1",
+  "version": "0.14.1",
   "description": "Shared type definitions for Shop Minis Platform",
   "main": "src/index.ts",
   "exports": {
     ".": "./src/index.ts",
+    "./package.json": "./package.json",
     "./actions": "./src/actions/index.ts",
     "./events": "./src/events/index.ts"
   },
@@ -20,7 +21,9 @@
   ],
   "dependencies": {},
   "peerDependencies": {},
-  "devDependencies": {},
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  },
   "author": "Shopify",
   "repository": {
     "type": "git",
@@ -29,6 +32,7 @@
   },
   "scripts": {
     "test": "TZ=UTC jest",
-    "type-check": "tsc --noEmit"
+    "type-check": "tsc --noEmit",
+    "typecheck": "pnpm run type-check"
   }
 }

package/src/actions/actions.ts

@@ -93,6 +93,8 @@ import {
   ShareSingleResponse,
   RequestPermissionParams,
   RequestPermissionResponse,
+  CheckPermissionParams,
+  CheckPermissionResponse,
   ReportErrorParams,
   ReportFetchParams,
 } from './params'
@@ -235,6 +237,7 @@ export interface ShopActionEvents {
     RequestPermissionParams,
     RequestPermissionResponse
   >
+  CHECK_PERMISSION: ShopAction<CheckPermissionParams, CheckPermissionResponse>
   REPORT_ERROR: ShopAction<ReportErrorParams, void>
   REPORT_FETCH: ShopAction<ReportFetchParams, void>
 }

package/src/actions/params.ts

@@ -34,6 +34,33 @@ export interface RequestPermissionResponse {
   errorMessage?: string
 }
 
+/**
+ * The current state of a permission for the Mini.
+ *
+ * - `granted`: The user has approved the in-app consent dialog and the OS has granted the permission.
+ * - `denied`: The user has previously denied the permission, either in the in-app consent dialog or at the OS level. The permission can still be requested again.
+ * - `blocked`: The permission is blocked at the OS level. The user must enable it from device settings.
+ * - `undetermined`: The user has not yet been shown the in-app consent dialog for this permission.
+ * - `unavailable`: The permission is not declared in the Mini's manifest, or the feature is not available on this device.
+ *
+ * @publicDocs
+ */
+export type PermissionStatus =
+  | 'granted'
+  | 'denied'
+  | 'blocked'
+  | 'undetermined'
+  | 'unavailable'
+
+export interface CheckPermissionParams {
+  permission: MiniPermission
+}
+
+export interface CheckPermissionResponse {
+  status: PermissionStatus
+  errorMessage?: string
+}
+
 export interface FavoriteParams {
   shopId: string
   productId: string

package/src/actions/scopes.ts

@@ -1,4 +1,4 @@
-import {ShopActionEvents} from '@shopify/shop-minis-platform/actions'
+import {ShopActionEvents} from './actions'
 
 // This enum should always match `MiniScopeEnum` in `shop-types`
 /* eslint-disable @shopify/typescript/prefer-pascal-case-enums */
@@ -8,25 +8,13 @@ export enum Scope {
   USER_SETTINGS_READ = 'user_settings:read',
   PROFILE = 'profile',
 
-  // Products
-  PRODUCTS_RECENT_READ = 'products:recent:read',
-  PRODUCTS_RECOMMENDATIONS_READ = 'products:recommendations:read',
-
-  // Shops
-  SHOPS_RECENT_READ = 'shops:recent:read',
-  SHOPS_FOLLOWS = 'shops:follows',
-  SHOPS_FOLLOWS_READ = 'shops:follows:read',
+  // Write scopes
   SHOPS_FOLLOWS_WRITE = 'shops:follows:write',
-  SHOPS_RECOMMENDATIONS_READ = 'shops:recommendations:read',
-
-  // Orders
-  ORDERS = 'orders',
-
-  // Product lists
-  PRODUCT_LIST = 'product_list',
-  PRODUCT_LIST_READ = 'product_list:read',
   PRODUCT_LIST_WRITE = 'product_list:write',
   PRODUCT_LIST_ITEM_WRITE = 'product_list_item:write',
+
+  // Sensitive Scopes (require runtime consent)
+  ORDERS = 'orders',
 }
 /* eslint-enable @shopify/typescript/prefer-pascal-case-enums */
 
@@ -37,20 +25,13 @@ export const ActionToScopesMapping: {
   GET_BUYER_ATTRIBUTES: Scope.PROFILE,
   GET_CURRENT_USER: Scope.USER_SETTINGS_READ,
 
+  // Orders
+  GET_ORDERS: Scope.ORDERS,
+
   // Shops
-  GET_FOLLOWED_SHOPS: Scope.SHOPS_FOLLOWS_READ,
-  GET_RECENT_SHOPS: Scope.SHOPS_RECENT_READ,
-  GET_RECOMMENDED_SHOPS: Scope.SHOPS_RECOMMENDATIONS_READ,
   FOLLOW_SHOP: Scope.SHOPS_FOLLOWS_WRITE,
   UNFOLLOW_SHOP: Scope.SHOPS_FOLLOWS_WRITE,
 
-  // Products
-  GET_RECENT_PRODUCTS: Scope.PRODUCTS_RECENT_READ,
-  GET_RECOMMENDED_PRODUCTS: Scope.PRODUCTS_RECOMMENDATIONS_READ,
-
-  // Orders
-  GET_ORDERS: Scope.ORDERS,
-
   // Product lists
   ADD_PRODUCT_LIST: Scope.PRODUCT_LIST_WRITE,
   ADD_PRODUCT_LIST_ITEM: Scope.PRODUCT_LIST_ITEM_WRITE,
@@ -59,9 +40,6 @@ export const ActionToScopesMapping: {
   REMOVE_PRODUCT_LIST: Scope.PRODUCT_LIST_WRITE,
   REMOVE_PRODUCT_LIST_ITEM: Scope.PRODUCT_LIST_ITEM_WRITE,
   RENAME_PRODUCT_LIST: Scope.PRODUCT_LIST_WRITE,
-  GET_SAVED_PRODUCTS: Scope.PRODUCT_LIST_READ,
-  GET_PRODUCT_LIST: Scope.PRODUCT_LIST_READ,
-  GET_PRODUCT_LISTS: Scope.PRODUCT_LIST_READ,
 } as const
 
 export const ActionToOptionalScopesMapping: {

package/src/types/minis.ts

@@ -1,3 +1,4 @@
+/** @publicDocs */
 export interface SafeAreaInsets {
   top: number
   right: number