@cesar-richard/git-connector-sdk 2.8.0 → 2.10.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 (2) hide show
  1. package/dist/schema.d.ts +119 -0
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -261,6 +261,11 @@ export interface components {
261
261
  reviewRequestedAt: string | null;
262
262
  /** @description Review lifecycle bucket, or null for issues — an issue is not under review, so no bucket applies. Pass ?viewer to split 'open-awaiting-my-review' from 'open-awaiting-other-review'; without it, a pending review always reads as 'open-awaiting-other-review'. */
263
263
  reviewStatus: ("draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed") | null;
264
+ /** @description Provider labels on the PR/MR/issue itself. Same semantic as WorkItem.labels: raw provider form (`d73a4a` on GitHub, `#428BCA` on GitLab), `color` null when the provider only gave a name (GitLab returns bare strings without label details), and scoped names like `priority::high` are NOT split. Empty array when unlabelled — never absent. */
265
+ labels: {
266
+ name: string;
267
+ color: string | null;
268
+ }[];
264
269
  authorIdentity?: {
265
270
  id: string | number;
266
271
  displayName: string;
@@ -304,6 +309,11 @@ export interface components {
304
309
  reviewRequestedAt: string | null;
305
310
  /** @description Review lifecycle bucket, or null for issues — an issue is not under review, so no bucket applies. Pass ?viewer to split 'open-awaiting-my-review' from 'open-awaiting-other-review'; without it, a pending review always reads as 'open-awaiting-other-review'. */
306
311
  reviewStatus: ("draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed") | null;
312
+ /** @description Provider labels on the PR/MR/issue itself. Same semantic as WorkItem.labels: raw provider form (`d73a4a` on GitHub, `#428BCA` on GitLab), `color` null when the provider only gave a name (GitLab returns bare strings without label details), and scoped names like `priority::high` are NOT split. Empty array when unlabelled — never absent. */
313
+ labels: {
314
+ name: string;
315
+ color: string | null;
316
+ }[];
307
317
  authorIdentity?: {
308
318
  id: string | number;
309
319
  displayName: string;
@@ -384,9 +394,13 @@ export interface components {
384
394
  [key: string]: unknown;
385
395
  };
386
396
  DeliverableAttribution: {
397
+ /** @description The user is an assignee of the issue. Independent of any PR/MR link. */
387
398
  isAssignee: boolean;
399
+ /** @description The user authored a commit inside a PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). Commits on a PR/MR that merely mentions the issue do NOT count. */
388
400
  hasOwnCommit: boolean;
401
+ /** @description The user authored a merged PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). A merged PR/MR that only says 'Related to <issue>' does NOT count — it links the two without delivering the issue. */
389
402
  isMergedPRAuthor: boolean;
403
+ /** @description First match wins: assigned > committer > pr_author > none. Only `resolves` links feed the committer/pr_author paths — `attributable` (which includes plain references) drives TIME imputation, not delivery. */
390
404
  result: "assigned" | "committer" | "pr_author" | "none";
391
405
  };
392
406
  DeliverableEvidence: {
@@ -431,9 +445,13 @@ export interface components {
431
445
  transitionBy: string | null;
432
446
  };
433
447
  attribution: {
448
+ /** @description The user is an assignee of the issue. Independent of any PR/MR link. */
434
449
  isAssignee: boolean;
450
+ /** @description The user authored a commit inside a PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). Commits on a PR/MR that merely mentions the issue do NOT count. */
435
451
  hasOwnCommit: boolean;
452
+ /** @description The user authored a merged PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). A merged PR/MR that only says 'Related to <issue>' does NOT count — it links the two without delivering the issue. */
436
453
  isMergedPRAuthor: boolean;
454
+ /** @description First match wins: assigned > committer > pr_author > none. Only `resolves` links feed the committer/pr_author paths — `attributable` (which includes plain references) drives TIME imputation, not delivery. */
437
455
  result: "assigned" | "committer" | "pr_author" | "none";
438
456
  } | null;
439
457
  linkedActivities: {
@@ -518,6 +536,11 @@ export interface components {
518
536
  url: string | null;
519
537
  }[];
520
538
  } | null;
539
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
540
+ labels: {
541
+ name: string;
542
+ color: string | null;
543
+ }[];
521
544
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
522
545
  ci?: {
523
546
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -636,9 +659,13 @@ export interface components {
636
659
  transitionBy: string | null;
637
660
  };
638
661
  attribution: {
662
+ /** @description The user is an assignee of the issue. Independent of any PR/MR link. */
639
663
  isAssignee: boolean;
664
+ /** @description The user authored a commit inside a PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). Commits on a PR/MR that merely mentions the issue do NOT count. */
640
665
  hasOwnCommit: boolean;
666
+ /** @description The user authored a merged PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). A merged PR/MR that only says 'Related to <issue>' does NOT count — it links the two without delivering the issue. */
641
667
  isMergedPRAuthor: boolean;
668
+ /** @description First match wins: assigned > committer > pr_author > none. Only `resolves` links feed the committer/pr_author paths — `attributable` (which includes plain references) drives TIME imputation, not delivery. */
642
669
  result: "assigned" | "committer" | "pr_author" | "none";
643
670
  } | null;
644
671
  linkedActivities: {
@@ -723,6 +750,11 @@ export interface components {
723
750
  url: string | null;
724
751
  }[];
725
752
  } | null;
753
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
754
+ labels: {
755
+ name: string;
756
+ color: string | null;
757
+ }[];
726
758
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
727
759
  ci?: {
728
760
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -1399,6 +1431,11 @@ export interface components {
1399
1431
  url: string | null;
1400
1432
  }[];
1401
1433
  } | null;
1434
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
1435
+ labels: {
1436
+ name: string;
1437
+ color: string | null;
1438
+ }[];
1402
1439
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
1403
1440
  ci?: {
1404
1441
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -1665,6 +1702,11 @@ export interface components {
1665
1702
  url: string | null;
1666
1703
  }[];
1667
1704
  } | null;
1705
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
1706
+ labels: {
1707
+ name: string;
1708
+ color: string | null;
1709
+ }[];
1668
1710
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
1669
1711
  ci?: {
1670
1712
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -1838,6 +1880,11 @@ export interface components {
1838
1880
  url: string | null;
1839
1881
  }[];
1840
1882
  } | null;
1883
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
1884
+ labels: {
1885
+ name: string;
1886
+ color: string | null;
1887
+ }[];
1841
1888
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
1842
1889
  ci?: {
1843
1890
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -2064,6 +2111,11 @@ export interface operations {
2064
2111
  url: string | null;
2065
2112
  }[];
2066
2113
  } | null;
2114
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
2115
+ labels: {
2116
+ name: string;
2117
+ color: string | null;
2118
+ }[];
2067
2119
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
2068
2120
  ci?: {
2069
2121
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -2241,6 +2293,11 @@ export interface operations {
2241
2293
  url: string | null;
2242
2294
  }[];
2243
2295
  } | null;
2296
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
2297
+ labels: {
2298
+ name: string;
2299
+ color: string | null;
2300
+ }[];
2244
2301
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
2245
2302
  ci?: {
2246
2303
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -2418,6 +2475,11 @@ export interface operations {
2418
2475
  url: string | null;
2419
2476
  }[];
2420
2477
  } | null;
2478
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
2479
+ labels: {
2480
+ name: string;
2481
+ color: string | null;
2482
+ }[];
2421
2483
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
2422
2484
  ci?: {
2423
2485
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -2651,6 +2713,11 @@ export interface operations {
2651
2713
  url: string | null;
2652
2714
  }[];
2653
2715
  } | null;
2716
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
2717
+ labels: {
2718
+ name: string;
2719
+ color: string | null;
2720
+ }[];
2654
2721
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
2655
2722
  ci?: {
2656
2723
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -2823,6 +2890,11 @@ export interface operations {
2823
2890
  url: string | null;
2824
2891
  }[];
2825
2892
  } | null;
2893
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
2894
+ labels: {
2895
+ name: string;
2896
+ color: string | null;
2897
+ }[];
2826
2898
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
2827
2899
  ci?: {
2828
2900
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -2995,6 +3067,11 @@ export interface operations {
2995
3067
  url: string | null;
2996
3068
  }[];
2997
3069
  } | null;
3070
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
3071
+ labels: {
3072
+ name: string;
3073
+ color: string | null;
3074
+ }[];
2998
3075
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
2999
3076
  ci?: {
3000
3077
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -3875,6 +3952,11 @@ export interface operations {
3875
3952
  reviewRequestedAt: string | null;
3876
3953
  /** @description Review lifecycle bucket, or null for issues — an issue is not under review, so no bucket applies. Pass ?viewer to split 'open-awaiting-my-review' from 'open-awaiting-other-review'; without it, a pending review always reads as 'open-awaiting-other-review'. */
3877
3954
  reviewStatus: ("draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed") | null;
3955
+ /** @description Provider labels on the PR/MR/issue itself. Same semantic as WorkItem.labels: raw provider form (`d73a4a` on GitHub, `#428BCA` on GitLab), `color` null when the provider only gave a name (GitLab returns bare strings without label details), and scoped names like `priority::high` are NOT split. Empty array when unlabelled — never absent. */
3956
+ labels: {
3957
+ name: string;
3958
+ color: string | null;
3959
+ }[];
3878
3960
  authorIdentity?: {
3879
3961
  id: string | number;
3880
3962
  displayName: string;
@@ -3919,6 +4001,11 @@ export interface operations {
3919
4001
  reviewRequestedAt: string | null;
3920
4002
  /** @description Review lifecycle bucket, or null for issues — an issue is not under review, so no bucket applies. Pass ?viewer to split 'open-awaiting-my-review' from 'open-awaiting-other-review'; without it, a pending review always reads as 'open-awaiting-other-review'. */
3921
4003
  reviewStatus: ("draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed") | null;
4004
+ /** @description Provider labels on the PR/MR/issue itself. Same semantic as WorkItem.labels: raw provider form (`d73a4a` on GitHub, `#428BCA` on GitLab), `color` null when the provider only gave a name (GitLab returns bare strings without label details), and scoped names like `priority::high` are NOT split. Empty array when unlabelled — never absent. */
4005
+ labels: {
4006
+ name: string;
4007
+ color: string | null;
4008
+ }[];
3922
4009
  authorIdentity?: {
3923
4010
  id: string | number;
3924
4011
  displayName: string;
@@ -3963,6 +4050,11 @@ export interface operations {
3963
4050
  reviewRequestedAt: string | null;
3964
4051
  /** @description Review lifecycle bucket, or null for issues — an issue is not under review, so no bucket applies. Pass ?viewer to split 'open-awaiting-my-review' from 'open-awaiting-other-review'; without it, a pending review always reads as 'open-awaiting-other-review'. */
3965
4052
  reviewStatus: ("draft" | "open-no-review" | "open-awaiting-my-review" | "open-awaiting-other-review" | "open-changes-requested" | "open-approved" | "merged" | "closed") | null;
4053
+ /** @description Provider labels on the PR/MR/issue itself. Same semantic as WorkItem.labels: raw provider form (`d73a4a` on GitHub, `#428BCA` on GitLab), `color` null when the provider only gave a name (GitLab returns bare strings without label details), and scoped names like `priority::high` are NOT split. Empty array when unlabelled — never absent. */
4054
+ labels: {
4055
+ name: string;
4056
+ color: string | null;
4057
+ }[];
3966
4058
  authorIdentity?: {
3967
4059
  id: string | number;
3968
4060
  displayName: string;
@@ -4063,9 +4155,13 @@ export interface operations {
4063
4155
  transitionBy: string | null;
4064
4156
  };
4065
4157
  attribution: {
4158
+ /** @description The user is an assignee of the issue. Independent of any PR/MR link. */
4066
4159
  isAssignee: boolean;
4160
+ /** @description The user authored a commit inside a PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). Commits on a PR/MR that merely mentions the issue do NOT count. */
4067
4161
  hasOwnCommit: boolean;
4162
+ /** @description The user authored a merged PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). A merged PR/MR that only says 'Related to <issue>' does NOT count — it links the two without delivering the issue. */
4068
4163
  isMergedPRAuthor: boolean;
4164
+ /** @description First match wins: assigned > committer > pr_author > none. Only `resolves` links feed the committer/pr_author paths — `attributable` (which includes plain references) drives TIME imputation, not delivery. */
4069
4165
  result: "assigned" | "committer" | "pr_author" | "none";
4070
4166
  } | null;
4071
4167
  linkedActivities: {
@@ -4150,6 +4246,11 @@ export interface operations {
4150
4246
  url: string | null;
4151
4247
  }[];
4152
4248
  } | null;
4249
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
4250
+ labels: {
4251
+ name: string;
4252
+ color: string | null;
4253
+ }[];
4153
4254
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
4154
4255
  ci?: {
4155
4256
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -4269,9 +4370,13 @@ export interface operations {
4269
4370
  transitionBy: string | null;
4270
4371
  };
4271
4372
  attribution: {
4373
+ /** @description The user is an assignee of the issue. Independent of any PR/MR link. */
4272
4374
  isAssignee: boolean;
4375
+ /** @description The user authored a commit inside a PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). Commits on a PR/MR that merely mentions the issue do NOT count. */
4273
4376
  hasOwnCommit: boolean;
4377
+ /** @description The user authored a merged PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). A merged PR/MR that only says 'Related to <issue>' does NOT count — it links the two without delivering the issue. */
4274
4378
  isMergedPRAuthor: boolean;
4379
+ /** @description First match wins: assigned > committer > pr_author > none. Only `resolves` links feed the committer/pr_author paths — `attributable` (which includes plain references) drives TIME imputation, not delivery. */
4275
4380
  result: "assigned" | "committer" | "pr_author" | "none";
4276
4381
  } | null;
4277
4382
  linkedActivities: {
@@ -4356,6 +4461,11 @@ export interface operations {
4356
4461
  url: string | null;
4357
4462
  }[];
4358
4463
  } | null;
4464
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
4465
+ labels: {
4466
+ name: string;
4467
+ color: string | null;
4468
+ }[];
4359
4469
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
4360
4470
  ci?: {
4361
4471
  status: "success" | "failed" | "running" | "canceled" | "unknown";
@@ -4475,9 +4585,13 @@ export interface operations {
4475
4585
  transitionBy: string | null;
4476
4586
  };
4477
4587
  attribution: {
4588
+ /** @description The user is an assignee of the issue. Independent of any PR/MR link. */
4478
4589
  isAssignee: boolean;
4590
+ /** @description The user authored a commit inside a PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). Commits on a PR/MR that merely mentions the issue do NOT count. */
4479
4591
  hasOwnCommit: boolean;
4592
+ /** @description The user authored a merged PR/MR that CLOSES this issue (`linkedActivities[].resolves === true`). A merged PR/MR that only says 'Related to <issue>' does NOT count — it links the two without delivering the issue. */
4480
4593
  isMergedPRAuthor: boolean;
4594
+ /** @description First match wins: assigned > committer > pr_author > none. Only `resolves` links feed the committer/pr_author paths — `attributable` (which includes plain references) drives TIME imputation, not delivery. */
4481
4595
  result: "assigned" | "committer" | "pr_author" | "none";
4482
4596
  } | null;
4483
4597
  linkedActivities: {
@@ -4562,6 +4676,11 @@ export interface operations {
4562
4676
  url: string | null;
4563
4677
  }[];
4564
4678
  } | null;
4679
+ /** @description Provider labels on the linked PR/MR. Same field and semantic as Activity.labels, so a PR/MR carries its labels whether or not it is rendered under an issue. */
4680
+ labels: {
4681
+ name: string;
4682
+ color: string | null;
4683
+ }[];
4565
4684
  /** @description Latest known CI pipeline for this PR/MR — derived from `ci-pipeline` events, NOT from per-job `ci-run`. Null when no pipeline is known: never read a null as 'green'. `status: 'failed'` is the CI half of a blocked signal, alongside hasConflicts, reviews and unresolvedThreads. */
4566
4685
  ci?: {
4567
4686
  status: "success" | "failed" | "running" | "canceled" | "unknown";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cesar-richard/git-connector-sdk",
3
- "version": "2.8.0",
3
+ "version": "2.10.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": {