@gitkraken/provider-apis 0.19.1 → 0.21.0

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

@@ -0,0 +1,301 @@
+export interface Options {
+    token?: string;
+    isPAT?: boolean;
+}
+export interface EnterpriseOptions extends Options {
+    baseUrl?: string;
+}
+export interface User {
+    name: string | null;
+    email: string | null;
+    avatarUrl: string | null;
+}
+export interface Account extends User {
+    id: string;
+    graphQLId?: string;
+    username: string | null;
+    url: string | null;
+}
+export interface Organization {
+    id: string;
+    graphQLId?: string;
+    username: string;
+    name: string | null;
+    email: string | null;
+    avatarUrl: string;
+}
+export declare enum GitBuildStatusStage {
+    Build = "build",
+    Production = "production",
+    Staging = "staging",
+    Test = "test"
+}
+export declare enum GitBuildStatusState {
+    ActionRequired = "ACTION_REQUIRED",
+    Cancelled = "CANCELLED",
+    Error = "ERROR",
+    Failed = "FAILED",
+    Pending = "PENDING",
+    Running = "RUNNING",
+    Skipped = "SKIPPED",
+    Success = "SUCCESS",
+    Warning = "WARNING",
+    OptionalActionRequired = "OPTIONAL_ACTION_REQUIRED"
+}
+export interface GitBuildStatus {
+    completedAt: Date | null;
+    description: string | null;
+    name: string | null;
+    state: GitBuildStatusState | null;
+    stage: GitBuildStatusStage | null;
+    startedAt: Date | null;
+    url: string;
+}
+export interface GitLabel {
+    color: string | null;
+    description: string | null;
+    graphQLId?: string;
+    id: string | null;
+    name: string;
+}
+export interface GitMilestone {
+    id: string;
+    graphQLId?: string;
+    number: number;
+    title: string;
+    description: string | null;
+    isOpen: boolean;
+    url: string;
+    startDate: Date | null;
+    dueDate: Date | null;
+}
+export interface GitRepository {
+    id: string;
+    graphQLId?: string;
+    namespace: string;
+    name: string;
+    project?: string;
+    webUrl: string | null;
+    httpsUrl: string | null;
+    sshUrl: string | null;
+    defaultBranch: GitRef | null;
+    permission: string | null;
+}
+export interface GitRef {
+    name: string;
+}
+export interface GitRefWithOID extends GitRef {
+    oid: string | null;
+}
+export interface GitRefWithCommit extends GitRef {
+    commit: GitCommit | null;
+}
+export interface GitCommit {
+    oid: string;
+    authoredDate: Date | null;
+    committedDate: Date | null;
+}
+export interface GitBlame {
+    ranges: {
+        startingLine: number;
+        endingLine: number;
+        commit: GitCommit & {
+            parentOids: string[];
+            message: string;
+            author: User | null;
+            committer: User | null;
+            fileCount: number | null;
+            additions: number | null;
+            deletions: number | null;
+        };
+    }[];
+}
+export declare enum GitMergeStrategy {
+    MergeCommit = "MERGE_COMMIT",
+    Rebase = "REBASE",
+    RebaseThenMergeCommit = "REBASE_THEN_MERGE_COMMIT",
+    FastForward = "FAST_FORWARD",
+    Squash = "SQUASH"
+}
+export declare enum GitPullRequestState {
+    Open = "OPEN",
+    Closed = "CLOSED",
+    Merged = "MERGED"
+}
+export declare enum GitPullRequestReviewState {
+    Approved = "APPROVED",
+    ChangesRequested = "CHANGES_REQUESTED",
+    Commented = "COMMENTED",
+    ReviewRequested = "REVIEW_REQUESTED"
+}
+export declare enum GitPullRequestMergeableState {
+    Behind = "BEHIND",
+    Blocked = "BLOCKED",
+    Conflicts = "CONFLICTS",
+    Mergeable = "MERGEABLE",
+    Unknown = "UNKNOWN",
+    UnknownAndBlocked = "UNKNOWN_AND_BLOCKED",
+    Unstable = "UNSTABLE"
+}
+export interface GitPullRequestPermissions {
+    canMerge: boolean;
+    canMergeAndBypassProtections: boolean;
+}
+export interface GitPullRequest {
+    id: string;
+    graphQLId?: string;
+    number: number;
+    title: string;
+    url: string | null;
+    state: GitPullRequestState;
+    isDraft: boolean;
+    createdDate: Date;
+    updatedDate: Date;
+    closedDate: Date | null;
+    mergedDate: Date | null;
+    baseRef: GitRefWithOID | null;
+    headRef: GitRefWithOID | null;
+    commentCount: number | null;
+    upvoteCount: number | null;
+    commitCount: number | null;
+    fileCount: number | null;
+    additions: number | null;
+    deletions: number | null;
+    author: Account | null;
+    assignees: Account[] | null;
+    reviews: {
+        reviewer: Account;
+        state: GitPullRequestReviewState;
+    }[] | null;
+    reviewDecision: GitPullRequestReviewState | null;
+    repository: {
+        id: string;
+        graphQLId?: string;
+        name: string;
+        project?: string;
+        owner: {
+            login: string;
+        };
+        remoteInfo: {
+            cloneUrlHTTPS: string;
+            cloneUrlSSH: string;
+        } | null;
+    };
+    headRepository: {
+        id: string;
+        graphQLId?: string;
+        name: string;
+        project?: string;
+        owner: {
+            login: string;
+        };
+        remoteInfo: {
+            cloneUrlHTTPS: string;
+            cloneUrlSSH: string;
+        } | null;
+    } | null;
+    headCommit: {
+        buildStatuses: GitBuildStatus[] | null;
+    } | null;
+    mergeableState: GitPullRequestMergeableState;
+    milestone?: GitMilestone | null;
+    labels?: GitLabel[];
+    permissions: GitPullRequestPermissions | null;
+    version?: number;
+}
+export interface GitComment {
+    author: Account | User | null;
+    body: string;
+    createdAt: Date | null;
+    id: string;
+    graphQLId?: string;
+    url: string;
+}
+export declare enum GitDiffLineType {
+    ADDED = "ADDED",
+    DELETED = "DELETED",
+    UNMODIFIED = "UNMODIFIED"
+}
+export interface GitDiffLine {
+    line: string;
+    oldLineNumber: number | null;
+    newLineNumber: number | null;
+    type: GitDiffLineType;
+}
+export interface GitPullRequestReviewComment extends GitComment {
+    diffLines: GitDiffLine[];
+    filename: string;
+    replies: GitComment[];
+    isOutdated: boolean;
+    isResolved: boolean;
+}
+export interface GitPullRequestReview extends GitComment {
+    reviewComments: GitPullRequestReviewComment[];
+}
+export interface GetRepoInput {
+    namespace: string;
+    name: string;
+    project?: string;
+}
+export interface GetReposInput {
+    repos: GetRepoInput[];
+}
+export type GetPRForRepoInput = {
+    repo: GetRepoInput;
+    number: number;
+};
+export interface SetPullRequestInput {
+    id: string;
+    number: number;
+    graphQLId?: string;
+    repository: {
+        id: string;
+        name: string;
+        project?: string;
+        owner: {
+            login: string;
+        };
+    };
+    version?: number;
+}
+export interface SetMilestoneInput {
+    id: string;
+    graphQLId?: string;
+}
+export interface SetAccountInput {
+    id: string;
+    name: string | null;
+    graphQLId?: string;
+    username: string | null;
+}
+export interface CreateCommitInput {
+    commitMessage: {
+        description?: string;
+        summary: string;
+    };
+    deletedFiles: string[];
+    newOrModifiedFiles: {
+        [filePath: string]: string;
+    };
+    repo: GetRepoInput;
+    target: {
+        name: string;
+        oid: string;
+    };
+}
+export interface SetLabelInput {
+    id: string | null;
+    graphQLId?: string;
+    name: string;
+}
+export interface CursorPageInput {
+    cursor?: string | null;
+}
+export interface NumberedPageInput {
+    page?: number | null;
+}
+export type PageInput = CursorPageInput | NumberedPageInput;
+export interface GetRepoErrorData {
+    input: GetRepoInput;
+    error?: Error;
+}

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,90 @@ 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 declare enum EntityVersion {
+    Zero = "0",
+    One = "1"
+}
+export declare enum EntityType {
+    PullRequest = "0",
+    Issue = "1"
+}
+export declare enum EntityIdentifierProviderType {
+    Azure = "0",
+    Github = "1",
+    GithubEnterprise = "2",
+    Gitlab = "3",
+    GitlabSelfHosted = "4",
+    Bitbucket = "5",
+    BitbucketServer = "6",
+    Jira = "7",
+    JiraServer = "8",
+    Trello = "9"
+}
+export type EntityIdentifier = {
+    provider: EntityIdentifierProviderType;
+    entityType: EntityType;
+    version: EntityVersion;
+    domain: string | null;
+    resourceId: string | null;
+    accountOrOrgId: string | null;
+    organizationName: string | null;
+    projectId: string | null;
+    repoId: string | null;
+    entityId: string;
+};
+export interface EntityIdentifierInterface {
+    encode(entityIdentifier: EntityIdentifier): string;
+    decode(entityFields: string[]): EntityIdentifier;
+    validate(entityIdentifier: EntityIdentifier): void;
+}
+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;

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[];