@kud/gh-cockpit 0.0.0

package/dist/index.d.ts

@@ -0,0 +1,124 @@
+import React, { ReactNode } from 'react';
+import { GHItem, RepoFilter, InboxExtension, DetailContext } from '@kud/gh-ink';
+export * from '@kud/gh-ink';
+import { Health } from '@kud/gh';
+export { buildInboxQuery } from '@kud/gh';
+
+declare const withRetry: <T>(fn: () => Promise<T>, attempts?: number, delayMs?: number) => Promise<T>;
+declare const computeHealth: (node: any) => Health;
+type CockpitItem = GHItem & {
+    labels?: string[];
+};
+declare const toGHItem: (node: any, opts?: {
+    indent?: boolean;
+}) => CockpitItem;
+declare const signalPath: () => string;
+
+type CheckDrillContext = {
+    /** `owner/name` of the PR the check belongs to. */
+    repo: string;
+    /** The check's details URL, as GitHub reported it. */
+    url: string;
+    /** Human label for the check, for the view's own chrome. */
+    name: string;
+    /** Return focus to the PR view. */
+    onBack: () => void;
+};
+type CheckDrill = {
+    /** Whether this viewer handles the URL. Cheap and synchronous — it runs per activation. */
+    match: (url: string) => boolean;
+    render: (ctx: CheckDrillContext) => ReactNode;
+};
+/** Supply the host's CI drill-ins. Call once, before rendering. */
+declare const registerCheckDrills: (drills: readonly CheckDrill[]) => void;
+declare const checkDrillFor: (url: string) => CheckDrill | null;
+
+/**
+ * One tab. `searches` are GitHub search qualifiers, run as written and folded
+ * into a single tab — which is how a tab can draw on more than one search while
+ * still banding each row correctly.
+ *
+ * `standing` says where YOU stand on the rows a search returns, and it cannot be
+ * recovered from a row afterwards: the same "awaiting review" is your work when
+ * a review was requested of you and somebody else's once you have given one.
+ * The two are different searches and nothing else tells them apart.
+ */
+type TabSearch = {
+    /** Search qualifiers, minus `is:pr` — e.g. `review-requested:@me`. */
+    q: string;
+    standing?: "authored" | "queued" | "spoken";
+};
+type TabSpec = {
+    /** Shown on the tab, and in the `?` legend. Yours to word. */
+    label: string;
+    /** One line saying what this tab holds, for the legend. */
+    help?: string;
+    searches: readonly (string | TabSearch)[];
+};
+type CockpitConfig = {
+    tabs: readonly TabSpec[];
+    /**
+     * Repo ranking, best first. `acme/` matches an owner, `acme/monorepo` matches
+     * one repo, so a repo can outrank the owner containing it.
+     */
+    repoPriority?: readonly string[];
+    /** Default filter, which `--include` / `--exclude` override. */
+    filter?: RepoFilter;
+    /** Named filters, invoked as `gh-cockpit <name>`. */
+    filters?: Record<string, RepoFilter>;
+    /** Where checkouts live, for the drill-in that opens one. */
+    checkoutDir?: string;
+    /** Cache directory name and how long a cached inbox is trusted. */
+    cacheNamespace?: string;
+    cacheTtlMs?: number;
+    /** Where a CI check drills in. Nothing registered means checks open in a browser. */
+    checkDrills?: readonly CheckDrill[];
+    extensions?: readonly InboxExtension[];
+    /** Rendered instead of the row's default drill-in, when supplied. */
+    detailFor?: (ctx: never) => ReactNode;
+};
+/**
+ * Identity, but typed — so a config file is checked against the schema at build
+ * time rather than producing an empty tab at runtime. The one thing a YAML
+ * config could not have given us.
+ */
+declare const defineCockpit: (config: CockpitConfig) => CockpitConfig;
+
+type CockpitArgs = {
+    /** Scope every search to the repo you are standing in. */
+    here: boolean;
+    /** Named filter from config, given positionally: `gh-cockpit work`. */
+    named?: string;
+    /** Patterns from the flags, which override a named or default filter. */
+    filter: RepoFilter;
+};
+declare const parseArgs: (argv: readonly string[]) => CockpitArgs;
+/** Whether the flags said anything at all, which decides if they override. */
+declare const hasPatterns: (f: RepoFilter) => boolean;
+
+declare const detailFor: (ctx: DetailContext) => React.JSX.Element;
+
+type Tab = "health" | "conversation";
+declare const PrView: ({ item, login, onBack, defaultTab, onRefresh, onRemove, onMerged, }: {
+    item: GHItem;
+    login: string;
+    onBack: () => void;
+    defaultTab?: Tab;
+    onRefresh?: () => void;
+    onRemove?: (item: GHItem) => void;
+    onMerged?: (item: GHItem) => void;
+}) => React.JSX.Element;
+
+declare const IssueView: ({ item, login, onBack, }: {
+    item: {
+        number: number;
+        repo: string;
+        url: string;
+        title?: string;
+        labels?: string[];
+    };
+    login: string;
+    onBack: () => void;
+}) => React.JSX.Element;
+
+export { type CheckDrill, type CheckDrillContext, type CockpitArgs, type CockpitConfig, type CockpitItem, IssueView, PrView, type TabSearch, type TabSpec, checkDrillFor, computeHealth, defineCockpit, detailFor, hasPatterns, parseArgs, registerCheckDrills, signalPath, toGHItem, withRetry };