@gitkraken/gitkraken-components 1.0.0-rc.19 → 1.0.0-rc.20

package/dist/components/graph/GraphContainer.d.ts

@@ -60,12 +60,14 @@ export type GraphContexts = {
 };
 
 export type Head = {
+  id?: string,
   name: string;
   isCurrentHead?: boolean;
   context?: string;
 };
 
 export type Remote = {
+  id?: string,
   name: string;
   owner?: string;
   avatarUrl?: string;
@@ -74,6 +76,7 @@ export type Remote = {
 };
 
 export type Tag = {
+  id?: string,
   name: string;
   annotated?: boolean;
   context?: string;
@@ -125,6 +128,46 @@ export type GraphRef = Head
 
 export type GraphRefGroup = Array<GraphRef>;
 
+export type RefMetadataById = { [id: string]: RefMetadata | null | undefined };
+export type RefMetadata = {
+  pullRequests?: PullRequestMetadata[];
+};
+
+export type PullRequestMetadata = {
+  hostingServiceType: HostingServiceType;
+  id: number;
+  title: string;
+  author?: string;
+  date?: number;
+  state?: string;
+  url?: string;
+  context?: string;
+};
+
+// Hosting service types for pull request metadata
+export const gitHubDotComHostingServiceType = 'github';
+export const githubEnterpriseHostingServiceType = 'githubEnterprise';
+export const gitLabHostingServiceType = 'gitlab';
+export const gitLabSelfHostingServiceType = 'gitlabSelfHosted';
+export const azureDevopsHostingServiceType = 'azureDevops';
+export const bitBucketHostingServiceType = 'bitbucket';
+export const bitBucketServerHostingServiceType = 'bitbucketServer';
+export type HostingServiceType =
+  typeof GitHubDotComHostingServiceType |
+  typeof GithubEnterpriseHostingServiceType |
+  typeof BitBucketHostingServiceType |
+  typeof BitBucketServerHostingServiceType |
+  typeof GitLabHostingServiceType |
+  typeof GitLabSelfHostingServiceType |
+  typeof AzureDevopsHostingServiceType;
+
+export type RefsMissingMetadata = {
+  [refId: string]: MissingRefMetadataType[]
+}
+export const missingPullRequestMetadataType = 'pullRequests';
+// Expand this as we add more types to RefMetadata
+export type MissingRefMetadataType = typeof missingPullRequestMetadataType;
+
 // Callbacks
 export type GetExternalIcon = (key: string) => React.ReactElement<any>;
 export type TranslationFn = (key: string, ...formatArgs: any) => string;
@@ -145,6 +188,7 @@ export type OnGraphRefNodeUnhovered = (event: any, refGroup: GraphRefGroup, grap
 export type OnGraphColumnResized = (graphZoneType: GraphZoneType, columnSettings: GraphColumnSetting) => void;
 export type OnShowMoreCommits = () => void;
 export type OnEmailsMissingAvatarUrls = (emails: { [email: string]: string }) => void;
+export type OnRefsMissingMetadata = (refs: RefsMissingMetadata) => void;
 
 // Main graph component
 export interface GraphContainerProps {
@@ -169,6 +213,7 @@ export interface GraphContainerProps {
   // pendingCommitMessageSummary: string;
   // repoPath: string;
   columnsSettings?: GraphColumnsSettings;
+  refMetadataById?: RefMetadataById;
   themeOpacityFactor?: number;
   translate?: TranslationFn;
   useAuthorInitialsForAvatars?: boolean;
@@ -192,6 +237,7 @@ export interface GraphContainerProps {
   // onWipNodeInputWillUnmount: OnComponentWillUnmount;
   // onUpdateGraphWidth: OnUpdateGraphWidth;
   onEmailsMissingAvatarUrls?: OnEmailsMissingAvatarUrls;
+  onRefsMissingMetadata?: OnRefsMissingMetadata;
   formatCommitDateTime?: OnFormatCommitDateTime;
   shaLength?: number;
   nonce?: string;
@@ -211,6 +257,7 @@ declare class GraphContainer extends React.PureComponent<GraphContainerProps, an
   ): void;
   forceUpdate(callback?: () => void): void;
   render(): JSX.Element;
+  selectCommits(shas: Sha[], includeToPrevSel: boolean): void;
 }
 
 export default GraphContainer;