@pg-atlas/data-sdk 0.4.1 → 0.6.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.
@@ -37,7 +37,7 @@ export type ValidationError = {
37
37
  /**
38
38
  * SubmissionStatus
39
39
  *
40
- * Processing state of an SbomSubmission record.
40
+ * Processing state of an artifact-linked audit record.
41
41
  */
42
42
  export type SubmissionStatus = 'pending' | 'processed' | 'failed';
43
43
  /**
@@ -257,8 +257,8 @@ export type RepoSummary = {
257
257
  /**
258
258
  * RepoDetailResponse
259
259
  *
260
- * Full repo detail with parent project, contributors, releases, and
261
- * dependency counts.
260
+ * Full repo detail with parent project, contributors, releases, dependency counts,
261
+ * and active contributor stats.
262
262
  */
263
263
  export type RepoDetailResponse = {
264
264
  /**
@@ -314,7 +314,9 @@ export type RepoDetailResponse = {
314
314
  * Releases
315
315
  */
316
316
  releases: Array<{
317
- [key: string]: unknown;
317
+ purl: string;
318
+ version: string;
319
+ release_date?: string;
318
320
  }> | null;
319
321
  parent_project: ProjectSummary | null;
320
322
  /**
@@ -323,6 +325,14 @@ export type RepoDetailResponse = {
323
325
  contributors: Array<ContributorSummary>;
324
326
  outgoing_dep_counts: DepCounts;
325
327
  incoming_dep_counts: DepCounts;
328
+ /**
329
+ * Active Contributors 30D
330
+ */
331
+ active_contributors_30d: number;
332
+ /**
333
+ * Active Contributors 90D
334
+ */
335
+ active_contributors_90d: number;
326
336
  };
327
337
  /**
328
338
  * DepCounts
@@ -448,6 +458,37 @@ export type RepoDependency = {
448
458
  * How firmly an edge was established.
449
459
  */
450
460
  export type EdgeConfidence = 'verified-sbom' | 'inferred-shadow';
461
+ /**
462
+ * RepoContributorSummary
463
+ *
464
+ * Contributor summary with commit counts for one repo.
465
+ */
466
+ export type RepoContributorSummary = {
467
+ /**
468
+ * Id
469
+ */
470
+ id: number;
471
+ /**
472
+ * Name
473
+ */
474
+ name: string;
475
+ /**
476
+ * Email Hash
477
+ */
478
+ email_hash: string;
479
+ /**
480
+ * Number Of Commits
481
+ */
482
+ number_of_commits: number;
483
+ /**
484
+ * First Commit Date
485
+ */
486
+ first_commit_date: string;
487
+ /**
488
+ * Last Commit Date
489
+ */
490
+ last_commit_date: string;
491
+ };
451
492
  /**
452
493
  * ProjectMetadata
453
494
  *
@@ -518,7 +559,7 @@ export type ProjectMetadata = {
518
559
  /**
519
560
  * ProjectDetailResponse
520
561
  *
521
- * Full project detail including validated metadata.
562
+ * Full project detail including contributor stats and metadata.
522
563
  *
523
564
  * ``metadata`` is the normalised form of the ``project_metadata`` JSONB column.
524
565
  */
@@ -561,6 +602,14 @@ export type ProjectDetailResponse = {
561
602
  * Project Id
562
603
  */
563
604
  project_id: number;
605
+ /**
606
+ * Active Contributors 30D
607
+ */
608
+ active_contributors_30d: number;
609
+ /**
610
+ * Active Contributors 90D
611
+ */
612
+ active_contributors_90d: number;
564
613
  metadata: ProjectMetadata;
565
614
  };
566
615
  /**
@@ -576,6 +625,29 @@ export type ProjectDependency = {
576
625
  */
577
626
  edge_count: number;
578
627
  };
628
+ /**
629
+ * ProjectContributorSummary
630
+ *
631
+ * Contributor summary aggregated across all repos in a project.
632
+ */
633
+ export type ProjectContributorSummary = {
634
+ /**
635
+ * Id
636
+ */
637
+ id: number;
638
+ /**
639
+ * Name
640
+ */
641
+ name: string;
642
+ /**
643
+ * Email Hash
644
+ */
645
+ email_hash: string;
646
+ /**
647
+ * Total Commits In Project
648
+ */
649
+ total_commits_in_project: number;
650
+ };
579
651
  /**
580
652
  * PaginatedResponse[RepoSummary]
581
653
  */
@@ -597,6 +669,27 @@ export type PaginatedResponseRepoSummary = {
597
669
  */
598
670
  offset: number;
599
671
  };
672
+ /**
673
+ * PaginatedResponse[RepoContributorSummary]
674
+ */
675
+ export type PaginatedResponseRepoContributorSummary = {
676
+ /**
677
+ * Items
678
+ */
679
+ items: Array<RepoContributorSummary>;
680
+ /**
681
+ * Total
682
+ */
683
+ total: number;
684
+ /**
685
+ * Limit
686
+ */
687
+ limit: number;
688
+ /**
689
+ * Offset
690
+ */
691
+ offset: number;
692
+ };
600
693
  /**
601
694
  * PaginatedResponse[ProjectSummary]
602
695
  */
@@ -618,6 +711,113 @@ export type PaginatedResponseProjectSummary = {
618
711
  */
619
712
  offset: number;
620
713
  };
714
+ /**
715
+ * PaginatedResponse[ProjectContributorSummary]
716
+ */
717
+ export type PaginatedResponseProjectContributorSummary = {
718
+ /**
719
+ * Items
720
+ */
721
+ items: Array<ProjectContributorSummary>;
722
+ /**
723
+ * Total
724
+ */
725
+ total: number;
726
+ /**
727
+ * Limit
728
+ */
729
+ limit: number;
730
+ /**
731
+ * Offset
732
+ */
733
+ offset: number;
734
+ };
735
+ /**
736
+ * PaginatedResponse[GitLogArtifactSummary]
737
+ */
738
+ export type PaginatedResponseGitLogArtifactSummary = {
739
+ /**
740
+ * Items
741
+ */
742
+ items: Array<GitLogArtifactSummary>;
743
+ /**
744
+ * Total
745
+ */
746
+ total: number;
747
+ /**
748
+ * Limit
749
+ */
750
+ limit: number;
751
+ /**
752
+ * Offset
753
+ */
754
+ offset: number;
755
+ };
756
+ /**
757
+ * GitLogArtifactSummary
758
+ *
759
+ * Compact gitlog artifact audit record for list endpoints.
760
+ */
761
+ export type GitLogArtifactSummary = {
762
+ /**
763
+ * Id
764
+ */
765
+ id: number;
766
+ /**
767
+ * Repo Id
768
+ */
769
+ repo_id: number;
770
+ /**
771
+ * Repo Canonical Id
772
+ */
773
+ repo_canonical_id: string;
774
+ /**
775
+ * Repo Display Name
776
+ */
777
+ repo_display_name: string;
778
+ /**
779
+ * Artifact Path
780
+ */
781
+ artifact_path: string | null;
782
+ status: SubmissionStatus;
783
+ /**
784
+ * Error Detail
785
+ */
786
+ error_detail: string | null;
787
+ /**
788
+ * Since Months
789
+ */
790
+ since_months: number;
791
+ /**
792
+ * Submitted At
793
+ */
794
+ submitted_at: string;
795
+ /**
796
+ * Processed At
797
+ */
798
+ processed_at: string | null;
799
+ };
800
+ /**
801
+ * PaginatedResponse[ContributorSummary]
802
+ */
803
+ export type PaginatedResponseContributorSummary = {
804
+ /**
805
+ * Items
806
+ */
807
+ items: Array<ContributorSummary>;
808
+ /**
809
+ * Total
810
+ */
811
+ total: number;
812
+ /**
813
+ * Limit
814
+ */
815
+ limit: number;
816
+ /**
817
+ * Offset
818
+ */
819
+ offset: number;
820
+ };
621
821
  /**
622
822
  * MetadataResponse
623
823
  *
@@ -636,6 +836,10 @@ export type MetadataResponse = {
636
836
  * Total Repos
637
837
  */
638
838
  total_repos: number;
839
+ /**
840
+ * Active Repos 90D
841
+ */
842
+ active_repos_90d: number;
639
843
  /**
640
844
  * Total External Repos
641
845
  */
@@ -648,6 +852,14 @@ export type MetadataResponse = {
648
852
  * Total Contributor Edges
649
853
  */
650
854
  total_contributor_edges: number;
855
+ /**
856
+ * Active Contributors 30D
857
+ */
858
+ active_contributors_30d: number;
859
+ /**
860
+ * Active Contributors 90D
861
+ */
862
+ active_contributors_90d: number;
651
863
  /**
652
864
  * Last Updated
653
865
  */
@@ -662,11 +874,31 @@ export type HealthResponse = {
662
874
  /**
663
875
  * Status
664
876
  */
665
- status: string;
877
+ status: 'live' | 'ready';
666
878
  /**
667
879
  * Version
668
880
  */
669
881
  version: string;
882
+ components: HealthComponents;
883
+ };
884
+ /**
885
+ * HealthComponents
886
+ *
887
+ * Component-level readiness details for GET /health.
888
+ */
889
+ export type HealthComponents = {
890
+ /**
891
+ * Artifact Store
892
+ */
893
+ artifact_store: 'local' | 'IPFS';
894
+ /**
895
+ * Database
896
+ */
897
+ database: 'ready' | 'not-configured';
898
+ /**
899
+ * Schema Version
900
+ */
901
+ schema_version: string | null;
670
902
  };
671
903
  /**
672
904
  * HTTPValidationError
@@ -677,6 +909,54 @@ export type HttpValidationError = {
677
909
  */
678
910
  detail?: Array<ValidationError>;
679
911
  };
912
+ /**
913
+ * GitLogArtifactDetailResponse
914
+ *
915
+ * Full gitlog artifact audit record including raw artifact content.
916
+ */
917
+ export type GitLogArtifactDetailResponse = {
918
+ /**
919
+ * Id
920
+ */
921
+ id: number;
922
+ /**
923
+ * Repo Id
924
+ */
925
+ repo_id: number;
926
+ /**
927
+ * Repo Canonical Id
928
+ */
929
+ repo_canonical_id: string;
930
+ /**
931
+ * Repo Display Name
932
+ */
933
+ repo_display_name: string;
934
+ /**
935
+ * Artifact Path
936
+ */
937
+ artifact_path: string | null;
938
+ status: SubmissionStatus;
939
+ /**
940
+ * Error Detail
941
+ */
942
+ error_detail: string | null;
943
+ /**
944
+ * Since Months
945
+ */
946
+ since_months: number;
947
+ /**
948
+ * Submitted At
949
+ */
950
+ submitted_at: string;
951
+ /**
952
+ * Processed At
953
+ */
954
+ processed_at: string | null;
955
+ /**
956
+ * Raw Artifact
957
+ */
958
+ raw_artifact?: string | null;
959
+ };
680
960
  /**
681
961
  * ContributorDetailResponse
682
962
  *
@@ -879,6 +1159,18 @@ export type ListProjectsData = {
879
1159
  * Search
880
1160
  */
881
1161
  search?: string | null;
1162
+ /**
1163
+ * Sort
1164
+ *
1165
+ * Comma-separated field:direction pairs, e.g. 'criticality_score:desc,display_name:asc'.
1166
+ */
1167
+ sort?: string | null;
1168
+ /**
1169
+ * Category
1170
+ *
1171
+ * Filter by project category (exact match).
1172
+ */
1173
+ category?: string | null;
882
1174
  /**
883
1175
  * Limit
884
1176
  *
@@ -971,6 +1263,48 @@ export type GetProjectReposResponses = {
971
1263
  200: PaginatedResponseRepoSummary;
972
1264
  };
973
1265
  export type GetProjectReposResponse = GetProjectReposResponses[keyof GetProjectReposResponses];
1266
+ export type GetProjectContributorsData = {
1267
+ body?: never;
1268
+ path: {
1269
+ /**
1270
+ * Canonical Id
1271
+ */
1272
+ canonical_id: string;
1273
+ };
1274
+ query?: {
1275
+ /**
1276
+ * Search
1277
+ */
1278
+ search?: string | null;
1279
+ /**
1280
+ * Limit
1281
+ *
1282
+ * Maximum number of items to return
1283
+ */
1284
+ limit?: number;
1285
+ /**
1286
+ * Offset
1287
+ *
1288
+ * Number of items to skip
1289
+ */
1290
+ offset?: number;
1291
+ };
1292
+ url: '/projects/{canonical_id}/contributors';
1293
+ };
1294
+ export type GetProjectContributorsErrors = {
1295
+ /**
1296
+ * Validation Error
1297
+ */
1298
+ 422: HttpValidationError;
1299
+ };
1300
+ export type GetProjectContributorsError = GetProjectContributorsErrors[keyof GetProjectContributorsErrors];
1301
+ export type GetProjectContributorsResponses = {
1302
+ /**
1303
+ * Successful Response
1304
+ */
1305
+ 200: PaginatedResponseProjectContributorSummary;
1306
+ };
1307
+ export type GetProjectContributorsResponse = GetProjectContributorsResponses[keyof GetProjectContributorsResponses];
974
1308
  export type GetProjectDependsOnData = {
975
1309
  body?: never;
976
1310
  path: {
@@ -1037,6 +1371,12 @@ export type ListReposData = {
1037
1371
  * Search
1038
1372
  */
1039
1373
  search?: string | null;
1374
+ /**
1375
+ * Sort
1376
+ *
1377
+ * Comma-separated field:direction pairs, e.g. 'adoption_stars:desc,display_name:asc'.
1378
+ */
1379
+ sort?: string | null;
1040
1380
  /**
1041
1381
  * Limit
1042
1382
  *
@@ -1120,6 +1460,48 @@ export type GetRepoHasDependentsResponses = {
1120
1460
  200: Array<RepoDependency>;
1121
1461
  };
1122
1462
  export type GetRepoHasDependentsResponse = GetRepoHasDependentsResponses[keyof GetRepoHasDependentsResponses];
1463
+ export type GetRepoContributorsData = {
1464
+ body?: never;
1465
+ path: {
1466
+ /**
1467
+ * Canonical Id
1468
+ */
1469
+ canonical_id: string;
1470
+ };
1471
+ query?: {
1472
+ /**
1473
+ * Search
1474
+ */
1475
+ search?: string | null;
1476
+ /**
1477
+ * Limit
1478
+ *
1479
+ * Maximum number of items to return
1480
+ */
1481
+ limit?: number;
1482
+ /**
1483
+ * Offset
1484
+ *
1485
+ * Number of items to skip
1486
+ */
1487
+ offset?: number;
1488
+ };
1489
+ url: '/repos/{canonical_id}/contributors';
1490
+ };
1491
+ export type GetRepoContributorsErrors = {
1492
+ /**
1493
+ * Validation Error
1494
+ */
1495
+ 422: HttpValidationError;
1496
+ };
1497
+ export type GetRepoContributorsError = GetRepoContributorsErrors[keyof GetRepoContributorsErrors];
1498
+ export type GetRepoContributorsResponses = {
1499
+ /**
1500
+ * Successful Response
1501
+ */
1502
+ 200: PaginatedResponseRepoContributorSummary;
1503
+ };
1504
+ export type GetRepoContributorsResponse = GetRepoContributorsResponses[keyof GetRepoContributorsResponses];
1123
1505
  export type GetRepoData = {
1124
1506
  body?: never;
1125
1507
  path: {
@@ -1145,6 +1527,43 @@ export type GetRepoResponses = {
1145
1527
  200: RepoDetailResponse;
1146
1528
  };
1147
1529
  export type GetRepoResponse = GetRepoResponses[keyof GetRepoResponses];
1530
+ export type ListContributorsData = {
1531
+ body?: never;
1532
+ path?: never;
1533
+ query?: {
1534
+ /**
1535
+ * Search
1536
+ */
1537
+ search?: string | null;
1538
+ /**
1539
+ * Limit
1540
+ *
1541
+ * Maximum number of items to return
1542
+ */
1543
+ limit?: number;
1544
+ /**
1545
+ * Offset
1546
+ *
1547
+ * Number of items to skip
1548
+ */
1549
+ offset?: number;
1550
+ };
1551
+ url: '/contributors';
1552
+ };
1553
+ export type ListContributorsErrors = {
1554
+ /**
1555
+ * Validation Error
1556
+ */
1557
+ 422: HttpValidationError;
1558
+ };
1559
+ export type ListContributorsError = ListContributorsErrors[keyof ListContributorsErrors];
1560
+ export type ListContributorsResponses = {
1561
+ /**
1562
+ * Successful Response
1563
+ */
1564
+ 200: PaginatedResponseContributorSummary;
1565
+ };
1566
+ export type ListContributorsResponse = ListContributorsResponses[keyof ListContributorsResponses];
1148
1567
  export type GetContributorData = {
1149
1568
  body?: never;
1150
1569
  path: {
@@ -1170,3 +1589,67 @@ export type GetContributorResponses = {
1170
1589
  200: ContributorDetailResponse;
1171
1590
  };
1172
1591
  export type GetContributorResponse = GetContributorResponses[keyof GetContributorResponses];
1592
+ export type ListGitlogArtifactsData = {
1593
+ body?: never;
1594
+ path?: never;
1595
+ query?: {
1596
+ /**
1597
+ * Repo
1598
+ *
1599
+ * Filter by repo canonical_id (exact match)
1600
+ */
1601
+ repo?: string | null;
1602
+ /**
1603
+ * Limit
1604
+ *
1605
+ * Maximum number of items to return
1606
+ */
1607
+ limit?: number;
1608
+ /**
1609
+ * Offset
1610
+ *
1611
+ * Number of items to skip
1612
+ */
1613
+ offset?: number;
1614
+ };
1615
+ url: '/gitlog';
1616
+ };
1617
+ export type ListGitlogArtifactsErrors = {
1618
+ /**
1619
+ * Validation Error
1620
+ */
1621
+ 422: HttpValidationError;
1622
+ };
1623
+ export type ListGitlogArtifactsError = ListGitlogArtifactsErrors[keyof ListGitlogArtifactsErrors];
1624
+ export type ListGitlogArtifactsResponses = {
1625
+ /**
1626
+ * Successful Response
1627
+ */
1628
+ 200: PaginatedResponseGitLogArtifactSummary;
1629
+ };
1630
+ export type ListGitlogArtifactsResponse = ListGitlogArtifactsResponses[keyof ListGitlogArtifactsResponses];
1631
+ export type GetGitlogArtifactData = {
1632
+ body?: never;
1633
+ path: {
1634
+ /**
1635
+ * Artifact Id
1636
+ */
1637
+ artifact_id: number;
1638
+ };
1639
+ query?: never;
1640
+ url: '/gitlog/{artifact_id}';
1641
+ };
1642
+ export type GetGitlogArtifactErrors = {
1643
+ /**
1644
+ * Validation Error
1645
+ */
1646
+ 422: HttpValidationError;
1647
+ };
1648
+ export type GetGitlogArtifactError = GetGitlogArtifactErrors[keyof GetGitlogArtifactErrors];
1649
+ export type GetGitlogArtifactResponses = {
1650
+ /**
1651
+ * Successful Response
1652
+ */
1653
+ 200: GitLogArtifactDetailResponse;
1654
+ };
1655
+ export type GetGitlogArtifactResponse = GetGitlogArtifactResponses[keyof GetGitlogArtifactResponses];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pg-atlas/data-sdk",
3
- "version": "0.4.1",
3
+ "version": "0.6.0",
4
4
  "description": "TypeScript SDK for the PG Atlas API",
5
5
  "keywords": [
6
6
  "stellar",