@riseonly/sdk 0.1.1 → 0.1.3

package/dist/index.d.ts

@@ -2,7 +2,7 @@ declare const DEFAULT_API_BASE = "https://api.riseonly.net";
 declare const CANONICAL_API_PREFIX = "/api/bot/v1";
 declare const WEBHOOK_SECRET_HEADER = "x-riseonly-bot-api-secret-token";
 declare const IDEMPOTENCY_HEADER = "x-request-id";
-declare const SUPPORTED_METHODS: readonly ["getMe", "sendMessage", "sendPhoto", "sendVideo", "sendDocument", "sendAudio", "sendVoice", "sendAnimation", "editMessageText", "deleteMessage", "sendChatAction", "getUpdates", "setWebhook", "deleteWebhook", "getWebhookInfo", "setMyCommands", "getMyCommands", "deleteMyCommands", "answerCallbackQuery", "getChat"];
+declare const SUPPORTED_METHODS: readonly ["getMe", "sendMessage", "sendPhoto", "sendVideo", "sendDocument", "sendAudio", "sendVoice", "sendAnimation", "editMessageText", "deleteMessage", "sendChatAction", "getUpdates", "setWebhook", "deleteWebhook", "getWebhookInfo", "setMyCommands", "getMyCommands", "deleteMyCommands", "setMyName", "getMyName", "setMyDescription", "getMyDescription", "setMyProfilePhoto", "removeMyProfilePhoto", "answerCallbackQuery", "getChat"];
 type BotApiMethod = (typeof SUPPORTED_METHODS)[number];
 declare const UPDATE_TYPES: readonly ["message", "edited_message", "callback_query", "chat_member", "my_chat_member"];
 type UpdateType = (typeof UPDATE_TYPES)[number];
@@ -45,6 +45,7 @@ interface ClientOptions {
 interface RequestOptions {
     requestId?: string;
     signal?: AbortSignal;
+    timeoutMs?: number;
 }
 interface User {
     id: string;
@@ -58,7 +59,7 @@ interface User {
     is_premium?: boolean;
     is_official?: boolean;
     is_online?: boolean;
-    last_seen?: string;
+    last_seen?: number;
     bot_owner_id?: string;
     can_join_groups?: boolean;
     supports_inline_queries?: boolean;
@@ -66,12 +67,15 @@ interface User {
 }
 interface Chat {
     id: string;
-    type: 'private' | 'group' | 'channel' | string;
+    type?: 'private' | 'group' | 'channel' | string;
     title?: string;
     username?: string;
     description?: string;
+    photo?: string;
     avatar_url?: string;
     member_count?: number;
+    is_public?: boolean;
+    is_verified?: boolean;
 }
 interface MediaVariant {
     variant_type?: string;
@@ -233,94 +237,104 @@ interface SetWebhookResult {
     url: string;
     enabled: boolean;
 }
-interface SendMessageOptions {
+interface BotName {
+    name: string;
+}
+interface BotDescription {
+    description: string;
+}
+interface SetMyNameOptions extends RequestOptions {
+    name: string;
+}
+interface SetMyDescriptionOptions extends RequestOptions {
+    description: string;
+}
+type ProfilePhotoInput = string | {
+    url: string;
+};
+interface SetMyProfilePhotoOptions extends RequestOptions {
+    photo: ProfilePhotoInput;
+}
+interface SendMessageOptions extends RequestOptions {
     chat_id: string;
-    text?: string;
-    caption?: string;
+    text: string;
     parse_mode?: string;
     disable_notification?: boolean;
     reply_to_message_id?: string;
     reply_markup?: ReplyMarkup;
-    requestId?: string;
 }
-interface SendMediaOptions {
+interface SendMediaOptions extends RequestOptions {
     chat_id: string;
     caption?: string;
     disable_notification?: boolean;
     reply_to_message_id?: string;
     reply_markup?: ReplyMarkup;
-    requestId?: string;
 }
-interface EditMessageTextOptions {
+interface EditMessageTextOptions extends RequestOptions {
     chat_id?: string;
     message_id?: string;
     inline_message_id?: string;
     text: string;
     parse_mode?: string;
     reply_markup?: ReplyMarkup;
-    requestId?: string;
 }
-interface DeleteMessageOptions {
+interface DeleteMessageOptions extends RequestOptions {
     chat_id: string;
     message_id: string;
-    requestId?: string;
 }
-interface SendChatActionOptions {
+interface SendChatActionOptions extends RequestOptions {
     chat_id: string;
     action: ChatAction;
-    requestId?: string;
 }
-interface GetUpdatesOptions {
+interface GetUpdatesOptions extends RequestOptions {
     offset?: number;
     limit?: number;
     timeout?: number;
     allowed_updates?: UpdateType[];
-    requestId?: string;
-    signal?: AbortSignal;
 }
-interface SetWebhookOptions {
+interface SetWebhookOptions extends RequestOptions {
     url: string;
     secret_token?: string;
     max_connections?: number;
     allowed_updates?: UpdateType[];
     drop_pending_updates?: boolean;
-    requestId?: string;
 }
-interface DeleteWebhookOptions {
+interface DeleteWebhookOptions extends RequestOptions {
     drop_pending_updates?: boolean;
-    requestId?: string;
 }
-interface SetMyCommandsOptions {
+interface SetMyCommandsOptions extends RequestOptions {
     commands: BotCommand[];
     scope?: CommandScope;
     language_code?: string;
-    requestId?: string;
 }
-interface GetMyCommandsOptions {
+interface GetMyCommandsOptions extends RequestOptions {
     scope?: CommandScope;
     language_code?: string;
-    requestId?: string;
 }
-interface DeleteMyCommandsOptions {
+interface DeleteMyCommandsOptions extends RequestOptions {
     scope?: CommandScope;
     language_code?: string;
-    requestId?: string;
 }
-interface AnswerCallbackQueryOptions {
+interface AnswerCallbackQueryOptions extends RequestOptions {
     callback_query_id: string;
     text?: string;
     show_alert?: boolean;
     url?: string;
-    requestId?: string;
 }
-interface GetChatOptions {
+interface GetChatOptions extends RequestOptions {
     chat_id: string;
-    requestId?: string;
 }
-type MediaInput = string | {
+interface MediaReference {
     file_id?: string;
     url?: string;
-};
+    file_name?: string;
+    mime_type?: string;
+    thumbnail_url?: string;
+    duration?: number;
+    width?: number;
+    height?: number;
+}
+type MediaInput = string | MediaReference;
 interface PollingOptions {
     interval?: number;
     timeout?: number;
@@ -333,15 +347,26 @@ interface WebhookServerOptions {
     host?: string;
     port?: number;
     secretToken?: string;
+    maxBodyBytes?: number;
 }
 interface BotOptions extends ClientOptions {
     polling?: boolean | PollingOptions;
     webhook?: false | WebhookServerOptions;
     allowed_updates?: UpdateType[];
 }
+interface BotSetupOptions {
+    name?: string;
+    description?: string;
+    profilePhoto?: ProfilePhotoInput;
+    commands?: BotCommand[];
+    commandScope?: CommandScope;
+    languageCode?: string;
+    webhook?: SetWebhookOptions | false;
+}
 type MessageHandler = (message: Message, update: Update) => void | Promise<void>;
 type EditedMessageHandler = (message: Message, update: Update) => void | Promise<void>;
 type CallbackQueryHandler = (query: CallbackQuery, update: Update) => void | Promise<void>;
+type TextHandler = (message: Message, match: RegExpExecArray | null, update: Update) => void | Promise<void>;
 type UpdateHandler = (update: Update) => void | Promise<void>;
 type ErrorHandler = (error: unknown) => void | Promise<void>;
 type PollingErrorHandler = (error: unknown) => void | Promise<void>;
@@ -395,11 +420,18 @@ declare class ApiClient {
     setMyCommands(options: SetMyCommandsOptions): Promise<boolean>;
     getMyCommands(options?: GetMyCommandsOptions): Promise<BotCommand[]>;
     deleteMyCommands(options?: DeleteMyCommandsOptions): Promise<boolean>;
+    setMyName(options: SetMyNameOptions): Promise<boolean>;
+    getMyName(options?: RequestOptions): Promise<BotName>;
+    setMyDescription(options: SetMyDescriptionOptions): Promise<boolean>;
+    getMyDescription(options?: RequestOptions): Promise<BotDescription>;
+    setMyProfilePhoto(options: SetMyProfilePhotoOptions): Promise<boolean>;
+    removeMyProfilePhoto(options?: RequestOptions): Promise<boolean>;
     answerCallbackQuery(options: AnswerCallbackQueryOptions): Promise<boolean>;
     getChat(options: GetChatOptions): Promise<Chat>;
     private sendMedia;
     private normalizeMedia;
     private buildMethodUrl;
+    private fetchJson;
 }
 
 declare class RiseonlyBot extends ApiClient {
@@ -408,6 +440,7 @@ declare class RiseonlyBot extends ApiClient {
     private webhookOptions?;
     private polling;
     private pollingAbort?;
+    private pollingTask?;
     private offset;
     private webhookServer?;
     constructor(token: string, options?: BotOptions);
@@ -423,6 +456,11 @@ declare class RiseonlyBot extends ApiClient {
      * Registers a one-time event listener.
      */
     once<T extends BotEvent>(event: T, handler: BotEventMap[T]): this;
+    command(commands: string | string[], handler: BotEventMap['message']): this;
+    hears(trigger: string | RegExp, handler: TextHandler): this;
+    action(trigger: string | RegExp, handler: BotEventMap['callback_query']): this;
+    catch(handler: BotEventMap['error']): this;
+    setup(options: BotSetupOptions): Promise<void>;
     /**
      * Starts long polling for bot updates.
      */
@@ -431,6 +469,8 @@ declare class RiseonlyBot extends ApiClient {
      * Stops long polling.
      */
     stopPolling(): Promise<void>;
+    launch(options?: PollingOptions): Promise<void>;
+    stop(): Promise<void>;
     /**
      * Starts a built-in HTTP server that receives webhook updates.
      */
@@ -453,6 +493,7 @@ declare class RiseonlyBot extends ApiClient {
     answer(query: CallbackQuery, text?: string, showAlert?: boolean): Promise<boolean>;
     private pollLoop;
     private emit;
+    private emitError;
 }
 
 declare class RiseonlyError extends Error {
@@ -475,6 +516,14 @@ declare class RiseonlyNetworkError extends RiseonlyError {
 declare class RiseonlyTimeoutError extends RiseonlyNetworkError {
     constructor(message?: string);
 }
+declare class RiseonlyAbortError extends RiseonlyNetworkError {
+    constructor(message?: string, cause?: unknown);
+}
+declare class RiseonlyResponseError extends RiseonlyNetworkError {
+    readonly status: number;
+    readonly body?: string;
+    constructor(message: string, status: number, body?: string);
+}
 
 interface WebhookRequest {
     headers: Record<string, string | string[] | undefined>;
@@ -532,4 +581,4 @@ declare function extractInitDataFromLaunchUrl(launchUrl: string): string | null;
  */
 declare function createRequestId(): string;
 
-export { type AnswerCallbackQueryOptions, ApiClient, type ApiEnvelope, type ApiErrorResponse, type ApiResponse, type BotCommand, type BotEvent, type BotEventMap, type BotOptions, CANONICAL_API_PREFIX, CHAT_ACTIONS, COMMAND_SCOPES, type CallbackQuery, type CallbackQueryHandler, type Capabilities, type Chat, type ClientOptions, DEFAULT_API_BASE, type DeleteMessageOptions, type DeleteMyCommandsOptions, type DeleteWebhookOptions, type EditMessageTextOptions, type EditedMessageHandler, type ErrorHandler, type ForceReply, type ForwardOrigin, type GetChatOptions, type GetMyCommandsOptions, type GetUpdatesOptions, IDEMPOTENCY_HEADER, type InlineKeyboardButton, type InlineKeyboardMarkup, type MediaFile, type MediaInput, type MediaVariant, type Message, type MessageEntity, type MessageHandler, type PollingErrorHandler, type PollingOptions, type ReactionCount, type ReplyKeyboardButton, type ReplyKeyboardMarkup, type ReplyKeyboardRemove, type ReplyMarkup, type RequestOptions, RiseonlyBot, RiseonlyError, RiseonlyNetworkError, RiseonlyTimeoutError, SUPPORTED_METHODS, type SendChatActionOptions, type SendMediaOptions, type SendMessageOptions, type SetMyCommandsOptions, type SetWebhookOptions, type SetWebhookResult, UPDATE_TYPES, type Update, type UpdateHandler, type User, WEBHOOK_SECRET_HEADER, type WebAppData, type WebAppInfo, type WebhookInfo, type WebhookServerOptions, buildInitDataCheckString, createRequestId, createWebhookHandler, deriveInitDataSecret, extractInitDataFromLaunchUrl, parseInitData, parseWebhookUpdate, signInitData, verifyInitData, verifyWebhookSecret };
+export { type AnswerCallbackQueryOptions, ApiClient, type ApiEnvelope, type ApiErrorResponse, type ApiResponse, type BotCommand, type BotDescription, type BotEvent, type BotEventMap, type BotName, type BotOptions, type BotSetupOptions, CANONICAL_API_PREFIX, CHAT_ACTIONS, COMMAND_SCOPES, type CallbackQuery, type CallbackQueryHandler, type Capabilities, type Chat, type ClientOptions, DEFAULT_API_BASE, type DeleteMessageOptions, type DeleteMyCommandsOptions, type DeleteWebhookOptions, type EditMessageTextOptions, type EditedMessageHandler, type ErrorHandler, type ForceReply, type ForwardOrigin, type GetChatOptions, type GetMyCommandsOptions, type GetUpdatesOptions, IDEMPOTENCY_HEADER, type InlineKeyboardButton, type InlineKeyboardMarkup, type MediaFile, type MediaInput, type MediaReference, type MediaVariant, type Message, type MessageEntity, type MessageHandler, type PollingErrorHandler, type PollingOptions, type ProfilePhotoInput, type ReactionCount, type ReplyKeyboardButton, type ReplyKeyboardMarkup, type ReplyKeyboardRemove, type ReplyMarkup, type RequestOptions, RiseonlyAbortError, RiseonlyBot, RiseonlyError, RiseonlyNetworkError, RiseonlyResponseError, RiseonlyTimeoutError, SUPPORTED_METHODS, type SendChatActionOptions, type SendMediaOptions, type SendMessageOptions, type SetMyCommandsOptions, type SetMyDescriptionOptions, type SetMyNameOptions, type SetMyProfilePhotoOptions, type SetWebhookOptions, type SetWebhookResult, type TextHandler, UPDATE_TYPES, type Update, type UpdateHandler, type User, WEBHOOK_SECRET_HEADER, type WebAppData, type WebAppInfo, type WebhookInfo, type WebhookServerOptions, buildInitDataCheckString, createRequestId, createWebhookHandler, deriveInitDataSecret, extractInitDataFromLaunchUrl, parseInitData, parseWebhookUpdate, signInitData, verifyInitData, verifyWebhookSecret };