ochre-sdk 1.0.78 → 1.1.0

package/dist/parsers/website/bounds.mjs

@@ -0,0 +1,28 @@
+//#region src/parsers/website/bounds.ts
+/**
+* Parses raw bounds data into a standardized bounds structure
+*
+* @param bounds - Raw bounds data in OCHRE format
+* @returns Parsed bounds object
+* @internal
+*/
+function parseBounds(bounds) {
+	const [southWest, northEast] = bounds.trimStart().startsWith("[") ? parseJsonBounds(bounds) : bounds.split(";").map((pair) => pair.split(",").map((coordinate) => Number(coordinate.trim())));
+	if (southWest?.length !== 2 || northEast?.length !== 2 || southWest.some((coordinate) => Number.isNaN(coordinate)) || northEast.some((coordinate) => Number.isNaN(coordinate))) throw new Error(`Invalid bounds: ${bounds}`, { cause: bounds });
+	return [[southWest[0], southWest[1]], [northEast[0], northEast[1]]];
+}
+function parseJsonBounds(bounds) {
+	let parsed;
+	try {
+		parsed = JSON.parse(bounds);
+	} catch {
+		throw new Error(`Invalid bounds: ${bounds}`, { cause: bounds });
+	}
+	if (!isNumberPairArray(parsed)) throw new Error(`Invalid bounds: ${bounds}`, { cause: bounds });
+	return parsed;
+}
+function isNumberPairArray(value) {
+	return Array.isArray(value) && value.every((pair) => Array.isArray(pair) && pair.every((coordinate) => typeof coordinate === "number"));
+}
+//#endregion
+export { parseBounds };

package/dist/parsers/website/components.d.mts

@@ -0,0 +1,91 @@
+import { WebElement, WebElementComponent, WebTitle } from "../../types/website.mjs";
+import { Identification, ItemLinks, SimplifiedProperty } from "../../types/index.mjs";
+import { XMLWebsiteResource } from "../../xml/types.mjs";
+import { ParserOptions } from "../helpers.mjs";
+import { WebsitePresentationReader } from "./reader.mjs";
+import { WebsitePageSlugs } from "./slug.mjs";
+//#region src/parsers/website/components.d.ts
+/**
+ * What every component parser is handed
+ *
+ * `pageSlugs` is the only thing the component, element and block parsers read
+ * from the enclosing website, so it is passed on its own rather than as part
+ * of a wider parse context. That keeps this module reachable from a test with
+ * a six-field object instead of a whole OCHRE website envelope.
+ */
+export type WebElementComponentParameters<T extends ReadonlyArray<string>> = {
+  componentProperty: SimplifiedProperty<T>;
+  componentReader: WebsitePresentationReader<T>;
+  elementResource: XMLWebsiteResource;
+  websiteLinks: ItemLinks<T>;
+  options: ParserOptions<T>;
+  pageSlugs: WebsitePageSlugs | undefined;
+};
+declare function parse3dViewerComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseAdvancedSearchComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseAnnotatedDocumentComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseAnnotatedImageComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseAudioPlayerComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseBibliographyComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseButtonComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseCollectionComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseEmptySpaceComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseEntriesComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseIframeComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseIiifViewerComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseImageComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseImageGalleryComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseMapComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseQueryComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseTableComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseSearchBarComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseTextComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseTimelineComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+declare function parseVideoComponent<T extends ReadonlyArray<string>>(parameters: WebElementComponentParameters<T>): WebElementComponent<T>;
+/**
+ * Parses raw web element properties into a standardized WebElementComponent structure
+ *
+ * @param componentProperty - Raw component property data in OCHRE format
+ * @param elementResource - Raw element resource data in OCHRE format
+ * @returns Parsed WebElementComponent object
+ */
+/**
+ * The parser for each web element component, keyed by its OCHRE component name
+ *
+ * Every component parser takes the same {@link WebElementComponentParameters}
+ * bag, so this is a table rather than a `switch`: a missing component is a type
+ * error here instead of a runtime throw, and each parser can be exercised on
+ * its own.
+ */
+export declare const WEB_ELEMENT_COMPONENT_PARSERS: {
+  readonly "3d-viewer": typeof parse3dViewerComponent;
+  readonly "advanced-search": typeof parseAdvancedSearchComponent;
+  readonly "annotated-document": typeof parseAnnotatedDocumentComponent;
+  readonly "annotated-image": typeof parseAnnotatedImageComponent;
+  readonly "audio-player": typeof parseAudioPlayerComponent;
+  readonly bibliography: typeof parseBibliographyComponent;
+  readonly button: typeof parseButtonComponent;
+  readonly collection: typeof parseCollectionComponent;
+  readonly "empty-space": typeof parseEmptySpaceComponent;
+  readonly entries: typeof parseEntriesComponent;
+  readonly iframe: typeof parseIframeComponent;
+  readonly "iiif-viewer": typeof parseIiifViewerComponent;
+  readonly image: typeof parseImageComponent;
+  readonly "image-gallery": typeof parseImageGalleryComponent;
+  readonly map: typeof parseMapComponent;
+  readonly query: typeof parseQueryComponent;
+  readonly table: typeof parseTableComponent;
+  readonly "search-bar": typeof parseSearchBarComponent;
+  readonly text: typeof parseTextComponent;
+  readonly timeline: typeof parseTimelineComponent;
+  readonly video: typeof parseVideoComponent;
+};
+export declare function parseWebTitle<T extends ReadonlyArray<string>>(properties: Array<SimplifiedProperty<T>>, identification: Identification<T>, overrides?: Partial<WebTitle<T>["properties"]>): WebTitle<T>;
+/**
+ * Parses raw web element data into a standardized WebElement structure
+ *
+ * @param elementResource - Raw element resource data in OCHRE format
+ * @returns Parsed WebElement object
+ */
+export declare function parseWebElement<T extends ReadonlyArray<string>>(elementResource: XMLWebsiteResource, options: ParserOptions<T>, pageSlugs: WebsitePageSlugs | undefined): WebElement<T>;
+//#endregion