@react-native-kakao/share 3.0.0 → 3.1.0-next.1

package/src/index.ts

@@ -3,9 +3,15 @@ import type { Double, UnsafeObject } from 'react-native/Libraries/Types/CodegenT
 import type {
   KakaoCalendarTemplate,
   KakaoCommerceTemplate,
+  KakaoDefaultTemplateParams,
   KakaoFeedTemplate,
+  KakaoImageUploadResult,
   KakaoListTemplate,
   KakaoLocationTemplate,
+  KakaoMessageSendResult,
+  KakaoSharePickerSettings,
+  KakaoShareTemplateDiagnostics,
+  KakaoShareTemplateDiagnosticsParams,
   KakaoTemplateButton,
   KakaoTemplateCommerce,
   KakaoTemplateContent,
@@ -17,6 +23,7 @@ import type {
 } from './spec/NativeKakaoShare';
 import Native from './spec/NativeKakaoShare';
 import { swapMobileExecutionParamsFieldValueIntoStringInIOS } from './util/swapMobileExecutionParamsFieldValueIntoStringInIOS';
+import { validateSharePickerSettings } from './validateSharePickerSettings';
 
 export type {
   KakaoTemplateSocial,
@@ -28,12 +35,22 @@ export type {
   KakaoTemplateCommerce,
   KakaoTemplateButton,
   KakaoLocationTemplate,
+  KakaoMessageSendResult,
+  KakaoSharePickerSettings,
+  KakaoShareTemplateDiagnostics,
+  KakaoShareTemplateDiagnosticsParams,
   KakaoListTemplate,
   KakaoFeedTemplate,
   KakaoCommerceTemplate,
   KakaoCalendarTemplate,
+  KakaoImageUploadResult,
+  KakaoDefaultTemplateParams,
 };
 
+export function isKakaoTalkSharingAvailable(): Promise<boolean> {
+  return Native.isKakaoTalkSharingAvailable();
+}
+
 function shareOrSendMeOrSendFriendOrWhatever(
   /* share, send-me, send-friend */
   sendType: string,
@@ -48,8 +65,10 @@ function shareOrSendMeOrSendFriendOrWhatever(
   useWebBrowserIfKakaoTalkNotAvailable: boolean,
   templateArgs: Readonly<{ [key: string]: string }>,
   serverCallbackArgs: Readonly<{ [key: string]: string }>,
+  includeFailureInfo?: boolean,
+  pickerSettings?: KakaoSharePickerSettings,
 ): Promise<any> {
-  return Native.shareOrSendMeOrSendFriendOrWhatever(
+  const response = Native.shareOrSendMeOrSendFriendOrWhatever(
     sendType,
     templateType,
     templateId,
@@ -58,12 +77,26 @@ function shareOrSendMeOrSendFriendOrWhatever(
     useWebBrowserIfKakaoTalkNotAvailable,
     templateArgs,
     serverCallbackArgs,
+    validateSharePickerSettings(pickerSettings),
   );
+
+  if (sendType === SendTypes.sendFriend) {
+    return response.then((result: KakaoMessageSendResult) =>
+      includeFailureInfo ? result : result.successfulReceiverUuids,
+    );
+  }
+
+  return response;
 }
 
+export type KakaoFriendMessageResult<T extends boolean = false> = T extends true
+  ? KakaoMessageSendResult
+  : string[];
+
 const SendTypes = { share: 'share', sendMe: 'send-me', sendFriend: 'send-friend' };
 const TemplateTypes = {
   custom: 'custom',
+  scrap: 'scrap',
   feed: 'feed',
   list: 'list',
   location: 'location',
@@ -71,17 +104,163 @@ const TemplateTypes = {
   text: 'text',
   calendar: 'calendar',
 };
+const DefaultScrapTemplateId = -1;
+
+export async function getShareTemplateDiagnostics(
+  params: KakaoShareTemplateDiagnosticsParams,
+): Promise<KakaoShareTemplateDiagnostics> {
+  const template =
+    'template' in params
+      ? params.template
+      : 'requestUrl' in params
+        ? { requestUrl: params.requestUrl }
+        : {};
+
+  return Native.getTemplateDiagnostics(
+    params.templateType,
+    'templateId' in params ? params.templateId ?? DefaultScrapTemplateId : DefaultScrapTemplateId,
+    swapMobileExecutionParamsFieldValueIntoStringInIOS(template),
+    'templateArgs' in params ? params.templateArgs ?? {} : {},
+    params.serverCallbackArgs ?? {},
+    validateSharePickerSettings(params.pickerSettings),
+  );
+}
+
+export async function makeDefaultTemplateUrl({
+  templateType,
+  template,
+  serverCallbackArgs = {},
+}: KakaoDefaultTemplateParams): Promise<string> {
+  return Native.makeTemplateUrl(
+    templateType,
+    DefaultScrapTemplateId,
+    swapMobileExecutionParamsFieldValueIntoStringInIOS(template),
+    {},
+    serverCallbackArgs,
+  );
+}
+
+export async function makeCustomTemplateUrl({
+  templateId,
+  templateArgs = {},
+  serverCallbackArgs = {},
+}: {
+  templateId: number;
+  templateArgs?: Record<string, string>;
+  serverCallbackArgs?: Record<string, string>;
+}): Promise<string> {
+  return Native.makeTemplateUrl(
+    TemplateTypes.custom,
+    templateId,
+    {},
+    templateArgs,
+    serverCallbackArgs,
+  );
+}
+
+export async function makeScrapTemplateUrl({
+  requestUrl,
+  templateId = DefaultScrapTemplateId,
+  templateArgs = {},
+  serverCallbackArgs = {},
+}: {
+  requestUrl: string;
+  templateId?: number;
+  templateArgs?: Record<string, string>;
+  serverCallbackArgs?: Record<string, string>;
+}): Promise<string> {
+  return Native.makeTemplateUrl(
+    TemplateTypes.scrap,
+    templateId,
+    { requestUrl },
+    templateArgs,
+    serverCallbackArgs,
+  );
+}
+
+export type KakaoScrapMessageParams = {
+  requestUrl: string;
+  templateId?: number;
+  templateArgs?: Record<string, string>;
+};
+
+export async function sendScrapTemplateToMe({
+  requestUrl,
+  templateId = DefaultScrapTemplateId,
+  templateArgs = {},
+}: KakaoScrapMessageParams) {
+  await Native.shareOrSendMeOrSendFriendOrWhatever(
+    SendTypes.sendMe,
+    TemplateTypes.scrap,
+    templateId,
+    { requestUrl },
+    [],
+    false,
+    templateArgs,
+    {},
+    undefined,
+  );
+}
+
+export function sendScrapTemplateToFriends<T extends boolean = false>({
+  requestUrl,
+  templateId = DefaultScrapTemplateId,
+  templateArgs = {},
+  receiverUuids,
+  includeFailureInfo,
+}: KakaoScrapMessageParams & { receiverUuids: string[]; includeFailureInfo?: T }): Promise<
+  KakaoFriendMessageResult<T>
+> {
+  return shareOrSendMeOrSendFriendOrWhatever(
+    SendTypes.sendFriend,
+    TemplateTypes.scrap,
+    templateId,
+    { requestUrl },
+    receiverUuids,
+    false,
+    templateArgs,
+    {},
+    includeFailureInfo,
+  );
+}
+
+export function shareScrapTemplate({
+  requestUrl,
+  templateId,
+  templateArgs = {},
+  serverCallbackArgs = {},
+  pickerSettings,
+  useWebBrowserIfKakaoTalkNotAvailable = true,
+}: {
+  requestUrl: string;
+  templateId?: number;
+  templateArgs?: Record<string, string>;
+  serverCallbackArgs?: Record<string, string>;
+  pickerSettings?: KakaoSharePickerSettings;
+  useWebBrowserIfKakaoTalkNotAvailable?: boolean;
+}): Promise<void> {
+  return Native.shareScrapTemplate(
+    requestUrl,
+    useWebBrowserIfKakaoTalkNotAvailable,
+    templateId,
+    templateArgs,
+    serverCallbackArgs,
+    validateSharePickerSettings(pickerSettings),
+  );
+}
 
 export function shareCustomTemplate({
   templateId,
   useWebBrowserIfKakaoTalkNotAvailable = true,
   serverCallbackArgs = {},
+  pickerSettings,
   templateArgs = {},
 }: {
   templateId: number;
   useWebBrowserIfKakaoTalkNotAvailable?: boolean;
   templateArgs?: Record<string, string>;
   serverCallbackArgs?: Record<string, string>;
+  pickerSettings?: KakaoSharePickerSettings;
 }) {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.share,
@@ -92,6 +271,8 @@ export function shareCustomTemplate({
     useWebBrowserIfKakaoTalkNotAvailable,
     templateArgs,
     serverCallbackArgs,
+    undefined,
+    pickerSettings,
   );
 }
 
@@ -114,15 +295,17 @@ export function sendCustomTemplateToMe({
   );
 }
 
-export function sendCustomTemplateToFriends({
+export function sendCustomTemplateToFriends<T extends boolean = false>({
   templateId,
   templateArgs = {},
   receiverUuids,
+  includeFailureInfo,
 }: {
   templateId: number;
   templateArgs?: Record<string, string>;
   receiverUuids: string[];
-}): Promise<string[]> {
+  includeFailureInfo?: T;
+}): Promise<KakaoFriendMessageResult<T>> {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.sendFriend,
     TemplateTypes.custom,
@@ -132,6 +315,7 @@ export function sendCustomTemplateToFriends({
     false,
     templateArgs,
     {},
+    includeFailureInfo,
   );
 }
 
@@ -139,10 +323,12 @@ export function shareFeedTemplate({
   template,
   useWebBrowserIfKakaoTalkNotAvailable = true,
   serverCallbackArgs = {},
+  pickerSettings,
 }: {
   template: KakaoFeedTemplate;
   useWebBrowserIfKakaoTalkNotAvailable?: boolean;
   serverCallbackArgs?: Record<string, string>;
+  pickerSettings?: KakaoSharePickerSettings;
 }) {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.share,
@@ -153,6 +339,8 @@ export function shareFeedTemplate({
     useWebBrowserIfKakaoTalkNotAvailable,
     {},
     serverCallbackArgs,
+    undefined,
+    pickerSettings,
   );
 }
 
@@ -169,13 +357,15 @@ export function sendFeedTemplateToMe({ template }: { template: KakaoFeedTemplate
   );
 }
 
-export function sendFeedTemplateToFriends({
+export function sendFeedTemplateToFriends<T extends boolean = false>({
   template,
   receiverUuids,
+  includeFailureInfo,
 }: {
   template: KakaoFeedTemplate;
   receiverUuids: string[];
-}): Promise<string[]> {
+  includeFailureInfo?: T;
+}): Promise<KakaoFriendMessageResult<T>> {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.sendFriend,
     TemplateTypes.feed,
@@ -185,6 +375,7 @@ export function sendFeedTemplateToFriends({
     false,
     {},
     {},
+    includeFailureInfo,
   );
 }
 
@@ -192,10 +383,12 @@ export function shareListTemplate({
   template,
   useWebBrowserIfKakaoTalkNotAvailable = true,
   serverCallbackArgs = {},
+  pickerSettings,
 }: {
   template: KakaoListTemplate;
   useWebBrowserIfKakaoTalkNotAvailable?: boolean;
   serverCallbackArgs?: Record<string, string>;
+  pickerSettings?: KakaoSharePickerSettings;
 }) {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.share,
@@ -206,6 +399,8 @@ export function shareListTemplate({
     useWebBrowserIfKakaoTalkNotAvailable,
     {},
     serverCallbackArgs,
+    undefined,
+    pickerSettings,
   );
 }
 
@@ -222,13 +417,15 @@ export function sendListTemplateToMe({ template }: { template: KakaoListTemplate
   );
 }
 
-export function sendListTemplateToFriends({
+export function sendListTemplateToFriends<T extends boolean = false>({
   template,
   receiverUuids,
+  includeFailureInfo,
 }: {
   template: KakaoListTemplate;
   receiverUuids: string[];
-}): Promise<string[]> {
+  includeFailureInfo?: T;
+}): Promise<KakaoFriendMessageResult<T>> {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.sendFriend,
     TemplateTypes.list,
@@ -238,6 +435,7 @@ export function sendListTemplateToFriends({
     false,
     {},
     {},
+    includeFailureInfo,
   );
 }
 
@@ -245,10 +443,12 @@ export function shareLocationTemplate({
   template,
   useWebBrowserIfKakaoTalkNotAvailable = true,
   serverCallbackArgs = {},
+  pickerSettings,
 }: {
   template: KakaoLocationTemplate;
   useWebBrowserIfKakaoTalkNotAvailable?: boolean;
   serverCallbackArgs?: Record<string, string>;
+  pickerSettings?: KakaoSharePickerSettings;
 }) {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.share,
@@ -259,6 +459,8 @@ export function shareLocationTemplate({
     useWebBrowserIfKakaoTalkNotAvailable,
     {},
     serverCallbackArgs,
+    undefined,
+    pickerSettings,
   );
 }
 
@@ -275,13 +477,15 @@ export function sendLocationTemplateToMe({ template }: { template: KakaoLocation
   );
 }
 
-export function sendLocationTemplateToFriends({
+export function sendLocationTemplateToFriends<T extends boolean = false>({
   template,
   receiverUuids,
+  includeFailureInfo,
 }: {
   template: KakaoLocationTemplate;
   receiverUuids: string[];
-}): Promise<string[]> {
+  includeFailureInfo?: T;
+}): Promise<KakaoFriendMessageResult<T>> {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.sendFriend,
     TemplateTypes.location,
@@ -291,6 +495,7 @@ export function sendLocationTemplateToFriends({
     false,
     {},
     {},
+    includeFailureInfo,
   );
 }
 
@@ -298,10 +503,12 @@ export function shareCommerceTemplate({
   template,
   useWebBrowserIfKakaoTalkNotAvailable = true,
   serverCallbackArgs = {},
+  pickerSettings,
 }: {
   template: KakaoCommerceTemplate;
   useWebBrowserIfKakaoTalkNotAvailable?: boolean;
   serverCallbackArgs?: Record<string, string>;
+  pickerSettings?: KakaoSharePickerSettings;
 }) {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.share,
@@ -312,6 +519,8 @@ export function shareCommerceTemplate({
     useWebBrowserIfKakaoTalkNotAvailable,
     {},
     serverCallbackArgs,
+    undefined,
+    pickerSettings,
   );
 }
 
@@ -328,13 +537,15 @@ export function sendCommerceTemplateToMe({ template }: { template: KakaoCommerce
   );
 }
 
-export function sendCommerceTemplateToFriends({
+export function sendCommerceTemplateToFriends<T extends boolean = false>({
   template,
   receiverUuids,
+  includeFailureInfo,
 }: {
   template: KakaoCommerceTemplate;
   receiverUuids: string[];
-}): Promise<string[]> {
+  includeFailureInfo?: T;
+}): Promise<KakaoFriendMessageResult<T>> {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.sendFriend,
     TemplateTypes.commerce,
@@ -344,6 +555,7 @@ export function sendCommerceTemplateToFriends({
     false,
     {},
     {},
+    includeFailureInfo,
   );
 }
 
@@ -351,10 +563,12 @@ export function shareTextTemplate({
   template,
   useWebBrowserIfKakaoTalkNotAvailable = true,
   serverCallbackArgs = {},
+  pickerSettings,
 }: {
   template: KakaoTextTemplate;
   useWebBrowserIfKakaoTalkNotAvailable?: boolean;
   serverCallbackArgs?: Record<string, string>;
+  pickerSettings?: KakaoSharePickerSettings;
 }) {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.share,
@@ -365,6 +579,8 @@ export function shareTextTemplate({
     useWebBrowserIfKakaoTalkNotAvailable,
     {},
     serverCallbackArgs,
+    undefined,
+    pickerSettings,
   );
 }
 
@@ -381,13 +597,15 @@ export function sendTextTemplateToMe({ template }: { template: KakaoTextTemplate
   );
 }
 
-export function sendTextTemplateToFriends({
+export function sendTextTemplateToFriends<T extends boolean = false>({
   template,
   receiverUuids,
+  includeFailureInfo,
 }: {
   template: KakaoTextTemplate;
   receiverUuids: string[];
-}): Promise<string[]> {
+  includeFailureInfo?: T;
+}): Promise<KakaoFriendMessageResult<T>> {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.sendFriend,
     TemplateTypes.text,
@@ -397,6 +615,7 @@ export function sendTextTemplateToFriends({
     false,
     {},
     {},
+    includeFailureInfo,
   );
 }
 
@@ -404,10 +623,12 @@ export function shareCalendarTemplate({
   template,
   useWebBrowserIfKakaoTalkNotAvailable = true,
   serverCallbackArgs = {},
+  pickerSettings,
 }: {
   template: KakaoCalendarTemplate;
   useWebBrowserIfKakaoTalkNotAvailable?: boolean;
   serverCallbackArgs?: Record<string, string>;
+  pickerSettings?: KakaoSharePickerSettings;
 }) {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.share,
@@ -418,6 +639,8 @@ export function shareCalendarTemplate({
     useWebBrowserIfKakaoTalkNotAvailable,
     {},
     serverCallbackArgs,
+    undefined,
+    pickerSettings,
   );
 }
 
@@ -434,13 +657,15 @@ export function sendCalendarTemplateToMe({ template }: { template: KakaoCalendar
   );
 }
 
-export function sendCalendarTemplateToFriends({
+export function sendCalendarTemplateToFriends<T extends boolean = false>({
   template,
   receiverUuids,
+  includeFailureInfo,
 }: {
   template: KakaoCalendarTemplate;
   receiverUuids: string[];
-}): Promise<string[]> {
+  includeFailureInfo?: T;
+}): Promise<KakaoFriendMessageResult<T>> {
   return shareOrSendMeOrSendFriendOrWhatever(
     SendTypes.sendFriend,
     TemplateTypes.calendar,
@@ -450,10 +675,41 @@ export function sendCalendarTemplateToFriends({
     false,
     {},
     {},
+    includeFailureInfo,
   );
 }
 
+export function uploadImage({
+  imageUri,
+  secureResource = true,
+}: {
+  imageUri: string;
+  secureResource?: boolean;
+}) {
+  return Native.uploadImage(imageUri, secureResource);
+}
+
+export function scrapImage({
+  imageUrl,
+  secureResource = true,
+}: {
+  imageUrl: string;
+  secureResource?: boolean;
+}) {
+  return Native.scrapImage(imageUrl, secureResource);
+}
+
 const KakaoShare = {
+  isKakaoTalkSharingAvailable,
+  getShareTemplateDiagnostics,
+  makeDefaultTemplateUrl,
+  makeCustomTemplateUrl,
+  makeScrapTemplateUrl,
+  uploadImage,
+  shareScrapTemplate,
+  sendScrapTemplateToMe,
+  sendScrapTemplateToFriends,
+  scrapImage,
   shareCustomTemplate,
   sendCustomTemplateToMe,
   sendCustomTemplateToFriends,