@shopify/shop-minis-platform 0.0.12 → 0.1.0

package/package.json

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

package/src/actions/actions.ts

@@ -88,6 +88,8 @@ import {
   GetContentResponse,
   GenerateUserTokenResponse,
   TranslateContentUpParams,
+  ShareSingleParams,
+  ShareSingleResponse,
 } from './params'
 import {ShopAction, SnakeToCamelCase} from './shared'
 
@@ -184,6 +186,7 @@ export interface ShopActionEvents {
     GetPopularProductsResponse
   >
   SHARE: ShopAction<ShareParams, ShareResponse>
+  SHARE_SINGLE: ShopAction<ShareSingleParams, ShareSingleResponse>
   GET_CURATED_PRODUCTS: ShopAction<
     GetCuratedProductsParams,
     GetCuratedProductsResponse

package/src/actions/params.ts

@@ -17,6 +17,9 @@ import {
   ContentIdentifierInput,
   UserTokenGenerateUserErrors,
   GeneratedTokenData,
+  BaseShareSingleOptions,
+  InstagramShareSingleOptions,
+  FacebookShareSingleOptions,
 } from '../types'
 
 export interface FavoriteParams {
@@ -567,6 +570,14 @@ export interface ShareResponse {
   dismissedAction?: boolean
 }
 
+export type ShareSingleParams =
+  | BaseShareSingleOptions
+  | InstagramShareSingleOptions
+  | FacebookShareSingleOptions
+export interface ShareSingleResponse {
+  message: string
+  success: boolean
+}
 export interface GetSavedProductsParams {
   includeSensitive?: boolean
   first?: number

package/src/types/index.ts

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

package/src/types/share.ts

@@ -0,0 +1,60 @@
+// Based on react-native-share shareSingle parameters
+export enum Social {
+  Facebook = 'facebook',
+  FacebookStories = 'facebookstories',
+  Pagesmanager = 'pagesmanager',
+  Twitter = 'twitter',
+  Whatsapp = 'whatsapp',
+  Whatsappbusiness = 'whatsappbusiness',
+  Instagram = 'instagram',
+  InstagramStories = 'instagramstories',
+  Googleplus = 'googleplus',
+  Email = 'email',
+  Pinterest = 'pinterest',
+  Linkedin = 'linkedin',
+  Sms = 'sms',
+  Telegram = 'telegram',
+  Snapchat = 'snapchat',
+  Messenger = 'messenger',
+  Viber = 'viber',
+  Discord = 'discord',
+}
+
+export interface BaseShareSingleOptions {
+  appId?: string
+  urls?: string[]
+  url?: string
+  type?: string
+  filename?: string
+  message?: string
+  title?: string
+  subject?: string
+  email?: string
+  recipient?: string
+  social: Exclude<Social, Social.FacebookStories | Social.InstagramStories>
+  forceDialog?: boolean
+}
+
+export interface InstagramShareSingleOptions
+  extends BaseSocialStoriesShareSingleOptions {
+  social: Social.InstagramStories
+  appId: string
+}
+
+export interface FacebookShareSingleOptions
+  extends BaseSocialStoriesShareSingleOptions {
+  social: Social.FacebookStories
+  appId: string
+}
+
+interface BaseSocialStoriesShareSingleOptions
+  extends Omit<BaseShareSingleOptions, 'social'> {
+  backgroundImage?: string
+  stickerImage?: string
+  backgroundBottomColor?: string
+  backgroundTopColor?: string
+  attributionURL?: string
+  backgroundVideo?: string
+  linkUrl?: string
+  linkText?: string
+}