ochre-sdk 0.20.3 → 0.20.5

package/dist/index.d.mts

@@ -1238,6 +1238,7 @@ declare function fetchSetItems<U extends Array<DataCategory> = Array<DataCategor
  * @param params.setScopeUuids - An array of set scope UUIDs to filter by
  * @param params.belongsToCollectionScopeUuids - The collection scope UUIDs to filter by
  * @param params.propertyVariableUuids - The property variable UUIDs to query by
+ * @param params.isLimitedToLeafPropertyValues - Whether to limit the property values to leaf property values
  * @param options - Options for the fetch
  * @param options.fetch - The fetch function to use
  * @param options.version - The version of the OCHRE API to use
@@ -1247,6 +1248,7 @@ declare function fetchSetPropertyValuesByPropertyVariables(params: {
   setScopeUuids: Array<string>;
   belongsToCollectionScopeUuids: Array<string>;
   propertyVariableUuids: Array<string>;
+  isLimitedToLeafPropertyValues?: boolean;
 }, options?: {
   fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
   version?: ApiVersion;

package/dist/index.mjs

@@ -766,7 +766,8 @@ const boundsSchema = z.string().transform((str, ctx) => {
 const setPropertyValuesByPropertyVariablesParamsSchema = z.object({
 	setScopeUuids: z.array(uuidSchema).min(1, "At least one set scope UUID is required"),
 	belongsToCollectionScopeUuids: z.array(uuidSchema).default([]),
-	propertyVariableUuids: z.array(uuidSchema).min(1, "At least one property variable UUID is required")
+	propertyVariableUuids: z.array(uuidSchema).min(1, "At least one property variable UUID is required"),
+	isLimitedToLeafPropertyValues: z.boolean().default(false)
 });
 const setItemsParamsSchema = z.object({
 	setScopeUuids: z.array(uuidSchema).min(1, "At least one set scope UUID is required"),
@@ -2394,13 +2395,14 @@ const responseSchema = z.object({ result: z.union([z.object({ ochre: z.object({
 * @param params.setScopeUuids - An array of set scope UUIDs to filter by
 * @param params.belongsToCollectionScopeUuids - An array of collection scope UUIDs to filter by
 * @param params.propertyVariableUuids - An array of property variable UUIDs to fetch
+* @param params.isLimitedToLeafPropertyValues - Whether to limit the property values to leaf property values
 * @param options - Options for the fetch
 * @param options.version - The version of the OCHRE API to use
 * @returns An XQuery string
 */
 function buildXQuery(params, options) {
 	const version = options?.version ?? DEFAULT_API_VERSION;
-	const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids } = params;
+	const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids, isLimitedToLeafPropertyValues } = params;
 	let setScopeFilter = "";
 	if (setScopeUuids.length > 0) setScopeFilter = `/set[(${setScopeUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ")})]/items`;
 	let collectionScopeFilter = "";
@@ -2411,10 +2413,10 @@ function buildXQuery(params, options) {
       ${collectionScopeFilter}
       //property[label/(${propertyVariableFilters})]
 
-  for $v in $matching-props/value
+  for $v in $matching-props/value${isLimitedToLeafPropertyValues ? "[not(@i)]" : ""}
     let $item-uuid := $v/ancestor::*[parent::items]/@uuid
     return <propertyValue uuid="{$v/@uuid}" rawValue="{$v/@rawValue}" dataType="{$v/@dataType}" itemUuid="{$item-uuid}">{
-      if ($v/content) then $v/content else $v/text()
+      if ($v/content) then string-join($v/content[@xml:lang="eng"]/string, "") else $v/text()
     }</propertyValue>`}}</ochre>`;
 }
 /**
@@ -2424,6 +2426,7 @@ function buildXQuery(params, options) {
 * @param params.setScopeUuids - An array of set scope UUIDs to filter by
 * @param params.belongsToCollectionScopeUuids - The collection scope UUIDs to filter by
 * @param params.propertyVariableUuids - The property variable UUIDs to query by
+* @param params.isLimitedToLeafPropertyValues - Whether to limit the property values to leaf property values
 * @param options - Options for the fetch
 * @param options.fetch - The fetch function to use
 * @param options.version - The version of the OCHRE API to use
@@ -2432,11 +2435,12 @@ function buildXQuery(params, options) {
 async function fetchSetPropertyValuesByPropertyVariables(params, options) {
 	try {
 		const version = options?.version ?? DEFAULT_API_VERSION;
-		const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids } = setPropertyValuesByPropertyVariablesParamsSchema.parse(params);
+		const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids, isLimitedToLeafPropertyValues } = setPropertyValuesByPropertyVariablesParamsSchema.parse(params);
 		const xquery = buildXQuery({
 			setScopeUuids,
 			belongsToCollectionScopeUuids,
-			propertyVariableUuids
+			propertyVariableUuids,
+			isLimitedToLeafPropertyValues
 		}, { version });
 		const response = await (options?.fetch ?? fetch)(version === 2 ? `https://ochre.lib.uchicago.edu/ochre/v2/ochre.php?xquery=${encodeURIComponent(xquery)}&format=json&lang="*"` : `https://ochre.lib.uchicago.edu/ochre?xquery=${encodeURIComponent(xquery)}&format=json&lang="*"`);
 		if (!response.ok) throw new Error(`OCHRE API responded with status: ${response.status}`);

package/package.json

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