ochre-sdk 1.2.1 → 1.3.1

package/dist/fetchers/set/property-values.d.mts

@@ -11,6 +11,7 @@ import { OchreRequestOptions } from "../request.mjs";
  * @param parameters.attributes.bibliographies - Whether to return values for bibliographies
  * @param parameters.attributes.periods - Whether to return values for periods
  * @param parameters.isLimitedToLeafPropertyValues - Whether to limit the property values to leaf property values
+ * @param parameters.language - Language of the text value, bibliography, and period labels that facets are keyed by (defaults to `"eng"`)
  * @param options - Options for the fetch
  * @param options.fetch - The fetch function to use
  * @returns Parsed Set property values and requested attribute values.
@@ -24,6 +25,7 @@ export declare function fetchSetPropertyValues(parameters: {
     periods: boolean;
   };
   isLimitedToLeafPropertyValues?: boolean;
+  language?: string;
 }, options?: OchreRequestOptions): Promise<{
   propertyValues: Array<PropertyValueQueryItem>;
   propertyValuesByPropertyVariableUuid: Record<string, Array<PropertyValueQueryItem>>;

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
@@ -150,10 +151,12 @@ const responseSchema = v.object({ result: v.object({ ochre: v.object({
 * @param parameters.attributes.bibliographies - Whether to return values for bibliographies
 * @param parameters.attributes.periods - Whether to return values for periods
 * @param parameters.isLimitedToLeafPropertyValues - Whether to limit the property values to leaf property values
+* @param parameters.language - Language of the text value, bibliography, and period labels that facets are keyed by (defaults to `"eng"`)
 * @returns An XQuery string
 */
 function buildXQuery(parameters) {
-	const { setScopeUuids, belongsToCollectionScopeUuids, queries, propertyFacetSelectors, attributes, isLimitedToLeafPropertyValues } = parameters;
+	const { setScopeUuids, belongsToCollectionScopeUuids, queries, propertyFacetSelectors, attributes, isLimitedToLeafPropertyValues, language } = parameters;
+	const languageLiteral = stringLiteral(language);
 	const valueFilter = isLimitedToLeafPropertyValues ? "[not(@i)]" : "";
 	const returnedSequences = [];
 	const xqueryDeclarations = ["declare namespace map = \"http://marklogic.com/xdmp/map\";", `declare function local:increment-count($counts, $key) {
@@ -173,7 +176,7 @@ declare function local:normalize-data-type($data-type) {
 
 declare function local:value-display-text($v) {
   if ($v/content)
-  then string-join($v/content[@xml:lang="eng"]//text(), "")
+  then string-join($v/content[@xml:lang=${languageLiteral}]//text(), "")
   else string($v)
 };
 
@@ -325,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="eng"]//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="eng"]//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;
 	}
@@ -424,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;
@@ -439,6 +433,7 @@ function collectAttributeValues(parsedAttributeValues) {
 * @param parameters.attributes.bibliographies - Whether to return values for bibliographies
 * @param parameters.attributes.periods - Whether to return values for periods
 * @param parameters.isLimitedToLeafPropertyValues - Whether to limit the property values to leaf property values
+* @param parameters.language - Language of the text value, bibliography, and period labels that facets are keyed by (defaults to `"eng"`)
 * @param options - Options for the fetch
 * @param options.fetch - The fetch function to use
 * @returns Parsed Set property values and requested attribute values.
@@ -446,7 +441,7 @@ function collectAttributeValues(parsedAttributeValues) {
 */
 async function fetchSetPropertyValues(parameters, options) {
 	try {
-		const { setScopeUuids, belongsToCollectionScopeUuids, queries, attributes, isLimitedToLeafPropertyValues } = v.parse(setPropertyValuesParametersSchema, parameters);
+		const { setScopeUuids, belongsToCollectionScopeUuids, queries, attributes, isLimitedToLeafPropertyValues, language } = v.parse(setPropertyValuesParametersSchema, parameters);
 		const propertyFacetSelectors = getPropertyFacetSelectors(queries);
 		if (propertyFacetSelectors.length === 0 && !attributes.bibliographies && !attributes.periods) return {
 			propertyValues: [],
@@ -464,7 +459,8 @@ async function fetchSetPropertyValues(parameters, options) {
 			queries,
 			propertyFacetSelectors,
 			attributes,
-			isLimitedToLeafPropertyValues
+			isLimitedToLeafPropertyValues,
+			language
 		});
 		const output = await requestOchre({
 			xquery,

package/dist/query.mjs

@@ -229,11 +229,8 @@ function buildAndCtsQueryExpression(queryExpressions) {
 	return buildAndCtsQueryExpressionInternal(queryExpressions);
 }
 function buildContentLanguageQuery(language) {
-	return buildPlainElementAttributeValueQueryExpression({
-		elementName: "content",
-		attributeName: "xml:lang",
-		value: searchValue(language)
-	});
+	const languageValue = searchValue(language);
+	return `cts:element-attribute-value-query(xs:QName("content"), xs:QName("xml:lang"), ${languageValue.expression}, fn:concat("lang=", ${languageValue.expression}))`;
 }
 function buildPropertyLabelQuery(propertyVariable) {
 	return buildPlainElementAttributeValueQueryExpression({

package/dist/schemas.d.mts

@@ -54,6 +54,7 @@ export declare const setPropertyValuesParametersSchema: v.ObjectSchema<{
     readonly periods: false;
   }>;
   readonly isLimitedToLeafPropertyValues: v.GenericSchema<unknown, boolean>;
+  readonly language: v.GenericSchema<unknown, string>;
 }, undefined>;
 /**
  * Schema for validating the parameters for the item OCR data fetching function

package/dist/schemas.mjs

@@ -237,7 +237,8 @@ const setPropertyValuesParametersSchema = v.object({
 		bibliographies: false,
 		periods: false
 	}),
-	isLimitedToLeafPropertyValues: defaultBoolean(false)
+	isLimitedToLeafPropertyValues: defaultBoolean(false),
+	language: defaultString("eng")
 });
 /**
 * Schema for validating the parameters for the item OCR data fetching function

package/dist/types/index.d.mts

@@ -794,10 +794,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/package.json

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