@gitkraken/gitkraken-components 1.1.0-rc.2 → 1.1.0-rc.22

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

@@ -11,10 +11,17 @@ 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 CssVariables = { [variable: string]: string };
+export type ExcludeByType = {
+  heads?: boolean;
+  remotes?: boolean;
+  stashes?: boolean;
+  tags?: boolean;
+};
+export type ExcludeRefsById = { [refId: string]: GraphRefOptData };
+export type IncludeOnlyRefsById = { [refId: string]: GraphRefOptData };
+export type IsSelectedBySha = { [sha: Sha]: boolean };
+export type HighlightedShas = { [sha: Sha]: boolean };
 
 export type WorkDirType = typeof mergeConflictNodeType
   | typeof unsupportedRebaseWarningNodeType
@@ -59,35 +66,33 @@ export type RowContexts = {
   sha?: GraphItemContext;
 };
 
+export type RowStats = {
+  files: number;
+  additions: number;
+  deletions: number;
+};
+
 export type GraphContexts = {
   graph?: GraphItemContext;
   header?: GraphItemContext;
 };
 
-export interface Head {
-  id?: string,
+interface Ref {
+  id?: string;
   name: string;
-  isCurrentHead?: boolean;
   context?: GraphItemContext;
   contextGroup?: GraphItemContext;
 }
-
-export interface Remote {
-  id?: string,
-  name: string;
+export interface Head extends Ref {
+  isCurrentHead?: boolean;
+}
+export interface Remote extends Ref {
   owner?: string;
   avatarUrl?: string;
   url?: string;
-  context?: GraphItemContext;
-  contextGroup?: GraphItemContext;
 }
-
-export interface Tag {
-  id?: string,
-  name: string;
+export interface Tag extends Ref {
   annotated?: boolean;
-  context?: GraphItemContext;
-  contextGroup?: GraphItemContext;
 }
 
 export type GraphRow = {
@@ -102,11 +107,13 @@ export type GraphRow = {
   remotes?: Remote[];
   tags?: Tag[];
   contexts?: RowContexts;
+  stats?: RowStats;
 };
 
 export type GraphColumnSetting = {
   width: number,
-  isHidden: boolean
+  isHidden: boolean,
+  order?: number
 };
 
 export type AvatarUrlByEmail = { [email: string]: string };
@@ -148,6 +155,7 @@ export type GraphRefGroup = Array<GraphRef>;
 export type RefMetadataById = { [id: string]: RefMetadata | null | undefined } | null;
 export type RefMetadata = {
   pullRequests?: PullRequestMetadata[] | null;
+  upstream?: UpstreamMetadata | null;
 };
 
 export type PullRequestMetadata = {
@@ -161,6 +169,14 @@ export type PullRequestMetadata = {
   context?: GraphItemContext;
 };
 
+export type UpstreamMetadata = {
+  name: string,
+  owner: string,
+  ahead: number,
+  behind: number,
+  sha?: Sha
+};
+
 // Hosting service types for pull request metadata
 export const gitHubDotComHostingServiceType = 'github';
 export const githubEnterpriseHostingServiceType = 'githubEnterprise';
@@ -182,8 +198,9 @@ export type RefsMissingMetadata = {
   [refId: string]: RefMetadataType[]
 }
 export const pullRequestMetadataType = 'pullRequests';
+export const upstreamMetadataType = 'upstream';
 // Expand this as we add more types to RefMetadata
-export type RefMetadataType = typeof pullRequestMetadataType;
+export type RefMetadataType = typeof pullRequestMetadataType | typeof upstreamMetadataType;
 
 // Callbacks
 export type GetExternalIcon = (key: string) => React.ReactElement<any>;
@@ -203,10 +220,12 @@ export type OnGraphRowHovered = (event: any, graphZoneType: GraphZoneType, graph
 export type OnGraphRowUnhovered = (event: any, graphZoneType: GraphZoneType, graphRow: GraphRow) => void;
 export type OnGraphRefNodeHovered = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow) => void;
 export type OnGraphRefNodeUnhovered = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow) => void;
+export type OnGraphColumnsReOrdered = (columnsSettings: GraphColumnsSettings) => void;
 export type OnGraphColumnResized = (graphZoneType: GraphZoneType, columnSettings: GraphColumnSetting) => void;
 export type OnGraphResized = (width: number, height: number) => void;
+export type OnGraphVisibleRowsChanged = (topVisibleRow: GraphRow, bottomVisibleRow: GraphRow) => void;
 export type OnShowMoreCommits = () => void;
-export type OnEmailsMissingAvatarUrls = (emails: { [email: string]: string }) => void;
+export type OnEmailsMissingAvatarUrls = (emails: AvatarUrlByEmail) => void;
 export type OnRefsMissingMetadata = (refs: RefsMissingMetadata) => void;
 
 // Main graph component
@@ -215,15 +234,21 @@ export interface GraphContainerProps {
   contexts?: GraphContexts;
   platform?: GraphPlatform;
   cssVariables?: CssVariables;
+  dimMergeCommits?: boolean;
   getExternalIcon: GetExternalIcon;
-  highlightRowsOnRefHover?: boolean,
-  showGhostRefsOnRowHover?: boolean,
-  showRemoteNamesOnRefs?: boolean,
-  enableMultiSelection?: boolean,
+  highlightRowsOnRefHover?: boolean;
+  isContainerWindowFocused?: boolean;
+  showGhostRefsOnRowHover?: boolean;
+  showRemoteNamesOnRefs?: boolean;
+  showUpstreamStatus?: boolean;
+  scrollRowPadding?: number;
+  enableMultiSelection?: boolean;
   graphRows: GraphRow[];
   hasMoreCommits?: boolean;
   highlightedShas?: HighlightedShas;
-  hiddenRefsById?: HiddenRefsById;
+  excludeByType?: ExcludeByType;
+  excludeRefsById?: ExcludeRefsById;
+  includeOnlyRefsById?: IncludeOnlyRefsById;
   isSelectedBySha?: IsSelectedBySha;
   isLoadingRows?: boolean;
   columnsSettings?: GraphColumnsSettings;
@@ -234,11 +259,12 @@ export interface GraphContainerProps {
   workDirStats?: WorkDirStats;
   onRowContextMenu?: OnRowContextMenu;
   onRefContextMenu?: OnRefContextMenu;
-  onToggleRefsVisibilityClick?: OnToggleRefsVisibilityClick,
+  onToggleRefsVisibilityClick?: OnToggleRefsVisibilityClick;
   onGraphRowHovered?: OnGraphRowHovered;
   onGraphRowUnhovered?: OnGraphRowUnhovered;
   onGraphRefNodeHovered?: OnGraphRefNodeHovered;
   onGraphRefNodeUnhovered?: OnGraphRefNodeUnhovered;
+  onGraphColumnsReOrdered?: OnGraphColumnsReOrdered;
   onColumnResized?: OnGraphColumnResized;
   onClickGraphRef?: OnClickGraphRef;
   onClickGraphRow?: OnClickGraphRow;
@@ -247,10 +273,11 @@ export interface GraphContainerProps {
   onSelectGraphRows?: OnSelectGraphRows;
   onShowMoreCommits?: OnShowMoreCommits;
   onGraphResized?: OnGraphResized;
+  onGraphVisibleRowsChanged?: OnGraphVisibleRowsChanged;
   onEmailsMissingAvatarUrls?: OnEmailsMissingAvatarUrls;
   onRefsMissingMetadata?: OnRefsMissingMetadata;
   formatCommitDateTime?: OnFormatCommitDateTime;
-  shaLength?: number;
+  shaLength?: number | null;
   nonce?: string;
 }
 
@@ -268,7 +295,7 @@ declare class GraphContainer extends React.PureComponent<GraphContainerProps, an
   ): void;
   forceUpdate(callback?: () => void): void;
   render(): JSX.Element;
-  selectCommits(shas: Sha[], includeToPrevSel: boolean): void;
+  selectCommits(shas: Sha[], includeToPrevSel: boolean, isAutoOrKeyScroll: boolean): void;
 }
 
 export default GraphContainer;