ochre-sdk 0.20.6 → 0.20.7

package/dist/index.d.mts

@@ -1231,6 +1231,12 @@ declare function fetchSetItems<U extends Array<DataCategory> = Array<DataCategor
 }>;
 //#endregion
 //#region src/utils/fetchers/set/property-values-by-property-variables.d.ts
+type SetPropertyValuesByPropertyVariablesTitleQueryInput = {
+  value: string;
+  matchMode: "includes" | "exact";
+  isCaseSensitive: boolean;
+  language?: string;
+};
 /**
  * Fetches and parses Set property values by property variables from the OCHRE API
  *
@@ -1238,6 +1244,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.titleQuery - Title query to filter returned items by item title
  * @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
@@ -1248,6 +1255,7 @@ declare function fetchSetPropertyValuesByPropertyVariables(params: {
   setScopeUuids: Array<string>;
   belongsToCollectionScopeUuids: Array<string>;
   propertyVariableUuids: Array<string>;
+  titleQuery?: SetPropertyValuesByPropertyVariablesTitleQueryInput;
   isLimitedToLeafPropertyValues?: boolean;
 }, options?: {
   fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;

package/dist/index.mjs

@@ -767,6 +767,12 @@ 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"),
+	titleQuery: z.object({
+		value: z.string(),
+		matchMode: z.enum(["includes", "exact"]),
+		isCaseSensitive: z.boolean(),
+		language: z.string().default("eng")
+	}).strict().optional(),
 	isLimitedToLeafPropertyValues: z.boolean().default(false)
 });
 const setItemsParamsSchema = z.object({
@@ -2109,7 +2115,7 @@ async function fetchItem(uuid, category, itemCategories, options) {
 * @param params.isCaseSensitive - Whether to match case-sensitively
 * @returns The string match predicate
 */
-function buildStringMatchPredicate(params) {
+function buildStringMatchPredicate$1(params) {
 	const { path, value, matchMode, isCaseSensitive } = params;
 	const comparedPath = isCaseSensitive ? path : `lower-case(${path})`;
 	const comparedValueLiteral = stringLiteral(isCaseSensitive ? value : value.toLowerCase());
@@ -2138,7 +2144,7 @@ function buildPropertyValuePredicate(query) {
 		to: query.to
 	})}]`;
 	if (query.dataType === "time" || query.dataType === "integer" || query.dataType === "decimal" || query.dataType === "boolean") return `.//properties//property[value[@rawValue=${stringLiteral(query.value)}]]`;
-	return `.//properties//property[${buildStringMatchPredicate({
+	return `.//properties//property[${buildStringMatchPredicate$1({
 		path: `string-join(value/content[@xml:lang="${query.language}"]/string, "")`,
 		value: query.value,
 		matchMode: query.matchMode,
@@ -2152,31 +2158,31 @@ function buildPropertyValuePredicate(query) {
 */
 function buildQueryPredicate(query) {
 	switch (query.target) {
-		case "title": return buildStringMatchPredicate({
+		case "title": return buildStringMatchPredicate$1({
 			path: `string-join(identification/label/content[@xml:lang="${query.language}"]/string, "")`,
 			value: query.value,
 			matchMode: query.matchMode,
 			isCaseSensitive: query.isCaseSensitive
 		});
-		case "description": return buildStringMatchPredicate({
+		case "description": return buildStringMatchPredicate$1({
 			path: `string-join(description/content[@xml:lang="${query.language}"]/string, "")`,
 			value: query.value,
 			matchMode: query.matchMode,
 			isCaseSensitive: query.isCaseSensitive
 		});
-		case "periods": return buildStringMatchPredicate({
+		case "periods": return buildStringMatchPredicate$1({
 			path: `string-join(periods/period/identification/label/content[@xml:lang="${query.language}"]/string, "")`,
 			value: query.value,
 			matchMode: query.matchMode,
 			isCaseSensitive: query.isCaseSensitive
 		});
-		case "bibliography": return buildStringMatchPredicate({
+		case "bibliography": return buildStringMatchPredicate$1({
 			path: `string-join(bibliographies/bibliography/identification/label/content[@xml:lang="${query.language}"]/string, "")`,
 			value: query.value,
 			matchMode: query.matchMode,
 			isCaseSensitive: query.isCaseSensitive
 		});
-		case "image": return buildStringMatchPredicate({
+		case "image": return buildStringMatchPredicate$1({
 			path: `string-join(image/identification/label/content[@xml:lang="${query.language}"]/string, "")`,
 			value: query.value,
 			matchMode: query.matchMode,
@@ -2391,6 +2397,35 @@ function aggregatePropertyValues(values) {
 	});
 }
 /**
+* Build a string match predicate for an XQuery string
+* @param params - The parameters for the predicate
+* @param params.path - The path to the string
+* @param params.value - The value to match
+* @param params.matchMode - The match mode (includes or exact)
+* @param params.isCaseSensitive - Whether to match case-sensitively
+* @returns The string match predicate
+*/
+function buildStringMatchPredicate(params) {
+	const { path, value, matchMode, isCaseSensitive } = params;
+	const comparedPath = isCaseSensitive ? path : `lower-case(${path})`;
+	const comparedValueLiteral = stringLiteral(isCaseSensitive ? value : value.toLowerCase());
+	if (matchMode === "includes") return `contains(${comparedPath}, ${comparedValueLiteral})`;
+	return `${comparedPath} = ${comparedValueLiteral}`;
+}
+/**
+* Build a title predicate for an XQuery string
+* @param titleQuery - The title query
+* @returns The title predicate
+*/
+function buildTitlePredicate(titleQuery) {
+	return buildStringMatchPredicate({
+		path: `string-join(identification/label/content[@xml:lang="${titleQuery.language}"]/string, "")`,
+		value: titleQuery.value,
+		matchMode: titleQuery.matchMode,
+		isCaseSensitive: titleQuery.isCaseSensitive
+	});
+}
+/**
 * Schema for a single property value query item in the OCHRE API response
 */
 const propertyValueQueryItemSchema = z.object({
@@ -2447,6 +2482,7 @@ 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.titleQuery - Title query to filter returned items by item title
 * @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
@@ -2454,16 +2490,22 @@ const responseSchema = z.object({ result: z.union([z.object({ ochre: z.object({
 */
 function buildXQuery(params, options) {
 	const version = options?.version ?? DEFAULT_API_VERSION;
-	const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids, isLimitedToLeafPropertyValues } = params;
-	let setScopeFilter = "";
-	if (setScopeUuids.length > 0) setScopeFilter = `/set[(${setScopeUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ")})]/items`;
-	let collectionScopeFilter = "";
-	if (belongsToCollectionScopeUuids.length > 0) collectionScopeFilter = `//properties[property[label/@uuid="${BELONGS_TO_COLLECTION_UUID}" and value/(${belongsToCollectionScopeUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ")})]]`;
+	const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids, titleQuery, isLimitedToLeafPropertyValues } = params;
+	let setScopeFilter = "/set/items/*";
+	if (setScopeUuids.length > 0) setScopeFilter = `/set[(${setScopeUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ")})]/items/*`;
 	const propertyVariableFilters = propertyVariableUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ");
-	return `<ochre>{${`let $matching-props := ${version === 2 ? "doc()" : "input()"}/ochre
+	const filterPredicates = [];
+	if (belongsToCollectionScopeUuids.length > 0) {
+		const belongsToCollectionScopeValues = belongsToCollectionScopeUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ");
+		filterPredicates.push(`.//properties[property[label/@uuid="${BELONGS_TO_COLLECTION_UUID}" and value/(${belongsToCollectionScopeValues})]]`);
+	}
+	if (titleQuery != null) filterPredicates.push(buildTitlePredicate(titleQuery));
+	const itemFilters = filterPredicates.length > 0 ? `[${filterPredicates.join(" and ")}]` : "";
+	return `<ochre>{${`let $items := ${version === 2 ? "doc()" : "input()"}/ochre
       ${setScopeFilter}
-      ${collectionScopeFilter}
-      //property[label/(${propertyVariableFilters})]
+      ${itemFilters}
+
+  let $matching-props := $items//property[label/(${propertyVariableFilters})]
 
   for $p in $matching-props
   for $v in $p/value${isLimitedToLeafPropertyValues ? "[not(@i)]" : ""}
@@ -2480,6 +2522,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.titleQuery - Title query to filter returned items by item title
 * @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
@@ -2489,11 +2532,12 @@ function buildXQuery(params, options) {
 async function fetchSetPropertyValuesByPropertyVariables(params, options) {
 	try {
 		const version = options?.version ?? DEFAULT_API_VERSION;
-		const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids, isLimitedToLeafPropertyValues } = setPropertyValuesByPropertyVariablesParamsSchema.parse(params);
+		const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids, titleQuery, isLimitedToLeafPropertyValues } = setPropertyValuesByPropertyVariablesParamsSchema.parse(params);
 		const xquery = buildXQuery({
 			setScopeUuids,
 			belongsToCollectionScopeUuids,
 			propertyVariableUuids,
+			titleQuery,
 			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="*"`);

package/package.json

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