@gitkraken/gitkraken-components 1.0.0 → 1.1.0-rc.10

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
@@ -64,30 +71,22 @@ export type GraphContexts = {
   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 = {
@@ -106,7 +105,8 @@ export type GraphRow = {
 
 export type GraphColumnSetting = {
   width: number,
-  isHidden: boolean
+  isHidden: boolean,
+  order?: number
 };
 
 export type AvatarUrlByEmail = { [email: string]: string };
@@ -203,35 +203,34 @@ 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 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
 export interface GraphContainerProps {
   avatarUrlByEmail?: AvatarUrlByEmail;
   contexts?: GraphContexts;
-  height?: number;
-  width?: number;
   platform?: GraphPlatform;
   cssVariables?: CssVariables;
   getExternalIcon: GetExternalIcon;
   highlightRowsOnRefHover?: boolean,
+  isContainerWindowFocused?: boolean;
   showGhostRefsOnRowHover?: boolean,
   showRemoteNamesOnRefs?: boolean,
+  scrollRowPadding?: number,
   enableMultiSelection?: boolean,
   graphRows: GraphRow[];
   hasMoreCommits?: boolean;
   highlightedShas?: HighlightedShas;
-  hiddenRefsById?: HiddenRefsById;
-  // isCommitting: boolean;
+  excludeByType?: ExcludeByType;
+  excludeRefsById?: ExcludeRefsById;
+  includeOnlyRefsById?: IncludeOnlyRefsById;
   isSelectedBySha?: IsSelectedBySha;
-  // isInUnsupportedRebase: boolean;
   isLoadingRows?: boolean;
-  // maybeCreateRefFormSha: ?Sha;
-  // pendingCommitMessageSummary: string;
-  // repoPath: string;
   columnsSettings?: GraphColumnsSettings;
   refMetadataById?: RefMetadataById;
   themeOpacityFactor?: number;
@@ -245,18 +244,15 @@ export interface GraphContainerProps {
   onGraphRowUnhovered?: OnGraphRowUnhovered;
   onGraphRefNodeHovered?: OnGraphRefNodeHovered;
   onGraphRefNodeUnhovered?: OnGraphRefNodeUnhovered;
-  // onBlurWipNodeInput: OnBlur;
+  onGraphColumnsReOrdered?: OnGraphColumnsReOrdered,
   onColumnResized?: OnGraphColumnResized;
-  // onFocusWipNodeInput: OnFocus;
-  // onMessageChange: OnCommitMessageChange;
   onClickGraphRef?: OnClickGraphRef;
   onClickGraphRow?: OnClickGraphRow;
   onDoubleClickGraphRow?: OnDoubleClickGraphRow;
   onDoubleClickGraphRef?: OnDoubleClickGraphRef;
   onSelectGraphRows?: OnSelectGraphRows;
   onShowMoreCommits?: OnShowMoreCommits;
-  // onWipNodeInputWillUnmount: OnComponentWillUnmount;
-  // onUpdateGraphWidth: OnUpdateGraphWidth;
+  onGraphResized?: OnGraphResized;
   onEmailsMissingAvatarUrls?: OnEmailsMissingAvatarUrls;
   onRefsMissingMetadata?: OnRefsMissingMetadata;
   formatCommitDateTime?: OnFormatCommitDateTime;
@@ -278,7 +274,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;