@gitkraken/provider-apis 0.19.0 → 0.20.0

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

@@ -0,0 +1,23 @@
+import { GetRepoInput } from './gitProvider';
+export declare enum GitHubIssueCloseReason {
+    Completed = "COMPLETED",
+    NotPlanned = "NOT_PLANNED"
+}
+export interface FetchPullRequestsData {
+    repos: GetRepoInput[];
+    assigneeLogins?: string[];
+    updatedBefore?: string;
+    isDraft?: boolean;
+    authorLogin?: string;
+    mentionLogin?: string;
+    reviewRequestedLogin?: string;
+    startQuery?: string;
+}
+export interface FetchIssuesData {
+    repos: GetRepoInput[];
+    assigneeLogins?: string[];
+    updatedBefore?: string;
+    authorLogin?: string;
+    mentionLogin?: string;
+    startQuery?: string;
+}

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

@@ -0,0 +1,7 @@
+export type PullRequestState = 'opened' | 'merged' | 'closed';
+export type PullRequestAssociation = 'assigned' | 'authored' | 'reviewRequested';
+export interface GitLabGetIssueInput {
+    namespace: string;
+    name: string;
+    number: string;
+}

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

@@ -0,0 +1,90 @@
+import { Account, GetReposInput, GitLabel, GitMilestone } from './gitProvider';
+export declare enum GitIssueState {
+    Open = "OPEN",
+    Closed = "CLOSED"
+}
+export interface GetIssueInput {
+    resourceId?: string;
+    namespace?: string;
+    project?: string;
+    name?: string;
+    number: string;
+}
+export type GetIssuesForReposInput = GetReposInput | {
+    repoIds: (string | number)[];
+};
+export interface IssueTransition {
+    id: string;
+    name: string;
+    to: {
+        id: string;
+        name: string;
+        color: string;
+        category: IssueStatusCategory;
+    };
+}
+export interface IssueComponent {
+    description: string | null;
+    id: string;
+    name: string;
+}
+export type IssueStatusCategory = 'TO_DO' | 'IN_PROGRESS' | 'DONE';
+export interface Issue {
+    author: Account | null;
+    assignees: Account[];
+    commentCount: number | null;
+    closedDate: Date | null;
+    createdDate: Date;
+    description: string | null;
+    graphQLId?: string;
+    id: string;
+    labels: GitLabel[];
+    number: string;
+    repository: {
+        id: string;
+        graphQLId?: string;
+        name: string;
+        owner: {
+            login?: string;
+        };
+    } | null;
+    project?: {
+        namespace: string | null;
+        resourceId: string | null;
+        name: string;
+    };
+    state: {
+        id?: string;
+        name: string;
+        color: string | null;
+        category?: IssueStatusCategory;
+    } | null;
+    statusTransitions?: IssueTransition[];
+    components?: IssueComponent[];
+    title: string;
+    type: string | null;
+    updatedDate: Date | null;
+    upvoteCount: number | null;
+    url: string | null;
+    milestone?: GitMilestone | null;
+}
+export interface SetIssueInput {
+    id: string;
+    graphQLId?: string;
+    number: string;
+    repository: {
+        name: string;
+        owner: {
+            login?: string;
+        };
+    } | null;
+    project?: {
+        namespace: string | null;
+        resourceId: string | null;
+        name: string;
+    };
+}
+export interface SetStatusInput {
+    name: string;
+    id?: string;
+}

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

@@ -0,0 +1,58 @@
+export interface JiraResource {
+    id: string;
+    name: string;
+    url: string;
+    avatarUrl: string;
+}
+export interface JiraProject {
+    id: string;
+    key: string;
+    name: string;
+    resourceId: string;
+}
+export interface JiraGetIssueInput {
+    resourceId: string;
+    number: string;
+}
+export interface JiraServerProject {
+    id: string;
+    name: string;
+}
+export interface SetComponentInput {
+    id: string;
+}
+export interface AvatarUrls {
+    '16x16': string;
+    '24x24': string;
+    '32x32': string;
+    '48x48': string;
+}
+export interface JiraUser {
+    accountId?: string;
+    accountType: string;
+    active: boolean;
+    avatarUrls: AvatarUrls;
+    displayName: string;
+    emailAddress: string;
+    key?: string;
+    self: string;
+    timeZone: string;
+    name?: string;
+}
+export interface JiraComponent {
+    ari?: string;
+    assignee?: JiraUser;
+    assigneeType: string;
+    description?: string;
+    id: string;
+    isAssigneeTypeValid: boolean;
+    lead?: JiraUser;
+    leadUserName?: string;
+    metadata?: unknown;
+    name: string;
+    project: string;
+    projectId: string;
+    realAssignee?: JiraUser;
+    realAssigneeType: string;
+    self: string;
+}

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

@@ -0,0 +1,22 @@
+export interface TrelloBoard {
+    id: string;
+    name: string;
+}
+export interface TrelloList {
+    id: string;
+    name: string;
+    closed: boolean;
+    pos: number;
+    softLimit: string;
+    idBoard: string;
+    subscribed: boolean;
+    limits: {
+        attachments: {
+            perBoard: {
+                status: string;
+                disableAt: number;
+                warnAt: number;
+            };
+        };
+    };
+}

package/dist/{types.d.ts → types/exportedTypes/types.d.ts}

@@ -1,5 +1,5 @@
 /// <reference types="node-fetch" />
-import { type GitPullRequest } from './providers/gitProvider';
+import { GitPullRequest } from './gitProvider';
 export type Fetch = typeof import('node-fetch').default;
 export declare const isFetch: (fetch: Fetch | RequestFunction, forceIsFetch?: boolean) => fetch is typeof import("node-fetch").default;
 export type RequestFunction = <T>(options: RequestOptions) => Promise<Response<T>>;
@@ -80,12 +80,53 @@ export type PagedResult<T> = {
 };
 export type FullFieldMap<T> = Record<keyof T, boolean>;
 export type FieldMap<T> = Partial<FullFieldMap<T>>;
-export type PullRequestBucketID = 'readyToMerge' | 'unassignedReviewers' | 'failingCI' | 'conflicts' | 'needsMyReview' | 'changesRequested' | 'reviewerCommented' | 'waitingForReview' | 'draft' | 'other';
+export type PullRequestActionCategory = 'readyToMerge' | 'unassignedReviewers' | 'failingCI' | 'conflicts' | 'needsMyReview' | 'changesRequested' | 'reviewerCommented' | 'waitingForReview' | 'draft' | 'other';
+export type PullRequestBucketID = PullRequestActionCategory | 'pinned' | 'snoozed';
 export interface PullRequestBucket {
     id: PullRequestBucketID;
     faIconName: string;
     name: string;
     priority: number;
-    pullRequests: GitPullRequest[];
+    pullRequests: PullRequestWithUniqueID[];
 }
+export type EnrichedItemsByUniqueId = {
+    [uuid: string]: EnrichedItem[];
+};
+export type EnrichedItem = {
+    id: string;
+    userId?: string;
+    type: 'pin' | 'snooze';
+    provider: 'azure' | 'bitbucket' | 'github' | 'gitlab' | 'jira' | 'trello' | 'gitkraken';
+    entityType: 'issue' | 'pr';
+    entityId: string;
+    entityUrl: string;
+    createdAt: string;
+    updatedAt: string;
+    expiresAt?: string;
+};
+export type PullRequestWithUniqueID = GitPullRequest & {
+    uuid: string;
+};
+export type ActionablePullRequest = PullRequestWithUniqueID & {
+    suggestedActionCategory: PullRequestActionCategory;
+    priority: number;
+    viewer: {
+        canMerge: boolean;
+        isAuthor: boolean;
+        isAssignee: boolean;
+        isReviewer: boolean;
+        shouldMerge: boolean;
+        shouldAssignReviewer: boolean;
+        waitingOnReviews: boolean;
+        shouldReview: boolean;
+        pinned?: boolean;
+        snoozed?: boolean;
+        enrichedItems?: EnrichedItem[];
+    };
+    failingCI: boolean;
+    hasConflicts: boolean;
+    changeRequestReviewCount: number;
+    commentReviewCount: number;
+    approvalReviewCount: number;
+};
 export type PullRequestBuckets = Record<PullRequestBucketID, PullRequestBucket>;

package/dist/{providers/azureDevops/azureDevOpsTypes.d.ts → types/internalTypes/azureDevOps.d.ts}

@@ -197,58 +197,7 @@ export interface AzureIssue {
     };
     url: string;
 }
-export interface WorkItemTypeField {
-    helpText: string;
-    alwaysRequired: boolean;
-    referenceName: string;
-    name: string;
-    url: string;
-}
-export interface WorkItemTypeTransition {
-    to: string;
-    actions: string[] | null;
-}
-export interface WorkItemState {
-    category: 'Proposed' | 'InProgress' | 'Resolved' | 'Completed' | 'Removed';
-    color: string;
-    name: string;
-}
-export interface WorkItemType {
-    name: string;
-    referenceName: string;
-    description: string;
-    color: string;
-    icon: {
-        id: string;
-        url: string;
-    };
-    isDisabled: boolean;
-    xmlForm: string;
-    fields: WorkItemTypeField[];
-    fieldInstances: WorkItemTypeField[];
-    transitions: {
-        [index: string]: WorkItemTypeTransition;
-    };
-    states: WorkItemState[];
-    url: string;
-}
-export interface AzureGraphAccount {
-    avatarUrl: string | null;
-    descriptor: string;
-    email: string | null;
-    name: string;
-    storageKeyURL: string;
-    username: string;
-}
 export interface UpdatePullRequestResponse {
     status: string;
 }
-export declare enum PullRequestAsyncStatus {
-    Conflicts = "conflicts",
-    Failure = "failure",
-    NotSet = "notSet",
-    Queued = "queued",
-    RejectedByPolicy = "rejectedByPolicy",
-    Succeeded = "succeeded"
-}
 export {};

package/dist/{providers/bitbucketServer/bitbucketServerTypes.d.ts → types/internalTypes/bitbucketServer.d.ts}

@@ -4,13 +4,6 @@ export interface Link {
 export interface NamedLink<T extends string = string> extends Link {
     name: T;
 }
-export interface BitbucketServerMergeStrategy {
-    description: string;
-    enabled: boolean;
-    flag: string;
-    id: string;
-    name: string;
-}
 export interface BitbucketServerPagedResponse<T> {
     values: T[];
     size: number;
@@ -62,6 +55,7 @@ export interface BitbucketServerUser {
     links: {
         self: Link[];
     };
+    avatarUrl?: string;
 }
 export interface BitbucketServerPullRequestUser {
     user: BitbucketServerUser;

package/dist/{providers/github/githubTypes.d.ts → types/internalTypes/github.d.ts}

@@ -1,8 +1,3 @@
-import { GetRepoInput } from '../gitProvider';
-export declare enum GitHubIssueCloseReason {
-    Completed = "COMPLETED",
-    NotPlanned = "NOT_PLANNED"
-}
 export declare enum GraphQLViewerPermission {
     ADMIN = "ADMIN",
     MAINTAIN = "MAINTAIN",
@@ -264,24 +259,6 @@ export interface GraphQLMilestone {
     title: string;
     url: string;
 }
-export interface FetchPullRequestsData {
-    repos: GetRepoInput[];
-    assigneeLogins?: string[];
-    updatedBefore?: string;
-    isDraft?: boolean;
-    authorLogin?: string;
-    mentionLogin?: string;
-    reviewRequestedLogin?: string;
-    startQuery?: string;
-}
-export interface FetchIssuesData {
-    repos: GetRepoInput[];
-    assigneeLogins?: string[];
-    updatedBefore?: string;
-    authorLogin?: string;
-    mentionLogin?: string;
-    startQuery?: string;
-}
 export interface GraphQLReviewThread {
     comments: {
         nodes: GraphQLReviewComment[];

package/dist/{providers/jira/sharedTypes.d.ts → types/internalTypes/jira.d.ts}

@@ -1,24 +1,4 @@
-export interface SetComponentInput {
-    id: string;
-}
-export interface AvatarUrls {
-    '16x16': string;
-    '24x24': string;
-    '32x32': string;
-    '48x48': string;
-}
-export interface JiraUser {
-    accountId?: string;
-    accountType: string;
-    active: boolean;
-    avatarUrls: AvatarUrls;
-    displayName: string;
-    emailAddress: string;
-    key?: string;
-    self: string;
-    timeZone: string;
-    name?: string;
-}
+import { AvatarUrls, JiraUser } from '../exportedTypes/jira';
 export interface JiraTransition {
     id: string;
     name: string;
@@ -49,23 +29,6 @@ export interface JiraComponentStub {
     name: string;
     self: string;
 }
-export interface JiraComponent {
-    ari?: string;
-    assignee?: JiraUser;
-    assigneeType: string;
-    description?: string;
-    id: string;
-    isAssigneeTypeValid: boolean;
-    lead?: JiraUser;
-    leadUserName?: string;
-    metadata?: unknown;
-    name: string;
-    project: string;
-    projectId: string;
-    realAssignee?: JiraUser;
-    realAssigneeType: string;
-    self: string;
-}
 export interface JiraIssueStatus {
     id: string;
     name: string;

package/dist/utils.d.ts

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

package/package.json

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