@decaf-ts/integrations 0.11.0 → 0.14.0

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

@@ -0,0 +1,287 @@
+import { HttpApiService, type HttpApiServiceConfig } from "../../shared/http/index.d.mts";
+/**
+ * @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[]>;
+}

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

@@ -0,0 +1,6 @@
+/**
+ * @module integrations/devops/github
+ * @summary GitHub REST v3 service (repositories, issues, pull requests).
+ * @description Re-exports the GitHub client-based service and its types.
+ */
+export * from "./GithubService.d.cts";

package/lib/types/devops/github/index.d.mts

@@ -0,0 +1,6 @@
+/**
+ * @module integrations/devops/github
+ * @summary GitHub REST v3 service (repositories, issues, pull requests).
+ * @description Re-exports the GitHub client-based service and its types.
+ */
+export * from "./GithubService.d.mts";

package/lib/types/devops/gitlab/GitlabService.d.cts

@@ -0,0 +1,277 @@
+import { HttpApiService, type HttpApiServiceConfig } from "../../shared/http/index.d.cts";
+/**
+ * @description Configuration for the GitLab service
+ * @summary Extends {@link HttpApiServiceConfig} with the GitLab personal
+ * access token (sent as the `PRIVATE-TOKEN` header) and the default
+ * `projectId` used when a call does not override it. When omitted, the
+ * `devops.gitlab` environment slice supplies the token (and optional
+ * `projectId`, `baseUrl`, `timeout`).
+ * @category DevOps
+ * @memberOf module:integrations/devops/gitlab/service
+ */
+export interface GitlabServiceConfig extends HttpApiServiceConfig {
+    /**
+     * @description GitLab personal access token
+     * @summary Sent as the `PRIVATE-TOKEN` header with every API call.
+     */
+    token?: string;
+    /**
+     * @description Default project ID used when a call does not override it
+     * @summary Accepts the URL-encoded project path or the numeric project ID.
+     */
+    projectId?: string;
+}
+/**
+ * @description Input for creating a GitLab issue
+ * @summary Carries the optional `projectId` override, the required issue
+ * `title`, and the optional description, comma-separated `labels`,
+ * `assigneeIds`, and `milestoneId`.
+ * @category DevOps
+ * @memberOf module:integrations/devops/gitlab/service
+ */
+export interface GitlabIssueInput {
+    /**
+     * @description Project ID for this call
+     * @summary Falls back to the configured `GitlabServiceConfig.projectId`.
+     */
+    projectId?: string;
+    /**
+     * @description Issue title (required by the GitLab API)
+     */
+    title: string;
+    /**
+     * @description Issue description in markdown
+     */
+    description?: string;
+    /**
+     * @description Comma-separated label names to apply
+     */
+    labels?: string;
+    /**
+     * @description GitLab user IDs to assign
+     */
+    assigneeIds?: number[];
+    /**
+     * @description Milestone ID to associate
+     */
+    milestoneId?: number;
+}
+/**
+ * @description Normalized GitLab issue descriptor
+ * @summary Maps the raw GitLab issue payload onto camelCase fields: identity
+ * (`iid`, `title`, `state`), `webUrl`, description and author, `labels`,
+ * and `createdAt`/`updatedAt` timestamps.
+ * @category DevOps
+ * @memberOf module:integrations/devops/gitlab/service
+ */
+export interface GitlabIssue {
+    projectId?: string;
+    iid: number;
+    title: string;
+    state?: string;
+    webUrl?: string;
+    description?: string;
+    author?: string;
+    labels?: string[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+/**
+ * @description Options for listing GitLab issues or merge requests
+ * @summary Carries the optional `projectId` override, the `state` filter, a
+ * page size (`limit`) and `page` number for paging, a comma-separated
+ * `labels` filter, and a `search` term. Merge-request listings pass the state
+ * through unchanged except for `"all"`, which GitLab models by omitting the
+ * parameter.
+ * @category DevOps
+ * @memberOf module:integrations/devops/gitlab/service
+ */
+export interface GitlabListOptions {
+    /**
+     * @description Project ID for this call
+     * @summary Falls back to the configured `GitlabServiceConfig.projectId`.
+     */
+    projectId?: string;
+    /**
+     * @description Issue/merge-request state filter
+     */
+    state?: "opened" | "closed" | "all";
+    /**
+     * @description Page size (GitLab'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 Search term matched against issue/merge-request titles and descriptions
+     */
+    search?: string;
+}
+/**
+ * @description GitLab REST API integration service
+ * @summary An undecorated HTTP service for looking up projects,
+ * listing issues, creating issues, commenting on issues (notes), and listing
+ * merge requests. Project targets resolve per call from the input's
+ * `projectId`, falling back to the configured value, and throw
+ * `InternalError` when unresolved. The token is sent as the `PRIVATE-TOKEN`
+ * header, and transport failures are mapped to decaf errors via
+ * {@link httpError}.
+ * @class GitlabService
+ * @category DevOps
+ * @example
+ * ```ts
+ * import { GitlabService } from "@decaf-ts/integrations/devops/gitlab";
+ *
+ * const gitlab = new GitlabService();
+ * await gitlab.initialize({
+ *   token: process.env.GRAPH_CREDENTIAL_GITLAB_TOKEN,
+ *   projectId: "example-org%2Fexample-repo",
+ * });
+ * const issue = await gitlab.createIssue({
+ *   title: "Bug report",
+ *   description: "Something is broken",
+ * });
+ * ```
+ * @memberOf module:integrations/devops/gitlab/service
+ */
+export declare class GitlabService extends HttpApiService<GitlabServiceConfig> {
+    /**
+     * @description The provider name used in error messages
+     */
+    protected readonly serviceName = "GitLab";
+    /**
+     * @description The GitLab REST v4 base URL
+     * @summary Used when the resolved config carries no `baseUrl`.
+     * @returns {string} `"https://gitlab.com/api/v4"`.
+     */
+    protected defaultBaseUrl(): string;
+    /**
+     * @description Builds the GitLab `PRIVATE-TOKEN` authorization headers
+     * @summary Returns the `PRIVATE-TOKEN: <token>` header when the config
+     * carries a token, and no headers otherwise.
+     * @param {GitlabServiceConfig} config - The resolved service configuration.
+     * @returns {Record<string, string>} The authorization headers (empty without a token).
+     */
+    protected authHeaders(config: GitlabServiceConfig): Record<string, string>;
+    /**
+     * @description Reads the GitLab credentials and defaults from the environment
+     * @summary Reads the `devops.gitlab` 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<GitlabServiceConfig> | undefined} A partial config, or `undefined` when no GitLab token is configured.
+     */
+    protected configFromEnvironment(): Partial<GitlabServiceConfig> | undefined;
+    /**
+     * @description Resolves the URL-encoded project path for a call
+     * @summary Builds `/projects/<projectId>` from the given project ID,
+     * falling back to the configured value, and throws when neither is
+     * available.
+     * @param {string} [projectId] - The per-call project override (URL-encoded path or numeric ID).
+     * @returns {string} The URL-encoded project API path.
+     * @throws {InternalError} When neither the input nor the config yields a project ID.
+     */
+    protected projectPath(projectId?: string): string;
+    /**
+     * @description Normalizes a raw GitLab issue payload
+     * @summary Maps the raw issue JSON onto a {@link GitlabIssue}: the author
+     * to its `username`, the label array to strings, and numeric/string fields
+     * are coerced. The project ID is echoed from the input, falling back to the
+     * configured value.
+     * @param {Record<string, unknown>} raw - The raw GitLab issue payload.
+     * @param {string} [projectId] - The project ID the issue belongs to.
+     * @returns {GitlabIssue} The normalized issue descriptor.
+     */
+    protected mapIssue(raw: Record<string, unknown>, projectId?: string): GitlabIssue;
+    /**
+     * @description Fetches a GitLab project
+     * @summary `GET`s `/projects/<projectId>` for the given ID (falling back to
+     * the configured `projectId`) and returns the raw project payload.
+     * @param {string} [projectId] - The project to look up; defaults to the configured `projectId`.
+     * @returns {Promise<unknown>} The raw GitLab project payload.
+     * @throws {InternalError} When the project ID cannot be resolved.
+     * @throws {NotFoundError} When the project does not exist (HTTP 404).
+     * @throws {ConflictError} When GitLab answers with HTTP 409.
+     * @throws {BadRequestError} When GitLab answers with any other HTTP error status.
+     */
+    getProject(projectId?: string): Promise<unknown>;
+    /**
+     * @description Lists GitLab issues with state, label, search, and page filtering
+     * @summary `GET`s `/projects/<projectId>/issues` with a `state` filter
+     * (default `"opened"`), a page size (`per_page`, default `30`), a page
+     * number, a comma-separated `labels` filter, and a `search` term.
+     * @param {GitlabListOptions} [options] - Project override, state, paging, label, and search options.
+     * @returns {Promise<GitlabIssue[]>} The normalized issues for the requested page.
+     * @throws {InternalError} When the project ID cannot be resolved.
+     * @throws {NotFoundError} When the project does not exist (HTTP 404).
+     * @throws {ConflictError} When GitLab answers with HTTP 409.
+     * @throws {BadRequestError} When GitLab answers with any other HTTP error status.
+     * @example
+     * ```ts
+     * const issues = await gitlab.listIssues({
+     *   projectId: "example-org%2Fexample-repo",
+     *   state: "opened",
+     *   labels: "bug,priority::high",
+     *   limit: 50,
+     *   page: 1,
+     * });
+     * ```
+     */
+    listIssues(options?: GitlabListOptions): Promise<GitlabIssue[]>;
+    /**
+     * @description Creates a GitLab issue
+     * @summary `POST`s the title, description, labels, assignee IDs, and
+     * milestone ID to `/projects/<projectId>/issues` and returns the normalized
+     * issue descriptor. Requires a non-empty `title` and a resolvable project
+     * ID.
+     * @param {GitlabIssueInput} input - The issue content and project targeting.
+     * @returns {Promise<GitlabIssue>} The normalized created issue.
+     * @throws {InternalError} When the title is empty or the project ID cannot be resolved.
+     * @throws {NotFoundError} When the project does not exist (HTTP 404).
+     * @throws {ConflictError} When GitLab answers with HTTP 409.
+     * @throws {BadRequestError} When GitLab answers with any other HTTP error status (e.g. invalid labels or assignees).
+     */
+    createIssue(input: GitlabIssueInput): Promise<GitlabIssue>;
+    /**
+     * @description Comments on a GitLab issue
+     * @summary `POST`s the comment body as a note to
+     * `/projects/<projectId>/issues/<iid>/notes` and returns the note
+     * identifier and its web URL. Requires a non-empty issue IID and body.
+     * @param {object} input - The comment target and body.
+     * @param {string} [input.projectId] - The project override; falls back to the configured `projectId`.
+     * @param {number} input.iid - The issue's project-scoped IID.
+     * @param {string} input.body - The comment body.
+     * @returns {Promise<{id: number, webUrl?: string}>} The created note's ID and web URL.
+     * @throws {InternalError} When the issue IID or body is empty, or the project ID cannot be resolved.
+     * @throws {NotFoundError} When the issue does not exist (HTTP 404).
+     * @throws {ConflictError} When GitLab answers with HTTP 409.
+     * @throws {BadRequestError} When GitLab answers with any other HTTP error status.
+     */
+    commentOnIssue(input: {
+        projectId?: string;
+        iid: number;
+        body: string;
+    }): Promise<{
+        id: number;
+        webUrl?: string;
+    }>;
+    /**
+     * @description Lists GitLab merge requests with state, search, and page filtering
+     * @summary `GET`s `/projects/<projectId>/merge_requests` with a `state`
+     * filter (default `"opened"`; `"all"` is sent as no state parameter),
+     * a page size (`per_page`, default `30`), a page number, and a `search`
+     * term. Merge requests are returned as raw GitLab payloads.
+     * @param {GitlabListOptions} [options] - Project override, state, paging, and search options.
+     * @returns {Promise<unknown[]>} The raw GitLab merge-request payloads.
+     * @throws {InternalError} When the project ID cannot be resolved.
+     * @throws {NotFoundError} When the project does not exist (HTTP 404).
+     * @throws {ConflictError} When GitLab answers with HTTP 409.
+     * @throws {BadRequestError} When GitLab answers with any other HTTP error status.
+     */
+    listMergeRequests(options?: GitlabListOptions): Promise<unknown[]>;
+}