ochre-sdk 1.0.0-beta.7 → 1.0.0-beta.9

package/dist/index.d.mts

@@ -294,7 +294,7 @@ type Event<T extends ReadonlyArray<string>> = {
     end: Date;
   } | null;
   label: MultilingualString<T>;
-  comment: string | null;
+  comment: MultilingualString<T> | null;
   agent: {
     uuid: string;
     label: MultilingualString<T>;
@@ -402,7 +402,7 @@ type ImageMap = {
  */
 type Note<T extends ReadonlyArray<string>> = {
   number: number;
-  title: string | null;
+  title: MultilingualString<T> | null;
   content: MultilingualString<T>;
   authors: Array<Person<T, "nested">>;
 };
@@ -440,19 +440,34 @@ type PropertyValueContent<T extends ReadonlyArray<string>> = Prettify<{
  *  Property in OCHRE
  */
 type Property<T extends ReadonlyArray<string>> = {
-  label: {
+  variable: {
     uuid: string;
+    label: MultilingualString<T>;
     publicationDateTime: Date | null;
-    name: string;
   };
   values: Array<PropertyValueContent<T>>;
   comment: MultilingualString<T> | null;
   properties: Array<Property<T>>;
 };
+/**
+ * Simplified property in OCHRE website payloads. Simplified property variables
+ * expose scalar labels rather than multilingual labels.
+ */
+type SimplifiedProperty<T extends ReadonlyArray<string>> = {
+  variable: {
+    uuid: string;
+    label: string;
+    publicationDateTime: Date | null;
+  };
+  values: Array<PropertyValueContent<T>>;
+  comment: MultilingualString<T> | null;
+  properties: Array<SimplifiedProperty<T>>;
+};
 /**
  *  Property in a Set item. OCHRE exposes Set item properties as a flat list.
  */
 type SingleHierarchyProperty<T extends ReadonlyArray<string>> = Omit<Property<T>, "properties">;
+type SingleHierarchySimplifiedProperty<T extends ReadonlyArray<string>> = Omit<SimplifiedProperty<T>, "properties">;
 type WithSingleHierarchyProperties<U extends {
   properties: Array<Property<T>>;
 }, T extends ReadonlyArray<string>> = U extends {
@@ -828,7 +843,7 @@ type PropertyValueQueryItem = {
   count: number;
   dataType: Exclude<PropertyValueContent<ReadonlyArray<string>>["dataType"], "coordinate">;
   content: string | number | boolean | null;
-  label: string | null;
+  label: MultilingualString | null;
 };
 /**
  * Represents a grouped Set attribute value query item
@@ -1529,7 +1544,7 @@ type WebElementComponent<T extends ReadonlyArray<string> = ReadonlyArray<string>
   component: "query";
   linkUuids: Array<string>;
   items: Array<{
-    label: string;
+    label: MultilingualString<T>;
     queries: Array<WebsitePropertyQuery<T>>;
     startIcon: string | null;
     endIcon: string | null;
@@ -1561,7 +1576,7 @@ type WebElementComponent<T extends ReadonlyArray<string> = ReadonlyArray<string>
 } | {
   component: "search-bar";
   queryVariant: "submit" | "change";
-  placeholder: string | null;
+  placeholder: MultilingualString<T> | null;
   baseFilterQueries: string | null;
   boundElementUuid: string | null;
   href: string | null;
@@ -1680,134 +1695,146 @@ type PropertyOptions = {
   limitToLeafPropertyValues?: boolean;
 };
 type PropertyContent<T extends ReadonlyArray<string>> = PropertyValueContent<T>["content"];
-type SearchableProperty<T extends ReadonlyArray<string>> = Property<T> | SingleHierarchyProperty<T>;
+type SearchableProperty<T extends ReadonlyArray<string>> = Property<T> | SingleHierarchyProperty<T> | SimplifiedProperty<T> | SingleHierarchySimplifiedProperty<T>;
 /**
- * Finds a property by its label UUID in an array of properties.
+ * Finds a property by its variable UUID in an array of properties.
  *
  * @param properties - Array of properties to search through
- * @param labelUuid - The property label UUID to search for
+ * @param variableUuid - The property variable UUID to search for
  * @param options - Search options, including whether to include nested properties
  * @returns The matching Property object, or null if not found
  */
-declare function getPropertyByLabelUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, labelUuid: string, options?: PropertyOptions): Property<T> | null;
-declare function getPropertyByLabelUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, labelUuid: string, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, variableUuid: string, options?: PropertyOptions): Property<T> | null;
+declare function getPropertyByVariableUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, variableUuid: string, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SimplifiedProperty<T>>, variableUuid: string, options?: PropertyOptions): SimplifiedProperty<T> | null;
+declare function getPropertyByVariableUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchySimplifiedProperty<T>>, variableUuid: string, options?: PropertyOptions): SingleHierarchySimplifiedProperty<T> | null;
 /**
- * Retrieves all values for a property with the given label UUID.
+ * Retrieves all values for a property with the given variable UUID.
  *
  * @param properties - Array of properties to search through
- * @param labelUuid - The property label UUID to search for
+ * @param variableUuid - The property variable UUID to search for
  * @param options - Search options, including whether to include nested properties
  * @returns Array of property values, or null if property not found
  */
-declare function getPropertyValuesByLabelUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, labelUuid: string, options?: PropertyOptions): Array<PropertyValueContent<T>> | null;
+declare function getPropertyValuesByVariableUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, variableUuid: string, options?: PropertyOptions): Array<PropertyValueContent<T>> | null;
 /**
- * Retrieves all value contents for a property with the given label UUID.
+ * Retrieves all value contents for a property with the given variable UUID.
  *
  * @param properties - Array of properties to search through
- * @param labelUuid - The property label UUID to search for
+ * @param variableUuid - The property variable UUID to search for
  * @param options - Search options, including whether to include nested properties
  * @returns Array of property value contents, or null if property not found
  */
-declare function getPropertyValueContentsByLabelUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, labelUuid: string, options?: PropertyOptions): Array<PropertyContent<T>> | null;
+declare function getPropertyValueContentsByVariableUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, variableUuid: string, options?: PropertyOptions): Array<PropertyContent<T>> | null;
 /**
- * Gets the first value of a property with the given label UUID.
+ * Gets the first value of a property with the given variable UUID.
  *
  * @param properties - Array of properties to search through
- * @param labelUuid - The property label UUID to search for
+ * @param variableUuid - The property variable UUID to search for
  * @param options - Search options, including whether to include nested properties
  * @returns The first property value, or null if property not found
  */
-declare function getPropertyValueByLabelUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, labelUuid: string, options?: PropertyOptions): PropertyValueContent<T> | null;
+declare function getPropertyValueByVariableUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, variableUuid: string, options?: PropertyOptions): PropertyValueContent<T> | null;
 /**
- * Gets the first value content of a property with the given label UUID.
+ * Gets the first value content of a property with the given variable UUID.
  *
  * @param properties - Array of properties to search through
- * @param labelUuid - The property label UUID to search for
+ * @param variableUuid - The property variable UUID to search for
  * @param options - Search options, including whether to include nested properties
  * @returns The first property value content, or null if property not found
  */
-declare function getPropertyValueContentByLabelUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, labelUuid: string, options?: PropertyOptions): PropertyContent<T> | null;
+declare function getPropertyValueContentByVariableUuid<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, variableUuid: string, options?: PropertyOptions): PropertyContent<T> | null;
 /**
- * Finds a property by its label name in an array of properties.
+ * Finds a property by its variable label in an array of properties.
  *
  * @param properties - Array of properties to search through
- * @param labelName - The property label name to search for
+ * @param variableLabel - The property variable label to search for
  * @param options - Search options, including whether to include nested properties
  * @returns The matching Property object, or null if not found
  */
-declare function getPropertyByLabelName<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, labelName: string, options?: PropertyOptions): Property<T> | null;
-declare function getPropertyByLabelName<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, labelName: string, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableLabel<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, variableLabel: string, options?: PropertyOptions): Property<T> | null;
+declare function getPropertyByVariableLabel<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, variableLabel: string, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableLabel<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SimplifiedProperty<T>>, variableLabel: string, options?: PropertyOptions): SimplifiedProperty<T> | null;
+declare function getPropertyByVariableLabel<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchySimplifiedProperty<T>>, variableLabel: string, options?: PropertyOptions): SingleHierarchySimplifiedProperty<T> | null;
 /**
- * Finds a property by its label name and all values.
+ * Finds a property by its variable label and all values.
  *
  * @param properties - Array of properties to search through
- * @param labelName - The property label name to search for
+ * @param variableLabel - The property variable label to search for
  * @param values - The property values to search for
  * @param options - Search options, including whether to include nested properties
  * @returns The matching Property object, or null if not found or all values do not match
  */
-declare function getPropertyByLabelNameAndValues<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, labelName: string, values: ReadonlyArray<PropertyValueContent<T>>, options?: PropertyOptions): Property<T> | null;
-declare function getPropertyByLabelNameAndValues<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, labelName: string, values: ReadonlyArray<PropertyValueContent<T>>, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableLabelAndValues<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, variableLabel: string, values: ReadonlyArray<PropertyValueContent<T>>, options?: PropertyOptions): Property<T> | null;
+declare function getPropertyByVariableLabelAndValues<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, variableLabel: string, values: ReadonlyArray<PropertyValueContent<T>>, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableLabelAndValues<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SimplifiedProperty<T>>, variableLabel: string, values: ReadonlyArray<PropertyValueContent<T>>, options?: PropertyOptions): SimplifiedProperty<T> | null;
+declare function getPropertyByVariableLabelAndValues<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchySimplifiedProperty<T>>, variableLabel: string, values: ReadonlyArray<PropertyValueContent<T>>, options?: PropertyOptions): SingleHierarchySimplifiedProperty<T> | null;
 /**
- * Finds a property by its label name and all value contents.
+ * Finds a property by its variable label and all value contents.
  *
  * @param properties - Array of properties to search through
- * @param labelName - The property label name to search for
+ * @param variableLabel - The property variable label to search for
  * @param valueContents - The value contents to search for
  * @param options - Search options, including whether to include nested properties
  * @returns The matching Property object, or null if not found or all value contents do not match
  */
-declare function getPropertyByLabelNameAndValueContents<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, labelName: string, valueContents: ReadonlyArray<PropertyContent<T>>, options?: PropertyOptions): Property<T> | null;
-declare function getPropertyByLabelNameAndValueContents<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, labelName: string, valueContents: ReadonlyArray<PropertyContent<T>>, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableLabelAndValueContents<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, variableLabel: string, valueContents: ReadonlyArray<PropertyContent<T>>, options?: PropertyOptions): Property<T> | null;
+declare function getPropertyByVariableLabelAndValueContents<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, variableLabel: string, valueContents: ReadonlyArray<PropertyContent<T>>, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableLabelAndValueContents<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SimplifiedProperty<T>>, variableLabel: string, valueContents: ReadonlyArray<PropertyContent<T>>, options?: PropertyOptions): SimplifiedProperty<T> | null;
+declare function getPropertyByVariableLabelAndValueContents<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchySimplifiedProperty<T>>, variableLabel: string, valueContents: ReadonlyArray<PropertyContent<T>>, options?: PropertyOptions): SingleHierarchySimplifiedProperty<T> | null;
 /**
- * Finds a property by its label name and one value.
+ * Finds a property by its variable label and one value.
  *
  * @param properties - Array of properties to search through
- * @param labelName - The property label name to search for
+ * @param variableLabel - The property variable label to search for
  * @param value - The property value to search for
  * @param options - Search options, including whether to include nested properties
  * @returns The matching Property object, or null if not found or value does not match
  */
-declare function getPropertyByLabelNameAndValue<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, labelName: string, value: PropertyValueContent<T>, options?: PropertyOptions): Property<T> | null;
-declare function getPropertyByLabelNameAndValue<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, labelName: string, value: PropertyValueContent<T>, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableLabelAndValue<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, variableLabel: string, value: PropertyValueContent<T>, options?: PropertyOptions): Property<T> | null;
+declare function getPropertyByVariableLabelAndValue<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, variableLabel: string, value: PropertyValueContent<T>, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableLabelAndValue<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SimplifiedProperty<T>>, variableLabel: string, value: PropertyValueContent<T>, options?: PropertyOptions): SimplifiedProperty<T> | null;
+declare function getPropertyByVariableLabelAndValue<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchySimplifiedProperty<T>>, variableLabel: string, value: PropertyValueContent<T>, options?: PropertyOptions): SingleHierarchySimplifiedProperty<T> | null;
 /**
- * Finds a property by its label name and one value content.
+ * Finds a property by its variable label and one value content.
  *
  * @param properties - Array of properties to search through
- * @param labelName - The property label name to search for
+ * @param variableLabel - The property variable label to search for
  * @param valueContent - The value content to search for
  * @param options - Search options, including whether to include nested properties
  * @returns The matching Property object, or null if not found or value content does not match
  */
-declare function getPropertyByLabelNameAndValueContent<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, labelName: string, valueContent: PropertyContent<T>, options?: PropertyOptions): Property<T> | null;
-declare function getPropertyByLabelNameAndValueContent<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, labelName: string, valueContent: PropertyContent<T>, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableLabelAndValueContent<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, variableLabel: string, valueContent: PropertyContent<T>, options?: PropertyOptions): Property<T> | null;
+declare function getPropertyByVariableLabelAndValueContent<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, variableLabel: string, valueContent: PropertyContent<T>, options?: PropertyOptions): SingleHierarchyProperty<T> | null;
+declare function getPropertyByVariableLabelAndValueContent<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SimplifiedProperty<T>>, variableLabel: string, valueContent: PropertyContent<T>, options?: PropertyOptions): SimplifiedProperty<T> | null;
+declare function getPropertyByVariableLabelAndValueContent<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchySimplifiedProperty<T>>, variableLabel: string, valueContent: PropertyContent<T>, options?: PropertyOptions): SingleHierarchySimplifiedProperty<T> | null;
 /**
- * Retrieves all values for a property with the given label name.
+ * Retrieves all values for a property with the given variable label.
  *
  * @param properties - Array of properties to search through
- * @param labelName - The property label name to search for
+ * @param variableLabel - The property variable label to search for
  * @param options - Search options, including whether to include nested properties
  * @returns Array of property values, or null if property not found
  */
-declare function getPropertyValuesByLabelName<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, labelName: string, options?: PropertyOptions): Array<PropertyValueContent<T>> | null;
+declare function getPropertyValuesByVariableLabel<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, variableLabel: string, options?: PropertyOptions): Array<PropertyValueContent<T>> | null;
 /**
- * Gets the first value of a property with the given label name.
+ * Gets the first value of a property with the given variable label.
  *
  * @param properties - Array of properties to search through
- * @param labelName - The property label name to search for
+ * @param variableLabel - The property variable label to search for
  * @param options - Search options, including whether to include nested properties
  * @returns The first property value, or null if property not found
  */
-declare function getPropertyValueByLabelName<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, labelName: string, options?: PropertyOptions): PropertyValueContent<T> | null;
+declare function getPropertyValueByVariableLabel<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, variableLabel: string, options?: PropertyOptions): PropertyValueContent<T> | null;
 /**
- * Gets the first value content of a property with the given label name.
+ * Gets the first value content of a property with the given variable label.
  *
  * @param properties - Array of properties to search through
- * @param labelName - The property label name to search for
+ * @param variableLabel - The property variable label to search for
  * @param options - Search options, including whether to include nested properties
  * @returns The first property value content, or null if property not found
  */
-declare function getPropertyValueContentByLabelName<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, labelName: string, options?: PropertyOptions): PropertyContent<T> | null;
+declare function getPropertyValueContentByVariableLabel<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, variableLabel: string, options?: PropertyOptions): PropertyContent<T> | null;
 /**
  * Gets all unique properties from an array of properties.
  *
@@ -1817,14 +1844,16 @@ declare function getPropertyValueContentByLabelName<T extends ReadonlyArray<stri
  */
 declare function getUniqueProperties<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<Property<T>>, options?: PropertyOptions): Array<Property<T>>;
 declare function getUniqueProperties<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchyProperty<T>>, options?: PropertyOptions): Array<SingleHierarchyProperty<T>>;
+declare function getUniqueProperties<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SimplifiedProperty<T>>, options?: PropertyOptions): Array<SimplifiedProperty<T>>;
+declare function getUniqueProperties<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SingleHierarchySimplifiedProperty<T>>, options?: PropertyOptions): Array<SingleHierarchySimplifiedProperty<T>>;
 /**
- * Gets all unique property label names from an array of properties.
+ * Gets all unique property variable labels from an array of properties.
  *
- * @param properties - Array of properties to get unique property labels from
+ * @param properties - Array of properties to get unique property variable labels from
  * @param options - Search options, including whether to include nested properties
- * @returns Array of unique property label names
+ * @returns Array of unique property variable labels
  */
-declare function getUniquePropertyLabelNames<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, options?: PropertyOptions): Array<string>;
+declare function getUniquePropertyVariableLabels<T extends ReadonlyArray<string> = ReadonlyArray<string>>(properties: ReadonlyArray<SearchableProperty<T>>, options?: PropertyOptions): Array<string>;
 /**
  * Get the leaf property values from an array of property values.
  *
@@ -1833,17 +1862,17 @@ declare function getUniquePropertyLabelNames<T extends ReadonlyArray<string> = R
  */
 declare function getLeafPropertyValues<T extends ReadonlyArray<string> = ReadonlyArray<string>>(propertyValues: ReadonlyArray<PropertyValueContent<T>>): Array<PropertyValueContent<T>>;
 /**
- * Filters a property based on a label and value criterion.
+ * Filters a property based on a variable label and value content criterion.
  *
  * @param property - The property to filter
- * @param filter - Filter criteria containing label and value to match
- * @param filter.labelName - The label name to filter by
+ * @param filter - Filter criteria containing variable label and value to match
+ * @param filter.variableLabel - The variable label to filter by
  * @param filter.value - The value to filter by
  * @param options - Search options, including whether to include nested properties
  * @returns True if the property matches the filter criteria, false otherwise
  */
 declare function filterProperties<T extends ReadonlyArray<string> = ReadonlyArray<string>>(property: SearchableProperty<T>, filter: {
-  labelName: string;
+  variableLabel: string;
   value: PropertyValueContent<T>;
 }, options?: PropertyOptions): boolean;
 //#endregion
@@ -1862,4 +1891,4 @@ declare const DEFAULT_PAGE_SIZE = 48;
  */
 declare function flattenItemProperties<U extends DataCategory = DataCategory, V extends HierarchyItemDataCategory<U> = HierarchyItemDataCategory<U>, T extends ReadonlyArray<string> = ReadonlyArray<string>, W extends ItemLocation = "topLevel">(item: Item<U, V, T, W>): FlattenedItem<Item<U, V, T, W>, T>;
 //#endregion
-export { BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, Context, ContextDataCategory, ContextItem, ContextNode, ContextTree, ContextTreeFilterLevel, ContextTreeLevel, ContextTreeLevelItem, Coordinates, CoordinatesSource, DEFAULT_PAGE_SIZE, DataCategory, DictionaryUnitItemLink, Event, Gallery, Heading, HeadingDataCategory, HierarchyDataCategory, HierarchyItemCategoryFromOption, HierarchyItemCategoryOption, HierarchyItemDataCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemLink, ItemLinkCategory, ItemLinks, ItemLocation, ItemsDataCategory, License, Metadata, type MultilingualOptions, MultilingualString, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringText, Note, Observation, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyOptions, PropertyValue, PropertyValueContent, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, RecursiveDataCategory, Resource, ResourceItemLink, Scope, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemDataCategory, SetItemLink, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetTree, SingleHierarchyProperty, SpatialUnit, SpatialUnitItemLink, Style, StylesheetCategory, StylesheetItem, Text, TextItemLink, Tree, TreeItemLink, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteType, defineLanguages, fetchGallery, fetchItem, fetchItemLinks, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabelName, getPropertyByLabelNameAndValue, getPropertyByLabelNameAndValueContent, getPropertyByLabelNameAndValueContents, getPropertyByLabelNameAndValues, getPropertyByLabelUuid, getPropertyValueByLabelName, getPropertyValueByLabelUuid, getPropertyValueContentByLabelName, getPropertyValueContentByLabelUuid, getPropertyValueContentsByLabelUuid, getPropertyValuesByLabelName, getPropertyValuesByLabelUuid, getUniqueProperties, getUniquePropertyLabelNames, withLanguages };
+export { BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, Context, ContextDataCategory, ContextItem, ContextNode, ContextTree, ContextTreeFilterLevel, ContextTreeLevel, ContextTreeLevelItem, Coordinates, CoordinatesSource, DEFAULT_PAGE_SIZE, DataCategory, DictionaryUnitItemLink, Event, Gallery, Heading, HeadingDataCategory, HierarchyDataCategory, HierarchyItemCategoryFromOption, HierarchyItemCategoryOption, HierarchyItemDataCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemLink, ItemLinkCategory, ItemLinks, ItemLocation, ItemsDataCategory, License, Metadata, type MultilingualOptions, MultilingualString, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringText, Note, Observation, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyOptions, PropertyValue, PropertyValueContent, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, RecursiveDataCategory, Resource, ResourceItemLink, Scope, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemDataCategory, SetItemLink, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetTree, SimplifiedProperty, SingleHierarchyProperty, SingleHierarchySimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Style, StylesheetCategory, StylesheetItem, Text, TextItemLink, Tree, TreeItemLink, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteType, defineLanguages, fetchGallery, fetchItem, fetchItemLinks, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByVariableLabel, getPropertyByVariableLabelAndValue, getPropertyByVariableLabelAndValueContent, getPropertyByVariableLabelAndValueContents, getPropertyByVariableLabelAndValues, getPropertyByVariableUuid, getPropertyValueByVariableLabel, getPropertyValueByVariableUuid, getPropertyValueContentByVariableLabel, getPropertyValueContentByVariableUuid, getPropertyValueContentsByVariableUuid, getPropertyValuesByVariableLabel, getPropertyValuesByVariableUuid, getUniqueProperties, getUniquePropertyVariableLabels, withLanguages };