@gitkraken/gitkraken-components 13.0.0-vnext.27 → 13.0.0-vnext.29

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

@@ -1,7 +1,7 @@
 import type { GridCellRenderer, ScrollParams } from 'react-virtualized';
 import type { ReactElement, ReactNode } from 'react';
 import type { CommitDateTimeSources } from '../commit/CommitConstants';
-import type { CommitType, Sha } from '../commit/CommitTypes';
+import type { CommitType, EdgeCommitType, Sha } from '../commit/CommitTypes';
 import type { CssVariables } from '../generic/GenericTypes';
 import type { HostingServiceType, IssueTrackerType } from '../hostingservice/HostingServiceTypes';
 import type { TranslationFn } from '../language/LanguageTypes';
@@ -38,6 +38,7 @@ export type EdgeCache = {
 export type ArcEndpointAngle = 0 | 90 | 180 | 270;
 export interface SvgStyles {
     fill: string;
+    filter?: string;
     shapeRendering: string;
     strokeLinejoin: string;
     strokeWidth: number;
@@ -57,7 +58,7 @@ export type SvgProps = ArcSvgProps | LineSvgProps;
 export type AnySvgProps = ArcSvgProps & LineSvgProps;
 export type Edge = {
     parentSha: Sha;
-    type: CommitType;
+    type: EdgeCommitType;
 };
 export type EdgeByColumn = {
     [column: number]: Edge;
@@ -136,6 +137,45 @@ export type IsSelectedBySha = {
 export type HighlightedShas = {
     [sha: Sha]: boolean;
 };
+export type SyntheticParentsBySha = Map<Sha, Sha[]>;
+export interface GraphScope {
+    /** Full ref id of the specific branch to scope to (e.g. 'refs/heads/feature/x'). NOT necessarily HEAD. */
+    branchRef: string;
+    /** Full ref id of the branch's upstream (e.g. 'refs/remotes/origin/feature/x'). */
+    upstreamRef?: string;
+    /** SHA of the merge-target tip commit. Its ancestors are NOT walked — the tip is kept as a marker. */
+    mergeTargetTipSha?: Sha;
+    /**
+     * Additional ref ids to include in the scope. Each tip becomes an anchor (same treatment as
+     * branchRef — shows all refs, acts as visibility floor) and its ancestors contribute to
+     * visibleShas subject to the mergeTarget exclusion.
+     *
+     * Primary use case: branches stacked on top of the focal branch (e.g. F2, F3 stacked on F1).
+     * The helper makes no stackedness check — any refs are valid (siblings, comparisons, etc.).
+     */
+    additionalBranchRefs?: string[];
+    /** How to render gaps when an anchor's real parents are hidden. Defaults to 'syntheticEdge'. */
+    collapseStyle?: 'syntheticEdge' | 'gap';
+}
+export interface ScopeVisibility {
+    visibleShas: Set<Sha>;
+    anchorShas: Set<Sha>;
+    /** Fork points (merge bases) where an anchor's ancestor walk terminated. Visual boundary "below" the focus group. */
+    forkPointShas: Set<Sha>;
+    /** The merge-target tip sha, when scope.mergeTargetTipSha was provided. Visual boundary "above" the focus group. */
+    mergeTargetShas: Set<Sha>;
+    syntheticParentsBySha: SyntheticParentsBySha;
+    /** Anchors whose synthetic walk failed — merge base not in loaded rows. Consumer should fetch more data. */
+    unreachableAnchors: Set<Sha>;
+    /**
+     * True when scope walks terminated at identified boundaries — at least one fork point was
+     * found AND no anchor was left unreachable. When false, the scope may be incomplete due to
+     * missing data (merge base not loaded, foreign ref not yet surfaced, partial history). Callers
+     * should NOT suppress commit autoloading while this is false — more data could establish the
+     * missing boundary.
+     */
+    isBounded: boolean;
+}
 export type IsExcludedBySha = {
     [id: Sha]: boolean;
 };
@@ -145,6 +185,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;
@@ -322,6 +365,8 @@ export interface ReadonlyGraphRow extends ReadonlyDeep<GraphRow> {
     /** Whether the row is hidden from the graph (filtered out by type or other filters). Output only */
     readonly hidden: boolean;
 }
+/** Which scope-boundary role this row plays, when an active scope identifies it as one. */
+export type ScopeBoundaryKind = 'forkPoint' | 'mergeTarget';
 export interface ProcessedGraphRow extends GraphRow {
     rowIndex?: number;
     column: number;
@@ -338,6 +383,7 @@ export interface ProcessedGraphRow extends GraphRow {
     timeLineEntry?: TimelineEntry;
     childRefs?: ChildRefsByType;
     refsData?: GraphRefsData;
+    scopeBoundaryKind?: ScopeBoundaryKind;
 }
 export type TopAndBottomVisibleRowIndex = {
     top: number;
@@ -406,7 +452,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;
@@ -479,7 +525,7 @@ export type OnToggleRefsVisibilityClick = (event: React.MouseEvent<any>, refs: G
 export interface GraphSelectionState {
     /** Whether the selected rows form a topologically contiguous selection (connected via parent-child relationships) */
     isContiguous: boolean;
-    /** Whether the selection was made topologically (via shift+click following graph topology) */
+    /** Whether the selection was made topologically (via ctrl/shift+click following graph topology) */
     isTopological: boolean;
 }
 export type OnSelectGraphRows = (rows: ReadonlyGraphRow[], focusedRow: ReadonlyGraphRow | undefined, state: GraphSelectionState) => void;
@@ -493,4 +539,10 @@ 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;
 export {};

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;

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

@@ -0,0 +1,15 @@
+import type { GraphRow, GraphScope, ScopeVisibility } from './GraphTypes';
+export declare function computeScopeVisibility(rows: GraphRow[], scope: GraphScope): ScopeVisibility;
+/**
+ * Returns true when a WIP row should be hidden under an active scope.
+ *
+ * Secondary (per-worktree) WIP rows are kept only when their parent is a branch anchor of the
+ * scope — i.e. the tip of `branchRef`, `upstreamRef`, or one of `additionalBranchRefs` (so a
+ * worktree checked out on a scoped branch still surfaces its WIP, even when empty). The merge
+ * target tip is excluded: it's a boundary, not a focused branch.
+ *
+ * The primary WIP row, merge-conflict node, and unsupported-rebase warning node are tied to
+ * the primary repo's HEAD. They are kept whenever at least one of their parents is in the
+ * scope's visible set; otherwise they would render as floating nodes with no anchoring topology.
+ */
+export declare function shouldHideWipRowForScope(row: GraphRow, scopeVisibility: ScopeVisibility | null): boolean;

package/dist/domain/graph/row/ProcessedGraphRowObj.d.ts

@@ -2,7 +2,7 @@ import type { ReactNode } from 'react';
 import type { IGraphContainer } from '../../../components/graph/IGraphContainer';
 import type { CommitType, Sha } from '../../commit/CommitTypes';
 import type { TimelineEntry } from '../GraphConstants';
-import type { ChildRefsByType, GraphRefsData, GraphRow, Head, ProcessedGraphRow, Remote, RowContexts, RowEdges, Tag } from '../GraphTypes';
+import type { ChildRefsByType, GraphRefsData, GraphRow, Head, ProcessedGraphRow, Remote, RowContexts, RowEdges, ScopeBoundaryKind, Tag } from '../GraphTypes';
 export declare class ProcessedGraphRowObj implements ProcessedGraphRow {
     private _graph;
     private _message;
@@ -27,6 +27,7 @@ export declare class ProcessedGraphRowObj implements ProcessedGraphRow {
     edges: RowEdges;
     childRefs: ChildRefsByType;
     timeLineEntry?: TimelineEntry;
+    scopeBoundaryKind?: ScopeBoundaryKind;
     summary: string;
     body?: string;
     displaySummary: string | ReactNode;

package/dist/domain/graph/rowAdornment/RowAdornmentHelpers.d.ts

@@ -0,0 +1,14 @@
+import type { Sha } from '../../commit/CommitTypes';
+/**
+ * Builds the CSS `<dashed-ident>` used to tie a graph row's `anchor-name`
+ * to the overlay's `position-anchor`. Shas are arbitrary caller-provided
+ * strings (e.g. `worktree-wip::/some/path` for multi-WIP rows) and may
+ * contain characters that aren't valid inside a CSS <custom-ident>, so
+ * each unsafe character is prefixed with `\` — a single-character CSS
+ * escape that preserves readability in DevTools while keeping the
+ * identifier parseable by the browser.
+ *
+ * Letters, digits, hyphen, underscore, and non-ASCII code points are
+ * already legal inside a CSS ident and pass through unchanged.
+ */
+export declare function getRowAnchorName(sha: Sha): string;

package/dist/domain/workdir/WorkDirHelpers.d.ts

@@ -0,0 +1,50 @@
+import type { ReactElement } from 'react';
+import type { Sha } from '../commit/CommitTypes';
+import type { VisibleWipShas, WipNodeMetadataBySha, WipShasMissingStats, WorkDirStats } from './WorkDirTypes';
+/** Translation key for the WIP row's label, selected based on stats state. */
+export type WipRowMessageKey = 'Graph-WorkInProgress' | 'Graph-WorkInProgress-Changes' | 'Graph-WorkInProgress-Clean';
+/**
+ * Picks the translation key for a WIP row's label based on the stats it has (or doesn't have):
+ * - `Graph-WorkInProgress-Changes` when stats show any added/modified/deleted activity
+ * - `Graph-WorkInProgress-Clean` when stats are present but all zero (queried, clean)
+ * - `Graph-WorkInProgress` when stats are not yet known (neutral fallback)
+ */
+export declare function getWipRowMessageKey(workDirStats: WorkDirStats | undefined): WipRowMessageKey;
+export type ResolvedWipState = {
+    isPrimaryWip: boolean;
+    effectiveWorkDirStats: WorkDirStats | undefined;
+    hasWorkDirChanges: boolean;
+    isWipEditable: boolean;
+    customWipContent: ReactElement<any> | null;
+    needsWipStatsRequest: boolean;
+};
+/**
+ * Resolves the effective WIP state for a given row.
+ *
+ * For the primary WIP row (sha === workDirType), uses the global workDirStats.
+ * For secondary WIP rows, uses the per-row metadata from wipNodeMetadataBySha. There is
+ * NO fallback to the global workDirStats — secondary rows belong to other worktrees, and
+ * painting the primary repo's counts on them would be wrong. Until per-row stats arrive,
+ * the pill renders nothing and `needsWipStatsRequest` triggers a deferred fetch.
+ */
+export declare function resolveWipState(sha: Sha, type: string, workDirStats: WorkDirStats | undefined, wipNodeMetadataBySha: WipNodeMetadataBySha | undefined, wipMessageEditable: boolean): ResolvedWipState;
+/** Predicate for secondary-WIP rows (per-worktree WIPs), excluding the primary WIP row. */
+export declare function isSecondaryWipRow(row: {
+    sha: Sha;
+    type?: string;
+}): boolean;
+/** Key-set equality for `VisibleWipShas` / `WipShasMissingStats`-shaped records (values are always `true`). */
+export declare function areVisibleWipShasEqual(a: VisibleWipShas, b: VisibleWipShas): boolean;
+/**
+ * Given the set of currently-visible secondary-WIP shas, the prior dedup map of shas already
+ * requested, and the per-sha metadata, compute (a) the pruned dedup map that only retains entries
+ * for shas still visible, and (b) the set of shas whose stats should be requested this tick.
+ *
+ * Shas that have left the viewport are dropped from the dedup so they can be re-asked on re-entry.
+ * Shas with `customContent` override or with non-stale `workDirStats` already populated are not
+ * added to `missing`.
+ */
+export declare function computeWipMissingShasUpdate(current: VisibleWipShas, priorRequestedDedup: WipShasMissingStats, metadataBySha: WipNodeMetadataBySha | undefined): {
+    missing: WipShasMissingStats;
+    prunedRequestedDedup: WipShasMissingStats;
+};

package/dist/domain/workdir/WorkDirTypes.d.ts

@@ -1,3 +1,5 @@
+import type { ReactElement } from 'react';
+import type { Sha } from '../commit/CommitTypes';
 import type { GraphItemContext } from '../graph/GraphTypes';
 export type WorkDirStats = {
     added: number;
@@ -6,3 +8,52 @@ export type WorkDirStats = {
     context?: GraphItemContext;
     renamed?: number;
 };
+/**
+ * Per-row decoration for a secondary (worktree) WIP graph row. Looked up by the row's `sha`.
+ *
+ * Not applied to the primary WIP row (`sha === workDirType`); use the `workDirStats` prop for that one.
+ *
+ * @see docs/multi-wip-rows.md
+ */
+export type WipNodeMetadata = {
+    /**
+     * Stats for this secondary WIP row's worktree. Omit to have the library request them via
+     * `onWipShasMissingStats`. Until per-row stats arrive, the pill renders nothing — the library does
+     * NOT fall back to the global `workDirStats` (which belongs to the primary repo).
+     */
+    workDirStats?: WorkDirStats;
+    /** When true, the library requests fresh stats while continuing to render `workDirStats` (stale-while-revalidate). */
+    workDirStatsStale?: boolean;
+    /** If provided, renders this element in place of the default WIP stats pill. Suppresses any stats request. */
+    customContent?: ReactElement<any>;
+    /** If provided, renders this avatar URL inside the graph node circle instead of the default WIP dot. */
+    nodeAvatarUrl?: string;
+};
+/**
+ * Decoration map for secondary WIP rows, keyed by the row's `sha`. The library does not create rows from
+ * this map — provide the row in `graphRows` and this map augments it.
+ */
+export type WipNodeMetadataBySha = Record<Sha, WipNodeMetadata>;
+/**
+ * Batched set of secondary-WIP shas for which the library is requesting stats. Delivered to the
+ * `onWipShasMissingStats` callback after a 100ms debounce with dedup.
+ */
+export type WipShasMissingStats = Record<Sha, true>;
+/**
+ * Caller-supplied handler invoked when one or more secondary WIP rows need stats fetched.
+ * Handler should async-fetch and push back an updated `wipNodeMetadataBySha` reference with
+ * `workDirStats` populated for each requested sha.
+ */
+export type OnWipShasMissingStats = (shas: WipShasMissingStats) => void;
+/**
+ * Batched set of secondary-WIP shas currently rendered in the viewport. Delivered to the
+ * `onVisibleWipShasChanged` callback after a 100ms debounce when the set changes.
+ */
+export type VisibleWipShas = Record<Sha, true>;
+/**
+ * Caller-supplied handler invoked when the set of secondary WIP rows visible in the viewport changes.
+ * Use this to acquire/release per-worktree resources (filesystem watchers, subscriptions, etc.) as
+ * rows scroll in and out of view. Consumers diff the provided set against their own tracking to
+ * decide what to hook/unhook.
+ */
+export type OnVisibleWipShasChanged = (shas: VisibleWipShas) => void;