ochre-sdk 1.0.0-beta.1 → 1.0.0-beta.11

package/dist/index.d.mts

@@ -5,23 +5,39 @@
  */
 type MultilingualStringEntry = {
   text: string;
+  richText: string;
   isPrimary: boolean;
 };
+type MultilingualStringText = {
+  text: string;
+  richText: string;
+};
+type MultilingualStringInput = string | {
+  text: string;
+  richText?: string;
+};
 type MultilingualStringJSON<T extends ReadonlyArray<string> = ReadonlyArray<string>> = {
   content: Partial<Record<T[number], Array<MultilingualStringEntry>>>;
   aliases: Array<string>;
 };
+type MultilingualStringObject<T extends ReadonlyArray<string> = ReadonlyArray<string>> = Partial<Record<T[number], MultilingualStringInput>>;
+type MultilingualStringEntries<T extends ReadonlyArray<string> = ReadonlyArray<string>> = Partial<Record<T[number], ReadonlyArray<MultilingualStringInput>>>;
 /**
  * Options for creating and working with multilingual strings
  */
 type MultilingualOptions = {
-  /** Whether this string contains rich text/HTML content */isRichText?: boolean; /** Default language to use for fallbacks */
-  defaultLanguage?: string; /** Available languages for this string */
+  /** Default language to use for fallbacks */defaultLanguage?: string; /** Available languages for this string */
   availableLanguages?: ReadonlyArray<string>; /** Alias values carried by OCHRE as zxx content */
   aliases?: ReadonlyArray<string>;
 };
-type MultilingualInputContent<T extends ReadonlyArray<string>> = Partial<Record<T[number], string>>;
-type MultilingualEntriesInput<T extends ReadonlyArray<string>> = Partial<Record<T[number], ReadonlyArray<string>>>;
+type MultilingualContent<T extends ReadonlyArray<string>> = Partial<Record<T[number], ReadonlyArray<MultilingualStringEntry>>>;
+declare const MULTILINGUAL_STRING_INTERNAL_INIT: unique symbol;
+type MultilingualStringInternalInit<T extends ReadonlyArray<string>> = {
+  readonly [MULTILINGUAL_STRING_INTERNAL_INIT]: true;
+  content: MultilingualContent<T>;
+  options: Required<MultilingualOptions>;
+  availableLanguages: ReadonlyArray<T[number]>;
+};
 /**
  * Multilingual string
  */
@@ -30,44 +46,72 @@ declare class MultilingualString<T extends ReadonlyArray<string> = ReadonlyArray
   private readonly _options;
   private readonly _availableLanguages;
   private readonly _aliases;
-  private constructor();
+  /**
+   * Create a new multilingual string from an object of language codes to text.
+   */
+  /** @internal */
+  constructor(init: MultilingualStringInternalInit<T>);
+  constructor(content: MultilingualStringObject<T>, languages: T, options?: MultilingualOptions);
+  constructor(content?: Partial<Record<string, MultilingualStringInput>>, languages?: undefined, options?: MultilingualOptions);
+  private static fromNormalized;
   /**
    * Create a new multilingual string from an object of language codes to text
    */
-  static fromObject<U extends ReadonlyArray<string>>(content: MultilingualInputContent<U>, languages: U, options?: MultilingualOptions): MultilingualString<U>;
-  static fromObject(content: Partial<Record<string, string>>, languages?: undefined, options?: MultilingualOptions): MultilingualString<ReadonlyArray<string>>;
+  static fromObject<U extends ReadonlyArray<string>>(content: MultilingualStringObject<U>, languages: U, options?: MultilingualOptions): MultilingualString<U>;
+  static fromObject(content: Partial<Record<string, MultilingualStringInput>>, languages?: undefined, options?: MultilingualOptions): MultilingualString<ReadonlyArray<string>>;
   /**
    * Create a new multilingual string from language entries.
    */
-  static fromEntries<U extends ReadonlyArray<string>>(content: MultilingualEntriesInput<U>, languages: U, options?: MultilingualOptions): MultilingualString<U>;
-  static fromEntries(content: Partial<Record<string, ReadonlyArray<string>>>, languages?: undefined, options?: MultilingualOptions): MultilingualString<ReadonlyArray<string>>;
+  static fromEntries<U extends ReadonlyArray<string>>(content: MultilingualStringEntries<U>, languages: U, options?: MultilingualOptions): MultilingualString<U>;
+  static fromEntries(content: Partial<Record<string, ReadonlyArray<MultilingualStringInput>>>, languages?: undefined, options?: MultilingualOptions): MultilingualString<ReadonlyArray<string>>;
   /**
    * Create a new multilingual string for a single language
    */
-  static create<U extends ReadonlyArray<string>>(language: U[number], text: string, languages: U, options?: MultilingualOptions): MultilingualString<U>;
-  static create(language: string, text: string, languages?: undefined, options?: MultilingualOptions): MultilingualString<ReadonlyArray<string>>;
+  static create<U extends ReadonlyArray<string>>(language: U[number], text: MultilingualStringInput, languages: U, options?: MultilingualOptions): MultilingualString<U>;
+  static create(language: string, text: MultilingualStringInput, languages?: undefined, options?: MultilingualOptions): MultilingualString<ReadonlyArray<string>>;
   /**
    * Create an empty multilingual string
    */
   static empty<U extends ReadonlyArray<string>>(languages: U, options?: MultilingualOptions): MultilingualString<U>;
   static empty(languages?: undefined, options?: MultilingualOptions): MultilingualString<ReadonlyArray<string>>;
+  /**
+   * Recreate a multilingual string from its JSON representation.
+   */
+  static fromJSON<U extends ReadonlyArray<string>>(json: MultilingualStringJSON<U>, languages: U, options?: Omit<MultilingualOptions, "aliases">): MultilingualString<U>;
+  static fromJSON(json: MultilingualStringJSON, languages?: undefined, options?: Omit<MultilingualOptions, "aliases">): MultilingualString<ReadonlyArray<string>>;
   private getPrimaryEntry;
   /**
    * Get text in a specific language with automatic fallback
    */
   getText(language?: T[number]): string;
+  /**
+   * Get rich text in a specific language with automatic fallback
+   */
+  getRichText(language?: T[number]): string;
   /**
    * Get primary text in a specific language without fallback
    */
   getExactText(language: T[number]): string | null;
+  /**
+   * Get primary rich text in a specific language without fallback
+   */
+  getExactRichText(language: T[number]): string | null;
   /**
    * Get all text entries in a specific language without fallback
    */
   getExactTexts(language: T[number]): Array<string>;
+  /**
+   * Get all rich text entries in a specific language without fallback
+   */
+  getExactRichTexts(language: T[number]): Array<string>;
   /**
    * Get all text entries in a specific language with fallback
    */
   getTexts(language?: T[number]): Array<string>;
+  /**
+   * Get all rich text entries in a specific language with fallback
+   */
+  getRichTexts(language?: T[number]): Array<string>;
   /**
    * Get all entries in a specific language without fallback
    */
@@ -108,18 +152,14 @@ declare class MultilingualString<T extends ReadonlyArray<string> = ReadonlyArray
    * Get the default language
    */
   getDefaultLanguage(): T[number];
-  /**
-   * Check if this string contains rich text
-   */
-  isRichText(): boolean;
   /**
    * Add or update the primary text for a language (returns new instance)
    */
-  withText(language: T[number], text: string): MultilingualString<T>;
+  withText(language: T[number], text: MultilingualStringInput): MultilingualString<T>;
   /**
    * Add another text entry for a language (returns new instance)
    */
-  withEntry(language: T[number], text: string): MultilingualString<T>;
+  withEntry(language: T[number], text: MultilingualStringInput): MultilingualString<T>;
   /**
    * Replace aliases (returns new instance)
    */
@@ -228,9 +268,11 @@ type ItemLocation = "topLevel" | "nested";
 type ItemOrigin<T extends ReadonlyArray<string>, U extends ItemLocation> = U extends "topLevel" ? {
   belongsTo: BelongsTo;
   metadata: Metadata<T>;
+  persistentUrl: string | null;
 } : {
   belongsTo: null;
   metadata: null;
+  persistentUrl: null;
 };
 /**
  *  License in OCHRE
@@ -272,7 +314,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>;
@@ -380,7 +422,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">>;
 };
@@ -418,19 +460,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 {
@@ -806,7 +863,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
@@ -923,7 +980,6 @@ type Query = QueryLeaf | QueryGroup;
 type FetchFunction$4 = (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
 type FetchGalleryBaseOptions<TLanguages extends ReadonlyArray<string> | undefined = undefined> = {
   languages?: TLanguages;
-  isRichText?: boolean;
   fetch?: FetchFunction$4;
 };
 type FetchGalleryLanguages<TLanguages extends ReadonlyArray<string> | undefined> = TLanguages extends readonly [] ? ReadonlyArray<string> : TLanguages extends ReadonlyArray<string> ? TLanguages : ReadonlyArray<string>;
@@ -937,7 +993,6 @@ type FetchGalleryLanguages<TLanguages extends ReadonlyArray<string> | undefined>
  * @param params.perPage - The number of items per page
  * @param options - The options for the fetch
  * @param options.languages - Language codes to parse. Inline arrays preserve literal types automatically.
- * @param options.isRichText - Whether to parse rich text fields as HTML strings
  * @param options.fetch - The fetch function to use
  * @returns The parsed gallery or an error message if the fetch/parse fails
  */
@@ -958,7 +1013,6 @@ declare function fetchGallery<const TLanguages extends ReadonlyArray<string> | u
 type FetchFunction$3 = (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
 type FetchItemLinksBaseOptions<TLanguages extends ReadonlyArray<string> | undefined = undefined> = {
   languages?: TLanguages;
-  isRichText?: boolean;
   fetch?: FetchFunction$3;
 };
 type FetchItemLinksLanguages<TLanguages extends ReadonlyArray<string> | undefined> = TLanguages extends readonly [] ? ReadonlyArray<string> : TLanguages extends ReadonlyArray<string> ? TLanguages : ReadonlyArray<string>;
@@ -969,7 +1023,6 @@ type FetchItemLinksLanguages<TLanguages extends ReadonlyArray<string> | undefine
  * @param options - Fetch and parser options
  * @param options.itemCategory - The category of items inside linked Trees/Sets to parse. Tree accepts one category; Set accepts one category or an array.
  * @param options.languages - Language codes to parse. Inline arrays preserve literal types automatically.
- * @param options.isRichText - Whether to parse the text as rich text
  * @param options.fetch - Custom fetch function to use instead of the default fetch
  * @returns An object containing parsed linked items
  */
@@ -987,7 +1040,6 @@ declare function fetchItemLinks<const TItemCategory extends HierarchyItemCategor
 type FetchFunction$2 = (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
 type FetchItemBaseOptions<TLanguages extends ReadonlyArray<string> | undefined = undefined> = {
   languages?: TLanguages;
-  isRichText?: boolean;
   fetch?: FetchFunction$2;
 };
 type FetchItemLanguages<TLanguages extends ReadonlyArray<string> | undefined> = TLanguages extends readonly [] ? ReadonlyArray<string> : TLanguages extends ReadonlyArray<string> ? TLanguages : ReadonlyArray<string>;
@@ -1014,7 +1066,6 @@ declare function withLanguages<const TLanguages extends ReadonlyArray<string>>(l
  * @param options.category - The category of the OCHRE item to fetch
  * @param options.itemCategory - The category of items inside the OCHRE item to fetch. Only valid for Trees and Sets. Tree accepts one category; Set accepts one category or an array.
  * @param options.languages - Language codes to parse. Inline arrays preserve literal types automatically.
- * @param options.isRichText - Whether to parse the text as rich text
  * @param options.fetch - Custom fetch function to use instead of the default fetch
  * @returns An object containing the parsed item
  */
@@ -1053,7 +1104,6 @@ declare function fetchItem<const TCategory extends DataCategory, const TLanguage
 type FetchFunction$1 = (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
 type FetchSetItemsBaseOptions<TLanguages extends ReadonlyArray<string> | undefined = undefined> = {
   languages?: TLanguages;
-  isRichText?: boolean;
   fetch?: FetchFunction$1;
 };
 type FetchSetItemsLanguages<TLanguages extends ReadonlyArray<string> | undefined> = TLanguages extends readonly [] ? ReadonlyArray<string> : TLanguages extends ReadonlyArray<string> ? TLanguages : ReadonlyArray<string>;
@@ -1514,7 +1564,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;
@@ -1546,7 +1596,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;
@@ -1648,7 +1698,6 @@ type FetchFunction = (input: string | URL | globalThis.Request, init?: RequestIn
 declare function fetchWebsite<const T extends ReadonlyArray<string> = ReadonlyArray<string>>(abbreviation: string, options?: {
   fetch?: FetchFunction;
   languages?: T;
-  isRichText?: boolean;
 }): Promise<{
   website: Website<T>;
   error: null;
@@ -1666,127 +1715,146 @@ type PropertyOptions = {
   limitToLeafPropertyValues?: boolean;
 };
 type PropertyContent<T extends ReadonlyArray<string>> = PropertyValueContent<T>["content"];
+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 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<Property<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<Property<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<Property<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<Property<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 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 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 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 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 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<Property<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<Property<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<Property<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.
  *
@@ -1795,14 +1863,17 @@ declare function getPropertyValueContentByLabelName<T extends ReadonlyArray<stri
  * @returns Array of unique properties
  */
 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<Property<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.
  *
@@ -1811,17 +1882,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: Property<T>, filter: {
-  labelName: string;
+declare function filterProperties<T extends ReadonlyArray<string> = ReadonlyArray<string>>(property: SearchableProperty<T>, filter: {
+  variableLabel: string;
   value: PropertyValueContent<T>;
 }, options?: PropertyOptions): boolean;
 //#endregion
@@ -1840,4 +1911,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, 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 MultilingualStringEntries, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringObject, 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 };