@pg-atlas/data-sdk 0.4.0

package/dist/generated/sdk.gen.d.ts

@@ -0,0 +1,146 @@
+import type { Client, Options as Options2, TDataShape } from './client';
+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';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+/**
+ * Liveness check
+ *
+ * Return the current health status and application version.
+ *
+ * This endpoint is intentionally dependency-free (no DB call) so that it
+ * remains responsive even when the database is unreachable. A richer check
+ * with named component statuses (db, graph) will be added in A2.
+ */
+export declare const health: <ThrowOnError extends boolean = false>(options?: Options<HealthData, ThrowOnError>) => import("./client").RequestResult<HealthResponses, unknown, ThrowOnError, "fields">;
+/**
+ * List SBOM submissions
+ *
+ * Returns a paginated list of SBOM submission records.  Supports optional filtering by ``repository`` claim and pagination via ``limit`` / ``offset`` query parameters.  Does not require authentication.
+ */
+export declare const listSbomSubmissions: <ThrowOnError extends boolean = false>(options?: Options<ListSbomSubmissionsData, ThrowOnError>) => import("./client").RequestResult<ListSbomSubmissionsResponses, ListSbomSubmissionsErrors, ThrowOnError, "fields">;
+/**
+ * Submit an SPDX 2.3 SBOM
+ *
+ * Accepts an SPDX 2.3 JSON SBOM document from the pg-atlas-sbom-action. Requires a valid GitHub OIDC Bearer token with `aud` set to the PG Atlas API URL. The submitting repository is identified from the token's `repository` claim — no additional configuration is required in the calling repo beyond `permissions: id-token: write`.
+ */
+export declare const ingestSbom: <ThrowOnError extends boolean = false>(options?: Options<IngestSbomData, ThrowOnError>) => import("./client").RequestResult<IngestSbomResponses, IngestSbomErrors, ThrowOnError, "fields">;
+/**
+ * Get SBOM submission detail
+ *
+ * Returns a single SBOM submission record along with the raw artifact content read from the backing store.  If the artifact file is missing, the ``raw_artifact`` field is ``null``.  Does not require authentication.
+ */
+export declare const getSbomSubmission: <ThrowOnError extends boolean = false>(options: Options<GetSbomSubmissionData, ThrowOnError>) => import("./client").RequestResult<GetSbomSubmissionResponses, GetSbomSubmissionErrors, ThrowOnError, "fields">;
+/**
+ * Ecosystem summary statistics
+ *
+ * Return aggregate counts across all graph entities.
+ *
+ * Counts are computed on-the-fly via simple ``COUNT(*)`` queries.  No
+ * caching is applied in this dev version — queries hit the DB directly.
+ */
+export declare const getMetadata: <ThrowOnError extends boolean = false>(options?: Options<GetMetadataData, ThrowOnError>) => import("./client").RequestResult<GetMetadataResponses, unknown, ThrowOnError, "fields">;
+/**
+ * List projects
+ *
+ * Paginated list of SCF-funded projects with optional filters.
+ *
+ * - **project_type**: filter by `public-good` or `scf-project`.
+ * - **activity_status**: filter by lifecycle status (`live`, `in-dev`, etc.).
+ * - **search**: case-insensitive substring match on `display_name`.
+ * - Results are ordered by `canonical_id` for deterministic pagination.
+ */
+export declare const listProjects: <ThrowOnError extends boolean = false>(options?: Options<ListProjectsData, ThrowOnError>) => import("./client").RequestResult<ListProjectsResponses, ListProjectsErrors, ThrowOnError, "fields">;
+/**
+ * Project detail
+ *
+ * Full detail for a single project, including validated metadata.
+ *
+ * The ``metadata`` field is the normalised form of the raw JSONB column —
+ * unknown keys from the crawler are passed through via ``extra="allow"``.
+ */
+export declare const getProject: <ThrowOnError extends boolean = false>(options: Options<GetProjectData, ThrowOnError>) => import("./client").RequestResult<GetProjectResponses, GetProjectErrors, ThrowOnError, "fields">;
+/**
+ * Repos belonging to a project
+ *
+ * Paginated list of repos that belong to the given project.
+ *
+ * Returns 404 if the project does not exist.
+ */
+export declare const getProjectRepos: <ThrowOnError extends boolean = false>(options: Options<GetProjectReposData, ThrowOnError>) => import("./client").RequestResult<GetProjectReposResponses, GetProjectReposErrors, ThrowOnError, "fields">;
+/**
+ * Project-level dependencies
+ *
+ * Collapsed project-level dependencies.
+ *
+ * Aggregates repo-level ``depends_on`` edges: for each distinct target project,
+ * returns the target project summary and the number of repo-level edges between
+ * the two projects.  Self-references and edges to external repos (which have no
+ * project) are excluded.
+ */
+export declare const getProjectDependsOn: <ThrowOnError extends boolean = false>(options: Options<GetProjectDependsOnData, ThrowOnError>) => import("./client").RequestResult<GetProjectDependsOnResponses, GetProjectDependsOnErrors, ThrowOnError, "fields">;
+/**
+ * Projects that depend on this project
+ *
+ * Collapsed project-level reverse dependencies.
+ *
+ * Same aggregation as ``depends-on`` but in the reverse direction: which
+ * other projects have repos that depend on repos of *this* project.
+ */
+export declare const getProjectHasDependents: <ThrowOnError extends boolean = false>(options: Options<GetProjectHasDependentsData, ThrowOnError>) => import("./client").RequestResult<GetProjectHasDependentsResponses, GetProjectHasDependentsErrors, ThrowOnError, "fields">;
+/**
+ * List repos
+ *
+ * Paginated list of in-ecosystem repos with optional filters.
+ *
+ * - **project_id**: filter to repos belonging to a specific project.
+ * - **search**: case-insensitive substring match on `display_name`.
+ * - Results are ordered by `canonical_id` for deterministic pagination.
+ */
+export declare const listRepos: <ThrowOnError extends boolean = false>(options?: Options<ListReposData, ThrowOnError>) => import("./client").RequestResult<ListReposResponses, ListReposErrors, ThrowOnError, "fields">;
+/**
+ * Direct dependencies of a repo
+ *
+ * List of direct dependencies (outgoing edges) for a given repo.
+ *
+ * Each entry includes the target vertex's canonical ID, display name,
+ * type (``repo`` or ``external-repo``), version range, and confidence level.
+ */
+export declare const getRepoDependsOn: <ThrowOnError extends boolean = false>(options: Options<GetRepoDependsOnData, ThrowOnError>) => import("./client").RequestResult<GetRepoDependsOnResponses, GetRepoDependsOnErrors, ThrowOnError, "fields">;
+/**
+ * Repos that depend on this repo
+ *
+ * List of direct dependents (incoming edges) for a given repo.
+ *
+ * Each entry includes the source vertex's canonical ID, display name,
+ * type, version range, and confidence level.
+ */
+export declare const getRepoHasDependents: <ThrowOnError extends boolean = false>(options: Options<GetRepoHasDependentsData, ThrowOnError>) => import("./client").RequestResult<GetRepoHasDependentsResponses, GetRepoHasDependentsErrors, ThrowOnError, "fields">;
+/**
+ * Repo detail
+ *
+ * Full detail for a single repo including parent project, contributors,
+ * releases, and dependency counts.
+ */
+export declare const getRepo: <ThrowOnError extends boolean = false>(options: Options<GetRepoData, ThrowOnError>) => import("./client").RequestResult<GetRepoResponses, GetRepoErrors, ThrowOnError, "fields">;
+/**
+ * Contributor detail
+ *
+ * Full detail for a single contributor with aggregated statistics and
+ * per-repo commit activity.
+ *
+ * The ``total_commits`` field sums commits across all repos.
+ * ``first_contribution`` / ``last_contribution`` are the earliest and latest
+ * commit dates across all repos.
+ */
+export declare const getContributor: <ThrowOnError extends boolean = false>(options: Options<GetContributorData, ThrowOnError>) => import("./client").RequestResult<GetContributorResponses, GetContributorErrors, ThrowOnError, "fields">;

package/dist/generated/sdk.gen.js

@@ -0,0 +1,133 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { client } from './client.gen';
+/**
+ * Liveness check
+ *
+ * Return the current health status and application version.
+ *
+ * This endpoint is intentionally dependency-free (no DB call) so that it
+ * remains responsive even when the database is unreachable. A richer check
+ * with named component statuses (db, graph) will be added in A2.
+ */
+export const health = (options) => (options?.client ?? client).get({ url: '/health', ...options });
+/**
+ * List SBOM submissions
+ *
+ * Returns a paginated list of SBOM submission records.  Supports optional filtering by ``repository`` claim and pagination via ``limit`` / ``offset`` query parameters.  Does not require authentication.
+ */
+export const listSbomSubmissions = (options) => (options?.client ?? client).get({ url: '/ingest/sbom', ...options });
+/**
+ * Submit an SPDX 2.3 SBOM
+ *
+ * Accepts an SPDX 2.3 JSON SBOM document from the pg-atlas-sbom-action. Requires a valid GitHub OIDC Bearer token with `aud` set to the PG Atlas API URL. The submitting repository is identified from the token's `repository` claim — no additional configuration is required in the calling repo beyond `permissions: id-token: write`.
+ */
+export const ingestSbom = (options) => (options?.client ?? client).post({ url: '/ingest/sbom', ...options });
+/**
+ * Get SBOM submission detail
+ *
+ * Returns a single SBOM submission record along with the raw artifact content read from the backing store.  If the artifact file is missing, the ``raw_artifact`` field is ``null``.  Does not require authentication.
+ */
+export const getSbomSubmission = (options) => (options.client ?? client).get({ url: '/ingest/sbom/{submission_id}', ...options });
+/**
+ * Ecosystem summary statistics
+ *
+ * Return aggregate counts across all graph entities.
+ *
+ * Counts are computed on-the-fly via simple ``COUNT(*)`` queries.  No
+ * caching is applied in this dev version — queries hit the DB directly.
+ */
+export const getMetadata = (options) => (options?.client ?? client).get({ url: '/metadata', ...options });
+/**
+ * List projects
+ *
+ * Paginated list of SCF-funded projects with optional filters.
+ *
+ * - **project_type**: filter by `public-good` or `scf-project`.
+ * - **activity_status**: filter by lifecycle status (`live`, `in-dev`, etc.).
+ * - **search**: case-insensitive substring match on `display_name`.
+ * - Results are ordered by `canonical_id` for deterministic pagination.
+ */
+export const listProjects = (options) => (options?.client ?? client).get({ url: '/projects', ...options });
+/**
+ * Project detail
+ *
+ * Full detail for a single project, including validated metadata.
+ *
+ * The ``metadata`` field is the normalised form of the raw JSONB column —
+ * unknown keys from the crawler are passed through via ``extra="allow"``.
+ */
+export const getProject = (options) => (options.client ?? client).get({ url: '/projects/{canonical_id}', ...options });
+/**
+ * Repos belonging to a project
+ *
+ * Paginated list of repos that belong to the given project.
+ *
+ * Returns 404 if the project does not exist.
+ */
+export const getProjectRepos = (options) => (options.client ?? client).get({ url: '/projects/{canonical_id}/repos', ...options });
+/**
+ * Project-level dependencies
+ *
+ * Collapsed project-level dependencies.
+ *
+ * Aggregates repo-level ``depends_on`` edges: for each distinct target project,
+ * returns the target project summary and the number of repo-level edges between
+ * the two projects.  Self-references and edges to external repos (which have no
+ * project) are excluded.
+ */
+export const getProjectDependsOn = (options) => (options.client ?? client).get({ url: '/projects/{canonical_id}/depends-on', ...options });
+/**
+ * Projects that depend on this project
+ *
+ * Collapsed project-level reverse dependencies.
+ *
+ * Same aggregation as ``depends-on`` but in the reverse direction: which
+ * other projects have repos that depend on repos of *this* project.
+ */
+export const getProjectHasDependents = (options) => (options.client ?? client).get({ url: '/projects/{canonical_id}/has-dependents', ...options });
+/**
+ * List repos
+ *
+ * Paginated list of in-ecosystem repos with optional filters.
+ *
+ * - **project_id**: filter to repos belonging to a specific project.
+ * - **search**: case-insensitive substring match on `display_name`.
+ * - Results are ordered by `canonical_id` for deterministic pagination.
+ */
+export const listRepos = (options) => (options?.client ?? client).get({ url: '/repos', ...options });
+/**
+ * Direct dependencies of a repo
+ *
+ * List of direct dependencies (outgoing edges) for a given repo.
+ *
+ * Each entry includes the target vertex's canonical ID, display name,
+ * type (``repo`` or ``external-repo``), version range, and confidence level.
+ */
+export const getRepoDependsOn = (options) => (options.client ?? client).get({ url: '/repos/{canonical_id}/depends-on', ...options });
+/**
+ * Repos that depend on this repo
+ *
+ * List of direct dependents (incoming edges) for a given repo.
+ *
+ * Each entry includes the source vertex's canonical ID, display name,
+ * type, version range, and confidence level.
+ */
+export const getRepoHasDependents = (options) => (options.client ?? client).get({ url: '/repos/{canonical_id}/has-dependents', ...options });
+/**
+ * Repo detail
+ *
+ * Full detail for a single repo including parent project, contributors,
+ * releases, and dependency counts.
+ */
+export const getRepo = (options) => (options.client ?? client).get({ url: '/repos/{canonical_id}', ...options });
+/**
+ * Contributor detail
+ *
+ * Full detail for a single contributor with aggregated statistics and
+ * per-repo commit activity.
+ *
+ * The ``total_commits`` field sums commits across all repos.
+ * ``first_contribution`` / ``last_contribution`` are the earliest and latest
+ * commit dates across all repos.
+ */
+export const getContributor = (options) => (options.client ?? client).get({ url: '/contributors/{contributor_id}', ...options });