@usa-open-data-connectors/usa-sources 0.1.7 → 0.1.9

package/dist/fccSocrataCatalogue.d.ts

@@ -0,0 +1,91 @@
+import type { UsDataAdapter } from './types.js';
+/** Adapter id for the FCC Open Data catalogue source. */
+export declare const FCC_SOCRATA_CATALOGUE_SOURCE_ID = "fcc-socrata-catalogue";
+/** Base URL for the FCC Open Data Socrata catalogue. */
+export declare const FCC_SOCRATA_CATALOGUE_API_BASE = "https://opendata.fcc.gov/api/views.json";
+/** How many catalogue entries one request reads. */
+export declare const FCC_SOCRATA_CATALOGUE_LIMIT = 10;
+/** One catalogue entry from the FCC Socrata discovery API. */
+export interface FccSocrataCatalogueEntry {
+    /** Four-by-four Socrata dataset id, e.g. "jdr4-3q4p". */
+    id: string;
+    /** Human-readable title of the dataset, chart, story, or file. */
+    name: string;
+    /** What the entry is: "dataset", "chart", "story", "file", or "href". */
+    assetType: string;
+    /** Bureau or topic the entry belongs to, or null when the catalogue lists none. */
+    category: string | null;
+    /** How the entry is rendered, e.g. "tabular", "href", or "story". */
+    viewType: string;
+    /** When the entry was created, in seconds since the Unix epoch. */
+    createdAtEpochSeconds: number;
+    /** When the entry was last modified, in seconds since the Unix epoch. */
+    viewLastModifiedEpochSeconds: number;
+    /** How many times the entry has been viewed. */
+    viewCount: number;
+    /** How many times the entry has been downloaded. */
+    downloadCount: number;
+    /** Licence URL the portal attaches to the entry, or "" when it supplies none. */
+    licenceUrl: string;
+    /** Publishing organisation the portal attaches to the entry, or "" when it supplies none. */
+    attribution: string;
+}
+/** One category and how many catalogue entries carry it. */
+export interface FccSocrataCategoryCount {
+    category: string;
+    entryCount: number;
+}
+/** One page of the FCC catalogue, folded for a story. */
+export interface FccSocrataCatalogue {
+    /** One entry per catalogue item in the page. */
+    entries: FccSocrataCatalogueEntry[];
+    entryCount: number;
+    /** Entries whose asset type is "dataset". */
+    datasetCount: number;
+    /** Entry with the latest creation time. Ties go to the earlier list entry. */
+    newestEntry: FccSocrataCatalogueEntry;
+    /**
+     * Categories in the page, most entries first, ties broken by name. An entry
+     * the catalogue lists without a category is counted under "Uncategorised".
+     */
+    categories: FccSocrataCategoryCount[];
+}
+/**
+ * Builds the request URL for one page of the FCC catalogue.
+ *
+ * The endpoint is keyless. The service answers the whole catalogue by default,
+ * so the adapter asks for a short page.
+ *
+ * @param options - an optional entry cap
+ * @returns the full request URL
+ */
+export declare function buildFccSocrataCatalogueUrl(options?: {
+    limit?: number;
+}): string;
+/**
+ * Parses one page of the FCC catalogue into the entries and category counts.
+ *
+ * An entry without an id, a name, or a creation time is a changed shape and
+ * stops the parse. An empty page also stops the parse, because a catalogue
+ * with no entries is not a usable answer.
+ *
+ * @param payload - the JSON body from the FCC Socrata discovery API
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export declare function parseFccSocrataCataloguePayload(payload: unknown): FccSocrataCatalogue;
+/**
+ * Reads one page of the Federal Communications Commission catalogue.
+ *
+ * One keyless request covers the page and reports what the catalogue holds,
+ * without reading any dataset's rows.
+ *
+ * @param options - an optional entry cap and fetch stub
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export declare function fetchFccSocrataCatalogue(options?: {
+    limit?: number;
+    fetchImpl?: typeof globalThis.fetch;
+}): Promise<FccSocrataCatalogue>;
+/** Federal Communications Commission catalogue of datasets and stories, keyless. */
+export declare const fccSocrataCatalogueAdapter: UsDataAdapter<FccSocrataCatalogue>;
+//# sourceMappingURL=fccSocrataCatalogue.d.ts.map

package/dist/fccSocrataCatalogue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fccSocrataCatalogue.d.ts","sourceRoot":"","sources":["../src/fccSocrataCatalogue.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,yDAAyD;AACzD,eAAO,MAAM,+BAA+B,0BAA0B,CAAC;AAEvE,wDAAwD;AACxD,eAAO,MAAM,8BAA8B,4CAA4C,CAAC;AAExF,oDAAoD;AACpD,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C,8DAA8D;AAC9D,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAC;IAClB,mFAAmF;IACnF,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,qBAAqB,EAAE,MAAM,CAAC;IAC9B,yEAAyE;IACzE,4BAA4B,EAAE,MAAM,CAAC;IACrC,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,aAAa,EAAE,MAAM,CAAC;IACtB,iFAAiF;IACjF,UAAU,EAAE,MAAM,CAAC;IACnB,6FAA6F;IAC7F,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,4DAA4D;AAC5D,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yDAAyD;AACzD,MAAM,WAAW,mBAAmB;IAClC,gDAAgD;IAChD,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,8EAA8E;IAC9E,WAAW,EAAE,wBAAwB,CAAC;IACtC;;;OAGG;IACH,UAAU,EAAE,uBAAuB,EAAE,CAAC;CACvC;AAqDD;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAKhF;AAED;;;;;;;;;GASG;AACH,wBAAgB,+BAA+B,CAAC,OAAO,EAAE,OAAO,GAAG,mBAAmB,CAwCrF;AAED;;;;;;;;GAQG;AACH,wBAAsB,wBAAwB,CAAC,OAAO,CAAC,EAAE;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;CACrC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAO/B;AAED,oFAAoF;AACpF,eAAO,MAAM,0BAA0B,EAAE,aAAa,CAAC,mBAAmB,CAazE,CAAC"}

package/dist/fccSocrataCatalogue.js

@@ -0,0 +1,133 @@
+import { z } from 'zod';
+import { UsSourceParseError } from './errors.js';
+import { readFixtureJson } from './fixtures.js';
+import { httpGet } from './http.js';
+import { parseSocrataCatalogueMetadata } from './socrataCatalogueMetadata.js';
+/** Adapter id for the FCC Open Data catalogue source. */
+export const FCC_SOCRATA_CATALOGUE_SOURCE_ID = 'fcc-socrata-catalogue';
+/** Base URL for the FCC Open Data Socrata catalogue. */
+export const FCC_SOCRATA_CATALOGUE_API_BASE = 'https://opendata.fcc.gov/api/views.json';
+/** How many catalogue entries one request reads. */
+export const FCC_SOCRATA_CATALOGUE_LIMIT = 10;
+/** Committed snapshot, so a build works when the FCC host is unreachable. */
+const FCC_SOCRATA_CATALOGUE_FIXTURE_FILENAME = 'fcc-socrata-catalogue-2026-11-08.json';
+/** Category bucket the adapter uses for an entry the catalogue lists without one. */
+const FCC_SOCRATA_UNCATEGORISED = 'Uncategorised';
+// The discovery API sends a bare JSON array. A value the catalogue does not
+// carry arrives as null, and every count arrives as a number.
+const FCC_SOCRATA_ENTRY_SCHEMA = z.object({
+    id: z.string().optional(),
+    name: z.string().optional(),
+    assetType: z.string().optional(),
+    category: z.string().nullable().optional(),
+    viewType: z.string().optional(),
+    createdAt: z.number().optional(),
+    viewLastModified: z.number().optional(),
+    viewCount: z.number().optional(),
+    downloadCount: z.number().optional(),
+    metadata: z.unknown().optional(),
+});
+const FCC_SOCRATA_PAYLOAD_SCHEMA = z.array(FCC_SOCRATA_ENTRY_SCHEMA);
+/** Counts entries per category, most entries first, ties by name. */
+function countFccCatalogueCategories(entries) {
+    const counts = new Map();
+    for (const entry of entries) {
+        const category = entry.category ?? FCC_SOCRATA_UNCATEGORISED;
+        counts.set(category, (counts.get(category) ?? 0) + 1);
+    }
+    return [...counts.entries()]
+        .sort(([leftCategory, leftCount], [rightCategory, rightCount]) => leftCount === rightCount ? leftCategory.localeCompare(rightCategory) : rightCount - leftCount)
+        .map(([category, entryCount]) => ({ category, entryCount }));
+}
+/** Picks the entry with the latest creation time, ties to the earlier entry. */
+function newestFccCatalogueEntry(entries) {
+    const first = entries[0];
+    if (first === undefined) {
+        throw new UsSourceParseError(FCC_SOCRATA_CATALOGUE_SOURCE_ID, 'No entries to summarise');
+    }
+    return entries.reduce((best, entry) => (entry.createdAtEpochSeconds > best.createdAtEpochSeconds ? entry : best), first);
+}
+/**
+ * Builds the request URL for one page of the FCC catalogue.
+ *
+ * The endpoint is keyless. The service answers the whole catalogue by default,
+ * so the adapter asks for a short page.
+ *
+ * @param options - an optional entry cap
+ * @returns the full request URL
+ */
+export function buildFccSocrataCatalogueUrl(options) {
+    const params = new URLSearchParams({
+        limit: String(options?.limit ?? FCC_SOCRATA_CATALOGUE_LIMIT),
+    });
+    return `${FCC_SOCRATA_CATALOGUE_API_BASE}?${params.toString()}`;
+}
+/**
+ * Parses one page of the FCC catalogue into the entries and category counts.
+ *
+ * An entry without an id, a name, or a creation time is a changed shape and
+ * stops the parse. An empty page also stops the parse, because a catalogue
+ * with no entries is not a usable answer.
+ *
+ * @param payload - the JSON body from the FCC Socrata discovery API
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export function parseFccSocrataCataloguePayload(payload) {
+    const parsed = FCC_SOCRATA_PAYLOAD_SCHEMA.safeParse(payload);
+    if (!parsed.success) {
+        throw new UsSourceParseError(FCC_SOCRATA_CATALOGUE_SOURCE_ID, parsed.error.message);
+    }
+    if (parsed.data.length === 0) {
+        throw new UsSourceParseError(FCC_SOCRATA_CATALOGUE_SOURCE_ID, 'The response carried no entries');
+    }
+    const entries = parsed.data.map((row) => {
+        if (row.id === undefined || row.name === undefined || row.createdAt === undefined) {
+            throw new UsSourceParseError(FCC_SOCRATA_CATALOGUE_SOURCE_ID, 'A catalogue entry arrived without its id, name, or creation time');
+        }
+        return {
+            id: row.id,
+            name: row.name,
+            assetType: row.assetType ?? '',
+            category: row.category ?? null,
+            viewType: row.viewType ?? '',
+            createdAtEpochSeconds: row.createdAt,
+            viewLastModifiedEpochSeconds: row.viewLastModified ?? row.createdAt,
+            viewCount: row.viewCount ?? 0,
+            downloadCount: row.downloadCount ?? 0,
+            ...parseSocrataCatalogueMetadata(row.metadata),
+        };
+    });
+    return {
+        entries,
+        entryCount: entries.length,
+        datasetCount: entries.filter((entry) => entry.assetType === 'dataset').length,
+        newestEntry: newestFccCatalogueEntry(entries),
+        categories: countFccCatalogueCategories(entries),
+    };
+}
+/**
+ * Reads one page of the Federal Communications Commission catalogue.
+ *
+ * One keyless request covers the page and reports what the catalogue holds,
+ * without reading any dataset's rows.
+ *
+ * @param options - an optional entry cap and fetch stub
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export async function fetchFccSocrataCatalogue(options) {
+    const fetchImpl = options?.fetchImpl ?? globalThis.fetch;
+    const url = buildFccSocrataCatalogueUrl(options?.limit === undefined ? {} : { limit: options.limit });
+    const response = await httpGet(FCC_SOCRATA_CATALOGUE_SOURCE_ID, url, { fetchImpl });
+    return parseFccSocrataCataloguePayload(await response.json());
+}
+/** Federal Communications Commission catalogue of datasets and stories, keyless. */
+export const fccSocrataCatalogueAdapter = {
+    id: FCC_SOCRATA_CATALOGUE_SOURCE_ID,
+    name: 'FCC Open Data catalogue',
+    auth: 'none',
+    description: 'The Federal Communications Commission Socrata catalogue, one row per published dataset, chart, or story, with its category, view count, and download count.',
+    fetchLive: async (options) => fetchFccSocrataCatalogue(options?.fetchImpl === undefined ? {} : { fetchImpl: options.fetchImpl }),
+    parse: (payload) => parseFccSocrataCataloguePayload(payload),
+    loadFixture: () => parseFccSocrataCataloguePayload(readFixtureJson(FCC_SOCRATA_CATALOGUE_FIXTURE_FILENAME)),
+};
+//# sourceMappingURL=fccSocrataCatalogue.js.map

package/dist/fccSocrataCatalogue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fccSocrataCatalogue.js","sourceRoot":"","sources":["../src/fccSocrataCatalogue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,6BAA6B,EAAE,MAAM,+BAA+B,CAAC;AAG9E,yDAAyD;AACzD,MAAM,CAAC,MAAM,+BAA+B,GAAG,uBAAuB,CAAC;AAEvE,wDAAwD;AACxD,MAAM,CAAC,MAAM,8BAA8B,GAAG,yCAAyC,CAAC;AAExF,oDAAoD;AACpD,MAAM,CAAC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AAkD9C,6EAA6E;AAC7E,MAAM,sCAAsC,GAAG,uCAAuC,CAAC;AAEvF,qFAAqF;AACrF,MAAM,yBAAyB,GAAG,eAAe,CAAC;AAElD,4EAA4E;AAC5E,8DAA8D;AAC9D,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC1C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;AAErE,qEAAqE;AACrE,SAAS,2BAA2B,CAClC,OAAmC;IAEnC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,yBAAyB,CAAC;QAC7D,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;SACzB,IAAI,CAAC,CAAC,CAAC,YAAY,EAAE,SAAS,CAAC,EAAE,CAAC,aAAa,EAAE,UAAU,CAAC,EAAE,EAAE,CAC/D,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,SAAS,CAC9F;SACA,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,gFAAgF;AAChF,SAAS,uBAAuB,CAAC,OAAmC;IAClE,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,kBAAkB,CAAC,+BAA+B,EAAE,yBAAyB,CAAC,CAAC;IAC3F,CAAC;IACD,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAC1F,KAAK,CACN,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CAAC,OAA4B;IACtE,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;QACjC,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,IAAI,2BAA2B,CAAC;KAC7D,CAAC,CAAC;IACH,OAAO,GAAG,8BAA8B,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AAClE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,+BAA+B,CAAC,OAAgB;IAC9D,MAAM,MAAM,GAAG,0BAA0B,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7D,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,kBAAkB,CAAC,+BAA+B,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtF,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,kBAAkB,CAC1B,+BAA+B,EAC/B,iCAAiC,CAClC,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAA+B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAClE,IAAI,GAAG,CAAC,EAAE,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAClF,MAAM,IAAI,kBAAkB,CAC1B,+BAA+B,EAC/B,kEAAkE,CACnE,CAAC;QACJ,CAAC;QACD,OAAO;YACL,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,SAAS,EAAE,GAAG,CAAC,SAAS,IAAI,EAAE;YAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,IAAI;YAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE;YAC5B,qBAAqB,EAAE,GAAG,CAAC,SAAS;YACpC,4BAA4B,EAAE,GAAG,CAAC,gBAAgB,IAAI,GAAG,CAAC,SAAS;YACnE,SAAS,EAAE,GAAG,CAAC,SAAS,IAAI,CAAC;YAC7B,aAAa,EAAE,GAAG,CAAC,aAAa,IAAI,CAAC;YACrC,GAAG,6BAA6B,CAAC,GAAG,CAAC,QAAQ,CAAC;SAC/C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO;QACP,UAAU,EAAE,OAAO,CAAC,MAAM;QAC1B,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,MAAM;QAC7E,WAAW,EAAE,uBAAuB,CAAC,OAAO,CAAC;QAC7C,UAAU,EAAE,2BAA2B,CAAC,OAAO,CAAC;KACjD,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,OAG9C;IACC,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;IACzD,MAAM,GAAG,GAAG,2BAA2B,CACrC,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAC7D,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,+BAA+B,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IACpF,OAAO,+BAA+B,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;AAChE,CAAC;AAED,oFAAoF;AACpF,MAAM,CAAC,MAAM,0BAA0B,GAAuC;IAC5E,EAAE,EAAE,+BAA+B;IACnC,IAAI,EAAE,yBAAyB;IAC/B,IAAI,EAAE,MAAM;IACZ,WAAW,EACT,6JAA6J;IAC/J,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAC3B,wBAAwB,CACtB,OAAO,EAAE,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CACzE;IACH,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,+BAA+B,CAAC,OAAO,CAAC;IAC5D,WAAW,EAAE,GAAG,EAAE,CAChB,+BAA+B,CAAC,eAAe,CAAC,sCAAsC,CAAC,CAAC;CAC3F,CAAC"}

package/dist/federalRegisterDocuments.d.ts

@@ -0,0 +1,78 @@
+import type { UsDataAdapter } from './types.js';
+/** Adapter id for the Federal Register documents source. */
+export declare const FEDERAL_REGISTER_DOCUMENTS_SOURCE_ID = "federal-register-documents";
+/** Base URL for the Federal Register documents API. */
+export declare const FEDERAL_REGISTER_API_BASE = "https://www.federalregister.gov/api/v1/documents.json";
+/** Number of documents one request asks for by default. */
+export declare const FEDERAL_REGISTER_DEFAULT_PAGE_SIZE = 10;
+/** Order the default request asks the service to use. */
+export declare const FEDERAL_REGISTER_DEFAULT_ORDER = "newest";
+/** One Federal Register document, trimmed to the fields a story reads. */
+export interface FederalRegisterDocument {
+    /** The register's own document number, e.g. "2026-22789". */
+    documentNumber: string;
+    title: string;
+    /** Document type, e.g. "Rule", "Proposed Rule", "Notice", or "Presidential Document". */
+    type: string;
+    /** Publication date as YYYY-MM-DD, as the register wrote it. */
+    publicationDate: string;
+    /** Abstract, or null when the register published none. */
+    abstract: string | null;
+    /** Agency names the document belongs to. Empty when the register names none. */
+    agencies: string[];
+    /** Public HTML page for the document. */
+    htmlUrl: string;
+    /** Public PDF for the document, or "" when the register supplied none. */
+    pdfUrl: string;
+}
+/** One page of Federal Register documents, with the service's page counts. */
+export interface FederalRegisterDocumentsPage {
+    documents: FederalRegisterDocument[];
+    documentCount: number;
+    /** Total the service reports for the query. The service caps large result sets. */
+    reportedCount: number;
+    totalPages: number;
+    nextPageUrl: string | null;
+}
+/** Caller-selected window for one document page. */
+export interface FederalRegisterDocumentsQuery {
+    perPage?: number;
+    page?: number;
+    order?: 'newest' | 'oldest' | 'relevance';
+}
+/**
+ * Builds the request URL for one page of Federal Register documents.
+ *
+ * The endpoint is keyless. The default order is newest first, so repeated
+ * calls return the documents published most recently.
+ *
+ * @param query - an optional page size, page number, and order
+ * @returns the full request URL
+ */
+export declare function buildFederalRegisterDocumentsUrl(query?: FederalRegisterDocumentsQuery): string;
+/**
+ * Parses one page of Federal Register documents.
+ *
+ * A document without its number, title, type, publication date, or HTML page
+ * is a changed shape and stops the parse. An empty result page is valid and
+ * returns zero documents with the service's counts.
+ *
+ * @param payload - the JSON body from the Federal Register documents API
+ * @returns the documents on the page and the service's page counts
+ */
+export declare function parseFederalRegisterDocumentsPayload(payload: unknown): FederalRegisterDocumentsPage;
+/**
+ * Reads one page of Federal Register documents.
+ *
+ * One keyless request covers the page. The response carries the service
+ * count, page total, and next-page URL alongside the documents themselves.
+ *
+ * @param query - an optional page size, page number, order, and fetch stub
+ * @returns the documents on the page and the service's page counts
+ */
+export declare function fetchFederalRegisterDocuments(query?: FederalRegisterDocumentsQuery & {
+    fetchImpl?: typeof globalThis.fetch;
+}): Promise<FederalRegisterDocumentsPage>;
+/** Federal Register documents, one row per document, keyless. */
+export declare const federalRegisterDocumentsAdapter: UsDataAdapter<FederalRegisterDocumentsPage>;
+//# sourceMappingURL=federalRegisterDocuments.d.ts.map

package/dist/federalRegisterDocuments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"federalRegisterDocuments.d.ts","sourceRoot":"","sources":["../src/federalRegisterDocuments.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,4DAA4D;AAC5D,eAAO,MAAM,oCAAoC,+BAA+B,CAAC;AAEjF,uDAAuD;AACvD,eAAO,MAAM,yBAAyB,0DAA0D,CAAC;AAEjG,2DAA2D;AAC3D,eAAO,MAAM,kCAAkC,KAAK,CAAC;AAErD,yDAAyD;AACzD,eAAO,MAAM,8BAA8B,WAAW,CAAC;AAEvD,0EAA0E;AAC1E,MAAM,WAAW,uBAAuB;IACtC,6DAA6D;IAC7D,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,yFAAyF;IACzF,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,eAAe,EAAE,MAAM,CAAC;IACxB,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,gFAAgF;IAChF,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,8EAA8E;AAC9E,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,uBAAuB,EAAE,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,mFAAmF;IACnF,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,oDAAoD;AACpD,MAAM,WAAW,6BAA6B;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,WAAW,CAAC;CAC3C;AAyBD;;;;;;;;GAQG;AACH,wBAAgB,gCAAgC,CAC9C,KAAK,GAAE,6BAAkC,GACxC,MAAM,CAOR;AAaD;;;;;;;;;GASG;AACH,wBAAgB,oCAAoC,CAClD,OAAO,EAAE,OAAO,GACf,4BAA4B,CA0B9B;AAED;;;;;;;;GAQG;AACH,wBAAsB,6BAA6B,CACjD,KAAK,GAAE,6BAA6B,GAAG;IAAE,SAAS,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;CAAO,GAClF,OAAO,CAAC,4BAA4B,CAAC,CASvC;AAED,iEAAiE;AACjE,eAAO,MAAM,+BAA+B,EAAE,aAAa,CAAC,4BAA4B,CAavF,CAAC"}

package/dist/federalRegisterDocuments.js

@@ -0,0 +1,119 @@
+import { z } from 'zod';
+import { UsSourceParseError } from './errors.js';
+import { readFixtureJson } from './fixtures.js';
+import { httpGet } from './http.js';
+/** Adapter id for the Federal Register documents source. */
+export const FEDERAL_REGISTER_DOCUMENTS_SOURCE_ID = 'federal-register-documents';
+/** Base URL for the Federal Register documents API. */
+export const FEDERAL_REGISTER_API_BASE = 'https://www.federalregister.gov/api/v1/documents.json';
+/** Number of documents one request asks for by default. */
+export const FEDERAL_REGISTER_DEFAULT_PAGE_SIZE = 10;
+/** Order the default request asks the service to use. */
+export const FEDERAL_REGISTER_DEFAULT_ORDER = 'newest';
+/** Committed snapshot, so a build works when the Federal Register host is unreachable. */
+const FEDERAL_REGISTER_FIXTURE_FILENAME = 'federal-register-documents-2026-11-08.json';
+// Every document in the live page carries these fields. The abstract and the
+// agency list can be empty, but a missing number, title, or date is a change.
+const FEDERAL_REGISTER_DOCUMENT_SCHEMA = z.object({
+    document_number: z.string().min(1),
+    title: z.string().min(1),
+    type: z.string().min(1),
+    publication_date: z.string(),
+    abstract: z.string().nullable().optional(),
+    agencies: z.array(z.object({ name: z.string().optional() })).optional(),
+    html_url: z.string().min(1),
+    pdf_url: z.string().nullable().optional(),
+});
+const FEDERAL_REGISTER_PAYLOAD_SCHEMA = z.object({
+    count: z.number().int().nonnegative(),
+    total_pages: z.number().int().nonnegative(),
+    next_page_url: z.string().nullable().optional(),
+    results: z.array(FEDERAL_REGISTER_DOCUMENT_SCHEMA),
+});
+/**
+ * Builds the request URL for one page of Federal Register documents.
+ *
+ * The endpoint is keyless. The default order is newest first, so repeated
+ * calls return the documents published most recently.
+ *
+ * @param query - an optional page size, page number, and order
+ * @returns the full request URL
+ */
+export function buildFederalRegisterDocumentsUrl(query = {}) {
+    const params = new URLSearchParams({
+        per_page: String(query.perPage ?? FEDERAL_REGISTER_DEFAULT_PAGE_SIZE),
+        page: String(query.page ?? 1),
+        order: query.order ?? FEDERAL_REGISTER_DEFAULT_ORDER,
+    });
+    return `${FEDERAL_REGISTER_API_BASE}?${params.toString()}`;
+}
+/** Reads a YYYY-MM-DD date, throwing when the register writes another shape. */
+function parseFederalRegisterDate(value, documentNumber) {
+    if (!/^\d{4}-\d{2}-\d{2}$/.test(value)) {
+        throw new UsSourceParseError(FEDERAL_REGISTER_DOCUMENTS_SOURCE_ID, `Document ${documentNumber} carried an unreadable publication date: ${value}`);
+    }
+    return value;
+}
+/**
+ * Parses one page of Federal Register documents.
+ *
+ * A document without its number, title, type, publication date, or HTML page
+ * is a changed shape and stops the parse. An empty result page is valid and
+ * returns zero documents with the service's counts.
+ *
+ * @param payload - the JSON body from the Federal Register documents API
+ * @returns the documents on the page and the service's page counts
+ */
+export function parseFederalRegisterDocumentsPayload(payload) {
+    const parsed = FEDERAL_REGISTER_PAYLOAD_SCHEMA.safeParse(payload);
+    if (!parsed.success) {
+        throw new UsSourceParseError(FEDERAL_REGISTER_DOCUMENTS_SOURCE_ID, parsed.error.message);
+    }
+    const documents = parsed.data.results.map((row) => ({
+        documentNumber: row.document_number,
+        title: row.title,
+        type: row.type,
+        publicationDate: parseFederalRegisterDate(row.publication_date, row.document_number),
+        abstract: row.abstract ?? null,
+        agencies: (row.agencies ?? []).flatMap((agency) => agency.name === undefined || agency.name.trim() === '' ? [] : [agency.name]),
+        htmlUrl: row.html_url,
+        pdfUrl: row.pdf_url ?? '',
+    }));
+    return {
+        documents,
+        documentCount: documents.length,
+        reportedCount: parsed.data.count,
+        totalPages: parsed.data.total_pages,
+        nextPageUrl: parsed.data.next_page_url ?? null,
+    };
+}
+/**
+ * Reads one page of Federal Register documents.
+ *
+ * One keyless request covers the page. The response carries the service
+ * count, page total, and next-page URL alongside the documents themselves.
+ *
+ * @param query - an optional page size, page number, order, and fetch stub
+ * @returns the documents on the page and the service's page counts
+ */
+export async function fetchFederalRegisterDocuments(query = {}) {
+    const fetchImpl = query.fetchImpl ?? globalThis.fetch;
+    const url = buildFederalRegisterDocumentsUrl({
+        ...(query.perPage === undefined ? {} : { perPage: query.perPage }),
+        ...(query.page === undefined ? {} : { page: query.page }),
+        ...(query.order === undefined ? {} : { order: query.order }),
+    });
+    const response = await httpGet(FEDERAL_REGISTER_DOCUMENTS_SOURCE_ID, url, { fetchImpl });
+    return parseFederalRegisterDocumentsPayload(await response.json());
+}
+/** Federal Register documents, one row per document, keyless. */
+export const federalRegisterDocumentsAdapter = {
+    id: FEDERAL_REGISTER_DOCUMENTS_SOURCE_ID,
+    name: 'Federal Register documents',
+    auth: 'none',
+    description: 'Documents published in the Federal Register, one row per document, with its type, publication date, agencies, abstract, and public HTML and PDF links.',
+    fetchLive: async (options) => fetchFederalRegisterDocuments(options?.fetchImpl === undefined ? {} : { fetchImpl: options.fetchImpl }),
+    parse: (payload) => parseFederalRegisterDocumentsPayload(payload),
+    loadFixture: () => parseFederalRegisterDocumentsPayload(readFixtureJson(FEDERAL_REGISTER_FIXTURE_FILENAME)),
+};
+//# sourceMappingURL=federalRegisterDocuments.js.map

package/dist/federalRegisterDocuments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"federalRegisterDocuments.js","sourceRoot":"","sources":["../src/federalRegisterDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC,4DAA4D;AAC5D,MAAM,CAAC,MAAM,oCAAoC,GAAG,4BAA4B,CAAC;AAEjF,uDAAuD;AACvD,MAAM,CAAC,MAAM,yBAAyB,GAAG,uDAAuD,CAAC;AAEjG,2DAA2D;AAC3D,MAAM,CAAC,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAErD,yDAAyD;AACzD,MAAM,CAAC,MAAM,8BAA8B,GAAG,QAAQ,CAAC;AAsCvD,0FAA0F;AAC1F,MAAM,iCAAiC,GAAG,4CAA4C,CAAC;AAEvF,6EAA6E;AAC7E,8EAA8E;AAC9E,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC1C,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IACvE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC1C,CAAC,CAAC;AAEH,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IACrC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC3C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC/C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,gCAAgC,CAAC;CACnD,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,UAAU,gCAAgC,CAC9C,KAAK,GAAkC,EAAE;IAEzC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;QACjC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,kCAAkC,CAAC;QACrE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC;QAC7B,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,8BAA8B;KACrD,CAAC,CAAC;IACH,OAAO,GAAG,yBAAyB,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AAC7D,CAAC;AAED,gFAAgF;AAChF,SAAS,wBAAwB,CAAC,KAAa,EAAE,cAAsB;IACrE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,kBAAkB,CAC1B,oCAAoC,EACpC,YAAY,cAAc,4CAA4C,KAAK,EAAE,CAC9E,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,oCAAoC,CAClD,OAAgB;IAEhB,MAAM,MAAM,GAAG,+BAA+B,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAClE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,kBAAkB,CAAC,oCAAoC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED,MAAM,SAAS,GAA8B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC7E,cAAc,EAAE,GAAG,CAAC,eAAe;QACnC,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,eAAe,EAAE,wBAAwB,CAAC,GAAG,CAAC,gBAAgB,EAAE,GAAG,CAAC,eAAe,CAAC;QACpF,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,IAAI;QAC9B,QAAQ,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAChD,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAC5E;QACD,OAAO,EAAE,GAAG,CAAC,QAAQ;QACrB,MAAM,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE;KAC1B,CAAC,CAAC,CAAC;IAEJ,OAAO;QACL,SAAS;QACT,aAAa,EAAE,SAAS,CAAC,MAAM;QAC/B,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK;QAChC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW;QACnC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI;KAC/C,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CACjD,KAAK,GAA4E,EAAE;IAEnF,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;IACtD,MAAM,GAAG,GAAG,gCAAgC,CAAC;QAC3C,GAAG,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAClE,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QACzD,GAAG,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;KAC7D,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,oCAAoC,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IACzF,OAAO,oCAAoC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;AACrE,CAAC;AAED,iEAAiE;AACjE,MAAM,CAAC,MAAM,+BAA+B,GAAgD;IAC1F,EAAE,EAAE,oCAAoC;IACxC,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE,MAAM;IACZ,WAAW,EACT,wJAAwJ;IAC1J,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAC3B,6BAA6B,CAC3B,OAAO,EAAE,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CACzE;IACH,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,oCAAoC,CAAC,OAAO,CAAC;IACjE,WAAW,EAAE,GAAG,EAAE,CAChB,oCAAoC,CAAC,eAAe,CAAC,iCAAiC,CAAC,CAAC;CAC3F,CAAC"}

package/dist/healthdataSocrataCatalogue.d.ts

@@ -21,6 +21,10 @@ export interface HealthdataSocrataCatalogueEntry {
     viewCount: number;
     /** How many times the entry has been downloaded. */
     downloadCount: number;
+    /** Licence URL the portal attaches to the entry, or "" when it supplies none. */
+    licenceUrl: string;
+    /** Publishing organisation the portal attaches to the entry, or "" when it supplies none. */
+    attribution: string;
 }
 /** One category and how many catalogue entries carry it. */
 export interface HealthdataSocrataCategoryCount {

package/dist/healthdataSocrataCatalogue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"healthdataSocrataCatalogue.d.ts","sourceRoot":"","sources":["../src/healthdataSocrataCatalogue.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,8DAA8D;AAC9D,eAAO,MAAM,sCAAsC,iCAAiC,CAAC;AAErF,0DAA0D;AAC1D,MAAM,WAAW,+BAA+B;IAC9C,yDAAyD;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAC;IAClB,qFAAqF;IACrF,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,qBAAqB,EAAE,MAAM,CAAC;IAC9B,yEAAyE;IACzE,4BAA4B,EAAE,MAAM,CAAC;IACrC,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,4DAA4D;AAC5D,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,qDAAqD;AACrD,MAAM,WAAW,0BAA0B;IACzC,gDAAgD;IAChD,OAAO,EAAE,+BAA+B,EAAE,CAAC;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,8EAA8E;IAC9E,WAAW,EAAE,+BAA+B,CAAC;IAC7C;;;OAGG;IACH,UAAU,EAAE,8BAA8B,EAAE,CAAC;CAC9C;AAED,yDAAyD;AACzD,eAAO,MAAM,qCAAqC,0CAA0C,CAAC;AAE7F,oDAAoD;AACpD,eAAO,MAAM,kCAAkC,KAAK,CAAC;AAyDrD;;;;;;;;GAQG;AACH,wBAAgB,kCAAkC,CAAC,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAKvF;AAED;;;;;;;;;GASG;AACH,wBAAgB,sCAAsC,CACpD,OAAO,EAAE,OAAO,GACf,0BAA0B,CAuC5B;AAED;;;;;;;;GAQG;AACH,wBAAsB,+BAA+B,CAAC,OAAO,CAAC,EAAE;IAC9D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;CACrC,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAOtC;AAED,kFAAkF;AAClF,eAAO,MAAM,iCAAiC,EAAE,aAAa,CAAC,0BAA0B,CAevF,CAAC"}
+{"version":3,"file":"healthdataSocrataCatalogue.d.ts","sourceRoot":"","sources":["../src/healthdataSocrataCatalogue.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,8DAA8D;AAC9D,eAAO,MAAM,sCAAsC,iCAAiC,CAAC;AAErF,0DAA0D;AAC1D,MAAM,WAAW,+BAA+B;IAC9C,yDAAyD;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAC;IAClB,qFAAqF;IACrF,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,qBAAqB,EAAE,MAAM,CAAC;IAC9B,yEAAyE;IACzE,4BAA4B,EAAE,MAAM,CAAC;IACrC,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,aAAa,EAAE,MAAM,CAAC;IACtB,iFAAiF;IACjF,UAAU,EAAE,MAAM,CAAC;IACnB,6FAA6F;IAC7F,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,4DAA4D;AAC5D,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,qDAAqD;AACrD,MAAM,WAAW,0BAA0B;IACzC,gDAAgD;IAChD,OAAO,EAAE,+BAA+B,EAAE,CAAC;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,8EAA8E;IAC9E,WAAW,EAAE,+BAA+B,CAAC;IAC7C;;;OAGG;IACH,UAAU,EAAE,8BAA8B,EAAE,CAAC;CAC9C;AAED,yDAAyD;AACzD,eAAO,MAAM,qCAAqC,0CAA0C,CAAC;AAE7F,oDAAoD;AACpD,eAAO,MAAM,kCAAkC,KAAK,CAAC;AA0DrD;;;;;;;;GAQG;AACH,wBAAgB,kCAAkC,CAAC,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAKvF;AAED;;;;;;;;;GASG;AACH,wBAAgB,sCAAsC,CACpD,OAAO,EAAE,OAAO,GACf,0BAA0B,CAwC5B;AAED;;;;;;;;GAQG;AACH,wBAAsB,+BAA+B,CAAC,OAAO,CAAC,EAAE;IAC9D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;CACrC,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAOtC;AAED,kFAAkF;AAClF,eAAO,MAAM,iCAAiC,EAAE,aAAa,CAAC,0BAA0B,CAevF,CAAC"}

package/dist/healthdataSocrataCatalogue.js

@@ -2,6 +2,7 @@ import { z } from 'zod';
 import { UsSourceParseError } from './errors.js';
 import { httpGet } from './http.js';
 import { readFixtureJson } from './fixtures.js';
+import { parseSocrataCatalogueMetadata } from './socrataCatalogueMetadata.js';
 /** Adapter id for the healthdata-socrata-catalogue source. */
 export const HEALTHDATA_SOCRATA_CATALOGUE_SOURCE_ID = 'healthdata-socrata-catalogue';
 /** Base URL for the HealthData.gov Socrata catalogue. */
@@ -24,6 +25,7 @@ const HEALTHDATA_SOCRATA_CATALOGUE_ENTRY_SCHEMA = z.object({
     viewLastModified: z.number().optional(),
     viewCount: z.number().optional(),
     downloadCount: z.number().optional(),
+    metadata: z.unknown().optional(),
 });
 const HEALTHDATA_SOCRATA_CATALOGUE_PAYLOAD_SCHEMA = z.array(HEALTHDATA_SOCRATA_CATALOGUE_ENTRY_SCHEMA);
 /** Counts entries per category, most entries first, ties by name. */
@@ -92,6 +94,7 @@ export function parseHealthdataSocrataCataloguePayload(payload) {
             viewLastModifiedEpochSeconds: row.viewLastModified ?? row.createdAt,
             viewCount: row.viewCount ?? 0,
             downloadCount: row.downloadCount ?? 0,
+            ...parseSocrataCatalogueMetadata(row.metadata),
         };
     });
     return {

package/dist/healthdataSocrataCatalogue.js.map

@@ -1 +1 @@
-{"version":3,"file":"healthdataSocrataCatalogue.js","sourceRoot":"","sources":["../src/healthdataSocrataCatalogue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGhD,8DAA8D;AAC9D,MAAM,CAAC,MAAM,sCAAsC,GAAG,8BAA8B,CAAC;AA8CrF,yDAAyD;AACzD,MAAM,CAAC,MAAM,qCAAqC,GAAG,uCAAuC,CAAC;AAE7F,oDAAoD;AACpD,MAAM,CAAC,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAErD,wFAAwF;AACxF,MAAM,6CAA6C,GACjD,8CAA8C,CAAC;AAEjD,qFAAqF;AACrF,MAAM,gCAAgC,GAAG,eAAe,CAAC;AAEzD,4EAA4E;AAC5E,8DAA8D;AAC9D,MAAM,yCAAyC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC1C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC;AAEH,MAAM,2CAA2C,GAAG,CAAC,CAAC,KAAK,CACzD,yCAAyC,CAC1C,CAAC;AAEF,qEAAqE;AACrE,SAAS,gCAAgC,CACvC,OAA0C;IAE1C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,gCAAgC,CAAC;QACpE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;SACzB,IAAI,CAAC,CAAC,CAAC,YAAY,EAAE,SAAS,CAAC,EAAE,CAAC,aAAa,EAAE,UAAU,CAAC,EAAE,EAAE,CAC/D,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,SAAS,CAC9F;SACA,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,gFAAgF;AAChF,SAAS,4BAA4B,CACnC,OAA0C;IAE1C,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,kBAAkB,CAAC,sCAAsC,EAAE,yBAAyB,CAAC,CAAC;IAClG,CAAC;IACD,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAC1F,KAAK,CACN,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kCAAkC,CAAC,OAA4B;IAC7E,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;QACjC,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,IAAI,kCAAkC,CAAC;KACpE,CAAC,CAAC;IACH,OAAO,yCAAyC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AACtE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,sCAAsC,CACpD,OAAgB;IAEhB,MAAM,MAAM,GAAG,2CAA2C,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC9E,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,kBAAkB,CAAC,sCAAsC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7F,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,kBAAkB,CAC1B,sCAAsC,EACtC,iCAAiC,CAClC,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAsC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACzE,IAAI,GAAG,CAAC,EAAE,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAClF,MAAM,IAAI,kBAAkB,CAC1B,sCAAsC,EACtC,kEAAkE,CACnE,CAAC;QACJ,CAAC;QACD,OAAO;YACL,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,SAAS,EAAE,GAAG,CAAC,SAAS,IAAI,EAAE;YAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,IAAI;YAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE;YAC5B,qBAAqB,EAAE,GAAG,CAAC,SAAS;YACpC,4BAA4B,EAAE,GAAG,CAAC,gBAAgB,IAAI,GAAG,CAAC,SAAS;YACnE,SAAS,EAAE,GAAG,CAAC,SAAS,IAAI,CAAC;YAC7B,aAAa,EAAE,GAAG,CAAC,aAAa,IAAI,CAAC;SACtC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO;QACP,UAAU,EAAE,OAAO,CAAC,MAAM;QAC1B,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,MAAM;QAC7E,WAAW,EAAE,4BAA4B,CAAC,OAAO,CAAC;QAClD,UAAU,EAAE,gCAAgC,CAAC,OAAO,CAAC;KACtD,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,+BAA+B,CAAC,OAGrD;IACC,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;IACzD,MAAM,GAAG,GAAG,kCAAkC,CAC5C,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAC7D,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,sCAAsC,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IAC3F,OAAO,sCAAsC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,kFAAkF;AAClF,MAAM,CAAC,MAAM,iCAAiC,GAA8C;IAC1F,EAAE,EAAE,sCAAsC;IAC1C,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE,MAAM;IACZ,WAAW,EACT,0IAA0I;IAC5I,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAC3B,+BAA+B,CAC7B,OAAO,EAAE,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CACzE;IACH,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,sCAAsC,CAAC,OAAO,CAAC;IACnE,WAAW,EAAE,GAAG,EAAE,CAChB,sCAAsC,CACpC,eAAe,CAAC,6CAA6C,CAAC,CAC/D;CACJ,CAAC"}
+{"version":3,"file":"healthdataSocrataCatalogue.js","sourceRoot":"","sources":["../src/healthdataSocrataCatalogue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,6BAA6B,EAAE,MAAM,+BAA+B,CAAC;AAG9E,8DAA8D;AAC9D,MAAM,CAAC,MAAM,sCAAsC,GAAG,8BAA8B,CAAC;AAkDrF,yDAAyD;AACzD,MAAM,CAAC,MAAM,qCAAqC,GAAG,uCAAuC,CAAC;AAE7F,oDAAoD;AACpD,MAAM,CAAC,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAErD,wFAAwF;AACxF,MAAM,6CAA6C,GACjD,8CAA8C,CAAC;AAEjD,qFAAqF;AACrF,MAAM,gCAAgC,GAAG,eAAe,CAAC;AAEzD,4EAA4E;AAC5E,8DAA8D;AAC9D,MAAM,yCAAyC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC1C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,2CAA2C,GAAG,CAAC,CAAC,KAAK,CACzD,yCAAyC,CAC1C,CAAC;AAEF,qEAAqE;AACrE,SAAS,gCAAgC,CACvC,OAA0C;IAE1C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,gCAAgC,CAAC;QACpE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;SACzB,IAAI,CAAC,CAAC,CAAC,YAAY,EAAE,SAAS,CAAC,EAAE,CAAC,aAAa,EAAE,UAAU,CAAC,EAAE,EAAE,CAC/D,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,SAAS,CAC9F;SACA,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,gFAAgF;AAChF,SAAS,4BAA4B,CACnC,OAA0C;IAE1C,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,kBAAkB,CAAC,sCAAsC,EAAE,yBAAyB,CAAC,CAAC;IAClG,CAAC;IACD,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAC1F,KAAK,CACN,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kCAAkC,CAAC,OAA4B;IAC7E,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;QACjC,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,IAAI,kCAAkC,CAAC;KACpE,CAAC,CAAC;IACH,OAAO,yCAAyC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AACtE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,sCAAsC,CACpD,OAAgB;IAEhB,MAAM,MAAM,GAAG,2CAA2C,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC9E,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,kBAAkB,CAAC,sCAAsC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7F,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,kBAAkB,CAC1B,sCAAsC,EACtC,iCAAiC,CAClC,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAsC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACzE,IAAI,GAAG,CAAC,EAAE,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAClF,MAAM,IAAI,kBAAkB,CAC1B,sCAAsC,EACtC,kEAAkE,CACnE,CAAC;QACJ,CAAC;QACD,OAAO;YACL,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,SAAS,EAAE,GAAG,CAAC,SAAS,IAAI,EAAE;YAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,IAAI;YAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE;YAC5B,qBAAqB,EAAE,GAAG,CAAC,SAAS;YACpC,4BAA4B,EAAE,GAAG,CAAC,gBAAgB,IAAI,GAAG,CAAC,SAAS;YACnE,SAAS,EAAE,GAAG,CAAC,SAAS,IAAI,CAAC;YAC7B,aAAa,EAAE,GAAG,CAAC,aAAa,IAAI,CAAC;YACrC,GAAG,6BAA6B,CAAC,GAAG,CAAC,QAAQ,CAAC;SAC/C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO;QACP,UAAU,EAAE,OAAO,CAAC,MAAM;QAC1B,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,MAAM;QAC7E,WAAW,EAAE,4BAA4B,CAAC,OAAO,CAAC;QAClD,UAAU,EAAE,gCAAgC,CAAC,OAAO,CAAC;KACtD,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,+BAA+B,CAAC,OAGrD;IACC,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;IACzD,MAAM,GAAG,GAAG,kCAAkC,CAC5C,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAC7D,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,sCAAsC,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IAC3F,OAAO,sCAAsC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,kFAAkF;AAClF,MAAM,CAAC,MAAM,iCAAiC,GAA8C;IAC1F,EAAE,EAAE,sCAAsC;IAC1C,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE,MAAM;IACZ,WAAW,EACT,0IAA0I;IAC5I,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAC3B,+BAA+B,CAC7B,OAAO,EAAE,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CACzE;IACH,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,sCAAsC,CAAC,OAAO,CAAC;IACnE,WAAW,EAAE,GAAG,EAAE,CAChB,sCAAsC,CACpC,eAAe,CAAC,6CAA6C,CAAC,CAC/D;CACJ,CAAC"}

package/dist/http.d.ts

@@ -37,4 +37,18 @@ export interface HttpGetOptions {
  * @throws {UsSourceApiError} On a non-2xx status, an abort, or a network error.
  */
 export declare function httpGet(source: string, url: string | URL, options?: HttpGetOptions): Promise<Response>;
+/**
+ * Issues a JSON POST through the shared HTTP layer.
+ *
+ * The body is serialised as JSON, and the request carries the same identity,
+ * timeout, and retry classification as every GET.
+ *
+ * @param source - Source name used in the error message, e.g. "nih-reporter-projects".
+ * @param url - Absolute URL or URL object to fetch.
+ * @param body - JSON-serialisable value sent as the request body.
+ * @param options - Fetch override, extra headers, and timeout.
+ * @returns The response, already checked for a successful status.
+ * @throws {UsSourceApiError} On a non-2xx status, an abort, or a network error.
+ */
+export declare function httpPostJson(source: string, url: string | URL, body: unknown, options?: HttpGetOptions): Promise<Response>;
 //# sourceMappingURL=http.d.ts.map

package/dist/http.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,mDAAmD,CAAC;AAE3E,qEAAqE;AACrE,eAAO,MAAM,kBAAkB,QAAS,CAAC;AAQzC,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC7B,oDAAoD;IACpD,SAAS,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,GAAG,SAAS,CAAC;IAChD,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAC7C,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAyBD;;;;;;;;;;;;GAYG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,GAAG,GAAG,EACjB,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,QAAQ,CAAC,CAsCnB"}
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,mDAAmD,CAAC;AAE3E,qEAAqE;AACrE,eAAO,MAAM,kBAAkB,QAAS,CAAC;AAQzC,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC7B,oDAAoD;IACpD,SAAS,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,GAAG,SAAS,CAAC;IAChD,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAC7C,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAyBD;;;;;;;;;;;;GAYG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,GAAG,GAAG,EACjB,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,QAAQ,CAAC,CAUnB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,GAAG,GAAG,EACjB,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,QAAQ,CAAC,CAWnB"}

package/dist/http.js

@@ -52,6 +52,33 @@ function buildRequestHeaders(extra) {
  * @throws {UsSourceApiError} On a non-2xx status, an abort, or a network error.
  */
 export async function httpGet(source, url, options = {}) {
+    return fetchWithRetry(source, url, {
+        method: 'GET',
+        ...(options.headers === undefined ? {} : { headers: options.headers }),
+    }, options);
+}
+/**
+ * Issues a JSON POST through the shared HTTP layer.
+ *
+ * The body is serialised as JSON, and the request carries the same identity,
+ * timeout, and retry classification as every GET.
+ *
+ * @param source - Source name used in the error message, e.g. "nih-reporter-projects".
+ * @param url - Absolute URL or URL object to fetch.
+ * @param body - JSON-serialisable value sent as the request body.
+ * @param options - Fetch override, extra headers, and timeout.
+ * @returns The response, already checked for a successful status.
+ * @throws {UsSourceApiError} On a non-2xx status, an abort, or a network error.
+ */
+export async function httpPostJson(source, url, body, options = {}) {
+    return fetchWithRetry(source, url, {
+        method: 'POST',
+        body: JSON.stringify(body),
+        headers: { 'content-type': 'application/json', ...options.headers },
+    }, options);
+}
+/** Runs one request with the shared headers, timeout, and retry policy. */
+async function fetchWithRetry(source, url, request, options) {
     const doFetch = options.fetchImpl ?? globalThis.fetch;
     const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
     const retries = options.retries ?? 0;
@@ -62,7 +89,8 @@ export async function httpGet(source, url, options = {}) {
         let response;
         try {
             response = await doFetch(url, {
-                headers: buildRequestHeaders(options.headers),
+                ...request,
+                headers: buildRequestHeaders(request.headers),
                 signal: controller.signal,
             });
         }

package/dist/http.js.map

@@ -1 +1 @@
-{"version":3,"file":"http.js","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,gDAAgD,CAAC;AAE3E,qEAAqE;AACrE,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAEzC,gFAAgF;AAChF,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEnC,mFAAmF;AACnF,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAgBvC;;;;;;;;;;GAUG;AACH,SAAS,mBAAmB,CAAC,KAAyC;IACpE,MAAM,OAAO,GAA2B,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;IACrE,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QACxD,IAAI,IAAI,CAAC,WAAW,EAAE,KAAK,YAAY,EAAE,CAAC;YACxC,OAAO,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,MAAc,EACd,GAAiB,EACjB,OAAO,GAAmB,EAAE;IAE5B,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;IACtD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,kBAAkB,CAAC;IAC1D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC;IACrC,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC;IAClD,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,SAAS,CAAC,CAAC;QAC9D,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE;gBAC5B,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC;gBAC7C,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC9B,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,2BAA2B,SAAS,IAAI,EAAE;oBAC3E,SAAS,EAAE,IAAI;iBAChB,CAAC,CAAC;YACL,CAAC;YACD,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,mBAAmB,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9F,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QAED,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YAChB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,SAAS,GACb,QAAQ,CAAC,MAAM,KAAK,sBAAsB,IAAI,QAAQ,CAAC,MAAM,IAAI,0BAA0B,CAAC;QAC9F,IAAI,CAAC,SAAS,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACrC,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,QAAQ,QAAQ,CAAC,MAAM,EAAE,EAAE;gBAC5D,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,SAAS;aACV,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,GAAG,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC;IACnF,CAAC;AACH,CAAC"}
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,gDAAgD,CAAC;AAE3E,qEAAqE;AACrE,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAEzC,gFAAgF;AAChF,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEnC,mFAAmF;AACnF,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAgBvC;;;;;;;;;;GAUG;AACH,SAAS,mBAAmB,CAAC,KAAyC;IACpE,MAAM,OAAO,GAA2B,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;IACrE,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QACxD,IAAI,IAAI,CAAC,WAAW,EAAE,KAAK,YAAY,EAAE,CAAC;YACxC,OAAO,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,MAAc,EACd,GAAiB,EACjB,OAAO,GAAmB,EAAE;IAE5B,OAAO,cAAc,CACnB,MAAM,EACN,GAAG,EACH;QACE,MAAM,EAAE,KAAK;QACb,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;KACvE,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAc,EACd,GAAiB,EACjB,IAAa,EACb,OAAO,GAAmB,EAAE;IAE5B,OAAO,cAAc,CACnB,MAAM,EACN,GAAG,EACH;QACE,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QAC1B,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE;KACpE,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED,2EAA2E;AAC3E,KAAK,UAAU,cAAc,CAC3B,MAAc,EACd,GAAiB,EACjB,OAAyD,EACzD,OAAuB;IAEvB,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;IACtD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,kBAAkB,CAAC;IAC1D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC;IACrC,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC;IAClD,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,SAAS,CAAC,CAAC;QAC9D,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE;gBAC5B,GAAG,OAAO;gBACV,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,OAA6C,CAAC;gBACnF,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC9B,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,2BAA2B,SAAS,IAAI,EAAE;oBAC3E,SAAS,EAAE,IAAI;iBAChB,CAAC,CAAC;YACL,CAAC;YACD,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,mBAAmB,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9F,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QAED,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YAChB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,SAAS,GACb,QAAQ,CAAC,MAAM,KAAK,sBAAsB,IAAI,QAAQ,CAAC,MAAM,IAAI,0BAA0B,CAAC;QAC9F,IAAI,CAAC,SAAS,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACrC,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,QAAQ,QAAQ,CAAC,MAAM,EAAE,EAAE;gBAC5D,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,SAAS;aACV,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,GAAG,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC;IACnF,CAAC;AACH,CAAC"}