@gitkraken/provider-apis 0.45.0 → 0.46.0

package/dist/providers/gitlab/gitlab.d.ts

@@ -1,4 +1,4 @@
-import { Account, CursorPageInput, EnterpriseOptions, GetRepoErrorData, GetRepoInput, GetReposInput, GitLabel, GitMergeStrategy, GitPullRequest, GitRepository, GitTreeItem, NumberedPageInput, SetAccountInput, SetLabelInput, SetMilestoneInput, SetPullRequestInput } from '../../types/exportedTypes/gitProvider';
+import { Account, AddInlineCommentInput, CursorPageInput, DeleteCommentInput, EditCommentInput, EnterpriseOptions, GetMergeBaseInput, GetRepoErrorData, GetRepoInput, GetReposInput, GitComment, GitLabel, GitMergeStrategy, GitPullRequest, GitPullRequestReview, GitRepository, GitTreeItem, NumberedPageInput, ResolveReviewThreadInput, SetAccountInput, SetLabelInput, SetMilestoneInput, SetPullRequestInput } from '../../types/exportedTypes/gitProvider';
 import { GitLabGetIssueInput, PullRequestAssociation } from '../../types/exportedTypes/gitlab';
 import { Issue, SetIssueInput } from '../../types/exportedTypes/issueProvider';
 import { GitProvider } from '../gitProvider';
@@ -307,4 +307,137 @@ export declare class GitLab extends EnterpriseProvider implements GitProvider, I
             hasNextPage: boolean;
         };
     }>;
+    /**
+     * Returns a single merge request by repo and IID, normalized to the {@link GitPullRequest} shape.
+     * Returns `{ data: null }` if the merge request (or repo) is not found (404). Network/5xx errors are thrown.
+     */
+    getPullRequestForRepo(input: {
+        repo: GetRepoInput;
+        number: number;
+    }, options?: EnterpriseOptions): Promise<{
+        data: GitPullRequest | null;
+    }>;
+    /**
+     * Returns the raw contents of a file at the given ref as a {@link Blob}.
+     * Matches the {@link GitHub.getFileContents} contract — call `.text()` for text files; binary files are preserved.
+     */
+    getFileContents(input: {
+        repo: GetRepoInput;
+        path: string;
+        ref: string;
+    }, options?: EnterpriseOptions): Promise<{
+        data: Blob;
+    }>;
+    /**
+     * Returns the top-level notes on a merge request — i.e. comments not attached to a diff line.
+     * System notes (state changes, label updates, etc.) and inline diff notes are excluded.
+     * Inline notes are surfaced via {@link GitLab.getReviewsForPullRequest} instead.
+     *
+     * GitLab REST uses `page` / `per_page` for pagination, so the {@link CursorPageInput.cursor} is a base64-encoded
+     * `{ page, perPage }` object. An empty/undefined cursor starts at page 1 with `per_page = MAX_PAGE_SIZE`.
+     */
+    getCommentsForPullRequest(input: {
+        repo: GetRepoInput;
+        pullRequestNumber: number;
+    } & CursorPageInput, options?: EnterpriseOptions): Promise<{
+        data: GitComment[];
+        pageInfo: {
+            endCursor: string | null;
+            hasNextPage: boolean;
+        };
+    }>;
+    /**
+     * Synthesizes a {@link GitPullRequestReview} array from GitLab approvals and diff discussions.
+     *
+     * GitLab does not natively model "reviews" the way GitHub does, so we emit:
+     *  - one review per approver (body `''`, no review comments), and
+     *  - one review per diff discussion (author/body from the first note; review comments mapped from all
+     *    notes in the discussion, replies become {@link GitComment}s on the first review comment).
+     *
+     * Top-level (non-diff) notes are NOT included here; they are returned by {@link GitLab.getCommentsForPullRequest}.
+     */
+    getReviewsForPullRequest(input: {
+        repo: GetRepoInput;
+        pullRequestId: number;
+    }, options?: EnterpriseOptions): Promise<{
+        data: GitPullRequestReview[];
+    }>;
+    /**
+     * Returns the merge request's changes as a single unified diff string, matching the
+     * {@link AzureDevOps.getPullRequestDiff} contract so the PR viewer can render GitLab MRs the same way.
+     *
+     * Pages through GitLab's REST `/merge_requests/:iid/diffs` endpoint (per-file diff entries) and assembles a
+     * git-style unified diff by prepending the appropriate `diff --git`, mode, rename, and `---`/`+++` headers to
+     * each entry's `diff` payload.
+     *
+     * Binary or otherwise empty diffs are emitted as a header-only stanza (no `---`/`+++` lines) so the resulting
+     * string remains a valid concatenation of git diff records.
+     */
+    getPullRequestDiff(input: {
+        repo: GetRepoInput;
+        pullRequestId: number;
+    }, options?: EnterpriseOptions): Promise<string>;
+    /**
+     * Returns the merge base SHA of two refs, matching the {@link GitHub.getMergeBase} contract.
+     * Uses GitLab's REST `/repository/merge_base` endpoint, which accepts two refs and returns the commit object
+     * for their merge base. Throws if no merge base exists between the two refs.
+     */
+    getMergeBase(input: GetMergeBaseInput, options?: EnterpriseOptions): Promise<{
+        data: string;
+    }>;
+    private fetchAllMergeRequestDiscussions;
+    private fetchAllPagedGitLabREST;
+    addCommentToPullRequest(input: {
+        pullRequest: SetPullRequestInput;
+        comment: string;
+    }, options?: EnterpriseOptions): Promise<void>;
+    /**
+     * Adds an inline (diff) comment to a merge request. When `threadId` is set the note is appended
+     * to that discussion; otherwise a new discussion is created, which requires the MR's `diff_refs`
+     * and so costs an extra `GET /merge_requests/:iid`. Returns the new note's composite ID.
+     */
+    addInlineCommentToPullRequest(input: AddInlineCommentInput, options?: EnterpriseOptions): Promise<string | undefined>;
+    private getNoteUrl;
+    private deleteNote;
+    deleteComment(input: DeleteCommentInput, options?: EnterpriseOptions): Promise<void>;
+    deleteInlineComment(input: DeleteCommentInput, options?: EnterpriseOptions): Promise<void>;
+    private editNote;
+    editComment(input: EditCommentInput, options?: EnterpriseOptions): Promise<void>;
+    editInlineComment(input: EditCommentInput, options?: EnterpriseOptions): Promise<void>;
+    resolveReviewThread(input: ResolveReviewThreadInput, options?: EnterpriseOptions): Promise<void>;
+    unresolveReviewThread(input: ResolveReviewThreadInput, options?: EnterpriseOptions): Promise<void>;
+    private setReviewThreadResolved;
+    /**
+     * Approves the merge request and, if a comment is provided, posts it as a top-level note.
+     *
+     * The approval is issued first so that a subsequent failure to post the note does not leave the MR in an
+     * inconsistent "approved but no rationale posted" rollback state. If the note POST fails the approval stays
+     * in place and the error is thrown to the caller.
+     */
+    approvePullRequest(input: {
+        pullRequest: SetPullRequestInput;
+        comment?: string;
+    }, options?: EnterpriseOptions): Promise<void>;
+    /**
+     * Posts a top-level note on a merge request. For GitLab this is the same endpoint and payload as
+     * {@link GitLab.addCommentToPullRequest}; exposed under the GitHub-parity name so callers can treat
+     * approve / request-changes / comment as three uniform review actions.
+     */
+    commentOnPullRequest(input: {
+        pullRequest: SetPullRequestInput;
+        comment: string;
+    }, options?: EnterpriseOptions): Promise<void>;
+    /**
+     * Marks the merge request as "Changes requested" by the caller and posts the comment as a note.
+     *
+     * Prefers GitLab's native `mergeRequestRequestChanges` GraphQL mutation (Premium/Ultimate, GA 17.2+).
+     * When the mutation isn't in the schema, falls back to clearing any standing approval from the caller
+     * so the MR isn't left "Approved" alongside the "Request changes" intent.
+     */
+    requestPullRequestChanges(input: {
+        pullRequest: SetPullRequestInput;
+        comment: string;
+    }, options?: EnterpriseOptions): Promise<void>;
+    private tryRequestChangesMutation;
+    private postMergeRequestNote;
 }

package/dist/types/exportedTypes/gitProvider.d.ts

@@ -316,6 +316,17 @@ export interface EditCommentInput {
 }
 export interface ResolveReviewThreadInput {
     threadId: string;
+    /**
+     * Required for GitLab — the project that owns the merge request. GitLab's REST endpoint for
+     * resolving/unresolving discussions is scoped to a project + merge request iid, and the
+     * discussion ID alone is not sufficient. GitHub and Azure DevOps ignore this field.
+     */
+    repo?: GetRepoInput;
+    /**
+     * Required for GitLab — the merge request iid (the per-project number). Paired with `repo` to
+     * locate the discussion. GitHub and Azure DevOps ignore this field.
+     */
+    pullRequestNumber?: number;
 }
 export interface CursorPageInput {
     cursor?: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitkraken/provider-apis",
-  "version": "0.45.0",
+  "version": "0.46.0",
   "description": "An SDK around different third-party APIs that accepts and returns data in a common format.",
   "author": "Axosoft, LLC dba GitKraken",
   "license": "SEE LICENSE IN LICENSE",