@amirhosseinnouri/send 1.0.0-2

package/dist/index.cjs

@@ -0,0 +1,356 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  PROVIDERS: () => PROVIDERS,
+  createSender: () => createSender,
+  elementConfigSchema: () => elementConfigSchema,
+  mattermostConfigSchema: () => mattermostConfigSchema,
+  messageSchema: () => messageSchema,
+  providerConfigSchemas: () => providerConfigSchemas,
+  send: () => send,
+  sendInputSchema: () => sendInputSchema,
+  senderConfigSchema: () => senderConfigSchema,
+  slackConfigSchema: () => slackConfigSchema,
+  teamsConfigSchema: () => teamsConfigSchema,
+  telegramConfigSchema: () => telegramConfigSchema
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/providers/element.ts
+var import_marked = require("marked");
+var ElementSender = class {
+  name = "Element";
+  homeserverUrl;
+  accessToken;
+  roomId;
+  constructor(config) {
+    this.homeserverUrl = config.homeserverUrl;
+    this.accessToken = config.accessToken;
+    this.roomId = config.roomId;
+  }
+  async send(message) {
+    const lines = [];
+    if (message.title) {
+      lines.push(message.markdown ? `**${message.title}**` : message.title, "");
+    }
+    lines.push(message.body);
+    const body = lines.join("\n");
+    const formatted = message.markdown ? {
+      format: "org.matrix.custom.html",
+      formatted_body: await import_marked.marked.parse(body, { async: true })
+    } : {};
+    const txnId = `send-${Date.now()}`;
+    const encodedRoomId = encodeURIComponent(this.roomId);
+    const url = `${this.homeserverUrl}/_matrix/client/v3/rooms/${encodedRoomId}/send/m.room.message/${txnId}`;
+    let response;
+    try {
+      response = await fetch(url, {
+        method: "PUT",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${this.accessToken}`
+        },
+        body: JSON.stringify({
+          msgtype: "m.text",
+          body,
+          ...formatted
+        })
+      });
+    } catch (error) {
+      const cause = error instanceof Error ? error.cause ?? error.message : error;
+      throw new Error(`Element fetch failed: ${JSON.stringify(cause)}`);
+    }
+    if (!response.ok) {
+      const responseBody = await response.text();
+      throw new Error(
+        `Element API returned status ${response.status}: ${responseBody}`
+      );
+    }
+  }
+};
+
+// src/providers/mattermost.ts
+var MattermostSender = class {
+  name = "Mattermost";
+  webhookUrl;
+  constructor(config) {
+    this.webhookUrl = config.webhookUrl;
+  }
+  /** Mattermost always renders markdown; escape special chars for plain bodies. */
+  escapeMarkdown(text) {
+    return text.replace(/([\\`*_{}[\]()#+\-.!|>~])/g, "\\$1");
+  }
+  async send(message) {
+    const summary = message.title ?? message.body;
+    const body = message.markdown ? message.body : this.escapeMarkdown(message.body);
+    const payload = {
+      text: message.title ? `#### ${message.title}` : "",
+      attachments: [
+        {
+          fallback: summary,
+          color: "#2eb886",
+          text: body
+        }
+      ]
+    };
+    const response = await fetch(this.webhookUrl, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(payload)
+    });
+    if (!response.ok) {
+      const body2 = await response.text();
+      throw new Error(
+        `Mattermost webhook returned status ${response.status}: ${body2}`
+      );
+    }
+  }
+};
+
+// src/providers/slack.ts
+var SlackSender = class {
+  name = "Slack";
+  webhookUrl;
+  constructor(config) {
+    this.webhookUrl = config.webhookUrl;
+  }
+  async send(message) {
+    const summary = message.title ?? message.body;
+    const blocks = [];
+    if (message.title) {
+      blocks.push({
+        type: "header",
+        text: { type: "plain_text", text: message.title }
+      });
+    }
+    blocks.push({ type: "divider" });
+    blocks.push({
+      type: "section",
+      text: {
+        type: message.markdown ? "mrkdwn" : "plain_text",
+        text: message.body
+      }
+    });
+    const payload = { text: summary, blocks };
+    const response = await fetch(this.webhookUrl, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(payload)
+    });
+    if (!response.ok) {
+      const body = await response.text();
+      throw new Error(
+        `Slack webhook returned status ${response.status}: ${body}`
+      );
+    }
+  }
+};
+
+// src/providers/teams.ts
+var TeamsSender = class {
+  name = "Microsoft Teams";
+  webhookUrl;
+  constructor(config) {
+    this.webhookUrl = config.webhookUrl;
+  }
+  async send(message) {
+    const summary = message.title ?? message.body;
+    const messageCard = {
+      "@type": "MessageCard",
+      "@context": "https://schema.org/extensions",
+      themeColor: "0078D7",
+      summary,
+      sections: [
+        {
+          activityTitle: message.title,
+          text: message.body,
+          markdown: message.markdown ?? false
+        }
+      ]
+    };
+    const response = await fetch(this.webhookUrl, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(messageCard)
+    });
+    if (!response.ok) {
+      throw new Error(
+        `Teams webhook returned status ${response.status}: ${response.statusText}`
+      );
+    }
+  }
+};
+
+// src/providers/telegram.ts
+var TelegramSender = class {
+  name = "Telegram";
+  botToken;
+  chatId;
+  constructor(config) {
+    this.botToken = config.botToken;
+    this.chatId = config.chatId;
+  }
+  escapeMarkdown(text) {
+    return text.replace(/([*_`[])/g, "\\$1");
+  }
+  async send(message) {
+    const lines = [];
+    if (message.markdown) {
+      if (message.title) {
+        lines.push(`*${this.escapeMarkdown(message.title)}*`, "");
+      }
+      lines.push(message.body);
+    } else {
+      if (message.title) lines.push(message.title, "");
+      lines.push(message.body);
+    }
+    const text = lines.join("\n");
+    const url = `https://api.telegram.org/bot${this.botToken}/sendMessage`;
+    const response = await fetch(url, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({
+        chat_id: this.chatId,
+        text,
+        ...message.markdown ? { parse_mode: "Markdown" } : {}
+      })
+    });
+    if (!response.ok) {
+      const body = await response.text();
+      throw new Error(
+        `Telegram API returned status ${response.status}: ${body}`
+      );
+    }
+  }
+};
+
+// src/providers/index.ts
+var PROVIDERS = [
+  "slack",
+  "teams",
+  "mattermost",
+  "telegram",
+  "element"
+];
+function createSender(config) {
+  switch (config.provider) {
+    case "slack":
+      return new SlackSender(config);
+    case "teams":
+      return new TeamsSender(config);
+    case "mattermost":
+      return new MattermostSender(config);
+    case "telegram":
+      return new TelegramSender(config);
+    case "element":
+      return new ElementSender(config);
+  }
+}
+
+// src/schema/element.ts
+var import_zod = require("zod");
+var elementConfigSchema = import_zod.z.object({
+  provider: import_zod.z.literal("element"),
+  homeserverUrl: import_zod.z.url(),
+  accessToken: import_zod.z.string(),
+  roomId: import_zod.z.string()
+});
+
+// src/schema/mattermost.ts
+var import_zod2 = require("zod");
+var mattermostConfigSchema = import_zod2.z.object({
+  provider: import_zod2.z.literal("mattermost"),
+  webhookUrl: import_zod2.z.url()
+});
+
+// src/schema/sender.ts
+var import_zod6 = require("zod");
+
+// src/schema/slack.ts
+var import_zod3 = require("zod");
+var slackConfigSchema = import_zod3.z.object({
+  provider: import_zod3.z.literal("slack"),
+  webhookUrl: import_zod3.z.url()
+});
+
+// src/schema/teams.ts
+var import_zod4 = require("zod");
+var teamsConfigSchema = import_zod4.z.object({
+  provider: import_zod4.z.literal("teams"),
+  webhookUrl: import_zod4.z.url()
+});
+
+// src/schema/telegram.ts
+var import_zod5 = require("zod");
+var telegramConfigSchema = import_zod5.z.object({
+  provider: import_zod5.z.literal("telegram"),
+  botToken: import_zod5.z.string(),
+  chatId: import_zod5.z.string()
+});
+
+// src/schema/sender.ts
+var messageSchema = import_zod6.z.object({
+  title: import_zod6.z.string().optional(),
+  body: import_zod6.z.string(),
+  /** Render the body as markdown in the provider's native format. */
+  markdown: import_zod6.z.boolean().optional()
+});
+var senderConfigSchema = import_zod6.z.discriminatedUnion("provider", [
+  slackConfigSchema,
+  teamsConfigSchema,
+  mattermostConfigSchema,
+  telegramConfigSchema,
+  elementConfigSchema
+]);
+var sendInputSchema = import_zod6.z.intersection(
+  senderConfigSchema,
+  messageSchema
+);
+var providerConfigSchemas = {
+  slack: slackConfigSchema,
+  teams: teamsConfigSchema,
+  mattermost: mattermostConfigSchema,
+  telegram: telegramConfigSchema,
+  element: elementConfigSchema
+};
+
+// src/index.ts
+async function send(input) {
+  const { title, body, markdown, ...config } = input;
+  const message = { title, body, markdown };
+  await createSender(config).send(message);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PROVIDERS,
+  createSender,
+  elementConfigSchema,
+  mattermostConfigSchema,
+  messageSchema,
+  providerConfigSchemas,
+  send,
+  sendInputSchema,
+  senderConfigSchema,
+  slackConfigSchema,
+  teamsConfigSchema,
+  telegramConfigSchema
+});

package/dist/index.d.cts

@@ -0,0 +1,149 @@
+import { z } from 'zod';
+
+declare const messageSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    body: z.ZodString;
+    markdown: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+declare const senderConfigSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    provider: z.ZodLiteral<"slack">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"teams">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"mattermost">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"telegram">;
+    botToken: z.ZodString;
+    chatId: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"element">;
+    homeserverUrl: z.ZodURL;
+    accessToken: z.ZodString;
+    roomId: z.ZodString;
+}, z.core.$strip>], "provider">;
+/** Schema for the flat one-shot `send()` input (config merged with message). */
+declare const sendInputSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    provider: z.ZodLiteral<"slack">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"teams">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"mattermost">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"telegram">;
+    botToken: z.ZodString;
+    chatId: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"element">;
+    homeserverUrl: z.ZodURL;
+    accessToken: z.ZodString;
+    roomId: z.ZodString;
+}, z.core.$strip>], "provider">, z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    body: z.ZodString;
+    markdown: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>>;
+/** Per-provider config schemas, keyed by provider, for consumers to reuse. */
+declare const providerConfigSchemas: {
+    readonly slack: z.ZodObject<{
+        provider: z.ZodLiteral<"slack">;
+        webhookUrl: z.ZodURL;
+    }, z.core.$strip>;
+    readonly teams: z.ZodObject<{
+        provider: z.ZodLiteral<"teams">;
+        webhookUrl: z.ZodURL;
+    }, z.core.$strip>;
+    readonly mattermost: z.ZodObject<{
+        provider: z.ZodLiteral<"mattermost">;
+        webhookUrl: z.ZodURL;
+    }, z.core.$strip>;
+    readonly telegram: z.ZodObject<{
+        provider: z.ZodLiteral<"telegram">;
+        botToken: z.ZodString;
+        chatId: z.ZodString;
+    }, z.core.$strip>;
+    readonly element: z.ZodObject<{
+        provider: z.ZodLiteral<"element">;
+        homeserverUrl: z.ZodURL;
+        accessToken: z.ZodString;
+        roomId: z.ZodString;
+    }, z.core.$strip>;
+};
+
+/**
+ * A provider-agnostic structured message. Each provider renders the body into
+ * its own native format (Slack blocks, Teams card, Telegram markdown, ...),
+ * optionally as markdown when {@link Message.markdown} is set.
+ */
+type Message = z.infer<typeof messageSchema>;
+/** Discriminated union of every supported provider configuration. */
+type SenderConfig = z.infer<typeof senderConfigSchema>;
+/** Every supported provider key, derived from the config schema discriminant. */
+type ChatProvider = SenderConfig["provider"];
+/** A configured, reusable sender bound to a single provider. */
+interface Sender {
+    /** Human-readable provider name, e.g. "Slack". */
+    name: string;
+    send(message: Message): Promise<void>;
+}
+/** Flat one-shot input: provider config merged with the message. */
+type SendInput = SenderConfig & Message;
+
+/** Every supported provider key. */
+declare const PROVIDERS: readonly ["slack", "teams", "mattermost", "telegram", "element"];
+/** Build a reusable {@link Sender} bound to a single provider configuration. */
+declare function createSender(config: SenderConfig): Sender;
+
+declare const elementConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"element">;
+    homeserverUrl: z.ZodURL;
+    accessToken: z.ZodString;
+    roomId: z.ZodString;
+}, z.core.$strip>;
+
+type ElementConfig = z.infer<typeof elementConfigSchema>;
+
+declare const mattermostConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"mattermost">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>;
+
+type MattermostConfig = z.infer<typeof mattermostConfigSchema>;
+
+declare const slackConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"slack">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>;
+
+type SlackConfig = z.infer<typeof slackConfigSchema>;
+
+declare const teamsConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"teams">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>;
+
+type TeamsConfig = z.infer<typeof teamsConfigSchema>;
+
+declare const telegramConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"telegram">;
+    botToken: z.ZodString;
+    chatId: z.ZodString;
+}, z.core.$strip>;
+
+type TelegramConfig = z.infer<typeof telegramConfigSchema>;
+
+/**
+ * Send a single message in one call. Convenience wrapper that splits the flat
+ * input into a provider config and a message, then dispatches.
+ *
+ * @example
+ * await send({ provider: "slack", webhookUrl, title: "Hi", body: "world" });
+ */
+declare function send(input: SendInput): Promise<void>;
+
+export { type ChatProvider, type ElementConfig, type MattermostConfig, type Message, PROVIDERS, type SendInput, type Sender, type SenderConfig, type SlackConfig, type TeamsConfig, type TelegramConfig, createSender, elementConfigSchema, mattermostConfigSchema, messageSchema, providerConfigSchemas, send, sendInputSchema, senderConfigSchema, slackConfigSchema, teamsConfigSchema, telegramConfigSchema };

package/dist/index.d.ts

@@ -0,0 +1,149 @@
+import { z } from 'zod';
+
+declare const messageSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    body: z.ZodString;
+    markdown: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+declare const senderConfigSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    provider: z.ZodLiteral<"slack">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"teams">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"mattermost">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"telegram">;
+    botToken: z.ZodString;
+    chatId: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"element">;
+    homeserverUrl: z.ZodURL;
+    accessToken: z.ZodString;
+    roomId: z.ZodString;
+}, z.core.$strip>], "provider">;
+/** Schema for the flat one-shot `send()` input (config merged with message). */
+declare const sendInputSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    provider: z.ZodLiteral<"slack">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"teams">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"mattermost">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"telegram">;
+    botToken: z.ZodString;
+    chatId: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    provider: z.ZodLiteral<"element">;
+    homeserverUrl: z.ZodURL;
+    accessToken: z.ZodString;
+    roomId: z.ZodString;
+}, z.core.$strip>], "provider">, z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    body: z.ZodString;
+    markdown: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>>;
+/** Per-provider config schemas, keyed by provider, for consumers to reuse. */
+declare const providerConfigSchemas: {
+    readonly slack: z.ZodObject<{
+        provider: z.ZodLiteral<"slack">;
+        webhookUrl: z.ZodURL;
+    }, z.core.$strip>;
+    readonly teams: z.ZodObject<{
+        provider: z.ZodLiteral<"teams">;
+        webhookUrl: z.ZodURL;
+    }, z.core.$strip>;
+    readonly mattermost: z.ZodObject<{
+        provider: z.ZodLiteral<"mattermost">;
+        webhookUrl: z.ZodURL;
+    }, z.core.$strip>;
+    readonly telegram: z.ZodObject<{
+        provider: z.ZodLiteral<"telegram">;
+        botToken: z.ZodString;
+        chatId: z.ZodString;
+    }, z.core.$strip>;
+    readonly element: z.ZodObject<{
+        provider: z.ZodLiteral<"element">;
+        homeserverUrl: z.ZodURL;
+        accessToken: z.ZodString;
+        roomId: z.ZodString;
+    }, z.core.$strip>;
+};
+
+/**
+ * A provider-agnostic structured message. Each provider renders the body into
+ * its own native format (Slack blocks, Teams card, Telegram markdown, ...),
+ * optionally as markdown when {@link Message.markdown} is set.
+ */
+type Message = z.infer<typeof messageSchema>;
+/** Discriminated union of every supported provider configuration. */
+type SenderConfig = z.infer<typeof senderConfigSchema>;
+/** Every supported provider key, derived from the config schema discriminant. */
+type ChatProvider = SenderConfig["provider"];
+/** A configured, reusable sender bound to a single provider. */
+interface Sender {
+    /** Human-readable provider name, e.g. "Slack". */
+    name: string;
+    send(message: Message): Promise<void>;
+}
+/** Flat one-shot input: provider config merged with the message. */
+type SendInput = SenderConfig & Message;
+
+/** Every supported provider key. */
+declare const PROVIDERS: readonly ["slack", "teams", "mattermost", "telegram", "element"];
+/** Build a reusable {@link Sender} bound to a single provider configuration. */
+declare function createSender(config: SenderConfig): Sender;
+
+declare const elementConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"element">;
+    homeserverUrl: z.ZodURL;
+    accessToken: z.ZodString;
+    roomId: z.ZodString;
+}, z.core.$strip>;
+
+type ElementConfig = z.infer<typeof elementConfigSchema>;
+
+declare const mattermostConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"mattermost">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>;
+
+type MattermostConfig = z.infer<typeof mattermostConfigSchema>;
+
+declare const slackConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"slack">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>;
+
+type SlackConfig = z.infer<typeof slackConfigSchema>;
+
+declare const teamsConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"teams">;
+    webhookUrl: z.ZodURL;
+}, z.core.$strip>;
+
+type TeamsConfig = z.infer<typeof teamsConfigSchema>;
+
+declare const telegramConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"telegram">;
+    botToken: z.ZodString;
+    chatId: z.ZodString;
+}, z.core.$strip>;
+
+type TelegramConfig = z.infer<typeof telegramConfigSchema>;
+
+/**
+ * Send a single message in one call. Convenience wrapper that splits the flat
+ * input into a provider config and a message, then dispatches.
+ *
+ * @example
+ * await send({ provider: "slack", webhookUrl, title: "Hi", body: "world" });
+ */
+declare function send(input: SendInput): Promise<void>;
+
+export { type ChatProvider, type ElementConfig, type MattermostConfig, type Message, PROVIDERS, type SendInput, type Sender, type SenderConfig, type SlackConfig, type TeamsConfig, type TelegramConfig, createSender, elementConfigSchema, mattermostConfigSchema, messageSchema, providerConfigSchemas, send, sendInputSchema, senderConfigSchema, slackConfigSchema, teamsConfigSchema, telegramConfigSchema };