@osdlc/typed-gh 0.13.0 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @osdlc/typed-gh
 
+## 0.14.0
+
+### Minor Changes
+
+- c58f58b: `pickPrForBranch` takes the `ListResult` that `openPrsForBranch` and `prList` return, as well as plain rows, so `pickPrForBranch(verb.parse(result), branch)` works without a `.rows` unwrap. It also accepts a readonly array.
+
 ## 0.13.0
 
 ### Minor Changes

package/README.md

@@ -605,8 +605,9 @@ Each verb takes an optional `GhTarget` last. Each client method has a verb of th
   `createReview`, `issueList`, `issueView`, `labelList`, `setIssueLabel`, `createLabel`,
   `editLabel`, `issueCommentEdit`, `repoList`, `repoView`, `searchPrs`, `api`, `graphql`,
   `installed` and `authStatus`.
-- `pickPrForBranch`: the first row whose head branch is exactly the one you name, for rows that
-  came from somewhere other than `prList({ head })`, such as a `head:` search.
+- `pickPrForBranch`: the first row whose head branch is exactly the one you name. `prList({ head })`
+  already filters exactly. This is for rows from elsewhere, such as a `head:` search. It takes plain
+  rows or a `ListResult`, so `openPrsForBranch`'s or `prList`'s parsed answer passes straight in.
 - `nodesAt`: one connection's nodes, joined across `graphql` pages.
 - Field lists: `PR_REF_FIELDS` (enough to identify a PR), `PR_LIST_FIELDS` (for triage),
   `PR_VIEW_FIELDS` (the full set), `REPO_FIELDS` and `SEARCH_PR_FIELDS`.

package/dist/async.js

@@ -133,7 +133,7 @@ export class AsyncGh {
             timeoutMs: opts.timeoutMs,
             signal: opts.signal,
         });
-        return v.pickPrForBranch(rows.rows, branch);
+        return v.pickPrForBranch(rows, branch);
     }
     /** {@link prView}, asked again until GitHub has computed the merge state. See `Gh.prViewSettled`. */
     async prViewSettled(number, opts = {}) {

package/dist/sync.js

@@ -187,7 +187,7 @@ export class Gh {
             fields: opts.fields ?? v.PR_REF_FIELDS,
             timeoutMs: opts.timeoutMs,
         });
-        return v.pickPrForBranch(rows.rows, branch);
+        return v.pickPrForBranch(rows, branch);
     }
     /**
      * {@link prView}, asked again until GitHub has computed the merge state.

package/dist/verbs.d.ts

@@ -487,11 +487,15 @@ export declare function createReview(number: number, opts: CreateReviewOptions,
 /**
  * The first row whose `headRefName` exactly equals `branch`, or null.
  *
- * `prList({ head })` already filters exactly. This is for rows from anywhere
- * else, such as a `search` query with gh's `head:` qualifier, which matches
- * `task/foo-2` for `task/foo`.
+ * Takes the rows, or the `ListResult` that {@link openPrsForBranch} and
+ * `prList` return, so their parsed answer passes straight in. Null (a failed
+ * call) stays null.
+ *
+ * `prList({ head })` already filters exactly. The filter here is for rows
+ * from anywhere else, such as a `search` query with gh's `head:` qualifier,
+ * which matches `task/foo-2` for `task/foo`.
  */
-export declare function pickPrForBranch(rows: PullRequest[] | null, branch: string): PullRequest | null;
+export declare function pickPrForBranch(rows: readonly PullRequest[] | ListResult<PullRequest> | null, branch: string): PullRequest | null;
 /**
  * The PR a branch names, from `prList({ head, state: 'all' })` rows: the open
  * one, or else the first row (gh lists newest first). Null when there are no

package/dist/verbs.js

@@ -1078,14 +1078,19 @@ export function createReview(number, opts, target) {
 /**
  * The first row whose `headRefName` exactly equals `branch`, or null.
  *
- * `prList({ head })` already filters exactly. This is for rows from anywhere
- * else, such as a `search` query with gh's `head:` qualifier, which matches
- * `task/foo-2` for `task/foo`.
+ * Takes the rows, or the `ListResult` that {@link openPrsForBranch} and
+ * `prList` return, so their parsed answer passes straight in. Null (a failed
+ * call) stays null.
+ *
+ * `prList({ head })` already filters exactly. The filter here is for rows
+ * from anywhere else, such as a `search` query with gh's `head:` qualifier,
+ * which matches `task/foo-2` for `task/foo`.
  */
 export function pickPrForBranch(rows, branch) {
     if (rows === null)
         return null;
-    return rows.find((r) => r.headRefName === branch) ?? null;
+    const list = 'rows' in rows ? rows.rows : rows;
+    return list.find((r) => r.headRefName === branch) ?? null;
 }
 /**
  * The PR a branch names, from `prList({ head, state: 'all' })` rows: the open

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdlc/typed-gh",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "A typed GitHub client for TypeScript over the gh CLI. A total PullRequest/Review/CheckRun model, pure argv builders and parsers, and a tri-modal client — queries return parsed values, mutations throw, raw() is the escape hatch. Uses gh's own credentials; reads no token.",
   "license": "MIT OR Apache-2.0",
   "author": "sksizer",
@@ -58,8 +58,8 @@
     "prettier": "3.9.6",
     "typescript": "~6.0.3",
     "vitest": "^5.0.5",
-    "@osdlc/prettier-config": "^0.3.1",
-    "@osdlc/tsconfig": "^0.4.1"
+    "@osdlc/tsconfig": "^0.4.1",
+    "@osdlc/prettier-config": "^0.3.1"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",