@digitalculture/ochre-sdk 0.5.11 → 0.5.12

package/dist/index.cjs

@@ -25,6 +25,7 @@ __export(index_exports, {
   fetchConcept: () => fetchConcept,
   fetchGallery: () => fetchGallery,
   fetchPeriod: () => fetchPeriod,
+  fetchPropertyValue: () => fetchPropertyValue,
   fetchResource: () => fetchResource,
   fetchSet: () => fetchSet,
   fetchSpatialUnit: () => fetchSpatialUnit,
@@ -2542,6 +2543,36 @@ async function fetchPeriod(uuid) {
   }
 }
 
+// src/utils/fetchers/property-value.ts
+async function fetchPropertyValue(uuid) {
+  try {
+    const [error, dataRaw] = await fetchByUuid(uuid);
+    if (error !== null) {
+      throw new Error(error);
+    }
+    if (!("propertyValue" in dataRaw.ochre)) {
+      throw new Error(
+        "Invalid OCHRE data: API response missing 'propertyValue' key"
+      );
+    }
+    const propertyValueItem = parsePropertyValue(dataRaw.ochre.propertyValue);
+    const data = {
+      uuid: parseFakeString(dataRaw.ochre.uuid),
+      publicationDateTime: new Date(dataRaw.ochre.publicationDateTime),
+      belongsTo: {
+        uuid: dataRaw.ochre.uuidBelongsTo,
+        abbreviation: parseFakeString(dataRaw.ochre.belongsTo)
+      },
+      metadata: parseMetadata(dataRaw.ochre.metadata),
+      item: propertyValueItem
+    };
+    return { metadata: data.metadata, propertyValue: data.item };
+  } catch (error) {
+    console.error(error);
+    return null;
+  }
+}
+
 // src/utils/fetchers/set.ts
 async function fetchSet(uuid) {
   try {
@@ -2663,6 +2694,7 @@ async function fetchWebsite(abbreviation) {
   fetchConcept,
   fetchGallery,
   fetchPeriod,
+  fetchPropertyValue,
   fetchResource,
   fetchSet,
   fetchSpatialUnit,

package/dist/index.d.cts

@@ -1342,6 +1342,35 @@ declare function fetchPeriod(uuid: string): Promise<{
     period: Period;
 } | null>;
 
+/**
+ * Fetches and parses a property value from the OCHRE API
+ *
+ * @param uuid - The UUID of the property value to fetch
+ * @returns Object containing the parsed property value and its metadata, or null if the fetch/parse fails
+ *
+ * @example
+ * ```ts
+ * const result = await fetchPropertyValue("123e4567-e89b-12d3-a456-426614174000");
+ * if (result === null) {
+ *   console.error("Failed to fetch property value");
+ *   return;
+ * }
+ * const { metadata, item } = result;
+ * console.log(`Fetched property value: ${item.identification.label}`);
+ * ```
+ *
+ * @remarks
+ * The returned property value includes:
+ * - Identification
+ * - Description
+ * - Notes
+ * - Links
+ */
+declare function fetchPropertyValue(uuid: string): Promise<{
+    metadata: Metadata;
+    propertyValue: PropertyValue;
+} | null>;
+
 /**
  * Fetches and parses a resource from the OCHRE API
  *
@@ -1891,4 +1920,4 @@ declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnote
  */
 declare function parseStringContent(content: OchreStringContent, language?: string): string;
 
-export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, type Document, type Event, type Footnote, type Gallery, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type License, type Link, type Metadata, type NestedConcept, type NestedResource, type NestedSpatialUnit, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueContent, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebBlock, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchBibliography, fetchByUuid, fetchConcept, fetchGallery, fetchPeriod, fetchResource, fetchSet, fetchSpatialUnit, fetchTree, fetchWebsite, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmail, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePerson, parsePersons, parseProperties, parsePropertyValue, parsePropertyValues, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite };
+export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, type Document, type Event, type Footnote, type Gallery, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type License, type Link, type Metadata, type NestedConcept, type NestedResource, type NestedSpatialUnit, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueContent, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebBlock, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchBibliography, fetchByUuid, fetchConcept, fetchGallery, fetchPeriod, fetchPropertyValue, fetchResource, fetchSet, fetchSpatialUnit, fetchTree, fetchWebsite, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmail, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePerson, parsePersons, parseProperties, parsePropertyValue, parsePropertyValues, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite };

package/dist/index.d.ts

@@ -1342,6 +1342,35 @@ declare function fetchPeriod(uuid: string): Promise<{
     period: Period;
 } | null>;
 
+/**
+ * Fetches and parses a property value from the OCHRE API
+ *
+ * @param uuid - The UUID of the property value to fetch
+ * @returns Object containing the parsed property value and its metadata, or null if the fetch/parse fails
+ *
+ * @example
+ * ```ts
+ * const result = await fetchPropertyValue("123e4567-e89b-12d3-a456-426614174000");
+ * if (result === null) {
+ *   console.error("Failed to fetch property value");
+ *   return;
+ * }
+ * const { metadata, item } = result;
+ * console.log(`Fetched property value: ${item.identification.label}`);
+ * ```
+ *
+ * @remarks
+ * The returned property value includes:
+ * - Identification
+ * - Description
+ * - Notes
+ * - Links
+ */
+declare function fetchPropertyValue(uuid: string): Promise<{
+    metadata: Metadata;
+    propertyValue: PropertyValue;
+} | null>;
+
 /**
  * Fetches and parses a resource from the OCHRE API
  *
@@ -1891,4 +1920,4 @@ declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnote
  */
 declare function parseStringContent(content: OchreStringContent, language?: string): string;
 
-export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, type Document, type Event, type Footnote, type Gallery, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type License, type Link, type Metadata, type NestedConcept, type NestedResource, type NestedSpatialUnit, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueContent, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebBlock, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchBibliography, fetchByUuid, fetchConcept, fetchGallery, fetchPeriod, fetchResource, fetchSet, fetchSpatialUnit, fetchTree, fetchWebsite, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmail, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePerson, parsePersons, parseProperties, parsePropertyValue, parsePropertyValues, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite };
+export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, type Document, type Event, type Footnote, type Gallery, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type License, type Link, type Metadata, type NestedConcept, type NestedResource, type NestedSpatialUnit, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueContent, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebBlock, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchBibliography, fetchByUuid, fetchConcept, fetchGallery, fetchPeriod, fetchPropertyValue, fetchResource, fetchSet, fetchSpatialUnit, fetchTree, fetchWebsite, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmail, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePerson, parsePersons, parseProperties, parsePropertyValue, parsePropertyValues, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite };

package/dist/index.js

@@ -2463,6 +2463,36 @@ async function fetchPeriod(uuid) {
   }
 }
 
+// src/utils/fetchers/property-value.ts
+async function fetchPropertyValue(uuid) {
+  try {
+    const [error, dataRaw] = await fetchByUuid(uuid);
+    if (error !== null) {
+      throw new Error(error);
+    }
+    if (!("propertyValue" in dataRaw.ochre)) {
+      throw new Error(
+        "Invalid OCHRE data: API response missing 'propertyValue' key"
+      );
+    }
+    const propertyValueItem = parsePropertyValue(dataRaw.ochre.propertyValue);
+    const data = {
+      uuid: parseFakeString(dataRaw.ochre.uuid),
+      publicationDateTime: new Date(dataRaw.ochre.publicationDateTime),
+      belongsTo: {
+        uuid: dataRaw.ochre.uuidBelongsTo,
+        abbreviation: parseFakeString(dataRaw.ochre.belongsTo)
+      },
+      metadata: parseMetadata(dataRaw.ochre.metadata),
+      item: propertyValueItem
+    };
+    return { metadata: data.metadata, propertyValue: data.item };
+  } catch (error) {
+    console.error(error);
+    return null;
+  }
+}
+
 // src/utils/fetchers/set.ts
 async function fetchSet(uuid) {
   try {
@@ -2583,6 +2613,7 @@ export {
   fetchConcept,
   fetchGallery,
   fetchPeriod,
+  fetchPropertyValue,
   fetchResource,
   fetchSet,
   fetchSpatialUnit,

package/package.json

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