@gitkraken/provider-apis 0.46.2 → 0.47.0

package/dist/providers/azureDevops/azureDevOps.d.ts

@@ -1,5 +1,5 @@
 import { AzureGetRepoInput, AzureGetReposInput, AzureGraphAccount, AzureOrganization, AzureProject, AzureSetAccountInput, AzureSetIssueInput, AzureSetPullRequestInput, PullRequestAsyncStatus, StatusByWorkItemIdByStatusId, WorkItemType } from '../../types/exportedTypes/azureDevOps';
-import { AddInlineCommentInput, CursorPageInput, DeleteCommentInput, EditCommentInput, EnterpriseOptions, GetMergeBaseInput, GetPRForRepoInput, GetRepoErrorData, GetRepoInput, GetReposInput, GitComment, GitMergeStrategy, GitPullRequest, GitPullRequestReview, GitRepository, GitRepositoryPermissions, NumberedPageInput, PageInput, ResolveReviewThreadInput, SetAccountInput, SetLabelInput, SetPullRequestInput } from '../../types/exportedTypes/gitProvider';
+import { AddInlineCommentInput, CursorPageInput, DeleteCommentInput, EditCommentInput, EnterpriseOptions, GetMergeBaseInput, GetPRForRepoInput, GetPullRequestDescriptionInput, GetRepoErrorData, GetRepoInput, GetReposInput, GitComment, GitMergeStrategy, GitPullRequest, GitPullRequestReview, GitRepository, GitRepositoryPermissions, NumberedPageInput, PageInput, PullRequestDescription, ResolveReviewThreadInput, SetAccountInput, SetLabelInput, SetPullRequestDescriptionInput, SetPullRequestInput } from '../../types/exportedTypes/gitProvider';
 import { Issue, SetStatusInput } from '../../types/exportedTypes/issueProvider';
 import { PagedResult, Result } from '../../types/exportedTypes/types';
 import { GitProvider } from '../gitProvider';
@@ -338,6 +338,8 @@ export declare class AzureDevOps extends EnterpriseProvider implements GitProvid
         }[];
     }>;
     getPullRequestForRepo(input: GetPRForRepoInput, options?: EnterpriseOptions): Promise<Result<GitPullRequest | null>>;
+    getPullRequestDescription(input: GetPullRequestDescriptionInput, options?: EnterpriseOptions): Promise<Result<PullRequestDescription>>;
+    setPullRequestDescription(input: SetPullRequestDescriptionInput, options?: EnterpriseOptions): Promise<Result<PullRequestDescription>>;
     getMergeBase(input: GetMergeBaseInput, options?: EnterpriseOptions): Promise<Result<string>>;
     getFileContents(input: {
         repo: GetRepoInput;

package/dist/providers/gitProvider.d.ts

@@ -1,4 +1,4 @@
-import { Account, AddInlineCommentInput, CreateCommitInput, DeleteCommentInput, EditCommentInput, GetMergeBaseInput, GetPRForRepoInput, GetRepoErrorData, GetRepoInput, GetReposInput, GitBlame, GitComment, GitLabel, GitMergeStrategy, GitPullRequest, GitRefWithCommit, GitRepository, Options, PageInput, ResolveReviewThreadInput, SetAccountInput, SetLabelInput, SetMilestoneInput, SetPullRequestInput, User } from '../types/exportedTypes/gitProvider';
+import { Account, AddInlineCommentInput, CreateCommitInput, DeleteCommentInput, EditCommentInput, GetMergeBaseInput, GetPRForRepoInput, GetPullRequestDescriptionInput, GetRepoErrorData, GetRepoInput, GetReposInput, GitBlame, GitComment, GitLabel, GitMergeStrategy, GitPullRequest, GitRefWithCommit, GitRepository, Options, PageInput, PullRequestDescription, ResolveReviewThreadInput, SetAccountInput, SetLabelInput, SetMilestoneInput, SetPullRequestDescriptionInput, SetPullRequestInput, User } from '../types/exportedTypes/gitProvider';
 import { PagedResult, Result } from '../types/exportedTypes/types';
 export interface GitProvider {
     getCurrentUser?(input: Record<string, never>, options: Options): Promise<Result<Account>>;
@@ -31,6 +31,8 @@ export interface GitProvider {
     }, options: Options): Promise<Result<GitBlame>>;
     getPullRequestsForRepos?(input: GetReposInput, options: Options): Promise<Result<GitPullRequest[]>>;
     getPullRequestForRepo?(input: GetPRForRepoInput, options: Options): Promise<Result<GitPullRequest | null>>;
+    getPullRequestDescription?(input: GetPullRequestDescriptionInput, options: Options): Promise<Result<PullRequestDescription>>;
+    setPullRequestDescription?(input: SetPullRequestDescriptionInput, options: Options): Promise<Result<PullRequestDescription>>;
     setPullRequestAssignees?(input: {
         pullRequest: SetPullRequestInput;
         assignees: SetAccountInput[];

package/dist/providers/github/github.d.ts

@@ -1,4 +1,4 @@
-import { Account, AddInlineCommentInput, CreateCommitInput, CursorPageInput, DeleteCommentInput, EditCommentInput, EnterpriseOptions, GetMergeBaseInput, GetRepoErrorData, GetRepoInput, GitComment, GitLabel, GitMergeStrategy, GitMilestone, GitPullRequest, GitPullRequestReviewComment, GitPullRequestReviewState, GitRepository, GitTreeItem, NumberedPageInput, Organization, ResolveReviewThreadInput, SetAccountInput, SetLabelInput, SetMilestoneInput, SetPullRequestInput } from '../../types/exportedTypes/gitProvider';
+import { Account, AddInlineCommentInput, CreateCommitInput, CursorPageInput, DeleteCommentInput, EditCommentInput, EnterpriseOptions, GetMergeBaseInput, GetPullRequestDescriptionInput, GetRepoErrorData, GetRepoInput, GitComment, GitLabel, GitMergeStrategy, GitMilestone, GitPullRequest, GitPullRequestReviewComment, GitPullRequestReviewState, GitRepository, GitTreeItem, NumberedPageInput, Organization, PullRequestDescription, ResolveReviewThreadInput, SetAccountInput, SetLabelInput, SetMilestoneInput, SetPullRequestDescriptionInput, SetPullRequestInput } from '../../types/exportedTypes/gitProvider';
 import { FetchIssuesData, FetchPullRequestsData, GitHubIssueCloseReason } from '../../types/exportedTypes/github';
 import { Issue, SetIssueInput } from '../../types/exportedTypes/issueProvider';
 import { Result } from '../../types/exportedTypes/types';
@@ -261,6 +261,8 @@ export declare class GitHub extends EnterpriseProvider implements GitProvider, I
     }, options?: EnterpriseOptions): Promise<{
         data: GitPullRequest | null;
     }>;
+    getPullRequestDescription(input: GetPullRequestDescriptionInput, options?: EnterpriseOptions): Promise<Result<PullRequestDescription>>;
+    setPullRequestDescription(input: SetPullRequestDescriptionInput, options?: EnterpriseOptions): Promise<Result<PullRequestDescription>>;
     getPullRequestByGraphQLId(input: {
         graphQLId: string;
     }, options?: EnterpriseOptions): Promise<{

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

@@ -1,6 +1,7 @@
-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 { Account, AddInlineCommentInput, CursorPageInput, DeleteCommentInput, EditCommentInput, EnterpriseOptions, GetMergeBaseInput, GetPullRequestDescriptionInput, GetRepoErrorData, GetRepoInput, GetReposInput, GitComment, GitLabel, GitMergeStrategy, GitPullRequest, GitPullRequestReview, GitRepository, GitTreeItem, NumberedPageInput, PullRequestDescription, ResolveReviewThreadInput, SetAccountInput, SetLabelInput, SetMilestoneInput, SetPullRequestDescriptionInput, SetPullRequestInput } from '../../types/exportedTypes/gitProvider';
 import { GitLabGetIssueInput, PullRequestAssociation } from '../../types/exportedTypes/gitlab';
 import { Issue, SetIssueInput } from '../../types/exportedTypes/issueProvider';
+import { Result } from '../../types/exportedTypes/types';
 import { GitProvider } from '../gitProvider';
 import { IssueProvider } from '../issueProvider';
 import { EnterpriseProvider } from '../provider';
@@ -317,6 +318,9 @@ export declare class GitLab extends EnterpriseProvider implements GitProvider, I
     }, options?: EnterpriseOptions): Promise<{
         data: GitPullRequest | null;
     }>;
+    private getMergeRequestUrl;
+    getPullRequestDescription(input: GetPullRequestDescriptionInput, options?: EnterpriseOptions): Promise<Result<PullRequestDescription>>;
+    setPullRequestDescription(input: SetPullRequestDescriptionInput, options?: EnterpriseOptions): Promise<Result<PullRequestDescription>>;
     /**
      * 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.

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

@@ -255,6 +255,19 @@ export type GetPRForRepoInput = {
     repo: GetRepoInput;
     number: number;
 };
+export type GetPullRequestDescriptionInput = {
+    repo: GetRepoInput;
+    number: number;
+};
+export type SetPullRequestDescriptionInput = {
+    repo: GetRepoInput;
+    number: number;
+    description: string;
+};
+export interface PullRequestDescription {
+    description: string | null;
+    descriptionHtml?: string | null;
+}
 export interface SetPullRequestInput {
     id: string;
     number: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitkraken/provider-apis",
-  "version": "0.46.2",
+  "version": "0.47.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",