ochre-sdk 1.0.27 → 1.0.29

package/dist/fetchers/item.mjs

@@ -109,7 +109,7 @@ async function fetchItem(uuid, options) {
 			const categories = [];
 			for (const possibleCategory of options.category) if (isItemCategoryWithEmbeddedItems(possibleCategory)) categories.push(possibleCategory);
 			omitEmbeddedItemsCategory = categories;
-			shouldFetchOmittedEmbeddedItems = categories.length > 0;
+			shouldFetchOmittedEmbeddedItems = shouldOmitEmbeddedItems && categories.length > 0;
 		}
 		const languages = options?.languages == null ? [] : parseLanguages(options.languages);
 		const fetcher = options?.fetch ?? fetch;

package/dist/fetchers/set/items.mjs

@@ -143,6 +143,7 @@ function buildExactStringPropertyPredicate(query) {
 	const propertyPredicates = [];
 	const value = stringLiteral(query.value);
 	if (query.propertyVariable != null) propertyPredicates.push(`label/@uuid = ${stringLiteral(query.propertyVariable)}`);
+	if (query.propertyRelation != null) propertyPredicates.push(`label/@relation = ${stringLiteral(query.propertyRelation)}`);
 	propertyPredicates.push(`value[
     not(@inherited = "true")
     and (

package/dist/fetchers/set/property-values.mjs

@@ -68,19 +68,25 @@ const propertyValueLabelContentSchema = v.object({
 	lang: v.string(),
 	string: v.array(propertyValueLabelStringSchema)
 });
-function getPropertyVariableUuidsFromQueries(queries) {
-	const propertyVariableUuids = /* @__PURE__ */ new Set();
+function getPropertyFacetSelectorsFromQueries(queries) {
+	const propertyFacetSelectors = /* @__PURE__ */ new Map();
 	if (queries == null) return [];
 	const pendingQueries = [queries];
 	for (const query of pendingQueries) {
 		if ("target" in query) {
 			if (query.target !== "property") continue;
-			if (query.propertyVariable != null) propertyVariableUuids.add(query.propertyVariable);
+			if (query.propertyVariable != null) {
+				const relation = query.propertyRelation ?? null;
+				propertyFacetSelectors.set(`${query.propertyVariable}|${relation}`, {
+					uuid: query.propertyVariable,
+					relation
+				});
+			}
 			continue;
 		}
 		pendingQueries.push(..."and" in query ? query.and : query.or);
 	}
-	return [...propertyVariableUuids];
+	return [...propertyFacetSelectors.values()];
 }
 function getItemFilterQueriesFromPropertyValueQueries(queries) {
 	if (queries == null) return null;
@@ -171,7 +177,7 @@ const responseSchema = v.object({ result: v.object({ ochre: v.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.queries - Recursive query tree used to filter matching items
-* @param params.propertyVariableUuids - Property variable UUIDs to aggregate, if any
+* @param params.propertyFacetSelectors - Property variable/relation selectors to aggregate, if any
 * @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
@@ -179,7 +185,7 @@ const responseSchema = v.object({ result: v.object({ ochre: v.object({
 * @returns An XQuery string
 */
 function buildXQuery(params) {
-	const { setScopeUuids, belongsToCollectionScopeUuids, queries, propertyVariableUuids, attributes, isLimitedToLeafPropertyValues } = params;
+	const { setScopeUuids, belongsToCollectionScopeUuids, queries, propertyFacetSelectors, attributes, isLimitedToLeafPropertyValues } = params;
 	const setScopeDeclaration = `declare variable $setScopeUuids := (${setScopeUuids.map((uuid) => stringLiteral(uuid)).join(", ")});`;
 	const baseItemsExpression = "doc()/ochre/set[@uuid = $setScopeUuids]/items/*";
 	const compiledQueryPlan = buildQueryPlan({ queries: getItemFilterQueriesFromPropertyValueQueries(queries) });
@@ -306,9 +312,13 @@ declare function local:add-attribute-facet($counts, $seen, $key) {
 };`
 	];
 	if (compiledQueryPlan.prolog !== "") xqueryDeclarations.push(compiledQueryPlan.prolog);
-	if (propertyVariableUuids.length > 0) {
-		const propertyVariableValues = propertyVariableUuids.map((uuid) => stringLiteral(uuid));
-		xqueryDeclarations.push(`declare variable $facetLabelUuids := (${propertyVariableValues.join(", ")});`);
+	if (propertyFacetSelectors.length > 0) {
+		const facetPropertyPredicates = [];
+		for (const selector of propertyFacetSelectors) {
+			const uuidPredicate = `label/@uuid = ${stringLiteral(selector.uuid)}`;
+			facetPropertyPredicates.push(selector.relation == null ? uuidPredicate : `(${uuidPredicate} and label/@relation = ${stringLiteral(selector.relation)})`);
+		}
+		const facetPropertyPredicate = facetPropertyPredicates.length === 1 ? facetPropertyPredicates[0] ?? "false()" : `(${facetPropertyPredicates.join(" or ")})`;
 		queryBlocks.push(`let $global-property-counts := map:map()
 let $variable-property-counts := map:map()
 let $variable-property-details := map:map()
@@ -318,7 +328,7 @@ let $_property-aggregation := xdmp:eager(
   let $global-seen := map:map()
   let $variable-seen := map:map()
   return
-    for $p in $item/properties/property[label/@uuid = $facetLabelUuids]
+    for $p in $item/properties/property[${facetPropertyPredicate}]
     let $variable-uuid := string($p/label/@uuid)
     for $v in $p/value${valueFilter}
     let $value-uuid := string($v/@uuid)
@@ -420,8 +430,8 @@ return (${returnedSequences.join(", ")})
 async function fetchSetPropertyValues(params, options) {
 	try {
 		const { setScopeUuids, belongsToCollectionScopeUuids, queries, attributes, isLimitedToLeafPropertyValues } = v.parse(setPropertyValuesParamsSchema, params);
-		const propertyVariableUuids = getPropertyVariableUuidsFromQueries(queries);
-		if (propertyVariableUuids.length === 0 && !attributes.bibliographies && !attributes.periods) return {
+		const propertyFacetSelectors = getPropertyFacetSelectorsFromQueries(queries);
+		if (propertyFacetSelectors.length === 0 && !attributes.bibliographies && !attributes.periods) return {
 			propertyValues: [],
 			propertyValuesByPropertyVariableUuid: {},
 			attributeValues: {
@@ -435,7 +445,7 @@ async function fetchSetPropertyValues(params, options) {
 			setScopeUuids,
 			belongsToCollectionScopeUuids,
 			queries,
-			propertyVariableUuids,
+			propertyFacetSelectors,
 			attributes,
 			isLimitedToLeafPropertyValues
 		});

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { MultilingualOptions, MultilingualString, MultilingualStringEntries, MultilingualStringEntry, MultilingualStringInput, MultilingualStringJSON, MultilingualStringObject, MultilingualStringText } from "./parsers/multilingual.mjs";
 import { AccordionWebBlock, ContextTree, ContextTreeFilterLevel, ContextTreeLevel, ContextTreeLevelItem, Scope, Style, StylesheetCategory, StylesheetItem, WebAccordionItem, WebBlock, WebBlockByLayout, WebBlockItem, WebBlockLayout, WebElement, WebElementComponent, WebElementComponentName, WebElementComponentOf, WebElementOf, WebImage, WebTitle, Webpage, Website, WebsiteMetadata, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteSegment, WebsiteType } from "./types/website.mjs";
-import { AnyBibliography, AnyConcept, AnyItem, AnyPeriod, AnyPerson, AnyPropertyValue, AnyPropertyVariable, AnyResource, AnySet, AnySpatialUnit, AnyText, AnyTree, BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, ContainedItemCategory, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Context, ContextItem, ContextItemCategory, ContextNode, Coordinates, CoordinatesSource, DictionaryUnitItemLink, EmbeddedBibliography, EmbeddedConcept, EmbeddedItem, EmbeddedPeriod, EmbeddedPerson, EmbeddedPropertyValue, EmbeddedPropertyVariable, EmbeddedResource, EmbeddedSet, EmbeddedSpatialUnit, EmbeddedText, EmbeddedTree, Event, Gallery, Heading, HeadingItemCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemLink, ItemLinkCategory, ItemLinks, ItemPayloadKind, ItemProperty, ItemWithoutEmbeddedItems, LanguageCodes, License, Metadata, Note, Observation, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyLike, PropertyValue, PropertyValueContent, PropertyValueDataType, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, QueryablePropertyValueDataType, RecursiveItemCategory, Resource, ResourceItemLink, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemCategory, SetItemLink, SetItemProperty, SetItemSimplifiedProperty, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetTree, SimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Text, TextItemLink, TopLevelItem, Tree, TreeItemCategory, TreeItemLink } from "./types/index.mjs";
+import { AnyBibliography, AnyConcept, AnyItem, AnyPeriod, AnyPerson, AnyPropertyValue, AnyPropertyVariable, AnyResource, AnySet, AnySpatialUnit, AnyText, AnyTree, BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, ContainedItemCategory, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Context, ContextItem, ContextItemCategory, ContextNode, Coordinates, CoordinatesSource, DictionaryUnitItemLink, EmbeddedBibliography, EmbeddedConcept, EmbeddedItem, EmbeddedPeriod, EmbeddedPerson, EmbeddedPropertyValue, EmbeddedPropertyVariable, EmbeddedResource, EmbeddedSet, EmbeddedSpatialUnit, EmbeddedText, EmbeddedTree, Event, Gallery, Heading, HeadingItemCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemLink, ItemLinkCategory, ItemLinks, ItemPayloadKind, ItemProperty, ItemWithoutEmbeddedItems, LanguageCodes, License, Metadata, Note, Observation, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyLike, PropertyRelation, PropertyValue, PropertyValueContent, PropertyValueDataType, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, QueryablePropertyValueDataType, RecursiveItemCategory, Resource, ResourceItemLink, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemCategory, SetItemLink, SetItemProperty, SetItemSimplifiedProperty, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetTree, SimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Text, TextItemLink, TopLevelItem, Tree, TreeItemCategory, TreeItemLink } from "./types/index.mjs";
 import { fetchGallery } from "./fetchers/gallery.mjs";
 import { fetchItemLinks } from "./fetchers/item-links.mjs";
 import { defineLanguages, fetchItem, withLanguages } from "./fetchers/item.mjs";
@@ -10,4 +10,4 @@ import { fetchWebsiteMetadata } from "./fetchers/website-metadata.mjs";
 import { fetchWebsite } from "./fetchers/website.mjs";
 import { PropertyOptions, filterProperties, getLeafPropertyValues, getPropertyByVariableLabel, getPropertyByVariableLabelAndValue, getPropertyByVariableLabelAndValueContent, getPropertyByVariableLabelAndValueContents, getPropertyByVariableLabelAndValues, getPropertyByVariableUuid, getPropertyValueByVariableLabel, getPropertyValueByVariableUuid, getPropertyValueContentByVariableLabel, getPropertyValueContentByVariableUuid, getPropertyValueContentsByVariableUuid, getPropertyValuesByVariableLabel, getPropertyValuesByVariableUuid, getUniqueProperties, getUniquePropertyVariableLabels } from "./getters.mjs";
 import { DEFAULT_PAGE_SIZE, flattenItemProperties } from "./helpers.mjs";
-export { type AccordionWebBlock, type AnyBibliography, type AnyConcept, type AnyItem, type AnyPeriod, type AnyPerson, type AnyPropertyValue, type AnyPropertyVariable, type AnyResource, type AnySet, type AnySpatialUnit, type AnyText, type AnyTree, type BaseItem, type BaseItemLink, type BelongsTo, type Bibliography, type BibliographyEntryInfo, type BibliographyItemLink, type BibliographySourceDocument, type Concept, type ConceptItemLink, type ContainedItemCategory, type ContainedItemCategoryFromOption, type ContainedItemCategoryOption, type Context, type ContextItem, type ContextItemCategory, type ContextNode, type ContextTree, type ContextTreeFilterLevel, type ContextTreeLevel, type ContextTreeLevelItem, type Coordinates, type CoordinatesSource, DEFAULT_PAGE_SIZE, type DictionaryUnitItemLink, type EmbeddedBibliography, type EmbeddedConcept, type EmbeddedItem, type EmbeddedPeriod, type EmbeddedPerson, type EmbeddedPropertyValue, type EmbeddedPropertyVariable, type EmbeddedResource, type EmbeddedSet, type EmbeddedSpatialUnit, type EmbeddedText, type EmbeddedTree, type Event, type Gallery, type Heading, type HeadingItemCategory, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type Item, type ItemCategory, type ItemCategoryFromOption, type ItemCategoryOption, type ItemCategoryWithEmbeddedItems, type ItemContainerCategory, type ItemLink, type ItemLinkCategory, type ItemLinks, type ItemPayloadKind, type ItemProperty, type ItemWithoutEmbeddedItems, type LanguageCodes, type License, type Metadata, type MultilingualOptions, MultilingualString, type MultilingualStringEntries, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringObject, type MultilingualStringText, type Note, type Observation, type Period, type PeriodItemLink, type Person, type PersonItemLink, type Property, type PropertyLike, PropertyOptions, type PropertyValue, type PropertyValueContent, type PropertyValueDataType, type PropertyValueItemLink, type PropertyValueQueryItem, type PropertyVariable, type PropertyVariableItemLink, type Query, type QueryGroup, type QueryLeaf, type QueryablePropertyValueDataType, type RecursiveItemCategory, type Resource, type ResourceItemLink, type Scope, type Section, type Set, type SetAttributeValueQueryItem, type SetBibliography, type SetConcept, type SetItem, type SetItemCategory, type SetItemLink, type SetItemProperty, type SetItemSimplifiedProperty, type SetItemsSort, type SetItemsSortDirection, type SetPeriod, type SetResource, type SetSpatialUnit, type SetTree, type SimplifiedProperty, type SpatialUnit, type SpatialUnitItemLink, type Style, type StylesheetCategory, type StylesheetItem, type Text, type TextItemLink, type TopLevelItem, type Tree, type TreeItemCategory, type TreeItemLink, type WebAccordionItem, type WebBlock, type WebBlockByLayout, type WebBlockItem, type WebBlockLayout, type WebElement, type WebElementComponent, type WebElementComponentName, type WebElementComponentOf, type WebElementOf, type WebImage, type WebTitle, type Webpage, type Website, type WebsiteMetadata, type WebsitePropertyQuery, type WebsitePropertyQueryNode, type WebsiteSegment, type WebsiteType, defineLanguages, fetchGallery, fetchItem, fetchItemLinks, fetchSetItems, fetchSetPropertyValues, fetchWebsite, fetchWebsiteMetadata, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByVariableLabel, getPropertyByVariableLabelAndValue, getPropertyByVariableLabelAndValueContent, getPropertyByVariableLabelAndValueContents, getPropertyByVariableLabelAndValues, getPropertyByVariableUuid, getPropertyValueByVariableLabel, getPropertyValueByVariableUuid, getPropertyValueContentByVariableLabel, getPropertyValueContentByVariableUuid, getPropertyValueContentsByVariableUuid, getPropertyValuesByVariableLabel, getPropertyValuesByVariableUuid, getUniqueProperties, getUniquePropertyVariableLabels, withLanguages };
+export { type AccordionWebBlock, type AnyBibliography, type AnyConcept, type AnyItem, type AnyPeriod, type AnyPerson, type AnyPropertyValue, type AnyPropertyVariable, type AnyResource, type AnySet, type AnySpatialUnit, type AnyText, type AnyTree, type BaseItem, type BaseItemLink, type BelongsTo, type Bibliography, type BibliographyEntryInfo, type BibliographyItemLink, type BibliographySourceDocument, type Concept, type ConceptItemLink, type ContainedItemCategory, type ContainedItemCategoryFromOption, type ContainedItemCategoryOption, type Context, type ContextItem, type ContextItemCategory, type ContextNode, type ContextTree, type ContextTreeFilterLevel, type ContextTreeLevel, type ContextTreeLevelItem, type Coordinates, type CoordinatesSource, DEFAULT_PAGE_SIZE, type DictionaryUnitItemLink, type EmbeddedBibliography, type EmbeddedConcept, type EmbeddedItem, type EmbeddedPeriod, type EmbeddedPerson, type EmbeddedPropertyValue, type EmbeddedPropertyVariable, type EmbeddedResource, type EmbeddedSet, type EmbeddedSpatialUnit, type EmbeddedText, type EmbeddedTree, type Event, type Gallery, type Heading, type HeadingItemCategory, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type Item, type ItemCategory, type ItemCategoryFromOption, type ItemCategoryOption, type ItemCategoryWithEmbeddedItems, type ItemContainerCategory, type ItemLink, type ItemLinkCategory, type ItemLinks, type ItemPayloadKind, type ItemProperty, type ItemWithoutEmbeddedItems, type LanguageCodes, type License, type Metadata, type MultilingualOptions, MultilingualString, type MultilingualStringEntries, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringObject, type MultilingualStringText, type Note, type Observation, type Period, type PeriodItemLink, type Person, type PersonItemLink, type Property, type PropertyLike, PropertyOptions, type PropertyRelation, type PropertyValue, type PropertyValueContent, type PropertyValueDataType, type PropertyValueItemLink, type PropertyValueQueryItem, type PropertyVariable, type PropertyVariableItemLink, type Query, type QueryGroup, type QueryLeaf, type QueryablePropertyValueDataType, type RecursiveItemCategory, type Resource, type ResourceItemLink, type Scope, type Section, type Set, type SetAttributeValueQueryItem, type SetBibliography, type SetConcept, type SetItem, type SetItemCategory, type SetItemLink, type SetItemProperty, type SetItemSimplifiedProperty, type SetItemsSort, type SetItemsSortDirection, type SetPeriod, type SetResource, type SetSpatialUnit, type SetTree, type SimplifiedProperty, type SpatialUnit, type SpatialUnitItemLink, type Style, type StylesheetCategory, type StylesheetItem, type Text, type TextItemLink, type TopLevelItem, type Tree, type TreeItemCategory, type TreeItemLink, type WebAccordionItem, type WebBlock, type WebBlockByLayout, type WebBlockItem, type WebBlockLayout, type WebElement, type WebElementComponent, type WebElementComponentName, type WebElementComponentOf, type WebElementOf, type WebImage, type WebTitle, type Webpage, type Website, type WebsiteMetadata, type WebsitePropertyQuery, type WebsitePropertyQueryNode, type WebsiteSegment, type WebsiteType, defineLanguages, fetchGallery, fetchItem, fetchItemLinks, fetchSetItems, fetchSetPropertyValues, fetchWebsite, fetchWebsiteMetadata, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByVariableLabel, getPropertyByVariableLabelAndValue, getPropertyByVariableLabelAndValueContent, getPropertyByVariableLabelAndValueContents, getPropertyByVariableLabelAndValues, getPropertyByVariableUuid, getPropertyValueByVariableLabel, getPropertyValueByVariableUuid, getPropertyValueContentByVariableLabel, getPropertyValueContentByVariableUuid, getPropertyValueContentsByVariableUuid, getPropertyValuesByVariableLabel, getPropertyValuesByVariableUuid, getUniqueProperties, getUniquePropertyVariableLabels, withLanguages };

package/dist/parsers/index.mjs

@@ -522,7 +522,8 @@ function parseProperty(rawProperty, options) {
 		variable: {
 			uuid: rawProperty.label.uuid,
 			label: parseRequiredContentLike(rawProperty.label, options),
-			publicationDateTime: rawProperty.label.publicationDateTime ?? null
+			publicationDateTime: rawProperty.label.publicationDateTime ?? null,
+			relation: rawProperty.label.relation ?? null
 		},
 		values,
 		comment: parseContentLike(rawProperty.comment, options),
@@ -543,7 +544,8 @@ function parseSimplifiedProperty(rawProperty, options) {
 		variable: {
 			uuid: rawProperty.label.uuid,
 			label: parseContentLikeText(rawProperty.label, options),
-			publicationDateTime: rawProperty.label.publicationDateTime ?? null
+			publicationDateTime: rawProperty.label.publicationDateTime ?? null,
+			relation: rawProperty.label.relation ?? null
 		},
 		values,
 		comment: parseContentLike(rawProperty.comment, options),

package/dist/query.mjs

@@ -320,13 +320,18 @@ function buildContentTargetQueryExpression(params) {
 	}));
 }
 function buildPropertyQueryExpression(params) {
-	const { propertyVariable, queryExpression } = params;
+	const { propertyVariable, propertyRelation, queryExpression } = params;
 	const propertyQueryExpressions = [queryExpression];
 	if (propertyVariable != null) propertyQueryExpressions.unshift(buildPropertyLabelQuery(propertyVariable));
+	if (propertyRelation != null) propertyQueryExpressions.unshift(buildPlainElementAttributeValueQueryExpression({
+		elementName: "label",
+		attributeName: "relation",
+		value: propertyRelation
+	}));
 	return buildNestedElementQuery(["properties", "property"], buildAndCtsQueryExpressionInternal(propertyQueryExpressions));
 }
 function buildPropertyTextMatchQueryExpression(params) {
-	const { propertyVariable, valueFilters = [], contentQueryExpression, rawValueQueryExpression, bareValueQueryExpression } = params;
+	const { propertyVariable, propertyRelation, valueFilters = [], contentQueryExpression, rawValueQueryExpression, bareValueQueryExpression } = params;
 	const letBindings = [];
 	const valueMatchReferences = [];
 	if (contentQueryExpression != null) {
@@ -345,6 +350,11 @@ function buildPropertyTextMatchQueryExpression(params) {
 	if (valueMatchReferences.length > 0) valueQueryExpressions.push(buildOrCtsQueryExpressionInternal(valueMatchReferences));
 	const propertyQueryExpressions = [];
 	if (propertyVariable != null) propertyQueryExpressions.push(buildPropertyLabelQuery(propertyVariable));
+	if (propertyRelation != null) propertyQueryExpressions.push(buildPlainElementAttributeValueQueryExpression({
+		elementName: "label",
+		attributeName: "relation",
+		value: propertyRelation
+	}));
 	propertyQueryExpressions.push(buildNestedElementQuery(["value"], buildAndCtsQueryExpressionInternal(valueQueryExpressions)));
 	const propertyQueryExpression = buildNestedElementQuery(["properties", "property"], buildAndCtsQueryExpressionInternal(propertyQueryExpressions));
 	if (letBindings.length === 0) return propertyQueryExpression;
@@ -353,13 +363,15 @@ function buildPropertyTextMatchQueryExpression(params) {
 function buildPropertyPresenceQueryExpression(params) {
 	return buildPropertyQueryExpression({
 		propertyVariable: params.propertyVariable,
+		propertyRelation: params.propertyRelation,
 		queryExpression: "cts:true-query()"
 	});
 }
 function buildPropertyStringQueryExpression(params) {
-	const { propertyVariable, value, matchMode, isCaseSensitive, language } = params;
+	const { propertyVariable, propertyRelation, value, matchMode, isCaseSensitive, language } = params;
 	return buildPropertyTextMatchQueryExpression({
 		propertyVariable,
+		propertyRelation,
 		valueFilters: [buildValueNotInheritedQuery()],
 		contentQueryExpression: buildValueContentInnerQuery({
 			language,
@@ -380,9 +392,10 @@ function buildPropertyStringQueryExpression(params) {
 	});
 }
 function buildPropertyScalarQueryExpression(params) {
-	const { propertyVariable, value, matchMode, isCaseSensitive } = params;
+	const { propertyVariable, propertyRelation, value, matchMode, isCaseSensitive } = params;
 	return buildPropertyQueryExpression({
 		propertyVariable,
+		propertyRelation,
 		queryExpression: buildNestedElementQuery(["value"], buildOrCtsQueryExpressionInternal([buildValueRawValueInnerQuery({
 			value,
 			matchMode,
@@ -398,6 +411,7 @@ function buildPropertyAllQueryExpression(params) {
 	const { query, value, matchMode } = params;
 	return buildPropertyTextMatchQueryExpression({
 		propertyVariable: query.propertyVariable,
+		propertyRelation: query.propertyRelation,
 		valueFilters: [buildValueNotIdRefQuery()],
 		contentQueryExpression: buildValueContentInnerQuery({
 			language: query.language,
@@ -418,9 +432,10 @@ function buildPropertyAllQueryExpression(params) {
 	});
 }
 function buildPropertyIdRefQueryExpression(params) {
-	const { propertyVariable, value } = params;
+	const { propertyVariable, propertyRelation, value } = params;
 	return buildPropertyQueryExpression({
 		propertyVariable,
+		propertyRelation,
 		queryExpression: buildNestedElementQuery(["value"], buildPlainElementAttributeValueQueryExpression({
 			elementName: "value",
 			attributeName: "uuid",
@@ -434,6 +449,7 @@ function buildPropertyDateRangeQueryExpression(query) {
 	if (query.to != null) rangeQueryExpressions.push(`cts:element-attribute-range-query(xs:QName("value"), xs:QName("rawValue"), "<=", ${stringLiteral(query.to)})`);
 	return buildPropertyQueryExpression({
 		propertyVariable: query.propertyVariable,
+		propertyRelation: query.propertyRelation,
 		queryExpression: buildNestedElementQuery(["value"], buildAndCtsQueryExpressionInternal(rangeQueryExpressions))
 	});
 }
@@ -498,10 +514,12 @@ function buildLeafValueQueryExpression(params) {
 			});
 			case "IDREF": return buildPropertyIdRefQueryExpression({
 				propertyVariable: query.propertyVariable,
+				propertyRelation: query.propertyRelation,
 				value
 			});
 			case "string": return buildPropertyStringQueryExpression({
 				propertyVariable: query.propertyVariable,
+				propertyRelation: query.propertyRelation,
 				value,
 				matchMode,
 				isCaseSensitive: query.isCaseSensitive,
@@ -514,6 +532,7 @@ function buildLeafValueQueryExpression(params) {
 			case "date":
 			case "dateTime": return buildPropertyScalarQueryExpression({
 				propertyVariable: query.propertyVariable,
+				propertyRelation: query.propertyRelation,
 				value,
 				matchMode,
 				isCaseSensitive: query.isCaseSensitive
@@ -590,6 +609,7 @@ function getLeafHelperKey(params) {
 			query.target,
 			query.dataType,
 			query.propertyVariable ?? "",
+			query.propertyRelation ?? "",
 			value,
 			query.isCaseSensitive ? "case-sensitive" : "case-insensitive",
 			query.language
@@ -636,6 +656,7 @@ function getIncludesLeafHelperKey(params) {
 			query.target,
 			query.dataType,
 			query.propertyVariable ?? "",
+			query.propertyRelation ?? "",
 			query.isCaseSensitive ? "case-sensitive" : "case-insensitive",
 			query.language,
 			isWildcarded ? "wildcarded" : "unwildcarded",
@@ -659,7 +680,10 @@ function registerIncludesLeafHelper(params) {
 	});
 }
 function buildLeafQueryExpression(context, query) {
-	if (query.target === "property" && query.dataType !== "date" && query.dataType !== "dateTime" && !("value" in query) && query.propertyVariable != null) return buildPropertyPresenceQueryExpression({ propertyVariable: query.propertyVariable });
+	if (query.target === "property" && query.dataType !== "date" && query.dataType !== "dateTime" && !("value" in query) && (query.propertyVariable != null || query.propertyRelation != null)) return buildPropertyPresenceQueryExpression({
+		propertyVariable: query.propertyVariable,
+		propertyRelation: query.propertyRelation
+	});
 	if (query.target === "property" && (query.dataType === "date" || query.dataType === "dateTime") && query.value == null) return buildPropertyDateRangeQueryExpression(query);
 	const searchValue = getLeafSearchValue(query);
 	if (searchValue == null) throw new Error("Missing searchable value for query leaf", { cause: query });

package/dist/schemas.mjs

@@ -77,6 +77,7 @@ const standardQueryFields = {
 	language: defaultString("eng"),
 	isNegated: defaultBoolean(false)
 };
+const propertyRelationSchema = v.picklist(["related", "inverse"]);
 /**
 * Shared schema for Set queries
 * @internal
@@ -85,6 +86,7 @@ const setQueryLeafSchema = v.union([
 	v.pipe(v.strictObject({
 		target: v.literal("property"),
 		propertyVariable: v.optional(uuidSchema),
+		propertyRelation: v.optional(propertyRelationSchema),
 		dataType: v.picklist([
 			"string",
 			"integer",
@@ -95,10 +97,11 @@ const setQueryLeafSchema = v.union([
 		]),
 		value: v.optional(v.string()),
 		...standardQueryFields
-	}), v.check((value) => value.propertyVariable != null || value.value != null, "Property queries must include at least one propertyVariable or value")),
+	}), v.check((value) => value.propertyVariable != null || value.propertyRelation != null || value.value != null, "Property queries must include at least one propertyVariable, propertyRelation, or value")),
 	v.strictObject({
 		target: v.literal("property"),
 		propertyVariable: uuidSchema,
+		propertyRelation: v.optional(propertyRelationSchema),
 		dataType: dateDataTypeSchema,
 		value: v.string(),
 		from: v.optional(v.never()),
@@ -108,6 +111,7 @@ const setQueryLeafSchema = v.union([
 	v.strictObject({
 		target: v.literal("property"),
 		propertyVariable: uuidSchema,
+		propertyRelation: v.optional(propertyRelationSchema),
 		dataType: dateDataTypeSchema,
 		value: v.optional(v.never()),
 		from: v.string(),
@@ -117,6 +121,7 @@ const setQueryLeafSchema = v.union([
 	v.strictObject({
 		target: v.literal("property"),
 		propertyVariable: uuidSchema,
+		propertyRelation: v.optional(propertyRelationSchema),
 		dataType: dateDataTypeSchema,
 		value: v.optional(v.never()),
 		from: v.optional(v.string()),
@@ -126,6 +131,7 @@ const setQueryLeafSchema = v.union([
 	v.strictObject({
 		target: v.literal("property"),
 		propertyVariable: v.optional(uuidSchema),
+		propertyRelation: v.optional(propertyRelationSchema),
 		dataType: v.literal("all"),
 		value: v.string(),
 		...standardQueryFields

package/dist/types/index.d.mts

@@ -296,6 +296,7 @@ type Property<T extends LanguageCodes = LanguageCodes> = {
     uuid: string;
     label: MultilingualString<T>;
     publicationDateTime: Date | null;
+    relation: PropertyRelation | null;
   };
   values: Array<PropertyValueContent<T>>;
   comment: MultilingualString<T> | null;
@@ -310,6 +311,7 @@ type SimplifiedProperty<T extends LanguageCodes = LanguageCodes> = {
     uuid: string;
     label: string;
     publicationDateTime: Date | null;
+    relation: PropertyRelation | null;
   };
   values: Array<PropertyValueContent<T>>;
   comment: MultilingualString<T> | null;
@@ -324,6 +326,7 @@ type PropertyLike<T extends LanguageCodes = LanguageCodes> = Property<T> | SetIt
 type ItemProperty<T extends LanguageCodes = LanguageCodes> = Property<T> | SetItemProperty<T>;
 type PropertyValueDataType = PropertyValueContent["dataType"];
 type QueryablePropertyValueDataType = Exclude<PropertyValueDataType, "coordinate">;
+type PropertyRelation = "related" | "inverse";
 type WithSetItemProperties<U extends {
   properties: Array<Property<T>>;
 }, T extends LanguageCodes> = U extends {
@@ -765,6 +768,7 @@ type SetItemsSort = {
 type QueryLeaf = {
   target: "property";
   propertyVariable?: string;
+  propertyRelation?: PropertyRelation;
   dataType: Exclude<QueryablePropertyValueDataType, "date" | "dateTime">;
   value?: string;
   from?: never;
@@ -776,6 +780,7 @@ type QueryLeaf = {
 } | {
   target: "property";
   propertyVariable: string;
+  propertyRelation?: PropertyRelation;
   dataType: "date" | "dateTime";
   value: string;
   from?: never;
@@ -787,6 +792,7 @@ type QueryLeaf = {
 } | {
   target: "property";
   propertyVariable: string;
+  propertyRelation?: PropertyRelation;
   dataType: "date" | "dateTime";
   value?: never;
   from: string;
@@ -798,6 +804,7 @@ type QueryLeaf = {
 } | {
   target: "property";
   propertyVariable: string;
+  propertyRelation?: PropertyRelation;
   dataType: "date" | "dateTime";
   value?: never;
   from?: string;
@@ -809,6 +816,7 @@ type QueryLeaf = {
 } | {
   target: "property";
   propertyVariable?: string;
+  propertyRelation?: PropertyRelation;
   dataType: "all";
   value: string;
   matchMode: "includes" | "exact";
@@ -843,4 +851,4 @@ type QueryGroup = {
  */
 type Query = QueryLeaf | QueryGroup;
 //#endregion
-export { AnyBibliography, AnyConcept, AnyItem, AnyPeriod, AnyPerson, AnyPropertyValue, AnyPropertyVariable, AnyResource, AnySet, AnySpatialUnit, AnyText, AnyTree, BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, ContainedItemCategory, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Context, ContextItem, ContextItemCategory, ContextNode, Coordinates, CoordinatesSource, DictionaryUnitItemLink, EmbeddedBibliography, EmbeddedConcept, EmbeddedItem, EmbeddedPeriod, EmbeddedPerson, EmbeddedPropertyValue, EmbeddedPropertyVariable, EmbeddedResource, EmbeddedSet, EmbeddedSpatialUnit, EmbeddedText, EmbeddedTree, Event, Gallery, Heading, HeadingItemCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemLink, ItemLinkCategory, ItemLinks, ItemPayloadKind, ItemProperty, ItemWithoutEmbeddedItems, LanguageCodes, License, Metadata, Note, Observation, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyLike, PropertyValue, PropertyValueContent, PropertyValueDataType, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, QueryablePropertyValueDataType, RecursiveItemCategory, Resource, ResourceItemLink, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemCategory, SetItemLink, SetItemProperty, SetItemSimplifiedProperty, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetTree, SimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Text, TextItemLink, TopLevelItem, Tree, TreeItemCategory, TreeItemLink };
+export { AnyBibliography, AnyConcept, AnyItem, AnyPeriod, AnyPerson, AnyPropertyValue, AnyPropertyVariable, AnyResource, AnySet, AnySpatialUnit, AnyText, AnyTree, BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, ContainedItemCategory, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Context, ContextItem, ContextItemCategory, ContextNode, Coordinates, CoordinatesSource, DictionaryUnitItemLink, EmbeddedBibliography, EmbeddedConcept, EmbeddedItem, EmbeddedPeriod, EmbeddedPerson, EmbeddedPropertyValue, EmbeddedPropertyVariable, EmbeddedResource, EmbeddedSet, EmbeddedSpatialUnit, EmbeddedText, EmbeddedTree, Event, Gallery, Heading, HeadingItemCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemLink, ItemLinkCategory, ItemLinks, ItemPayloadKind, ItemProperty, ItemWithoutEmbeddedItems, LanguageCodes, License, Metadata, Note, Observation, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyLike, PropertyRelation, PropertyValue, PropertyValueContent, PropertyValueDataType, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, QueryablePropertyValueDataType, RecursiveItemCategory, Resource, ResourceItemLink, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemCategory, SetItemLink, SetItemProperty, SetItemSimplifiedProperty, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetTree, SimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Text, TextItemLink, TopLevelItem, Tree, TreeItemCategory, TreeItemLink };

package/dist/xml/schemas.mjs

@@ -229,10 +229,12 @@ const XMLNote = v.object({
 	date: v.optional(customDateTime("XMLNote: date is not a valid datetime")),
 	authors: v.optional(v.object({ author: v.array(v.lazy(() => XMLPerson)) }, "XMLNote: authors is object with author array of XMLPerson"))
 }, "XMLNote: Shape error");
+const XMLPropertyRelation = v.picklist(["related", "inverse"]);
 const XMLProperty = v.lazy(() => v.object({
 	label: v.intersect([v.union([XMLContent, XMLString]), v.object({
 		uuid: v.union([v.literal(""), v.pipe(v.string("XMLProperty: uuid is string and required"), v.check(isPseudoUuid, "XMLProperty: uuid is not a valid pseudo-UUID"))], "XMLProperty: uuid is string and required"),
-		publicationDateTime: v.optional(customDateTime("XMLProperty: publicationDateTime is not a valid datetime"))
+		publicationDateTime: v.optional(customDateTime("XMLProperty: publicationDateTime is not a valid datetime")),
+		relation: v.optional(XMLPropertyRelation)
 	}, "XMLProperty: label is object with uuid")]),
 	value: v.optional(v.array(v.object({
 		...v.partial(XMLContent).entries,
@@ -259,7 +261,8 @@ const XMLProperty = v.lazy(() => v.object({
 const XMLSimplifiedProperty = v.lazy(() => v.object({
 	label: v.intersect([v.union([XMLContent, XMLString]), v.object({
 		uuid: v.union([v.literal(""), v.pipe(v.string("XMLSimplifiedProperty: uuid is string and required"), v.check(isPseudoUuid, "XMLSimplifiedProperty: uuid is not a valid pseudo-UUID"))], "XMLSimplifiedProperty: uuid is string and required"),
-		publicationDateTime: v.optional(customDateTime("XMLSimplifiedProperty: publicationDateTime is not a valid datetime"))
+		publicationDateTime: v.optional(customDateTime("XMLSimplifiedProperty: publicationDateTime is not a valid datetime")),
+		relation: v.optional(XMLPropertyRelation)
 	}, "XMLSimplifiedProperty: label is object with uuid")]),
 	value: v.optional(v.array(v.object({
 		...v.partial(XMLContent).entries,

package/dist/xml/types.d.mts

@@ -182,10 +182,12 @@ type XMLNote = Partial<XMLContent> & XMLString & {
     author: Array<XMLPerson>;
   };
 };
+type XMLPropertyRelation = "related" | "inverse";
 type XMLProperty = {
   label: (XMLContent | XMLString) & {
     uuid: string;
     publicationDateTime?: Date;
+    relation?: XMLPropertyRelation;
   };
   value?: Array<Partial<XMLContent> & {
     i?: XMLNumber;
@@ -212,6 +214,7 @@ type XMLSimplifiedProperty = {
   label: (XMLContent | XMLString) & {
     uuid: string;
     publicationDateTime?: Date;
+    relation?: XMLPropertyRelation;
   };
   value?: Array<Partial<XMLContent> & {
     i?: XMLNumber;
@@ -898,4 +901,4 @@ type XMLWebsiteData = {
   };
 };
 //#endregion
-export { XMLBaseItem, XMLBibliography, XMLBoolean, XMLConcept, XMLContent, XMLContext, XMLContextGroup, XMLContextItem, XMLContextValue, XMLCoordinate, XMLCoordinates, XMLCoordinatesSource, XMLData, XMLDataItem, XMLDictionaryUnit, XMLEmptyContext, XMLEvent, XMLGallery, XMLGalleryData, XMLHeading, XMLHeadingItemCategory, XMLIdentification, XMLImage, XMLImageMap, XMLImageMapArea, XMLInterpretation, XMLItemCategory, XMLItemLinks, XMLItemLinksData, XMLLicense, XMLLink, XMLLinkedBaseItem, XMLLinkedBibliography, XMLLinkedConcept, XMLLinkedPeriod, XMLLinkedPerson, XMLLinkedPropertyValue, XMLLinkedPropertyVariable, XMLLinkedResource, XMLLinkedSet, XMLLinkedSpatialUnit, XMLLinkedText, XMLLinkedTree, XMLMetadata, XMLNote, XMLNumber, XMLObservation, XMLPeriod, XMLPerson, XMLProperty, XMLPropertyValue, XMLPropertyVariable, XMLRecursiveItemCategory, XMLResource, XMLSection, XMLSet, XMLSetItems, XMLSetItemsData, XMLSimplifiedProperty, XMLSpatialUnit, XMLString, XMLText, XMLTree, XMLWebsiteContext, XMLWebsiteContextItem, XMLWebsiteContextLevel, XMLWebsiteData, XMLWebsiteFilterContext, XMLWebsiteFilterContextItem, XMLWebsiteOptions, XMLWebsiteProperties, XMLWebsiteResource, XMLWebsiteResourceGroup, XMLWebsiteResourceItem, XMLWebsiteScope, XMLWebsiteSegment, XMLWebsiteStyle, XMLWebsiteTree };
+export { XMLBaseItem, XMLBibliography, XMLBoolean, XMLConcept, XMLContent, XMLContext, XMLContextGroup, XMLContextItem, XMLContextValue, XMLCoordinate, XMLCoordinates, XMLCoordinatesSource, XMLData, XMLDataItem, XMLDictionaryUnit, XMLEmptyContext, XMLEvent, XMLGallery, XMLGalleryData, XMLHeading, XMLHeadingItemCategory, XMLIdentification, XMLImage, XMLImageMap, XMLImageMapArea, XMLInterpretation, XMLItemCategory, XMLItemLinks, XMLItemLinksData, XMLLicense, XMLLink, XMLLinkedBaseItem, XMLLinkedBibliography, XMLLinkedConcept, XMLLinkedPeriod, XMLLinkedPerson, XMLLinkedPropertyValue, XMLLinkedPropertyVariable, XMLLinkedResource, XMLLinkedSet, XMLLinkedSpatialUnit, XMLLinkedText, XMLLinkedTree, XMLMetadata, XMLNote, XMLNumber, XMLObservation, XMLPeriod, XMLPerson, XMLProperty, XMLPropertyRelation, XMLPropertyValue, XMLPropertyVariable, XMLRecursiveItemCategory, XMLResource, XMLSection, XMLSet, XMLSetItems, XMLSetItemsData, XMLSimplifiedProperty, XMLSpatialUnit, XMLString, XMLText, XMLTree, XMLWebsiteContext, XMLWebsiteContextItem, XMLWebsiteContextLevel, XMLWebsiteData, XMLWebsiteFilterContext, XMLWebsiteFilterContextItem, XMLWebsiteOptions, XMLWebsiteProperties, XMLWebsiteResource, XMLWebsiteResourceGroup, XMLWebsiteResourceItem, XMLWebsiteScope, XMLWebsiteSegment, XMLWebsiteStyle, XMLWebsiteTree };

package/package.json

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