ochre-sdk 0.21.7 → 0.22.0

package/dist/index.d.mts

@@ -734,7 +734,7 @@ type QueryLeaf = {
   language: string;
   isNegated?: boolean;
 } | {
-  target: "title" | "description" | "image" | "periods" | "bibliography";
+  target: "title" | "description" | "image" | "periods" | "bibliography" | "notes";
   value: string;
   matchMode: "includes" | "exact";
   isCaseSensitive: boolean;
@@ -1043,8 +1043,7 @@ type WebElementComponent = {
     uuid: string;
     label: string;
   }> | null;
-  variant: "full" | "highlights";
-  itemVariant: "detailed" | "card" | "tile" | "showcase";
+  variant: "detailed" | "card" | "tile" | "showcase";
   paginationVariant: "default" | "numeric";
   layout: "image-top" | "image-bottom" | "image-start" | "image-end";
   imageQuality: "high" | "low";
@@ -1143,9 +1142,9 @@ type WebElementComponent = {
     uuid: string;
     label: string;
   }> | null;
-  itemVariant: Extract<WebElementComponent, {
+  variant: Extract<WebElementComponent, {
     component: "collection";
-  }>["itemVariant"];
+  }>["variant"];
   paginationVariant: Extract<WebElementComponent, {
     component: "collection";
   }>["paginationVariant"];
@@ -1400,7 +1399,8 @@ declare function fetchWebsite(abbreviation: string, options?: {
  * Options for property search operations
  */
 type PropertyOptions = {
-  /** Whether to recursively search through nested properties */includeNestedProperties: boolean;
+  /** Whether to recursively search through nested properties */includeNestedProperties?: boolean; /** Whether to limit the search to leaf properties */
+  limitToLeafPropertyValues?: boolean;
 };
 /**
  * Finds a property by its UUID in an array of properties
@@ -1410,7 +1410,7 @@ type PropertyOptions = {
  * @param options - Search options, including whether to include nested properties
  * @returns The matching Property object, or null if not found
  */
-declare function getPropertyByUuid(properties: Array<Property>, uuid: string, options?: PropertyOptions): Property | null;
+declare function getPropertyByUuid<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, uuid: string, options?: PropertyOptions): Property<T> | null;
 /**
  * Retrieves all values for a property with the given UUID
  *
@@ -1419,7 +1419,16 @@ declare function getPropertyByUuid(properties: Array<Property>, uuid: string, op
  * @param options - Search options, including whether to include nested properties
  * @returns Array of property values as strings, or null if property not found
  */
-declare function getPropertyValuesByUuid(properties: Array<Property>, uuid: string, options?: PropertyOptions): Array<string | number | boolean | Date | null> | null;
+declare function getPropertyValuesByUuid<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, uuid: string, options?: PropertyOptions): Array<PropertyValueContent<T>> | null;
+/**
+ * Retrieves all value contents for a property with the given UUID
+ *
+ * @param properties - Array of properties to search through
+ * @param uuid - The UUID to search for
+ * @param options - Search options, including whether to include nested properties
+ * @returns Array of property value contents as strings, or null if property not found
+ */
+declare function getPropertyValueContentsByUuid<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, uuid: string, options?: PropertyOptions): Array<PropertyValueContent<T>["content"]> | null;
 /**
  * Gets the first value of a property with the given UUID
  *
@@ -1428,7 +1437,16 @@ declare function getPropertyValuesByUuid(properties: Array<Property>, uuid: stri
  * @param options - Search options, including whether to include nested properties
  * @returns The first property value as string, or null if property not found
  */
-declare function getPropertyValueByUuid(properties: Array<Property>, uuid: string, options?: PropertyOptions): string | number | boolean | Date | null;
+declare function getPropertyValueByUuid<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, uuid: string, options?: PropertyOptions): PropertyValueContent<T> | null;
+/**
+ * Gets the first value content of a property with the given UUID
+ *
+ * @param properties - Array of properties to search through
+ * @param uuid - The UUID to search for
+ * @param options - Search options, including whether to include nested properties
+ * @returns The first property value content as string, or null if property not found
+ */
+declare function getPropertyValueContentByUuid<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, uuid: string, options?: PropertyOptions): PropertyValueContent<T>["content"] | null;
 /**
  * Finds a property by its label in an array of properties
  *
@@ -1437,7 +1455,7 @@ declare function getPropertyValueByUuid(properties: Array<Property>, uuid: strin
  * @param options - Search options, including whether to include nested properties
  * @returns The matching Property object, or null if not found
  */
-declare function getPropertyByLabel(properties: Array<Property>, label: string, options?: PropertyOptions): Property | null;
+declare function getPropertyByLabel<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, label: string, options?: PropertyOptions): Property<T> | null;
 /**
  * Finds a property by its label and all values in an array of properties
  *
@@ -1447,7 +1465,17 @@ declare function getPropertyByLabel(properties: Array<Property>, label: string,
  * @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 getPropertyByLabelAndValues(properties: Array<Property>, label: string, values: Array<string | number | boolean | Date | null>, options?: PropertyOptions): Property | null;
+declare function getPropertyByLabelAndValues<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, label: string, values: Array<PropertyValueContent<T>>, options?: PropertyOptions): Property<T> | null;
+/**
+ * Finds a property by its label and all values in an array of properties
+ *
+ * @param properties - Array of properties to search through
+ * @param label - The 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 values do not match
+ */
+declare function getPropertyByLabelAndValueContents<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, label: string, valueContents: Array<PropertyValueContent<T>["content"]>, options?: PropertyOptions): Property<T> | null;
 /**
  * Finds a property by its label and value in an array of properties
  *
@@ -1457,7 +1485,17 @@ declare function getPropertyByLabelAndValues(properties: Array<Property>, label:
  * @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 getPropertyByLabelAndValue(properties: Array<Property>, label: string, value: string | number | boolean | Date | null, options?: PropertyOptions): Property | null;
+declare function getPropertyByLabelAndValue<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, label: string, value: PropertyValueContent<T>, options?: PropertyOptions): Property<T> | null;
+/**
+ * Finds a property by its label and value content in an array of properties
+ *
+ * @param properties - Array of properties to search through
+ * @param label - The 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 getPropertyByLabelAndValueContent<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, label: string, valueContent: PropertyValueContent<T>["content"], options?: PropertyOptions): Property<T> | null;
 /**
  * Retrieves all values for a property with the given label
  *
@@ -1466,7 +1504,7 @@ declare function getPropertyByLabelAndValue(properties: Array<Property>, label:
  * @param options - Search options, including whether to include nested properties
  * @returns Array of property values as strings, or null if property not found
  */
-declare function getPropertyValuesByLabel(properties: Array<Property>, label: string, options?: PropertyOptions): Array<string | number | boolean | Date | null> | null;
+declare function getPropertyValuesByLabel<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, label: string, options?: PropertyOptions): Array<PropertyValueContent<T>> | null;
 /**
  * Gets the first value of a property with the given label
  *
@@ -1475,7 +1513,16 @@ declare function getPropertyValuesByLabel(properties: Array<Property>, label: st
  * @param options - Search options, including whether to include nested properties
  * @returns The first property value as string, or null if property not found
  */
-declare function getPropertyValueByLabel(properties: Array<Property>, label: string, options?: PropertyOptions): string | number | boolean | Date | null;
+declare function getPropertyValueByLabel<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, label: string, options?: PropertyOptions): PropertyValueContent<T> | null;
+/**
+ * Gets the first value content of a property with the given label
+ *
+ * @param properties - Array of properties to search through
+ * @param label - The label to search for
+ * @param options - Search options, including whether to include nested properties
+ * @returns The first property value content as string, or null if property not found
+ */
+declare function getPropertyValueContentByLabel<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, label: string, options?: PropertyOptions): PropertyValueContent<T>["content"] | null;
 /**
  * Gets all unique properties from an array of properties
  *
@@ -1483,7 +1530,7 @@ declare function getPropertyValueByLabel(properties: Array<Property>, label: str
  * @param options - Search options, including whether to include nested properties
  * @returns Array of unique properties
  */
-declare function getUniqueProperties(properties: Array<Property>, options?: PropertyOptions): Array<Property>;
+declare function getUniqueProperties<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, options?: PropertyOptions): Array<Property<T>>;
 /**
  * Gets all unique property labels from an array of properties
  *
@@ -1491,7 +1538,7 @@ declare function getUniqueProperties(properties: Array<Property>, options?: Prop
  * @param options - Search options, including whether to include nested properties
  * @returns Array of unique property labels
  */
-declare function getUniquePropertyLabels(properties: Array<Property>, options?: PropertyOptions): Array<string>;
+declare function getUniquePropertyLabels<T extends PropertyValueContentType = PropertyValueContentType>(properties: Array<Property<T>>, options?: PropertyOptions): Array<string>;
 /**
  * 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
@@ -1508,9 +1555,9 @@ declare function getLeafPropertyValues<T extends PropertyValueContentType = Prop
  * @param options - Search options, including whether to include nested properties
  * @returns True if the property matches the filter criteria, false otherwise
  */
-declare function filterProperties(property: Property, filter: {
+declare function filterProperties<T extends PropertyValueContentType = PropertyValueContentType>(property: Property<T>, filter: {
   label: string;
-  value: string | number | boolean | Date;
+  value: PropertyValueContent<T>;
 }, options?: PropertyOptions): boolean;
 //#endregion
 //#region src/utils/helpers.d.ts
@@ -1536,4 +1583,4 @@ declare const DEFAULT_PAGE_SIZE = 48;
  */
 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>;
 //#endregion
-export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Query, QueryGroup, QueryLeaf, Resource, Scope, Section, Set, SetAttributeValueQueryItem, SetItemsSort, SetItemsSortDirection, SpatialUnit, Style, StylesheetCategory, StylesheetItem, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteType, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Query, QueryGroup, QueryLeaf, Resource, Scope, Section, Set, SetAttributeValueQueryItem, SetItemsSort, SetItemsSortDirection, SpatialUnit, Style, StylesheetCategory, StylesheetItem, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteType, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValueContent, getPropertyByLabelAndValueContents, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValueContentByLabel, getPropertyValueContentByUuid, getPropertyValueContentsByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };