@pipedream/telegram_bot_api 0.3.3

package/actions/send-video-note/send-video-note.mjs

@@ -0,0 +1,76 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+import contentTypes from "../../content-types.mjs";
+
+export default {
+  key: "telegram_bot_api-send-video-note",
+  name: "Send a Video Note",
+  description: "As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. [See the docs](https://core.telegram.org/bots/api#sendvideonote) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    filename: {
+      propDefinition: [
+        telegramBotApi,
+        "filename",
+      ],
+    },
+    videoNote: {
+      propDefinition: [
+        telegramBotApi,
+        "media",
+      ],
+      label: "Video Note",
+    },
+    contentType: {
+      propDefinition: [
+        telegramBotApi,
+        "contentType",
+      ],
+      options: contentTypes.video,
+    },
+    length: {
+      propDefinition: [
+        telegramBotApi,
+        "length",
+      ],
+    },
+    duration: {
+      propDefinition: [
+        telegramBotApi,
+        "duration",
+      ],
+    },
+    reply_to_message_id: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_to_message_id",
+      ],
+    },
+    reply_markup: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_markup",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.sendVideoNote(this.chatId, this.videoNote, {
+      length: this.length,
+      duration: this.duration,
+      reply_to_message_id: this.reply_to_message_id,
+      reply_markup: this.reply_markup,
+      filename: this.filename,
+      contentType: this.contentType,
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully sent the video note${this.fileName ? ` "${this.filename}"` : ""} to chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/send-voice-message/send-voice-message.mjs

@@ -0,0 +1,85 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+import contentTypes from "../../content-types.mjs";
+
+export default {
+  key: "telegram_bot_api-send-voice-message",
+  name: "Send a Voice Message",
+  description: "Sends a voice message. [See the docs](https://core.telegram.org/bots/api#sendvoice) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    caption: {
+      propDefinition: [
+        telegramBotApi,
+        "caption",
+      ],
+      description: "Enter the voice message caption.",
+    },
+    filename: {
+      propDefinition: [
+        telegramBotApi,
+        "filename",
+      ],
+    },
+    voice: {
+      propDefinition: [
+        telegramBotApi,
+        "media",
+      ],
+      label: "Voice Message",
+    },
+    parse_mode: {
+      propDefinition: [
+        telegramBotApi,
+        "parse_mode",
+      ],
+    },
+    disable_notification: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_notification",
+      ],
+    },
+    contentType: {
+      propDefinition: [
+        telegramBotApi,
+        "contentType",
+      ],
+      options: contentTypes.voice,
+    },
+    duration: {
+      propDefinition: [
+        telegramBotApi,
+        "duration",
+      ],
+      description: "Enter the duration of sent voice message in seconds.",
+    },
+    reply_markup: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_markup",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.sendAudio(this.chatId, this.voice, {
+      caption: this.caption,
+      parse_mode: this.parse_mode,
+      disable_notification: this.disable_notification,
+      duration: this.duration,
+      reply_markup: this.reply_markup,
+      filename: this.filename,
+      contentType: this.contentType,
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully sent the voice message${this.fileName ? ` "${this.filename}"` : ""} to chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/unpin-message/unpin-message.mjs

@@ -0,0 +1,29 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-unpin-message",
+  name: "Unpin a Message",
+  description: "Unpins a message. [See the docs](https://core.telegram.org/bots/api#unpinchatmessage) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    messageId: {
+      propDefinition: [
+        telegramBotApi,
+        "messageId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.unpinChatMessage(this.chatId, this.messageId);
+    $.export("$summary", `Successfully unpinned the message from chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/constants.mjs

@@ -0,0 +1,198 @@
+/**
+ * @typedef {string} MediaType - a type of media as defined by
+ * the [Telegram Bot API docs](https://bit.ly/3m7rjsc)
+ */
+
+/**
+ * Represents a photo to be sent
+ *
+ * @type {MediaType}
+ */
+const TELEGRAM_BOT_API_MEDIA_PHOTO = "photo";
+
+/**
+  * Represents a video to be sent
+  *
+  * @type {MediaType}
+  */
+const TELEGRAM_BOT_API_MEDIA_VIDEO = "video";
+
+/**
+  * Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent
+  *
+  * @type {MediaType}
+  */
+const TELEGRAM_BOT_API_MEDIA_ANIMATION = "animation";
+
+/**
+  * Represents an audio file to be treated as music to be sent
+  *
+  * @type {MediaType}
+  */
+const TELEGRAM_BOT_API_MEDIA_AUDIO = "audio";
+
+/**
+  * Represents a general file to be sent
+  *
+  * @type {MediaType}
+  */
+const TELEGRAM_BOT_API_MEDIA_DOCUMENT = "document";
+
+/**
+  * All the available Telegram Bot media types
+  * @type {MediaType[]}
+  */
+const TELEGRAM_BOT_API_MEDIA_TYPES = [
+  TELEGRAM_BOT_API_MEDIA_PHOTO,
+  TELEGRAM_BOT_API_MEDIA_VIDEO,
+  TELEGRAM_BOT_API_MEDIA_ANIMATION,
+  TELEGRAM_BOT_API_MEDIA_AUDIO,
+  TELEGRAM_BOT_API_MEDIA_DOCUMENT,
+];
+
+/**
+ * @typedef {string} UIMediaType - a type of media shown to users as part of the UI
+ */
+
+/**
+   * Represents a document or image
+   *
+   * @type {UIMediaType}
+   */
+const TELEGRAM_BOT_API_UI_MEDIA_DOCUMENT = "Document/Image";
+
+/**
+ * Represents a photo
+ *
+ * @type {UIMediaType}
+ */
+const TELEGRAM_BOT_API_UI_MEDIA_PHOTO = "Photo";
+
+/**
+   * Represents an audio file to be treated as music
+   *
+   * @type {UIMediaType}
+   */
+const TELEGRAM_BOT_API_UI_MEDIA_AUDIO = "Audio";
+
+/**
+   * Represents a video
+   *
+   * @type {UIMediaType}
+   */
+const TELEGRAM_BOT_API_UI_MEDIA_VIDEO = "Video";
+
+/**
+   * Represents a video note
+   *
+   * @type {UIMediaType}
+   */
+const TELEGRAM_BOT_API_UI_MEDIA_VIDEO_NOTE = "Video Note";
+
+/**
+   * Represents a voice message
+   *
+   * @type {UIMediaType}
+   */
+const TELEGRAM_BOT_API_UI_MEDIA_VOICE = "Voice";
+
+/**
+   * Represents a sticker
+   *
+   * @type {UIMediaType}
+   */
+const TELEGRAM_BOT_API_UI_MEDIA_STICKER = "Sticker";
+
+/**
+  * All the available Telegram Bot UI media types
+  * @type {UIMediaType[]}
+  */
+const TELEGRAM_BOT_API_UI_MEDIA_TYPES = [
+  TELEGRAM_BOT_API_UI_MEDIA_DOCUMENT,
+  TELEGRAM_BOT_API_UI_MEDIA_PHOTO,
+  TELEGRAM_BOT_API_UI_MEDIA_AUDIO,
+  TELEGRAM_BOT_API_UI_MEDIA_VIDEO,
+  TELEGRAM_BOT_API_UI_MEDIA_VIDEO_NOTE,
+  TELEGRAM_BOT_API_UI_MEDIA_VOICE,
+  TELEGRAM_BOT_API_UI_MEDIA_STICKER,
+];
+
+/**
+ * @typedef {string} FormattingMode - a formatting mode used to parse entities in text, as defined
+ * by the [Telegram Bot API docs](@see{@link https://core.telegram.org/bots/api#formatting-options})
+ */
+
+/**
+ * Mode used to parse text using MarkdownV2 style
+ *
+ * @example
+ * *bold \*text*
+ * _italic \*text_
+ * __underline__
+ * ~strikethrough~
+ * *bold _italic bold ~italic bold strikethrough~ __underline italic bold___ bold*
+ * [inline URL](http://www.example.com/)
+ *
+ * @type {FormattingMode}
+ */
+const TELEGRAM_BOT_API_MARKDOWNV2_STYLE = "MarkdownV2";
+
+/**
+ * Mode used to parse text using HTML style
+ *
+ * @example
+ * <b>bold</b>, <strong>bold</strong> <i>italic</i>, <em>italic</em> <u>underline</u>,
+ * <ins>underline</ins> <s>strikethrough</s>, <strike>strikethrough</strike>,
+ * <del>strikethrough</del> <b>bold <i>italic bold <s>italic bold strikethrough</s> <u>underline
+ * italic bold</u></i> bold</b>
+ *
+ * @type {FormattingMode}
+ */
+const TELEGRAM_BOT_API_HTML_STYLE = "HTML";
+
+/**
+ * Mode used to parse text using Markdown style
+ *
+ * @example
+ * *bold text*
+ * _italic text_
+ * [inline URL](http://www.example.com/)
+ * [inline mention of a user](tg://user?id=123456789)
+ * `inline fixed-width code`
+ *
+ * @type {FormattingMode}
+ */
+const TELEGRAM_BOT_API_MARKDOWN_STYLE = "Markdown";
+
+/**
+  * All the available Telegram Bot formatting modes
+  * @type {FormattingMode[]}
+  */
+const TELEGRAM_BOT_API_FORMATTING_MODES = [
+  TELEGRAM_BOT_API_MARKDOWNV2_STYLE,
+  TELEGRAM_BOT_API_HTML_STYLE,
+  TELEGRAM_BOT_API_MARKDOWN_STYLE,
+];
+
+export {
+  // Media types
+  TELEGRAM_BOT_API_MEDIA_PHOTO,
+  TELEGRAM_BOT_API_MEDIA_VIDEO,
+  TELEGRAM_BOT_API_MEDIA_ANIMATION,
+  TELEGRAM_BOT_API_MEDIA_AUDIO,
+  TELEGRAM_BOT_API_MEDIA_DOCUMENT,
+  // Array of media types
+  TELEGRAM_BOT_API_MEDIA_TYPES,
+  // UI media types
+  TELEGRAM_BOT_API_UI_MEDIA_DOCUMENT,
+  TELEGRAM_BOT_API_UI_MEDIA_PHOTO,
+  TELEGRAM_BOT_API_UI_MEDIA_AUDIO,
+  TELEGRAM_BOT_API_UI_MEDIA_VIDEO,
+  TELEGRAM_BOT_API_UI_MEDIA_VIDEO_NOTE,
+  TELEGRAM_BOT_API_UI_MEDIA_VOICE,
+  TELEGRAM_BOT_API_UI_MEDIA_STICKER,
+  // Array of UI media types
+  TELEGRAM_BOT_API_UI_MEDIA_TYPES,
+  // Array of formatting modes
+  TELEGRAM_BOT_API_FORMATTING_MODES,
+};

package/content-types.mjs

@@ -0,0 +1,115 @@
+const image = [
+  {
+    label: "Gif Images",
+    value: "image/gif",
+  },
+  {
+    label: "JPG Images",
+    value: "image/jpeg",
+  },
+  {
+    label: "PNG Images",
+    value: "image/png",
+  },
+  {
+    label: "Bitmap Images",
+    value: "image/bmp",
+  },
+  {
+    label: "Vector Images",
+    value: "image/svg+xml",
+  },
+];
+
+const video = [
+  {
+    label: "Video - MPEG",
+    value: "video/mpeg",
+  },
+  {
+    label: "Video - MP4",
+    value: "video/mp4",
+  },
+  {
+    label: "Video - WebM",
+    value: "video/webm",
+  },
+  {
+    label: "Video - OGG",
+    value: "video/ogg",
+  },
+];
+
+const audio = [
+  {
+    label: "Audio - MPEG",
+    value: "audio/mpeg",
+  },
+  {
+    label: "Audio - Midi",
+    value: "audio/mid",
+  },
+  {
+    label: "Audio - WebM",
+    value: "audio/webm",
+  },
+  {
+    label: "Audio - OGG",
+    value: "audio/ogg",
+  },
+  {
+    label: "Audio - Wave",
+    value: "audio/vnd.wav",
+  },
+];
+
+const voice = [
+  ...audio,
+  {
+    label: "Video - MP4",
+    value: "video/mp4",
+  },
+  {
+    label: "Video - WebM",
+    value: "video/webm",
+  },
+  {
+    label: "Video - OGG",
+    value: "video/ogg",
+  },
+];
+
+const document = [
+  {
+    label: "Plain Text",
+    value: "text/plain",
+  },
+  {
+    label: "HTML Data",
+    value: "text/html",
+  },
+  {
+    label: "XML Files",
+    value: "application/xml",
+  },
+  {
+    label: "PDF Files",
+    value: "application/pdf",
+  },
+];
+
+const all = [
+  ...document,
+  ...image,
+  ...video,
+  ...audio,
+];
+
+export default {
+  image,
+  video,
+  audio,
+  voice,
+  document,
+  all,
+};

package/env.mjs

@@ -0,0 +1,14 @@
+// Environment variables are set in this file rather than `telegram_bot_api.app.mjs` because
+// Javascript imports are hoisted, so imported modules will initialize before any of the current
+// modules initialization code gets to run. We want these env vars to be set before other imported
+// modules (specifically 'node-telegram-bot-api') are initialized.
+
+// If unset, set `process.env.NTBA_FIX_319` to true to enable cancellation of
+// Promises. See: https://github.com/yagop/node-telegram-bot-api/issues/319 for
+// more information.
+process.env.NTBA_FIX_319 = process.env.NTBA_FIX_319 ?? true;
+
+// If unset, set `process.env.NTBA_FIX_350` to true to enable automatic resolution of `filename`
+// and `contentType` properties. See: https://github.com/yagop/node-telegram-bot-api/issues/350
+// for more information.
+process.env.NTBA_FIX_350 = process.env.NTBA_FIX_350 ?? true;

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@pipedream/telegram_bot_api",
+  "version": "0.3.3",
+  "description": "Pipedream Telegram_bot_api Components",
+  "main": "telegram_bot_api.app.mjs",
+  "keywords": [
+    "pipedream",
+    "telegram_bot_api"
+  ],
+  "homepage": "https://pipedream.com/apps/telegram_bot_api",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "license": "MIT",
+  "dependencies": {
+    "@pipedream/platform": "^0.9.0",
+    "node-telegram-bot-api": "^0.54.0"
+  },
+  "gitHead": "e12480b94cc03bed4808ebc6b13e7fdb3a1ba535",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/sources/channel-updates/channel-updates.mjs

@@ -0,0 +1,50 @@
+// eslint-disable-next-line camelcase
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  type: "source",
+  key: "telegram_bot_api-channel-updates",
+  name: "Channel Updates (Instant)",
+  description: "Emit new event each time a channel message is created or updated.",
+  version: "0.0.3",
+  dedupe: "unique",
+  props: {
+    db: "$.service.db",
+    // eslint-disable-next-line pipedream/props-label,pipedream/props-description
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    telegramBotApi,
+  },
+  hooks: {
+    async activate() {
+      await this.telegramBotApi.createHook(this.http.endpoint, [
+        "channel_post",
+        "edited_channel_post",
+      ]);
+    },
+    async deactivate() {
+      await this.telegramBotApi.deleteHook();
+    },
+  },
+  async run(event) {
+    if ((event.path).substring(1) !== this.telegramBotApi.$auth.token) {
+      return;
+    }
+    this.http.respond({
+      status: 200,
+    });
+    const { body } = event;
+    if (!body) {
+      return;
+    }
+    const channelPost = body.edited_channel_post ?? body.channel_post;
+    this.$emit(body,
+      {
+        id: body.update_id,
+        summary: `${channelPost.chat.title} - ${channelPost.text}`,
+        ts: Date.now(),
+      });
+  },
+};

package/sources/message-updates/message-updates.mjs

@@ -0,0 +1,50 @@
+// eslint-disable-next-line camelcase
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  type: "source",
+  key: "telegram_bot_api-message-updates",
+  name: "Message Updates (Instant)",
+  description: "Emit new event each time a Telegram message is created or updated.",
+  version: "0.0.3",
+  dedupe: "unique",
+  props: {
+    db: "$.service.db",
+    // eslint-disable-next-line pipedream/props-label,pipedream/props-description
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    telegramBotApi,
+  },
+  hooks: {
+    async activate() {
+      await this.telegramBotApi.createHook(this.http.endpoint, [
+        "message",
+        "edited_message",
+      ]);
+    },
+    async deactivate() {
+      await this.telegramBotApi.deleteHook();
+    },
+  },
+  async run(event) {
+    if ((event.path).substring(1) !== this.telegramBotApi.$auth.token) {
+      return;
+    }
+    this.http.respond({
+      status: 200,
+    });
+    const { body } = event;
+    if (!body) {
+      return;
+    }
+    const message = body.edited_message ?? body.message;
+    this.$emit(body,
+      {
+        id: body.update_id,
+        summary: message.text,
+        ts: Date.now(),
+      });
+  },
+};

package/sources/new-updates/new-updates.mjs

@@ -0,0 +1,63 @@
+// eslint-disable-next-line camelcase
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-new-updates",
+  name: "New Updates (Instant)",
+  description: "Emit new event for each new Telegram event.",
+  version: "0.0.3",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    db: "$.service.db",
+    // eslint-disable-next-line pipedream/props-label,pipedream/props-description
+    http: {
+      label: "HTTP Responder",
+      description: "Exposes a `respond()` method that lets the source issue HTTP responses",
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    telegramBotApi,
+    updateTypes: {
+      propDefinition: [
+        telegramBotApi, // eslint-disable-line camelcase
+        "updateTypes",
+      ],
+    },
+  },
+  hooks: {
+    async activate() {
+      await this.telegramBotApi.createHook(this.http.endpoint, this.updateTypes);
+    },
+    async deactivate() {
+      await this.telegramBotApi.deleteHook();
+    },
+  },
+  methods: {
+    getMeta(body) {
+      let summary;
+      if (body.message.from)
+        summary = `Update from ${body.message.from.first_name} ${body.message.from.last_name}`;
+      else
+        summary = `Update ID ${body.update_id}`;
+      return {
+        id: body.update_id,
+        summary,
+        ts: Date.now(),
+      };
+    },
+  },
+  async run(event) {
+    if ((event.path).substring(1) !== this.telegramBotApi.$auth.token) {
+      return;
+    }
+    this.http.respond({
+      status: 200,
+    });
+    const { body } = event;
+    if (!body) {
+      return;
+    }
+    this.$emit(body, this.getMeta(body));
+  },
+};