@kud/gh 0.4.0 → 0.5.0

package/dist/inbox.d.ts

@@ -1,9 +1,31 @@
+/**
+ * How much of each row to ask for.
+ *
+ * `full` carries health, conversation and labels — everything `computeHealth`
+ * and a conversation line need. `minimal` carries identity only: type, number,
+ * title, url, draft, timestamp, repo.
+ *
+ * This is a cost axis, not a taste one. Measured against GitHub's own
+ * `rateLimit { cost }`: the full query costs **111 points** of a 5000/hour
+ * budget, at a nodeCount of ~25,550 — because `statusCheckRollup.contexts`
+ * appears in five PR fragments and `reviewThreads(first: 50)` multiplies
+ * beneath each one. A caller that renders a title and a link was paying for
+ * every check run on every open PR. At 111 a poller gets 45 refreshes an hour.
+ */
+export type InboxShape = "full" | "minimal";
 /** A repo-scoped or account-wide inbox. */
 export type InboxQueryOptions = {
     /** `owner/name`. Scopes every search to one repository. */
     repo?: string;
     /** How far back `recentlyDone` looks. Defaults to 14 days. */
     doneWithinDays?: number;
+    /**
+     * Defaults to `full`, so every existing caller keeps what it had. Reach for
+     * `minimal` only when nothing downstream reads health, conversation or
+     * labels — those fields do not degrade, they vanish, and `computeHealth`
+     * falls through to a wrong answer rather than an absent one.
+     */
+    shape?: InboxShape;
 };
 /**
  * Build the inbox query. Without `repo`, it is account-wide.
@@ -14,5 +36,5 @@ export type InboxQueryOptions = {
  * render empty and read as "nothing to do here". So `repo:` REPLACES
  * `user:@me` rather than joining it.
  */
-export declare const buildInboxQuery: ({ repo, doneWithinDays, }?: InboxQueryOptions) => string;
+export declare const buildInboxQuery: ({ repo, doneWithinDays, shape, }?: InboxQueryOptions) => string;
 //# sourceMappingURL=inbox.d.ts.map

package/dist/inbox.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inbox.d.ts","sourceRoot":"","sources":["../src/inbox.ts"],"names":[],"mappings":"AAQA,2CAA2C;AAC3C,MAAM,MAAM,iBAAiB,GAAG;IAC9B,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,8DAA8D;IAC9D,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAmDD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAAI,4BAG7B,iBAAsB,WAoFxB,CAAA"}
+{"version":3,"file":"inbox.d.ts","sourceRoot":"","sources":["../src/inbox.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,CAAA;AAE3C,2CAA2C;AAC3C,MAAM,MAAM,iBAAiB,GAAG;IAC9B,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,8DAA8D;IAC9D,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,UAAU,CAAA;CACnB,CAAA;AA6DD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAAI,mCAI7B,iBAAsB,WA6FxB,CAAA"}

package/dist/inbox.js

@@ -8,10 +8,20 @@
 // computeHealth's precedence needs reviewDecision, mergeable and the check
 // rollup. A fragment that omits them does NOT degrade gracefully — it falls
 // straight through to whatever token is left, so a PR you already sent back
-// renders as "awaiting review" and a failing one renders as quiet. Every PR
-// fragment therefore carries the whole set; none of it is optional.
+// renders as "awaiting review" and a failing one renders as quiet.
+//
+// So this set is all-or-nothing, which is exactly why `shape` drops it whole
+// rather than field by field: a caller either computes health and needs every
+// one of these, or renders none of it and should pay for none of it. There is
+// no coherent middle, and the `minimal` shape is not a smaller health — it is
+// the absence of health.
+//
+// `isDraft` is deliberately NOT in here. It is identity, not health, and a
+// minimal caller still has to tell a draft from an open PR, so it sits in the
+// base field list beside `number` and `title` where dropping health cannot
+// take it with them.
 const PR_HEALTH = `
-      isDraft reviewDecision mergeable
+      reviewDecision mergeable
       statusCheckRollup { contexts(first: 20) { nodes {
         ... on CheckRun { name conclusion status }
         ... on StatusContext { context state }
@@ -57,37 +67,45 @@ const sinceDay = (days) => new Date(Date.now() - days * 86400 * 1000).toISOStrin
  * render empty and read as "nothing to do here". So `repo:` REPLACES
  * `user:@me` rather than joining it.
  */
-export const buildInboxQuery = ({ repo, doneWithinDays = 14, } = {}) => {
+export const buildInboxQuery = ({ repo, doneWithinDays = 14, shape = "full", } = {}) => {
     const scope = repo ? `repo:${repo} ` : "";
     const owned = repo ? "" : "user:@me ";
     const doneSince = sinceDay(doneWithinDays);
+    /* Interpolated as empty strings rather than branching the query text, so the
+       two shapes cannot drift into two separately-maintained queries. */
+    const full = shape === "full";
+    const health = full ? PR_HEALTH : "";
+    const conversation = full ? PR_CONVERSATION : "";
+    const issueConversation = full ? ISSUE_CONVERSATION : "";
+    const issueLabels = full ? ISSUE_LABELS : "";
     return `
 {
   viewer { login }
   myPRs: search(query: "${scope}is:pr is:open author:@me", type: ISSUE, first: 100) {
     nodes { __typename ... on PullRequest {
-      number title createdAt url headRefName
+      number title createdAt url headRefName isDraft
       repository { nameWithOwner }
-      ${PR_HEALTH}
-      ${PR_CONVERSATION}
+      author { login }
+      ${health}
+      ${conversation}
     }}
   }
   reviewRequests: search(query: "${scope}is:pr is:open review-requested:@me", type: ISSUE, first: 20) {
     nodes { __typename ... on PullRequest {
-      number title createdAt url headRefName
+      number title createdAt url headRefName isDraft
       repository { nameWithOwner }
       author { login }
-      ${PR_HEALTH}
-      ${PR_CONVERSATION}
+      ${health}
+      ${conversation}
     }}
   }
   reviewed: search(query: "${scope}is:pr is:open reviewed-by:@me -author:@me -review-requested:@me", type: ISSUE, first: 20) {
     nodes { __typename ... on PullRequest {
-      number title createdAt url headRefName
+      number title createdAt url headRefName isDraft
       repository { nameWithOwner }
       author { login }
-      ${PR_HEALTH}
-      ${PR_CONVERSATION}
+      ${health}
+      ${conversation}
     }}
   }
   assigned: search(query: "${scope}is:open assignee:@me", type: ISSUE, first: 30) {
@@ -95,13 +113,13 @@ export const buildInboxQuery = ({ repo, doneWithinDays = 14, } = {}) => {
       __typename
       ... on Issue {
         number title createdAt url repository { nameWithOwner } author { login }
-        ${ISSUE_CONVERSATION}
-        ${ISSUE_LABELS}
+        ${issueConversation}
+        ${issueLabels}
       }
       ... on PullRequest {
-        number title createdAt url headRefName repository { nameWithOwner } author { login }
-        ${PR_HEALTH}
-        ${PR_CONVERSATION}
+        number title createdAt url headRefName isDraft repository { nameWithOwner } author { login }
+        ${health}
+        ${conversation}
       }
     }
   }
@@ -110,8 +128,8 @@ export const buildInboxQuery = ({ repo, doneWithinDays = 14, } = {}) => {
       number title createdAt url
       repository { nameWithOwner }
       author { login }
-      ${ISSUE_CONVERSATION}
-      ${ISSUE_LABELS}
+      ${issueConversation}
+      ${issueLabels}
     }}
   }
   authoredIssues: search(query: "${scope}is:issue is:open author:@me archived:false", type: ISSUE, first: 30) {
@@ -119,17 +137,17 @@ export const buildInboxQuery = ({ repo, doneWithinDays = 14, } = {}) => {
       number title createdAt url
       repository { nameWithOwner }
       author { login }
-      ${ISSUE_CONVERSATION}
-      ${ISSUE_LABELS}
+      ${issueConversation}
+      ${issueLabels}
     }}
   }
   repoPRs: search(query: "${scope}${owned}is:pr is:open -author:@me archived:false", type: ISSUE, first: 30) {
     nodes { __typename ... on PullRequest {
-      number title createdAt url headRefName
+      number title createdAt url headRefName isDraft
       repository { nameWithOwner }
       author { login }
-      ${PR_HEALTH}
-      ${PR_CONVERSATION}
+      ${health}
+      ${conversation}
     }}
   }
   recentlyDone: search(query: "${scope}is:pr author:@me -is:open closed:>=${doneSince}", type: ISSUE, first: 30) {

package/dist/inbox.js.map

@@ -1 +1 @@
-{"version":3,"file":"inbox.js","sourceRoot":"","sources":["../src/inbox.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,6EAA6E;AAC7E,qCAAqC;AACrC,EAAE;AACF,6EAA6E;AAC7E,+EAA+E;AAC/E,uDAAuD;AAUvD,2EAA2E;AAC3E,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAC5E,oEAAoE;AACpE,MAAM,SAAS,GAAG;;;;;YAKN,CAAA;AAEZ,6EAA6E;AAC7E,gFAAgF;AAChF,8EAA8E;AAC9E,2DAA2D;AAC3D,EAAE;AACF,8EAA8E;AAC9E,8EAA8E;AAC9E,4EAA4E;AAC5E,gFAAgF;AAChF,8EAA8E;AAC9E,+DAA+D;AAC/D,MAAM,eAAe,GAAG;;;;;;;8DAOsC,CAAA;AAE9D,MAAM,kBAAkB,GAAG;uFAC4D,CAAA;AAEvF,+EAA+E;AAC/E,qEAAqE;AACrE,MAAM,YAAY,GAAG;2CACsB,CAAA;AAE3C;;;;;GAKG;AACH,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAChC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;AAEvE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,EAC9B,IAAI,EACJ,cAAc,GAAG,EAAE,MACE,EAAE,EAAE,EAAE;IAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IACzC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAA;IACrC,MAAM,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAA;IAE1C,OAAO;;;0BAGiB,KAAK;;;;QAIvB,SAAS;QACT,eAAe;;;mCAGY,KAAK;;;;;QAKhC,SAAS;QACT,eAAe;;;6BAGM,KAAK;;;;;QAK1B,SAAS;QACT,eAAe;;;6BAGM,KAAK;;;;;UAKxB,kBAAkB;UAClB,YAAY;;;;UAIZ,SAAS;UACT,eAAe;;;;+BAIM,KAAK,GAAG,KAAK;;;;;QAKpC,kBAAkB;QAClB,YAAY;;;mCAGe,KAAK;;;;;QAKhC,kBAAkB;QAClB,YAAY;;;4BAGQ,KAAK,GAAG,KAAK;;;;;QAKjC,SAAS;QACT,eAAe;;;iCAGU,KAAK,sCAAsC,SAAS;;;;;;;CAOpF,CAAA;AACD,CAAC,CAAA"}
+{"version":3,"file":"inbox.js","sourceRoot":"","sources":["../src/inbox.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,6EAA6E;AAC7E,qCAAqC;AACrC,EAAE;AACF,6EAA6E;AAC7E,+EAA+E;AAC/E,uDAAuD;AAiCvD,2EAA2E;AAC3E,4EAA4E;AAC5E,4EAA4E;AAC5E,mEAAmE;AACnE,EAAE;AACF,6EAA6E;AAC7E,8EAA8E;AAC9E,8EAA8E;AAC9E,8EAA8E;AAC9E,yBAAyB;AACzB,EAAE;AACF,2EAA2E;AAC3E,8EAA8E;AAC9E,2EAA2E;AAC3E,qBAAqB;AACrB,MAAM,SAAS,GAAG;;;;;YAKN,CAAA;AAEZ,6EAA6E;AAC7E,gFAAgF;AAChF,8EAA8E;AAC9E,2DAA2D;AAC3D,EAAE;AACF,8EAA8E;AAC9E,8EAA8E;AAC9E,4EAA4E;AAC5E,gFAAgF;AAChF,8EAA8E;AAC9E,+DAA+D;AAC/D,MAAM,eAAe,GAAG;;;;;;;8DAOsC,CAAA;AAE9D,MAAM,kBAAkB,GAAG;uFAC4D,CAAA;AAEvF,+EAA+E;AAC/E,qEAAqE;AACrE,MAAM,YAAY,GAAG;2CACsB,CAAA;AAE3C;;;;;GAKG;AACH,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAChC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;AAEvE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,EAC9B,IAAI,EACJ,cAAc,GAAG,EAAE,EACnB,KAAK,GAAG,MAAM,MACO,EAAE,EAAE,EAAE;IAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IACzC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAA;IACrC,MAAM,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAA;IAE1C;yEACqE;IACrE,MAAM,IAAI,GAAG,KAAK,KAAK,MAAM,CAAA;IAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAA;IACpC,MAAM,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAA;IAChD,MAAM,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAA;IACxD,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAA;IAE5C,OAAO;;;0BAGiB,KAAK;;;;;QAKvB,MAAM;QACN,YAAY;;;mCAGe,KAAK;;;;;QAKhC,MAAM;QACN,YAAY;;;6BAGS,KAAK;;;;;QAK1B,MAAM;QACN,YAAY;;;6BAGS,KAAK;;;;;UAKxB,iBAAiB;UACjB,WAAW;;;;UAIX,MAAM;UACN,YAAY;;;;+BAIS,KAAK,GAAG,KAAK;;;;;QAKpC,iBAAiB;QACjB,WAAW;;;mCAGgB,KAAK;;;;;QAKhC,iBAAiB;QACjB,WAAW;;;4BAGS,KAAK,GAAG,KAAK;;;;;QAKjC,MAAM;QACN,YAAY;;;iCAGa,KAAK,sCAAsC,SAAS;;;;;;;CAOpF,CAAA;AACD,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kud/gh",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Surface-agnostic GitHub core — gh CLI primitives, PR review comments, health, and webhook logic.",
   "type": "module",
   "main": "dist/index.js",