@kud/gh-ink 0.1.0 → 0.3.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { ReactNode } from 'react';
 import { PrComments, PrHealthData, PrCheck, Health } from '@kud/gh';
 import { StyledLine } from '@kud/ink-ui';
 
@@ -9,8 +9,9 @@ type CommentsPanelProps = {
     error: string | null;
     reload: () => void;
     onReplyingChange?: (active: boolean) => void;
+    showConversationHeading?: boolean;
 };
-declare const CommentsPanel: ({ repo, number, data, error, reload, onReplyingChange, }: CommentsPanelProps) => React.JSX.Element;
+declare const CommentsPanel: ({ repo, number, data, error, reload, onReplyingChange, showConversationHeading, }: CommentsPanelProps) => React.JSX.Element;
 
 type HealthPanelProps = {
     repo: string;
@@ -32,4 +33,204 @@ declare const healthGlyph: (h: Health) => string;
 declare const healthColor: (h: Health) => string;
 declare const healthLegend: [Health, string][];
 
-export { CommentsPanel, type CommentsPanelProps, HealthPanel, type HealthPanelProps, healthColor, healthDisplay, healthGlyph, healthLegend, renderMarkdown };
+interface InboxExtension {
+    id: string;
+    title: string;
+    key: string;
+    body: (onExit: () => void, target?: string) => ReactNode;
+}
+
+type GHDetail = {
+    reviewDecision?: string;
+    mergeable?: string;
+    checksPass: number;
+    checksFail: number;
+    checksPending: number;
+    threadsTotal: number;
+    lastCommitAt?: string;
+    lastEventAt?: string;
+};
+type GHItem = {
+    kind: "pr" | "issue";
+    number: number;
+    title: string;
+    repo: string;
+    url: string;
+    branch?: string;
+    health: Health;
+    author?: string;
+    age: string;
+    ts: number;
+    unresolved: number;
+    conversation: number;
+    lastActor?: string;
+    detail?: GHDetail;
+    indent: boolean;
+};
+type JiraRow = {
+    kind: "jira";
+    key: string;
+    summary: string;
+    url: string;
+    jiraStatus: string;
+    age: string;
+    indent: boolean;
+    instanceKey?: string;
+};
+type RepoHeader = {
+    kind: "repo-header";
+    repo: string;
+    age: string;
+    indent: boolean;
+};
+type ShowMore = {
+    kind: "show-more";
+    hidden: GHItem[];
+    indent: boolean;
+};
+type ShowLess = {
+    kind: "show-less";
+    toHide: GHItem[];
+    indent: boolean;
+};
+type SubgroupHeader = {
+    kind: "subgroup-header";
+    label: string;
+    age: string;
+    indent: boolean;
+};
+type AnyItem = GHItem | JiraRow | RepoHeader | SubgroupHeader | ShowMore | ShowLess;
+type CiStatus = {
+    job: string;
+    buildNumber: number;
+    result: string;
+    building: boolean;
+    url: string;
+    age: string;
+};
+type Section = {
+    id: string;
+    label: string;
+    items: AnyItem[];
+};
+type DetailContext = {
+    item: GHItem;
+    kind: "pr" | "issue";
+    login: string;
+    onBack: () => void;
+    onRefresh: () => void;
+    onRemove: (item: GHItem) => void;
+};
+type Action = {
+    label: string;
+    hint: string;
+    run: () => void;
+    subActions?: Action[];
+};
+type JiraTransition = {
+    label: string;
+    state: string;
+    resolutions?: string[];
+};
+declare const relativeTime: (iso: string) => string;
+type ExplainSection = {
+    heading: string;
+    lines: string[];
+};
+declare const explainItem: (item: GHItem, login: string) => ExplainSection[];
+declare const repoPriority: (repo: string) => number;
+declare const sortItems: (items: GHItem[]) => GHItem[];
+declare const sortByRecency: (items: GHItem[]) => GHItem[];
+declare const insertRepoHeaders: (items: GHItem[]) => AnyItem[];
+declare const layoutGHItems: (items: GHItem[], sectionId: string) => AnyItem[];
+declare const filterByOrigin: (sections: Section[], keep: "work" | "home", isWorkRepo: (repo: string) => boolean) => Section[];
+declare const filterBySearch: (sections: Section[], query: string) => Section[];
+declare const filterByRepos: (sections: Section[], repos: Set<string>) => Section[];
+declare const withoutItem: (sections: Section[], target: GHItem) => Section[];
+declare const reposInSections: (sections: Section[]) => string[];
+declare const moveCursor: (items: AnyItem[], current: number, dir: 1 | -1) => number;
+declare const fitCount: (items: AnyItem[], start: number, budget: number) => number;
+declare const windowCount: (items: AnyItem[], start: number, budget: number) => number;
+declare const maxViewStart: (items: AnyItem[], budget: number) => number;
+declare const withHeaders: (items: AnyItem[], idx: number) => number;
+declare const truncate: (str: string, max: number) => string;
+declare const clipboard: (text: string) => void;
+declare const buildCheckoutCmd: (repoFull: string, branch: string, login: string) => Promise<string>;
+declare const resolveRepoPath: (repoFull: string) => Promise<string | null>;
+declare const itermRun: (cmd: string, appleScript: string) => Promise<void>;
+declare const jumpToRepo: (repoFull: string, branch: string, login: string) => Promise<void>;
+declare const runInPane: (cmd: string) => Promise<void>;
+declare const jumpToRepoPane: (repoFull: string, branch: string, login: string) => Promise<void>;
+declare const openInTab: (cmd: string) => Promise<void>;
+declare const runInPaneHorizontal: (cmd: string) => Promise<void>;
+declare const runHere: (cmd: string) => void;
+declare const COLS: number;
+declare const topLevelCount: (s: Section) => number;
+declare const drillCmd: (item: AnyItem) => string | null;
+declare const buildActions: (item: AnyItem, login: string, showFlash: (msg: string) => void, jiraBase?: string, jiraKeyRe?: RegExp, jiraTransitions?: JiraTransition[], onRefresh?: () => void, onRemove?: (item: GHItem) => void, onOpenView?: (item: AnyItem) => boolean) => Action[];
+type CiStatusState = {
+    kind: "loading";
+} | {
+    kind: "error";
+} | {
+    kind: "ready";
+    status: CiStatus;
+};
+declare const toCiStatusState: (status: CiStatus | null) => CiStatusState;
+declare const sameCiStatusState: (a: CiStatusState, b: CiStatusState) => boolean;
+declare const CiStatusLine: ({ state, job, }: {
+    state: CiStatusState;
+    job?: string;
+}) => React.JSX.Element;
+declare const useActionMenu: () => {
+    actions: Action[] | null;
+    cursor: number;
+    open: (next: Action[]) => void;
+    close: () => void;
+    handleKey: (key: {
+        upArrow?: boolean;
+        downArrow?: boolean;
+        return?: boolean;
+        escape?: boolean;
+    }) => boolean;
+};
+declare const ActionMenu: ({ item, actions, cursor, }: {
+    item: AnyItem;
+    actions: Action[];
+    cursor: number;
+}) => React.JSX.Element;
+declare const App: ({ fetcher, cacheKey, title, detailFor, isWorkRepo, initialIncludeWork, jiraBase, jiraKeyRe, jiraTransitions, workToggle, hasCiStatus, ciJob, ciFetcher, ciPollMs, extensions, tabHelp, }: {
+    fetcher: () => Promise<{
+        sections: Section[];
+        login: string;
+        ciStatus?: CiStatus | null;
+    }>;
+    cacheKey?: string;
+    title?: string;
+    detailFor?: (ctx: DetailContext) => React.ReactNode;
+    isWorkRepo?: (repo: string) => boolean;
+    initialIncludeWork?: boolean;
+    tabHelp?: [string, string][];
+    jiraBase?: string;
+    jiraKeyRe?: RegExp;
+    jiraTransitions?: JiraTransition[];
+    workToggle?: boolean;
+    hasCiStatus?: boolean;
+    ciJob?: string;
+    ciFetcher?: () => Promise<CiStatus | null>;
+    ciPollMs?: number;
+    extensions?: InboxExtension[];
+}) => React.JSX.Element;
+
+type CachedCockpit = {
+    sections: Section[];
+    login: string;
+    at: number;
+};
+declare const readCache: (key: string) => CachedCockpit | null;
+declare const writeCache: (key: string, data: {
+    sections: Section[];
+    login: string;
+}) => void;
+
+export { type Action, ActionMenu, type AnyItem, App, COLS, type CiStatus, CiStatusLine, type CiStatusState, CommentsPanel, type CommentsPanelProps, type DetailContext, type ExplainSection, type GHDetail, type GHItem, HealthPanel, type HealthPanelProps, type InboxExtension, type JiraRow, type JiraTransition, type RepoHeader, type Section, type ShowLess, type ShowMore, type SubgroupHeader, buildActions, buildCheckoutCmd, clipboard, drillCmd, explainItem, filterByOrigin, filterByRepos, filterBySearch, fitCount, healthColor, healthDisplay, healthGlyph, healthLegend, insertRepoHeaders, itermRun, jumpToRepo, jumpToRepoPane, layoutGHItems, maxViewStart, moveCursor, openInTab, readCache, relativeTime, renderMarkdown, repoPriority, reposInSections, resolveRepoPath, runHere, runInPane, runInPaneHorizontal, sameCiStatusState, sortByRecency, sortItems, toCiStatusState, topLevelCount, truncate, useActionMenu, windowCount, withHeaders, withoutItem, writeCache };