@decaf-ts/integrations 0.11.0 → 0.14.0

package/lib/types/comms/whatsapp/WhatsAppService.d.mts

@@ -0,0 +1,258 @@
+import { HttpApiService, type HttpApiServiceConfig } from "../../shared/http/index.d.mts";
+/**
+ * @description Configuration for the WhatsApp service
+ * @summary Extends {@link HttpApiServiceConfig} with the Meta access token
+ * (sent as a bearer token) and the sender `phoneNumberId` used in the
+ * `/messages` path. When omitted, the `comms.whatsApp` environment slice
+ * supplies both (plus optional `baseUrl`/`timeout`). Both values are
+ * credential references, never literals in source.
+ * @category Comms
+ * @memberOf module:integrations/comms/whatsapp/service
+ */
+export interface WhatsAppServiceConfig extends HttpApiServiceConfig {
+    /**
+     * @description Meta WhatsApp Cloud API access token
+     * @summary Sent as `Authorization: Bearer <token>` with every API call.
+     */
+    token?: string;
+    /**
+     * @description Sender phone number ID used in the messages path
+     */
+    phoneNumberId?: string;
+}
+/**
+ * @description Input for sending a WhatsApp text message
+ * @summary Carries the recipient (`to`, E.164 digits without `+`), the text
+ * body, and whether link previews are generated.
+ * @category Comms
+ * @memberOf module:integrations/comms/whatsapp/service
+ */
+export interface WhatsAppTextInput {
+    /**
+     * @description Recipient phone number in international format
+     */
+    to: string;
+    /**
+     * @description Text message body
+     */
+    text: string;
+    /**
+     * @description Whether WhatsApp generates a link preview
+     */
+    previewUrl?: boolean;
+}
+/**
+ * @description Input for sending a WhatsApp template message
+ * @summary Carries the recipient, the approved `templateName`, its
+ * `languageCode`, and optional template `components`.
+ * @category Comms
+ * @memberOf module:integrations/comms/whatsapp/service
+ */
+export interface WhatsAppTemplateInput {
+    /**
+     * @description Recipient phone number in international format
+     */
+    to: string;
+    /**
+     * @description Name of the approved message template
+     */
+    templateName: string;
+    /**
+     * @description Template language code (e.g. `"en_US"`)
+     */
+    languageCode: string;
+    /**
+     * @description Optional template components (header/body/button parameters)
+     */
+    components?: unknown[];
+}
+/**
+ * @description Supported WhatsApp media message types
+ * @summary The media kinds the Cloud API accepts in the message `type` field.
+ * @category Comms
+ * @memberOf module:integrations/comms/whatsapp/service
+ */
+export type WhatsAppMediaType = "image" | "audio" | "video" | "document";
+/**
+ * @description Input for sending a WhatsApp media message
+ * @summary Carries the recipient, the media `type`, and either a previously
+ * uploaded `mediaId` or a public `link` (one is required), plus an optional
+ * `caption` and `filename`.
+ * @category Comms
+ * @memberOf module:integrations/comms/whatsapp/service
+ */
+export interface WhatsAppMediaInput {
+    /**
+     * @description Recipient phone number in international format
+     */
+    to: string;
+    /**
+     * @description Media kind sent in the message `type` field
+     */
+    type: WhatsAppMediaType;
+    /**
+     * @description ID of previously uploaded WhatsApp media
+     */
+    mediaId?: string;
+    /**
+     * @description Public URL of the media (alternative to `mediaId`)
+     */
+    link?: string;
+    /**
+     * @description Optional caption (images, videos, documents)
+     */
+    caption?: string;
+    /**
+     * @description Optional filename (documents)
+     */
+    filename?: string;
+}
+/**
+ * @description Input for marking a WhatsApp message as read
+ * @summary Carries the inbound `messageId` to acknowledge.
+ * @category Comms
+ * @memberOf module:integrations/comms/whatsapp/service
+ */
+export interface WhatsAppReadInput {
+    /**
+     * @description ID of the inbound message to mark read
+     */
+    messageId: string;
+}
+/**
+ * @description WhatsApp Cloud API integration service
+ * @summary An undecorated HTTP service for text, template, and media
+ * messages, read receipts, and media metadata. Every message operation needs
+ * both the access token and the sender phone number ID; missing credentials or
+ * identifiers raise `InternalError`, and transport failures are mapped to decaf
+ * errors via {@link httpError}.
+ * @class WhatsAppService
+ * @extends HttpApiService
+ * @category Comms
+ * @example
+ * ```ts
+ * import { WhatsAppService } from "@decaf-ts/integrations/comms/whatsapp";
+ *
+ * const whatsapp = new WhatsAppService();
+ * await whatsapp.initialize({
+ *   token: process.env.GRAPH_CREDENTIAL_WHATSAPP_TOKEN,
+ *   phoneNumberId: process.env.WHATSAPP_PHONE_NUMBER_ID,
+ * });
+ * await whatsapp.sendText({ to: "15551234567", text: "Hello" });
+ * ```
+ * @mermaid
+ * sequenceDiagram
+ *   autonumber
+ *   participant Caller
+ *   participant Service as WhatsAppService
+ *   participant Graph as WhatsApp Cloud API
+ *   Caller->>Service: sendText(input)
+ *   activate Service
+ *   Service->>Service: requireTokenAndPhone()
+ *   Service->>Graph: POST /{phoneNumberId}/messages
+ *   activate Graph
+ *   Graph-->>Service: message payload
+ *   deactivate Graph
+ *   Service-->>Caller: message payload
+ *   deactivate Service
+ * @memberOf module:integrations/comms/whatsapp/service
+ */
+export declare class WhatsAppService extends HttpApiService<WhatsAppServiceConfig> {
+    /**
+     * @description The provider name used in error messages
+     */
+    protected readonly serviceName = "WhatsApp";
+    /**
+     * @description The WhatsApp Cloud API base URL
+     * @summary Used when the resolved config carries no `baseUrl`.
+     * @returns {string} `"https://graph.facebook.com/v19.0"`.
+     */
+    protected defaultBaseUrl(): string;
+    /**
+     * @description Builds the WhatsApp bearer authorization headers
+     * @summary Returns `Authorization: Bearer <token>` when configured, and no
+     * headers otherwise.
+     * @param {WhatsAppServiceConfig} config - The resolved service configuration.
+     * @returns {Record<string, string>} The authorization headers (empty without a token).
+     */
+    protected authHeaders(config: WhatsAppServiceConfig): Record<string, string>;
+    /**
+     * @description Reads the WhatsApp credentials and defaults from the environment
+     * @summary Reads the `comms.whatsApp` slice and returns a partial config
+     * when a token or phone number ID is configured, `undefined` otherwise.
+     * Values pass through `envString`/`envNumber` to reject unset-leaf proxies.
+     * @returns {Partial<WhatsAppServiceConfig> | undefined} A partial config, or `undefined` when neither credential is configured.
+     */
+    protected configFromEnvironment(): Partial<WhatsAppServiceConfig> | undefined;
+    /**
+     * @description Asserts the access token and sender phone number ID
+     * @summary Calls `requireToken()` and returns the configured
+     * `phoneNumberId` used to build the messages path.
+     * @returns {string} The configured sender phone number ID.
+     * @throws {InternalError} When no token or phone number ID is configured.
+     */
+    protected requireTokenAndPhone(): string;
+    /**
+     * @description Builds the encoded messages path for a sender
+     * @summary Encodes the phone number ID into `/<id>/messages`.
+     * @param {string} phoneNumberId - The sender phone number ID.
+     * @returns {string} The messages API path.
+     */
+    private messagesPath;
+    /**
+     * @description Sends a WhatsApp text message
+     * @summary `POST`s a `text` message to the sender's `/messages` endpoint
+     * and returns the WhatsApp message payload.
+     * @param {WhatsAppTextInput} input - The recipient, text, and preview flag.
+     * @returns {Promise<unknown>} The WhatsApp message payload.
+     * @throws {InternalError} When credentials or the phone number ID are missing.
+     * @throws {BadRequestError} When WhatsApp rejects the message.
+     * @example
+     * ```ts
+     * await whatsapp.sendText({ to: "15551234567", text: "Deployment finished" });
+     * ```
+     */
+    sendText(input: WhatsAppTextInput): Promise<unknown>;
+    /**
+     * @description Sends a WhatsApp template message
+     * @summary `POST`s a `template` message referencing an approved template
+     * name and language, with optional components.
+     * @param {WhatsAppTemplateInput} input - The recipient and template definition.
+     * @returns {Promise<unknown>} The WhatsApp message payload.
+     * @throws {InternalError} When credentials or the phone number ID are missing.
+     * @throws {BadRequestError} When WhatsApp rejects the template message.
+     */
+    sendTemplate(input: WhatsAppTemplateInput): Promise<unknown>;
+    /**
+     * @description Sends a WhatsApp media message
+     * @summary `POST`s an `image`/`audio`/`video`/`document` message using
+     * either an uploaded `mediaId` or a public `link`, with optional caption and
+     * filename.
+     * @param {WhatsAppMediaInput} input - The recipient and media reference.
+     * @returns {Promise<unknown>} The WhatsApp message payload.
+     * @throws {InternalError} When credentials or the phone number ID are missing, or neither `mediaId` nor `link` is provided.
+     * @throws {BadRequestError} When WhatsApp rejects the media message.
+     */
+    sendMedia(input: WhatsAppMediaInput): Promise<unknown>;
+    /**
+     * @description Marks an inbound WhatsApp message as read
+     * @summary `POST`s a `read` status for the message to the sender's
+     * `/messages` endpoint.
+     * @param {WhatsAppReadInput} input - The inbound message ID to acknowledge.
+     * @returns {Promise<unknown>} The WhatsApp status payload.
+     * @throws {InternalError} When credentials, the phone number ID, or the message ID are missing.
+     * @throws {BadRequestError} When WhatsApp rejects the request.
+     */
+    markAsRead(input: WhatsAppReadInput): Promise<unknown>;
+    /**
+     * @description Fetches WhatsApp media metadata
+     * @summary `GET`s the media descriptor (URL, MIME type, size) by media ID;
+     * the descriptor's URL is then used to download the binary.
+     * @param {string} mediaId - The WhatsApp media ID.
+     * @returns {Promise<unknown>} The media metadata payload.
+     * @throws {InternalError} When no token is configured or the media ID is empty.
+     * @throws {NotFoundError} When the media does not exist (HTTP 404).
+     * @throws {BadRequestError} When WhatsApp rejects the request.
+     */
+    getMedia(mediaId: string): Promise<unknown>;
+}

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

@@ -0,0 +1 @@
+export * from "./WhatsAppService.d.cts";

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

@@ -0,0 +1 @@
+export * from "./WhatsAppService.d.mts";

package/lib/types/devops/environment.d.cts

@@ -0,0 +1,62 @@
+/**
+ * @module integrations/devops/environment
+ * @summary Environment contract and accumulated environment for the devops integration services.
+ * @description Declares the `DevopsEnvironmentShape` consumed by the GitHub and
+ * GitLab services' `configFromEnvironment()` implementations and the
+ * `DevopsEnvironment` singleton created via `LoggedEnvironment.accumulate`.
+ * Services read their credentials and defaults from the matching
+ * `devops.<provider>` slice, using the `envString`/`envNumber` helpers from
+ * `shared/environmentValue` to reject unset-leaf proxies.
+ */
+/**
+ * @description Environment shape for the devops integration services
+ * @summary Defines the `devops` root with one slice per provider (`github`,
+ * `gitlab`). Each slice carries the provider's required `token` and defaults
+ * (`owner`/`repo` for GitHub, `projectId` for GitLab) plus an optional
+ * `baseUrl` override and `timeout`. Fields are typed as required here so
+ * `LoggedEnvironment.accumulate` registers them; absent values resolve to
+ * proxy placeholders at runtime and must pass through `envString`/`envNumber`.
+ * @memberOf module:integrations/devops/environment
+ */
+export interface DevopsEnvironmentShape {
+    devops: {
+        github: {
+            token: string;
+            baseUrl: string;
+            owner: string;
+            repo: string;
+            timeout?: number;
+        };
+        gitlab: {
+            token: string;
+            baseUrl: string;
+            projectId: string;
+            timeout?: number;
+        };
+    };
+}
+/**
+ * @description Accumulated devops environment singleton
+ * @summary The `LoggedEnvironment.accumulate`-registered instance backing the
+ * `DevopsEnvironmentShape` contract. Devops services read their provider
+ * slice (e.g. `DevopsEnvironment.devops.github`) inside
+ * `configFromEnvironment()` and translate it into an
+ * `HttpApiServiceConfig`-derived config. Credentials come from environment
+ * variables; for as-graph node usage those are provided as
+ * `GRAPH_CREDENTIAL_*` values (placeholders in this example).
+ * @example
+ * ```ts
+ * import { GithubService } from "@decaf-ts/integrations/devops/github";
+ *
+ * // with devops.github.token / devops.github.owner / devops.github.repo configured
+ * const github = new GithubService();
+ * await github.initialize();
+ * ```
+ * @constant {LoggedEnvironment} DevopsEnvironment
+ * @memberOf module:integrations/devops/environment
+ */
+export declare const DevopsEnvironment: import("@decaf-ts/logging").AccumulatedEnvironment<{
+    app: string | undefined;
+} & import("@decaf-ts/logging").LoggingConfig<object> & {
+    env: any;
+} & DevopsEnvironmentShape>;

package/lib/types/devops/environment.d.mts

@@ -0,0 +1,62 @@
+/**
+ * @module integrations/devops/environment
+ * @summary Environment contract and accumulated environment for the devops integration services.
+ * @description Declares the `DevopsEnvironmentShape` consumed by the GitHub and
+ * GitLab services' `configFromEnvironment()` implementations and the
+ * `DevopsEnvironment` singleton created via `LoggedEnvironment.accumulate`.
+ * Services read their credentials and defaults from the matching
+ * `devops.<provider>` slice, using the `envString`/`envNumber` helpers from
+ * `shared/environmentValue` to reject unset-leaf proxies.
+ */
+/**
+ * @description Environment shape for the devops integration services
+ * @summary Defines the `devops` root with one slice per provider (`github`,
+ * `gitlab`). Each slice carries the provider's required `token` and defaults
+ * (`owner`/`repo` for GitHub, `projectId` for GitLab) plus an optional
+ * `baseUrl` override and `timeout`. Fields are typed as required here so
+ * `LoggedEnvironment.accumulate` registers them; absent values resolve to
+ * proxy placeholders at runtime and must pass through `envString`/`envNumber`.
+ * @memberOf module:integrations/devops/environment
+ */
+export interface DevopsEnvironmentShape {
+    devops: {
+        github: {
+            token: string;
+            baseUrl: string;
+            owner: string;
+            repo: string;
+            timeout?: number;
+        };
+        gitlab: {
+            token: string;
+            baseUrl: string;
+            projectId: string;
+            timeout?: number;
+        };
+    };
+}
+/**
+ * @description Accumulated devops environment singleton
+ * @summary The `LoggedEnvironment.accumulate`-registered instance backing the
+ * `DevopsEnvironmentShape` contract. Devops services read their provider
+ * slice (e.g. `DevopsEnvironment.devops.github`) inside
+ * `configFromEnvironment()` and translate it into an
+ * `HttpApiServiceConfig`-derived config. Credentials come from environment
+ * variables; for as-graph node usage those are provided as
+ * `GRAPH_CREDENTIAL_*` values (placeholders in this example).
+ * @example
+ * ```ts
+ * import { GithubService } from "@decaf-ts/integrations/devops/github";
+ *
+ * // with devops.github.token / devops.github.owner / devops.github.repo configured
+ * const github = new GithubService();
+ * await github.initialize();
+ * ```
+ * @constant {LoggedEnvironment} DevopsEnvironment
+ * @memberOf module:integrations/devops/environment
+ */
+export declare const DevopsEnvironment: import("@decaf-ts/logging").AccumulatedEnvironment<{
+    app: string | undefined;
+} & import("@decaf-ts/logging").LoggingConfig<object> & {
+    env: any;
+} & DevopsEnvironmentShape>;

package/lib/types/devops/github/GithubService.d.cts

@@ -0,0 +1,287 @@
+import { HttpApiService, type HttpApiServiceConfig } from "../../shared/http/index.d.cts";
+/**
+ * @description Configuration for the GitHub service
+ * @summary Extends {@link HttpApiServiceConfig} with the GitHub personal
+ * access token (sent as a bearer token with the GitHub API version headers)
+ * and the default `owner`/`repo` used when a call does not override them.
+ * When omitted, the `devops.github` environment slice supplies the token
+ * (and optional `owner`, `repo`, `baseUrl`, `timeout`).
+ * @category DevOps
+ * @memberOf module:integrations/devops/github/service
+ */
+export interface GithubServiceConfig extends HttpApiServiceConfig {
+    /**
+     * @description GitHub personal access token
+     * @summary Sent as `Authorization: Bearer <token>` with every API call.
+     */
+    token?: string;
+    /**
+     * @description Default repository owner used when a call does not override it
+     */
+    owner?: string;
+    /**
+     * @description Default repository name used when a call does not override it
+     */
+    repo?: string;
+}
+/**
+ * @description Repository targeting reference
+ * @summary Carries the optional `owner`/`repo` override for a single call;
+ * when either field is omitted the service falls back to the configured
+ * `GithubServiceConfig.owner`/`repo`. Operations that cannot resolve both
+ * values throw `InternalError`.
+ * @category DevOps
+ * @memberOf module:integrations/devops/github/service
+ */
+export interface GithubRepositoryRef {
+    /**
+     * @description Repository owner for this call
+     */
+    owner?: string;
+    /**
+     * @description Repository name for this call
+     */
+    repo?: string;
+}
+/**
+ * @description Input for creating a GitHub issue
+ * @summary Extends {@link GithubRepositoryRef} with the required issue
+ * `title` and the optional body, labels, assignees, and milestone number.
+ * @category DevOps
+ * @memberOf module:integrations/devops/github/service
+ */
+export interface GithubIssueInput extends GithubRepositoryRef {
+    /**
+     * @description Issue title (required by the GitHub API)
+     */
+    title: string;
+    /**
+     * @description Issue body in markdown
+     */
+    body?: string;
+    /**
+     * @description Label names to apply
+     */
+    labels?: string[];
+    /**
+     * @description Usernames to assign
+     */
+    assignees?: string[];
+    /**
+     * @description Milestone number to associate
+     */
+    milestone?: number;
+}
+/**
+ * @description Normalized GitHub issue descriptor
+ * @summary Maps the raw GitHub issue payload onto camelCase fields: identity
+ * (`number`, `title`, `state`), `htmlUrl`, body and author, `labels` (label
+ * names only), `comments` count, and `createdAt`/`updatedAt` timestamps.
+ * Pull requests returned by the issues endpoint are filtered out.
+ * @category DevOps
+ * @memberOf module:integrations/devops/github/service
+ */
+export interface GithubIssue extends GithubRepositoryRef {
+    number: number;
+    title: string;
+    state?: string;
+    htmlUrl?: string;
+    body?: string;
+    user?: string;
+    labels?: string[];
+    comments?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/**
+ * @description Options for listing GitHub issues or pull requests
+ * @summary Extends {@link GithubRepositoryRef} with the issue/PR `state`
+ * filter, a page size (`limit`) and `page` number for paging, and a
+ * comma-separated `labels` filter applied to issue listings.
+ * @category DevOps
+ * @memberOf module:integrations/devops/github/service
+ */
+export interface GithubListOptions extends GithubRepositoryRef {
+    /**
+     * @description Issue/PR state filter
+     */
+    state?: "open" | "closed" | "all";
+    /**
+     * @description Page size (GitHub's `per_page`); defaults to `30`
+     */
+    limit?: number;
+    /**
+     * @description Page number to request
+     */
+    page?: number;
+    /**
+     * @description Comma-separated label names to filter issues by
+     */
+    labels?: string;
+}
+/**
+ * @description GitHub REST API integration service
+ * @summary An undecorated HTTP service for looking up
+ * repositories, listing issues (excluding pull requests), creating issues,
+ * commenting on issues, and listing pull requests. Repository targets resolve
+ * per call from the input's `owner`/`repo`, falling back to the configured
+ * config values, and throw `InternalError` when unresolved. The token is sent
+ * as a bearer token with the GitHub `Accept` and API-version headers, and
+ * transport failures are mapped to decaf errors via {@link httpError}.
+ * @class GithubService
+ * @category DevOps
+ * @example
+ * ```ts
+ * import { GithubService } from "@decaf-ts/integrations/devops/github";
+ *
+ * const github = new GithubService();
+ * await github.initialize({
+ *   token: process.env.GRAPH_CREDENTIAL_GITHUB_TOKEN,
+ *   owner: "example-org",
+ *   repo: "example-repo",
+ * });
+ * const issue = await github.createIssue({
+ *   title: "Bug report",
+ *   body: "Something is broken",
+ *   labels: ["bug"],
+ * });
+ * ```
+ * @memberOf module:integrations/devops/github/service
+ */
+export declare class GithubService extends HttpApiService<GithubServiceConfig> {
+    /**
+     * @description The provider name used in error messages
+     */
+    protected readonly serviceName = "GitHub";
+    /**
+     * @description The GitHub REST API base URL
+     * @summary Used when the resolved config carries no `baseUrl`.
+     * @returns {string} `"https://api.github.com"`.
+     */
+    protected defaultBaseUrl(): string;
+    /**
+     * @description Builds the GitHub authentication and API version headers
+     * @summary Returns `Authorization: Bearer <token>`, the GitHub JSON
+     * `Accept` header, and the `X-GitHub-Api-Version` header when the config
+     * carries a token; without a token only the `Accept` headers are sent.
+     * @param {GithubServiceConfig} config - The resolved service configuration.
+     * @returns {Record<string, string>} The authorization and version headers.
+     */
+    protected authHeaders(config: GithubServiceConfig): Record<string, string>;
+    /**
+     * @description Reads the GitHub credentials and defaults from the environment
+     * @summary Reads the `devops.github` 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<GithubServiceConfig> | undefined} A partial config, or `undefined` when no GitHub token is configured.
+     */
+    protected configFromEnvironment(): Partial<GithubServiceConfig> | undefined;
+    /**
+     * @description Resolves the URL-encoded repository path for a call
+     * @summary Builds `/repos/<owner>/<repo>` from the input's `owner`/`repo`,
+     * falling back to the configured config values, and throws when either
+     * value is missing.
+     * @param {GithubRepositoryRef} [input] - The per-call repository override.
+     * @returns {string} The URL-encoded repository API path.
+     * @throws {InternalError} When neither the input nor the config yields an owner and repository.
+     */
+    protected repoPath(input?: GithubRepositoryRef): string;
+    /**
+     * @description Normalizes a raw GitHub issue payload
+     * @summary Maps the raw issue JSON onto a {@link GithubIssue}: label objects
+     * are reduced to names, the author to its `login`, and numeric/string
+     * fields are coerced. The repository reference is echoed from the input,
+     * falling back to the configured `owner`/`repo`.
+     * @param {Record<string, unknown>} raw - The raw GitHub issue payload.
+     * @param {GithubRepositoryRef} ref - The repository reference the issue belongs to.
+     * @returns {GithubIssue} The normalized issue descriptor.
+     */
+    protected mapIssue(raw: Record<string, unknown>, ref: GithubRepositoryRef): GithubIssue;
+    /**
+     * @description Fetches a GitHub repository
+     * @summary `GET`s `/repos/<owner>/<repo>` for the given reference (falling
+     * back to the configured `owner`/`repo`) and returns the raw repository
+     * payload.
+     * @param {GithubRepositoryRef} [ref] - The repository to look up; defaults to the configured `owner`/`repo`.
+     * @returns {Promise<unknown>} The raw GitHub repository payload.
+     * @throws {InternalError} When the repository reference cannot be resolved.
+     * @throws {NotFoundError} When the repository does not exist (HTTP 404).
+     * @throws {ConflictError} When GitHub answers with HTTP 409.
+     * @throws {BadRequestError} When GitHub answers with any other HTTP error status.
+     */
+    getRepository(ref?: GithubRepositoryRef): Promise<unknown>;
+    /**
+     * @description Lists GitHub issues with state, label, and page filtering
+     * @summary `GET`s `/repos/<owner>/<repo>/issues` with a `state` filter
+     * (default `"open"`), a page size (`per_page`, default `30`), a page
+     * number, and a comma-separated `labels` filter. Entries carrying a
+     * `pull_request` key are filtered out so only true issues are returned.
+     * @param {GithubListOptions} [options] - Repository override, state, paging, and label options.
+     * @returns {Promise<GithubIssue[]>} The normalized issues for the requested page.
+     * @throws {InternalError} When the repository reference cannot be resolved.
+     * @throws {NotFoundError} When the repository does not exist (HTTP 404).
+     * @throws {ConflictError} When GitHub answers with HTTP 409.
+     * @throws {BadRequestError} When GitHub answers with any other HTTP error status.
+     * @example
+     * ```ts
+     * let page = 1;
+     * for (;;) {
+     *   const issues = await github.listIssues({
+     *     state: "open",
+     *     labels: "bug,priority:high",
+     *     limit: 50,
+     *     page,
+     *   });
+     *   if (issues.length === 0) break;
+     *   page += 1;
+     * }
+     * ```
+     */
+    listIssues(options?: GithubListOptions): Promise<GithubIssue[]>;
+    /**
+     * @description Creates a GitHub issue
+     * @summary `POST`s the title, body, labels, assignees, and milestone to
+     * `/repos/<owner>/<repo>/issues` and returns the normalized issue
+     * descriptor. Requires a non-empty `title` and a resolvable repository
+     * reference.
+     * @param {GithubIssueInput} input - The issue content and repository targeting.
+     * @returns {Promise<GithubIssue>} The normalized created issue.
+     * @throws {InternalError} When the title is empty or the repository reference cannot be resolved.
+     * @throws {NotFoundError} When the repository does not exist (HTTP 404).
+     * @throws {ConflictError} When GitHub answers with HTTP 409.
+     * @throws {BadRequestError} When GitHub answers with any other HTTP error status (e.g. invalid labels or assignees).
+     */
+    createIssue(input: GithubIssueInput): Promise<GithubIssue>;
+    /**
+     * @description Comments on a GitHub issue
+     * @summary `POST`s the comment body to
+     * `/repos/<owner>/<repo>/issues/<number>/comments` and returns the comment
+     * identifier and its HTML URL. Requires a non-empty issue number and body.
+     * @param {GithubRepositoryRef & {number: number, body: string}} input - The repository targeting, issue number, and comment body.
+     * @returns {Promise<{id: number, htmlUrl?: string}>} The created comment's ID and HTML URL.
+     * @throws {InternalError} When the issue number or body is empty, or the repository reference cannot be resolved.
+     * @throws {NotFoundError} When the issue does not exist (HTTP 404).
+     * @throws {ConflictError} When GitHub answers with HTTP 409.
+     * @throws {BadRequestError} When GitHub answers with any other HTTP error status.
+     */
+    commentOnIssue(input: GithubRepositoryRef & {
+        number: number;
+        body: string;
+    }): Promise<{
+        id: number;
+        htmlUrl?: string;
+    }>;
+    /**
+     * @description Lists GitHub pull requests with state and page filtering
+     * @summary `GET`s `/repos/<owner>/<repo>/pulls` with a `state` filter
+     * (default `"open"`), a page size (`per_page`, default `30`), and a page
+     * number. Pull requests are returned as raw GitHub payloads.
+     * @param {GithubListOptions} [options] - Repository override, state, and paging options.
+     * @returns {Promise<unknown[]>} The raw GitHub pull-request payloads.
+     * @throws {InternalError} When the repository reference cannot be resolved.
+     * @throws {NotFoundError} When the repository does not exist (HTTP 404).
+     * @throws {ConflictError} When GitHub answers with HTTP 409.
+     * @throws {BadRequestError} When GitHub answers with any other HTTP error status.
+     */
+    listPullRequests(options?: GithubListOptions): Promise<unknown[]>;
+}