@ebowwa/channel-telegram 1.17.1 → 1.17.2

package/src/types.ts

@@ -286,3 +286,108 @@ export interface ConversationMessage {
   role: 'user' | 'assistant';
   content: string;
 }
+
+// ============================================================
+// Location Types (Live Location Support)
+// ============================================================
+
+/**
+ * Extended location interface that includes all Telegram Bot API properties.
+ * The @types/node-telegram-bot-api only includes latitude/longitude.
+ * @see https://core.telegram.org/bots/api#location
+ */
+export interface TelegramLocation {
+  /** Longitude as defined by sender */
+  longitude: number;
+  /** Latitude as defined by sender */
+  latitude: number;
+  /** Optional. The radius of uncertainty for the location, measured in meters; 0-1500 */
+  horizontal_accuracy?: number;
+  /** Optional. Time relative to the message sending date, during which the location can be updated, in seconds */
+  live_period?: number;
+  /** Optional. The direction in which the user is moving, in degrees; 1-360 */
+  heading?: number;
+  /** Optional. The maximum distance for proximity alerts about approaching another chat member, in meters */
+  proximity_alert_radius?: number;
+}
+
+/**
+ * Represents a venue (location + name/address).
+ * @see https://core.telegram.org/bots/api#venue
+ */
+export interface TelegramVenue {
+  /** The location of the venue */
+  location: TelegramLocation;
+  /** Name of the venue */
+  title: string;
+  /** Address of the venue */
+  address: string;
+  /** Optional. Foursquare identifier of the venue */
+  foursquare_id?: string;
+  /** Optional. Foursquare type of the venue */
+  foursquare_type?: string;
+  /** Optional. Google Places identifier of the venue */
+  google_place_id?: string;
+  /** Optional. Google Places type of the venue */
+  google_place_type?: string;
+}
+
+/**
+ * Live location state for tracking active live locations.
+ */
+export interface LiveLocationState {
+  /** Chat ID where the live location was shared */
+  chatId: number;
+  /** Message ID of the location message */
+  messageId: number;
+  /** User ID who shared the location */
+  userId: number;
+  /** Current location data */
+  location: TelegramLocation;
+  /** When the live location was first received */
+  startedAt: Date;
+  /** When the live location expires (calculated from live_period) */
+  expiresAt?: Date;
+  /** Number of updates received */
+  updateCount: number;
+}
+
+/**
+ * Options for sending a location.
+ */
+export interface SendLocationOptions {
+  /** Unique identifier for the target message thread (topic) of the forum */
+  message_thread_id?: number;
+  /** Period in seconds for which the location will be updated (see Live Locations) */
+  live_period?: number;
+  /** Latitude of the location */
+  latitude: number;
+  /** Longitude of the location */
+  longitude: number;
+  /** The radius of uncertainty for the location, measured in meters; 0-1500 */
+  horizontal_accuracy?: number;
+  /** Direction in which the location moves, in degrees; 1-360 */
+  heading?: number;
+  /** Maximum distance for proximity alerts, in meters; 1-100000 */
+  proximity_alert_radius?: number;
+  /** Sends the message silently */
+  disable_notification?: boolean;
+  /** Protects the contents of the sent message from forwarding and saving */
+  protect_content?: boolean;
+}
+
+/**
+ * Options for editing a live location.
+ */
+export interface EditLiveLocationOptions {
+  /** Latitude of new location */
+  latitude: number;
+  /** Longitude of new location */
+  longitude: number;
+  /** The radius of uncertainty for the location, measured in meters; 0-1500 */
+  horizontal_accuracy?: number;
+  /** Direction in which the location moves, in degrees; 1-360 */
+  heading?: number;
+  /** Maximum distance for proximity alerts, in meters; 1-100000 */
+  proximity_alert_radius?: number;
+}