@facteurjs/core 1.0.0-beta.0

package/dist/channels/slack/message.js

@@ -0,0 +1,390 @@
+import { WebhookMessage } from "../webhook/message.js";
+
+//#region src/channels/slack/message.ts
+var SlackMessage = class SlackMessage extends WebhookMessage {
+	#text = "";
+	#iconEmoji = "";
+	#iconUrl = "";
+	#username = "";
+	#channel = "";
+	#threadTs = "";
+	#unfurlLinks = false;
+	#unfurlMedia = false;
+	#blocks = [];
+	/**
+	* Creates a new instance of SlackMessage.
+	*/
+	static create() {
+		return new SlackMessage();
+	}
+	/**
+	* Sets the main text content of the message. This will be displayed as fallback text.
+	*/
+	setText(text) {
+		this.#text = text;
+		return this;
+	}
+	/**
+	* Sets the username for the bot that will send the message.
+	*/
+	setBotUsername(username) {
+		this.#username = username;
+		return this;
+	}
+	/**
+	* Sets the emoji icon for the bot (e.g., ":ghost:").
+	*/
+	setBotIconEmoji(emoji) {
+		this.#iconEmoji = emoji;
+		return this;
+	}
+	/**
+	* Sets the avatar URL for the bot.
+	*/
+	setBotIconUrl(url) {
+		this.#iconUrl = url;
+		return this;
+	}
+	/**
+	* Sets the channel to send the message to.
+	*/
+	setChannel(channel) {
+		this.#channel = channel;
+		return this;
+	}
+	/**
+	* Sets the thread timestamp to reply to a specific thread.
+	*/
+	setThreadTimestamp(threadTs) {
+		this.#threadTs = threadTs;
+		return this;
+	}
+	/**
+	* Whether to automatically unfurl links in the message.
+	*/
+	setUnfurlLinks(unfurl) {
+		this.#unfurlLinks = unfurl;
+		return this;
+	}
+	/**
+	* Whether to automatically unfurl media in the message.
+	*/
+	setUnfurlMedia(unfurl) {
+		this.#unfurlMedia = unfurl;
+		return this;
+	}
+	/**
+	* Adds a section block with text content.
+	*/
+	addSectionBlock(callback) {
+		const block = new SlackSectionBlock();
+		callback(block);
+		this.#blocks.push(block);
+		return this;
+	}
+	/**
+	* Adds a header block with plain text.
+	*/
+	addHeaderBlock(text) {
+		this.#blocks.push(new SlackHeaderBlock(text));
+		return this;
+	}
+	/**
+	* Adds a divider block to separate content.
+	*/
+	addDividerBlock() {
+		this.#blocks.push(new SlackDividerBlock());
+		return this;
+	}
+	/**
+	* Adds a context block with contextual information.
+	*/
+	addContextBlock(callback) {
+		const block = new SlackContextBlock();
+		callback(block);
+		this.#blocks.push(block);
+		return this;
+	}
+	/**
+	* Adds an image block to display an image.
+	*/
+	addImageBlock(callback) {
+		const block = new SlackImageBlock();
+		callback(block);
+		this.#blocks.push(block);
+		return this;
+	}
+	/**
+	* Adds an actions block with interactive elements.
+	*/
+	addActionsBlock(callback) {
+		const block = new SlackActionsBlock();
+		callback(block);
+		this.#blocks.push(block);
+		return this;
+	}
+	serialize() {
+		const body = {
+			text: this.#text,
+			username: this.#username,
+			icon_emoji: this.#iconEmoji,
+			icon_url: this.#iconUrl,
+			channel: this.#channel,
+			unfurl_links: this.#unfurlLinks,
+			unfurl_media: this.#unfurlMedia,
+			blocks: this.#blocks.map((block) => block.serialize())
+		};
+		if (this.#threadTs) body.thread_ts = this.#threadTs;
+		return {
+			...super.serialize(),
+			body
+		};
+	}
+};
+var SlackBlock = class {
+	blockId;
+	setBlockId(blockId) {
+		this.blockId = blockId;
+		return this;
+	}
+};
+var SlackSectionBlock = class extends SlackBlock {
+	#text;
+	#fields = [];
+	#accessory;
+	/**
+	* Sets the main text for the section using markdown formatting.
+	*/
+	setMarkdownText(text) {
+		this.#text = {
+			type: "mrkdwn",
+			text
+		};
+		return this;
+	}
+	/**
+	* Sets the main text for the section using plain text.
+	*/
+	setPlainText(text) {
+		this.#text = {
+			type: "plain_text",
+			text
+		};
+		return this;
+	}
+	/**
+	* Adds a field to the section using markdown formatting.
+	*/
+	addMarkdownField(text) {
+		this.#fields.push({
+			type: "mrkdwn",
+			text
+		});
+		return this;
+	}
+	/**
+	* Adds a field to the section using plain text.
+	*/
+	addPlainTextField(text) {
+		this.#fields.push({
+			type: "plain_text",
+			text
+		});
+		return this;
+	}
+	/**
+	* Adds a button accessory to the section.
+	*/
+	addButtonAccessory(options) {
+		this.#accessory = {
+			type: "button",
+			text: {
+				type: "plain_text",
+				text: options.text
+			},
+			action_id: options.actionId,
+			value: options.value,
+			style: options.style
+		};
+		return this;
+	}
+	serialize() {
+		return {
+			type: "section",
+			block_id: this.blockId,
+			text: this.#text,
+			fields: this.#fields.length > 0 ? this.#fields : void 0,
+			accessory: this.#accessory
+		};
+	}
+};
+var SlackHeaderBlock = class extends SlackBlock {
+	#text;
+	constructor(text) {
+		super();
+		this.#text = text;
+	}
+	serialize() {
+		return {
+			type: "header",
+			block_id: this.blockId,
+			text: {
+				type: "plain_text",
+				text: this.#text
+			}
+		};
+	}
+};
+var SlackDividerBlock = class extends SlackBlock {
+	serialize() {
+		return {
+			type: "divider",
+			block_id: this.blockId
+		};
+	}
+};
+var SlackContextBlock = class extends SlackBlock {
+	#elements = [];
+	/**
+	* Adds markdown text to the context block.
+	*/
+	addMarkdownText(text) {
+		this.#elements.push({
+			type: "mrkdwn",
+			text
+		});
+		return this;
+	}
+	/**
+	* Adds plain text to the context block.
+	*/
+	addPlainText(text) {
+		this.#elements.push({
+			type: "plain_text",
+			text
+		});
+		return this;
+	}
+	/**
+	* Adds an image to the context block.
+	*/
+	addImage(options) {
+		this.#elements.push({
+			type: "image",
+			image_url: options.imageUrl,
+			alt_text: options.altText
+		});
+		return this;
+	}
+	serialize() {
+		return {
+			type: "context",
+			block_id: this.blockId,
+			elements: this.#elements
+		};
+	}
+};
+var SlackImageBlock = class extends SlackBlock {
+	#imageUrl;
+	#altText;
+	#title;
+	/**
+	* Sets the image URL for the block.
+	*/
+	setImageUrl(url) {
+		this.#imageUrl = url;
+		return this;
+	}
+	/**
+	* Sets the alt text for accessibility.
+	*/
+	setAltText(altText) {
+		this.#altText = altText;
+		return this;
+	}
+	/**
+	* Sets an optional title for the image.
+	*/
+	setTitle(title) {
+		this.#title = title;
+		return this;
+	}
+	serialize() {
+		return {
+			type: "image",
+			block_id: this.blockId,
+			image_url: this.#imageUrl,
+			alt_text: this.#altText,
+			title: this.#title ? {
+				type: "plain_text",
+				text: this.#title
+			} : void 0
+		};
+	}
+};
+var SlackActionsBlock = class extends SlackBlock {
+	#elements = [];
+	/**
+	* Adds a button to the actions block.
+	*/
+	addButton(options) {
+		this.#elements.push({
+			type: "button",
+			text: {
+				type: "plain_text",
+				text: options.text
+			},
+			action_id: options.actionId,
+			value: options.value,
+			style: options.style,
+			url: options.url
+		});
+		return this;
+	}
+	/**
+	* Adds a static select menu to the actions block.
+	*/
+	addStaticSelect(options) {
+		this.#elements.push({
+			type: "static_select",
+			placeholder: {
+				type: "plain_text",
+				text: options.placeholder
+			},
+			action_id: options.actionId,
+			options: options.options.map((option) => ({
+				text: {
+					type: "plain_text",
+					text: option.text
+				},
+				value: option.value
+			}))
+		});
+		return this;
+	}
+	/**
+	* Adds a date picker to the actions block.
+	*/
+	addDatePicker(options) {
+		this.#elements.push({
+			type: "datepicker",
+			placeholder: {
+				type: "plain_text",
+				text: options.placeholder
+			},
+			action_id: options.actionId,
+			initial_date: options.initialDate
+		});
+		return this;
+	}
+	serialize() {
+		return {
+			type: "actions",
+			block_id: this.blockId,
+			elements: this.#elements
+		};
+	}
+};
+
+//#endregion
+export { SlackMessage };

package/dist/channels/slack/types.d.ts

@@ -0,0 +1,7 @@
+import { WebhookOptions, WebhookTargets } from "../webhook/types.js";
+
+//#region src/channels/slack/types.d.ts
+type SlackOptions<WebhooksNames extends string> = WebhookOptions<WebhooksNames>;
+type SlackTargets<Options extends SlackOptions<any>> = WebhookTargets<Options>;
+//#endregion
+export { SlackOptions, SlackTargets };

package/dist/channels/transmit/channel.d.ts

@@ -0,0 +1,21 @@
+import { Channel, ChannelSendParams, kTargetSymbol } from "../../types/channel.js";
+import { TransmitMessage } from "./message.js";
+import { TransmitConfig, TransmitTargets } from "./types.js";
+
+//#region src/channels/transmit/channel.d.ts
+declare function transmitChannel(config: TransmitConfig): TransmitChannel;
+declare class TransmitChannel implements Channel<TransmitConfig, TransmitMessage, any, TransmitTargets> {
+  #private;
+  private config;
+  name: "transmit";
+  [kTargetSymbol]: TransmitTargets;
+  constructor(config: TransmitConfig);
+  send(options: ChannelSendParams<TransmitMessage, TransmitTargets>): Promise<void>;
+}
+declare module '@facteurjs/core/types' {
+  interface Notification {
+    asTransmitMessage(): TransmitMessage;
+  }
+}
+//#endregion
+export { TransmitChannel, transmitChannel };

package/dist/channels/transmit/channel.js

@@ -0,0 +1,27 @@
+import { errors } from "../../errors/index.js";
+import { kTargetSymbol } from "../../types/channel.js";
+import "../../types/index.js";
+
+//#region src/channels/transmit/channel.ts
+function transmitChannel(config) {
+	return new TransmitChannel(config);
+}
+var TransmitChannel = class {
+	name = "transmit";
+	[kTargetSymbol] = null;
+	constructor(config) {
+		this.config = config;
+	}
+	#resolveTargets(options) {
+		if (options.targets) return options.targets;
+		throw new errors.E_UNAVAILABLE_TARGETS(["Transmit"]);
+	}
+	async send(options) {
+		const message = options.message.serialize();
+		const targets = this.#resolveTargets(options);
+		this.config.transmit.broadcast(targets.channel, message.content);
+	}
+};
+
+//#endregion
+export { TransmitChannel, transmitChannel };

package/dist/channels/transmit/index.d.ts

@@ -0,0 +1,3 @@
+import { TransmitMessage } from "./message.js";
+import { TransmitChannel, transmitChannel } from "./channel.js";
+export { TransmitChannel, TransmitMessage, transmitChannel };

package/dist/channels/transmit/index.js

@@ -0,0 +1,4 @@
+import { TransmitMessage } from "./message.js";
+import { TransmitChannel, transmitChannel } from "./channel.js";
+
+export { TransmitChannel, TransmitMessage, transmitChannel };

package/dist/channels/transmit/message.d.ts

@@ -0,0 +1,11 @@
+//#region src/channels/transmit/message.d.ts
+declare class TransmitMessage {
+  #private;
+  static create(): TransmitMessage;
+  setContent(content: Record<string, any>): this;
+  serialize(): {
+    content: Record<string, any>;
+  };
+}
+//#endregion
+export { TransmitMessage };

package/dist/channels/transmit/message.js

@@ -0,0 +1,17 @@
+//#region src/channels/transmit/message.ts
+var TransmitMessage = class TransmitMessage {
+	#content = {};
+	static create() {
+		return new TransmitMessage();
+	}
+	setContent(content) {
+		this.#content = content;
+		return this;
+	}
+	serialize() {
+		return { content: this.#content };
+	}
+};
+
+//#endregion
+export { TransmitMessage };

package/dist/channels/transmit/types.d.ts

@@ -0,0 +1,11 @@
+import { Transmit } from "@boringnode/transmit";
+
+//#region src/channels/transmit/types.d.ts
+interface TransmitTargets {
+  channel: string;
+}
+interface TransmitConfig {
+  transmit: Transmit<any>;
+}
+//#endregion
+export { TransmitConfig, TransmitTargets };

package/dist/channels/twilio/channel.d.ts

@@ -0,0 +1,21 @@
+import { Channel, ChannelSendParams, kTargetSymbol } from "../../types/channel.js";
+import { TwilioMessage } from "./message.js";
+import { TwilioConfig, TwilioTargets } from "./types.js";
+
+//#region src/channels/twilio/channel.d.ts
+declare function twilioChannel(config: TwilioConfig): TwilioChannel;
+declare class TwilioChannel implements Channel<TwilioConfig, TwilioMessage, any, TwilioTargets> {
+  #private;
+  private config;
+  name: "twilio";
+  [kTargetSymbol]: TwilioTargets;
+  constructor(config: TwilioConfig);
+  send(options: ChannelSendParams<TwilioMessage, TwilioTargets>): Promise<void>;
+}
+declare module '@facteurjs/core/types' {
+  interface Notification {
+    asTwilioMessage(): TwilioMessage;
+  }
+}
+//#endregion
+export { TwilioChannel, twilioChannel };

package/dist/channels/twilio/channel.js

@@ -0,0 +1,56 @@
+import { errors } from "../../errors/index.js";
+import { kTargetSymbol } from "../../types/channel.js";
+import "../../types/index.js";
+import Twilio from "twilio";
+
+//#region src/channels/twilio/channel.ts
+function twilioChannel(config) {
+	return new TwilioChannel(config);
+}
+var TwilioChannel = class {
+	name = "twilio";
+	[kTargetSymbol] = null;
+	#client;
+	constructor(config) {
+		this.config = config;
+		this.#client = new Twilio(config.accountSid, config.authToken);
+	}
+	async send(options) {
+		const message = options.message;
+		const targets = this.#resolveTargets(options);
+		const messageData = message.serialize();
+		const from = this.#resolveFrom(message, targets);
+		if (from) messageData.from = from;
+		if (this.config.messagingServiceSid && !message.getMessagingServiceSid()) messageData.messagingServiceSid = this.config.messagingServiceSid;
+		if (this.config.maxPrice !== void 0 && message.getMaxPrice() === void 0) messageData.maxPrice = this.config.maxPrice;
+		if (this.config.shortenUrls) messageData.shortenUrls = true;
+		const to = this.config.debugTo || targets.to;
+		try {
+			await this.#client.messages.create({
+				...messageData,
+				to
+			});
+		} catch (error) {
+			if (this.config.ignoredErrorCodes && error.code) {
+				const isIgnored = this.config.ignoredErrorCodes.includes(error.code) || this.config.ignoredErrorCodes.includes("*");
+				if (isIgnored) return;
+			}
+			throw error;
+		}
+	}
+	#resolveTargets(options) {
+		if (options.targets) return options.targets;
+		throw new errors.E_UNAVAILABLE_TARGETS(["Twilio"]);
+	}
+	#resolveFrom(message, targets) {
+		if (message.getFrom()) return message.getFrom();
+		if (targets.from) return targets.from;
+		if (this.config.from) return this.config.from;
+		if (message.getAlphanumericSender()) return message.getAlphanumericSender();
+		if (this.config.alphanumericSender) return this.config.alphanumericSender;
+		return void 0;
+	}
+};
+
+//#endregion
+export { TwilioChannel, twilioChannel };

package/dist/channels/twilio/index.d.ts

@@ -0,0 +1,4 @@
+import { TwilioMessage } from "./message.js";
+import { TwilioConfig, TwilioTargets } from "./types.js";
+import { TwilioChannel, twilioChannel } from "./channel.js";
+export { TwilioChannel, type TwilioConfig, TwilioMessage, type TwilioTargets, twilioChannel };

package/dist/channels/twilio/index.js

@@ -0,0 +1,4 @@
+import { TwilioMessage } from "./message.js";
+import { TwilioChannel, twilioChannel } from "./channel.js";
+
+export { TwilioChannel, TwilioMessage, twilioChannel };

package/dist/channels/twilio/message.d.ts

@@ -0,0 +1,86 @@
+//#region src/channels/twilio/message.d.ts
+declare class TwilioMessage {
+  #private;
+  /**
+   * Creates a new instance of TwilioMessage
+   */
+  static create(): TwilioMessage;
+  /**
+   * Sets the message content/body
+   */
+  setBody(body: string): this;
+  /**
+   * Gets the message body
+   */
+  getBody(): string;
+  /**
+   * Sets the sender phone number
+   */
+  setFrom(from: string): this;
+  /**
+   * Gets the sender phone number
+   */
+  getFrom(): string | undefined;
+  /**
+   * Sets the messaging service SID
+   */
+  setMessagingServiceSid(sid: string): this;
+  /**
+   * Gets the messaging service SID.
+   */
+  getMessagingServiceSid(): string | undefined;
+  /**
+   * Sets the alphanumeric sender
+   */
+  setAlphanumericSender(sender: string): this;
+  /**
+   * Gets the alphanumeric sender
+   */
+  getAlphanumericSender(): string | undefined;
+  /**
+   * Sets the maximum price per message in USD
+   */
+  setMaxPrice(price: number): this;
+  /**
+   * Gets the maximum price.
+   */
+  getMaxPrice(): number | undefined;
+  /**
+   * Sets the validity period in seconds
+   */
+  setValidityPeriod(seconds: number): this;
+  /**
+   * Gets the validity period.
+   */
+  getValidityPeriod(): number | undefined;
+  /**
+   * Sets force delivery option.
+   */
+  setForceDelivery(force: boolean): this;
+  /**
+   * Gets force delivery option
+   */
+  getForceDelivery(): boolean | undefined;
+  /**
+   * Sets provide feedback option
+   */
+  setProvideFeedback(provide: boolean): this;
+  /**
+   * Gets provide feedback option.
+   */
+  getProvideFeedback(): boolean | undefined;
+  /**
+   * Sets the application SID for status callbacks.
+   */
+  setApplicationSid(sid: string): this;
+  /**
+   * Gets the application SID
+   */
+  getApplicationSid(): string | undefined;
+  /**
+   * Serializes the message to Twilio API format
+   */
+  serialize(): Record<string, any>;
+}
+//#endregion
+export { TwilioMessage };