@shopify/shop-minis-platform 0.3.0 → 0.4.0

package/package.json

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

package/src/actions/index.ts

@@ -1,4 +1,4 @@
 export * from './actions'
-export * from './consent'
 export * from './shared'
 export * from './params'
+export * from './scopes'

package/src/actions/scopes.ts

@@ -0,0 +1,68 @@
+import {ShopActionEvents} from '@shopify/shop-minis-platform/actions'
+
+export const Scope = {
+  // User
+  OPENID: 'OPENID',
+  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',
+  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',
+  FAVORITES: 'FAVORITES',
+  FAVORITES_WRITE: 'FAVORITES_WRITE',
+} as const
+
+export type ScopeType = (typeof Scope)[keyof typeof Scope]
+
+export const ActionToScopesMapping: {
+  [key in keyof ShopActionEvents]?: ScopeType
+} = {
+  // User
+  GENERATE_USER_TOKEN: Scope.OPENID,
+  GET_ACCOUNT_INFORMATION: Scope.PROFILE,
+  GET_BUYER_ATTRIBUTES: Scope.PROFILE,
+  GET_CURRENT_USER: Scope.USER_SETTINGS_READ,
+
+  // 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,
+  FAVORITE: Scope.FAVORITES_WRITE,
+  UNFAVORITE: Scope.FAVORITES_WRITE,
+  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.FAVORITES,
+  GET_PRODUCT_LIST: Scope.PRODUCT_LIST_READ,
+  GET_PRODUCT_LISTS: Scope.PRODUCT_LIST_READ,
+} as const

package/src/types/content.ts

@@ -1,4 +1,11 @@
 /* eslint-disable @shopify/typescript/prefer-pascal-case-enums */
+
+export enum MinisContentStatus {
+  PENDING = 'PENDING',
+  READY = 'READY',
+  REJECTED = 'REJECTED',
+}
+
 export interface ImageType {
   url: string
   altText?: string | null
@@ -37,6 +44,7 @@ export interface Content {
   visibility: ContentVisibility[]
   shareableUrl?: string | null
   products?: ContentProduct[] | null
+  status?: MinisContentStatus | null
 }
 
 export enum ContentCreateUserErrorCode {

package/src/types/index.ts

@@ -4,7 +4,6 @@ export * from './shop'
 export * from './user'
 export * from './content'
 export * from './order'
-export * from './permissions'
 export * from './share'
 export * from './query'
 export * from './minis'

package/src/actions/consent.ts

@@ -1,109 +0,0 @@
-import {ShopActionEvents} from './actions'
-
-// Consent types
-export const UserDataConsent = {
-  // User & Account
-  USER_TOKEN: 'USER_TOKEN', // Generate user authentication tokens
-  VIEW_PROFILE: 'VIEW_PROFILE', // Name and avatar
-  VIEW_ACCOUNT_INFO: 'VIEW_ACCOUNT_INFO', // Account details and settings
-  VIEW_PREFERENCES: 'VIEW_PREFERENCES', // Gender and category preferences
-
-  // Products
-  VIEW_VISITED_PRODUCTS: 'VIEW_VISITED_PRODUCTS', // Products you've viewed
-  VIEW_PRODUCT_RECOMMENDATIONS: 'VIEW_PRODUCT_RECOMMENDATIONS', // View suggested products
-
-  // Shops
-  VIEW_VISITED_SHOPS: 'VIEW_VISITED_SHOPS', // Shops you've visited
-  VIEW_FOLLOWED_SHOPS: 'VIEW_FOLLOWED_SHOPS', // View shops you follow
-  VIEW_SHOP_RECOMMENDATIONS: 'VIEW_SHOP_RECOMMENDATIONS', // View suggested shops
-  FOLLOW_SHOPS: 'FOLLOW_SHOPS', // Follow and unfollow shops
-
-  // Orders
-  VIEW_ORDERS: 'VIEW_ORDERS', // View your past purchases
-
-  // Lists - Viewing
-  VIEW_PRODUCT_LISTS: 'VIEW_PRODUCT_LISTS', // View your product lists
-  VIEW_SAVED_PRODUCTS: 'VIEW_SAVED_PRODUCTS', // View your favorited items
-
-  // Lists - Managing
-  CREATE_PRODUCT_LISTS: 'CREATE_PRODUCT_LISTS', // Create product lists
-  MANAGE_PRODUCT_LISTS: 'MANAGE_PRODUCT_LISTS', // Organize product lists
-  MANAGE_PRODUCT_LIST_ITEMS: 'MANAGE_PRODUCT_LIST_ITEMS', // Add and remove items from lists
-  SAVE_PRODUCTS: 'SAVE_PRODUCTS', // Save and unsave products
-} as const
-
-export type ConsentType = (typeof UserDataConsent)[keyof typeof UserDataConsent]
-
-// Consents UI groups
-export const ConsentModalGroups = {
-  profile: [
-    UserDataConsent.USER_TOKEN,
-    UserDataConsent.VIEW_PROFILE,
-    UserDataConsent.VIEW_ACCOUNT_INFO,
-    UserDataConsent.VIEW_PREFERENCES,
-  ] as ConsentType[],
-
-  activity: [
-    UserDataConsent.VIEW_VISITED_PRODUCTS,
-    UserDataConsent.VIEW_VISITED_SHOPS,
-    UserDataConsent.VIEW_PRODUCT_RECOMMENDATIONS,
-    UserDataConsent.VIEW_SHOP_RECOMMENDATIONS,
-    UserDataConsent.VIEW_SAVED_PRODUCTS,
-    UserDataConsent.VIEW_FOLLOWED_SHOPS,
-    UserDataConsent.VIEW_ORDERS,
-  ] as ConsentType[],
-
-  saves: [
-    UserDataConsent.SAVE_PRODUCTS,
-    UserDataConsent.FOLLOW_SHOPS,
-    UserDataConsent.CREATE_PRODUCT_LISTS,
-    UserDataConsent.MANAGE_PRODUCT_LISTS,
-    UserDataConsent.MANAGE_PRODUCT_LIST_ITEMS,
-    UserDataConsent.VIEW_PRODUCT_LISTS,
-  ] as ConsentType[],
-} as const
-
-// Set of actions mapped to required consents, which are watched by the PermissionsMiddleware
-// If an action is not listed here, no consent is required to perform it
-// (unless allowUnlistedActions is false in the PermissionsMiddleware config)
-export const ActionToUserDataConsentMapping: {
-  [key in keyof ShopActionEvents]?: ConsentType
-} = {
-  // User token
-  GENERATE_USER_TOKEN: UserDataConsent.USER_TOKEN,
-
-  // User profile
-  GET_ACCOUNT_INFORMATION: UserDataConsent.VIEW_ACCOUNT_INFO,
-  GET_BUYER_ATTRIBUTES: UserDataConsent.VIEW_PREFERENCES,
-  GET_CURRENT_USER: UserDataConsent.VIEW_PROFILE,
-
-  // Shops data
-  GET_FOLLOWED_SHOPS: UserDataConsent.VIEW_FOLLOWED_SHOPS,
-  GET_RECENT_SHOPS: UserDataConsent.VIEW_VISITED_SHOPS,
-  GET_RECOMMENDED_SHOPS: UserDataConsent.VIEW_SHOP_RECOMMENDATIONS,
-
-  // Products data
-  GET_RECENT_PRODUCTS: UserDataConsent.VIEW_VISITED_PRODUCTS,
-  GET_RECOMMENDED_PRODUCTS: UserDataConsent.VIEW_PRODUCT_RECOMMENDATIONS,
-
-  // Orders data
-  GET_ORDERS: UserDataConsent.VIEW_ORDERS,
-
-  // Shop following
-  FOLLOW_SHOP: UserDataConsent.FOLLOW_SHOPS,
-  UNFOLLOW_SHOP: UserDataConsent.FOLLOW_SHOPS,
-
-  // Manage product lists
-  ADD_PRODUCT_LIST: UserDataConsent.CREATE_PRODUCT_LISTS,
-  ADD_PRODUCT_LIST_ITEM: UserDataConsent.MANAGE_PRODUCT_LIST_ITEMS,
-  FAVORITE: UserDataConsent.SAVE_PRODUCTS,
-  UNFAVORITE: UserDataConsent.SAVE_PRODUCTS,
-  REMOVE_PRODUCT_LIST: UserDataConsent.MANAGE_PRODUCT_LISTS,
-  REMOVE_PRODUCT_LIST_ITEM: UserDataConsent.MANAGE_PRODUCT_LIST_ITEMS,
-  RENAME_PRODUCT_LIST: UserDataConsent.MANAGE_PRODUCT_LISTS,
-
-  // View product lists
-  GET_SAVED_PRODUCTS: UserDataConsent.VIEW_SAVED_PRODUCTS,
-  GET_PRODUCT_LIST: UserDataConsent.VIEW_PRODUCT_LISTS,
-  GET_PRODUCT_LISTS: UserDataConsent.VIEW_PRODUCT_LISTS,
-}

package/src/types/permissions.ts

@@ -1,24 +0,0 @@
-export type Permission = 'CAMERA' | 'GALLERY' | 'MICROPHONE'
-
-export interface MiniManifest {
-  trusted_domains?: string[]
-  permissions?: string[]
-  [key: string]: any
-}
-
-export const Consent = {
-  MiniConsent: 'mini_consent',
-  CameraConsent: 'camera_consent',
-  PhotoLibraryConsent: 'photo_library_consent',
-  MicrophoneConsent: 'microphone_consent',
-} as const
-
-export const ConsentStatus = {
-  Granted: 'granted',
-  Dismissed: 'dismissed',
-  Idle: 'idle',
-} as const
-
-export type ConsentType = (typeof Consent)[keyof typeof Consent]
-export type ConsentStatusType =
-  (typeof ConsentStatus)[keyof typeof ConsentStatus]