@gitkraken/provider-apis 0.24.2 → 0.25.0

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

@@ -240,6 +240,7 @@ export declare class AzureDevOps extends Provider implements GitProvider, IssueP
         assigneeLogins?: string[];
         authorLogin?: string;
         mentionLogin?: string;
+        labelNames?: string[];
         statusByWorkItemIdByStatusId?: StatusByWorkItemIdByStatusId;
     } & NumberedPageInput, options?: EnterpriseOptions): Promise<{
         pageInfo: {

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

@@ -82,12 +82,7 @@ export declare class GitHub extends EnterpriseProvider implements GitProvider, I
             endCursor: string | null;
             hasNextPage: boolean;
         };
-        data: {
-            name: string | null;
-            email: string | null;
-            username: string | null;
-            avatarUrl: string | null;
-        }[];
+        data: Pick<Account, keyof Account>[];
     }>;
     getRepo(input: GetRepoInput, options?: EnterpriseOptions): Promise<{
         data: GitRepository;
@@ -190,6 +185,7 @@ export declare class GitHub extends EnterpriseProvider implements GitProvider, I
         query: string;
         isDraft?: boolean;
         includeFromArchivedRepos?: boolean;
+        maxPageSize?: number;
     } & CursorPageInput, options?: EnterpriseOptions): Promise<{
         pageInfo: {
             hasNextPage: boolean;
@@ -200,6 +196,7 @@ export declare class GitHub extends EnterpriseProvider implements GitProvider, I
     searchIssues(input: {
         query: string;
         includeFromArchivedRepos?: boolean;
+        maxPageSize?: number;
     } & CursorPageInput, options?: EnterpriseOptions): Promise<{
         pageInfo: {
             hasNextPage: boolean;
@@ -213,6 +210,8 @@ export declare class GitHub extends EnterpriseProvider implements GitProvider, I
     getPullRequestsAssociatedWithUser(input: {
         username: string;
         includeFromArchivedRepos?: boolean;
+        labelNames?: string[];
+        maxPageSize?: number;
     } & CursorPageInput, options?: EnterpriseOptions): Promise<{
         pageInfo: {
             hasNextPage: boolean;
@@ -308,6 +307,8 @@ export declare class GitHub extends EnterpriseProvider implements GitProvider, I
     getIssuesAssociatedWithUser(input: {
         username: string;
         includeFromArchivedRepos?: boolean;
+        maxPageSize?: number;
+        labelNames?: string[];
     } & CursorPageInput, options?: EnterpriseOptions): Promise<{
         pageInfo: {
             hasNextPage: boolean;

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

@@ -6,7 +6,10 @@ export declare const minimumFeatureVersions: {
     LATEST_REVIEWS: number[];
     VIEWER_CAN_MERGE_AS_ADMIN: number[];
 };
+export declare const MAX_PR_PAGE_SIZE = 15;
+export declare const MAX_ISSUE_PAGE_SIZE = 100;
 type MinimumFeatureVersions = typeof minimumFeatureVersions;
+export declare const isNotNull: <T>(item: T | null) => item is T;
 export declare const doesEnterpriseSupportFeature: (enterpriseVersion: [number, number, number], feature: keyof MinimumFeatureVersions) => boolean;
 export declare const GITHUB_API_URL = "https://api.github.com";
 export declare const GITHUB_GRAPHQL_API_URL: string;
@@ -23,6 +26,7 @@ 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, options: {
+    maxPageSize: number;
     supportsEmail: boolean;
     supportsDrafts?: boolean;
     enterpriseVersion?: [number, number, number] | null;

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

@@ -122,6 +122,7 @@ export declare class GitLab extends EnterpriseProvider implements GitProvider, I
         username: string;
         association: PullRequestAssociation;
         includeFromArchivedRepos?: boolean;
+        labelNames?: string[];
     } & CursorPageInput, options?: EnterpriseOptions): Promise<{
         pageInfo: {
             endCursor: string | null;
@@ -135,6 +136,7 @@ export declare class GitLab extends EnterpriseProvider implements GitProvider, I
     getPullRequestsAssociatedWithUser(input: {
         username: string;
         includeFromArchivedRepos?: boolean;
+        labelNames?: string[];
     } & CursorPageInput, options?: EnterpriseOptions): Promise<{
         pageInfo: {
             hasNextPage: boolean;
@@ -149,6 +151,7 @@ export declare class GitLab extends EnterpriseProvider implements GitProvider, I
         assigneeLogins?: string[];
         updatedBefore?: string;
         authorLogin?: string;
+        labelNames?: string[];
         isDraft?: boolean;
         reviewRequestedLogin?: string;
     } & CursorPageInput, options?: EnterpriseOptions): Promise<{
@@ -165,6 +168,7 @@ export declare class GitLab extends EnterpriseProvider implements GitProvider, I
         assigneeLogins?: string[];
         updatedBefore?: string;
         authorLogin?: string;
+        labelNames?: string[];
         isDraft?: boolean;
         reviewRequestedLogin?: string;
         includeFromArchivedRepos?: boolean;
@@ -222,6 +226,7 @@ export declare class GitLab extends EnterpriseProvider implements GitProvider, I
         assigneeLogins?: string[];
         updatedBefore?: string;
         authorLogin?: string;
+        labelNames?: string[];
     } & CursorPageInput, options?: EnterpriseOptions): Promise<{
         pageInfo: {
             endCursor: string | null;
@@ -234,6 +239,7 @@ export declare class GitLab extends EnterpriseProvider implements GitProvider, I
         assigneeLogins?: string[];
         updatedBefore?: string;
         authorLogin?: string;
+        labelNames?: string[];
         includeFromArchivedRepos?: boolean;
     } & CursorPageInput, options?: EnterpriseOptions): Promise<{
         pageInfo: {

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

@@ -69,6 +69,7 @@ export declare class Jira extends Provider implements IssueProvider {
         assigneeLogins?: string[];
         authorLogin?: string;
         mentionLogin?: string;
+        labelNames?: string[];
     } & NumberedPageInput, options?: EnterpriseOptions): Promise<{
         data: import("../../types/exportedTypes/issueProvider").Issue[];
         pageInfo: {
@@ -82,6 +83,7 @@ export declare class Jira extends Provider implements IssueProvider {
         assigneeLogins?: string[];
         authorLogin?: string;
         mentionLogin?: string;
+        labelNames?: string[];
     } & NumberedPageInput, options?: EnterpriseOptions): Promise<{
         data: import("../../types/exportedTypes/issueProvider").Issue[];
         pageInfo: {
@@ -91,6 +93,7 @@ export declare class Jira extends Provider implements IssueProvider {
     }>;
     getIssuesForResourceForCurrentUser(input: {
         resourceId: string;
+        labelNames?: string[];
     } & NumberedPageInput, options?: EnterpriseOptions): Promise<{
         data: import("../../types/exportedTypes/issueProvider").Issue[];
         pageInfo: {

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

@@ -23,6 +23,7 @@ export declare const getIssue: (config: ProviderConfig, input: {
 }>;
 export declare const getIssuesForResourceForCurrentUser: (config: ProviderConfig, input: {
     resourceId?: string;
+    labelNames?: string[];
 } & NumberedPageInput, resourceUrl: string | null, options?: EnterpriseOptions) => Promise<{
     data: Issue[];
     pageInfo: {
@@ -36,6 +37,7 @@ export declare const getIssuesForProject: (config: ProviderConfig, input: {
     assigneeLogins?: string[];
     authorLogin?: string;
     mentionLogin?: string;
+    labelNames?: string[];
 } & NumberedPageInput, resourceUrl: string | null, options?: EnterpriseOptions) => Promise<{
     data: Issue[];
     pageInfo: {
@@ -49,6 +51,7 @@ export declare const getIssuesForProjects: (config: ProviderConfig, input: {
     assigneeLogins?: string[];
     authorLogin?: string;
     mentionLogin?: string;
+    labelNames?: string[];
 } & NumberedPageInput, resourceUrl: string | null, options?: EnterpriseOptions) => Promise<{
     data: Issue[];
     pageInfo: {

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

@@ -30,6 +30,7 @@ export declare class JiraServer extends EnterpriseProvider implements IssueProvi
         assigneeLogins?: string[];
         authorLogin?: string;
         mentionLogin?: string;
+        labelNames?: string[];
     } & NumberedPageInput, options?: EnterpriseOptions): Promise<{
         data: import("../../types/exportedTypes/issueProvider").Issue[];
         pageInfo: {
@@ -42,6 +43,7 @@ export declare class JiraServer extends EnterpriseProvider implements IssueProvi
         assigneeLogins?: string[];
         authorLogin?: string;
         mentionLogin?: string;
+        labelNames?: string[];
     } & NumberedPageInput, options?: EnterpriseOptions): Promise<{
         data: import("../../types/exportedTypes/issueProvider").Issue[];
         pageInfo: {
@@ -49,7 +51,9 @@ export declare class JiraServer extends EnterpriseProvider implements IssueProvi
             nextPage: number | null;
         };
     }>;
-    getIssuesForResourceForCurrentUser(input: NumberedPageInput, options?: EnterpriseOptions): Promise<{
+    getIssuesForResourceForCurrentUser(input: {
+        labelNames?: string[];
+    } & NumberedPageInput, options?: EnterpriseOptions): Promise<{
         data: import("../../types/exportedTypes/issueProvider").Issue[];
         pageInfo: {
             hasNextPage: boolean;

package/dist/providers/trello/trello.d.ts

@@ -44,6 +44,7 @@ export declare class Trello extends Provider implements IssueProvider {
         boardId: string;
         filterText?: string;
         assigneeLogins?: string[];
+        labelNamesOrColors?: string[];
         trelloBoardListsById?: Record<string, {
             name: string;
         }>;

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

@@ -31,8 +31,8 @@ export type EntityIdentifier = {
     entityId: string;
 };
 export type AzureIssueEntityIdentifierInput = {
-    provider: EntityIdentifierProviderType;
-    entityType: EntityType;
+    provider: EntityIdentifierProviderType.Azure;
+    entityType: EntityType.Issue;
     version?: EntityVersion;
     organizationName: string;
     projectId: string;
@@ -40,8 +40,8 @@ export type AzureIssueEntityIdentifierInput = {
     domain?: string;
 };
 export type AzurePullRequestEntityIdentifierInput = {
-    provider: EntityIdentifierProviderType;
-    entityType: EntityType;
+    provider: EntityIdentifierProviderType.Azure;
+    entityType: EntityType.PullRequest;
     version?: EntityVersion;
     organizationName: string;
     projectId: string;
@@ -50,61 +50,83 @@ export type AzurePullRequestEntityIdentifierInput = {
     domain?: string;
 };
 export type BitbucketIssueEntityIdentifierInput = {
-    provider: EntityIdentifierProviderType;
-    entityType: EntityType;
+    entityType: EntityType.Issue;
     version?: EntityVersion;
     repoId: string;
     entityId: string;
-    domain?: string;
-};
+} & ({
+    provider: EntityIdentifierProviderType.Bitbucket;
+} | {
+    provider: EntityIdentifierProviderType.BitbucketServer;
+    domain: string;
+});
 export type BitbucketPullRequestEntityIdentifierInput = {
-    provider: EntityIdentifierProviderType;
-    entityType: EntityType;
+    entityType: EntityType.PullRequest;
     version?: EntityVersion;
     repoId: string;
     entityId: string;
-    domain?: string;
-};
+} & ({
+    provider: EntityIdentifierProviderType.Bitbucket;
+} | {
+    provider: EntityIdentifierProviderType.BitbucketServer;
+    domain: string;
+});
 export type GithubIssueEntityIdentifierInput = {
-    provider: EntityIdentifierProviderType;
-    entityType: EntityType;
+    entityType: EntityType.Issue;
     version?: EntityVersion;
     entityId: string;
-    domain?: string;
-};
+} & ({
+    provider: EntityIdentifierProviderType.Github;
+} | {
+    provider: EntityIdentifierProviderType.GithubEnterprise;
+    domain: string;
+});
 export type GithubPullRequestEntityIdentifierInput = {
-    provider: EntityIdentifierProviderType;
-    entityType: EntityType;
+    entityType: EntityType.PullRequest;
     version?: EntityVersion;
     entityId: string;
-    domain?: string;
-};
+} & ({
+    provider: EntityIdentifierProviderType.Github;
+} | {
+    provider: EntityIdentifierProviderType.GithubEnterprise;
+    domain: string;
+});
 export type GitlabIssueEntityIdentifierInput = {
-    provider: EntityIdentifierProviderType;
-    entityType: EntityType;
+    entityType: EntityType.Issue;
     version?: EntityVersion;
     entityId: string;
     domain?: string;
-};
+} & ({
+    provider: EntityIdentifierProviderType.Gitlab;
+} | {
+    provider: EntityIdentifierProviderType.GitlabSelfHosted;
+    domain: string;
+});
 export type GitlabPullRequestEntityIdentifierInput = {
-    provider: EntityIdentifierProviderType;
-    entityType: EntityType;
+    entityType: EntityType.PullRequest;
     version?: EntityVersion;
     entityId: string;
-    domain?: string;
-};
+} & ({
+    provider: EntityIdentifierProviderType.Gitlab;
+} | {
+    provider: EntityIdentifierProviderType.GitlabSelfHosted;
+    domain: string;
+});
 export type JiraIssueEntityIdentifierInput = {
-    provider: EntityIdentifierProviderType;
-    entityType: EntityType;
+    entityType: EntityType.Issue;
     version?: EntityVersion;
-    resourceId?: string;
     projectId: string;
     entityId: string;
-    domain?: string;
-};
+} & ({
+    provider: EntityIdentifierProviderType.Jira;
+    resourceId: string;
+} | {
+    provider: EntityIdentifierProviderType.JiraServer;
+    domain: string;
+});
 export type TrelloIssueEntityIdentifierInput = {
-    provider: EntityIdentifierProviderType;
-    entityType: EntityType;
+    provider: EntityIdentifierProviderType.Trello;
+    entityType: EntityType.Issue;
     version?: EntityVersion;
     accountOrOrgId: string;
     projectId: string;

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

@@ -10,9 +10,21 @@ export interface FetchPullRequestsData {
     isDraft?: boolean;
     authorLogin?: string;
     mentionLogin?: string;
+    labelNames?: string[];
     reviewRequestedLogin?: string;
     startQuery?: string;
     includeFromArchivedRepos?: boolean;
+    /**
+     * GitHub is temperamental when it comes to fetching a lot of PRs at the same time. GitHub times-out API requests if
+     * they take longer than 10 seconds to complete. So, if the PR page size is too big, GitHub will cancel the request.
+     * We default to fetching 15 PRs at the same time, which ensures the API will not time-out. Some repos seem to be more
+     * susceptible to time-outs than others, so while you may be able to fetch 50 PRs per-page for one repo, it does not
+     * guarantee that you will be able to fetch 50 PRs per-page from another.
+     *
+     * So basically, use this option at your own risk. If you set it much too much higher than 15, GitHub will stop being
+     * able to consistently complete API calls.
+     */
+    maxPageSize?: number;
 }
 export interface FetchIssuesData {
     repos: GetRepoInput[];
@@ -20,6 +32,12 @@ export interface FetchIssuesData {
     updatedBefore?: string;
     authorLogin?: string;
     mentionLogin?: string;
+    labelNames?: string[];
     startQuery?: string;
     includeFromArchivedRepos?: boolean;
+    /**
+     * While GitHub is temperamental when it comes to fetching a lot of PRs, it does not have the same problem when
+     * fetching a lot of issues. This value defaults to 100.
+     */
+    maxPageSize?: number;
 }

package/dist/types/internalTypes/github.d.ts

@@ -145,21 +145,21 @@ export interface GraphQLPullRequest {
     additions: number;
     deletions: number;
     assignees: {
-        nodes: GraphQLUser[] | null;
+        nodes: (GraphQLUser | null)[] | null;
     };
     author: GraphQLUser | GraphQLBot | Record<string, never> | null;
     commits: {
-        nodes: {
+        nodes: ({
             commit: {
                 oid: string;
                 statusCheckRollup: {
                     contexts: {
                         totalCount: number;
-                        nodes: (GraphQLCheckRun | GraphQLContext)[] | null;
+                        nodes: (GraphQLCheckRun | GraphQLContext | null)[] | null;
                     };
                 } | null;
             };
-        }[] | null;
+        } | null)[] | null;
         totalCount: number;
     };
     baseRef: {
@@ -196,16 +196,16 @@ export interface GraphQLPullRequest {
         viewerPermission: GitHubRepositoryPermission;
     };
     reviewRequests: {
-        nodes: {
+        nodes: ({
             asCodeOwner?: boolean;
             requestedReviewer: GraphQLUser | Record<string, never> | null;
-        }[] | null;
+        } | null)[] | null;
     } | null;
     latestReviews?: {
-        nodes: {
+        nodes: ({
             author: GraphQLUser;
             state: GitHubPullRequestReviewState;
-        }[] | null;
+        } | null)[] | null;
     } | null;
     url: string;
     updatedAt: string;
@@ -213,7 +213,7 @@ export interface GraphQLPullRequest {
     mergeStateStatus: GitHubPullRequestMergeStateStatus;
     milestone: GraphQLMilestone | null;
     labels: {
-        nodes: GraphQLLabel[] | null;
+        nodes: (GraphQLLabel | null)[] | null;
     } | null;
     viewerCanMergeAsAdmin?: boolean;
 }
@@ -233,7 +233,7 @@ export interface GraphQLIssue {
         };
     };
     assignees: {
-        nodes: GraphQLUser[] | null;
+        nodes: (GraphQLUser | null)[] | null;
     };
     author: GraphQLUser | GraphQLBot | Record<string, never> | null;
     closedAt: string | null;
@@ -247,7 +247,7 @@ export interface GraphQLIssue {
     };
     milestone: GraphQLMilestone | null;
     labels: {
-        nodes: GraphQLLabel[] | null;
+        nodes: (GraphQLLabel | null)[] | null;
     } | null;
 }
 export interface GraphQLMilestone {
@@ -261,7 +261,7 @@ export interface GraphQLMilestone {
 }
 export interface GraphQLReviewThread {
     comments: {
-        nodes: GraphQLReviewComment[];
+        nodes: (GraphQLReviewComment | null)[] | null;
     };
     isOutdated: boolean;
     isResolved: boolean;

package/package.json

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