@gitkraken/gitkraken-components 1.1.0-rc.9 → 2.1.0

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

@@ -1,6 +1,7 @@
 // eslint-disable-next-line no-unused-vars
 import * as React from 'react';
 import {
+  CommitDateTimeSources,
   commitNodeType,
   mergeConflictNodeType,
   mergeNodeType,
@@ -30,7 +31,8 @@ export type WorkDirType = typeof mergeConflictNodeType
 export type WorkDirStats = {
   added: number,
   deleted: number,
-  modified: number
+  modified: number,
+  context?: GraphItemContext
   // TODO: Add renamed once available in GitLens from provider
   // renamed: number
 };
@@ -66,6 +68,12 @@ export type RowContexts = {
   sha?: GraphItemContext;
 };
 
+export type RowStats = {
+  files: number;
+  additions: number;
+  deletions: number;
+};
+
 export type GraphContexts = {
   graph?: GraphItemContext;
   header?: GraphItemContext;
@@ -101,6 +109,7 @@ export type GraphRow = {
   remotes?: Remote[];
   tags?: Tag[];
   contexts?: RowContexts;
+  stats?: RowStats;
 };
 
 export type GraphColumnSetting = {
@@ -148,9 +157,14 @@ 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 = {
+export interface BaseMetadata {
+  context?: GraphItemContext;
+}
+
+export interface PullRequestMetadata extends BaseMetadata {
   hostingServiceType: HostingServiceType;
   id: number;
   title: string;
@@ -158,8 +172,15 @@ export type PullRequestMetadata = {
   date?: number;
   state?: string;
   url?: string;
-  context?: GraphItemContext;
-};
+}
+
+export interface UpstreamMetadata extends BaseMetadata {
+  name: string;
+  owner: string;
+  ahead: number;
+  behind: number;
+  sha?: Sha;
+}
 
 // Hosting service types for pull request metadata
 export const gitHubDotComHostingServiceType = 'github';
@@ -182,22 +203,30 @@ 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;
+export type RefMetadataItem = PullRequestMetadata | UpstreamMetadata;
+export type RefMetadataItemWithIdAndType = RefMetadataItem & {
+  refId: string;
+  metadataType: RefMetadataType;
+};
+
+export type CommitDateTimeSource = CommitDateTimeSources;
 
 // Callbacks
 export type GetExternalIcon = (key: string) => React.ReactElement<any>;
 export type TranslationFn = (key: string, ...formatArgs: any) => string;
-export type OnFormatCommitDateTime = (commitDateTime: number) => string;
+export type OnFormatCommitDateTime = (commitDateTime: number, source?: CommitDateTimeSource) => 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 OnClickGraphRef = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow, metadataItem?: RefMetadataItemWithIdAndType) => void;
 export type OnDoubleClickGraphRow = (event: any, graphZoneType: GraphZoneType, graphRow: GraphRow) => void;
-export type OnDoubleClickGraphRef = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow) => void;
+export type OnDoubleClickGraphRef = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow, metadataItem?: RefMetadataItemWithIdAndType) => void;
 export type OnSelectGraphRows = (selectedRows: GraphRow[]) => void;
 export type OnGraphRowHovered = (event: any, graphZoneType: GraphZoneType, graphRow: GraphRow) => void;
 export type OnGraphRowUnhovered = (event: any, graphZoneType: GraphZoneType, graphRow: GraphRow) => void;
@@ -206,6 +235,9 @@ export type OnGraphRefNodeUnhovered = (event: any, refGroup: GraphRefGroup, grap
 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 OnGraphMouseEnter = (event: any) => void;
+export type OnGraphMouseLeave = (event: any) => void;
 export type OnShowMoreCommits = () => void;
 export type OnEmailsMissingAvatarUrls = (emails: AvatarUrlByEmail) => void;
 export type OnRefsMissingMetadata = (refs: RefsMissingMetadata) => void;
@@ -216,13 +248,15 @@ export interface GraphContainerProps {
   contexts?: GraphContexts;
   platform?: GraphPlatform;
   cssVariables?: CssVariables;
+  dimMergeCommits?: boolean;
   getExternalIcon: GetExternalIcon;
-  highlightRowsOnRefHover?: boolean,
+  highlightRowsOnRefHover?: boolean;
   isContainerWindowFocused?: boolean;
-  showGhostRefsOnRowHover?: boolean,
-  showRemoteNamesOnRefs?: boolean,
-  scrollRowPadding?: number,
-  enableMultiSelection?: boolean,
+  showGhostRefsOnRowHover?: boolean;
+  showRemoteNamesOnRefs?: boolean;
+  enabledRefMetadataTypes?: RefMetadataType[];
+  scrollRowPadding?: number;
+  enableMultiSelection?: boolean;
   graphRows: GraphRow[];
   hasMoreCommits?: boolean;
   highlightedShas?: HighlightedShas;
@@ -239,12 +273,12 @@ export interface GraphContainerProps {
   workDirStats?: WorkDirStats;
   onRowContextMenu?: OnRowContextMenu;
   onRefContextMenu?: OnRefContextMenu;
-  onToggleRefsVisibilityClick?: OnToggleRefsVisibilityClick,
+  onToggleRefsVisibilityClick?: OnToggleRefsVisibilityClick;
   onGraphRowHovered?: OnGraphRowHovered;
   onGraphRowUnhovered?: OnGraphRowUnhovered;
   onGraphRefNodeHovered?: OnGraphRefNodeHovered;
   onGraphRefNodeUnhovered?: OnGraphRefNodeUnhovered;
-  onGraphColumnsReOrdered?: OnGraphColumnsReOrdered,
+  onGraphColumnsReOrdered?: OnGraphColumnsReOrdered;
   onColumnResized?: OnGraphColumnResized;
   onClickGraphRef?: OnClickGraphRef;
   onClickGraphRow?: OnClickGraphRow;
@@ -253,10 +287,13 @@ export interface GraphContainerProps {
   onSelectGraphRows?: OnSelectGraphRows;
   onShowMoreCommits?: OnShowMoreCommits;
   onGraphResized?: OnGraphResized;
+  onGraphVisibleRowsChanged?: OnGraphVisibleRowsChanged;
+  onGraphMouseEnter?: OnGraphMouseEnter;
+  onGraphMouseLeave?: OnGraphMouseLeave;
   onEmailsMissingAvatarUrls?: OnEmailsMissingAvatarUrls;
   onRefsMissingMetadata?: OnRefsMissingMetadata;
   formatCommitDateTime?: OnFormatCommitDateTime;
-  shaLength?: number;
+  shaLength?: number | null;
   nonce?: string;
 }