ochre-sdk 1.3.13 → 1.3.14

package/dist/reflection.mjs

@@ -1,4 +1,4 @@
-//#region src/reflection.ts
+// src/reflection.ts
 /**
 * Reading values whose shape is not known at compile time
 *
@@ -75,5 +75,4 @@ function readStringProperty(value, key) {
 	const property = readProperty(value, key);
 	return typeof property === "string" ? property : null;
 }
-//#endregion
 export { isObject, readArrayProperty, readEntries, readProperty, readStringProperty };

package/dist/schemas.d.mts

@@ -1,6 +1,5 @@
 import { Query } from "./types/index.mjs";
 import * as v from "valibot";
-//#region src/schemas.d.ts
 /**
  * Validates a pseudo-UUID string
  * @param value - The string to validate
@@ -147,5 +146,4 @@ export declare const treeItemsParametersSchema: v.ObjectSchema<{
   readonly page: v.OptionalSchema<v.GenericSchema<unknown, number>, 1>;
   readonly pageSize: v.OptionalSchema<v.GenericSchema<unknown, number>, 48>;
   readonly treeScopeUuids: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>, undefined>, v.MinLengthAction<string[], 1, "At least one tree scope UUID is required">]>;
-}, undefined>;
-//#endregion
+}, undefined>;

package/dist/schemas.mjs

@@ -1,7 +1,7 @@
 import "./constants.mjs";
 import { getOchreLanguageCode, isOchreLanguageCode } from "./languages.mjs";
 import * as v from "valibot";
-//#region src/schemas.ts
+// src/schemas.ts
 const PSEUDO_UUID_REGEX = /^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$/i;
 /**
 * Validates a pseudo-UUID string
@@ -290,5 +290,4 @@ const treeItemsParametersSchema = v.object({
 	treeScopeUuids: v.pipe(v.array(uuidSchema), v.minLength(1, "At least one tree scope UUID is required")),
 	...containerItemsParametersEntries
 });
-//#endregion
 export { componentSchema, gallerySchema, isPseudoUuid, itemLocationsParametersSchema, itemOcrDataParametersSchema, ochreLanguageCodeSchema, renderOptionsSchema, setItemsParametersSchema, setPropertyValuesParametersSchema, treeItemsParametersSchema, uuidSchema };

package/dist/types/index.d.mts

@@ -1,7 +1,6 @@
 import { MultilingualString } from "../parsers/multilingual.mjs";
 import { Prettify } from "./utilities.mjs";
 import { Style, Webpage } from "./website.mjs";
-//#region src/types/index.d.ts
 /**
  * Language-code tuple or array used by OCHRE multilingual fields.
  *
@@ -226,6 +225,14 @@ export type Image<T extends LanguageCodes = LanguageCodes> = {
   fileSize: number | null;
   base64: string | null;
 };
+/**
+ *  Download option of an item in OCHRE
+ */
+export type DownloadOption = {
+  type: "highQualityImage" | "iiifManifest" | "document" | "ocr";
+  href: string;
+  fileFormat: string;
+};
 /**
  *  Area of an image map in OCHRE
  */
@@ -652,6 +659,7 @@ export type Bibliography<T extends LanguageCodes = LanguageCodes, U extends Item
   citationFormatSpan: string | null;
   referenceFormatDiv: string | null;
   image: Image<T> | null;
+  downloadOptions: Array<DownloadOption>;
   sourceDocument: BibliographySourceDocument | null;
   publicationInfo: {
     publishers: Array<Person<T, "embedded">>;
@@ -723,6 +731,7 @@ export type Observation<T extends LanguageCodes = LanguageCodes> = {
   periods: Array<Period<T, "embedded">>;
   links: ItemLinks<T>;
   reverseLinks: ItemLinks<T>;
+  downloadOptions: Array<DownloadOption>;
   notes: Array<Note<T>>;
   properties: Array<Property<T>>;
   bibliographies: Array<Bibliography<T, "embedded">>;
@@ -764,6 +773,7 @@ export type Resource<T extends LanguageCodes = LanguageCodes, U extends ItemPayl
   image: Image<T> | null;
   document: MultilingualString<T> | null;
   imageMap: ImageMap | null;
+  downloadOptions: Array<DownloadOption>;
   coordinates: Array<Coordinates<T>>;
   periods: Array<Period<T, "embedded">>;
   links: ItemLinks<T>;
@@ -1015,5 +1025,4 @@ export type ItemProperty<T extends LanguageCodes = LanguageCodes> = Property<T>
  */
 export type RecursiveItemCategory = Exclude<ItemCategory, "tree" | "person" | "propertyVariable" | "propertyValue" | "set">;
 export type TopLevelItem<U extends ItemCategory = ItemCategory, V extends ContainedItemCategory<U> = ContainedItemCategory<U>, T extends LanguageCodes = LanguageCodes> = Item<U, V, T, "topLevel">;
-//#endregion
 export {};

package/dist/types/utilities.d.mts

@@ -1,9 +1,7 @@
-//#region src/types/utilities.d.ts
 /**
  * Flatten an intersection so editors show one object instead of `A & B`
  *
  * Deliberately not re-exported from the package root: it is a TypeScript
  * presentation detail, not part of the OCHRE model.
  */
-export type Prettify<T> = { [K in keyof T]: T[K]; } & {};
-//#endregion
+export type Prettify<T> = { [K in keyof T]: T[K]; } & {};

package/dist/types/website.d.mts

@@ -1,7 +1,6 @@
 import { MultilingualString } from "../parsers/multilingual.mjs";
 import { Prettify } from "./utilities.mjs";
 import { Bibliography, Identification, ItemCategory, LanguageCodes, License, Metadata, Person, QueryablePropertyValueDataType } from "./index.mjs";
-//#region src/types/website.d.ts
 /**
  * Represents a context tree level item with a variable and value
  */
@@ -579,5 +578,4 @@ export type AccordionWebBlock<T extends LanguageCodes = LanguageCodes> = WebBloc
 /**
  * Represents a stylesheet item with its UUID and category
  */
-export type StylesheetCategory = Extract<ItemCategory, "propertyVariable" | "propertyValue">;
-//#endregion
+export type StylesheetCategory = Extract<ItemCategory, "propertyVariable" | "propertyValue">;

package/dist/xml/dates.d.mts

@@ -1,4 +1,3 @@
-//#region src/xml/dates.d.ts
 /**
  * Parses ISO date/time strings and OCHRE's "YYYY-MM-DD HH:mm:ss" format.
  * Like date-fns parseISO: strings without a timezone offset (including
@@ -9,5 +8,4 @@
  * @returns A Date object representing the parsed date/time, or an Invalid Date if parsing fails.
  * @internal
  */
-export declare function parseDateTime(value: string): Date;
-//#endregion
+export declare function parseDateTime(value: string): Date;

package/dist/xml/dates.mjs

@@ -1,4 +1,4 @@
-//#region src/xml/dates.ts
+// src/xml/dates.ts
 /**
 * Regular expression to match ISO date/time strings and OCHRE's "YYYY-MM-DD HH:mm:ss" format.
 */
@@ -45,5 +45,4 @@ function parseDateTime(value) {
 	if (timezone == null || timezone === "Z") return date;
 	return applyTimezoneOffset(date, timezone);
 }
-//#endregion
 export { parseDateTime };

package/dist/xml/metadata.d.mts

@@ -1,4 +1,3 @@
-//#region src/xml/metadata.d.ts
 /**
  * Read the offset a node started at in the source XML
  * @param value - The parsed node
@@ -16,5 +15,4 @@ export declare function getXMLSourceIndex(value: unknown): number | null;
  * @param input - The raw parsed input to read metadata from
  * @internal
  */
-export declare function restoreXMLMetadata(output: unknown, input: unknown): void;
-//#endregion
+export declare function restoreXMLMetadata(output: unknown, input: unknown): void;

package/dist/xml/metadata.mjs

@@ -1,6 +1,6 @@
 import { isObject, readEntries, readProperty } from "../reflection.mjs";
 import { XMLParser } from "fast-xml-parser";
-//#region src/xml/metadata.ts
+// src/xml/metadata.ts
 const XML_METADATA_SYMBOL = XMLParser.getMetaDataSymbol();
 /**
 * Read the source metadata `fast-xml-parser` attaches under a symbol key
@@ -47,5 +47,4 @@ function restoreXMLMetadata(output, input) {
 	}
 	for (const [key, outputValue] of readEntries(output)) restoreXMLMetadata(outputValue, readProperty(input, key));
 }
-//#endregion
 export { getXMLSourceIndex, restoreXMLMetadata };

package/dist/xml/schemas.d.mts

@@ -1,6 +1,5 @@
 import { XMLBibliography, XMLData as XMLData$1, XMLDataItem as XMLDataItem$1, XMLItemLinksData as XMLItemLinksData$1, XMLLink as XMLLink$1, XMLPeriod, XMLPerson, XMLProperty, XMLResource, XMLSetItemsData as XMLSetItemsData$1, XMLString, XMLWebsiteResource, XMLWebsiteResourceItem } from "./types.mjs";
 import * as v from "valibot";
-//#region src/xml/schemas.d.ts
 export declare const XMLLink: v.GenericSchema<unknown, XMLLink$1>;
 export declare const XMLDataItem: v.GenericSchema<unknown, XMLDataItem$1>;
 export declare const XMLItemLinksData: v.GenericSchema<unknown, XMLItemLinksData$1>;
@@ -448,6 +447,13 @@ export declare const XMLGalleryData: v.ObjectSchema<{
               whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
             }, "XMLString: Shape error">], undefined>, v.CheckAction<string | XMLString, "XMLNumber: string is not a number">, v.TransformAction<string | XMLString, number>]>;
           }, "XMLImageMap: Shape error">, undefined>;
+          readonly downloadOptions: v.OptionalSchema<v.ObjectSchema<{
+            readonly option: v.ArraySchema<v.ObjectSchema<{
+              readonly type: v.PicklistSchema<["highQualityImage", "iiifManifest", "document", "ocr"], "XMLDownloadOptions: type is highQualityImage, iiifManifest, document, or ocr">;
+              readonly href: v.SchemaWithPipe<readonly [v.StringSchema<"XMLDownloadOptions: href is string and required">, v.UrlAction<string, "XMLDownloadOptions: href is not a valid URL">]>;
+              readonly fileFormat: v.StringSchema<"XMLDownloadOptions: fileFormat is string and required">;
+            }, "XMLDownloadOptions: option is object with type, href, and fileFormat">, undefined>;
+          }, "XMLDownloadOptions: Shape error">, undefined>;
           readonly document: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.ObjectSchema<{
             readonly content: v.ArraySchema<v.ObjectSchema<{
               readonly links: v.OptionalSchema<v.LazySchema<v.GenericSchema<unknown, XMLLink$1>>, undefined>;
@@ -1645,6 +1651,13 @@ export declare const XMLGalleryData: v.ObjectSchema<{
                     }, "XMLString: Shape error">], undefined>, v.CheckAction<string | XMLString, "XMLNumber: string is not a number">, v.TransformAction<string | XMLString, number | undefined>]>, undefined>;
                     readonly payload: v.OptionalSchema<v.StringSchema<"XMLImage: payload is string and optional">, undefined>;
                   }, "XMLImage: Shape error">, undefined>;
+                  readonly downloadOptions: v.OptionalSchema<v.ObjectSchema<{
+                    readonly option: v.ArraySchema<v.ObjectSchema<{
+                      readonly type: v.PicklistSchema<["highQualityImage", "iiifManifest", "document", "ocr"], "XMLDownloadOptions: type is highQualityImage, iiifManifest, document, or ocr">;
+                      readonly href: v.SchemaWithPipe<readonly [v.StringSchema<"XMLDownloadOptions: href is string and required">, v.UrlAction<string, "XMLDownloadOptions: href is not a valid URL">]>;
+                      readonly fileFormat: v.StringSchema<"XMLDownloadOptions: fileFormat is string and required">;
+                    }, "XMLDownloadOptions: option is object with type, href, and fileFormat">, undefined>;
+                  }, "XMLDownloadOptions: Shape error">, undefined>;
                   readonly publicationInfo: v.OptionalSchema<v.ObjectSchema<{
                     readonly publishers: v.OptionalSchema<v.UnionSchema<[v.ObjectSchema<{
                       readonly publisher: v.ArraySchema<v.LazySchema<v.GenericSchema<unknown, XMLPerson>>, undefined>;
@@ -2982,6 +2995,13 @@ export declare const XMLGalleryData: v.ObjectSchema<{
                 }, "XMLString: Shape error">], undefined>, v.CheckAction<string | XMLString, "XMLNumber: string is not a number">, v.TransformAction<string | XMLString, number | undefined>]>, undefined>;
                 readonly payload: v.OptionalSchema<v.StringSchema<"XMLImage: payload is string and optional">, undefined>;
               }, "XMLImage: Shape error">, undefined>;
+              readonly downloadOptions: v.OptionalSchema<v.ObjectSchema<{
+                readonly option: v.ArraySchema<v.ObjectSchema<{
+                  readonly type: v.PicklistSchema<["highQualityImage", "iiifManifest", "document", "ocr"], "XMLDownloadOptions: type is highQualityImage, iiifManifest, document, or ocr">;
+                  readonly href: v.SchemaWithPipe<readonly [v.StringSchema<"XMLDownloadOptions: href is string and required">, v.UrlAction<string, "XMLDownloadOptions: href is not a valid URL">]>;
+                  readonly fileFormat: v.StringSchema<"XMLDownloadOptions: fileFormat is string and required">;
+                }, "XMLDownloadOptions: option is object with type, href, and fileFormat">, undefined>;
+              }, "XMLDownloadOptions: Shape error">, undefined>;
               readonly publicationInfo: v.OptionalSchema<v.ObjectSchema<{
                 readonly publishers: v.OptionalSchema<v.UnionSchema<[v.ObjectSchema<{
                   readonly publisher: v.ArraySchema<v.LazySchema<v.GenericSchema<unknown, XMLPerson>>, undefined>;
@@ -7784,5 +7804,4 @@ export declare const XMLWebsiteData: v.ObjectSchema<{
       }, undefined>, undefined>;
     }, "XMLWebsiteData: ochre is object with website tree">;
   }, "XMLWebsiteData: result is object with ochre">;
-}, "XMLWebsiteData: Shape error">;
-//#endregion
+}, "XMLWebsiteData: Shape error">;

package/dist/xml/schemas.mjs

@@ -2,7 +2,7 @@ import { readArrayProperty } from "../reflection.mjs";
 import { isPseudoUuid } from "../schemas.mjs";
 import { parseDateTime } from "./dates.mjs";
 import * as v from "valibot";
-//#region src/xml/schemas.ts
+// src/xml/schemas.ts
 function getXMLStringPayload(value) {
 	return typeof value === "string" ? value : value.payload ?? null;
 }
@@ -221,6 +221,16 @@ const XMLImage = v.object({
 	fileSize: XMLOptionalNumber,
 	payload: v.optional(v.string("XMLImage: payload is string and optional"))
 }, "XMLImage: Shape error");
+const XMLDownloadOptions = v.object({ option: v.array(v.object({
+	type: v.picklist([
+		"highQualityImage",
+		"iiifManifest",
+		"document",
+		"ocr"
+	], "XMLDownloadOptions: type is highQualityImage, iiifManifest, document, or ocr"),
+	href: v.pipe(v.string("XMLDownloadOptions: href is string and required"), v.url("XMLDownloadOptions: href is not a valid URL")),
+	fileFormat: v.string("XMLDownloadOptions: fileFormat is string and required")
+}, "XMLDownloadOptions: option is object with type, href, and fileFormat")) }, "XMLDownloadOptions: Shape error");
 const XMLImageMapArea = v.object({
 	uuid: v.pipe(v.string("XMLImageMapArea: uuid is string and required"), v.check(isPseudoUuid, "XMLImageMapArea: uuid is not a valid pseudo-UUID")),
 	publicationDateTime: v.optional(customDateTime("XMLImageMapArea: publicationDateTime is not a valid datetime")),
@@ -487,6 +497,7 @@ const XMLBibliography = v.object({
 		publicationDateTime: v.optional(customDateTime("XMLBibliography: publicationDateTime is not a valid datetime"))
 	}, "XMLBibliography: sourceDocument is object with uuid and payload")),
 	image: v.optional(XMLImage),
+	downloadOptions: v.optional(XMLDownloadOptions),
 	publicationInfo: v.optional(v.object({
 		publishers: v.optional(v.union([v.object({ publisher: v.array(v.lazy(() => XMLPerson)) }), v.object({ publishers: v.object({ person: v.array(v.lazy(() => XMLPerson)) }) })])),
 		startDate: v.optional(v.object({
@@ -556,6 +567,7 @@ const XMLObservation = v.object({
 		v.lazy(() => XMLDataItem),
 		v.array(v.union([v.lazy(() => XMLLink), v.lazy(() => XMLDataItem)]))
 	])),
+	downloadOptions: v.optional(XMLDownloadOptions),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	bibliographies: v.optional(v.object({ bibliography: v.array(XMLBibliography) }))
@@ -647,6 +659,7 @@ const XMLResource = v.object({
 	width: XMLOptionalNumber,
 	image: v.optional(XMLImage),
 	imagemap: v.optional(XMLImageMap),
+	downloadOptions: v.optional(XMLDownloadOptions),
 	document: XMLOptionalContent,
 	coordinates: v.optional(XMLCoordinates),
 	periods: v.optional(v.object({ period: v.array(XMLPeriod) })),
@@ -982,5 +995,4 @@ const XMLWebsiteData = v.object({ result: v.object({ ochre: v.object({
 	tree: v.array(XMLWebsiteTree),
 	styleLabels: v.optional(v.object({ styleLabel: v.optional(v.array(v.intersect([v.object({ valueUuid: v.string("XMLWebsiteData: styleLabel valueUuid is string and required") }, "XMLWebsiteData: styleLabel is object with valueUuid"), XMLContent]))) }))
 }, "XMLWebsiteData: ochre is object with website tree") }, "XMLWebsiteData: result is object with ochre") }, "XMLWebsiteData: Shape error");
-//#endregion
 export { XMLData, XMLDataItem, XMLGalleryData, XMLItemLinksData, XMLItemLocationsData, XMLLink, XMLMapSourcesData, XMLSetItemsData, XMLWebsiteData };

package/dist/xml/types.d.mts

@@ -1,4 +1,3 @@
-//#region src/xml/types.d.ts
 export type XMLItemCategory = "tree" | "bibliography" | "spatialUnit" | "concept" | "period" | "person" | "propertyVariable" | "variable" | "propertyValue" | "value" | "text" | "resource" | "set";
 export type XMLRecursiveItemCategory = Exclude<XMLItemCategory, "tree" | "person" | "propertyVariable" | "propertyValue" | "set">;
 /**
@@ -167,6 +166,13 @@ export type XMLImage = {
   fileSize?: number;
   payload?: string;
 };
+export type XMLDownloadOptions = {
+  option: Array<{
+    type: "highQualityImage" | "iiifManifest" | "document" | "ocr";
+    href: string;
+    fileFormat: string;
+  }>;
+};
 export type XMLImageMapArea = {
   uuid: string;
   publicationDateTime?: Date;
@@ -256,6 +262,7 @@ export type XMLBibliography = Partial<XMLBaseItem> & {
     publicationDateTime?: Date;
   };
   image?: XMLImage;
+  downloadOptions?: XMLDownloadOptions;
   publicationInfo?: {
     publishers?: {
       publisher: Array<XMLPerson>;
@@ -434,6 +441,7 @@ export type XMLObservation = {
   };
   links?: XMLLink;
   reverseLinks?: XMLLink | XMLDataItem | Array<XMLLink | XMLDataItem>;
+  downloadOptions?: XMLDownloadOptions;
   notes?: {
     note: Array<XMLNote>;
   };
@@ -546,6 +554,7 @@ export type XMLResource = XMLBaseItem & {
   width?: number;
   image?: XMLImage;
   imagemap?: XMLImageMap;
+  downloadOptions?: XMLDownloadOptions;
   document?: XMLContent;
   coordinates?: XMLCoordinates;
   periods?: {
@@ -966,5 +975,4 @@ export type XMLWebsiteData = {
     };
   };
 };
-export type XMLHeadingItemCategory = Exclude<XMLItemCategory, "tree" | "bibliography" | "spatialUnit" | "concept" | "period">;
-//#endregion
+export type XMLHeadingItemCategory = Exclude<XMLItemCategory, "tree" | "bibliography" | "spatialUnit" | "concept" | "period">;

package/dist/xquery.d.mts

@@ -1,4 +1,3 @@
-//#region src/xquery.d.ts
 /**
  * Build a string literal for an XQuery string
  * @param value - The string value to escape
@@ -74,5 +73,4 @@ export declare function compileOchreQuery(parameters: {
   declarations?: ReadonlyArray<string>;
   body: (context: OchreQueryContext) => string;
   contentLanguage?: OchreContentLanguage | null;
-}): string;
-//#endregion
+}): string;

package/dist/xquery.mjs

@@ -1,5 +1,5 @@
 import { DEFAULT_LANGUAGES } from "./constants.mjs";
-//#region src/xquery.ts
+// src/xquery.ts
 /**
 * Build a string literal for an XQuery string
 * @param value - The string value to escape
@@ -137,5 +137,4 @@ ${contentLanguage == null ? bodyExpression : `local:select-language((
 ${bodyExpression}
 ), ${stringLiteral(contentLanguage.language)}, ${stringLiteral(contentLanguage.fallbackLanguage)})`}`;
 }
-//#endregion
 export { OCHRE_RESPONSE_PADDING, compileOchreQuery, getContentLanguage, stringLiteral };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "1.3.13",
+  "version": "1.3.14",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -45,7 +45,8 @@
     "dist"
   ],
   "dependencies": {
-    "fast-equals": "^6.1.1",
+    "@nodable/entities": "^3.1.0",
+    "fast-equals": "^6.2.1",
     "fast-xml-parser": "^5.11.2",
     "valibot": "^1.5.0"
   },
@@ -53,15 +54,15 @@
     "@antfu/eslint-config": "^9.5.1",
     "@types/node": "^24.19.2",
     "bumpp": "^12.3.0",
-    "eslint": "^10.12.0",
+    "eslint": "^10.13.0",
     "eslint-plugin-erasable-syntax-only": "^0.7.2",
     "eslint-plugin-slop": "^0.1.3",
     "eslint-plugin-sonarjs": "^4.2.2",
-    "knip": "^6.41.0",
-    "oxfmt": "^0.73.0",
+    "knip": "^6.42.1",
+    "oxfmt": "^0.74.0",
     "tsdown": "^0.23.1",
     "typescript": "^6.0.3",
-    "vitest": "^5.0.4"
+    "vitest": "^5.0.5"
   },
   "scripts": {
     "dev": "tsdown src/index.ts --watch",