@photon-ai/advanced-imessage-kit 1.14.2 → 1.16.0

package/dist/index.d.cts

@@ -57,15 +57,66 @@ type AttachmentResponse = {
     hasLivePhoto?: boolean;
 };
 
+interface TextStyle {
+    start: number;
+    end: number;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strikethrough?: boolean;
+}
+type TextAnimation = "big" | "small" | "shake" | "nod" | "explode" | "ripple" | "bloom" | "jitter";
+type BubbleEffect = "slam" | "loud" | "gentle" | "invisibleInk" | "confetti" | "lasers" | "fireworks" | "balloons" | "hearts" | "shootingStar" | "celebration" | "echo" | "spotlight";
 interface SendMessageOptions {
     chatGuid: string;
     message: string;
     tempGuid?: string;
     subject?: string;
-    effectId?: string;
     selectedMessageGuid?: string;
     partIndex?: number;
     richLink?: boolean;
+    textStyles?: TextStyle[];
+    textAnimation?: TextAnimation;
+    bubbleEffect?: BubbleEffect;
+}
+type SendMultipartMessagePart = {
+    partIndex?: number;
+    text: string;
+    mention?: Record<string, unknown>;
+} | {
+    partIndex?: number;
+    filePath: string;
+    fileName?: string;
+};
+interface SendMultipartMessageOptions {
+    chatGuid: string;
+    parts: SendMultipartMessagePart[];
+    tempGuid?: string;
+    subject?: string;
+    effectId?: string;
+    selectedMessageGuid?: string;
+    partIndex?: number;
+    ddScan?: boolean;
+    attributedBody?: Record<string, unknown> | Record<string, unknown>[];
+}
+interface SendIMessageAppOptions {
+    chatGuid: string;
+    balloonBundleId: string;
+    appName: string;
+    url: string;
+    ldtext?: string;
+    layoutClass?: string;
+    userInfo?: {
+        caption?: string;
+        subcaption?: string;
+        "secondary-subcaption"?: string;
+        "tertiary-subcaption"?: string;
+        "image-title"?: string;
+        "image-subtitle"?: string;
+    };
+    appId?: number;
+    imageBase64?: string;
+    sessionIdentifier?: string;
 }
 interface MessageData {
     guid: string;
@@ -434,7 +485,7 @@ declare class ChatModule {
         service?: "iMessage" | "SMS";
         tempGuid?: string;
         subject?: string;
-        effectId?: string;
+        bubbleEffect?: BubbleEffect;
         attributedBody?: Record<string, unknown>;
     }): Promise<ChatResponse>;
     getChat(guid: string, options?: {
@@ -533,7 +584,9 @@ declare class MessageModule {
     private readonly http;
     private readonly enqueueSend;
     constructor(http: AxiosInstance, enqueueSend?: <T>(task: () => Promise<T>) => Promise<T>);
+    private uploadMultipartAttachment;
     sendMessage(options: SendMessageOptions): Promise<MessageResponse>;
+    sendMultipartMessage(options: SendMultipartMessageOptions): Promise<MessageResponse>;
     getMessage(guid: string, options?: {
         with?: string[];
     }): Promise<MessageResponse>;
@@ -737,4 +790,4 @@ declare function parsePollVotes(message: MessageResponse): ParsedPollVote | null
 declare function getPollSummary(message: MessageResponse): string;
 declare function getPollOneLiner(message: MessageResponse): string;
 
-export { type AddPollOptionOptions, AdvancedIMessageKit, type Attachment, type AttachmentResponse, type BackupData, CHAT_READ_STATUS_CHANGED, type Chat, type ChatResponse, type ClientConfig, type CreatePollOptions, FT_CALL_STATUS_CHANGED, type FaceTimeStatusData, type FindMyLocationItem, GROUP_ICON_CHANGED, GROUP_ICON_REMOVED, GROUP_NAME_CHANGE, HELLO_WORLD, type Handle, type HandleResponse, IMESSAGE_ALIASES_REMOVED, INCOMING_FACETIME, MESSAGE_SEND_ERROR, MESSAGE_UPDATED, type Message, type MessageData, type MessageResponse, NEW_FINDMY_LOCATION, NEW_MESSAGE, NEW_SERVER, PARTICIPANT_ADDED, PARTICIPANT_LEFT, PARTICIPANT_REMOVED, type ParsedPoll, type ParsedPollVote, type PhotonEventMap, type PhotonEventName, type PollDefinition, type PollMessageResponse, type PollOption, type PollVote, type PollVoteResponse, SCHEDULED_MESSAGE_CREATED, SCHEDULED_MESSAGE_DELETED, SCHEDULED_MESSAGE_ERROR, SCHEDULED_MESSAGE_SENT, SCHEDULED_MESSAGE_UPDATED, SDK, SERVER_UPDATE, SERVER_UPDATE_DOWNLOADING, SERVER_UPDATE_INSTALLING, SETTINGS_BACKUP_CREATED, SETTINGS_BACKUP_DELETED, SETTINGS_BACKUP_UPDATED, type ScheduledMessageData, type SendAttachmentOptions, type SendMessageOptions, type SendStickerOptions, type ServerMetadataResponse, type ServerUpdateData, THEME_BACKUP_CREATED, THEME_BACKUP_DELETED, THEME_BACKUP_UPDATED, TYPING_INDICATOR, type TypedEventEmitter, type ValidRemoveTapback, type ValidTapback, type VotePollOptions, getLogger, getOptionTextById, getPollOneLiner, getPollSummary, isPollMessage, isPollVote, parsePollDefinition, parsePollVotes, setGlobalLogLevel, setGlobalLogToFile };
+export { type AddPollOptionOptions, AdvancedIMessageKit, type Attachment, type AttachmentResponse, type BackupData, type BubbleEffect, CHAT_READ_STATUS_CHANGED, type Chat, type ChatResponse, type ClientConfig, type CreatePollOptions, FT_CALL_STATUS_CHANGED, type FaceTimeStatusData, type FindMyLocationItem, GROUP_ICON_CHANGED, GROUP_ICON_REMOVED, GROUP_NAME_CHANGE, HELLO_WORLD, type Handle, type HandleResponse, IMESSAGE_ALIASES_REMOVED, INCOMING_FACETIME, MESSAGE_SEND_ERROR, MESSAGE_UPDATED, type Message, type MessageData, type MessageResponse, NEW_FINDMY_LOCATION, NEW_MESSAGE, NEW_SERVER, PARTICIPANT_ADDED, PARTICIPANT_LEFT, PARTICIPANT_REMOVED, type ParsedPoll, type ParsedPollVote, type PhotonEventMap, type PhotonEventName, type PollDefinition, type PollMessageResponse, type PollOption, type PollVote, type PollVoteResponse, SCHEDULED_MESSAGE_CREATED, SCHEDULED_MESSAGE_DELETED, SCHEDULED_MESSAGE_ERROR, SCHEDULED_MESSAGE_SENT, SCHEDULED_MESSAGE_UPDATED, SDK, SERVER_UPDATE, SERVER_UPDATE_DOWNLOADING, SERVER_UPDATE_INSTALLING, SETTINGS_BACKUP_CREATED, SETTINGS_BACKUP_DELETED, SETTINGS_BACKUP_UPDATED, type ScheduledMessageData, type SendAttachmentOptions, type SendIMessageAppOptions, type SendMessageOptions, type SendMultipartMessageOptions, type SendMultipartMessagePart, type SendStickerOptions, type ServerMetadataResponse, type ServerUpdateData, THEME_BACKUP_CREATED, THEME_BACKUP_DELETED, THEME_BACKUP_UPDATED, TYPING_INDICATOR, type TextAnimation, type TextStyle, type TypedEventEmitter, type ValidRemoveTapback, type ValidTapback, type VotePollOptions, getLogger, getOptionTextById, getPollOneLiner, getPollSummary, isPollMessage, isPollVote, parsePollDefinition, parsePollVotes, setGlobalLogLevel, setGlobalLogToFile };

package/dist/index.d.ts

@@ -57,15 +57,66 @@ type AttachmentResponse = {
     hasLivePhoto?: boolean;
 };
 
+interface TextStyle {
+    start: number;
+    end: number;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strikethrough?: boolean;
+}
+type TextAnimation = "big" | "small" | "shake" | "nod" | "explode" | "ripple" | "bloom" | "jitter";
+type BubbleEffect = "slam" | "loud" | "gentle" | "invisibleInk" | "confetti" | "lasers" | "fireworks" | "balloons" | "hearts" | "shootingStar" | "celebration" | "echo" | "spotlight";
 interface SendMessageOptions {
     chatGuid: string;
     message: string;
     tempGuid?: string;
     subject?: string;
-    effectId?: string;
     selectedMessageGuid?: string;
     partIndex?: number;
     richLink?: boolean;
+    textStyles?: TextStyle[];
+    textAnimation?: TextAnimation;
+    bubbleEffect?: BubbleEffect;
+}
+type SendMultipartMessagePart = {
+    partIndex?: number;
+    text: string;
+    mention?: Record<string, unknown>;
+} | {
+    partIndex?: number;
+    filePath: string;
+    fileName?: string;
+};
+interface SendMultipartMessageOptions {
+    chatGuid: string;
+    parts: SendMultipartMessagePart[];
+    tempGuid?: string;
+    subject?: string;
+    effectId?: string;
+    selectedMessageGuid?: string;
+    partIndex?: number;
+    ddScan?: boolean;
+    attributedBody?: Record<string, unknown> | Record<string, unknown>[];
+}
+interface SendIMessageAppOptions {
+    chatGuid: string;
+    balloonBundleId: string;
+    appName: string;
+    url: string;
+    ldtext?: string;
+    layoutClass?: string;
+    userInfo?: {
+        caption?: string;
+        subcaption?: string;
+        "secondary-subcaption"?: string;
+        "tertiary-subcaption"?: string;
+        "image-title"?: string;
+        "image-subtitle"?: string;
+    };
+    appId?: number;
+    imageBase64?: string;
+    sessionIdentifier?: string;
 }
 interface MessageData {
     guid: string;
@@ -434,7 +485,7 @@ declare class ChatModule {
         service?: "iMessage" | "SMS";
         tempGuid?: string;
         subject?: string;
-        effectId?: string;
+        bubbleEffect?: BubbleEffect;
         attributedBody?: Record<string, unknown>;
     }): Promise<ChatResponse>;
     getChat(guid: string, options?: {
@@ -533,7 +584,9 @@ declare class MessageModule {
     private readonly http;
     private readonly enqueueSend;
     constructor(http: AxiosInstance, enqueueSend?: <T>(task: () => Promise<T>) => Promise<T>);
+    private uploadMultipartAttachment;
     sendMessage(options: SendMessageOptions): Promise<MessageResponse>;
+    sendMultipartMessage(options: SendMultipartMessageOptions): Promise<MessageResponse>;
     getMessage(guid: string, options?: {
         with?: string[];
     }): Promise<MessageResponse>;
@@ -737,4 +790,4 @@ declare function parsePollVotes(message: MessageResponse): ParsedPollVote | null
 declare function getPollSummary(message: MessageResponse): string;
 declare function getPollOneLiner(message: MessageResponse): string;
 
-export { type AddPollOptionOptions, AdvancedIMessageKit, type Attachment, type AttachmentResponse, type BackupData, CHAT_READ_STATUS_CHANGED, type Chat, type ChatResponse, type ClientConfig, type CreatePollOptions, FT_CALL_STATUS_CHANGED, type FaceTimeStatusData, type FindMyLocationItem, GROUP_ICON_CHANGED, GROUP_ICON_REMOVED, GROUP_NAME_CHANGE, HELLO_WORLD, type Handle, type HandleResponse, IMESSAGE_ALIASES_REMOVED, INCOMING_FACETIME, MESSAGE_SEND_ERROR, MESSAGE_UPDATED, type Message, type MessageData, type MessageResponse, NEW_FINDMY_LOCATION, NEW_MESSAGE, NEW_SERVER, PARTICIPANT_ADDED, PARTICIPANT_LEFT, PARTICIPANT_REMOVED, type ParsedPoll, type ParsedPollVote, type PhotonEventMap, type PhotonEventName, type PollDefinition, type PollMessageResponse, type PollOption, type PollVote, type PollVoteResponse, SCHEDULED_MESSAGE_CREATED, SCHEDULED_MESSAGE_DELETED, SCHEDULED_MESSAGE_ERROR, SCHEDULED_MESSAGE_SENT, SCHEDULED_MESSAGE_UPDATED, SDK, SERVER_UPDATE, SERVER_UPDATE_DOWNLOADING, SERVER_UPDATE_INSTALLING, SETTINGS_BACKUP_CREATED, SETTINGS_BACKUP_DELETED, SETTINGS_BACKUP_UPDATED, type ScheduledMessageData, type SendAttachmentOptions, type SendMessageOptions, type SendStickerOptions, type ServerMetadataResponse, type ServerUpdateData, THEME_BACKUP_CREATED, THEME_BACKUP_DELETED, THEME_BACKUP_UPDATED, TYPING_INDICATOR, type TypedEventEmitter, type ValidRemoveTapback, type ValidTapback, type VotePollOptions, getLogger, getOptionTextById, getPollOneLiner, getPollSummary, isPollMessage, isPollVote, parsePollDefinition, parsePollVotes, setGlobalLogLevel, setGlobalLogToFile };
+export { type AddPollOptionOptions, AdvancedIMessageKit, type Attachment, type AttachmentResponse, type BackupData, type BubbleEffect, CHAT_READ_STATUS_CHANGED, type Chat, type ChatResponse, type ClientConfig, type CreatePollOptions, FT_CALL_STATUS_CHANGED, type FaceTimeStatusData, type FindMyLocationItem, GROUP_ICON_CHANGED, GROUP_ICON_REMOVED, GROUP_NAME_CHANGE, HELLO_WORLD, type Handle, type HandleResponse, IMESSAGE_ALIASES_REMOVED, INCOMING_FACETIME, MESSAGE_SEND_ERROR, MESSAGE_UPDATED, type Message, type MessageData, type MessageResponse, NEW_FINDMY_LOCATION, NEW_MESSAGE, NEW_SERVER, PARTICIPANT_ADDED, PARTICIPANT_LEFT, PARTICIPANT_REMOVED, type ParsedPoll, type ParsedPollVote, type PhotonEventMap, type PhotonEventName, type PollDefinition, type PollMessageResponse, type PollOption, type PollVote, type PollVoteResponse, SCHEDULED_MESSAGE_CREATED, SCHEDULED_MESSAGE_DELETED, SCHEDULED_MESSAGE_ERROR, SCHEDULED_MESSAGE_SENT, SCHEDULED_MESSAGE_UPDATED, SDK, SERVER_UPDATE, SERVER_UPDATE_DOWNLOADING, SERVER_UPDATE_INSTALLING, SETTINGS_BACKUP_CREATED, SETTINGS_BACKUP_DELETED, SETTINGS_BACKUP_UPDATED, type ScheduledMessageData, type SendAttachmentOptions, type SendIMessageAppOptions, type SendMessageOptions, type SendMultipartMessageOptions, type SendMultipartMessagePart, type SendStickerOptions, type ServerMetadataResponse, type ServerUpdateData, THEME_BACKUP_CREATED, THEME_BACKUP_DELETED, THEME_BACKUP_UPDATED, TYPING_INDICATOR, type TextAnimation, type TextStyle, type TypedEventEmitter, type ValidRemoveTapback, type ValidTapback, type VotePollOptions, getLogger, getOptionTextById, getPollOneLiner, getPollSummary, isPollMessage, isPollVote, parsePollDefinition, parsePollVotes, setGlobalLogLevel, setGlobalLogToFile };

package/dist/index.js

@@ -135,14 +135,16 @@ function extractService(chatGuid) {
   return void 0;
 }
 async function createChatWithMessage(options) {
-  const { http, address, message, tempGuid, subject, effectId, service } = options;
+  const { http, address, message, tempGuid, subject, bubbleEffect, textStyles, textAnimation, service } = options;
   try {
     const response = await http.post("/api/v1/chat/new", {
       addresses: [address],
       message,
       tempGuid,
       subject,
-      effectId,
+      bubbleEffect,
+      textStyles,
+      textAnimation,
       ...service && { service }
     });
     return response.data.data?.guid;
@@ -500,6 +502,15 @@ var MessageModule = class {
     this.http = http;
     this.enqueueSend = enqueueSend;
   }
+  async uploadMultipartAttachment(part, fileName = part.fileName || path__default.basename(part.filePath)) {
+    const fileBuffer = await readFile(part.filePath);
+    const form = new FormData();
+    form.append("attachment", fileBuffer, fileName);
+    const response = await this.http.post("/api/v1/attachment/upload", form, {
+      headers: form.getHeaders()
+    });
+    return response.data.data.path;
+  }
   async sendMessage(options) {
     return this.enqueueSend(async () => {
       const tempGuid = options.tempGuid || randomUUID();
@@ -518,13 +529,70 @@ var MessageModule = class {
           message: options.message,
           tempGuid,
           subject: options.subject,
-          effectId: options.effectId,
+          bubbleEffect: options.bubbleEffect,
+          textStyles: options.textStyles,
+          textAnimation: options.textAnimation,
           service
         });
         return { guid: tempGuid, text: options.message, dateCreated: Date.now() };
       }
     });
   }
+  async sendMultipartMessage(options) {
+    return this.enqueueSend(async () => {
+      const tempGuid = options.tempGuid || randomUUID();
+      const buildPayloadPart = async (part, index) => {
+        const resolvedPartIndex = part.partIndex ?? index;
+        if ("text" in part) {
+          return {
+            partIndex: resolvedPartIndex,
+            text: part.text,
+            ...part.mention ? { mention: part.mention } : {}
+          };
+        }
+        const fileName = part.fileName || path__default.basename(part.filePath);
+        const uploadedPath = await this.uploadMultipartAttachment(part, fileName);
+        return {
+          partIndex: resolvedPartIndex,
+          attachment: uploadedPath,
+          name: fileName
+        };
+      };
+      const uploadParts = async () => {
+        const parts = [];
+        for (const [index, part] of options.parts.entries()) {
+          parts.push(await buildPayloadPart(part, index));
+        }
+        return parts;
+      };
+      const send = async (chatGuid) => {
+        const parts = await uploadParts();
+        const payload = {
+          chatGuid,
+          tempGuid,
+          parts,
+          subject: options.subject,
+          effectId: options.effectId,
+          selectedMessageGuid: options.selectedMessageGuid,
+          partIndex: options.partIndex ?? 0,
+          ddScan: options.ddScan ?? false,
+          attributedBody: options.attributedBody
+        };
+        const response = await this.http.post("/api/v1/message/multipart", payload);
+        return response.data.data;
+      };
+      try {
+        return await send(options.chatGuid);
+      } catch (error) {
+        if (isChatNotExistError(error)) {
+          throw new Error(
+            "Chat does not exist for multipart send. Use an existing chatGuid, or create the chat first before calling sendMultipartMessage()."
+          );
+        }
+        throw error;
+      }
+    });
+  }
   async getMessage(guid, options) {
     const response = await this.http.get(`/api/v1/message/${encodeURIComponent(guid)}`, {
       params: options?.with ? { with: options.with.join(",") } : {}
@@ -890,6 +958,7 @@ var _AdvancedIMessageKit = class _AdvancedIMessageKit extends EventEmitter {
       "new-server",
       "incoming-facetime",
       "ft-call-status-changed",
+      "new-findmy-location",
       "hello-world"
     ];
     for (const eventName of serverEvents) {