@gitkraken/provider-apis 0.25.3 → 0.25.5

package/dist/providerUtils/gitProvider.d.ts

@@ -1,5 +1,5 @@
 import { type Account } from '../types/exportedTypes/gitProvider';
-import type { ActionablePullRequest, CodeSuggestionsCountByPrUuid, EnrichedItemsByUniqueId, PullRequestBuckets, PullRequestWithUniqueID } from '../types/exportedTypes/types';
+import type { ActionablePullRequest, CodeSuggestionsCountByPrUuid, EnrichedItemsByUniqueId, OrganizationMemberIdentitiesMap, OrganizationMemberIdentityPrProvider, PullRequestBuckets, PullRequestGroupByCategory, PullRequestWithUniqueID, Team, Workspace } from '../types/exportedTypes/types';
 export declare const PINNED_BUCKET_ID = "pinned";
 export declare const READY_TO_MERGE_BUCKET_ID = "readyToMerge";
 export declare const UNASSIGNED_REVIEWERS_BUCKET_ID = "unassignedReviewers";
@@ -30,3 +30,47 @@ export declare const groupPullRequestsIntoBuckets: (pullRequests: PullRequestWit
     enrichedItemsByUniqueId?: EnrichedItemsByUniqueId;
     codeSuggestionsCountByPrUuid?: CodeSuggestionsCountByPrUuid;
 }) => PullRequestBuckets;
+/**
+ *
+ * @param pullRequests the list of PRs with unique IDs from provider package
+ * @returns PullRequestGroupByCategory - similar structure to status buckets where the bucketId is the repo's unique id
+ */
+export declare const groupPullRequestsByRepo: (pullRequests: PullRequestWithUniqueID[]) => PullRequestGroupByCategory | import("../types/exportedTypes/types").IssueGroupByCategory;
+/**
+ *
+ * @param pullRequests the list of PRs with unique IDs from provider package
+ * @returns PullRequestGroupByCategory - similar structure to status buckets where the bucketId is the assignee's unique id
+ *   If PR has multiple assignees, it will end up in all relevant assignee groups
+ */
+export declare const groupPullRequestsByAssignee: (pullRequests: PullRequestWithUniqueID[]) => PullRequestGroupByCategory | import("../types/exportedTypes/types").IssueGroupByCategory;
+/**
+ *
+ * @param pullRequests the list of PRs with unique IDs from provider package
+ * @returns PullRequestGroupByCategory - similar structure to status buckets where the bucketId is the author's unique id
+ */
+export declare const groupPullRequestsByAuthor: (pullRequests: PullRequestWithUniqueID[]) => PullRequestGroupByCategory | import("../types/exportedTypes/types").IssueGroupByCategory;
+/**
+ *
+ * @param pullRequests the list of PRs with unique IDs from provider package
+ * @returns PullRequestGroupByCategory - similar structure to status buckets where the bucketId is the reviewer's unique id
+ *   If PR has multiple reviewers, it will end up in all relevant reviewer groups
+ */
+export declare const groupPullRequestsByReviewer: (pullRequests: PullRequestWithUniqueID[]) => PullRequestGroupByCategory | import("../types/exportedTypes/types").IssueGroupByCategory;
+/**
+ *
+ * @param pullRequests the list of PRs with unique IDs from provider package
+ * @param workspaces the list of workspaces. This should match the value returned from the /workspaces API
+ * @returns PullRequestGroupByCategory - similar structure to status buckets where the bucketId is the workspace's unique id
+ *   If repo for PR belongs to multiple workspaces, it will end up in all relevant workspace groups
+ */
+export declare const groupPullRequestsByWorkspace: (pullRequests: PullRequestWithUniqueID[], workspaces: Workspace[]) => PullRequestGroupByCategory | import("../types/exportedTypes/types").IssueGroupByCategory;
+/**
+ *
+ * @param pullRequests the list of PRs with unique IDs from provider package
+ * @param organizationMemberIdentities the response from the member-identities route. map of GK id to provider ids
+ * @param provider the provider name to get the user id from
+ * @param teams a list of organization teams
+ * @returns similar structure to status buckets where the bucketId is the team's unique id
+ * @todo future improvement is to let surface define relationship of users. So surface could say 'team member is author' or something
+ */
+export declare const groupPullRequestsByGitKrakenTeam: (pullRequests: PullRequestWithUniqueID[], organizationMemberIdentities: OrganizationMemberIdentitiesMap, provider: OrganizationMemberIdentityPrProvider, teams: Team[]) => PullRequestGroupByCategory | import("../types/exportedTypes/types").IssueGroupByCategory;

package/dist/providerUtils/issueProvider.d.ts

@@ -0,0 +1,30 @@
+import { IssueGroupByCategory, IssueWithUniqueID, OrganizationMemberIdentitiesMap, OrganizationMemberIdentityIssueProvider, Team } from '../types/exportedTypes/types';
+/**
+ *
+ * @param issues the list of issues with unique IDs from provider package
+ * @returns IssueGroupByCategory - where the bucketId is the repo's unique id
+ */
+export declare const groupIssuesByRepo: (issues: IssueWithUniqueID[]) => import("../types/exportedTypes/types").PullRequestGroupByCategory | IssueGroupByCategory;
+/**
+ *
+ * @param issues the list of issues with unique IDs from provider package
+ * @returns IssueGroupByCategory -  where the bucketId is the assignee's unique id
+ *   If issue has multiple assignees, item will end up in all relevant assignee groups
+ */
+export declare const groupIssuesByAssignee: (issues: IssueWithUniqueID[]) => import("../types/exportedTypes/types").PullRequestGroupByCategory | IssueGroupByCategory;
+/**
+ *
+ * @param issues the list of issues with unique IDs from provider package
+ * @returns IssueGroupByCategory - where the bucketId is the author's unique id
+ */
+export declare const groupIssuesByAuthor: (issues: IssueWithUniqueID[]) => import("../types/exportedTypes/types").PullRequestGroupByCategory | IssueGroupByCategory;
+/**
+ *
+ * @param issues the list of issues with unique IDs from provider package
+ * @param organizationMemberIdentities the response from the member-identities route. map of GK id to provider ids
+ * @param provider the provider name to get the user id from
+ * @param teams a list of organization teams
+ * @returns  IssueGroupByCategory - where the bucketId is the team's unique id
+ * @todo future improvement is to let surface define relationship of users. So surface could say 'team member is author' or something
+ */
+export declare const groupIssuesByGitKrakenTeam: (issues: IssueWithUniqueID[], organizationMemberIdentities: OrganizationMemberIdentitiesMap, provider: OrganizationMemberIdentityIssueProvider, teams: Team[]) => import("../types/exportedTypes/types").PullRequestGroupByCategory | IssueGroupByCategory;

package/dist/providerUtils/shared.d.ts

@@ -1,4 +1,7 @@
-import { GitPullRequestReviewState } from '../types/exportedTypes/gitProvider';
+import { Account, GitPullRequestReviewState } from '../types/exportedTypes/gitProvider';
+import { IssueGroupByCategory, PullRequestGroupByCategory } from '../types/exportedTypes/types';
 export declare const summarizeReviewDecision: (reviews: {
     state: GitPullRequestReviewState;
 }[] | null) => GitPullRequestReviewState | null;
+export declare const getAccountNameWithFallback: (account: Account, fallback: string) => string;
+export declare const setGroupPriorityAlphabetically: (groupedItems: PullRequestGroupByCategory | IssueGroupByCategory) => PullRequestGroupByCategory | IssueGroupByCategory;

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

@@ -1,5 +1,6 @@
 /// <reference types="node-fetch" />
-import { GitPullRequest } from './gitProvider';
+import { Account, GitPullRequest } from './gitProvider';
+import { Issue } from './issueProvider';
 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>>;
@@ -82,13 +83,21 @@ export type FullFieldMap<T> = Record<keyof T, boolean>;
 export type FieldMap<T> = Partial<FullFieldMap<T>>;
 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;
+interface PullRequestBucketBase {
     name: string;
     priority: number;
     pullRequests: PullRequestWithUniqueID[];
 }
+export interface PullRequestBucket extends PullRequestBucketBase {
+    id: PullRequestBucketID;
+    faIconName: string;
+}
+export interface PullRequestGroupByBucket extends PullRequestBucketBase {
+    id: string;
+    accountData?: Account;
+}
+export type OrganizationMemberIdentityPrProvider = 'github' | 'gitlab' | 'bitbucket' | 'azure';
+export type OrganizationMemberIdentityIssueProvider = 'github' | 'gitlab' | 'jira' | 'azure' | 'trello';
 export type EnrichedItemsByUniqueId = {
     [uuid: string]: EnrichedItem[];
 };
@@ -136,3 +145,52 @@ export type ActionablePullRequest = PullRequestWithUniqueID & {
     approvalReviewCount: number;
 };
 export type PullRequestBuckets = Record<PullRequestBucketID, PullRequestBucket>;
+export type IssueWithUniqueID = Issue & {
+    uuid: string;
+};
+export interface IssueGroupByBucket {
+    name: string;
+    priority: number;
+    issues: IssueWithUniqueID[];
+    id: string;
+    accountData?: Account;
+}
+export interface PullRequestGroupByCategory {
+    [bucketId: string]: PullRequestGroupByBucket;
+}
+export interface IssueGroupByCategory {
+    [bucketId: string]: IssueGroupByBucket;
+}
+export interface Workspace {
+    id: string;
+    name: string;
+    azureOrganizationId?: string | null;
+    azureProject?: string;
+    provider: string;
+    providerData?: {
+        repositories: {
+            nodes: {
+                name: string;
+                id: string;
+                repositoryId?: string;
+                providerOrganizationId?: string;
+                providerProjectName?: string;
+            }[];
+        };
+    };
+}
+export interface OrganizationMemberIdentitiesMap {
+    [gkId: string]: {
+        [provider in OrganizationMemberIdentityPrProvider | OrganizationMemberIdentityIssueProvider]: {
+            providerID: string;
+        };
+    };
+}
+export interface Team {
+    id: string;
+    members: {
+        id: string;
+    }[];
+    name: string;
+}
+export {};

package/package.json

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