signal-sdk 0.0.8 → 0.1.0

package/dist/SignalCli.d.ts

@@ -0,0 +1,205 @@
+import { Message, Contact, GroupUpdateOptions, SendMessageOptions, ContactUpdateOptions, AccountConfiguration, Device, ReceiptType, StickerPack, IdentityKey, LinkingOptions, LinkingResult, MessageRequestResponseType, SendResponse, GroupInfo, RemoveContactOptions, UserStatusResult, PaymentNotificationData, StickerPackManifest, StickerPackUploadResult, RateLimitChallengeResult, ChangeNumberSession, UploadProgress, PollCreateOptions, PollVoteOptions, PollTerminateOptions, GetAttachmentOptions, GetAvatarOptions, GetStickerOptions, UpdateAccountOptions, AccountUpdateResult, SendContactsOptions, ListGroupsOptions } from './interfaces';
+import { EventEmitter } from 'events';
+import { SignalCliConfig } from './config';
+export declare class SignalCli extends EventEmitter {
+    private signalCliPath;
+    private account?;
+    private cliProcess;
+    private requestPromises;
+    private config;
+    private logger;
+    private rateLimiter;
+    private reconnectAttempts;
+    private maxReconnectAttempts;
+    constructor(accountOrPath?: string, account?: string, config?: SignalCliConfig);
+    connect(): Promise<void>;
+    disconnect(): void;
+    gracefulShutdown(): Promise<void>;
+    private handleRpcResponse;
+    private handleStderrData;
+    private sendJsonRpcRequest;
+    private isGroupId;
+    register(number: string, voice?: boolean, captcha?: string): Promise<void>;
+    verify(number: string, token: string, pin?: string): Promise<void>;
+    sendMessage(recipient: string, message: string, options?: Omit<SendMessageOptions, 'message'>): Promise<SendResponse>;
+    sendReaction(recipient: string, targetAuthor: string, targetTimestamp: number, emoji: string, remove?: boolean): Promise<SendResponse>;
+    sendTyping(recipient: string, stop?: boolean): Promise<void>;
+    remoteDeleteMessage(recipient: string, targetTimestamp: number): Promise<void>;
+    updateContact(number: string, name: string, options?: Omit<ContactUpdateOptions, 'name'>): Promise<void>;
+    block(recipients: string[], groupId?: string): Promise<void>;
+    unblock(recipients: string[], groupId?: string): Promise<void>;
+    quitGroup(groupId: string): Promise<void>;
+    joinGroup(uri: string): Promise<void>;
+    updateProfile(name: string, about?: string, aboutEmoji?: string, avatar?: string): Promise<void>;
+    sendReceipt(recipient: string, targetTimestamp: number, type?: ReceiptType): Promise<void>;
+    listStickerPacks(): Promise<StickerPack[]>;
+    addStickerPack(packId: string, packKey: string): Promise<void>;
+    unregister(): Promise<void>;
+    deleteLocalAccountData(): Promise<void>;
+    updateAccountConfiguration(config: AccountConfiguration): Promise<void>;
+    removeDevice(deviceId: number): Promise<void>;
+    setPin(pin: string): Promise<void>;
+    removePin(): Promise<void>;
+    listIdentities(number?: string): Promise<IdentityKey[]>;
+    trustIdentity(number: string, safetyNumber: string, verified?: boolean): Promise<void>;
+    link(deviceName?: string): Promise<string>;
+    /**
+     * Link a new device to an existing Signal account with QR code support.
+     * This method provides a complete device linking solution with QR code generation.
+     *
+     * @param options - Linking options including device name and QR code output preferences
+     * @returns Promise resolving to LinkingResult with QR code data and linking status
+     */
+    deviceLink(options?: LinkingOptions): Promise<LinkingResult>;
+    /**
+     * Display ASCII QR code in console.
+     * Uses qrcode-terminal which is included as a dependency.
+     */
+    private displayQRCode;
+    addDevice(uri: string, deviceName?: string): Promise<void>;
+    sendSyncRequest(): Promise<void>;
+    sendMessageRequestResponse(recipient: string, response: MessageRequestResponseType): Promise<void>;
+    getVersion(): Promise<any>;
+    createGroup(name: string, members: string[]): Promise<GroupInfo>;
+    updateGroup(groupId: string, options: GroupUpdateOptions): Promise<void>;
+    listGroups(): Promise<GroupInfo[]>;
+    listContacts(): Promise<Contact[]>;
+    listDevices(): Promise<Device[]>;
+    listAccounts(): Promise<string[]>;
+    /**
+     * @deprecated Use `connect` and listen for `message` events instead.
+     * This method now provides a compatibility layer by connecting and buffering messages.
+     */
+    receiveMessages(): Promise<Message[]>;
+    /**
+     * @deprecated Use `connect` instead.
+     * This method now calls connect() for backward compatibility.
+     */
+    startDaemon(): void;
+    /**
+     * @deprecated Use `gracefulShutdown` or `disconnect` instead.
+     * This method now calls gracefulShutdown() for backward compatibility.
+     */
+    stopDaemon(): void;
+    /**
+     * Remove a contact from the contact list.
+     * @param number - The phone number of the contact to remove
+     * @param options - Options for how to remove the contact
+     */
+    removeContact(number: string, options?: RemoveContactOptions): Promise<void>;
+    /**
+     * Check if phone numbers are registered with Signal.
+     * @param numbers - Array of phone numbers to check
+     * @param usernames - Optional array of usernames to check
+     * @returns Array of user status results
+     */
+    getUserStatus(numbers?: string[], usernames?: string[]): Promise<UserStatusResult[]>;
+    /**
+     * Send a payment notification to a recipient.
+     * @param recipient - Phone number or group ID to send the notification to
+     * @param paymentData - Payment notification data including receipt
+     * @returns Send response with timestamp and other details
+     */
+    sendPaymentNotification(recipient: string, paymentData: PaymentNotificationData): Promise<SendResponse>;
+    /**
+     * Upload a custom sticker pack to Signal.
+     * @param manifest - Sticker pack manifest information
+     * @returns Upload result with pack ID and key
+     */
+    uploadStickerPack(manifest: StickerPackManifest): Promise<StickerPackUploadResult>;
+    /**
+     * Submit a rate limit challenge to lift rate limiting.
+     * @param challenge - Challenge token from the proof required error
+     * @param captcha - Captcha token from solved captcha
+     * @returns Challenge result indicating success/failure
+     */
+    submitRateLimitChallenge(challenge: string, captcha: string): Promise<RateLimitChallengeResult>;
+    /**
+     * Start the process of changing phone number.
+     * @param newNumber - The new phone number to change to
+     * @param voice - Whether to use voice verification instead of SMS
+     * @param captcha - Captcha token if required
+     * @returns Change number session information
+     */
+    startChangeNumber(newNumber: string, voice?: boolean, captcha?: string): Promise<ChangeNumberSession>;
+    /**
+     * Finish the phone number change process with verification code.
+     * @param verificationCode - The verification code received via SMS/voice
+     * @param pin - Registration lock PIN if enabled
+     */
+    finishChangeNumber(verificationCode: string, pin?: string): Promise<void>;
+    /**
+     * Enhanced send message with progress callback support.
+     * @param recipient - Phone number or group ID
+     * @param message - Message text
+     * @param options - Send options including progress callback
+     * @returns Send response
+     */
+    sendMessageWithProgress(recipient: string, message: string, options?: SendMessageOptions & {
+        onProgress?: (progress: UploadProgress) => void;
+    }): Promise<SendResponse>;
+    /**
+     * Send a poll create message to a recipient or group.
+     * @param options Poll creation options
+     * @returns Send response with timestamp
+     */
+    sendPollCreate(options: PollCreateOptions): Promise<SendResponse>;
+    /**
+     * Send a poll vote message to vote on a poll.
+     * @param recipient Recipient or group ID
+     * @param options Poll vote options
+     * @returns Send response with timestamp
+     */
+    sendPollVote(recipient: string, options: PollVoteOptions): Promise<SendResponse>;
+    /**
+     * Send a poll terminate message to close a poll.
+     * @param recipient Recipient or group ID
+     * @param options Poll terminate options
+     * @returns Send response with timestamp
+     */
+    sendPollTerminate(recipient: string, options: PollTerminateOptions): Promise<SendResponse>;
+    /**
+     * Update account information (device name, username, privacy settings).
+     * @param options Account update options
+     * @returns Account update result
+     */
+    updateAccount(options: UpdateAccountOptions): Promise<AccountUpdateResult>;
+    /**
+     * Get raw attachment data as base64 string.
+     * @param options Attachment retrieval options
+     * @returns Base64 encoded attachment data
+     */
+    getAttachment(options: GetAttachmentOptions): Promise<string>;
+    /**
+     * Get raw avatar data as base64 string.
+     * @param options Avatar retrieval options
+     * @returns Base64 encoded avatar data
+     */
+    getAvatar(options: GetAvatarOptions): Promise<string>;
+    /**
+     * Get raw sticker data as base64 string.
+     * @param options Sticker retrieval options
+     * @returns Base64 encoded sticker data
+     */
+    getSticker(options: GetStickerOptions): Promise<string>;
+    /**
+     * Send contacts synchronization message to linked devices.
+     * @param options Contacts sync options
+     */
+    sendContacts(options?: SendContactsOptions): Promise<void>;
+    /**
+     * List groups with optional filtering and details.
+     * @param options List groups options
+     * @returns Array of group information
+     */
+    listGroupsDetailed(options?: ListGroupsOptions): Promise<GroupInfo[]>;
+    /**
+     * List all local accounts.
+     * @returns Array of account phone numbers
+     */
+    listAccountsDetailed(): Promise<Array<{
+        number: string;
+        name?: string;
+        uuid?: string;
+    }>>;
+}