@gitkraken/gitkraken-components 1.0.0-rc.9 → 1.0.0

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

@@ -12,7 +12,9 @@ import {
 // Input variables
 export type Sha = string;
 export type CssVariables = {[variable: string]: string};
+export type HiddenRefsById = {[refId: string]: GraphRefOptData};
 export type IsSelectedBySha = {[sha: Sha]: boolean};
+export type HighlightedShas = {[sha: Sha]: boolean};
 
 export type WorkDirType = typeof mergeConflictNodeType
   | typeof unsupportedRebaseWarningNodeType
@@ -42,22 +44,51 @@ export type GraphPlatform = 'aix'
   | 'win32'
   | 'cygwin';
 
-export type Head = {
+export type GraphItemContext = string | object;
+export type RefGroupContexts = { [name: string]: GraphItemContext };
+
+export type RowContexts = {
+  row?: GraphItemContext;
+  ref?: GraphItemContext;
+  refGroups?: RefGroupContexts;
+  graph?: GraphItemContext;
+  avatar?: GraphItemContext;
+  message?: GraphItemContext;
+  author?: GraphItemContext;
+  date?: GraphItemContext;
+  sha?: GraphItemContext;
+};
+
+export type GraphContexts = {
+  graph?: GraphItemContext;
+  header?: GraphItemContext;
+};
+
+export interface Head {
+  id?: string,
   name: string;
   isCurrentHead?: boolean;
-};
+  context?: GraphItemContext;
+  contextGroup?: GraphItemContext;
+}
 
-export type Remote = {
+export interface Remote {
+  id?: string,
   name: string;
   owner?: string;
   avatarUrl?: string;
   url?: string;
-};
+  context?: GraphItemContext;
+  contextGroup?: GraphItemContext;
+}
 
-export type Tag = {
+export interface Tag {
+  id?: string,
   name: string;
   annotated?: boolean;
-};
+  context?: GraphItemContext;
+  contextGroup?: GraphItemContext;
+}
 
 export type GraphRow = {
   sha: Sha;
@@ -70,19 +101,22 @@ export type GraphRow = {
   heads?: Head[];
   remotes?: Remote[];
   tags?: Tag[];
-  avatarUrl?: string;
+  contexts?: RowContexts;
 };
 
 export type GraphColumnSetting = {
-  width: number
+  width: number,
+  isHidden: boolean
 };
 
-export const REF_ZONE_TYPE = 'refZone';
-export const GRAPH_ZONE_TYPE = 'commitZone';
-export const MESSAGE_ZONE_TYPE = 'commitMessageZone';
-export const AUTHOR_ZONE_TYPE = 'commitAuthorZone';
-export const DATE_TIME_ZONE_TYPE = 'commitDateTimeZone';
-export const SHA_ZONE_TYPE = 'commitShaZone';
+export type AvatarUrlByEmail = { [email: string]: string };
+
+export const REF_ZONE_TYPE = 'ref';
+export const GRAPH_ZONE_TYPE = 'graph';
+export const MESSAGE_ZONE_TYPE = 'message';
+export const AUTHOR_ZONE_TYPE = 'author';
+export const DATE_TIME_ZONE_TYPE = 'datetime';
+export const SHA_ZONE_TYPE = 'sha';
 
 export type GraphZoneType = typeof REF_ZONE_TYPE
   | typeof GRAPH_ZONE_TYPE
@@ -93,23 +127,73 @@ export type GraphZoneType = typeof REF_ZONE_TYPE
 
 export type GraphColumnsSettings = { [graphZoneType: string]: GraphColumnSetting };
 
-export type GraphRef = Head
-  | Remote
-  | Tag
-  | {
-    refType: string
-  };
+export type GraphRefType = 'head'
+  | 'remote'
+  | 'tag';
+
+export interface GraphRef extends Head, Remote, Tag {
+  refType: GraphRefType;
+}
+
+export type GraphRefOptData = {
+  id: string;
+  name: string;
+  type: GraphRefType;
+  owner?: string;
+  avatarUrl?: string;
+};
 
 export type GraphRefGroup = Array<GraphRef>;
 
+export type RefMetadataById = { [id: string]: RefMetadata | null | undefined } | null;
+export type RefMetadata = {
+  pullRequests?: PullRequestMetadata[] | null;
+};
+
+export type PullRequestMetadata = {
+  hostingServiceType: HostingServiceType;
+  id: number;
+  title: string;
+  author?: string;
+  date?: number;
+  state?: string;
+  url?: string;
+  context?: GraphItemContext;
+};
+
+// 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]: RefMetadataType[]
+}
+export const pullRequestMetadataType = 'pullRequests';
+// Expand this as we add more types to RefMetadata
+export type RefMetadataType = typeof pullRequestMetadataType;
+
 // Callbacks
-export type GetExternalIcon = (key: string) => ReactElement<*>;
+export type GetExternalIcon = (key: string) => React.ReactElement<any>;
 export type TranslationFn = (key: string, ...formatArgs: any) => string;
 export type OnFormatCommitDateTime = (commitDateTime: number) => string;
 
 // Events
 export type OnRowContextMenu = (event: any, graphZoneType: GraphZoneType, graphRow: GraphRow) => void;
 export type OnRefContextMenu = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow) => void;
+export type OnToggleRefsVisibilityClick = (event: React.MouseEvent, refs: GraphRefOptData[], visible: boolean, graphRow?: GraphRow) => void;
 export type OnClickGraphRow = (event: any, graphZoneType: GraphZoneType, graphRow: GraphRow) => void;
 export type OnClickGraphRef = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow) => void;
 export type OnDoubleClickGraphRow = (event: any, graphZoneType: GraphZoneType, graphRow: GraphRow) => void;
@@ -121,17 +205,26 @@ export type OnGraphRefNodeHovered = (event: any, refGroup: GraphRefGroup, graphR
 export type OnGraphRefNodeUnhovered = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow) => void;
 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 {
+  avatarUrlByEmail?: AvatarUrlByEmail;
+  contexts?: GraphContexts;
   height?: number;
   width?: number;
   platform?: GraphPlatform;
   cssVariables?: CssVariables;
   getExternalIcon: GetExternalIcon;
+  highlightRowsOnRefHover?: boolean,
+  showGhostRefsOnRowHover?: boolean,
+  showRemoteNamesOnRefs?: boolean,
   enableMultiSelection?: boolean,
   graphRows: GraphRow[];
   hasMoreCommits?: boolean;
+  highlightedShas?: HighlightedShas;
+  hiddenRefsById?: HiddenRefsById;
   // isCommitting: boolean;
   isSelectedBySha?: IsSelectedBySha;
   // isInUnsupportedRebase: boolean;
@@ -140,12 +233,14 @@ export interface GraphContainerProps {
   // pendingCommitMessageSummary: string;
   // repoPath: string;
   columnsSettings?: GraphColumnsSettings;
+  refMetadataById?: RefMetadataById;
   themeOpacityFactor?: number;
   translate?: TranslationFn;
   useAuthorInitialsForAvatars?: boolean;
   workDirStats?: WorkDirStats;
   onRowContextMenu?: OnRowContextMenu;
   onRefContextMenu?: OnRefContextMenu;
+  onToggleRefsVisibilityClick?: OnToggleRefsVisibilityClick,
   onGraphRowHovered?: OnGraphRowHovered;
   onGraphRowUnhovered?: OnGraphRowUnhovered;
   onGraphRefNodeHovered?: OnGraphRefNodeHovered;
@@ -162,6 +257,8 @@ export interface GraphContainerProps {
   onShowMoreCommits?: OnShowMoreCommits;
   // onWipNodeInputWillUnmount: OnComponentWillUnmount;
   // onUpdateGraphWidth: OnUpdateGraphWidth;
+  onEmailsMissingAvatarUrls?: OnEmailsMissingAvatarUrls;
+  onRefsMissingMetadata?: OnRefsMissingMetadata;
   formatCommitDateTime?: OnFormatCommitDateTime;
   shaLength?: number;
   nonce?: string;
@@ -181,6 +278,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;