ochre-sdk 1.0.0-beta.3 → 1.0.0-beta.5

package/dist/index.d.mts

@@ -5,8 +5,17 @@
  */
 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>;
@@ -15,13 +24,12 @@ type MultilingualStringJSON<T extends ReadonlyArray<string> = ReadonlyArray<stri
  * 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 MultilingualInputContent<T extends ReadonlyArray<string>> = Partial<Record<T[number], MultilingualStringInput>>;
+type MultilingualEntriesInput<T extends ReadonlyArray<string>> = Partial<Record<T[number], ReadonlyArray<MultilingualStringInput>>>;
 /**
  * Multilingual string
  */
@@ -35,17 +43,17 @@ declare class MultilingualString<T extends ReadonlyArray<string> = ReadonlyArray
    * 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(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(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
    */
@@ -56,18 +64,34 @@ declare class MultilingualString<T extends ReadonlyArray<string> = ReadonlyArray
    * 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 +132,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)
    */
@@ -925,7 +945,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>;
@@ -939,7 +958,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
  */
@@ -960,7 +978,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>;
@@ -971,7 +988,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
  */
@@ -989,7 +1005,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>;
@@ -1016,7 +1031,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
  */
@@ -1055,7 +1069,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>;
@@ -1650,7 +1663,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;
@@ -1842,4 +1854,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 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 };