ochre-sdk 0.20.16 → 0.20.17

package/dist/index.d.mts

@@ -1269,9 +1269,9 @@ declare function fetchSetItems<U extends Array<DataCategory> = Array<DataCategor
  * @param params.belongsToCollectionScopeUuids - The collection scope UUIDs to filter by
  * @param params.propertyVariableUuids - The property variable UUIDs to query by
  * @param params.queries - Ordered queries to combine with AND/OR and optional NOT via negation
- * @param params.attributeQueries - Whether to return values for bibliographies and periods
- * @param params.attributeQueries.bibliographies - Whether to return values for bibliographies
- * @param params.attributeQueries.periods - Whether to return values for periods
+ * @param params.attributes - Whether to return values for bibliographies and periods
+ * @param params.attributes.bibliographies - Whether to return values for bibliographies
+ * @param params.attributes.periods - Whether to return values for periods
  * @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
@@ -1284,7 +1284,7 @@ declare function fetchSetPropertyValuesByPropertyVariables(params: {
   belongsToCollectionScopeUuids: Array<string>;
   propertyVariableUuids: Array<string>;
   queries?: Array<Query>;
-  attributeQueries?: {
+  attributes?: {
     bibliographies: boolean;
     periods: boolean;
   };

package/dist/index.mjs

@@ -875,7 +875,7 @@ const setPropertyValuesByPropertyVariablesParamsSchema = z.object({
 	belongsToCollectionScopeUuids: z.array(uuidSchema).default([]),
 	propertyVariableUuids: z.array(uuidSchema).min(1, "At least one property variable UUID is required"),
 	queries: setQueriesSchema,
-	attributeQueries: z.object({
+	attributes: z.object({
 		bibliographies: z.boolean().default(false),
 		periods: z.boolean().default(false)
 	}).default({
@@ -2602,9 +2602,9 @@ const responseSchema = z.object({ result: z.union([z.object({ ochre: z.object({
 * @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.queries - Ordered queries to combine with AND/OR and optional NOT via negation
-* @param params.attributeQueries - Whether to return values for bibliographies and periods
-* @param params.attributeQueries.bibliographies - Whether to return values for bibliographies
-* @param params.attributeQueries.periods - Whether to return values for periods
+* @param params.attributes - Whether to return values for bibliographies and periods
+* @param params.attributes.bibliographies - Whether to return values for bibliographies
+* @param params.attributes.periods - Whether to return values for periods
 * @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
@@ -2612,7 +2612,7 @@ 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, queries, attributeQueries, isLimitedToLeafPropertyValues } = params;
+	const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids, queries, attributes, 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 ");
@@ -2635,7 +2635,7 @@ let $property-values :=
       if ($v/content) then string-join($v/content[@xml:lang="eng"]/string, "") else $v/text()
     }</propertyValue>`];
 	const returnedSequences = ["$property-values"];
-	if (attributeQueries.bibliographies) {
+	if (attributes.bibliographies) {
 		queryBlocks.push(`let $bibliography-values :=
   for $item in $items
   for $bibliography in $item/bibliographies/bibliography
@@ -2644,7 +2644,7 @@ let $property-values :=
     return <attributeValue attributeType="bibliographies" itemUuid="{$item/@uuid}" content="{$label}" />`);
 		returnedSequences.push("$bibliography-values");
 	}
-	if (attributeQueries.periods) {
+	if (attributes.periods) {
 		queryBlocks.push(`let $period-values :=
   for $item in $items
   for $period in $item/periods/period
@@ -2669,9 +2669,9 @@ return (${returnedSequences.join(", ")})`}}</ochre>`;
 * @param params.belongsToCollectionScopeUuids - The collection scope UUIDs to filter by
 * @param params.propertyVariableUuids - The property variable UUIDs to query by
 * @param params.queries - Ordered queries to combine with AND/OR and optional NOT via negation
-* @param params.attributeQueries - Whether to return values for bibliographies and periods
-* @param params.attributeQueries.bibliographies - Whether to return values for bibliographies
-* @param params.attributeQueries.periods - Whether to return values for periods
+* @param params.attributes - Whether to return values for bibliographies and periods
+* @param params.attributes.bibliographies - Whether to return values for bibliographies
+* @param params.attributes.periods - Whether to return values for periods
 * @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
@@ -2682,13 +2682,13 @@ return (${returnedSequences.join(", ")})`}}</ochre>`;
 async function fetchSetPropertyValuesByPropertyVariables(params, options) {
 	try {
 		const version = options?.version ?? DEFAULT_API_VERSION;
-		const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids, queries, attributeQueries, isLimitedToLeafPropertyValues } = setPropertyValuesByPropertyVariablesParamsSchema.parse(params);
+		const { setScopeUuids, belongsToCollectionScopeUuids, propertyVariableUuids, queries, attributes, isLimitedToLeafPropertyValues } = setPropertyValuesByPropertyVariablesParamsSchema.parse(params);
 		const xquery = buildXQuery({
 			setScopeUuids,
 			belongsToCollectionScopeUuids,
 			propertyVariableUuids,
 			queries,
-			attributeQueries,
+			attributes,
 			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="*"`);
@@ -2728,8 +2728,8 @@ async function fetchSetPropertyValuesByPropertyVariables(params, options) {
 			propertyValues: aggregatePropertyValues(flattenedPropertyValues),
 			propertyValuesByPropertyVariableUuid,
 			attributeValues: {
-				bibliographies: attributeQueries.bibliographies ? aggregateAttributeValues(attributeValuesByTypeRaw.bibliographies) : null,
-				periods: attributeQueries.periods ? aggregateAttributeValues(attributeValuesByTypeRaw.periods) : null
+				bibliographies: attributes.bibliographies ? aggregateAttributeValues(attributeValuesByTypeRaw.bibliographies) : null,
+				periods: attributes.periods ? aggregateAttributeValues(attributeValuesByTypeRaw.periods) : null
 			},
 			error: null
 		};

package/package.json

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