@gitkraken/provider-apis 0.14.2 → 0.15.1

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

@@ -28,7 +28,7 @@ export type StatusByWorkItemIdByStatusId = {
 };
 export declare class AzureDevOps extends Provider implements GitProvider {
     /** Note: PATs are not supported for this function, only OAuth tokens are. */
-    getCurrentUser(options?: EnterpriseOptions): Promise<{
+    getCurrentUser(input?: Record<string, never>, options?: EnterpriseOptions): Promise<{
         data: {
             id: string;
             name: string;

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

@@ -226,7 +226,9 @@ export interface WorkItemType {
     xmlForm: string;
     fields: WorkItemTypeField[];
     fieldInstances: WorkItemTypeField[];
-    transitions: [string: WorkItemTypeTransition];
+    transitions: {
+        [index: string]: WorkItemTypeTransition;
+    };
     states: WorkItemState[];
     url: string;
 }

package/dist/providers/bitbucket/bitbucket.d.ts

@@ -15,7 +15,7 @@ export declare class Bitbucket extends Provider implements GitProvider {
     }): Promise<{
         data: RefreshTokenResponse;
     }>;
-    getCurrentUser(options?: Options): Promise<{
+    getCurrentUser(input?: Record<string, never>, options?: Options): Promise<{
         data: Account;
     }>;
     getUserForCommit(input: {

package/dist/providers/bitbucketServer/bitbucketServer.d.ts

@@ -1,4 +1,4 @@
-import { EnterpriseOptions, GetRepoErrorData, GetRepoInput, GitProvider, GitRepository } from '../gitProvider';
+import { EnterpriseOptions, GetRepoErrorData, GetRepoInput, GitProvider, GitPullRequest, GitRepository, NumberedPageInput } from '../gitProvider';
 import { EnterpriseProvider } from '../provider';
 import { BitbucketServerMergeStrategy } from './bitbucketServerTypes';
 export declare class BitbucketServer extends EnterpriseProvider implements GitProvider {
@@ -20,6 +20,30 @@ export declare class BitbucketServer extends EnterpriseProvider implements GitPr
         data: GitRepository[];
         errors: GetRepoErrorData[];
     }>;
+    private getPullRequestsForRepoBase;
+    getPullRequestsForRepo(input: {
+        repo: GetRepoInput;
+        authorLogin?: string;
+    } & NumberedPageInput, options?: EnterpriseOptions): Promise<{
+        pageInfo: {
+            hasNextPage: boolean;
+            nextPage: number | null;
+        };
+        data: GitPullRequest[];
+    }>;
+    getPullRequestsForRepos(input: {
+        repos: GetRepoInput[];
+        authorLogin?: string;
+    }, options?: EnterpriseOptions): Promise<{
+        data: GitPullRequest[];
+    }>;
+    getPullRequestsForCurrentUser(input: NumberedPageInput, options?: EnterpriseOptions): Promise<{
+        pageInfo: {
+            hasNextPage: boolean;
+            nextPage: number | null;
+        };
+        data: GitPullRequest[];
+    }>;
     closePullRequest(input: {
         repo: GetRepoInput;
         pullRequestId: string;

package/dist/providers/bitbucketServer/bitbucketServerTypes.d.ts

@@ -11,3 +11,92 @@ export interface BitbucketServerMergeStrategy {
     id: string;
     name: string;
 }
+export interface BitbucketServerPagedResponse<T> {
+    values: T[];
+    size: number;
+    limit: number;
+    isLastPage: boolean;
+    nextPageStart: number;
+    start: number;
+}
+export interface BitbucketServerPullRequestRef {
+    id: string;
+    displayId: string;
+    latestCommit: string;
+    type: string;
+    repository: {
+        slug: string;
+        id: number;
+        name: string;
+        hierarchyId: string;
+        scmId: string;
+        state: string;
+        statusMessage: string;
+        forkable: boolean;
+        project: {
+            key: string;
+            id: number;
+            name: string;
+            public: boolean;
+            type: string;
+            links: {
+                self: Link[];
+            };
+        };
+        public: boolean;
+        archived: boolean;
+        links: {
+            clone: NamedLink[];
+            self: Link[];
+        };
+    };
+}
+export interface BitbucketServerUser {
+    name: string;
+    emailAddress: string;
+    active: boolean;
+    displayName: string;
+    id: number;
+    slug: string;
+    type: string;
+    links: {
+        self: Link[];
+    };
+}
+export interface BitbucketServerPullRequestUser {
+    user: BitbucketServerUser;
+    lastReviewedCommit?: string;
+    role: 'REVIEWER' | 'AUTHOR' | 'PARTICIPANT';
+    approved: boolean;
+    status: 'UNAPPROVED' | 'NEEDS_WORK' | 'APPROVED';
+}
+export interface BitbucketServerPullRequest {
+    id: number;
+    version: number;
+    title: string;
+    description: string;
+    state: 'OPEN' | 'MERGED' | 'DECLINED';
+    open: boolean;
+    closed: boolean;
+    createdDate: number;
+    updatedDate: number;
+    closedDate: number | null;
+    fromRef: BitbucketServerPullRequestRef;
+    toRef: BitbucketServerPullRequestRef;
+    locked: boolean;
+    author: BitbucketServerPullRequestUser;
+    reviewers: BitbucketServerPullRequestUser[];
+    participants: BitbucketServerPullRequestUser[];
+    properties: {
+        mergeResult: {
+            outcome: string;
+            current: boolean;
+        };
+        resolvedTaskCount: number;
+        commentCount: number;
+        openTaskCount: number;
+    };
+    links: {
+        self: Link[];
+    };
+}

package/dist/providers/gitProvider.d.ts

@@ -61,10 +61,12 @@ export declare enum GitLabCiJobStatus {
     WaitingForResource = "WAITING_FOR_RESOURCE"
 }
 export interface GitBuildStatus {
+    completedAt: Date | null;
     description: string | null;
     name: string | null;
     state: GitHubCheckRunState | GitHubStatusState | GitLabCiJobStatus | null;
     stage: GitBuildStatusStage | null;
+    startedAt: Date | null;
     url: string;
 }
 export interface GitLabel {
@@ -177,6 +179,8 @@ export interface GitPullRequest {
     }[] | null;
     reviewDecision: GitPullRequestReviewState | null;
     repository: {
+        id: string;
+        graphQLId?: string;
         name: string;
         project?: string;
         owner: {
@@ -188,14 +192,17 @@ export interface GitPullRequest {
         } | null;
     };
     headRepository: {
+        id: string;
+        graphQLId?: string;
         name: string;
+        project?: string;
         owner: {
             login: string;
         };
         remoteInfo: {
             cloneUrlHTTPS: string;
             cloneUrlSSH: string;
-        };
+        } | null;
     } | null;
     headCommit: {
         buildStatuses: GitBuildStatus[] | null;
@@ -256,7 +263,7 @@ export interface GetRepoErrorData {
     error?: Error;
 }
 export interface GitProvider {
-    getCurrentUser?(options: Options): Promise<Result<Account>>;
+    getCurrentUser?(input: Record<string, never>, options: Options): Promise<Result<Account>>;
     getUserForCommit?(input: {
         repo: GetRepoInput;
         oid: string;

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

@@ -4,10 +4,14 @@ import { EnterpriseProvider } from '../provider';
 import { FetchIssuesData, FetchPullRequestsData } from './githubTypes';
 export declare class GitHub extends EnterpriseProvider implements GitProvider {
     private _scopesCache;
+    private _enterpriseVersionsCache;
     private getScopes;
+    private getEnterpriseVersion;
     private getEnterpriseAvatarUrlIfNeeded;
-    getCurrentUser(options?: EnterpriseOptions): Promise<{
-        data: Account;
+    getCurrentUser<F extends keyof Account>(input?: {
+        fields?: F[];
+    }, options?: EnterpriseOptions): Promise<{
+        data: Pick<Account, F>;
     }>;
     getAccountsForRepo(input: {
         repo: GetRepoInput;
@@ -16,7 +20,7 @@ export declare class GitHub extends EnterpriseProvider implements GitProvider {
             endCursor: string | null;
             hasNextPage: boolean;
         };
-        data: Account[];
+        data: Pick<Account, keyof Account>[];
     }>;
     getUserForCommit(input: {
         repo: GetRepoInput;
@@ -36,13 +40,13 @@ export declare class GitHub extends EnterpriseProvider implements GitProvider {
         email: string;
         avatarSize?: number;
     }, options?: EnterpriseOptions): Promise<{
-        data: Account;
+        data: Pick<Account, keyof Account>;
     }>;
     getAccountForUsername(input: {
         username: string;
         avatarSize?: number;
     }, options?: EnterpriseOptions): Promise<{
-        data: Account;
+        data: Pick<Account, keyof Account>;
     }>;
     getOrgsForCurrentUser(input?: CursorPageInput, options?: EnterpriseOptions): Promise<{
         pageInfo: {

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

@@ -1,19 +1,20 @@
-import { GraphQLBody, GraphQLError, GraphQLResponse, ProviderConfig } from '../../types';
-import { EnterpriseOptions, GitDiffLineType } from '../gitProvider';
+import { FieldMap, GraphQLBody, GraphQLError, GraphQLResponse, ProviderConfig } from '../../types';
+import { Account, EnterpriseOptions, GitDiffLineType } from '../gitProvider';
 export declare const GITHUB_API_URL = "https://api.github.com";
 export declare const GITHUB_GRAPHQL_API_URL: string;
 export declare const GRAPHQL_MILESTONE_FIELDS = "\ndescription\ndueOn\nid\nnumber\nstate\ntitle\nurl\n";
 export declare const GRAPHQL_LABEL_FIELDS = "\ncolor\ndescription\nid\nname\n";
 export declare const getGraphQLEndpoint: (config: ProviderConfig, options: EnterpriseOptions) => string;
+export declare const getRESTBaseUrl: (config: ProviderConfig, options: EnterpriseOptions) => string;
 export declare const makeGitHubGraphQLRequest: <T>(config: ProviderConfig, data: GraphQLBody, options: EnterpriseOptions) => Promise<import("../../types").Response<GraphQLResponse<T>>>;
 export declare const hasEmailScope: (scopes: string[]) => boolean;
-export declare const getAccountFields: (withAvatarSizeVar?: boolean, includeEmail?: boolean) => string;
+export declare const getAccountFields: (withAvatarSizeVar?: boolean, includeEmail?: boolean, fields?: FieldMap<Account>) => string;
 export declare const getBotFields: (withAvatarSizeVar?: boolean) => string;
-export declare const getPullRequestFields: (isDraftPullRequestSupported: boolean, includeEmail?: boolean) => string;
+export declare const getPullRequestFields: (isDraftPullRequestSupported: boolean, includeEmail: boolean | undefined, supportsEnterpriseVersion3: boolean) => string;
 export declare const getIssueFields: (includeEmail?: boolean) => string;
 export declare const GithubSearchSyntaxQualifiers: Record<string, string>;
 export declare const getProjectGithubSearchSyntax: (search: string) => string[];
-export declare const makeSearchIssuesOrPRsGraphQLBody: (type: 'issue' | 'pr', query: string, cursor: string | null | undefined, supportsEmail: boolean, supportsDrafts?: boolean) => GraphQLBody;
+export declare const makeSearchIssuesOrPRsGraphQLBody: (type: 'issue' | 'pr', query: string, cursor: string | null | undefined, supportsEmail: boolean, supportsDrafts?: boolean, supportsEnterpriseVersion3?: boolean) => GraphQLBody;
 export declare const hasDraftsNotSupportedError: (errors?: GraphQLError[]) => boolean;
 export declare const getDiffLinesFromDiffHunk: (diffHunk: string, originalLine: number | null, originalStartLine: number | null, startDiffSide: 'LEFT' | 'RIGHT' | null) => {
     line: string;

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

@@ -69,12 +69,15 @@ export interface GraphQLOrganization {
 }
 export type PullRequestState = 'OPEN' | 'CLOSED' | 'MERGED';
 export interface GraphQLCheckRun {
+    completedAt: string | null;
     name: string;
-    status: GitHubCheckRunState;
     permalink: string;
+    startedAt: string | null;
+    status: GitHubCheckRunState;
 }
 export interface GraphQLContext {
     context: string;
+    createdAt: string;
     description: string;
     state: GitHubStatusState;
     targetUrl: string;
@@ -129,6 +132,8 @@ export interface GraphQLPullRequest {
         } | null;
     } | null;
     headRepository: {
+        id: string;
+        databaseId: string;
         name: string;
         owner: {
             login: string;
@@ -137,6 +142,8 @@ export interface GraphQLPullRequest {
         url: string;
     };
     repository: {
+        id: string;
+        databaseId: string;
         name: string;
         owner: {
             login: string;
@@ -146,11 +153,11 @@ export interface GraphQLPullRequest {
     };
     reviewRequests: {
         nodes: {
-            asCodeOwner: boolean;
-            requestedReviewer: GraphQLUser;
+            asCodeOwner?: boolean;
+            requestedReviewer: GraphQLUser | Record<string, never> | null;
         }[] | null;
     } | null;
-    latestReviews: {
+    latestReviews?: {
         nodes: {
             author: GraphQLUser;
             state: GitHubPullRequestReviewState;
@@ -172,6 +179,8 @@ export interface GraphQLIssue {
     url: string;
     state: GithubIssueState;
     repository: {
+        databaseId: string;
+        id: string;
         name: string;
         owner: {
             login: string;

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

@@ -4,7 +4,8 @@ import { EnterpriseProvider } from '../provider';
 export type PullRequestState = 'opened' | 'merged' | 'closed';
 export type PullRequestAssociation = 'assigned' | 'authored' | 'reviewRequested';
 export declare class GitLab extends EnterpriseProvider implements GitProvider, IssueProvider {
-    getCurrentUser(options?: EnterpriseOptions): Promise<{
+    private getIsSelfHosted;
+    getCurrentUser(input?: Record<string, never>, options?: EnterpriseOptions): Promise<{
         data: Account;
     }>;
     getUserForCommit(input: {

package/dist/providers/issueProvider.d.ts

@@ -16,6 +16,12 @@ export type GetIssuesForReposInput = GetReposInput | {
 export interface IssueTransition {
     id: string;
     name: string;
+    to: {
+        id: string;
+        name: string;
+        color: string;
+        category: IssueStatusCategory;
+    };
 }
 export interface IssueComponent {
     description: string | null;
@@ -35,12 +41,15 @@ export interface Issue {
     labels: GitLabel[];
     number: string;
     repository: {
+        id: string;
+        graphQLId?: string;
         name: string;
         owner: {
             login?: string;
         };
     } | null;
     state: {
+        id?: string;
         name: string;
         color: string | null;
         category?: IssueStatusCategory;

package/dist/providers/jira/sharedTypes.d.ts

@@ -64,6 +64,7 @@ export interface JiraComponent {
     self: string;
 }
 export interface JiraIssueStatus {
+    id: string;
     name: string;
     statusCategory: {
         colorName: string;

package/dist/types.d.ts

@@ -76,3 +76,5 @@ export type PagedResult<T> = {
     pageInfo: CursorPageInfo | NumberedPageInfo;
     data: T[];
 };
+export type FullFieldMap<T> = Record<keyof T, boolean>;
+export type FieldMap<T> = Partial<FullFieldMap<T>>;

package/dist/utils.d.ts

@@ -1 +1,11 @@
+import { FieldMap } from './types';
 export declare const getRequestHeaders: (token?: string, basicAuth?: boolean) => Record<string, string>;
+export declare const toFieldMap: <T, K extends keyof T = keyof T>(fields?: K[] | undefined) => Partial<import("./types").FullFieldMap<T>> | undefined;
+/**
+ * Returns providerQueryString if requestedFields is undefined or if any of the normalized fields depend on the query string.
+ * @param requestedFields
+ * @param normalizedFields
+ * @param providerQueryString
+ * @returns string
+ */
+export declare const fieldQuery: <T>(requestedFields: Partial<import("./types").FullFieldMap<T>> | undefined, normalizedFields: (keyof T)[], providerQueryString: string) => string;

package/package.json

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