@gitkraken/gitkraken-components 11.2.1 → 12.0.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 12.0.0
+
+- **BREAKING CHANGE:** `hostingServiceInfo` is now a required `GraphContainer` prop ([#392](https://github.com/gitkraken/GitKrakenComponents/pull/392))
+  - It maps every `HostingServiceType` to that service's display name and the character that prefixes a pull request number on it (for example `#`, or `!` for GitLab merge requests). The graph no longer keeps its own copy of the service names, so consumers must pass this prop; omitting it is a compile error, and a pull request row will throw at runtime.
+- **BREAKING CHANGE:** `PullRequestIcon-Tooltip` no longer hardcodes `#` ([#392](https://github.com/gitkraken/GitKrakenComponents/pull/392))
+  - `{0}` is now a pull request id that already carries its service's character, so the default changed from `'#{0}: {1}\n Double-click to open pull request on {2}'` to `'{0}: {1}\n Double-click to open pull request on {2}'`. Consumers that ship their own translation map fall back to `DEFAULT_TRANSLATIONS` only when no `translate` prop is given, so they must update this key in lockstep or every pull request tooltip renders `##123` (`!!123` on GitLab).
+- Deprecated `getHostingServiceName` in favor of the `hostingServiceInfo` prop. It still ships in this release and will be removed in the next major version. ([#392](https://github.com/gitkraken/GitKrakenComponents/pull/392))
+- Added `stackPosition` and `stackSize` to pull request ref metadata. When both are whole numbers and `stackPosition` falls between 1 and `stackSize`, the pull request icon's tooltip names the pull request's position in its stack. ([#392](https://github.com/gitkraken/GitKrakenComponents/pull/392))
+- Added the `PullRequestIcon-TooltipWithStack` translation key for that tooltip. Consumers that ship their own translation map should add it. ([#392](https://github.com/gitkraken/GitKrakenComponents/pull/392))
+
 ## 11.2.1
 
 - Ensures the branch or tag creation input remains visible and usable when its target commit scrolls out of the virtualized graph viewport ([#390](https://github.com/gitkraken/GitKrakenComponents/pull/390))

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

@@ -7,6 +7,7 @@ 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, 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 { HostingServiceInfoType, HostingServiceType } from '../../domain/hostingservice/HostingServiceTypes';
 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';
@@ -35,6 +36,11 @@ export interface StateProps {
     downstreamsByUpstream?: DownstreamsByUpstream;
     formatRefShorthand?: FormatRefShorthand;
     highlightRowsOnRefHover?: boolean;
+    /**
+     * The display name and pull request character (for example `#` or `!`) to use for each hosting service.
+     * Every `HostingServiceType` must be present, since pull request metadata names its hosting service by type.
+     */
+    hostingServiceInfo: Record<HostingServiceType, HostingServiceInfoType>;
     isContainerWindowFocused?: boolean;
     isRefShorthandValid?: IsRefShorthandValid;
     showGhostRefsOnRowHover?: boolean;

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

@@ -2,6 +2,7 @@ import type { ReactElement } from 'react';
 import React from 'react';
 import type { CommitType, Sha } from '../../../domain/commit/CommitTypes';
 import type { GetExternalIcon, GetMissingRefMetadata, GraphItemContext, GraphRef, GraphRefGroup, OnClickRef, OnClickRefMetadata, OnDoubleClickRef, OnDoubleClickRefMetadata, OnHideRefClick, OnRefBeginDrag, OnRefCanDrag, OnRefCanDrop, OnRefDragEnter, OnRefDragLeave, OnRefDrop, OnRefEndDrag, OnRefNodeHovered, OnRefZoneContextMenu, RefMetadataById, RefMetadataItem, RefMetadataType } from '../../../domain/graph/GraphTypes';
+import type { HostingServiceInfoType, HostingServiceType } from '../../../domain/hostingservice/HostingServiceTypes';
 import type { TranslationFn } from '../../../domain/language/LanguageTypes';
 import type { RefIconsPosition } from '../../../domain/ref/RefTypes';
 import type { OnClick, OnContextMenu, OnDoubleClick } from '../../../domain/ui/UiTypes';
@@ -11,6 +12,7 @@ export type RefNodeProps = {
     groupIsHovered: boolean;
     hasActive: boolean;
     hasRefs: boolean;
+    hostingServiceInfo: Record<HostingServiceType, HostingServiceInfoType>;
     isActive: boolean;
     isGhostRef: boolean;
     isHidden?: boolean;

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

@@ -1,6 +1,7 @@
 import type { ReactElement, RefObject } from 'react';
 import type { CommitType, Sha } from '../../../domain/commit/CommitTypes';
 import type { GetExternalIcon, GetMissingRefMetadata, GraphItemContext, IncludeOnlyRefsById, IncludeOnlyRemotesByName, OnClickRef, OnDoubleClickRef, OnRefBeginDrag, OnRefCanDrag, OnRefCanDrop, OnRefDragEnter, OnRefDragLeave, OnRefDrop, OnRefEndDrag, OnRefNodeHovered, OnRefZoneContextMenu, OnToggleRefNodesShown, GraphRefGroup as RefGroup, RefGroupContexts, RefMetadataById, RefMetadataType } from '../../../domain/graph/GraphTypes';
+import type { HostingServiceInfoType, HostingServiceType } from '../../../domain/hostingservice/HostingServiceTypes';
 import type { TranslationFn } from '../../../domain/language/LanguageTypes';
 import type { RefIconsPosition } from '../../../domain/ref/RefTypes';
 type RefNodesProps = {
@@ -14,6 +15,7 @@ type RefNodesProps = {
     targetRef: RefObject<HTMLDivElement>;
     hasActive: boolean;
     hasRefs: boolean;
+    hostingServiceInfo: Record<HostingServiceType, HostingServiceInfoType>;
     includeOnlyRefsById: IncludeOnlyRefsById;
     includeOnlyRemotesByName: IncludeOnlyRemotesByName;
     isGhostRef: boolean;
@@ -43,5 +45,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, 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'>;
+declare function RefNodes({ enabledRefMetadataTypes, column, columnForColoring, context, enableShowHideRefsOptions, targetRef, hasActive, hasRefs, getExternalIcon, hostingServiceInfo, 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

@@ -3,6 +3,7 @@ import React from 'react';
 import type { CommitType, Sha } from '../../../domain/commit/CommitTypes';
 import type { Style } from '../../../domain/generic/GenericTypes';
 import type { GetExternalIcon, GetMissingRefMetadata, GraphItemContext, GraphRefGroup, IncludeOnlyRefsById, IncludeOnlyRemotesByName, OnClickRef, OnDoubleClickRef, OnRefBeginDrag, OnRefCanDrag, OnRefCanDrop, OnRefDragEnter, OnRefDragLeave, OnRefDrop, OnRefEndDrag, OnRefNodeHovered, OnRefNodeUnhovered, OnRefZoneContextMenu, OnRefZoneHovered, OnRefZoneUnhovered, OnToggleRefNodesShown, RefGroupContexts, RefMetadataById, RefMetadataType } from '../../../domain/graph/GraphTypes';
+import type { HostingServiceInfoType, HostingServiceType } from '../../../domain/hostingservice/HostingServiceTypes';
 import type { TranslationFn } from '../../../domain/language/LanguageTypes';
 import type { RefIconsPosition } from '../../../domain/ref/RefTypes';
 type RefZoneDefaultProps = {
@@ -18,6 +19,7 @@ type RefZoneProps = {
     hasActive: boolean;
     hasRefs: boolean;
     hasTimeline: boolean;
+    hostingServiceInfo: Record<HostingServiceType, HostingServiceInfoType>;
     hoveredRefGroup: GraphRefGroup | null;
     hoveredRefZoneSha?: Sha;
     includeOnlyRefsById: IncludeOnlyRefsById;

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

@@ -1,6 +1,7 @@
 import type { GridCellRenderer } from 'react-virtualized';
 import type { Sha } from '../../../domain/commit/CommitTypes';
 import type { CommonGraphRowDispatchProps, CommonGraphRowProps, FormatRefShorthand, GetMissingRefMetadata, IncludeOnlyRefsById, IncludeOnlyRemotesByName, IsRefShorthandValid, OnClickRef, OnDoubleClickRef, OnRefBeginDrag, OnRefCanDrag, OnRefCanDrop, OnRefCreate, OnRefCreateCancel, OnRefCreateContextMenu, OnRefDragEnter, OnRefDragLeave, OnRefDrop, OnRefEndDrag, OnRefNodeHovered, OnRefNodeUnhovered, OnRefShorthandChange, OnRefZoneContextMenu, OnRefZoneHovered, OnRefZoneUnhovered, OnToggleRefNodesShown, RefMetadataById } from '../../../domain/graph/GraphTypes';
+import type { HostingServiceInfoType, HostingServiceType } from '../../../domain/hostingservice/HostingServiceTypes';
 import type { GetRealKeyForCellFunc } from '../../../domain/reactvirtualized/ReactVirtualizedHelpers';
 import type { CreateRefFormData, RefIconsPosition } from '../../../domain/ref/RefTypes';
 interface OwnProps {
@@ -13,6 +14,7 @@ interface StateProps {
     isCreateRefFloating?: boolean;
     formatRefShorthand: FormatRefShorthand;
     enableShowHideRefsOptions: boolean;
+    hostingServiceInfo: Record<HostingServiceType, HostingServiceInfoType>;
     isInUnsupportedRebase: boolean;
     isRefShorthandValid: IsRefShorthandValid;
     hoveredRefZoneSha?: Sha;

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

@@ -242,6 +242,13 @@ export interface PullRequestMetadata extends BaseMetadata {
     author?: string;
     date?: number;
     state?: string;
+    /**
+     * This pull request's position in its stack, counting from 1 at the bottom. Ignored unless it is a whole
+     * number from 1 through `stackSize`.
+     */
+    stackPosition?: number;
+    /** How many pull requests the stack holds. Only names the position when paired with `stackPosition`. */
+    stackSize?: number;
     url?: string;
 }
 export interface UpstreamMetadata extends BaseMetadata {

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

@@ -0,0 +1,6 @@
+import type { HostingServiceInfoType, HostingServiceType } from '../hostingservice/HostingServiceTypes';
+import type { TranslationFn } from '../language/LanguageTypes';
+import type { PullRequestMetadata } from './GraphTypes';
+export declare function hasStackPosition(stackPosition?: number, stackSize?: number): boolean;
+export declare function getPullRequestDisplayId(pullRequestCharacter: string, pullRequestId: number): string;
+export declare function getPullRequestTooltipText(pullRequest: PullRequestMetadata, hostingServiceInfo: Record<HostingServiceType, HostingServiceInfoType>, translate: TranslationFn): string;

package/dist/domain/hostingservice/HostingServiceTypes.d.ts

@@ -16,4 +16,11 @@ export type JiraServerIssueTrackerType = 'jiraServer';
 export type TrelloIssueTrackerType = 'trello';
 export type BitbucketIssueTrackerType = 'bitbucket';
 export type IssueTrackerType = GitHubIssueTrackerType | GithubEnterpriseIssueTrackerType | GitLabIssueTrackerType | GitLabSelfHostedIssueTrackerType | JiraCloudIssueTrackerType | JiraServerIssueTrackerType | TrelloIssueTrackerType | AzureDevopsIssueTrackerType | BitbucketIssueTrackerType;
+/**
+ * @deprecated Pass `hostingServiceInfo` to `GraphContainer` instead. Removed in the next major version.
+ */
 export declare function getHostingServiceName(hostingServiceType: HostingServiceType): string;
+export type HostingServiceInfoType = {
+    name: string;
+    pullRequestCharacter: string;
+};