@decaf-ts/integrations 0.11.0 → 0.12.0

package/lib/types/comms/gmail/GmailService.d.mts

@@ -0,0 +1,190 @@
+import { HttpApiService, type HttpApiServiceConfig } from "../../shared/http/index.d.mts";
+import { type EmailMessageInput } from "../email/mime.d.mts";
+/**
+ * @description Configuration for the Gmail service
+ * @summary Extends {@link HttpApiServiceConfig} with the OAuth access token
+ * (sent as a bearer token) and the mailbox `userId` used in the API path
+ * (defaults to `"me"`). When omitted, the `comms.gmail` environment slice
+ * supplies the token (and optional `userId`, `baseUrl`, `timeout`).
+ * @category Comms
+ * @memberOf module:integrations/comms/gmail/service
+ */
+export interface GmailServiceConfig extends HttpApiServiceConfig {
+    /**
+     * @description Gmail API OAuth access token
+     * @summary Sent as `Authorization: Bearer <token>` with every API call.
+     */
+    token?: string;
+    /**
+     * @description Mailbox user identifier
+     * @summary The special value `"me"` (the default) refers to the authenticated user.
+     */
+    userId?: string;
+}
+/**
+ * @description Result of a sent Gmail message
+ * @summary Echoes Gmail's identifiers for the sent message: the message `id`,
+ * its `threadId` when Gmail assigned one, and the applied `labelIds`.
+ * @category Comms
+ * @memberOf module:integrations/comms/gmail/service
+ */
+export interface GmailSendResult {
+    id: string;
+    threadId?: string;
+    labelIds?: string[];
+}
+/**
+ * @description Result of a Gmail message list call
+ * @summary Carries one page of message references (`messages` with `id` and
+ * optional `threadId`), the `nextPageToken` to pass back as `pageToken` for
+ * the next page, and Gmail's `resultSizeEstimate`.
+ * @category Comms
+ * @memberOf module:integrations/comms/gmail/service
+ */
+export interface GmailListResult {
+    messages: Array<{
+        id: string;
+        threadId?: string;
+    }>;
+    nextPageToken?: string;
+    resultSizeEstimate?: number;
+}
+/**
+ * @description Gmail API integration service
+ * @summary An undecorated HTTP service for sending MIME-built
+ * emails, listing messages with Gmail query syntax and page tokens, fetching
+ * a single message in a chosen format, and listing labels. All operations
+ * require an OAuth token (`requireToken()`) and operate on the configured
+ * `userId` mailbox (default `"me"`); transport failures are mapped to decaf
+ * errors via {@link httpError}.
+ * @class GmailService
+ * @category Comms
+ * @example
+ * ```ts
+ * import { GmailService } from "@decaf-ts/integrations/comms/gmail";
+ *
+ * const gmail = new GmailService();
+ * await gmail.initialize({
+ *   token: process.env.GRAPH_CREDENTIAL_GMAIL_TOKEN,
+ * });
+ * await gmail.send({
+ *   from: "bot@example.com",
+ *   to: "ops@example.com",
+ *   subject: "Deploy",
+ *   text: "Release 1.2.0 is live",
+ * });
+ * ```
+ * @memberOf module:integrations/comms/gmail/service
+ */
+export declare class GmailService extends HttpApiService<GmailServiceConfig> {
+    /**
+     * @description The provider name used in error messages
+     */
+    protected readonly serviceName = "Gmail";
+    /**
+     * @description The Gmail REST API base URL
+     * @summary Used when the resolved config carries no `baseUrl`.
+     * @returns {string} `"https://gmail.googleapis.com/gmail/v1"`.
+     */
+    protected defaultBaseUrl(): string;
+    /**
+     * @description Builds the Gmail OAuth bearer authorization headers
+     * @summary Returns the `Authorization: Bearer <token>` header when the
+     * config carries a token, and no headers otherwise.
+     * @param {GmailServiceConfig} config - The resolved service configuration.
+     * @returns {Record<string, string>} The authorization headers (empty without a token).
+     */
+    protected authHeaders(config: GmailServiceConfig): Record<string, string>;
+    /**
+     * @description Reads the Gmail credentials and defaults from the environment
+     * @summary Reads the `comms.gmail` environment slice and returns a partial
+     * config when a token is configured, `undefined` otherwise. Values pass
+     * through `envString`/`envNumber` to reject unset-leaf proxies.
+     * @returns {Partial<GmailServiceConfig> | undefined} A partial config, or `undefined` when no Gmail token is configured.
+     */
+    protected configFromEnvironment(): Partial<GmailServiceConfig> | undefined;
+    /**
+     * @description Builds the mailbox-scoped API path
+     * @summary Returns `/users/<userId>` with the configured `userId` (or
+     * `"me"` when unset) URL-encoded; all message and label operations are
+     * relative to this path.
+     * @returns {string} The URL-encoded mailbox path.
+     */
+    protected userPath(): string;
+    /**
+     * @description Sends an email through the Gmail API
+     * @summary Builds a raw MIME message from the input with the shared email
+     * MIME builder (`buildEmail`), base64url-encodes it, and `POST`s it to
+     * `users.messages.send`. Requires a token and a `from` sender address.
+     * @param {EmailMessageInput} input - The message envelope and body (`from`, `to`, `subject`, and optional `cc`/`bcc`/`text`/`html`/`replyTo`/`attachments`).
+     * @returns {Promise<GmailSendResult>} Gmail's identifiers for the sent message.
+     * @throws {InternalError} When no token is configured or the sender address is missing.
+     * @throws {NotFoundError} When the endpoint answers with HTTP 404.
+     * @throws {ConflictError} When Gmail answers with HTTP 409.
+     * @throws {BadRequestError} When Gmail answers with any other HTTP error status (e.g. invalid recipients).
+     */
+    send(input: EmailMessageInput): Promise<GmailSendResult>;
+    /**
+     * @description Lists mailbox messages with Gmail query paging
+     * @summary `GET`s `users.messages.list` with an optional Gmail `query`
+     * (`q` parameter, e.g. `"from:user@example.com is:unread"`), a page size
+     * (default `25`), a `pageToken` from the previous page, and `labelIds`
+     * filtering. Returns the message references and the `nextPageToken` to pass
+     * back as `pageToken` for the next page.
+     * @param {object} [options] - Query and paging options.
+     * @param {string} [options.query] - Gmail search query (`q` parameter).
+     * @param {number} [options.maxResults] - Page size; defaults to `25`.
+     * @param {string} [options.pageToken] - The `nextPageToken` from the previous page.
+     * @param {string[]} [options.labelIds] - Label IDs the messages must carry.
+     * @returns {Promise<GmailListResult>} One page of message references with the next page token when more pages exist.
+     * @throws {InternalError} When no token is configured.
+     * @throws {NotFoundError} When the endpoint answers with HTTP 404.
+     * @throws {ConflictError} When Gmail answers with HTTP 409.
+     * @throws {BadRequestError} When Gmail answers with any other HTTP error status (e.g. invalid query).
+     * @example
+     * ```ts
+     * let pageToken: string | undefined;
+     * do {
+     *   const page = await gmail.listMessages({
+     *     query: "is:unread",
+     *     maxResults: 100,
+     *     pageToken,
+     *   });
+     *   console.log(page.messages);
+     *   pageToken = page.nextPageToken;
+     * } while (pageToken);
+     * ```
+     */
+    listMessages(options?: {
+        query?: string;
+        maxResults?: number;
+        pageToken?: string;
+        labelIds?: string[];
+    }): Promise<GmailListResult>;
+    /**
+     * @description Fetches a single Gmail message
+     * @summary `GET`s `users.messages.get` for the given message ID with the
+     * requested `format`. With `"full"` (the default) the payload includes the
+     * parsed body parts; `"metadata"` limits it to headers and labels,
+     * `"minimal"` to identifiers only, and `"raw"` returns the raw MIME string.
+     * @param {string} id - The Gmail message ID.
+     * @param {"full" | "metadata" | "minimal" | "raw"} [format] - The message format to request; defaults to `"full"`.
+     * @returns {Promise<Record<string, unknown>>} The raw Gmail message payload in the requested format.
+     * @throws {InternalError} When no token is configured or the message ID is empty.
+     * @throws {NotFoundError} When the message does not exist (HTTP 404).
+     * @throws {ConflictError} When Gmail answers with HTTP 409.
+     * @throws {BadRequestError} When Gmail answers with any other HTTP error status.
+     */
+    getMessage(id: string, format?: "full" | "metadata" | "minimal" | "raw"): Promise<Record<string, unknown>>;
+    /**
+     * @description Lists the mailbox's Gmail labels
+     * @summary `GET`s `users.labels.list` and returns the raw label payloads
+     * (including `id`, `name`, and `type`).
+     * @returns {Promise<Array<Record<string, unknown>>>} The raw Gmail label payloads.
+     * @throws {InternalError} When no token is configured.
+     * @throws {NotFoundError} When the endpoint answers with HTTP 404.
+     * @throws {ConflictError} When Gmail answers with HTTP 409.
+     * @throws {BadRequestError} When Gmail answers with any other HTTP error status.
+     */
+    listLabels(): Promise<Array<Record<string, unknown>>>;
+}

package/lib/types/comms/gmail/index.d.cts

@@ -0,0 +1,6 @@
+/**
+ * @module integrations/comms/gmail
+ * @summary Gmail service (REST v1 message send/list/get and label listing).
+ * @description Re-exports the Gmail client-based service and its types.
+ */
+export * from "./GmailService.d.cts";

package/lib/types/comms/gmail/index.d.mts

@@ -0,0 +1,6 @@
+/**
+ * @module integrations/comms/gmail
+ * @summary Gmail service (REST v1 message send/list/get and label listing).
+ * @description Re-exports the Gmail client-based service and its types.
+ */
+export * from "./GmailService.d.mts";

package/lib/types/comms/index.d.cts

@@ -0,0 +1,13 @@
+/**
+ * @module integrations/comms
+ * @summary Comms integration services (Slack, Telegram, Teams, Gmail, Email).
+ * @description Re-exports the messaging/email services, their per-service
+ * modules, and the shared `comms` environment slice. Each sub-module is also
+ * available through its own package subpath export.
+ */
+export * from "./email/index.d.cts";
+export * from "./gmail/index.d.cts";
+export * from "./slack/index.d.cts";
+export * from "./teams/index.d.cts";
+export * from "./telegram/index.d.cts";
+export * from "./environment.d.cts";

package/lib/types/comms/index.d.mts

@@ -0,0 +1,13 @@
+/**
+ * @module integrations/comms
+ * @summary Comms integration services (Slack, Telegram, Teams, Gmail, Email).
+ * @description Re-exports the messaging/email services, their per-service
+ * modules, and the shared `comms` environment slice. Each sub-module is also
+ * available through its own package subpath export.
+ */
+export * from "./email/index.d.mts";
+export * from "./gmail/index.d.mts";
+export * from "./slack/index.d.mts";
+export * from "./teams/index.d.mts";
+export * from "./telegram/index.d.mts";
+export * from "./environment.d.mts";

package/lib/types/comms/slack/SlackService.d.cts

@@ -0,0 +1,259 @@
+import { HttpApiService, type HttpApiServiceConfig } from "../../shared/http/index.d.cts";
+/**
+ * @description Configuration for the Slack service
+ * @summary Extends {@link HttpApiServiceConfig} with the Slack Bot User OAuth
+ * token used as a bearer token. When omitted, the `comms.slack` environment
+ * slice supplies the token (and optional `baseUrl`/`timeout`).
+ * @category Comms
+ * @memberOf module:integrations/comms/slack/service
+ */
+export interface SlackServiceConfig extends HttpApiServiceConfig {
+    /**
+     * @description Slack Bot User OAuth token
+     * @summary Sent as `Authorization: Bearer <token>` with every API call.
+     */
+    token?: string;
+}
+/**
+ * @description Input for posting a message to a Slack channel or thread
+ * @summary Carries the destination `channel` (ID or `#channel`/`@user` style
+ * name), the plain-text fallback `text`, optional Block Kit `blocks`, and the
+ * posting options (thread reply, broadcast reply, unfurling).
+ * @category Comms
+ * @memberOf module:integrations/comms/slack/service
+ */
+export interface SlackPostMessageInput {
+    /**
+     * @description Destination channel ID, `#channel`, or `@user` mention
+     */
+    channel: string;
+    /**
+     * @description Plain-text message body (also the fallback for `blocks`)
+     */
+    text: string;
+    /**
+     * @description Optional Block Kit layout blocks replacing plain text
+     */
+    blocks?: unknown[];
+    /**
+     * @description Message timestamp to reply in-thread to
+     */
+    threadTs?: string;
+    /**
+     * @description Whether to also notify the channel when replying in a thread
+     */
+    replyBroadcast?: boolean;
+    /**
+     * @description Whether link previews are enabled
+     */
+    unfurlLinks?: boolean;
+    /**
+     * @description Whether media unfurls are enabled
+     */
+    unfurlMedia?: boolean;
+}
+/**
+ * @description Result of a posted Slack message
+ * @summary Echoes the destination `channel` and the message timestamp `ts`
+ * (usable as `threadTs` for follow-up replies), with the posted `text` and the
+ * raw `message` payload when Slack returns them.
+ * @category Comms
+ * @memberOf module:integrations/comms/slack/service
+ */
+export interface SlackPostMessageResult {
+    channel: string;
+    ts: string;
+    text?: string;
+    message?: unknown;
+}
+/**
+ * @description Normalized Slack conversation (channel) descriptor
+ * @summary Maps the raw `conversations.*` payload onto camelCase fields:
+ * identity (`id`, `name`), visibility (`isPrivate`, `isArchived`),
+ * `memberCount`, and topic/purpose summaries.
+ * @category Comms
+ * @memberOf module:integrations/comms/slack/service
+ */
+export interface SlackChannel {
+    id: string;
+    name?: string;
+    isPrivate?: boolean;
+    isArchived?: boolean;
+    memberCount?: number;
+    topic?: string;
+    purpose?: string;
+}
+interface SlackApiResponse {
+    ok: boolean;
+    error?: string;
+}
+/**
+ * @description Slack Web API integration service
+ * @summary An undecorated HTTP service for posting messages,
+ * listing conversations with cursor paging, fetching a single conversation,
+ * and looking up users. The Slack Bot token is sent as a bearer token, every
+ * call requires it (`requireToken()`), non-`ok` Slack responses raise
+ * `InternalError`, and transport failures are mapped to decaf errors via
+ * {@link httpError}.
+ * @class SlackService
+ * @category Comms
+ * @example
+ * ```ts
+ * import { SlackService } from "@decaf-ts/integrations/comms/slack";
+ *
+ * const slack = new SlackService();
+ * await slack.initialize({
+ *   token: process.env.GRAPH_CREDENTIAL_SLACK_TOKEN,
+ * });
+ * await slack.postMessage({
+ *   channel: "#general",
+ *   text: "Deployment finished",
+ * });
+ * ```
+ * @mermaid
+ * sequenceDiagram
+ *   autonumber
+ *   participant Caller
+ *   participant Service as SlackService
+ *   participant Slack as Slack Web API
+ *   Caller->>Service: postMessage(input)
+ *   activate Service
+ *   Service->>Service: requireToken()
+ *   Service->>Slack: POST /chat.postMessage
+ *   activate Slack
+ *   Slack-->>Service: { ok, channel, ts }
+ *   deactivate Slack
+ *   alt ok
+ *     Service-->>Caller: SlackPostMessageResult
+ *   else error
+ *     Service--xCaller: InternalError / mapped decaf error
+ *   end
+ *   deactivate Service
+ * @memberOf module:integrations/comms/slack/service
+ */
+export declare class SlackService extends HttpApiService<SlackServiceConfig> {
+    /**
+     * @description The provider name used in error messages
+     */
+    protected readonly serviceName = "Slack";
+    /**
+     * @description The Slack Web API base URL
+     * @summary Used when the resolved config carries no `baseUrl`.
+     * @returns {string} `"https://slack.com/api"`.
+     */
+    protected defaultBaseUrl(): string;
+    /**
+     * @description Builds the Slack bearer authorization headers
+     * @summary Returns the `Authorization: Bearer <token>` header when the
+     * config carries a token, and no headers otherwise.
+     * @param {SlackServiceConfig} config - The resolved service configuration.
+     * @returns {Record<string, string>} The authorization headers (empty without a token).
+     */
+    protected authHeaders(config: SlackServiceConfig): Record<string, string>;
+    /**
+     * @description Reads the Slack credentials and defaults from the environment
+     * @summary Reads the `comms.slack` environment slice and returns a partial
+     * config when a token is configured, `undefined` otherwise. Values pass
+     * through `envString`/`envNumber` to reject unset-leaf proxies.
+     * @returns {Partial<SlackServiceConfig> | undefined} A partial config, or `undefined` when no Slack token is configured.
+     */
+    protected configFromEnvironment(): Partial<SlackServiceConfig> | undefined;
+    /**
+     * @description Posts a request to a Slack Web API method
+     * @summary Shared request path for all Slack operations: asserts a token is
+     * configured, `POST`s the payload to `/<method>`, rejects non-`ok` Slack
+     * responses with an `InternalError`, and maps transport failures through
+     * {@link httpError}.
+     * @template T - The expected Slack response shape, extending `SlackApiResponse`.
+     * @param {string} method - The Slack Web API method name (e.g. `"chat.postMessage"`).
+     * @param {Record<string, unknown>} payload - The JSON body for the method.
+     * @returns {Promise<T>} The parsed Slack response payload.
+     * @throws {InternalError} When no token is configured or Slack answers with `ok: false`.
+     * @throws {NotFoundError} When Slack answers with HTTP 404.
+     * @throws {ConflictError} When Slack answers with HTTP 409.
+     * @throws {BadRequestError} When Slack answers with any other HTTP error status.
+     */
+    protected call<T extends SlackApiResponse>(method: string, payload: Record<string, unknown>): Promise<T>;
+    /**
+     * @description Posts a message to a Slack channel or thread
+     * @summary Sends the input to Slack's `chat.postMessage` method and returns
+     * the destination channel and message timestamp; use the returned `ts` as
+     * `threadTs` to reply in the same thread. Provide `blocks` for Block Kit
+     * layouts (with `text` as the fallback), or plain text alone.
+     * @param {SlackPostMessageInput} input - The message destination and content.
+     * @returns {Promise<SlackPostMessageResult>} The posted message's channel, timestamp, text, and raw payload.
+     * @throws {InternalError} When no token is configured or Slack rejects the message.
+     * @throws {NotFoundError} When the channel cannot be found (HTTP 404).
+     * @throws {ConflictError} When Slack answers with HTTP 409.
+     * @throws {BadRequestError} When Slack answers with any other HTTP error status.
+     * @example
+     * ```ts
+     * await slack.postMessage({
+     *   channel: "#deploys",
+     *   text: "Release 1.2.0 is live",
+     *   unfurlLinks: false,
+     * });
+     * ```
+     */
+    postMessage(input: SlackPostMessageInput): Promise<SlackPostMessageResult>;
+    /**
+     * @description Lists Slack conversations with cursor paging
+     * @summary Calls `conversations.list` with a page size (default `100`),
+     * conversation `types` (default public and private channels), and archived
+     * exclusion (default `true`), returning normalized channels and the
+     * `nextCursor` to pass back as `cursor` for the next page.
+     * @param {object} [options] - Paging and filter options.
+     * @param {number} [options.limit] - Page size; defaults to `100`.
+     * @param {string} [options.cursor] - The `nextCursor` from the previous page.
+     * @param {string} [options.types] - Comma-separated conversation types (e.g. `"public_channel,private_channel"`); defaults to `"public_channel,private_channel"`.
+     * @param {boolean} [options.excludeArchived] - Whether archived channels are excluded; defaults to `true`.
+     * @returns {Promise<{channels: SlackChannel[], nextCursor?: string}>} The page of channels and the cursor for the next page, when more pages exist.
+     * @throws {InternalError} When no token is configured or Slack rejects the call.
+     * @throws {NotFoundError} When Slack answers with HTTP 404.
+     * @throws {ConflictError} When Slack answers with HTTP 409.
+     * @throws {BadRequestError} When Slack answers with any other HTTP error status.
+     * @example
+     * ```ts
+     * let cursor: string | undefined;
+     * do {
+     *   const page = await slack.listConversations({ limit: 200, cursor });
+     *   console.log(page.channels.map((channel) => channel.name));
+     *   cursor = page.nextCursor;
+     * } while (cursor);
+     * ```
+     */
+    listConversations(options?: {
+        limit?: number;
+        cursor?: string;
+        types?: string;
+        excludeArchived?: boolean;
+    }): Promise<{
+        channels: SlackChannel[];
+        nextCursor?: string;
+    }>;
+    /**
+     * @description Fetches a single Slack conversation
+     * @summary Calls `conversations.info` for the given channel ID (or
+     * `#name`) and returns the normalized channel descriptor.
+     * @param {string} channel - The channel ID or `#name` to look up.
+     * @returns {Promise<SlackChannel>} The normalized conversation descriptor.
+     * @throws {InternalError} When no token is configured or Slack rejects the call.
+     * @throws {NotFoundError} When the channel does not exist (HTTP 404).
+     * @throws {ConflictError} When Slack answers with HTTP 409.
+     * @throws {BadRequestError} When Slack answers with any other HTTP error status.
+     */
+    getConversation(channel: string): Promise<SlackChannel>;
+    /**
+     * @description Fetches a Slack user profile
+     * @summary Calls `users.info` for the given user ID and returns the raw
+     * user payload, or `undefined` when Slack reports no user.
+     * @param {string} userId - The Slack user ID to look up (e.g. `"U12345678"`).
+     * @returns {Promise<Record<string, unknown> | undefined>} The raw user payload, or `undefined` when the user is not found.
+     * @throws {InternalError} When no token is configured or Slack rejects the call.
+     * @throws {NotFoundError} When the user does not exist (HTTP 404).
+     * @throws {ConflictError} When Slack answers with HTTP 409.
+     * @throws {BadRequestError} When Slack answers with any other HTTP error status.
+     */
+    getUser(userId: string): Promise<Record<string, unknown> | undefined>;
+}
+export {};