ochre-sdk 1.3.0 → 1.3.2

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

@@ -4,7 +4,7 @@ import { FetchBaseOptions, FetchLanguages } from "../../parsers/helpers.mjs";
 /**
  * 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
+ * Each item carries only its identification, its publication date, 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}.

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

@@ -24,6 +24,7 @@ async function fetchSetItemLocations(parameters, options) {
   return <items totalCount="{count(${items})}">{
     for $item in ${items}
     return <itemLocation uuid="{$item/@uuid}" category="{local-name($item)}">{
+      $item/@publicationDateTime,
       $item/identification,
       $item/coordinates,
       for $value in $item//properties//property[label/@uuid = $propertyVariableUuids]/value[@uuid]
@@ -57,6 +58,7 @@ async function fetchSetItemLocations(parameters, options) {
 			itemsByUuid.set(itemLocation.uuid, {
 				uuid: itemLocation.uuid,
 				category,
+				publicationDateTime: itemLocation.publicationDateTime ?? null,
 				identification: parseIdentification(itemLocation.identification, { languages }),
 				coordinates: parseCoordinates(itemLocation.coordinates, { languages }),
 				propertyValues

package/dist/fetchers/set/property-values.mjs

@@ -124,12 +124,13 @@ const propertyValueQueryItemSchema = v.pipe(v.object({
 const attributeValueQueryItemSchema = v.pipe(v.object({
 	attributeType: v.picklist(["bibliographies", "periods"]),
 	count: countSchema,
-	content: v.optional(v.string()),
-	payload: v.optional(v.string())
+	key: v.optional(v.string()),
+	content: v.optional(v.array(propertyValueLabelContentSchema))
 }), v.transform((value) => ({
 	attributeType: value.attributeType,
 	count: value.count,
-	content: value.content != null && value.content !== "" ? value.content : value.payload != null && value.payload !== "" ? value.payload : null
+	content: value.key != null && value.key !== "" ? value.key : null,
+	label: parsePropertyValueLabel(value.content, value.key)
 })));
 /**
 * Schema for the property values OCHRE API response
@@ -327,45 +328,35 @@ let $property-values :=
   )`);
 			returnedSequences.push("$property-values");
 		}
-		if (attributes.bibliographies) {
-			queryBlocks.push(`let $bibliography-counts := map:map()
-let $_bibliography-aggregation := xdmp:eager(
+		for (const [attributeType, attributePath] of [["bibliographies", "bibliographies/bibliography"], ["periods", "periods/period"]]) {
+			if (!attributes[attributeType]) continue;
+			queryBlocks.push(`let $${attributeType}-counts := map:map()
+let $${attributeType}-labels := map:map()
+let $_${attributeType}-aggregation := xdmp:eager(
   for $item in ${items}
   let $seen := map:map()
   return
-    for $bibliography in $item/bibliographies/bibliography${notSupplemental}
-    let $label := string-join($bibliography/identification/label/content[@xml:lang=${languageLiteral}]//text(), "")
-    where string-length($label) gt 0
-    return local:add-attribute-facet($bibliography-counts, $seen, $label)
-)
-
-let $bibliography-values :=
-  (
-    $_bibliography-aggregation,
-    for $label in map:keys($bibliography-counts)
-    return <attributeValue attributeType="bibliographies" count="{map:get($bibliography-counts, $label)}" content="{$label}" />
-  )`);
-			returnedSequences.push("$bibliography-values");
-		}
-		if (attributes.periods) {
-			queryBlocks.push(`let $period-counts := map:map()
-let $_period-aggregation := xdmp:eager(
-  for $item in ${items}
-  let $seen := map:map()
-  return
-    for $period in $item/periods/period${notSupplemental}
-    let $label := string-join($period/identification/label/content[@xml:lang=${languageLiteral}]//text(), "")
-    where string-length($label) gt 0
-    return local:add-attribute-facet($period-counts, $seen, $label)
+    for $attribute in $item/${attributePath}${notSupplemental}
+    let $label := $attribute/identification/label
+    let $key := string-join($label/content[@xml:lang=${languageLiteral}]//text(), "")
+    where string-length($key) gt 0
+    return (
+      if (empty(map:get($${attributeType}-labels, $key)))
+      then map:put($${attributeType}-labels, $key, local:value-label-content($label))
+      else (),
+      local:add-attribute-facet($${attributeType}-counts, $seen, $key)
+    )
 )
 
-let $period-values :=
+let $${attributeType}-values :=
   (
-    $_period-aggregation,
-    for $label in map:keys($period-counts)
-    return <attributeValue attributeType="periods" count="{map:get($period-counts, $label)}" content="{$label}" />
+    $_${attributeType}-aggregation,
+    for $key in map:keys($${attributeType}-counts)
+    return <attributeValue attributeType="${attributeType}" count="{map:get($${attributeType}-counts, $key)}" key="{$key}">{
+      map:get($${attributeType}-labels, $key)
+    }</attributeValue>
   )`);
-			returnedSequences.push("$period-values");
+			returnedSequences.push(`$${attributeType}-values`);
 		}
 		return queryBlocks;
 	}
@@ -426,7 +417,8 @@ function collectAttributeValues(parsedAttributeValues) {
 		if (attributeValue.content == null || attributeValue.content === "") continue;
 		attributeValuesByType[attributeValue.attributeType].push({
 			count: attributeValue.count,
-			content: attributeValue.content
+			content: attributeValue.content,
+			label: attributeValue.label
 		});
 	}
 	return attributeValuesByType;

package/dist/types/index.d.mts

@@ -571,6 +571,7 @@ export type SetItem<U extends SetItemCategory = SetItemCategory, T extends Langu
 export type SetItemLocation<T extends LanguageCodes = LanguageCodes> = {
   uuid: string;
   category: SetItemCategory;
+  publicationDateTime: Date | null;
   identification: Identification<T>;
   coordinates: Array<Coordinates<T>>;
   propertyValues: Array<{
@@ -794,10 +795,14 @@ export type PropertyValueQueryItem = {
 };
 /**
  * Represents a grouped Set attribute value query item
+ *
+ * `content` is the label in the requested language, which facet queries match
+ * on; `label` carries the label in every language for display.
  */
 export type SetAttributeValueQueryItem = {
   count: number;
   content: string;
+  label: MultilingualString | null;
 };
 /**
  * Represents sorting direction for Set items

package/dist/xml/schemas.d.mts

@@ -4119,6 +4119,7 @@ export declare const XMLSetItemLocationsData: v.ObjectSchema<{
         readonly itemLocation: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
           readonly uuid: v.StringSchema<"XMLSetItemLocation: uuid is string and required">;
           readonly category: v.StringSchema<"XMLSetItemLocation: category is string and required">;
+          readonly publicationDateTime: v.OptionalSchema<v.GenericSchema<unknown, Date>, undefined>;
           readonly identification: v.ObjectSchema<{
             readonly label: v.UnionSchema<[v.ObjectSchema<{
               readonly content: v.ArraySchema<v.ObjectSchema<{

package/dist/xml/schemas.mjs

@@ -931,6 +931,7 @@ const XMLSetItemsData = v.object({ result: v.object({ ochre: v.object({ items: X
 const XMLSetItemLocation = v.object({
 	uuid: v.string("XMLSetItemLocation: uuid is string and required"),
 	category: v.string("XMLSetItemLocation: category is string and required"),
+	publicationDateTime: v.optional(customDateTime("XMLSetItemLocation: publicationDateTime is not a valid datetime")),
 	identification: XMLIdentification,
 	coordinates: v.optional(XMLCoordinates),
 	value: v.optional(v.array(v.intersect([v.object({

package/dist/xml/types.d.mts

@@ -892,6 +892,7 @@ export type XMLSetItemsData = {
 export type XMLSetItemLocation = {
   uuid: string;
   category: string;
+  publicationDateTime?: Date;
   identification: XMLIdentification;
   coordinates?: XMLCoordinates;
   value?: Array<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",