@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.
@@ -1,5 +1,5 @@
1
1
  import type { Client, Options as Options2, TDataShape } from './client';
2
- import type { GetContributorData, GetContributorErrors, GetContributorResponses, GetMetadataData, GetMetadataResponses, GetProjectData, GetProjectDependsOnData, GetProjectDependsOnErrors, GetProjectDependsOnResponses, GetProjectErrors, GetProjectHasDependentsData, GetProjectHasDependentsErrors, GetProjectHasDependentsResponses, GetProjectReposData, GetProjectReposErrors, GetProjectReposResponses, GetProjectResponses, GetRepoData, GetRepoDependsOnData, GetRepoDependsOnErrors, GetRepoDependsOnResponses, GetRepoErrors, GetRepoHasDependentsData, GetRepoHasDependentsErrors, GetRepoHasDependentsResponses, GetRepoResponses, GetSbomSubmissionData, GetSbomSubmissionErrors, GetSbomSubmissionResponses, HealthData, HealthResponses, IngestSbomData, IngestSbomErrors, IngestSbomResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponses, ListReposData, ListReposErrors, ListReposResponses, ListSbomSubmissionsData, ListSbomSubmissionsErrors, ListSbomSubmissionsResponses } from './types.gen';
2
+ import type { GetContributorData, GetContributorErrors, GetContributorResponses, GetGitlogArtifactData, GetGitlogArtifactErrors, GetGitlogArtifactResponses, GetMetadataData, GetMetadataResponses, GetProjectContributorsData, GetProjectContributorsErrors, GetProjectContributorsResponses, GetProjectData, GetProjectDependsOnData, GetProjectDependsOnErrors, GetProjectDependsOnResponses, GetProjectErrors, GetProjectHasDependentsData, GetProjectHasDependentsErrors, GetProjectHasDependentsResponses, GetProjectReposData, GetProjectReposErrors, GetProjectReposResponses, GetProjectResponses, GetRepoContributorsData, GetRepoContributorsErrors, GetRepoContributorsResponses, GetRepoData, GetRepoDependsOnData, GetRepoDependsOnErrors, GetRepoDependsOnResponses, GetRepoErrors, GetRepoHasDependentsData, GetRepoHasDependentsErrors, GetRepoHasDependentsResponses, GetRepoResponses, GetSbomSubmissionData, GetSbomSubmissionErrors, GetSbomSubmissionResponses, HealthData, HealthResponses, IngestSbomData, IngestSbomErrors, IngestSbomResponses, ListContributorsData, ListContributorsErrors, ListContributorsResponses, ListGitlogArtifactsData, ListGitlogArtifactsErrors, ListGitlogArtifactsResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponses, ListReposData, ListReposErrors, ListReposResponses, ListSbomSubmissionsData, ListSbomSubmissionsErrors, ListSbomSubmissionsResponses } from './types.gen';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -14,13 +14,9 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
14
14
  meta?: Record<string, unknown>;
15
15
  };
16
16
  /**
17
- * Liveness check
17
+ * Readiness check
18
18
  *
19
- * Return the current health status and application version.
20
- *
21
- * This endpoint is intentionally dependency-free (no DB call) so that it
22
- * remains responsive even when the database is unreachable. A richer check
23
- * with named component statuses (db, graph) will be added in A2.
19
+ * Return the current readiness status and application version.
24
20
  */
25
21
  export declare const health: <ThrowOnError extends boolean = false>(options?: Options<HealthData, ThrowOnError>) => import("./client").RequestResult<HealthResponses, unknown, ThrowOnError, "fields">;
26
22
  /**
@@ -53,12 +49,14 @@ export declare const getMetadata: <ThrowOnError extends boolean = false>(options
53
49
  /**
54
50
  * List projects
55
51
  *
56
- * Paginated list of SCF-funded projects with optional filters.
52
+ * Paginated list of SCF-funded projects with optional filters and sorting.
57
53
  *
58
54
  * - **project_type**: filter by `public-good` or `scf-project`.
59
55
  * - **activity_status**: filter by lifecycle status (`live`, `in-dev`, etc.).
60
56
  * - **search**: case-insensitive substring match on `display_name`.
61
- * - Results are ordered by `canonical_id` for deterministic pagination.
57
+ * - **sort**: comma-separated `field:direction` pairs for server-side ordering.
58
+ * - **category**: filter by exact project category string.
59
+ * - Default order is `canonical_id` for deterministic pagination.
62
60
  */
63
61
  export declare const listProjects: <ThrowOnError extends boolean = false>(options?: Options<ListProjectsData, ThrowOnError>) => import("./client").RequestResult<ListProjectsResponses, ListProjectsErrors, ThrowOnError, "fields">;
64
62
  /**
@@ -78,6 +76,12 @@ export declare const getProject: <ThrowOnError extends boolean = false>(options:
78
76
  * Returns 404 if the project does not exist.
79
77
  */
80
78
  export declare const getProjectRepos: <ThrowOnError extends boolean = false>(options: Options<GetProjectReposData, ThrowOnError>) => import("./client").RequestResult<GetProjectReposResponses, GetProjectReposErrors, ThrowOnError, "fields">;
79
+ /**
80
+ * Contributors across a project's repos
81
+ *
82
+ * Paginated contributors aggregated across all repos belonging to the project.
83
+ */
84
+ export declare const getProjectContributors: <ThrowOnError extends boolean = false>(options: Options<GetProjectContributorsData, ThrowOnError>) => import("./client").RequestResult<GetProjectContributorsResponses, GetProjectContributorsErrors, ThrowOnError, "fields">;
81
85
  /**
82
86
  * Project-level dependencies
83
87
  *
@@ -101,11 +105,12 @@ export declare const getProjectHasDependents: <ThrowOnError extends boolean = fa
101
105
  /**
102
106
  * List repos
103
107
  *
104
- * Paginated list of in-ecosystem repos with optional filters.
108
+ * Paginated list of in-ecosystem repos with optional filters and sorting.
105
109
  *
106
110
  * - **project_id**: filter to repos belonging to a specific project.
107
111
  * - **search**: case-insensitive substring match on `display_name`.
108
- * - Results are ordered by `canonical_id` for deterministic pagination.
112
+ * - **sort**: comma-separated `field:direction` pairs for server-side ordering.
113
+ * - Default order is `canonical_id` for deterministic pagination.
109
114
  */
110
115
  export declare const listRepos: <ThrowOnError extends boolean = false>(options?: Options<ListReposData, ThrowOnError>) => import("./client").RequestResult<ListReposResponses, ListReposErrors, ThrowOnError, "fields">;
111
116
  /**
@@ -126,6 +131,12 @@ export declare const getRepoDependsOn: <ThrowOnError extends boolean = false>(op
126
131
  * type, version range, and confidence level.
127
132
  */
128
133
  export declare const getRepoHasDependents: <ThrowOnError extends boolean = false>(options: Options<GetRepoHasDependentsData, ThrowOnError>) => import("./client").RequestResult<GetRepoHasDependentsResponses, GetRepoHasDependentsErrors, ThrowOnError, "fields">;
134
+ /**
135
+ * Contributors for a repo
136
+ *
137
+ * Paginated contributors for one repo with commit-count and commit-date spans.
138
+ */
139
+ export declare const getRepoContributors: <ThrowOnError extends boolean = false>(options: Options<GetRepoContributorsData, ThrowOnError>) => import("./client").RequestResult<GetRepoContributorsResponses, GetRepoContributorsErrors, ThrowOnError, "fields">;
129
140
  /**
130
141
  * Repo detail
131
142
  *
@@ -133,6 +144,12 @@ export declare const getRepoHasDependents: <ThrowOnError extends boolean = false
133
144
  * releases, and dependency counts.
134
145
  */
135
146
  export declare const getRepo: <ThrowOnError extends boolean = false>(options: Options<GetRepoData, ThrowOnError>) => import("./client").RequestResult<GetRepoResponses, GetRepoErrors, ThrowOnError, "fields">;
147
+ /**
148
+ * List contributors
149
+ *
150
+ * Paginated contributor list with optional case-insensitive name filtering.
151
+ */
152
+ export declare const listContributors: <ThrowOnError extends boolean = false>(options?: Options<ListContributorsData, ThrowOnError>) => import("./client").RequestResult<ListContributorsResponses, ListContributorsErrors, ThrowOnError, "fields">;
136
153
  /**
137
154
  * Contributor detail
138
155
  *
@@ -144,3 +161,15 @@ export declare const getRepo: <ThrowOnError extends boolean = false>(options: Op
144
161
  * commit dates across all repos.
145
162
  */
146
163
  export declare const getContributor: <ThrowOnError extends boolean = false>(options: Options<GetContributorData, ThrowOnError>) => import("./client").RequestResult<GetContributorResponses, GetContributorErrors, ThrowOnError, "fields">;
164
+ /**
165
+ * List gitlog processing attempts
166
+ *
167
+ * Paginated list of gitlog processing attempts with optional repo filter.
168
+ */
169
+ export declare const listGitlogArtifacts: <ThrowOnError extends boolean = false>(options?: Options<ListGitlogArtifactsData, ThrowOnError>) => import("./client").RequestResult<ListGitlogArtifactsResponses, ListGitlogArtifactsErrors, ThrowOnError, "fields">;
170
+ /**
171
+ * Get gitlog processing attempt detail
172
+ *
173
+ * Return one gitlog attempt record with its raw artifact content when available.
174
+ */
175
+ export declare const getGitlogArtifact: <ThrowOnError extends boolean = false>(options: Options<GetGitlogArtifactData, ThrowOnError>) => import("./client").RequestResult<GetGitlogArtifactResponses, GetGitlogArtifactErrors, ThrowOnError, "fields">;
@@ -1,13 +1,9 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
  import { client } from './client.gen';
3
3
  /**
4
- * Liveness check
4
+ * Readiness check
5
5
  *
6
- * Return the current health status and application version.
7
- *
8
- * This endpoint is intentionally dependency-free (no DB call) so that it
9
- * remains responsive even when the database is unreachable. A richer check
10
- * with named component statuses (db, graph) will be added in A2.
6
+ * Return the current readiness status and application version.
11
7
  */
12
8
  export const health = (options) => (options?.client ?? client).get({ url: '/health', ...options });
13
9
  /**
@@ -40,12 +36,14 @@ export const getMetadata = (options) => (options?.client ?? client).get({ url: '
40
36
  /**
41
37
  * List projects
42
38
  *
43
- * Paginated list of SCF-funded projects with optional filters.
39
+ * Paginated list of SCF-funded projects with optional filters and sorting.
44
40
  *
45
41
  * - **project_type**: filter by `public-good` or `scf-project`.
46
42
  * - **activity_status**: filter by lifecycle status (`live`, `in-dev`, etc.).
47
43
  * - **search**: case-insensitive substring match on `display_name`.
48
- * - Results are ordered by `canonical_id` for deterministic pagination.
44
+ * - **sort**: comma-separated `field:direction` pairs for server-side ordering.
45
+ * - **category**: filter by exact project category string.
46
+ * - Default order is `canonical_id` for deterministic pagination.
49
47
  */
50
48
  export const listProjects = (options) => (options?.client ?? client).get({ url: '/projects', ...options });
51
49
  /**
@@ -65,6 +63,12 @@ export const getProject = (options) => (options.client ?? client).get({ url: '/p
65
63
  * Returns 404 if the project does not exist.
66
64
  */
67
65
  export const getProjectRepos = (options) => (options.client ?? client).get({ url: '/projects/{canonical_id}/repos', ...options });
66
+ /**
67
+ * Contributors across a project's repos
68
+ *
69
+ * Paginated contributors aggregated across all repos belonging to the project.
70
+ */
71
+ export const getProjectContributors = (options) => (options.client ?? client).get({ url: '/projects/{canonical_id}/contributors', ...options });
68
72
  /**
69
73
  * Project-level dependencies
70
74
  *
@@ -88,11 +92,12 @@ export const getProjectHasDependents = (options) => (options.client ?? client).g
88
92
  /**
89
93
  * List repos
90
94
  *
91
- * Paginated list of in-ecosystem repos with optional filters.
95
+ * Paginated list of in-ecosystem repos with optional filters and sorting.
92
96
  *
93
97
  * - **project_id**: filter to repos belonging to a specific project.
94
98
  * - **search**: case-insensitive substring match on `display_name`.
95
- * - Results are ordered by `canonical_id` for deterministic pagination.
99
+ * - **sort**: comma-separated `field:direction` pairs for server-side ordering.
100
+ * - Default order is `canonical_id` for deterministic pagination.
96
101
  */
97
102
  export const listRepos = (options) => (options?.client ?? client).get({ url: '/repos', ...options });
98
103
  /**
@@ -113,6 +118,12 @@ export const getRepoDependsOn = (options) => (options.client ?? client).get({ ur
113
118
  * type, version range, and confidence level.
114
119
  */
115
120
  export const getRepoHasDependents = (options) => (options.client ?? client).get({ url: '/repos/{canonical_id}/has-dependents', ...options });
121
+ /**
122
+ * Contributors for a repo
123
+ *
124
+ * Paginated contributors for one repo with commit-count and commit-date spans.
125
+ */
126
+ export const getRepoContributors = (options) => (options.client ?? client).get({ url: '/repos/{canonical_id}/contributors', ...options });
116
127
  /**
117
128
  * Repo detail
118
129
  *
@@ -120,6 +131,12 @@ export const getRepoHasDependents = (options) => (options.client ?? client).get(
120
131
  * releases, and dependency counts.
121
132
  */
122
133
  export const getRepo = (options) => (options.client ?? client).get({ url: '/repos/{canonical_id}', ...options });
134
+ /**
135
+ * List contributors
136
+ *
137
+ * Paginated contributor list with optional case-insensitive name filtering.
138
+ */
139
+ export const listContributors = (options) => (options?.client ?? client).get({ url: '/contributors', ...options });
123
140
  /**
124
141
  * Contributor detail
125
142
  *
@@ -131,3 +148,15 @@ export const getRepo = (options) => (options.client ?? client).get({ url: '/repo
131
148
  * commit dates across all repos.
132
149
  */
133
150
  export const getContributor = (options) => (options.client ?? client).get({ url: '/contributors/{contributor_id}', ...options });
151
+ /**
152
+ * List gitlog processing attempts
153
+ *
154
+ * Paginated list of gitlog processing attempts with optional repo filter.
155
+ */
156
+ export const listGitlogArtifacts = (options) => (options?.client ?? client).get({ url: '/gitlog', ...options });
157
+ /**
158
+ * Get gitlog processing attempt detail
159
+ *
160
+ * Return one gitlog attempt record with its raw artifact content when available.
161
+ */
162
+ export const getGitlogArtifact = (options) => (options.client ?? client).get({ url: '/gitlog/{artifact_id}', ...options });