@digitalculture/ochre-sdk 0.7.15 → 0.7.17

package/dist/index.d.cts

@@ -1,9 +1,4 @@
-import { Language } from "iso-639-3";
-
 //#region src/types/main.d.ts
-/**
-* Represents the core data structure containing item information and metadata
-*/
 /**
  * Represents the core data structure containing item information and metadata
  */
@@ -42,7 +37,7 @@ type Metadata = {
   } | null;
   dataset: string;
   publisher: string;
-  languages: Array<Language["iso6393"]>;
+  languages: Array<string>;
   identifier: string;
   description: string;
 };
@@ -177,7 +172,7 @@ type Coordinates = {
 type Observation = {
   number: number;
   date: Date | null;
-  observers: Array<string>;
+  observers: Array<string> | Array<Person>;
   notes: Array<Note>;
   links: Array<Link>;
   properties: Array<Property>;
@@ -360,11 +355,11 @@ type PropertyValueContentType = "string" | "integer" | "decimal" | "boolean" | "
 /**
  * Represents a property value with type information
  */
-type PropertyValueContent = {
-  content: string | number | boolean | Date | null;
-  booleanValue: boolean | null;
+type PropertyValueContent<T extends PropertyValueContentType> = {
+  content: T extends "string" ? string : T extends "IDREF" ? string : T extends "integer" ? number : T extends "decimal" ? number : T extends "boolean" ? boolean : T extends "date" ? Date : T extends "dateTime" ? Date : T extends "time" ? Date : null;
+  booleanLabel: T extends "boolean" ? string | null : null;
   isUncertain: boolean;
-  type: PropertyValueContentType;
+  type: T;
   category: string;
   uuid: string | null;
   publicationDateTime: Date | null;
@@ -373,10 +368,10 @@ type PropertyValueContent = {
 /**
  * Represents a property with label, values and nested properties
  */
-type Property = {
+type Property<T extends PropertyValueContentType = PropertyValueContentType> = {
   uuid: string;
   label: string;
-  values: Array<PropertyValueContent>;
+  values: Array<PropertyValueContent<T>>;
   comment: string | null;
   properties: Array<Property>;
 };
@@ -782,6 +777,59 @@ type PropertyOptions = {
   /** Whether to recursively search through nested properties */
   includeNestedProperties: boolean;
 };
+/**
+ * Finds a property by its UUID in an array of properties
+ *
+ * @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 matching Property object, or null if not found
+ *
+ * @example
+ * ```ts
+ * const property = getPropertyByUuid(properties, "123e4567-e89b-12d3-a456-426614174000", { includeNestedProperties: true });
+ * if (property) {
+ *   console.log(property.values);
+ * }
+ * ```
+ */
+declare function getPropertyByUuid(properties: Array<Property>, uuid: string, options?: PropertyOptions): Property | null;
+/**
+ * Retrieves all values 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 values as strings, or null if property not found
+ *
+ * @example
+ * ```ts
+ * const values = getPropertyValuesByUuid(properties, "123e4567-e89b-12d3-a456-426614174000");
+ * if (values) {
+ *   for (const value of values) {
+ *     console.log(value);
+ *   }
+ * }
+ * ```
+ */
+declare function getPropertyValuesByUuid(properties: Array<Property>, uuid: string, options?: PropertyOptions): Array<string | number | boolean | Date | null> | null;
+/**
+ * Gets the first value 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 as string, or null if property not found
+ *
+ * @example
+ * ```ts
+ * const title = getPropertyValueByUuid(properties, "123e4567-e89b-12d3-a456-426614174000");
+ * if (title) {
+ *   console.log(`Document title: ${title}`);
+ * }
+ * ```
+ */
+declare function getPropertyValueByUuid(properties: Array<Property>, uuid: string, options?: PropertyOptions): string | number | boolean | Date | null;
 /**
  * Finds a property by its label in an array of properties
  *
@@ -849,6 +897,20 @@ declare function getPropertyValueByLabel(properties: Array<Property>, label: str
  * ```
  */
 declare function getUniqueProperties(properties: Array<Property>, options?: PropertyOptions): Array<Property>;
+/**
+ * Gets all unique property labels from an array of properties
+ *
+ * @param properties - Array of properties to get unique property labels from
+ * @param options - Search options, including whether to include nested properties
+ * @returns Array of unique property labels
+ *
+ * @example
+ * ```ts
+ * const properties = getAllUniquePropertyLabels(properties, { includeNestedProperties: true });
+ * console.log(`Available properties: ${properties.join(", ")}`);
+ * ```
+ */
+declare function getUniquePropertyLabels(properties: Array<Property>, options?: PropertyOptions): Array<string>;
 /**
  * Filters a property based on a label and value criteria
  *
@@ -876,4 +938,4 @@ declare function filterProperties(property: Property, filter: {
 }, options?: PropertyOptions): boolean;
 
 //#endregion
-export { Bibliography, Concept, Context, ContextItem, ContextNode, Coordinates, Data, DataCategory, Document, Event, Footnote, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Set, SpatialUnit, Style, Tree, WebBlock, WebElement, WebElementComponent, WebImage, WebSectionSidebarItem, Webpage, WebpageProperties, Website, WebsiteProperties, fetchGallery, fetchItem, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, getUniqueProperties };
+export { Bibliography, Concept, Context, ContextItem, ContextNode, Coordinates, Data, DataCategory, Document, Event, Footnote, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Set, SpatialUnit, Style, Tree, WebBlock, WebElement, WebElementComponent, WebImage, WebSectionSidebarItem, Webpage, WebpageProperties, Website, WebsiteProperties, fetchGallery, fetchItem, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/dist/index.d.ts

@@ -1,9 +1,4 @@
-import { Language } from "iso-639-3";
-
 //#region src/types/main.d.ts
-/**
-* Represents the core data structure containing item information and metadata
-*/
 /**
  * Represents the core data structure containing item information and metadata
  */
@@ -42,7 +37,7 @@ type Metadata = {
   } | null;
   dataset: string;
   publisher: string;
-  languages: Array<Language["iso6393"]>;
+  languages: Array<string>;
   identifier: string;
   description: string;
 };
@@ -177,7 +172,7 @@ type Coordinates = {
 type Observation = {
   number: number;
   date: Date | null;
-  observers: Array<string>;
+  observers: Array<string> | Array<Person>;
   notes: Array<Note>;
   links: Array<Link>;
   properties: Array<Property>;
@@ -360,11 +355,11 @@ type PropertyValueContentType = "string" | "integer" | "decimal" | "boolean" | "
 /**
  * Represents a property value with type information
  */
-type PropertyValueContent = {
-  content: string | number | boolean | Date | null;
-  booleanValue: boolean | null;
+type PropertyValueContent<T extends PropertyValueContentType> = {
+  content: T extends "string" ? string : T extends "IDREF" ? string : T extends "integer" ? number : T extends "decimal" ? number : T extends "boolean" ? boolean : T extends "date" ? Date : T extends "dateTime" ? Date : T extends "time" ? Date : null;
+  booleanLabel: T extends "boolean" ? string | null : null;
   isUncertain: boolean;
-  type: PropertyValueContentType;
+  type: T;
   category: string;
   uuid: string | null;
   publicationDateTime: Date | null;
@@ -373,10 +368,10 @@ type PropertyValueContent = {
 /**
  * Represents a property with label, values and nested properties
  */
-type Property = {
+type Property<T extends PropertyValueContentType = PropertyValueContentType> = {
   uuid: string;
   label: string;
-  values: Array<PropertyValueContent>;
+  values: Array<PropertyValueContent<T>>;
   comment: string | null;
   properties: Array<Property>;
 };
@@ -782,6 +777,59 @@ type PropertyOptions = {
   /** Whether to recursively search through nested properties */
   includeNestedProperties: boolean;
 };
+/**
+ * Finds a property by its UUID in an array of properties
+ *
+ * @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 matching Property object, or null if not found
+ *
+ * @example
+ * ```ts
+ * const property = getPropertyByUuid(properties, "123e4567-e89b-12d3-a456-426614174000", { includeNestedProperties: true });
+ * if (property) {
+ *   console.log(property.values);
+ * }
+ * ```
+ */
+declare function getPropertyByUuid(properties: Array<Property>, uuid: string, options?: PropertyOptions): Property | null;
+/**
+ * Retrieves all values 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 values as strings, or null if property not found
+ *
+ * @example
+ * ```ts
+ * const values = getPropertyValuesByUuid(properties, "123e4567-e89b-12d3-a456-426614174000");
+ * if (values) {
+ *   for (const value of values) {
+ *     console.log(value);
+ *   }
+ * }
+ * ```
+ */
+declare function getPropertyValuesByUuid(properties: Array<Property>, uuid: string, options?: PropertyOptions): Array<string | number | boolean | Date | null> | null;
+/**
+ * Gets the first value 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 as string, or null if property not found
+ *
+ * @example
+ * ```ts
+ * const title = getPropertyValueByUuid(properties, "123e4567-e89b-12d3-a456-426614174000");
+ * if (title) {
+ *   console.log(`Document title: ${title}`);
+ * }
+ * ```
+ */
+declare function getPropertyValueByUuid(properties: Array<Property>, uuid: string, options?: PropertyOptions): string | number | boolean | Date | null;
 /**
  * Finds a property by its label in an array of properties
  *
@@ -849,6 +897,20 @@ declare function getPropertyValueByLabel(properties: Array<Property>, label: str
  * ```
  */
 declare function getUniqueProperties(properties: Array<Property>, options?: PropertyOptions): Array<Property>;
+/**
+ * Gets all unique property labels from an array of properties
+ *
+ * @param properties - Array of properties to get unique property labels from
+ * @param options - Search options, including whether to include nested properties
+ * @returns Array of unique property labels
+ *
+ * @example
+ * ```ts
+ * const properties = getAllUniquePropertyLabels(properties, { includeNestedProperties: true });
+ * console.log(`Available properties: ${properties.join(", ")}`);
+ * ```
+ */
+declare function getUniquePropertyLabels(properties: Array<Property>, options?: PropertyOptions): Array<string>;
 /**
  * Filters a property based on a label and value criteria
  *
@@ -876,4 +938,4 @@ declare function filterProperties(property: Property, filter: {
 }, options?: PropertyOptions): boolean;
 
 //#endregion
-export { Bibliography, Concept, Context, ContextItem, ContextNode, Coordinates, Data, DataCategory, Document, Event, Footnote, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Set, SpatialUnit, Style, Tree, WebBlock, WebElement, WebElementComponent, WebImage, WebSectionSidebarItem, Webpage, WebpageProperties, Website, WebsiteProperties, fetchGallery, fetchItem, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, getUniqueProperties };
+export { Bibliography, Concept, Context, ContextItem, ContextNode, Coordinates, Data, DataCategory, Document, Event, Footnote, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Set, SpatialUnit, Style, Tree, WebBlock, WebElement, WebElementComponent, WebImage, WebSectionSidebarItem, Webpage, WebpageProperties, Website, WebsiteProperties, fetchGallery, fetchItem, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };