ochre-sdk 1.2.0 → 1.3.0

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

@@ -2,6 +2,7 @@ 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";
@@ -26,7 +27,7 @@ async function fetchSetItemLocations(parameters, options) {
       $item/identification,
       $item/coordinates,
       for $value in $item//properties//property[label/@uuid = $propertyVariableUuids]/value[@uuid]
-      return <value variable="{$value/../label/@uuid}" uuid="{$value/@uuid}"/>
+      return <value variable="{$value/../label/@uuid}" uuid="{$value/@uuid}">{$value/content}</value>
     }</itemLocation>
   }</items>`
 			}),
@@ -49,7 +50,8 @@ async function fetchSetItemLocations(parameters, options) {
 				seenPropertyValues.add(key);
 				propertyValues.push({
 					variableUuid: value.variable,
-					valueUuid: value.uuid
+					valueUuid: value.uuid,
+					label: parseRequiredContentLike(value, { languages })
 				});
 			}
 			itemsByUuid.set(itemLocation.uuid, {

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

@@ -150,10 +150,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 +175,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)
 };
 
@@ -332,7 +334,7 @@ let $_bibliography-aggregation := xdmp:eager(
   let $seen := map:map()
   return
     for $bibliography in $item/bibliographies/bibliography${notSupplemental}
-    let $label := string-join($bibliography/identification/label/content[@xml:lang="eng"]//text(), "")
+    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)
 )
@@ -352,7 +354,7 @@ let $_period-aggregation := xdmp:eager(
   let $seen := map:map()
   return
     for $period in $item/periods/period${notSupplemental}
-    let $label := string-join($period/identification/label/content[@xml:lang="eng"]//text(), "")
+    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)
 )
@@ -439,6 +441,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 +449,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 +467,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

@@ -576,6 +576,7 @@ export type SetItemLocation<T extends LanguageCodes = LanguageCodes> = {
   propertyValues: Array<{
     variableUuid: string;
     valueUuid: string;
+    label: MultilingualString<T>;
   }>;
 };
 /**

package/dist/xml/schemas.d.mts

@@ -4668,10 +4668,31 @@ export declare const XMLSetItemLocationsData: v.ObjectSchema<{
               }, "XMLCoordinatesSource: Shape error">], undefined>, undefined>;
             }, "XMLCoordinates: Shape error">], "XMLCoordinates: Shape error">, undefined>;
           }, "XMLCoordinates: Shape error">, undefined>;
-          readonly value: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+          readonly value: v.OptionalSchema<v.ArraySchema<v.IntersectSchema<[v.ObjectSchema<{
             readonly variable: v.StringSchema<"XMLSetItemLocation: value variable is string and required">;
             readonly uuid: v.StringSchema<"XMLSetItemLocation: value uuid is string and required">;
-          }, "XMLSetItemLocation: value is object with variable and uuid">, undefined>, undefined>;
+          }, "XMLSetItemLocation: value is object with variable and uuid">, v.ObjectSchema<{
+            readonly content: v.ArraySchema<v.ObjectSchema<{
+              readonly links: v.OptionalSchema<v.LazySchema<v.GenericSchema<unknown, XMLLink$1>>, undefined>;
+              readonly properties: v.OptionalSchema<v.ObjectSchema<{
+                readonly property: v.ArraySchema<v.LazySchema<v.GenericSchema<unknown, XMLProperty>>, "XMLRichTextEnvelope: properties is array of XMLProperty">;
+              }, undefined>, undefined>;
+              readonly annotation: v.OptionalSchema<v.StringSchema<"XMLRichTextEnvelope: annotation is string and optional">, undefined>;
+              readonly string: v.ArraySchema<v.ObjectSchema<{
+                string: v.OptionalSchema<v.ArraySchema<v.LazySchema<v.GenericSchema<unknown, XMLString>>, "XMLString: string is array of XMLString">, undefined>;
+                links: v.OptionalSchema<v.LazySchema<v.GenericSchema<unknown, XMLLink$1>>, undefined>;
+                properties: v.OptionalSchema<v.ObjectSchema<{
+                  readonly property: v.ArraySchema<v.LazySchema<v.GenericSchema<unknown, XMLProperty>>, "XMLRichTextEnvelope: properties is array of XMLProperty">;
+                }, undefined>, undefined>;
+                annotation: v.OptionalSchema<v.StringSchema<"XMLRichTextEnvelope: annotation is string and optional">, undefined>;
+                payload: v.OptionalSchema<v.StringSchema<"XMLString: payload is string and optional">, undefined>;
+                rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
+                whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
+              }, "XMLString: Shape error">, undefined>;
+              readonly title: v.OptionalSchema<v.StringSchema<"XMLContent: title is string and optional">, undefined>;
+              readonly lang: v.StringSchema<"XMLContent: lang is string and required">;
+            }, undefined>, "XMLContent: content is array of object with string, title, and lang">;
+          }, "XMLContent: Shape error">], undefined>, undefined>, undefined>;
         }, "XMLSetItemLocation: Shape error">, "XMLSetItemLocationsData: itemLocation is array of XMLSetItemLocation">, undefined>;
       }, "XMLSetItemLocationsData: items is object with totalCount">;
     }, "XMLSetItemLocationsData: ochre">;

package/dist/xml/schemas.mjs

@@ -933,10 +933,10 @@ const XMLSetItemLocation = v.object({
 	category: v.string("XMLSetItemLocation: category is string and required"),
 	identification: XMLIdentification,
 	coordinates: v.optional(XMLCoordinates),
-	value: v.optional(v.array(v.object({
+	value: v.optional(v.array(v.intersect([v.object({
 		variable: v.string("XMLSetItemLocation: value variable is string and required"),
 		uuid: v.string("XMLSetItemLocation: value uuid is string and required")
-	}, "XMLSetItemLocation: value is object with variable and uuid")))
+	}, "XMLSetItemLocation: value is object with variable and uuid"), XMLContent])))
 }, "XMLSetItemLocation: Shape error");
 const XMLSetItemLocationsData = v.object({ result: v.object({ ochre: v.object({ items: v.object({
 	totalCount: XMLNumber,

package/dist/xml/types.d.mts

@@ -897,7 +897,7 @@ export type XMLSetItemLocation = {
   value?: Array<{
     variable: string;
     uuid: string;
-  }>;
+  } & XMLContent>;
 };
 export type XMLSetItemLocationsData = {
   result: {

package/package.json

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