@gitkraken/gitkraken-components 2.0.0 → 3.0.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,
@@ -155,7 +156,7 @@ export type GraphRefGroup = Array<GraphRef>;
 
 export type RefMetadataById = { [id: string]: RefMetadata | null | undefined } | null;
 export type RefMetadata = {
-  pullRequests?: PullRequestMetadata[] | null;
+  pullRequest?: PullRequestMetadata[] | null;
   upstream?: UpstreamMetadata | null;
 };
 
@@ -201,29 +202,37 @@ export type HostingServiceType =
 export type RefsMissingMetadata = {
   [refId: string]: RefMetadataType[]
 }
-export const pullRequestMetadataType = 'pullRequests';
+export type RefMetadataType = keyof RefMetadata;
+export const pullRequestMetadataType = 'pullRequest';
 export const upstreamMetadataType = 'upstream';
 // Expand this as we add more types to RefMetadata
-export type RefMetadataType = typeof pullRequestMetadataType | typeof upstreamMetadataType;
-export type RefMetadataItem = PullRequestMetadata | UpstreamMetadata;
-export type RefMetadataItemWithIdAndType = RefMetadataItem & {
-  refId: string;
-  metadataType: RefMetadataType;
-};
+export type RefMetadataItem =
+  | {
+    refId: string;
+    type: typeof pullRequestMetadataType;
+    data: PullRequestMetadata;
+  }
+  | {
+    refId: string;
+    type: typeof upstreamMetadataType;
+    data: UpstreamMetadata;
+  };
+
+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, metadataItem?: RefMetadataItemWithIdAndType) => void;
+export type OnClickGraphRef = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow, metadataItem?: RefMetadataItem) => void;
 export type OnDoubleClickGraphRow = (event: any, graphZoneType: GraphZoneType, graphRow: GraphRow) => void;
-export type OnDoubleClickGraphRef = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow, metadataItem?: RefMetadataItemWithIdAndType) => void;
+export type OnDoubleClickGraphRef = (event: any, refGroup: GraphRefGroup, graphRow: GraphRow, metadataItem?: RefMetadataItem) => 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;