@cesar-richard/git-connector-sdk 1.33.1 → 1.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +16 -0
  2. package/dist/schema.d.ts +40 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -192,6 +192,22 @@ for (const wi of data.items) {
192
192
  }
193
193
  ```
194
194
 
195
+ ### Link traceability (`linkedActivities[].linkSource`)
196
+
197
+ Each entry in `linkedActivities` carries an optional `linkSource` object with the
198
+ raw `hintSource` persisted on the link row and a human-readable `kind` derived
199
+ from it (`body-ref`, `title-ref`, `pr-comment-ref`, `issue-comment-ref`,
200
+ `unknown`). Consumers can use this to surface WHY a link was created — useful
201
+ for debugging missing or unexpected links in the Explorer UI.
202
+
203
+ ```ts
204
+ for (const pr of wi.linkedActivities) {
205
+ if (pr.linkSource) {
206
+ console.log(` ↳ ${pr.url} linked via ${pr.linkSource.kind} (${pr.linkSource.hintSource})`);
207
+ }
208
+ }
209
+ ```
210
+
195
211
  GitLab resolution uses a 90-day cache (configurable via `GITLAB_USER_CACHE_TTL_DAYS`).
196
212
 
197
213
  ### Issue ↔ PR/MR link detection patterns
package/dist/schema.d.ts CHANGED
@@ -203,6 +203,10 @@ export interface components {
203
203
  name: string;
204
204
  color: string | null;
205
205
  };
206
+ LinkSource: {
207
+ hintSource: string;
208
+ kind: string;
209
+ };
206
210
  LinkedActivity: {
207
211
  id: string;
208
212
  type: "pr" | "mr";
@@ -267,6 +271,10 @@ export interface components {
267
271
  }[];
268
272
  } | null;
269
273
  reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
274
+ linkSource?: {
275
+ hintSource: string;
276
+ kind: string;
277
+ };
270
278
  };
271
279
  Provider: "github" | "gitlab";
272
280
  ResolvedUser: {
@@ -433,6 +441,10 @@ export interface components {
433
441
  }[];
434
442
  } | null;
435
443
  reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
444
+ linkSource?: {
445
+ hintSource: string;
446
+ kind: string;
447
+ };
436
448
  }[];
437
449
  statusHistory: {
438
450
  label: {
@@ -550,6 +562,10 @@ export interface components {
550
562
  }[];
551
563
  } | null;
552
564
  reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
565
+ linkSource?: {
566
+ hintSource: string;
567
+ kind: string;
568
+ };
553
569
  }[];
554
570
  statusHistory: {
555
571
  label: {
@@ -716,6 +732,10 @@ export interface operations {
716
732
  }[];
717
733
  } | null;
718
734
  reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
735
+ linkSource?: {
736
+ hintSource: string;
737
+ kind: string;
738
+ };
719
739
  }[];
720
740
  statusHistory: {
721
741
  label: {
@@ -837,6 +857,10 @@ export interface operations {
837
857
  }[];
838
858
  } | null;
839
859
  reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
860
+ linkSource?: {
861
+ hintSource: string;
862
+ kind: string;
863
+ };
840
864
  }[];
841
865
  statusHistory: {
842
866
  label: {
@@ -958,6 +982,10 @@ export interface operations {
958
982
  }[];
959
983
  } | null;
960
984
  reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
985
+ linkSource?: {
986
+ hintSource: string;
987
+ kind: string;
988
+ };
961
989
  }[];
962
990
  statusHistory: {
963
991
  label: {
@@ -1103,6 +1131,10 @@ export interface operations {
1103
1131
  }[];
1104
1132
  } | null;
1105
1133
  reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
1134
+ linkSource?: {
1135
+ hintSource: string;
1136
+ kind: string;
1137
+ };
1106
1138
  }[];
1107
1139
  statusHistory: {
1108
1140
  label: {
@@ -1219,6 +1251,10 @@ export interface operations {
1219
1251
  }[];
1220
1252
  } | null;
1221
1253
  reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
1254
+ linkSource?: {
1255
+ hintSource: string;
1256
+ kind: string;
1257
+ };
1222
1258
  }[];
1223
1259
  statusHistory: {
1224
1260
  label: {
@@ -1335,6 +1371,10 @@ export interface operations {
1335
1371
  }[];
1336
1372
  } | null;
1337
1373
  reviewStatus?: "draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed";
1374
+ linkSource?: {
1375
+ hintSource: string;
1376
+ kind: string;
1377
+ };
1338
1378
  }[];
1339
1379
  statusHistory: {
1340
1380
  label: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cesar-richard/git-connector-sdk",
3
- "version": "1.33.1",
3
+ "version": "1.34.0",
4
4
  "description": "TypeScript SDK for the git-connector v1 API (work items + iterations aggregated from GitHub/GitLab). Version published on npm tracks server releases.",
5
5
  "license": "MIT",
6
6
  "repository": {