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

package/dist/sanFranciscoOpenDataCatalogue.d.ts

@@ -0,0 +1,42 @@
+import { type SocrataCatalogue, type SocrataCatalogueCategoryCount, type SocrataCatalogueEntry } from './socrataCatalogue.js';
+/** Adapter id for the San Francisco Open Data catalogue source. */
+export declare const SAN_FRANCISCO_OPEN_DATA_CATALOGUE_SOURCE_ID = "san-francisco-open-data-catalogue";
+/** Base URL for the San Francisco Open Data Socrata catalogue. */
+export declare const SAN_FRANCISCO_OPEN_DATA_API_BASE = "https://data.sf.gov/api/views.json";
+/** How many catalogue entries one request reads. */
+export declare const SAN_FRANCISCO_OPEN_DATA_CATALOGUE_LIMIT = 10;
+/** One catalogue entry from the San Francisco Socrata discovery API. */
+export type SanFranciscoOpenDataCatalogueEntry = SocrataCatalogueEntry;
+/** One city topic and how many catalogue entries carry it. */
+export type SanFranciscoOpenDataCategoryCount = SocrataCatalogueCategoryCount;
+/** One page of the San Francisco catalogue, folded for a story. */
+export type SanFranciscoOpenDataCatalogue = SocrataCatalogue;
+/**
+ * Builds the request URL for one page of the San Francisco catalogue.
+ *
+ * @param options - an optional entry cap
+ * @returns the full request URL
+ */
+export declare function buildSanFranciscoOpenDataCatalogueUrl(options?: {
+    limit?: number;
+}): string;
+/**
+ * Parses one page of the San Francisco catalogue into entries and topic counts.
+ *
+ * @param payload - the JSON body from the San Francisco Socrata discovery API
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export declare function parseSanFranciscoOpenDataCataloguePayload(payload: unknown): SanFranciscoOpenDataCatalogue;
+/**
+ * Reads one page of the San Francisco Open Data catalogue.
+ *
+ * @param options - an optional entry cap and fetch stub
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export declare function fetchSanFranciscoOpenDataCatalogue(options?: {
+    limit?: number;
+    fetchImpl?: typeof globalThis.fetch;
+}): Promise<SanFranciscoOpenDataCatalogue>;
+/** San Francisco Open Data catalogue of datasets, maps, and filtered views, keyless. */
+export declare const sanFranciscoOpenDataCatalogueAdapter: import("./types.js").UsDataAdapter<SocrataCatalogue>;
+//# sourceMappingURL=sanFranciscoOpenDataCatalogue.d.ts.map

package/dist/sanFranciscoOpenDataCatalogue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanFranciscoOpenDataCatalogue.d.ts","sourceRoot":"","sources":["../src/sanFranciscoOpenDataCatalogue.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,gBAAgB,EACrB,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC3B,MAAM,uBAAuB,CAAC;AAE/B,mEAAmE;AACnE,eAAO,MAAM,2CAA2C,sCAAsC,CAAC;AAE/F,kEAAkE;AAClE,eAAO,MAAM,gCAAgC,uCAAuC,CAAC;AAErF,oDAAoD;AACpD,eAAO,MAAM,uCAAuC,KAA0B,CAAC;AAE/E,wEAAwE;AACxE,MAAM,MAAM,kCAAkC,GAAG,qBAAqB,CAAC;AAEvE,8DAA8D;AAC9D,MAAM,MAAM,iCAAiC,GAAG,6BAA6B,CAAC;AAE9E,mEAAmE;AACnE,MAAM,MAAM,6BAA6B,GAAG,gBAAgB,CAAC;AAM7D;;;;;GAKG;AACH,wBAAgB,qCAAqC,CAAC,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAE1F;AAED;;;;;GAKG;AACH,wBAAgB,yCAAyC,CACvD,OAAO,EAAE,OAAO,GACf,6BAA6B,CAE/B;AAED;;;;;GAKG;AACH,wBAAsB,kCAAkC,CAAC,OAAO,CAAC,EAAE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;CACrC,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAQzC;AAED,wFAAwF;AACxF,eAAO,MAAM,oCAAoC,sDAO/C,CAAC"}

package/dist/sanFranciscoOpenDataCatalogue.js

@@ -0,0 +1,48 @@
+import { buildSocrataCatalogueUrl, createSocrataCatalogueAdapter, fetchSocrataCatalogue, parseSocrataCataloguePayload, SOCRATA_CATALOGUE_LIMIT, } from './socrataCatalogue.js';
+/** Adapter id for the San Francisco Open Data catalogue source. */
+export const SAN_FRANCISCO_OPEN_DATA_CATALOGUE_SOURCE_ID = 'san-francisco-open-data-catalogue';
+/** Base URL for the San Francisco Open Data Socrata catalogue. */
+export const SAN_FRANCISCO_OPEN_DATA_API_BASE = 'https://data.sf.gov/api/views.json';
+/** How many catalogue entries one request reads. */
+export const SAN_FRANCISCO_OPEN_DATA_CATALOGUE_LIMIT = SOCRATA_CATALOGUE_LIMIT;
+/** Committed snapshot, so a build works when the San Francisco host is unreachable. */
+const SAN_FRANCISCO_OPEN_DATA_FIXTURE_FILENAME = 'san-francisco-open-data-catalogue-2026-11-08.json';
+/**
+ * Builds the request URL for one page of the San Francisco catalogue.
+ *
+ * @param options - an optional entry cap
+ * @returns the full request URL
+ */
+export function buildSanFranciscoOpenDataCatalogueUrl(options) {
+    return buildSocrataCatalogueUrl(SAN_FRANCISCO_OPEN_DATA_API_BASE, options);
+}
+/**
+ * Parses one page of the San Francisco catalogue into entries and topic counts.
+ *
+ * @param payload - the JSON body from the San Francisco Socrata discovery API
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export function parseSanFranciscoOpenDataCataloguePayload(payload) {
+    return parseSocrataCataloguePayload(SAN_FRANCISCO_OPEN_DATA_CATALOGUE_SOURCE_ID, payload);
+}
+/**
+ * Reads one page of the San Francisco Open Data catalogue.
+ *
+ * @param options - an optional entry cap and fetch stub
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export async function fetchSanFranciscoOpenDataCatalogue(options) {
+    return fetchSocrataCatalogue({
+        sourceId: SAN_FRANCISCO_OPEN_DATA_CATALOGUE_SOURCE_ID,
+        apiBase: SAN_FRANCISCO_OPEN_DATA_API_BASE,
+    }, options);
+}
+/** San Francisco Open Data catalogue of datasets, maps, and filtered views, keyless. */
+export const sanFranciscoOpenDataCatalogueAdapter = createSocrataCatalogueAdapter({
+    sourceId: SAN_FRANCISCO_OPEN_DATA_CATALOGUE_SOURCE_ID,
+    name: 'San Francisco Open Data catalogue',
+    description: 'The San Francisco Open Data Socrata catalogue, one row per published dataset, map, or filtered view, with its city topic, view count, and download count.',
+    apiBase: SAN_FRANCISCO_OPEN_DATA_API_BASE,
+    fixtureFilename: SAN_FRANCISCO_OPEN_DATA_FIXTURE_FILENAME,
+});
+//# sourceMappingURL=sanFranciscoOpenDataCatalogue.js.map

package/dist/sanFranciscoOpenDataCatalogue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanFranciscoOpenDataCatalogue.js","sourceRoot":"","sources":["../src/sanFranciscoOpenDataCatalogue.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,6BAA6B,EAC7B,qBAAqB,EACrB,4BAA4B,EAC5B,uBAAuB,GAIxB,MAAM,uBAAuB,CAAC;AAE/B,mEAAmE;AACnE,MAAM,CAAC,MAAM,2CAA2C,GAAG,mCAAmC,CAAC;AAE/F,kEAAkE;AAClE,MAAM,CAAC,MAAM,gCAAgC,GAAG,oCAAoC,CAAC;AAErF,oDAAoD;AACpD,MAAM,CAAC,MAAM,uCAAuC,GAAG,uBAAuB,CAAC;AAW/E,uFAAuF;AACvF,MAAM,wCAAwC,GAC5C,mDAAmD,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,UAAU,qCAAqC,CAAC,OAA4B;IAChF,OAAO,wBAAwB,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yCAAyC,CACvD,OAAgB;IAEhB,OAAO,4BAA4B,CAAC,2CAA2C,EAAE,OAAO,CAAC,CAAC;AAC5F,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,kCAAkC,CAAC,OAGxD;IACC,OAAO,qBAAqB,CAC1B;QACE,QAAQ,EAAE,2CAA2C;QACrD,OAAO,EAAE,gCAAgC;KAC1C,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED,wFAAwF;AACxF,MAAM,CAAC,MAAM,oCAAoC,GAAG,6BAA6B,CAAC;IAChF,QAAQ,EAAE,2CAA2C;IACrD,IAAI,EAAE,mCAAmC;IACzC,WAAW,EACT,2JAA2J;IAC7J,OAAO,EAAE,gCAAgC;IACzC,eAAe,EAAE,wCAAwC;CAC1D,CAAC,CAAC"}

package/dist/seattleOpenDataCatalogue.d.ts

@@ -0,0 +1,91 @@
+import type { UsDataAdapter } from './types.js';
+/** Adapter id for the Seattle Open Data catalogue source. */
+export declare const SEATTLE_OPEN_DATA_CATALOGUE_SOURCE_ID = "seattle-open-data-catalogue";
+/** Base URL for the Seattle Open Data Socrata catalogue. */
+export declare const SEATTLE_OPEN_DATA_API_BASE = "https://data.seattle.gov/api/views.json";
+/** How many catalogue entries one request reads. */
+export declare const SEATTLE_OPEN_DATA_CATALOGUE_LIMIT = 10;
+/** One catalogue entry from the Seattle Socrata discovery API. */
+export interface SeattleOpenDataCatalogueEntry {
+    /** Four-by-four Socrata dataset id, e.g. "k8z7-3feg". */
+    id: string;
+    /** Human-readable title of the dataset, chart, story, map, or file. */
+    name: string;
+    /** What the entry is: "dataset", "federated_href", "chart", "story", or "map". */
+    assetType: string;
+    /** City 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 text or URL the portal attaches, or "" when it supplies none. */
+    licenceUrl: string;
+    /** Publishing organisation the portal attaches, or "" when it supplies none. */
+    attribution: string;
+}
+/** One city topic and how many catalogue entries carry it. */
+export interface SeattleOpenDataCategoryCount {
+    category: string;
+    entryCount: number;
+}
+/** One page of the Seattle catalogue, folded for a story. */
+export interface SeattleOpenDataCatalogue {
+    /** One entry per catalogue item in the page. */
+    entries: SeattleOpenDataCatalogueEntry[];
+    entryCount: number;
+    /** Entries whose asset type is "dataset". */
+    datasetCount: number;
+    /** Entry with the latest creation time. Ties go to the earlier list entry. */
+    newestEntry: SeattleOpenDataCatalogueEntry;
+    /**
+     * Categories in the page, most entries first, ties broken by name. An entry
+     * the catalogue lists without a category is counted under "Uncategorised".
+     */
+    categories: SeattleOpenDataCategoryCount[];
+}
+/**
+ * Builds the request URL for one page of the Seattle 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 buildSeattleOpenDataCatalogueUrl(options?: {
+    limit?: number;
+}): string;
+/**
+ * Parses one page of the Seattle catalogue into the entries and topic 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 Seattle Socrata discovery API
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export declare function parseSeattleOpenDataCataloguePayload(payload: unknown): SeattleOpenDataCatalogue;
+/**
+ * Reads one page of the Seattle Open Data catalogue.
+ *
+ * One keyless request covers the page and reports what the city portal 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 fetchSeattleOpenDataCatalogue(options?: {
+    limit?: number;
+    fetchImpl?: typeof globalThis.fetch;
+}): Promise<SeattleOpenDataCatalogue>;
+/** Seattle Open Data catalogue of datasets, maps, charts, and stories, keyless. */
+export declare const seattleOpenDataCatalogueAdapter: UsDataAdapter<SeattleOpenDataCatalogue>;
+//# sourceMappingURL=seattleOpenDataCatalogue.d.ts.map

package/dist/seattleOpenDataCatalogue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seattleOpenDataCatalogue.d.ts","sourceRoot":"","sources":["../src/seattleOpenDataCatalogue.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,6DAA6D;AAC7D,eAAO,MAAM,qCAAqC,gCAAgC,CAAC;AAEnF,4DAA4D;AAC5D,eAAO,MAAM,0BAA0B,4CAA4C,CAAC;AAEpF,oDAAoD;AACpD,eAAO,MAAM,iCAAiC,KAAK,CAAC;AAEpD,kEAAkE;AAClE,MAAM,WAAW,6BAA6B;IAC5C,yDAAyD;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,kFAAkF;IAClF,SAAS,EAAE,MAAM,CAAC;IAClB,8EAA8E;IAC9E,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,4EAA4E;IAC5E,UAAU,EAAE,MAAM,CAAC;IACnB,gFAAgF;IAChF,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,8DAA8D;AAC9D,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,6DAA6D;AAC7D,MAAM,WAAW,wBAAwB;IACvC,gDAAgD;IAChD,OAAO,EAAE,6BAA6B,EAAE,CAAC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,8EAA8E;IAC9E,WAAW,EAAE,6BAA6B,CAAC;IAC3C;;;OAGG;IACH,UAAU,EAAE,4BAA4B,EAAE,CAAC;CAC5C;AAuDD;;;;;;;;GAQG;AACH,wBAAgB,gCAAgC,CAAC,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAKrF;AAED;;;;;;;;;GASG;AACH,wBAAgB,oCAAoC,CAAC,OAAO,EAAE,OAAO,GAAG,wBAAwB,CAwC/F;AAED;;;;;;;;GAQG;AACH,wBAAsB,6BAA6B,CAAC,OAAO,CAAC,EAAE;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;CACrC,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAOpC;AAED,mFAAmF;AACnF,eAAO,MAAM,+BAA+B,EAAE,aAAa,CAAC,wBAAwB,CAanF,CAAC"}

package/dist/seattleOpenDataCatalogue.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 Seattle Open Data catalogue source. */
+export const SEATTLE_OPEN_DATA_CATALOGUE_SOURCE_ID = 'seattle-open-data-catalogue';
+/** Base URL for the Seattle Open Data Socrata catalogue. */
+export const SEATTLE_OPEN_DATA_API_BASE = 'https://data.seattle.gov/api/views.json';
+/** How many catalogue entries one request reads. */
+export const SEATTLE_OPEN_DATA_CATALOGUE_LIMIT = 10;
+/** Committed snapshot, so a build works when the Seattle host is unreachable. */
+const SEATTLE_OPEN_DATA_FIXTURE_FILENAME = 'seattle-open-data-catalogue-2026-11-08.json';
+/** Category bucket the adapter uses for an entry the catalogue lists without one. */
+const SEATTLE_OPEN_DATA_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 SEATTLE_OPEN_DATA_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 SEATTLE_OPEN_DATA_PAYLOAD_SCHEMA = z.array(SEATTLE_OPEN_DATA_ENTRY_SCHEMA);
+/** Counts entries per category, most entries first, ties by name. */
+function countSeattleOpenDataCategories(entries) {
+    const counts = new Map();
+    for (const entry of entries) {
+        const category = entry.category ?? SEATTLE_OPEN_DATA_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 newestSeattleOpenDataEntry(entries) {
+    const first = entries[0];
+    if (first === undefined) {
+        throw new UsSourceParseError(SEATTLE_OPEN_DATA_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 Seattle 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 buildSeattleOpenDataCatalogueUrl(options) {
+    const params = new URLSearchParams({
+        limit: String(options?.limit ?? SEATTLE_OPEN_DATA_CATALOGUE_LIMIT),
+    });
+    return `${SEATTLE_OPEN_DATA_API_BASE}?${params.toString()}`;
+}
+/**
+ * Parses one page of the Seattle catalogue into the entries and topic 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 Seattle Socrata discovery API
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export function parseSeattleOpenDataCataloguePayload(payload) {
+    const parsed = SEATTLE_OPEN_DATA_PAYLOAD_SCHEMA.safeParse(payload);
+    if (!parsed.success) {
+        throw new UsSourceParseError(SEATTLE_OPEN_DATA_CATALOGUE_SOURCE_ID, parsed.error.message);
+    }
+    if (parsed.data.length === 0) {
+        throw new UsSourceParseError(SEATTLE_OPEN_DATA_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(SEATTLE_OPEN_DATA_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: newestSeattleOpenDataEntry(entries),
+        categories: countSeattleOpenDataCategories(entries),
+    };
+}
+/**
+ * Reads one page of the Seattle Open Data catalogue.
+ *
+ * One keyless request covers the page and reports what the city portal 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 fetchSeattleOpenDataCatalogue(options) {
+    const fetchImpl = options?.fetchImpl ?? globalThis.fetch;
+    const url = buildSeattleOpenDataCatalogueUrl(options?.limit === undefined ? {} : { limit: options.limit });
+    const response = await httpGet(SEATTLE_OPEN_DATA_CATALOGUE_SOURCE_ID, url, { fetchImpl });
+    return parseSeattleOpenDataCataloguePayload(await response.json());
+}
+/** Seattle Open Data catalogue of datasets, maps, charts, and stories, keyless. */
+export const seattleOpenDataCatalogueAdapter = {
+    id: SEATTLE_OPEN_DATA_CATALOGUE_SOURCE_ID,
+    name: 'Seattle Open Data catalogue',
+    auth: 'none',
+    description: 'The Seattle Open Data Socrata catalogue, one row per published dataset, map, chart, or story, with its city topic, view count, and download count.',
+    fetchLive: async (options) => fetchSeattleOpenDataCatalogue(options?.fetchImpl === undefined ? {} : { fetchImpl: options.fetchImpl }),
+    parse: (payload) => parseSeattleOpenDataCataloguePayload(payload),
+    loadFixture: () => parseSeattleOpenDataCataloguePayload(readFixtureJson(SEATTLE_OPEN_DATA_FIXTURE_FILENAME)),
+};
+//# sourceMappingURL=seattleOpenDataCatalogue.js.map

package/dist/seattleOpenDataCatalogue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seattleOpenDataCatalogue.js","sourceRoot":"","sources":["../src/seattleOpenDataCatalogue.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,6DAA6D;AAC7D,MAAM,CAAC,MAAM,qCAAqC,GAAG,6BAA6B,CAAC;AAEnF,4DAA4D;AAC5D,MAAM,CAAC,MAAM,0BAA0B,GAAG,yCAAyC,CAAC;AAEpF,oDAAoD;AACpD,MAAM,CAAC,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAkDpD,iFAAiF;AACjF,MAAM,kCAAkC,GAAG,6CAA6C,CAAC;AAEzF,qFAAqF;AACrF,MAAM,+BAA+B,GAAG,eAAe,CAAC;AAExD,4EAA4E;AAC5E,8DAA8D;AAC9D,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,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,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;AAEjF,qEAAqE;AACrE,SAAS,8BAA8B,CACrC,OAAwC;IAExC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,+BAA+B,CAAC;QACnE,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,0BAA0B,CACjC,OAAwC;IAExC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,kBAAkB,CAAC,qCAAqC,EAAE,yBAAyB,CAAC,CAAC;IACjG,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,gCAAgC,CAAC,OAA4B;IAC3E,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;QACjC,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,IAAI,iCAAiC,CAAC;KACnE,CAAC,CAAC;IACH,OAAO,GAAG,0BAA0B,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AAC9D,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,oCAAoC,CAAC,OAAgB;IACnE,MAAM,MAAM,GAAG,gCAAgC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACnE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,kBAAkB,CAAC,qCAAqC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5F,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,kBAAkB,CAC1B,qCAAqC,EACrC,iCAAiC,CAClC,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAoC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACvE,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,qCAAqC,EACrC,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,0BAA0B,CAAC,OAAO,CAAC;QAChD,UAAU,EAAE,8BAA8B,CAAC,OAAO,CAAC;KACpD,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAAC,OAGnD;IACC,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;IACzD,MAAM,GAAG,GAAG,gCAAgC,CAC1C,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,qCAAqC,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1F,OAAO,oCAAoC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;AACrE,CAAC;AAED,mFAAmF;AACnF,MAAM,CAAC,MAAM,+BAA+B,GAA4C;IACtF,EAAE,EAAE,qCAAqC;IACzC,IAAI,EAAE,6BAA6B;IACnC,IAAI,EAAE,MAAM;IACZ,WAAW,EACT,oJAAoJ;IACtJ,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,kCAAkC,CAAC,CAAC;CAC5F,CAAC"}

package/dist/socrataCatalogue.d.ts

@@ -0,0 +1,121 @@
+import type { UsDataAdapter } from './types.js';
+/** Default number of catalogue entries one request reads. */
+export declare const SOCRATA_CATALOGUE_LIMIT = 10;
+/** Category bucket used when a catalogue entry carries no category. */
+export declare const SOCRATA_UNCATEGORISED = "Uncategorised";
+/** One catalogue entry from a Socrata discovery API. */
+export interface SocrataCatalogueEntry {
+    /** Socrata four-by-four id, e.g. "p4pq-bxn9". */
+    id: string;
+    /** Human-readable title of the dataset, chart, story, map, or file. */
+    name: string;
+    /** What the entry is, e.g. "dataset", "chart", "story", "map", or "file". */
+    assetType: string;
+    /** Source topic the entry belongs to, or null when the catalogue lists none. */
+    category: string | null;
+    /** How the entry is rendered, e.g. "tabular" 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 text or URL the portal attaches, or "" when it supplies none. */
+    licenceUrl: string;
+    /** Publishing organisation the portal attaches, or "" when it supplies none. */
+    attribution: string;
+}
+/** One catalogue topic and how many entries carry it. */
+export interface SocrataCatalogueCategoryCount {
+    category: string;
+    entryCount: number;
+}
+/** One page of a Socrata catalogue, folded for a story. */
+export interface SocrataCatalogue {
+    /** One entry per catalogue item in the page. */
+    entries: SocrataCatalogueEntry[];
+    entryCount: number;
+    /** Entries whose asset type is "dataset". */
+    datasetCount: number;
+    /** Entry with the latest creation time. Ties go to the earlier list entry. */
+    newestEntry: SocrataCatalogueEntry;
+    /**
+     * Categories in the page, most entries first, ties broken by name. An entry
+     * the catalogue lists without a category is counted under the configured
+     * uncategorised label.
+     */
+    categories: SocrataCatalogueCategoryCount[];
+}
+/** Configuration for one Socrata catalogue source. */
+export interface SocrataCatalogueSource {
+    /** Adapter id, used in errors and the registry. */
+    sourceId: string;
+    /** Base URL of the Socrata discovery API, without the limit parameter. */
+    apiBase: string;
+    /** Default entry cap. Defaults to {@link SOCRATA_CATALOGUE_LIMIT}. */
+    limit?: number;
+    /** Category bucket for entries without a category. Defaults to "Uncategorised". */
+    uncategorisedLabel?: string;
+}
+/** Configuration for one Socrata catalogue adapter. */
+export interface SocrataCatalogueAdapterConfig extends SocrataCatalogueSource {
+    /** Human-readable source name. */
+    name: string;
+    /** What the adapter reads, in one sentence. */
+    description: string;
+    /** Filename inside src/fixtures for the committed snapshot. */
+    fixtureFilename: string;
+}
+/**
+ * Builds the request URL for one page of a Socrata catalogue.
+ *
+ * The endpoint is keyless. The service answers the whole catalogue by default,
+ * so the adapter asks for a short page unless the caller sets a cap.
+ *
+ * @param apiBase - the Socrata discovery API URL, without query parameters
+ * @param options - an optional entry cap
+ * @returns the full request URL
+ */
+export declare function buildSocrataCatalogueUrl(apiBase: string, options?: {
+    limit?: number;
+}): string;
+/**
+ * Parses one page of a Socrata catalogue into entries and topic 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 sourceId - adapter id used in parse errors
+ * @param payload - the JSON body from the Socrata discovery API
+ * @param options - an optional category label for entries without one
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export declare function parseSocrataCataloguePayload(sourceId: string, payload: unknown, options?: {
+    uncategorisedLabel?: string;
+}): SocrataCatalogue;
+/**
+ * Reads one page of a Socrata catalogue.
+ *
+ * One keyless request covers the page and reports what the portal holds,
+ * without reading any dataset's rows.
+ *
+ * @param source - source id, API base, and optional defaults
+ * @param options - an optional entry cap and fetch stub
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export declare function fetchSocrataCatalogue(source: SocrataCatalogueSource, options?: {
+    limit?: number;
+    fetchImpl?: typeof globalThis.fetch;
+}): Promise<SocrataCatalogue>;
+/**
+ * Creates an adapter around one Socrata catalogue endpoint.
+ *
+ * @param config - source id, endpoint, fixture, and the text the API shows
+ * @returns an adapter that fetches, parses, and loads the committed snapshot
+ */
+export declare function createSocrataCatalogueAdapter(config: SocrataCatalogueAdapterConfig): UsDataAdapter<SocrataCatalogue>;
+//# sourceMappingURL=socrataCatalogue.d.ts.map

package/dist/socrataCatalogue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socrataCatalogue.d.ts","sourceRoot":"","sources":["../src/socrataCatalogue.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,6DAA6D;AAC7D,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAE1C,uEAAuE;AACvE,eAAO,MAAM,qBAAqB,kBAAkB,CAAC;AAErD,wDAAwD;AACxD,MAAM,WAAW,qBAAqB;IACpC,iDAAiD;IACjD,EAAE,EAAE,MAAM,CAAC;IACX,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,SAAS,EAAE,MAAM,CAAC;IAClB,gFAAgF;IAChF,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,4DAA4D;IAC5D,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,4EAA4E;IAC5E,UAAU,EAAE,MAAM,CAAC;IACnB,gFAAgF;IAChF,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,yDAAyD;AACzD,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,2DAA2D;AAC3D,MAAM,WAAW,gBAAgB;IAC/B,gDAAgD;IAChD,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,8EAA8E;IAC9E,WAAW,EAAE,qBAAqB,CAAC;IACnC;;;;OAIG;IACH,UAAU,EAAE,6BAA6B,EAAE,CAAC;CAC7C;AAED,sDAAsD;AACtD,MAAM,WAAW,sBAAsB;IACrC,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mFAAmF;IACnF,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,uDAAuD;AACvD,MAAM,WAAW,6BAA8B,SAAQ,sBAAsB;IAC3E,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,+DAA+D;IAC/D,eAAe,EAAE,MAAM,CAAC;CACzB;AAmDD;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAK9F;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE;IAAE,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAAE,GACxC,gBAAgB,CAwClB;AAED;;;;;;;;;GASG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;CAAE,GAChE,OAAO,CAAC,gBAAgB,CAAC,CAU3B;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,6BAA6B,GACpC,aAAa,CAAC,gBAAgB,CAAC,CAoCjC"}

package/dist/socrataCatalogue.js

@@ -0,0 +1,151 @@
+import { z } from 'zod';
+import { UsSourceParseError } from './errors.js';
+import { readFixtureJson } from './fixtures.js';
+import { httpGet } from './http.js';
+import { parseSocrataCatalogueMetadata } from './socrataCatalogueMetadata.js';
+/** Default number of catalogue entries one request reads. */
+export const SOCRATA_CATALOGUE_LIMIT = 10;
+/** Category bucket used when a catalogue entry carries no category. */
+export const 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 SOCRATA_CATALOGUE_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 SOCRATA_CATALOGUE_PAYLOAD_SCHEMA = z.array(SOCRATA_CATALOGUE_ENTRY_SCHEMA);
+/** Counts entries per category, most entries first, ties by name. */
+function countSocrataCategories(entries, uncategorisedLabel) {
+    const counts = new Map();
+    for (const entry of entries) {
+        const category = entry.category ?? uncategorisedLabel;
+        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 newestSocrataEntry(sourceId, entries) {
+    const first = entries[0];
+    if (first === undefined) {
+        throw new UsSourceParseError(sourceId, 'No entries to summarise');
+    }
+    return entries.reduce((best, entry) => (entry.createdAtEpochSeconds > best.createdAtEpochSeconds ? entry : best), first);
+}
+/**
+ * Builds the request URL for one page of a Socrata catalogue.
+ *
+ * The endpoint is keyless. The service answers the whole catalogue by default,
+ * so the adapter asks for a short page unless the caller sets a cap.
+ *
+ * @param apiBase - the Socrata discovery API URL, without query parameters
+ * @param options - an optional entry cap
+ * @returns the full request URL
+ */
+export function buildSocrataCatalogueUrl(apiBase, options) {
+    const params = new URLSearchParams({
+        limit: String(options?.limit ?? SOCRATA_CATALOGUE_LIMIT),
+    });
+    return `${apiBase}?${params.toString()}`;
+}
+/**
+ * Parses one page of a Socrata catalogue into entries and topic 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 sourceId - adapter id used in parse errors
+ * @param payload - the JSON body from the Socrata discovery API
+ * @param options - an optional category label for entries without one
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export function parseSocrataCataloguePayload(sourceId, payload, options) {
+    const parsed = SOCRATA_CATALOGUE_PAYLOAD_SCHEMA.safeParse(payload);
+    if (!parsed.success) {
+        throw new UsSourceParseError(sourceId, parsed.error.message);
+    }
+    if (parsed.data.length === 0) {
+        throw new UsSourceParseError(sourceId, 'The response carried no entries');
+    }
+    const entries = parsed.data.map((row) => {
+        if (row.id === undefined || row.name === undefined || row.createdAt === undefined) {
+            throw new UsSourceParseError(sourceId, '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: newestSocrataEntry(sourceId, entries),
+        categories: countSocrataCategories(entries, options?.uncategorisedLabel ?? SOCRATA_UNCATEGORISED),
+    };
+}
+/**
+ * Reads one page of a Socrata catalogue.
+ *
+ * One keyless request covers the page and reports what the portal holds,
+ * without reading any dataset's rows.
+ *
+ * @param source - source id, API base, and optional defaults
+ * @param options - an optional entry cap and fetch stub
+ * @returns the entries in the page, the counts, and the newest entry
+ */
+export async function fetchSocrataCatalogue(source, options) {
+    const fetchImpl = options?.fetchImpl ?? globalThis.fetch;
+    const limit = options?.limit ?? source.limit;
+    const url = buildSocrataCatalogueUrl(source.apiBase, limit === undefined ? {} : { limit });
+    const response = await httpGet(source.sourceId, url, { fetchImpl });
+    return parseSocrataCataloguePayload(source.sourceId, await response.json(), source.uncategorisedLabel === undefined ? {} : { uncategorisedLabel: source.uncategorisedLabel });
+}
+/**
+ * Creates an adapter around one Socrata catalogue endpoint.
+ *
+ * @param config - source id, endpoint, fixture, and the text the API shows
+ * @returns an adapter that fetches, parses, and loads the committed snapshot
+ */
+export function createSocrataCatalogueAdapter(config) {
+    const source = {
+        sourceId: config.sourceId,
+        apiBase: config.apiBase,
+        ...(config.limit === undefined ? {} : { limit: config.limit }),
+        ...(config.uncategorisedLabel === undefined
+            ? {}
+            : { uncategorisedLabel: config.uncategorisedLabel }),
+    };
+    return {
+        id: config.sourceId,
+        name: config.name,
+        auth: 'none',
+        description: config.description,
+        fetchLive: async (options) => fetchSocrataCatalogue(source, options?.fetchImpl === undefined ? {} : { fetchImpl: options.fetchImpl }),
+        parse: (payload) => parseSocrataCataloguePayload(source.sourceId, payload, source.uncategorisedLabel === undefined
+            ? {}
+            : { uncategorisedLabel: source.uncategorisedLabel }),
+        loadFixture: () => parseSocrataCataloguePayload(source.sourceId, readFixtureJson(config.fixtureFilename), source.uncategorisedLabel === undefined
+            ? {}
+            : { uncategorisedLabel: source.uncategorisedLabel }),
+    };
+}
+//# sourceMappingURL=socrataCatalogue.js.map

package/dist/socrataCatalogue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"socrataCatalogue.js","sourceRoot":"","sources":["../src/socrataCatalogue.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,6DAA6D;AAC7D,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAE1C,uEAAuE;AACvE,MAAM,CAAC,MAAM,qBAAqB,GAAG,eAAe,CAAC;AAyErD,4EAA4E;AAC5E,8DAA8D;AAC9D,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,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,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;AAEjF,qEAAqE;AACrE,SAAS,sBAAsB,CAC7B,OAAgC,EAChC,kBAA0B;IAE1B,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,kBAAkB,CAAC;QACtD,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,kBAAkB,CACzB,QAAgB,EAChB,OAAgC;IAEhC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,kBAAkB,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;IACpE,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;;;;;;;;;GASG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAe,EAAE,OAA4B;IACpF,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;QACjC,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,IAAI,uBAAuB,CAAC;KACzD,CAAC,CAAC;IACH,OAAO,GAAG,OAAO,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AAC3C,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,4BAA4B,CAC1C,QAAgB,EAChB,OAAgB,EAChB,OAAyC;IAEzC,MAAM,MAAM,GAAG,gCAAgC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACnE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,kBAAkB,CAAC,QAAQ,EAAE,iCAAiC,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,OAAO,GAA4B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC/D,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,QAAQ,EACR,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,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC;QAClD,UAAU,EAAE,sBAAsB,CAChC,OAAO,EACP,OAAO,EAAE,kBAAkB,IAAI,qBAAqB,CACrD;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,MAA8B,EAC9B,OAAiE;IAEjE,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;IACzD,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC;IAC7C,MAAM,GAAG,GAAG,wBAAwB,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC3F,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IACpE,OAAO,4BAA4B,CACjC,MAAM,CAAC,QAAQ,EACf,MAAM,QAAQ,CAAC,IAAI,EAAE,EACrB,MAAM,CAAC,kBAAkB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,EAAE,CACjG,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAC3C,MAAqC;IAErC,MAAM,MAAM,GAA2B;QACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;QAC9D,GAAG,CAAC,MAAM,CAAC,kBAAkB,KAAK,SAAS;YACzC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,EAAE,CAAC;KACvD,CAAC;IACF,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,QAAQ;QACnB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAC3B,qBAAqB,CACnB,MAAM,EACN,OAAO,EAAE,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CACzE;QACH,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CACjB,4BAA4B,CAC1B,MAAM,CAAC,QAAQ,EACf,OAAO,EACP,MAAM,CAAC,kBAAkB,KAAK,SAAS;YACrC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,EAAE,CACtD;QACH,WAAW,EAAE,GAAG,EAAE,CAChB,4BAA4B,CAC1B,MAAM,CAAC,QAAQ,EACf,eAAe,CAAC,MAAM,CAAC,eAAe,CAAC,EACvC,MAAM,CAAC,kBAAkB,KAAK,SAAS;YACrC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,EAAE,CACtD;KACJ,CAAC;AACJ,CAAC"}

package/dist/socrataCatalogueMetadata.d.ts

@@ -0,0 +1,19 @@
+/** Source-supplied licence and attribution metadata for one Socrata entry. */
+export interface SocrataCatalogueMetadata {
+    /** 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;
+}
+/**
+ * Reads the licence and attribution values Socrata attaches to a catalogue entry.
+ *
+ * Portals use "Common Core" for older entries and "Common Core 3" for newer
+ * ones. A missing or malformed block returns empty strings, because the portal
+ * did not supply the value rather than the adapter knowing better.
+ *
+ * @param metadata - the entry's Socrata metadata block
+ * @returns the source-supplied licence URL and publisher
+ */
+export declare function parseSocrataCatalogueMetadata(metadata: unknown): SocrataCatalogueMetadata;
+//# sourceMappingURL=socrataCatalogueMetadata.d.ts.map