ochre-sdk 1.1.6 → 1.2.1

package/README.md

@@ -66,6 +66,10 @@ present and `error` is `null`; on failure, the parsed value is `null` and
   style, collection, and item-page configuration.
 - `fetchSetItems(params, containedItemCategories, options)` fetches paginated
   Set search results with typed query and sort support.
+- `fetchSetItemLocations(params, options)` fetches the identification,
+  coordinates and chosen property values of every Set item matching a query,
+  without paging, for drawing all results on a map while a list pages through
+  them.
 - `fetchTreeItems(params, containedItemCategories, options)` is the same for a
   Tree, and is how to read a Tree too large to fetch whole. Items nested under
   headings come back flat, in document order.
@@ -152,6 +156,10 @@ const result = await fetchSetItems(
 Use `fetchSetPropertyValues` with the same query shape when you need facet data
 for a filtered result set.
 
+Sort by distance from a point with `{ target: "distance", latitude, longitude }`.
+Items are ordered by their first point, or the center of their first plane, and
+items without coordinates come last.
+
 `fetchTreeItems` takes the same `Query` tree and the same sort options, because
 both fetchers compile the same query model against their container's searchable
 path. The difference is what the payload carries: OCHRE publishes Tree items as

package/dist/constants.mjs

@@ -40,6 +40,7 @@ const XML_ARRAY_TAGS = [
 	"scope",
 	"level",
 	"style",
+	"itemLocation",
 	"flattenContexts",
 	"suppressContexts",
 	"filterContexts",

package/dist/fetchers/container-items.mjs

@@ -88,6 +88,18 @@ function buildOrderedItemsClause(sort) {
       let $sortKey := ${`string-join($item/identification/label/content[@xml:lang=${stringLiteral(sort.language ?? "eng")}]/string, "")`}
       stable order by ${buildStringOrderByClause(direction)}
       return $item`;
+	if (sort.target === "distance") {
+		const longitudeScale = Math.cos(sort.latitude * Math.PI / 180);
+		return `let $orderedItems :=
+    for $item at $position in $items
+      let $point := ($item/coordinates/coord[@type = "point"][@latitude castable as xs:double][@longitude castable as xs:double])[1]
+      let $plane := ($item/coordinates/coord[@type = "plane"][minimum/@latitude castable as xs:double][minimum/@longitude castable as xs:double][maximum/@latitude castable as xs:double][maximum/@longitude castable as xs:double])[1]
+      let $latitude := if (exists($point)) then xs:double($point/@latitude) else if (exists($plane)) then (xs:double($plane/minimum/@latitude) + xs:double($plane/maximum/@latitude)) div 2 else ()
+      let $longitude := if (exists($point)) then xs:double($point/@longitude) else if (exists($plane)) then (xs:double($plane/minimum/@longitude) + xs:double($plane/maximum/@longitude)) div 2 else ()
+      let $sortKey := if (exists($latitude)) then ($latitude - ${sort.latitude}) * ($latitude - ${sort.latitude}) + ($longitude - ${sort.longitude}) * ($longitude - ${sort.longitude}) * ${longitudeScale * longitudeScale} else ()
+      stable order by ${buildTypedOrderByClause(direction)}
+      return $item`;
+	}
 	if (sort.target === "date") return `let $orderedItems :=
     for $item at $position in $items
       let $sortKey := string(($item/@date, $item/interpretations/interpretation/@date)[1])

package/dist/fetchers/set/item-locations.d.mts

@@ -0,0 +1,35 @@
+import { Query, SetItemLocation } from "../../types/index.mjs";
+import { FetchBaseOptions, FetchLanguages } from "../../parsers/helpers.mjs";
+//#region src/fetchers/set/item-locations.d.ts
+/**
+ * Fetches the location of every Set item that matches a query, without paging
+ *
+ * Each item carries only its identification, its coordinates and the values of
+ * the requested property variables (inherited values included), which is what a
+ * map needs to draw and colour every match while a list pages through the same
+ * query with {@link fetchSetItems}.
+ *
+ * @param parameters - The parameters for the fetch
+ * @param parameters.setScopeUuids - The Set scope UUIDs to filter by
+ * @param parameters.queries - Recursive query tree used to filter matching items
+ * @param parameters.propertyVariableUuids - The property variables whose values each item should carry
+ * @param options - Options for the fetch
+ * @param options.fetch - The fetch function to use
+ * @returns The item locations, or an error if the fetch/parse fails
+ */
+export declare function fetchSetItemLocations<const TLanguages extends ReadonlyArray<string> | undefined = undefined>(parameters: {
+  setScopeUuids: Array<string>;
+  queries?: Query | null;
+  propertyVariableUuids?: Array<string>;
+}, options?: FetchBaseOptions<TLanguages>): Promise<{
+  totalCount: number;
+  items: Array<SetItemLocation<FetchLanguages<TLanguages>>>;
+  error: null;
+  detailedError: null;
+} | {
+  totalCount: null;
+  items: null;
+  error: string;
+  detailedError: string;
+}>;
+//#endregion

package/dist/fetchers/set/item-locations.mjs

@@ -0,0 +1,80 @@
+import { normalizeItemCategory } from "../../categories.mjs";
+import { getErrorOutput } from "../../errors.mjs";
+import { requestOchre } from "../request.mjs";
+import { setItemLocationsParametersSchema } from "../../schemas.mjs";
+import { parseRequiredContentLike } from "../../parsers/helpers.mjs";
+import { parseRequestedLanguages, resolveContentLanguages } from "../../parsers/languages.mjs";
+import { parseCoordinates, parseIdentification } from "../../parsers/index.mjs";
+import { XMLSetItemLocationsData } from "../../xml/schemas.mjs";
+import { stringLiteral } from "../../xquery.mjs";
+import { compileContainerItemsQuery } from "../../query.mjs";
+import * as v from "valibot";
+//#region src/fetchers/set/item-locations.ts
+async function fetchSetItemLocations(parameters, options) {
+	try {
+		const { setScopeUuids, belongsToCollectionScopeUuids, queries, propertyVariableUuids } = v.parse(setItemLocationsParametersSchema, parameters);
+		const output = await requestOchre({
+			xquery: compileContainerItemsQuery({
+				container: "set",
+				scopeUuids: setScopeUuids,
+				belongsToCollectionScopeUuids,
+				queries,
+				body: ({ items }) => `  let $propertyVariableUuids := (${Array.from(propertyVariableUuids, (uuid) => stringLiteral(uuid)).join(", ")})
+
+  return <items totalCount="{count(${items})}">{
+    for $item in ${items}
+    return <itemLocation uuid="{$item/@uuid}" category="{local-name($item)}">{
+      $item/identification,
+      $item/coordinates,
+      for $value in $item//properties//property[label/@uuid = $propertyVariableUuids]/value[@uuid]
+      return <value variable="{$value/../label/@uuid}" uuid="{$value/@uuid}">{$value/content}</value>
+    }</itemLocation>
+  }</items>`
+			}),
+			schema: XMLSetItemLocationsData,
+			label: "OCHRE Set item locations",
+			options
+		});
+		const languages = resolveContentLanguages(output.result.ochre.items, parseRequestedLanguages(options?.languages));
+		const itemsByUuid = /* @__PURE__ */ new Map();
+		const itemLocations = output.result.ochre.items.itemLocation ?? [];
+		for (const itemLocation of itemLocations) {
+			const category = normalizeItemCategory(itemLocation.category);
+			if (category == null || itemsByUuid.has(itemLocation.uuid)) continue;
+			const propertyValues = [];
+			const seenPropertyValues = /* @__PURE__ */ new Set();
+			const values = itemLocation.value ?? [];
+			for (const value of values) {
+				const key = `${value.variable}:${value.uuid}`;
+				if (seenPropertyValues.has(key)) continue;
+				seenPropertyValues.add(key);
+				propertyValues.push({
+					variableUuid: value.variable,
+					valueUuid: value.uuid,
+					label: parseRequiredContentLike(value, { languages })
+				});
+			}
+			itemsByUuid.set(itemLocation.uuid, {
+				uuid: itemLocation.uuid,
+				category,
+				identification: parseIdentification(itemLocation.identification, { languages }),
+				coordinates: parseCoordinates(itemLocation.coordinates, { languages }),
+				propertyValues
+			});
+		}
+		return {
+			totalCount: output.result.ochre.items.totalCount,
+			items: itemsByUuid.values().toArray(),
+			error: null,
+			detailedError: null
+		};
+	} catch (error) {
+		return {
+			totalCount: null,
+			items: null,
+			...getErrorOutput(error, "Failed to fetch Set item locations")
+		};
+	}
+}
+//#endregion
+export { fetchSetItemLocations };

package/dist/index.d.mts

@@ -1,12 +1,13 @@
 import { MultilingualOptions, MultilingualString, MultilingualStringEntries, MultilingualStringEntry, MultilingualStringInput, MultilingualStringJSON, MultilingualStringObject, MultilingualStringText } from "./parsers/multilingual.mjs";
 import { AccordionWebBlock, ContextTree, ContextTreeFilterLevel, ContextTreeFilterVariant, ContextTreeLevel, ContextTreeLevelItem, ProtectedWebsite, ResponsiveStyles, Scope, Style, StylesheetCategory, StylesheetItem, WebAccordionItem, WebBlock, WebBlockByLayout, WebBlockItem, WebBlockLayout, WebElement, WebElementComponent, WebElementComponentName, WebElementComponentOf, WebElementOf, WebIiifViewer, WebImage, WebLoadingVariant, WebOptions, WebSectionDisplay, WebSectionVariant, WebSidebar, WebTitle, Webpage, Website, WebsiteMetadata, WebsitePrivacy, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteSegment, WebsiteType } from "./types/website.mjs";
-import { AnyBibliography, AnyConcept, AnyItem, AnyPeriod, AnyPerson, AnyPropertyValue, AnyPropertyVariable, AnyResource, AnySet, AnySpatialUnit, AnyText, AnyTree, BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, ContainedItemCategory, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Context, ContextItem, ContextItemCategory, ContextNode, Coordinates, CoordinatesSource, DictionaryUnitItemLink, EmbeddedBibliography, EmbeddedConcept, EmbeddedItem, EmbeddedPeriod, EmbeddedPerson, EmbeddedPropertyValue, EmbeddedPropertyVariable, EmbeddedResource, EmbeddedSet, EmbeddedSpatialUnit, EmbeddedText, EmbeddedTree, Event, Gallery, Heading, HeadingItemCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemLink, ItemLinkCategory, ItemLinks, ItemPayloadKind, ItemProperty, ItemWithoutEmbeddedItems, LanguageCodes, License, Metadata, Note, Observation, OcrString, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyLike, PropertyRelation, PropertyValue, PropertyValueContent, PropertyValueDataType, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, QueryablePropertyValueDataType, RecursiveItemCategory, Resource, ResourceItemLink, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemCategory, SetItemLink, SetItemProperty, SetItemSimplifiedProperty, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetStyle, SetStyleProperty, SetTree, SimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Text, TextItemLink, TopLevelItem, Tree, TreeItemCategory, TreeItemLink } from "./types/index.mjs";
+import { AnyBibliography, AnyConcept, AnyItem, AnyPeriod, AnyPerson, AnyPropertyValue, AnyPropertyVariable, AnyResource, AnySet, AnySpatialUnit, AnyText, AnyTree, BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, ContainedItemCategory, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Context, ContextItem, ContextItemCategory, ContextNode, Coordinates, CoordinatesSource, DictionaryUnitItemLink, EmbeddedBibliography, EmbeddedConcept, EmbeddedItem, EmbeddedPeriod, EmbeddedPerson, EmbeddedPropertyValue, EmbeddedPropertyVariable, EmbeddedResource, EmbeddedSet, EmbeddedSpatialUnit, EmbeddedText, EmbeddedTree, Event, Gallery, Heading, HeadingItemCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemLink, ItemLinkCategory, ItemLinks, ItemPayloadKind, ItemProperty, ItemWithoutEmbeddedItems, LanguageCodes, License, Metadata, Note, Observation, OcrString, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyLike, PropertyRelation, PropertyValue, PropertyValueContent, PropertyValueDataType, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, QueryablePropertyValueDataType, RecursiveItemCategory, Resource, ResourceItemLink, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemCategory, SetItemLink, SetItemLocation, SetItemProperty, SetItemSimplifiedProperty, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetStyle, SetStyleProperty, SetTree, SimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Text, TextItemLink, TopLevelItem, Tree, TreeItemCategory, TreeItemLink } from "./types/index.mjs";
 import { DEFAULT_PAGE_SIZE } from "./constants.mjs";
 import { fetchGallery } from "./fetchers/gallery.mjs";
 import { fetchItemChildren } from "./fetchers/item-children.mjs";
 import { fetchItemLinks } from "./fetchers/item-links.mjs";
 import { fetchItemOcrData } from "./fetchers/item-ocr-data.mjs";
 import { fetchItem } from "./fetchers/item.mjs";
+import { fetchSetItemLocations } from "./fetchers/set/item-locations.mjs";
 import { fetchSetItems } from "./fetchers/set/items.mjs";
 import { fetchSetPropertyValues } from "./fetchers/set/property-values.mjs";
 import { fetchTreeItems } from "./fetchers/tree/items.mjs";
@@ -15,4 +16,4 @@ import { fetchWebsite } from "./fetchers/website.mjs";
 import { PropertyOptions, PropertySelector, getLeafPropertyValues, getProperty, getPropertyValue, getPropertyValues, getUniqueProperties, getUniquePropertyVariableLabels, isPropertyMatchingFilter, normalizePropertyVariableLabel } from "./getters.mjs";
 import { flattenItemProperties } from "./helpers.mjs";
 import { defineLanguages } from "./parsers/languages.mjs";
-export { type AccordionWebBlock, type AnyBibliography, type AnyConcept, type AnyItem, type AnyPeriod, type AnyPerson, type AnyPropertyValue, type AnyPropertyVariable, type AnyResource, type AnySet, type AnySpatialUnit, type AnyText, type AnyTree, type BaseItem, type BaseItemLink, type BelongsTo, type Bibliography, type BibliographyEntryInfo, type BibliographyItemLink, type BibliographySourceDocument, type Concept, type ConceptItemLink, type ContainedItemCategory, type ContainedItemCategoryFromOption, type ContainedItemCategoryOption, type Context, type ContextItem, type ContextItemCategory, type ContextNode, type ContextTree, type ContextTreeFilterLevel, type ContextTreeFilterVariant, type ContextTreeLevel, type ContextTreeLevelItem, type Coordinates, type CoordinatesSource, DEFAULT_PAGE_SIZE, type DictionaryUnitItemLink, type EmbeddedBibliography, type EmbeddedConcept, type EmbeddedItem, type EmbeddedPeriod, type EmbeddedPerson, type EmbeddedPropertyValue, type EmbeddedPropertyVariable, type EmbeddedResource, type EmbeddedSet, type EmbeddedSpatialUnit, type EmbeddedText, type EmbeddedTree, type Event, type Gallery, type Heading, type HeadingItemCategory, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type Item, type ItemCategory, type ItemCategoryFromOption, type ItemCategoryOption, type ItemCategoryWithEmbeddedItems, type ItemContainerCategory, type ItemLink, type ItemLinkCategory, type ItemLinks, type ItemPayloadKind, type ItemProperty, type ItemWithoutEmbeddedItems, type LanguageCodes, type License, type Metadata, type MultilingualOptions, MultilingualString, type MultilingualStringEntries, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringObject, type MultilingualStringText, type Note, type Observation, type OcrString, type Period, type PeriodItemLink, type Person, type PersonItemLink, type Property, type PropertyLike, type PropertyOptions, type PropertyRelation, type PropertySelector, type PropertyValue, type PropertyValueContent, type PropertyValueDataType, type PropertyValueItemLink, type PropertyValueQueryItem, type PropertyVariable, type PropertyVariableItemLink, type ProtectedWebsite, type Query, type QueryGroup, type QueryLeaf, type QueryablePropertyValueDataType, type RecursiveItemCategory, type Resource, type ResourceItemLink, type ResponsiveStyles, type Scope, type Section, type Set, type SetAttributeValueQueryItem, type SetBibliography, type SetConcept, type SetItem, type SetItemCategory, type SetItemLink, type SetItemProperty, type SetItemSimplifiedProperty, type SetItemsSort, type SetItemsSortDirection, type SetPeriod, type SetResource, type SetSpatialUnit, type SetStyle, type SetStyleProperty, type SetTree, type SimplifiedProperty, type SpatialUnit, type SpatialUnitItemLink, type Style, type StylesheetCategory, type StylesheetItem, type Text, type TextItemLink, type TopLevelItem, type Tree, type TreeItemCategory, type TreeItemLink, type WebAccordionItem, type WebBlock, type WebBlockByLayout, type WebBlockItem, type WebBlockLayout, type WebElement, type WebElementComponent, type WebElementComponentName, type WebElementComponentOf, type WebElementOf, type WebIiifViewer, type WebImage, type WebLoadingVariant, type WebOptions, type WebSectionDisplay, type WebSectionVariant, type WebSidebar, type WebTitle, type Webpage, type Website, type WebsiteMetadata, type WebsitePrivacy, type WebsitePropertyQuery, type WebsitePropertyQueryNode, type WebsiteSegment, type WebsiteType, defineLanguages, fetchGallery, fetchItem, fetchItemChildren, fetchItemLinks, fetchItemOcrData, fetchSetItems, fetchSetPropertyValues, fetchTreeItems, fetchWebsite, fetchWebsiteMetadata, flattenItemProperties, getLeafPropertyValues, getProperty, getPropertyValue, getPropertyValues, getUniqueProperties, getUniquePropertyVariableLabels, isPropertyMatchingFilter, normalizePropertyVariableLabel };
+export { type AccordionWebBlock, type AnyBibliography, type AnyConcept, type AnyItem, type AnyPeriod, type AnyPerson, type AnyPropertyValue, type AnyPropertyVariable, type AnyResource, type AnySet, type AnySpatialUnit, type AnyText, type AnyTree, type BaseItem, type BaseItemLink, type BelongsTo, type Bibliography, type BibliographyEntryInfo, type BibliographyItemLink, type BibliographySourceDocument, type Concept, type ConceptItemLink, type ContainedItemCategory, type ContainedItemCategoryFromOption, type ContainedItemCategoryOption, type Context, type ContextItem, type ContextItemCategory, type ContextNode, type ContextTree, type ContextTreeFilterLevel, type ContextTreeFilterVariant, type ContextTreeLevel, type ContextTreeLevelItem, type Coordinates, type CoordinatesSource, DEFAULT_PAGE_SIZE, type DictionaryUnitItemLink, type EmbeddedBibliography, type EmbeddedConcept, type EmbeddedItem, type EmbeddedPeriod, type EmbeddedPerson, type EmbeddedPropertyValue, type EmbeddedPropertyVariable, type EmbeddedResource, type EmbeddedSet, type EmbeddedSpatialUnit, type EmbeddedText, type EmbeddedTree, type Event, type Gallery, type Heading, type HeadingItemCategory, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type Item, type ItemCategory, type ItemCategoryFromOption, type ItemCategoryOption, type ItemCategoryWithEmbeddedItems, type ItemContainerCategory, type ItemLink, type ItemLinkCategory, type ItemLinks, type ItemPayloadKind, type ItemProperty, type ItemWithoutEmbeddedItems, type LanguageCodes, type License, type Metadata, type MultilingualOptions, MultilingualString, type MultilingualStringEntries, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringObject, type MultilingualStringText, type Note, type Observation, type OcrString, type Period, type PeriodItemLink, type Person, type PersonItemLink, type Property, type PropertyLike, type PropertyOptions, type PropertyRelation, type PropertySelector, type PropertyValue, type PropertyValueContent, type PropertyValueDataType, type PropertyValueItemLink, type PropertyValueQueryItem, type PropertyVariable, type PropertyVariableItemLink, type ProtectedWebsite, type Query, type QueryGroup, type QueryLeaf, type QueryablePropertyValueDataType, type RecursiveItemCategory, type Resource, type ResourceItemLink, type ResponsiveStyles, type Scope, type Section, type Set, type SetAttributeValueQueryItem, type SetBibliography, type SetConcept, type SetItem, type SetItemCategory, type SetItemLink, type SetItemLocation, type SetItemProperty, type SetItemSimplifiedProperty, type SetItemsSort, type SetItemsSortDirection, type SetPeriod, type SetResource, type SetSpatialUnit, type SetStyle, type SetStyleProperty, type SetTree, type SimplifiedProperty, type SpatialUnit, type SpatialUnitItemLink, type Style, type StylesheetCategory, type StylesheetItem, type Text, type TextItemLink, type TopLevelItem, type Tree, type TreeItemCategory, type TreeItemLink, type WebAccordionItem, type WebBlock, type WebBlockByLayout, type WebBlockItem, type WebBlockLayout, type WebElement, type WebElementComponent, type WebElementComponentName, type WebElementComponentOf, type WebElementOf, type WebIiifViewer, type WebImage, type WebLoadingVariant, type WebOptions, type WebSectionDisplay, type WebSectionVariant, type WebSidebar, type WebTitle, type Webpage, type Website, type WebsiteMetadata, type WebsitePrivacy, type WebsitePropertyQuery, type WebsitePropertyQueryNode, type WebsiteSegment, type WebsiteType, defineLanguages, fetchGallery, fetchItem, fetchItemChildren, fetchItemLinks, fetchItemOcrData, fetchSetItemLocations, fetchSetItems, fetchSetPropertyValues, fetchTreeItems, fetchWebsite, fetchWebsiteMetadata, flattenItemProperties, getLeafPropertyValues, getProperty, getPropertyValue, getPropertyValues, getUniqueProperties, getUniquePropertyVariableLabels, isPropertyMatchingFilter, normalizePropertyVariableLabel };

package/dist/index.mjs

@@ -8,9 +8,10 @@ import { fetchItemChildren } from "./fetchers/item-children.mjs";
 import { fetchItemLinks } from "./fetchers/item-links.mjs";
 import { fetchItemOcrData } from "./fetchers/item-ocr-data.mjs";
 import { fetchItem } from "./fetchers/item.mjs";
+import { fetchSetItemLocations } from "./fetchers/set/item-locations.mjs";
 import { fetchSetItems } from "./fetchers/set/items.mjs";
 import { fetchSetPropertyValues } from "./fetchers/set/property-values.mjs";
 import { fetchTreeItems } from "./fetchers/tree/items.mjs";
 import { fetchWebsiteMetadata } from "./fetchers/website-metadata.mjs";
 import { fetchWebsite } from "./fetchers/website.mjs";
-export { DEFAULT_PAGE_SIZE, MultilingualString, defineLanguages, fetchGallery, fetchItem, fetchItemChildren, fetchItemLinks, fetchItemOcrData, fetchSetItems, fetchSetPropertyValues, fetchTreeItems, fetchWebsite, fetchWebsiteMetadata, flattenItemProperties, getLeafPropertyValues, getProperty, getPropertyValue, getPropertyValues, getUniqueProperties, getUniquePropertyVariableLabels, isPropertyMatchingFilter, normalizePropertyVariableLabel };
+export { DEFAULT_PAGE_SIZE, MultilingualString, defineLanguages, fetchGallery, fetchItem, fetchItemChildren, fetchItemLinks, fetchItemOcrData, fetchSetItemLocations, fetchSetItems, fetchSetPropertyValues, fetchTreeItems, fetchWebsite, fetchWebsiteMetadata, flattenItemProperties, getLeafPropertyValues, getProperty, getPropertyValue, getPropertyValues, getUniqueProperties, getUniquePropertyVariableLabels, isPropertyMatchingFilter, normalizePropertyVariableLabel };

package/dist/parsers/index.d.mts

@@ -1,12 +1,13 @@
 import { Webpage } from "../types/website.mjs";
-import { Bibliography, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Gallery, Identification, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemContainerCategory, ItemLinks, Metadata, Note, Person, Property, Resource, SetItem, SetItemCategory, SimplifiedProperty } from "../types/index.mjs";
-import { XMLBibliography, XMLData, XMLDataItem, XMLGalleryData, XMLIdentification, XMLItemLinks, XMLLink, XMLMetadata, XMLNote, XMLPerson, XMLProperty, XMLResource, XMLSetItems, XMLSimplifiedProperty } from "../xml/types.mjs";
+import { Bibliography, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Coordinates, Gallery, Identification, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemContainerCategory, ItemLinks, Metadata, Note, Person, Property, Resource, SetItem, SetItemCategory, SimplifiedProperty } from "../types/index.mjs";
+import { XMLBibliography, XMLCoordinates, XMLData, XMLDataItem, XMLGalleryData, XMLIdentification, XMLItemLinks, XMLLink, XMLMetadata, XMLNote, XMLPerson, XMLProperty, XMLResource, XMLSetItems, XMLSimplifiedProperty } from "../xml/types.mjs";
 import { ParserOptions, getParserOptions, parseStringLike } from "./helpers.mjs";
 //#region src/parsers/index.d.ts
 export type RawOchre = XMLData["result"]["ochre"];
 type ResourceViewParser<T extends ReadonlyArray<string>> = (view: XMLResource["view"], context: Pick<Resource<T, "topLevel">, "belongsTo" | "metadata">) => Webpage<T> | null;
 type SetItemCategoryFromCategories<T extends ReadonlyArray<SetItemCategory> | undefined> = T extends ReadonlyArray<infer U> ? Extract<U, SetItemCategory> : SetItemCategory;
 export declare function parseIdentification<T extends ReadonlyArray<string>>(rawIdentification: XMLIdentification, options: ParserOptions<T>): Identification<T>;
+export declare function parseCoordinates<T extends ReadonlyArray<string>>(rawCoordinates: XMLCoordinates | undefined, options: ParserOptions<T>): Array<Coordinates<T>>;
 export declare function parseNotes<T extends ReadonlyArray<string>>(rawNotes: {
   note: Array<XMLNote>;
 } | undefined, options: ParserOptions<T>): Array<Note<T>>;

package/dist/parsers/index.mjs

@@ -1229,4 +1229,4 @@ function parseItem(rawData, options) {
 	};
 }
 //#endregion
-export { getParserOptions, parseBibliographyList, parseGallery, parseIdentification, parseItem, parseLinkedItems, parseLinks, parseMetadata, parseNotes, parsePersonList, parseProperties, parseSetItems, parseSimplifiedProperties, parseStringLike };
+export { getParserOptions, parseBibliographyList, parseCoordinates, parseGallery, parseIdentification, parseItem, parseLinkedItems, parseLinks, parseMetadata, parseNotes, parsePersonList, parseProperties, parseSetItems, parseSimplifiedProperties, parseStringLike };

package/dist/parsers/website/components.mjs

@@ -233,6 +233,7 @@ function parseButtonComponent(parameters) {
 const COLLECTION_FILTER_DEFAULTS = {
 	isResultsBarDisplayed: false,
 	isInputDisplayed: false,
+	isMapDisplayed: false,
 	isLimitedToInputFilter: false,
 	isLimitedToLeafPropertyValues: false,
 	isSidebarDisplayed: false,
@@ -247,6 +248,7 @@ function parseCollectionComponent(parameters) {
 	componentReader.readAll(filter, {
 		isResultsBarDisplayed: "filter-results-bar-displayed",
 		isInputDisplayed: "filter-input-displayed",
+		isMapDisplayed: "filter-map-displayed",
 		isLimitedToInputFilter: "filter-limit-to-input-filter",
 		isLimitedToLeafPropertyValues: "filter-limit-to-leaf-property-values",
 		isSidebarDisplayed: "filter-sidebar-displayed",

package/dist/schemas.d.mts

@@ -83,6 +83,11 @@ export declare const setItemsParametersSchema: v.ObjectSchema<{
     readonly dataType: v.PicklistSchema<readonly ["string", "integer", "decimal", "boolean", "date", "dateTime", "time", "IDREF"], undefined>;
     readonly direction: v.OptionalSchema<v.PicklistSchema<["asc", "desc"], undefined>, "asc">;
     readonly language: v.GenericSchema<unknown, string>;
+  }, undefined>, v.StrictObjectSchema<{
+    readonly target: v.LiteralSchema<"distance", undefined>;
+    readonly latitude: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.MinValueAction<number, -90, undefined>, v.MaxValueAction<number, 90, undefined>]>;
+    readonly longitude: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.MinValueAction<number, -180, undefined>, v.MaxValueAction<number, 180, undefined>]>;
+    readonly direction: v.OptionalSchema<v.PicklistSchema<["asc", "desc"], undefined>, "asc">;
   }, undefined>], undefined>, {
     readonly target: "none";
   }>;
@@ -90,6 +95,16 @@ export declare const setItemsParametersSchema: v.ObjectSchema<{
   readonly pageSize: v.OptionalSchema<v.GenericSchema<unknown, number>, 48>;
   readonly setScopeUuids: 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 set scope UUID is required">]>;
 }, undefined>;
+/**
+ * Schema for validating the parameters of the Set item locations fetching function
+ * @internal
+ */
+export declare const setItemLocationsParametersSchema: v.ObjectSchema<{
+  readonly setScopeUuids: 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 set scope UUID is required">]>;
+  readonly belongsToCollectionScopeUuids: v.OptionalSchema<v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>, undefined>, readonly []>;
+  readonly queries: v.OptionalSchema<v.NullableSchema<v.GenericSchema<unknown, Query>, undefined>, null>;
+  readonly propertyVariableUuids: v.OptionalSchema<v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>, undefined>, readonly []>;
+}, undefined>;
 export declare const treeItemsParametersSchema: v.ObjectSchema<{
   readonly belongsToCollectionScopeUuids: v.OptionalSchema<v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>, undefined>, readonly []>;
   readonly queries: v.OptionalSchema<v.NullableSchema<v.GenericSchema<unknown, Query>, undefined>, null>;
@@ -108,6 +123,11 @@ export declare const treeItemsParametersSchema: v.ObjectSchema<{
     readonly dataType: v.PicklistSchema<readonly ["string", "integer", "decimal", "boolean", "date", "dateTime", "time", "IDREF"], undefined>;
     readonly direction: v.OptionalSchema<v.PicklistSchema<["asc", "desc"], undefined>, "asc">;
     readonly language: v.GenericSchema<unknown, string>;
+  }, undefined>, v.StrictObjectSchema<{
+    readonly target: v.LiteralSchema<"distance", undefined>;
+    readonly latitude: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.MinValueAction<number, -90, undefined>, v.MaxValueAction<number, 90, undefined>]>;
+    readonly longitude: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.MinValueAction<number, -180, undefined>, v.MaxValueAction<number, 180, undefined>]>;
+    readonly direction: v.OptionalSchema<v.PicklistSchema<["asc", "desc"], undefined>, "asc">;
   }, undefined>], undefined>, {
     readonly target: "none";
   }>;

package/dist/schemas.mjs

@@ -214,6 +214,12 @@ const setItemsSortSchema = v.optional(v.variant("target", [
 		]),
 		direction: sortDirectionSchema,
 		language: defaultString("eng")
+	}),
+	v.strictObject({
+		target: v.literal("distance"),
+		latitude: v.pipe(v.number(), v.minValue(-90), v.maxValue(90)),
+		longitude: v.pipe(v.number(), v.minValue(-180), v.maxValue(180)),
+		direction: sortDirectionSchema
 	})
 ]), { target: "none" });
 /**
@@ -258,9 +264,19 @@ const setItemsParametersSchema = v.object({
 	setScopeUuids: v.pipe(v.array(uuidSchema), v.minLength(1, "At least one set scope UUID is required")),
 	...containerItemsParametersEntries
 });
+/**
+* Schema for validating the parameters of the Set item locations fetching function
+* @internal
+*/
+const setItemLocationsParametersSchema = v.object({
+	setScopeUuids: v.pipe(v.array(uuidSchema), v.minLength(1, "At least one set scope UUID is required")),
+	belongsToCollectionScopeUuids: v.optional(v.array(uuidSchema), []),
+	queries: setQueriesSchema,
+	propertyVariableUuids: v.optional(v.array(uuidSchema), [])
+});
 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, iso639_3Schema, itemOcrDataParametersSchema, renderOptionsSchema, setItemsParametersSchema, setPropertyValuesParametersSchema, treeItemsParametersSchema, uuidSchema };
+export { componentSchema, gallerySchema, isPseudoUuid, iso639_3Schema, itemOcrDataParametersSchema, renderOptionsSchema, setItemLocationsParametersSchema, setItemsParametersSchema, setPropertyValuesParametersSchema, treeItemsParametersSchema, uuidSchema };

package/dist/types/index.d.mts

@@ -564,6 +564,21 @@ export type SetPeriod<T extends LanguageCodes = LanguageCodes> = Prettify<Omit<W
 export type SetResource<T extends LanguageCodes = LanguageCodes> = Prettify<Omit<WithSetItemProperties<Resource<T, "embedded">, T>, "items">>;
 export type SetTree<T extends LanguageCodes = LanguageCodes> = Prettify<Omit<WithSetItemProperties<Tree<TreeItemCategory, T, "embedded">, T>, "items">>;
 export type SetItem<U extends SetItemCategory = SetItemCategory, T extends LanguageCodes = LanguageCodes> = U extends "tree" ? SetTree<T> : U extends "bibliography" ? SetBibliography<T> : U extends "concept" ? SetConcept<T> : U extends "spatialUnit" ? SetSpatialUnit<T> : U extends "period" ? SetPeriod<T> : U extends "person" ? WithSetItemProperties<Person<T, "embedded">, T> : U extends "propertyVariable" ? PropertyVariable<T, "embedded"> : U extends "propertyValue" ? WithSetItemProperties<PropertyValue<T, "embedded">, T> : U extends "resource" ? SetResource<T> : U extends "text" ? Text<T, "embedded"> : U extends "set" ? Omit<WithSetItemProperties<Set<SetItemCategory, T, "embedded">, T>, "items"> : never;
+/**
+ * The location of a Set item, without its properties, for drawing and ordering
+ * every match of a query at once
+ */
+export type SetItemLocation<T extends LanguageCodes = LanguageCodes> = {
+  uuid: string;
+  category: SetItemCategory;
+  identification: Identification<T>;
+  coordinates: Array<Coordinates<T>>;
+  propertyValues: Array<{
+    variableUuid: string;
+    valueUuid: string;
+    label: MultilingualString<T>;
+  }>;
+};
 /**
  *  Person in OCHRE
  */
@@ -812,6 +827,16 @@ export type SetItemsSort = {
   dataType: QueryablePropertyValueDataType;
   direction?: SetItemsSortDirection;
   language?: string;
+} |
+/**
+ * Sort on the distance from a point, using an item's first point or, failing
+ * that, the center of its first plane. Items without coordinates sort last.
+ */
+{
+  target: "distance";
+  latitude: number;
+  longitude: number;
+  direction?: SetItemsSortDirection;
 };
 /**
  * Represents a leaf query for Set items

package/dist/types/website.d.mts

@@ -355,6 +355,7 @@ export type WebElementComponent<T extends LanguageCodes = LanguageCodes> = {
     isSidebarDisplayed: boolean;
     isResultsBarDisplayed: boolean;
     isInputDisplayed: boolean;
+    isMapDisplayed: boolean;
     isLimitedToInputFilter: boolean;
     isLimitedToLeafPropertyValues: boolean;
     sidebarSort: "default" | "alphabetical";