@gitkraken/gitkraken-components 11.0.4 → 11.0.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 11.0.5
+
+- Implemented branch pinning feature ([#378](https://github.com/gitkraken/GitKrakenComponents/pull/378))
+- Added ids to the ref node component to be able to add user education annotations to the graph ([#378](https://github.com/gitkraken/GitKrakenComponents/pull/378))
+- Added new icon to the graph for the pin branch to left action ([#378](https://github.com/gitkraken/GitKrakenComponents/pull/378))
+
 ## 11.0.4
 
 - Fixed commit shortcuts (cmd+enter / cmd+shift+enter) not firing in GKD when the WIP input is focused by allowing modifier-based shortcuts to bubble. ([#377](https://github.com/gitkraken/GitKrakenComponents/pull/377))

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

@@ -6,7 +6,7 @@ import type { Sha } from '../../domain/commit/CommitTypes';
 import type { CssVariables } from '../../domain/generic/GenericTypes';
 import type { GraphCommitDescDisplayMode, GraphMarkerType, GraphSearchMode, GraphZone, GraphZoneType, ShiftSelectMode } from '../../domain/graph/GraphConstants';
 import type { ThrottledFn } from '../../domain/graph/GraphHelpers';
-import type { AbsoluteNodeLeftByColumn, AvatarUrlByEmail, AvatarUrlRequestedByEmail, ChildrenBySha, ColumnColorByColumn, DownstreamsByUpstream, EdgeByColumn, ExcludeByType, ExcludeRefsById, ExcludeRemotesByName, FormatCommitMessage, FormatRefShorthand, GetExternalIcon, GetMissingAvatar, GetMissingRefMetadata, GraphColumnSetting, GraphColumnsSettings, GraphContexts, GraphMarkerColors, GraphMarkerRowIndices, GraphPlatform, GraphRefGroup, GraphRow, GraphZoneModeConstants, GraphZonesByType, Head, HighlightedShas, IncludeOnlyRefsById, IncludeOnlyRemotesByName, IsRefShorthandValid, IsSelectedBySha, NodeOffsetByColumn, NodeOpacityByColumn, OnClearCurrentlyHoveredGraphCommit, OnClickCommit, OnClickGraphRef, OnClickGraphRow, OnClickRef, OnCommitContextMenu, OnCommitMessageChange, OnCurrentlyHoveredGraphCommit, OnDoubleClickCommit, OnDoubleClickGraphRef, OnDoubleClickGraphRow, OnDoubleClickRef, OnEmailsMissingAvatarUrls, OnFilterColumnClick, OnFormatCommitDateTime, OnGraphColumnReOrdered, OnGraphColumnResized, OnGraphColumnsReOrdered, OnGraphMouseEnter, OnGraphMouseLeave, OnGraphRefNodeHovered, OnGraphRefNodeUnhovered, OnGraphResized, OnGraphRowHovered, OnGraphRowUnhovered, OnGraphScrollForZone, OnGraphVisibleRowsChanged, OnGraphZoneResize, OnGraphZoneResizeEnd, OnLoadSelectedGraphRow, OnPopupGraphHeaderContextMenu, OnRefBeginDrag, OnRefCanDrag, OnRefCanDrop, OnRefContextMenu, OnRefCreate, OnRefCreateCancel, OnRefCreateContextMenu, OnRefDragEnter, OnRefDragLeave, OnRefDrop, OnRefEndDrag, OnRefNodeHovered, OnRefNodeUnhovered, OnRefShorthandChange, OnRefsMissingMetadata, OnRefZoneContextMenu, OnRefZoneHovered, OnRefZoneUnhovered, OnRowContextMenu, OnScrollForZone, OnSelectGraphRows, OnSettingsClick, OnShowMoreCommits, OnToggleRefNodesShown, OnToggleRefsVisibilityClick, OnWipMessageBlur, OnWipMessageFocus, ProcessedGraphRow, ProcessedGraphRowBySha, RefMetadataById, RefMetadataRequestedById, RefMetadataType, RefsMissingMetadata, Remote, ReserverInfoBySha, RowEdges, RowStats, RowStatsConstraints, ShaByRefId, Tag, TopAndBottomVisibleRowIndex } from '../../domain/graph/GraphTypes';
+import type { AbsoluteNodeLeftByColumn, AvatarUrlByEmail, AvatarUrlRequestedByEmail, ChildrenBySha, ColumnColorByColumn, DownstreamsByUpstream, EdgeByColumn, ExcludeByType, ExcludeRefsById, ExcludeRemotesByName, FormatCommitMessage, FormatRefShorthand, GetExternalIcon, GetMissingAvatar, GetMissingRefMetadata, GraphColumnSetting, GraphColumnsSettings, GraphContexts, GraphMarkerColors, GraphMarkerRowIndices, GraphPlatform, GraphRefGroup, GraphRow, GraphZoneModeConstants, GraphZonesByType, Head, HighlightedShas, IncludeOnlyRefsById, IncludeOnlyRemotesByName, IsRefShorthandValid, IsSelectedBySha, NodeOffsetByColumn, NodeOpacityByColumn, OnClearCurrentlyHoveredGraphCommit, OnClickCommit, OnClickGraphRef, OnClickGraphRow, OnClickRef, OnColumnsCalculated, OnCommitContextMenu, OnCommitMessageChange, OnCurrentlyHoveredGraphCommit, OnDoubleClickCommit, OnDoubleClickGraphRef, OnDoubleClickGraphRow, OnDoubleClickRef, OnEmailsMissingAvatarUrls, OnFilterColumnClick, OnFormatCommitDateTime, OnGraphColumnReOrdered, OnGraphColumnResized, OnGraphColumnsReOrdered, OnGraphMouseEnter, OnGraphMouseLeave, OnGraphRefNodeHovered, OnGraphRefNodeUnhovered, OnGraphResized, OnGraphRowHovered, OnGraphRowUnhovered, OnGraphScrollForZone, OnGraphVisibleRowsChanged, OnGraphZoneResize, OnGraphZoneResizeEnd, OnLoadSelectedGraphRow, OnPopupGraphHeaderContextMenu, OnRefBeginDrag, OnRefCanDrag, OnRefCanDrop, OnRefContextMenu, OnRefCreate, OnRefCreateCancel, OnRefCreateContextMenu, OnRefDragEnter, OnRefDragLeave, OnRefDrop, OnRefEndDrag, OnRefNodeHovered, OnRefNodeUnhovered, OnRefShorthandChange, OnRefsMissingMetadata, OnRefZoneContextMenu, OnRefZoneHovered, OnRefZoneUnhovered, OnRowContextMenu, OnScrollForZone, OnSelectGraphRows, OnSettingsClick, OnShowMoreCommits, OnToggleRefNodesShown, OnToggleRefsVisibilityClick, OnWipMessageBlur, OnWipMessageFocus, ProcessedGraphRow, ProcessedGraphRowBySha, RefMetadataById, RefMetadataRequestedById, RefMetadataType, RefsMissingMetadata, Remote, ReserverInfoBySha, RowEdges, RowStats, RowStatsConstraints, ShaByRefId, Tag, TopAndBottomVisibleRowIndex } from '../../domain/graph/GraphTypes';
 import type { TranslationFn } from '../../domain/language/LanguageTypes';
 import type { CreateRefFormData, RefIconsPosition } from '../../domain/ref/RefTypes';
 import type { OnBlur, OnKeyDown, OnKeyUp, OnMouseDown, OnResizeParams } from '../../domain/ui/UiTypes';
@@ -54,6 +54,12 @@ export interface StateProps {
     isInUnsupportedRebase?: boolean;
     isLoadingRows?: boolean;
     pendingCommitMessageSummary?: string;
+    /**
+     * Full name of the branch to pin to the left-most column (column 0).
+     * Example: "refs/heads/main" or "refs/remotes/origin/main"
+     * If null or undefined, no branch is pinned.
+     */
+    pinnedBranchFullName?: string | null;
     shiftSelectMode?: ShiftSelectMode;
     suppressNonRefRowTooltips?: boolean;
     refMetadataById?: RefMetadataById | null;
@@ -93,6 +99,12 @@ export interface DispatchProps {
     onGraphColumnsReOrdered?: OnGraphColumnsReOrdered;
     onFilterColumnClick?: OnFilterColumnClick;
     onColumnResized?: OnGraphColumnResized;
+    /**
+     * Callback invoked when column numbers are calculated for each commit.
+     * Receives a map of SHA → column number.
+     * Used to sync column layout data back to the parent application.
+     */
+    onColumnsCalculated?: OnColumnsCalculated;
     onFocusWipNodeInput?: OnWipMessageFocus;
     onMessageChange?: OnCommitMessageChange;
     onPopupGraphHeaderContextMenu?: OnPopupGraphHeaderContextMenu;
@@ -190,6 +202,7 @@ declare class GraphContainer extends React.Component<Props, ComponentState> impl
     hasMergeNodeChildBySha: HasMergeNodeChildBySha;
     reserverInfoBySha: ReserverInfoBySha;
     columnsUsed: ColumnsUsed;
+    pinnedBranchShas: Set<Sha>;
     rowsStats?: Record<string, RowStats>;
     workDirStats: WorkDirStats;
     excludeByType: ExcludeByType;
@@ -320,7 +333,7 @@ declare class GraphContainer extends React.Component<Props, ComponentState> impl
     getEndingAndPassThroughEdgesByColumnFromPrevRow(graphRow: ProcessedGraphRow, prevRowEdges: RowEdges): RowEdges;
     getFinalEdgeStateForGraphAndRow(graphRow: ProcessedGraphRow, prevRowEdges: RowEdges): RowEdges;
     loadEdgesBySha(): void;
-    processRows(graphRows?: GraphRow[]): void;
+    processRows(graphRows?: GraphRow[], pinnedBranchFullName?: string | null): void;
     getStartingEdgesByColumn(currentRow: ProcessedGraphRow): EdgeByColumn;
     formatCommitDateTimeCallback: OnFormatCommitDateTime;
     formatCommitMessageCallback: FormatCommitMessage;
@@ -333,12 +346,11 @@ declare class GraphContainer extends React.Component<Props, ComponentState> impl
     selectNext(topological?: boolean): void;
     selectPrevious(topological?: boolean): void;
     selectHead(upstream?: boolean): void;
-    getAvailableColumnAndUseIt(): number;
     getColumns(graphRow: GraphRow): number;
     getFilteredHeadsForGraphRow(row: GraphRow, hasIncludes: boolean): Head[];
     getFilteredRemotesForGraphRow(row: GraphRow, hasIncludes: boolean): Remote[];
     getFilteredTagsForGraphRow(row: GraphRow, hasIncludes: boolean, rowHasVisibleChild: boolean): Tag[];
-    loadRowsbySha(graphRows: GraphRow[]): void;
+    loadRowsbySha(graphRows: GraphRow[], pinnedBranchFullName?: string | null): void;
     updateRowStatsConstraints(): void;
     updateTimelines(): void;
     clearTimelines(): void;

package/dist/components/graph/refzone/RefNode.d.ts

@@ -13,7 +13,9 @@ export type RefNodeProps = {
     hasRefs: boolean;
     isActive: boolean;
     isGhostRef: boolean;
+    isHidden?: boolean;
     isInUnsupportedRebase: boolean;
+    isPinned: boolean;
     isRefGroupIncluded: boolean;
     key?: string;
     onClick: OnClickRef;

package/dist/components/graph/refzone/RefNodeAnnotationTarget.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+type Props = React.ComponentProps<'div'> & {
+    className?: string;
+    isRefGhost: boolean;
+    isRefHidden: boolean;
+    isRefActive: boolean;
+    isRefPinned: boolean;
+};
+declare const RefNodeAnnotationTarget: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<HTMLDivElement>>;
+export default RefNodeAnnotationTarget;

package/dist/components/graph/refzone/RefNodes.d.ts

@@ -22,6 +22,7 @@ type RefNodesProps = {
     numGraphColumns: number;
     onClickRef: OnClickRef;
     onMissingRefMetadata: GetMissingRefMetadata;
+    pinnedBranchFullName?: string | null;
     refGroupContexts: RefGroupContexts | null;
     refGroupsByName: RefGroup[];
     refIconsPosition: RefIconsPosition;
@@ -42,5 +43,5 @@ type RefNodesProps = {
     type: CommitType;
     useColumnHeaderIcons: boolean;
 };
-declare function RefNodes({ enabledRefMetadataTypes, column, columnForColoring, context, enableShowHideRefsOptions, targetRef, hasActive, hasRefs, getExternalIcon, includeOnlyRefsById, includeOnlyRemotesByName, isGhostRef, isHovered, isInUnsupportedRebase, numGraphColumns, onMissingRefMetadata, refGroupContexts, refGroupsByName, refIconsPosition, refMetadata, refNodeHovered, sha, showRemoteNamesOnRefs, showContextMenuForGroupedRef, onClickRef, onDoubleClickRef, onToggleRefNodesShown, onRefBeginDrag, onRefCanDrag, onRefCanDrop, onRefDragEnter, onRefDragLeave, onRefDrop, onRefEndDrag, translate, type, useColumnHeaderIcons, }: RefNodesProps): ReactElement<'span' | 'div'>;
+declare function RefNodes({ enabledRefMetadataTypes, column, columnForColoring, context, enableShowHideRefsOptions, targetRef, hasActive, hasRefs, getExternalIcon, includeOnlyRefsById, includeOnlyRemotesByName, isGhostRef, isHovered, isInUnsupportedRebase, numGraphColumns, onMissingRefMetadata, pinnedBranchFullName, refGroupContexts, refGroupsByName, refIconsPosition, refMetadata, refNodeHovered, sha, showRemoteNamesOnRefs, showContextMenuForGroupedRef, onClickRef, onDoubleClickRef, onToggleRefNodesShown, onRefBeginDrag, onRefCanDrag, onRefCanDrop, onRefDragEnter, onRefDragLeave, onRefDrop, onRefEndDrag, translate, type, useColumnHeaderIcons, }: RefNodesProps): ReactElement<'span' | 'div'>;
 export default RefNodes;

package/dist/components/graph/refzone/RefZone.d.ts

@@ -36,6 +36,7 @@ type RefZoneProps = {
     onRefDragLeave: OnRefDragLeave;
     onRefDrop: OnRefDrop;
     onRefEndDrag: OnRefEndDrag;
+    pinnedBranchFullName?: string | null;
     refGroupContexts: RefGroupContexts | null;
     refGroupsByName: GraphRefGroup[];
     refIconsPosition: RefIconsPosition;

package/dist/components/graph/rowRenderers/RefZoneRow.d.ts

@@ -15,6 +15,7 @@ interface StateProps {
     isInUnsupportedRebase: boolean;
     isRefShorthandValid: IsRefShorthandValid;
     hoveredRefZoneSha?: Sha;
+    pinnedBranchFullName?: string | null;
     refIconsPosition: RefIconsPosition;
     refMetadataById?: RefMetadataById | null;
     shouldShowRefLine: boolean;

package/dist/domain/graph/GraphConstants.d.ts

@@ -31,6 +31,8 @@ export declare const REF_ZONE_MARGIN_LEFT = 2;
 export declare const REF_ZONE_MARGIN_RIGHT = 6;
 export declare const REF_NODE_ICON_WIDTH = 14;
 export declare const REF_NODE_ICON_MARGIN = 5;
+export declare const REF_NODE_ACTIVE_ANNOTATION_ID = "gk-graph-ref-active";
+export declare const REF_NODE_PINNED_ANNOTATION_ID = "gk-graph-ref-pinned";
 export declare const REF_NODE_ICON_SPACING: number;
 export declare const REF_NODE_OUTER_SPACING = 10;
 export declare const REF_ZONE_SHOW_ICON_WIDTH = 55;

package/dist/domain/graph/GraphTypes.d.ts

@@ -145,6 +145,9 @@ export type HasSpecialChildBySha = {
 export type ReserverInfoBySha = {
     [id: Sha]: ReserverInfo;
 };
+export type ColumnNumberBySha = {
+    [sha: Sha]: number;
+};
 export type RefTargetFunc = () => Element | null | undefined;
 export type ColumnContentGenerator = () => ReactElement<any>;
 export type GraphItemContext = string | Object;
@@ -396,7 +399,7 @@ export type DownstreamsByUpstream = {
     [upstreamName: string]: string[];
 };
 export type GraphPlatform = 'aix' | 'android' | 'darwin' | 'freebsd' | 'linux' | 'openbsd' | 'sunos' | 'win32' | 'cygwin';
-export type ExternalIconKeys = 'added' | 'author' | 'branch' | 'changes' | 'check' | 'commit' | 'datetime' | 'deleted' | 'files' | 'filter' | 'graph' | 'head' | 'hide' | `issue-${IssueTrackerType}` | 'loading' | 'message' | 'modified' | 'pull-request' | 'remote' | `remote-${HostingServiceType}` | 'renamed' | 'resolved' | 'settings' | 'show' | 'stash' | 'tag' | 'upstream-ahead' | 'upstream-behind' | 'warning' | 'worktree';
+export type ExternalIconKeys = 'added' | 'author' | 'branch' | 'changes' | 'check' | 'commit' | 'datetime' | 'deleted' | 'files' | 'filter' | 'graph' | 'head' | 'hide' | `issue-${IssueTrackerType}` | 'loading' | 'message' | 'modified' | 'pin' | 'pull-request' | 'remote' | `remote-${HostingServiceType}` | 'renamed' | 'resolved' | 'settings' | 'show' | 'stash' | 'tag' | 'upstream-ahead' | 'upstream-behind' | 'warning' | 'worktree';
 export type GetExternalIcon = (key: ExternalIconKeys) => ReactElement<any>;
 export type GetMissingAvatar = (email: string, sha: string) => void;
 export type GetMissingRefMetadata = (id: string, types: RefMetadataType[]) => void;
@@ -474,3 +477,9 @@ export type OnGraphColumnResized = (graphZoneType: GraphZoneType, columnSettings
 export type OnShowMoreCommits = () => void;
 export type OnEmailsMissingAvatarUrls = (emails: AvatarUrlByEmail) => void;
 export type OnRefsMissingMetadata = (refs: RefsMissingMetadata) => void;
+/**
+ * Callback invoked when column numbers are calculated for each commit.
+ * Receives a map of SHA → column number.
+ * Used to sync column layout data back to the parent application.
+ */
+export type OnColumnsCalculated = (columnsBySha: ColumnNumberBySha) => void;

package/dist/domain/graph/PinnedBranchHelpers.d.ts

@@ -0,0 +1,21 @@
+import type { Sha } from '../commit/CommitTypes';
+import type { GraphRow } from './GraphTypes';
+/**
+ * Identifies commits that belong to the pinned branch by following the first-parent chain.
+ * Returns a Set of SHAs that are part of the pinned branch.
+ */
+export declare function identifyPinnedBranchCommits(graphRows: GraphRow[], pinnedBranchFullName?: string | null): Set<Sha>;
+/**
+ * Gets the next available column number, marking it as used.
+ * When reserveColumn0ForPinned is true, starts searching from column 1.
+ */
+export declare function getAvailableColumnAndUseIt(columnsUsed: {
+    [column: number]: boolean;
+}, reserveColumn0ForPinned?: boolean): number;
+/**
+ * Determines the column number for a parent commit based on pinning status and parent index.
+ * For pinned parents, always reserve column 0; for non-pinned, use normal logic.
+ */
+export declare function getParentColumn(columnsUsed: {
+    [column: number]: boolean;
+}, isParentPinned: boolean, parentIndex: number, currentColumn: number, hasPinnedBranch: boolean): number;