@cesar-richard/git-connector-sdk 1.30.0 → 1.32.0

package/README.md

@@ -154,6 +154,41 @@ for (const e of data.events) {
 
 Available on every commit event regardless of provider or ingestion path. `event.author` is always equal to `event.authorResolved?.login`.
 
+### PR review status (`reviewStatus`)
+
+Each `LinkedActivity` carries an optional `reviewStatus` field with 8 possible
+values, computed server-side from the PR's state, draft flag, requested
+reviewers, and review history:
+
+| Value | Meaning |
+|---|---|
+| `draft` | PR is a draft — not yet ready for review |
+| `open-no-review` | Open, no reviewer requested |
+| `open-awaiting-my-review` | Open, you (the `viewer`) are a requested reviewer |
+| `open-awaiting-other-review` | Open, waiting on someone else's review |
+| `open-changes-requested` | Open, at least one reviewer requested changes (and that verdict hasn't been superseded by an approval) |
+| `open-approved` | Open and approved, no outstanding change requests |
+| `merged` | Merged |
+| `closed` | Closed without merging |
+
+Pass `?viewer=<login>` (case-insensitive) on `GET /v1/work-items` or
+`GET /v1/work-items/{source}/{projectKey}/{number}` to drive the
+`open-awaiting-my-review` vs `open-awaiting-other-review` split. Without
+`viewer`, awaiting-review PRs always show as `open-awaiting-other-review`.
+
+```ts
+const { data } = await client.GET("/v1/work-items", {
+  params: { query: { state: "open", viewer: "cesar" } },
+});
+for (const wi of data.items) {
+  for (const pr of wi.linkedActivities) {
+    if (pr.reviewStatus === "open-awaiting-my-review") {
+      console.log(`Needs your review: ${pr.url}`);
+    }
+  }
+}
+```
+
 ---
 
 ## API surface

package/dist/schema.d.ts

@@ -254,6 +254,7 @@ export interface components {
                     url: string | null;
                 }[];
             } | null;
+            reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
         };
         Provider: "github" | "gitlab";
         Review: {
@@ -262,6 +263,7 @@ export interface components {
             submittedAt: string;
             url: string | null;
         };
+        ReviewStatus: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
         ReviewsSummary: {
             approvedCount: string | number;
             changesRequestedCount: string | number;
@@ -382,6 +384,7 @@ export interface components {
                         url: string | null;
                     }[];
                 } | null;
+                reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
             }[];
             statusHistory: {
                 label: {
@@ -480,6 +483,7 @@ export interface components {
                             url: string | null;
                         }[];
                     } | null;
+                    reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
                 }[];
                 statusHistory: {
                     label: {
@@ -536,6 +540,8 @@ export interface operations {
                 withoutApproval?: string;
                 /** @description Returns only work items where AT LEAST ONE linked PR/MR has been reviewed by the given username (case-insensitive, any state). */
                 reviewerIs?: string;
+                /** @description Login (case-insensitive) used to compute linkedActivities[].reviewStatus. When the viewer is in a PR's requested reviewers and no verdict is active, reviewStatus is 'open-awaiting-my-review' instead of 'open-awaiting-other-review'. */
+                viewer?: string;
             };
             header?: never;
             path?: never;
@@ -625,6 +631,7 @@ export interface operations {
                                         url: string | null;
                                     }[];
                                 } | null;
+                                reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
                             }[];
                             statusHistory: {
                                 label: {
@@ -727,6 +734,7 @@ export interface operations {
                                         url: string | null;
                                     }[];
                                 } | null;
+                                reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
                             }[];
                             statusHistory: {
                                 label: {
@@ -829,6 +837,7 @@ export interface operations {
                                         url: string | null;
                                     }[];
                                 } | null;
+                                reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
                             }[];
                             statusHistory: {
                                 label: {
@@ -860,7 +869,10 @@ export interface operations {
     };
     "getV1Work-itemsBySourceByProjectKeyByNumber": {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Login (case-insensitive) used to compute linkedActivities[].reviewStatus. Drives the 'open-awaiting-my-review' vs 'open-awaiting-other-review' split. */
+                viewer?: string;
+            };
             header?: never;
             path: {
                 source: string;
@@ -952,6 +964,7 @@ export interface operations {
                                     url: string | null;
                                 }[];
                             } | null;
+                            reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
                         }[];
                         statusHistory: {
                             label: {
@@ -1049,6 +1062,7 @@ export interface operations {
                                     url: string | null;
                                 }[];
                             } | null;
+                            reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
                         }[];
                         statusHistory: {
                             label: {
@@ -1146,6 +1160,7 @@ export interface operations {
                                     url: string | null;
                                 }[];
                             } | null;
+                            reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
                         }[];
                         statusHistory: {
                             label: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cesar-richard/git-connector-sdk",
-  "version": "1.30.0",
+  "version": "1.32.0",
   "description": "TypeScript SDK for the git-connector v1 API (work items + iterations aggregated from GitHub/GitLab). Version published on npm tracks server releases.",
   "license": "MIT",
   "repository": {