@digitalculture/ochre-sdk 0.17.11 → 0.17.13

package/dist/index.d.mts

@@ -494,7 +494,10 @@ type PropertyValueContentType = "string" | "integer" | "decimal" | "boolean" | "
  * Represents a property value with type information
  */
 type PropertyValueContent<T extends PropertyValueContentType> = {
-  hierarchyLevel: number | null;
+  hierarchy: {
+    isLeaf: boolean;
+    level: number | null;
+  };
   content: (T extends "integer" ? number : T extends "decimal" ? number : T extends "time" ? number : T extends "boolean" ? boolean : string) | null;
   dataType: T;
   label: string | null;
@@ -835,7 +838,7 @@ type WebElementComponent = {
     isMapDisplayed: boolean;
     isInputDisplayed: boolean;
     isLimitedToTitleQuery: boolean;
-    isLimitedToHighestHierarchyLevel: boolean;
+    isLimitedToLeafPropertyValues: boolean;
     sidebarSort: "default" | "alphabetical";
   };
   options: {
@@ -1396,5 +1399,11 @@ declare const DEFAULT_API_VERSION = 2;
  * @returns The item with the properties flattened
  */
 declare function flattenItemProperties<T extends DataCategory = DataCategory, U extends DataCategory | Array<DataCategory> = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? Array<DataCategory> : never)>(item: Item<T, U>): Item<T, U>;
+/**
+ * Get the leaf property values from an array of property values
+ * @param propertyValues - The array of property values to get the leaf property values from
+ * @returns The array of leaf property values
+ */
+declare function getLeafPropertyValues<T extends PropertyValueContentType = PropertyValueContentType>(propertyValues: Array<PropertyValueContent<T>>): Array<PropertyValueContent<T>>;
 //#endregion
-export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyQueryItem, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Scope, Section, Set, SpatialUnit, Style, Text, Tree, UuidMetadata, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebTitle, Webpage, Website, fetchByUuidMetadata, fetchGallery, fetchItem, fetchItemsByPropertyValues, fetchPropertyValuesByPropertyVariables, fetchWebsite, filterProperties, flattenItemProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyQueryItem, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Scope, Section, Set, SpatialUnit, Style, Text, Tree, UuidMetadata, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebTitle, Webpage, Website, fetchByUuidMetadata, fetchGallery, fetchItem, fetchItemsByPropertyValues, fetchPropertyValuesByPropertyVariables, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/dist/index.mjs

@@ -1011,6 +1011,14 @@ function flattenItemProperties(item) {
 		properties: collectPropertiesFromSubNodes()
 	};
 }
+/**
+* Get the leaf property values from an array of property values
+* @param propertyValues - The array of property values to get the leaf property values from
+* @returns The array of leaf property values
+*/
+function getLeafPropertyValues(propertyValues) {
+	return propertyValues.filter((value) => value.hierarchy.isLeaf);
+}
 
 //#endregion
 //#region src/utils/parse.ts
@@ -1446,7 +1454,10 @@ function parseProperty(property, language = "eng") {
 		if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
 			content = parseFakeString(value);
 			return {
-				hierarchyLevel: null,
+				hierarchy: {
+					isLeaf: true,
+					level: null
+				},
 				content,
 				label: null,
 				dataType: "string",
@@ -1502,7 +1513,10 @@ function parseProperty(property, language = "eng") {
 					break;
 			}
 			return {
-				hierarchyLevel: value.i ?? null,
+				hierarchy: {
+					isLeaf: value.inherited == null || !value.inherited,
+					level: value.i ?? null
+				},
 				content,
 				dataType: parsedType,
 				isUncertain: value.isUncertain ?? false,
@@ -1519,9 +1533,6 @@ function parseProperty(property, language = "eng") {
 				slug: value.slug ?? null
 			};
 		}
-	}).toSorted((a, b) => {
-		if (a.hierarchyLevel != null && b.hierarchyLevel != null) return b.hierarchyLevel - a.hierarchyLevel;
-		return 0;
 	});
 	return {
 		uuid: property.label.uuid,
@@ -2302,9 +2313,9 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			let isFilterLimitedToTitleQuery = false;
 			const isFilterLimitedToTitleQueryProperty = getPropertyValueByLabel(componentProperty.properties, "filter-limit-to-title-query");
 			if (isFilterLimitedToTitleQueryProperty !== null) isFilterLimitedToTitleQuery = isFilterLimitedToTitleQueryProperty === true;
-			let isFilterLimitedToHighestHierarchyLevel = false;
-			const isFilterLimitedToHighestHierarchyLevelProperty = getPropertyValueByLabel(componentProperty.properties, "filter-limit-to-highest-hierarchy-level");
-			if (isFilterLimitedToHighestHierarchyLevelProperty !== null) isFilterLimitedToHighestHierarchyLevel = isFilterLimitedToHighestHierarchyLevelProperty === true;
+			let isFilterLimitedToLeafPropertyValues = false;
+			const isFilterLimitedToLeafPropertyValuesProperty = getPropertyValueByLabel(componentProperty.properties, "filter-limit-to-leaf-property-values");
+			if (isFilterLimitedToLeafPropertyValuesProperty !== null) isFilterLimitedToLeafPropertyValues = isFilterLimitedToLeafPropertyValuesProperty === true;
 			let isSortDisplayed = false;
 			const isSortDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "sort-displayed");
 			if (isSortDisplayedProperty !== null) isSortDisplayed = isSortDisplayedProperty === true;
@@ -2364,7 +2375,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 				isMapDisplayed: isFilterMapDisplayed,
 				isInputDisplayed: isFilterInputDisplayed,
 				isLimitedToTitleQuery: isFilterLimitedToTitleQuery,
-				isLimitedToHighestHierarchyLevel: isFilterLimitedToHighestHierarchyLevel,
+				isLimitedToLeafPropertyValues: isFilterLimitedToLeafPropertyValues,
 				sidebarSort: filterSidebarSort
 			};
 			properties.isSortDisplayed = isSortDisplayed;
@@ -3888,4 +3899,4 @@ async function fetchWebsite(abbreviation, options) {
 }
 
 //#endregion
-export { DEFAULT_API_VERSION, fetchByUuidMetadata, fetchGallery, fetchItem, fetchItemsByPropertyValues, fetchPropertyValuesByPropertyVariables, fetchWebsite, filterProperties, flattenItemProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { DEFAULT_API_VERSION, fetchByUuidMetadata, fetchGallery, fetchItem, fetchItemsByPropertyValues, fetchPropertyValuesByPropertyVariables, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/package.json

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