ochre-sdk 0.20.2 → 0.20.4

package/dist/index.d.mts

@@ -656,6 +656,7 @@ type Query = {
   isCaseSensitive: boolean;
   language: string;
   operator?: "AND" | "OR";
+  isNegated?: boolean;
 } | {
   target: "propertyValue";
   dataType: "date" | "dateTime";
@@ -666,6 +667,7 @@ type Query = {
   isCaseSensitive: boolean;
   language: string;
   operator?: "AND" | "OR";
+  isNegated?: boolean;
 } | {
   target: "propertyValue";
   dataType: "date" | "dateTime";
@@ -676,6 +678,7 @@ type Query = {
   isCaseSensitive: boolean;
   language: string;
   operator?: "AND" | "OR";
+  isNegated?: boolean;
 } | {
   target: "title" | "description" | "image" | "periods" | "bibliography";
   value: string;
@@ -683,6 +686,7 @@ type Query = {
   isCaseSensitive: boolean;
   language: string;
   operator?: "AND" | "OR";
+  isNegated?: boolean;
 };
 //#endregion
 //#region src/types/website.d.ts
@@ -1193,7 +1197,7 @@ declare function fetchItem<T extends DataCategory = DataCategory, U extends Data
  * @param params.setScopeUuids - The Set scope UUIDs to filter by
  * @param params.belongsToCollectionScopeUuids - The collection scope UUIDs to filter by
  * @param params.propertyVariableUuids - The property variable UUIDs to filter by
- * @param params.queries - Ordered queries to combine with AND/OR
+ * @param params.queries - Ordered queries to combine with AND/OR and optional NOT via negation
  * @param params.page - The page number (1-indexed)
  * @param params.pageSize - The number of items per page
  * @param itemCategories - The categories of the items to fetch
@@ -1234,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
@@ -1243,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"),
@@ -787,7 +788,8 @@ const setItemsParamsSchema = z.object({
 			matchMode: z.enum(["includes", "exact"]),
 			isCaseSensitive: z.boolean(),
 			language: z.string().default("eng"),
-			operator: z.enum(["AND", "OR"]).optional()
+			operator: z.enum(["AND", "OR"]).optional(),
+			isNegated: z.boolean().optional().default(false)
 		}).strict(),
 		z.object({
 			target: z.literal("propertyValue"),
@@ -798,7 +800,8 @@ const setItemsParamsSchema = z.object({
 			matchMode: z.enum(["includes", "exact"]),
 			isCaseSensitive: z.boolean(),
 			language: z.string().default("eng"),
-			operator: z.enum(["AND", "OR"]).optional()
+			operator: z.enum(["AND", "OR"]).optional(),
+			isNegated: z.boolean().optional().default(false)
 		}).strict(),
 		z.object({
 			target: z.literal("propertyValue"),
@@ -809,7 +812,8 @@ const setItemsParamsSchema = z.object({
 			matchMode: z.enum(["includes", "exact"]),
 			isCaseSensitive: z.boolean(),
 			language: z.string().default("eng"),
-			operator: z.enum(["AND", "OR"]).optional()
+			operator: z.enum(["AND", "OR"]).optional(),
+			isNegated: z.boolean().optional().default(false)
 		}).strict(),
 		z.object({
 			target: z.enum([
@@ -823,7 +827,8 @@ const setItemsParamsSchema = z.object({
 			matchMode: z.enum(["includes", "exact"]),
 			isCaseSensitive: z.boolean(),
 			language: z.string().default("eng"),
-			operator: z.enum(["AND", "OR"]).optional()
+			operator: z.enum(["AND", "OR"]).optional(),
+			isNegated: z.boolean().optional().default(false)
 		}).strict()
 	])).default([]),
 	page: z.number().min(1, "Page must be positive").default(1),
@@ -2181,12 +2186,19 @@ function buildQueryPredicate(query) {
 	}
 }
 /**
+* Build a boolean query clause for an XQuery string.
+*/
+function buildBooleanQueryClause(query) {
+	const baseClause = `(${buildQueryPredicate(query)})`;
+	return query.isNegated ? `not(${baseClause})` : baseClause;
+}
+/**
 * Build an XQuery string to fetch Set items from the OCHRE API
 * @param params - The parameters for the fetch
 * @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 filter by
-* @param params.queries - Ordered queries to combine with AND/OR
+* @param params.queries - Ordered queries to combine with AND/OR and optional NOT via negation
 * @param params.page - The page number (1-indexed)
 * @param params.pageSize - The number of items per page
 * @param options - Options for the fetch
@@ -2200,9 +2212,9 @@ function buildXQuery$1(params, options) {
 	const endPosition = page * pageSize;
 	const setScopeFilter = `/set[(${setScopeUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ")})]/items/*`;
 	const queryFilters = queries.map((query, index) => {
-		const predicate = `(${buildQueryPredicate(query)})`;
-		if (index === 0) return predicate;
-		return `${query.operator === "OR" ? "or" : "and"} ${predicate}`;
+		const clause = buildBooleanQueryClause(query);
+		if (index === 0) return clause;
+		return `${query.operator === "OR" ? "or" : "and"} ${clause}`;
 	}).join(" ");
 	const filterPredicates = [];
 	if (belongsToCollectionScopeUuids.length > 0) {
@@ -2235,7 +2247,7 @@ function buildXQuery$1(params, options) {
 * @param params.setScopeUuids - The Set scope UUIDs to filter by
 * @param params.belongsToCollectionScopeUuids - The collection scope UUIDs to filter by
 * @param params.propertyVariableUuids - The property variable UUIDs to filter by
-* @param params.queries - Ordered queries to combine with AND/OR
+* @param params.queries - Ordered queries to combine with AND/OR and optional NOT via negation
 * @param params.page - The page number (1-indexed)
 * @param params.pageSize - The number of items per page
 * @param itemCategories - The categories of the items to fetch
@@ -2383,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 = "";
@@ -2400,7 +2413,7 @@ 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()
@@ -2413,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
@@ -2421,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.2",
+  "version": "0.20.4",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -52,8 +52,7 @@
     "eslint": "^10.0.2",
     "prettier": "^3.8.1",
     "tsdown": "^0.20.3",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.18"
+    "typescript": "^5.9.3"
   },
   "scripts": {
     "dev": "tsdown src/index.ts --watch",
@@ -65,7 +64,6 @@
     "format": "prettier --cache --check .",
     "format:fix": "prettier --cache --write --list-different .",
     "check-types": "tsc --noEmit",
-    "test": "vitest run",
     "release": "bumpp"
   }
 }