ochre-sdk 0.20.1 → 0.20.3

package/dist/index.d.mts

@@ -648,12 +648,37 @@ type PropertyValueQueryItem = {
  */
 type Query = {
   target: "propertyValue";
-  dataType: Exclude<PropertyValueContentType, "coordinate">;
+  dataType: Exclude<Exclude<PropertyValueContentType, "coordinate">, "date" | "dateTime">;
+  value: string;
+  from?: never;
+  to?: never;
+  matchMode: "includes" | "exact";
+  isCaseSensitive: boolean;
+  language: string;
+  operator?: "AND" | "OR";
+  isNegated?: boolean;
+} | {
+  target: "propertyValue";
+  dataType: "date" | "dateTime";
+  value: string;
+  from: string;
+  to?: string;
+  matchMode: "includes" | "exact";
+  isCaseSensitive: boolean;
+  language: string;
+  operator?: "AND" | "OR";
+  isNegated?: boolean;
+} | {
+  target: "propertyValue";
+  dataType: "date" | "dateTime";
   value: string;
+  from?: string;
+  to: string;
   matchMode: "includes" | "exact";
   isCaseSensitive: boolean;
   language: string;
   operator?: "AND" | "OR";
+  isNegated?: boolean;
 } | {
   target: "title" | "description" | "image" | "periods" | "bibliography";
   value: string;
@@ -661,6 +686,7 @@ type Query = {
   isCaseSensitive: boolean;
   language: string;
   operator?: "AND" | "OR";
+  isNegated?: boolean;
 };
 //#endregion
 //#region src/types/website.d.ts
@@ -1171,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

package/dist/index.mjs

@@ -772,37 +772,64 @@ const setItemsParamsSchema = 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).default([]),
-	queries: z.array(z.discriminatedUnion("target", [z.object({
-		target: z.literal("propertyValue"),
-		dataType: z.enum([
-			"string",
-			"integer",
-			"decimal",
-			"boolean",
-			"date",
-			"dateTime",
-			"time",
-			"IDREF"
-		]),
-		value: z.string(),
-		matchMode: z.enum(["includes", "exact"]),
-		isCaseSensitive: z.boolean(),
-		language: z.string().default("eng"),
-		operator: z.enum(["AND", "OR"]).optional()
-	}), z.object({
-		target: z.enum([
-			"title",
-			"description",
-			"image",
-			"periods",
-			"bibliography"
-		]),
-		value: z.string(),
-		matchMode: z.enum(["includes", "exact"]),
-		isCaseSensitive: z.boolean(),
-		language: z.string().default("eng"),
-		operator: z.enum(["AND", "OR"]).optional()
-	})])).default([]),
+	queries: z.array(z.union([
+		z.object({
+			target: z.literal("propertyValue"),
+			dataType: z.enum([
+				"string",
+				"integer",
+				"decimal",
+				"boolean",
+				"time",
+				"IDREF"
+			]),
+			value: z.string(),
+			matchMode: z.enum(["includes", "exact"]),
+			isCaseSensitive: z.boolean(),
+			language: z.string().default("eng"),
+			operator: z.enum(["AND", "OR"]).optional(),
+			isNegated: z.boolean().optional().default(false)
+		}).strict(),
+		z.object({
+			target: z.literal("propertyValue"),
+			dataType: z.enum(["date", "dateTime"]),
+			value: z.string(),
+			from: z.string(),
+			to: z.string().optional(),
+			matchMode: z.enum(["includes", "exact"]),
+			isCaseSensitive: z.boolean(),
+			language: z.string().default("eng"),
+			operator: z.enum(["AND", "OR"]).optional(),
+			isNegated: z.boolean().optional().default(false)
+		}).strict(),
+		z.object({
+			target: z.literal("propertyValue"),
+			dataType: z.enum(["date", "dateTime"]),
+			value: z.string(),
+			from: z.string().optional(),
+			to: z.string(),
+			matchMode: z.enum(["includes", "exact"]),
+			isCaseSensitive: z.boolean(),
+			language: z.string().default("eng"),
+			operator: z.enum(["AND", "OR"]).optional(),
+			isNegated: z.boolean().optional().default(false)
+		}).strict(),
+		z.object({
+			target: z.enum([
+				"title",
+				"description",
+				"image",
+				"periods",
+				"bibliography"
+			]),
+			value: z.string(),
+			matchMode: z.enum(["includes", "exact"]),
+			isCaseSensitive: z.boolean(),
+			language: z.string().default("eng"),
+			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),
 	pageSize: z.number().min(1, "Page size must be positive").default(DEFAULT_PAGE_SIZE)
 }).superRefine((value, ctx) => {
@@ -2089,13 +2116,27 @@ function buildStringMatchPredicate(params) {
 	return `${comparedPath} = ${comparedValueLiteral}`;
 }
 /**
+* Build a date/dateTime range predicate for an XQuery string.
+*/
+function buildDateRangePredicate(params) {
+	const { from, to } = params;
+	const conditions = [];
+	if (from != null) conditions.push(`(value/@rawValue ge ${stringLiteral(from)})`);
+	if (to != null) conditions.push(`(value/@rawValue le ${stringLiteral(to)})`);
+	return conditions.join(" and ");
+}
+/**
 * Build a property value predicate for an XQuery string
 * @param query - The propertyValue query
 * @returns The property value predicate
 */
 function buildPropertyValuePredicate(query) {
 	if (query.dataType === "IDREF") return `.//properties//property[value[@uuid=${stringLiteral(query.value)}]]`;
-	if (query.dataType === "date" || query.dataType === "dateTime" || query.dataType === "time" || query.dataType === "integer" || query.dataType === "decimal" || query.dataType === "boolean") return `.//properties//property[value[@rawValue=${stringLiteral(query.value)}]]`;
+	if (query.dataType === "date" || query.dataType === "dateTime") return `.//properties//property[(label/@uuid=${stringLiteral(query.value)}) and ${buildDateRangePredicate({
+		from: query.from,
+		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({
 		path: `string-join(value/content[@xml:lang="${query.language}"]/string, "")`,
 		value: query.value,
@@ -2109,43 +2150,54 @@ function buildPropertyValuePredicate(query) {
 * @returns The query predicate
 */
 function buildQueryPredicate(query) {
-	const stringMatchParams = {
-		value: query.value,
-		matchMode: query.matchMode,
-		isCaseSensitive: query.isCaseSensitive,
-		language: query.language
-	};
 	switch (query.target) {
 		case "title": return buildStringMatchPredicate({
 			path: `string-join(identification/label/content[@xml:lang="${query.language}"]/string, "")`,
-			...stringMatchParams
+			value: query.value,
+			matchMode: query.matchMode,
+			isCaseSensitive: query.isCaseSensitive
 		});
 		case "description": return buildStringMatchPredicate({
 			path: `string-join(description/content[@xml:lang="${query.language}"]/string, "")`,
-			...stringMatchParams
+			value: query.value,
+			matchMode: query.matchMode,
+			isCaseSensitive: query.isCaseSensitive
 		});
 		case "periods": return buildStringMatchPredicate({
 			path: `string-join(periods/period/identification/label/content[@xml:lang="${query.language}"]/string, "")`,
-			...stringMatchParams
+			value: query.value,
+			matchMode: query.matchMode,
+			isCaseSensitive: query.isCaseSensitive
 		});
 		case "bibliography": return buildStringMatchPredicate({
 			path: `string-join(bibliographies/bibliography/identification/label/content[@xml:lang="${query.language}"]/string, "")`,
-			...stringMatchParams
+			value: query.value,
+			matchMode: query.matchMode,
+			isCaseSensitive: query.isCaseSensitive
 		});
 		case "image": return buildStringMatchPredicate({
 			path: `string-join(image/identification/label/content[@xml:lang="${query.language}"]/string, "")`,
-			...stringMatchParams
+			value: query.value,
+			matchMode: query.matchMode,
+			isCaseSensitive: query.isCaseSensitive
 		});
 		case "propertyValue": return buildPropertyValuePredicate(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
@@ -2159,9 +2211,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) {
@@ -2194,7 +2246,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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "0.20.1",
+  "version": "0.20.3",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -47,13 +47,12 @@
   },
   "devDependencies": {
     "@antfu/eslint-config": "^7.6.1",
-    "@types/node": "^24.10.13",
+    "@types/node": "^24.10.14",
     "bumpp": "^10.4.1",
     "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"
   }
 }