@digitalculture/ochre-sdk 0.5.10 → 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,
@@ -62,6 +63,8 @@ __export(index_exports, {
   parsePerson: () => parsePerson,
   parsePersons: () => parsePersons,
   parseProperties: () => parseProperties,
+  parsePropertyValue: () => parsePropertyValue,
+  parsePropertyValues: () => parsePropertyValues,
   parseResource: () => parseResource,
   parseResources: () => parseResources,
   parseSet: () => parseSet,
@@ -574,6 +577,7 @@ var componentSchema = import_zod3.z.enum(
     "n-columns",
     "n-rows",
     "network-graph",
+    "search-bar",
     "table",
     "text",
     "timeline",
@@ -712,7 +716,7 @@ function parsePersons(persons) {
   return returnPersons;
 }
 function parseLink(linkRaw) {
-  const links = "resource" in linkRaw ? linkRaw.resource : "spatialUnit" in linkRaw ? linkRaw.spatialUnit : "concept" in linkRaw ? linkRaw.concept : "set" in linkRaw ? linkRaw.set : "tree" in linkRaw ? linkRaw.tree : "person" in linkRaw ? linkRaw.person : "bibliography" in linkRaw ? linkRaw.bibliography : "epigraphicUnit" in linkRaw ? linkRaw.epigraphicUnit : null;
+  const links = "resource" in linkRaw ? linkRaw.resource : "spatialUnit" in linkRaw ? linkRaw.spatialUnit : "concept" in linkRaw ? linkRaw.concept : "set" in linkRaw ? linkRaw.set : "tree" in linkRaw ? linkRaw.tree : "person" in linkRaw ? linkRaw.person : "bibliography" in linkRaw ? linkRaw.bibliography : "epigraphicUnit" in linkRaw ? linkRaw.epigraphicUnit : "propertyValue" in linkRaw ? linkRaw.propertyValue : null;
   if (!links) {
     throw new Error(
       `Invalid link provided: ${JSON.stringify(linkRaw, null, 2)}`
@@ -722,7 +726,7 @@ function parseLink(linkRaw) {
   const returnLinks = [];
   for (const link of linksToParse) {
     const returnLink = {
-      category: "resource" in linkRaw ? "resource" : "spatialUnit" in linkRaw ? "spatialUnit" : "concept" in linkRaw ? "concept" : "set" in linkRaw ? "set" : "person" in linkRaw ? "person" : "tree" in linkRaw ? "tree" : "bibliography" in linkRaw ? "bibliography" : "epigraphicUnit" in linkRaw ? "epigraphicUnit" : null,
+      category: "resource" in linkRaw ? "resource" : "spatialUnit" in linkRaw ? "spatialUnit" : "concept" in linkRaw ? "concept" : "set" in linkRaw ? "set" : "person" in linkRaw ? "person" : "tree" in linkRaw ? "tree" : "bibliography" in linkRaw ? "bibliography" : "epigraphicUnit" in linkRaw ? "epigraphicUnit" : "propertyValue" in linkRaw ? "propertyValue" : null,
       content: "content" in link ? link.content != null ? parseFakeString(link.content) : null : null,
       href: "href" in link && link.href != null ? link.href : null,
       uuid: link.uuid,
@@ -1017,6 +1021,31 @@ function parseBibliographies(bibliographies) {
   }
   return returnBibliographies;
 }
+function parsePropertyValue(propertyValue) {
+  return {
+    uuid: propertyValue.uuid,
+    category: "propertyValue",
+    n: propertyValue.n,
+    publicationDateTime: propertyValue.publicationDateTime ? new Date(propertyValue.publicationDateTime) : null,
+    identification: parseIdentification(propertyValue.identification),
+    description: ["string", "number", "boolean"].includes(
+      typeof propertyValue.description
+    ) ? parseFakeString(propertyValue.description) : parseStringContent(propertyValue.description),
+    notes: propertyValue.notes ? parseNotes(
+      Array.isArray(propertyValue.notes.note) ? propertyValue.notes.note : [propertyValue.notes.note]
+    ) : [],
+    links: propertyValue.links ? parseLinks(
+      Array.isArray(propertyValue.links) ? propertyValue.links : [propertyValue.links]
+    ) : []
+  };
+}
+function parsePropertyValues(propertyValues) {
+  const returnPropertyValues = [];
+  for (const propertyValue of propertyValues) {
+    returnPropertyValues.push(parsePropertyValue(propertyValue));
+  }
+  return returnPropertyValues;
+}
 function parseTree(tree) {
   let creators = [];
   if (tree.creators) {
@@ -1034,6 +1063,7 @@ function parseTree(tree) {
   let periods = [];
   let bibliographies = [];
   let persons = [];
+  let propertyValues = [];
   if (typeof tree.items !== "string" && "resource" in tree.items) {
     resources = parseResources(
       Array.isArray(tree.items.resource) ? tree.items.resource : [tree.items.resource]
@@ -1064,6 +1094,11 @@ function parseTree(tree) {
       Array.isArray(tree.items.person) ? tree.items.person : [tree.items.person]
     );
   }
+  if (typeof tree.items !== "string" && "propertyValue" in tree.items) {
+    propertyValues = parsePropertyValues(
+      Array.isArray(tree.items.propertyValue) ? tree.items.propertyValue : [tree.items.propertyValue]
+    );
+  }
   const returnTree = {
     uuid: tree.uuid,
     category: "tree",
@@ -1080,7 +1115,8 @@ function parseTree(tree) {
       concepts,
       periods,
       bibliographies,
-      persons
+      persons,
+      propertyValues
     },
     properties: tree.properties ? parseProperties(
       Array.isArray(tree.properties.property) ? tree.properties.property : [tree.properties.property]
@@ -1095,6 +1131,7 @@ function parseSet(set) {
   let periods = [];
   let bibliographies = [];
   let persons = [];
+  let propertyValues = [];
   if (typeof set.items !== "string" && "resource" in set.items) {
     resources = parseResources(
       Array.isArray(set.items.resource) ? set.items.resource : [set.items.resource],
@@ -1128,6 +1165,11 @@ function parseSet(set) {
       Array.isArray(set.items.person) ? set.items.person : [set.items.person]
     );
   }
+  if (typeof set.items !== "string" && "propertyValue" in set.items) {
+    propertyValues = parsePropertyValues(
+      Array.isArray(set.items.propertyValue) ? set.items.propertyValue : [set.items.propertyValue]
+    );
+  }
   return {
     uuid: set.uuid,
     category: "set",
@@ -1148,7 +1190,8 @@ function parseSet(set) {
       concepts,
       periods,
       bibliographies,
-      persons
+      persons,
+      propertyValues
     }
   };
 }
@@ -1712,6 +1755,15 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.tableId = tableLink.uuid;
       break;
     }
+    case "search-bar": {
+      let variant = getPropertyValueByLabel(
+        componentProperty.properties,
+        "variant"
+      );
+      variant ??= "default";
+      properties.variant = variant;
+      break;
+    }
     case "text": {
       if (!document) {
         throw new Error(
@@ -2491,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 {
@@ -2612,6 +2694,7 @@ async function fetchWebsite(abbreviation) {
   fetchConcept,
   fetchGallery,
   fetchPeriod,
+  fetchPropertyValue,
   fetchResource,
   fetchSet,
   fetchSpatialUnit,
@@ -2649,6 +2732,8 @@ async function fetchWebsite(abbreviation) {
   parsePerson,
   parsePersons,
   parseProperties,
+  parsePropertyValue,
+  parsePropertyValues,
   parseResource,
   parseResources,
   parseSet,

package/dist/index.d.cts

@@ -11,7 +11,7 @@ type Data = {
     };
     publicationDateTime: Date;
     metadata: Metadata;
-    item: Tree | Set | Resource | SpatialUnit | Concept | Period | Bibliography | Person;
+    item: Tree | Set | Resource | SpatialUnit | Concept | Period | Bibliography | Person | PropertyValue;
 };
 /**
  * Basic identification information used across multiple types
@@ -112,7 +112,7 @@ type Link = {
     uuid: string;
     publicationDateTime: Date | null;
     type: string | null;
-    category: "resource" | "spatialUnit" | "concept" | "set" | "tree" | "person" | "bibliography" | "epigraphicUnit" | null;
+    category: "resource" | "spatialUnit" | "concept" | "set" | "tree" | "person" | "bibliography" | "epigraphicUnit" | "propertyValue" | null;
     identification: Identification | null;
     content: string | null;
     href: string | null;
@@ -295,6 +295,7 @@ type Set = {
         periods: Array<Period>;
         bibliographies: Array<Bibliography>;
         persons: Array<Person>;
+        propertyValues: Array<PropertyValue>;
     };
 };
 /**
@@ -343,15 +344,24 @@ type Period = {
     description: string | null;
 };
 /**
- * Valid types for property values
+ * Represents a property value with type information
  */
-type PropertyValueType = "string" | "number" | "integer" | "boolean" | "date" | "dateTime" | "time" | "IDREF";
+type PropertyValue = {
+    uuid: string;
+    category: "propertyValue";
+    n: number;
+    publicationDateTime: Date | null;
+    identification: Identification;
+    description: string;
+    notes: Array<Note>;
+    links: Array<Link>;
+};
 /**
  * Represents a property value with type information
  */
-type PropertyValue = {
+type PropertyValueContent = {
     content: string;
-    type: PropertyValueType;
+    type: "string" | "number" | "integer" | "boolean" | "date" | "dateTime" | "time" | "IDREF";
     category: string | null;
     uuid: string | null;
     publicationDateTime: Date | null;
@@ -361,7 +371,7 @@ type PropertyValue = {
  */
 type Property = {
     label: string;
-    values: Array<PropertyValue>;
+    values: Array<PropertyValueContent>;
     comment: string | null;
     properties: Array<Property>;
 };
@@ -385,6 +395,7 @@ type Tree = {
         periods: Array<Period>;
         bibliographies: Array<Bibliography>;
         persons: Array<Person>;
+        propertyValues: Array<PropertyValue>;
     };
     properties: Array<Property>;
 };
@@ -547,6 +558,9 @@ type WebElementComponent = {
     rows: Array<WebElement>;
 } | {
     component: "network-graph";
+} | {
+    component: "search-bar";
+    variant: "default" | "full";
 } | {
     component: "table";
     tableId: string;
@@ -796,6 +810,7 @@ type OchreData = {
     | { period: OchrePeriod }
     | { bibliography: OchreBibliography }
     | { person: OchrePerson }
+    | { propertyValue: OchrePropertyValue }
   );
 };
 
@@ -840,7 +855,8 @@ type OchreTree = {
     | { concept: OchreConcept | Array<OchreConcept> }
     | { period: OchrePeriod | Array<OchrePeriod> }
     | { bibliography: OchreBibliography | Array<OchreBibliography> }
-    | { person: OchrePerson | Array<OchrePerson> };
+    | { person: OchrePerson | Array<OchrePerson> }
+    | { propertyValue: OchrePropertyValue | Array<OchrePropertyValue> };
   properties?: { property: OchreProperty | Array<OchreProperty> };
 };
 
@@ -865,7 +881,8 @@ type OchreSet = {
     | { concept: OchreConcept | Array<OchreConcept> }
     | { period: OchrePeriod | Array<OchrePeriod> }
     | { bibliography: OchreBibliography | Array<OchreBibliography> }
-    | { person: OchrePerson | Array<OchrePerson> };
+    | { person: OchrePerson | Array<OchrePerson> }
+    | { propertyValue: OchrePropertyValue | Array<OchrePropertyValue> };
 };
 
 /**
@@ -962,7 +979,7 @@ type OchreNestedConcept = Omit<OchreConcept, "context" | "availability">;
 /**
  * Raw property value structure corresponding to the parsed PropertyValue type
  */
-type OchrePropertyValue = OchreStringContent & {
+type OchrePropertyValueContent = OchreStringContent & {
   uuid?: string;
   publicationDateTime?: string; // YYYY-MM-DDThh:mm:ssZ
   type: string;
@@ -975,7 +992,10 @@ type OchrePropertyValue = OchreStringContent & {
  */
 type OchreProperty = {
   label: OchreStringContent & { uuid: string };
-  value?: OchrePropertyValue | Array<OchrePropertyValue> | FakeString;
+  value?:
+    | OchrePropertyValueContent
+    | Array<OchrePropertyValueContent>
+    | FakeString;
   comment?: FakeString;
   property?: OchreProperty | Array<OchreProperty>;
 };
@@ -1038,7 +1058,8 @@ type OchreLink =
   | { tree: OchreLinkItem | Array<OchreLinkItem> }
   | { person: OchreLinkItem | Array<OchreLinkItem> }
   | { epigraphicUnit: OchreLinkItem | Array<OchreLinkItem> }
-  | { bibliography: OchreBibliography | Array<OchreBibliography> };
+  | { bibliography: OchreBibliography | Array<OchreBibliography> }
+  | { propertyValue: OchreLinkItem | Array<OchreLinkItem> };
 
 /**
  * Raw image structure corresponding to the parsed Image type
@@ -1259,6 +1280,19 @@ type OchreInterpretation = {
   properties?: { property: OchreProperty | Array<OchreProperty> };
 };
 
+/**
+ * Raw property value structure corresponding to the parsed PropertyValue type
+ */
+type OchrePropertyValue = {
+  uuid: string;
+  n: number;
+  publicationDateTime?: string; // YYYY-MM-DDThh:mm:ss
+  identification: OchreIdentification;
+  description: OchreStringContent | FakeString;
+  notes?: { note: OchreNote | Array<OchreNote> };
+  links?: OchreLink | Array<OchreLink>;
+};
+
 /**
  * Fetches raw OCHRE data by UUID from the OCHRE API
  *
@@ -1308,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
  *
@@ -1730,6 +1793,20 @@ declare function parseBibliography(bibliography: OchreBibliography): Bibliograph
  * @returns Array of parsed Bibliography objects
  */
 declare function parseBibliographies(bibliographies: Array<OchreBibliography>): Array<Bibliography>;
+/**
+ * Parses raw property value data into a standardized PropertyValue structure
+ *
+ * @param propertyValue - Raw property value data in OCHRE format
+ * @returns Parsed PropertyValue object
+ */
+declare function parsePropertyValue(propertyValue: OchrePropertyValue): PropertyValue;
+/**
+ * Parses an array of raw property values into standardized PropertyValue objects
+ *
+ * @param propertyValues - Array of raw property values in OCHRE format
+ * @returns Array of parsed PropertyValue objects
+ */
+declare function parsePropertyValues(propertyValues: Array<OchrePropertyValue>): Array<PropertyValue>;
 /**
  * Parses a raw tree structure into a standardized Tree object
  *
@@ -1843,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 PropertyValueType, 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, 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

@@ -11,7 +11,7 @@ type Data = {
     };
     publicationDateTime: Date;
     metadata: Metadata;
-    item: Tree | Set | Resource | SpatialUnit | Concept | Period | Bibliography | Person;
+    item: Tree | Set | Resource | SpatialUnit | Concept | Period | Bibliography | Person | PropertyValue;
 };
 /**
  * Basic identification information used across multiple types
@@ -112,7 +112,7 @@ type Link = {
     uuid: string;
     publicationDateTime: Date | null;
     type: string | null;
-    category: "resource" | "spatialUnit" | "concept" | "set" | "tree" | "person" | "bibliography" | "epigraphicUnit" | null;
+    category: "resource" | "spatialUnit" | "concept" | "set" | "tree" | "person" | "bibliography" | "epigraphicUnit" | "propertyValue" | null;
     identification: Identification | null;
     content: string | null;
     href: string | null;
@@ -295,6 +295,7 @@ type Set = {
         periods: Array<Period>;
         bibliographies: Array<Bibliography>;
         persons: Array<Person>;
+        propertyValues: Array<PropertyValue>;
     };
 };
 /**
@@ -343,15 +344,24 @@ type Period = {
     description: string | null;
 };
 /**
- * Valid types for property values
+ * Represents a property value with type information
  */
-type PropertyValueType = "string" | "number" | "integer" | "boolean" | "date" | "dateTime" | "time" | "IDREF";
+type PropertyValue = {
+    uuid: string;
+    category: "propertyValue";
+    n: number;
+    publicationDateTime: Date | null;
+    identification: Identification;
+    description: string;
+    notes: Array<Note>;
+    links: Array<Link>;
+};
 /**
  * Represents a property value with type information
  */
-type PropertyValue = {
+type PropertyValueContent = {
     content: string;
-    type: PropertyValueType;
+    type: "string" | "number" | "integer" | "boolean" | "date" | "dateTime" | "time" | "IDREF";
     category: string | null;
     uuid: string | null;
     publicationDateTime: Date | null;
@@ -361,7 +371,7 @@ type PropertyValue = {
  */
 type Property = {
     label: string;
-    values: Array<PropertyValue>;
+    values: Array<PropertyValueContent>;
     comment: string | null;
     properties: Array<Property>;
 };
@@ -385,6 +395,7 @@ type Tree = {
         periods: Array<Period>;
         bibliographies: Array<Bibliography>;
         persons: Array<Person>;
+        propertyValues: Array<PropertyValue>;
     };
     properties: Array<Property>;
 };
@@ -547,6 +558,9 @@ type WebElementComponent = {
     rows: Array<WebElement>;
 } | {
     component: "network-graph";
+} | {
+    component: "search-bar";
+    variant: "default" | "full";
 } | {
     component: "table";
     tableId: string;
@@ -796,6 +810,7 @@ type OchreData = {
     | { period: OchrePeriod }
     | { bibliography: OchreBibliography }
     | { person: OchrePerson }
+    | { propertyValue: OchrePropertyValue }
   );
 };
 
@@ -840,7 +855,8 @@ type OchreTree = {
     | { concept: OchreConcept | Array<OchreConcept> }
     | { period: OchrePeriod | Array<OchrePeriod> }
     | { bibliography: OchreBibliography | Array<OchreBibliography> }
-    | { person: OchrePerson | Array<OchrePerson> };
+    | { person: OchrePerson | Array<OchrePerson> }
+    | { propertyValue: OchrePropertyValue | Array<OchrePropertyValue> };
   properties?: { property: OchreProperty | Array<OchreProperty> };
 };
 
@@ -865,7 +881,8 @@ type OchreSet = {
     | { concept: OchreConcept | Array<OchreConcept> }
     | { period: OchrePeriod | Array<OchrePeriod> }
     | { bibliography: OchreBibliography | Array<OchreBibliography> }
-    | { person: OchrePerson | Array<OchrePerson> };
+    | { person: OchrePerson | Array<OchrePerson> }
+    | { propertyValue: OchrePropertyValue | Array<OchrePropertyValue> };
 };
 
 /**
@@ -962,7 +979,7 @@ type OchreNestedConcept = Omit<OchreConcept, "context" | "availability">;
 /**
  * Raw property value structure corresponding to the parsed PropertyValue type
  */
-type OchrePropertyValue = OchreStringContent & {
+type OchrePropertyValueContent = OchreStringContent & {
   uuid?: string;
   publicationDateTime?: string; // YYYY-MM-DDThh:mm:ssZ
   type: string;
@@ -975,7 +992,10 @@ type OchrePropertyValue = OchreStringContent & {
  */
 type OchreProperty = {
   label: OchreStringContent & { uuid: string };
-  value?: OchrePropertyValue | Array<OchrePropertyValue> | FakeString;
+  value?:
+    | OchrePropertyValueContent
+    | Array<OchrePropertyValueContent>
+    | FakeString;
   comment?: FakeString;
   property?: OchreProperty | Array<OchreProperty>;
 };
@@ -1038,7 +1058,8 @@ type OchreLink =
   | { tree: OchreLinkItem | Array<OchreLinkItem> }
   | { person: OchreLinkItem | Array<OchreLinkItem> }
   | { epigraphicUnit: OchreLinkItem | Array<OchreLinkItem> }
-  | { bibliography: OchreBibliography | Array<OchreBibliography> };
+  | { bibliography: OchreBibliography | Array<OchreBibliography> }
+  | { propertyValue: OchreLinkItem | Array<OchreLinkItem> };
 
 /**
  * Raw image structure corresponding to the parsed Image type
@@ -1259,6 +1280,19 @@ type OchreInterpretation = {
   properties?: { property: OchreProperty | Array<OchreProperty> };
 };
 
+/**
+ * Raw property value structure corresponding to the parsed PropertyValue type
+ */
+type OchrePropertyValue = {
+  uuid: string;
+  n: number;
+  publicationDateTime?: string; // YYYY-MM-DDThh:mm:ss
+  identification: OchreIdentification;
+  description: OchreStringContent | FakeString;
+  notes?: { note: OchreNote | Array<OchreNote> };
+  links?: OchreLink | Array<OchreLink>;
+};
+
 /**
  * Fetches raw OCHRE data by UUID from the OCHRE API
  *
@@ -1308,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
  *
@@ -1730,6 +1793,20 @@ declare function parseBibliography(bibliography: OchreBibliography): Bibliograph
  * @returns Array of parsed Bibliography objects
  */
 declare function parseBibliographies(bibliographies: Array<OchreBibliography>): Array<Bibliography>;
+/**
+ * Parses raw property value data into a standardized PropertyValue structure
+ *
+ * @param propertyValue - Raw property value data in OCHRE format
+ * @returns Parsed PropertyValue object
+ */
+declare function parsePropertyValue(propertyValue: OchrePropertyValue): PropertyValue;
+/**
+ * Parses an array of raw property values into standardized PropertyValue objects
+ *
+ * @param propertyValues - Array of raw property values in OCHRE format
+ * @returns Array of parsed PropertyValue objects
+ */
+declare function parsePropertyValues(propertyValues: Array<OchrePropertyValue>): Array<PropertyValue>;
 /**
  * Parses a raw tree structure into a standardized Tree object
  *
@@ -1843,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 PropertyValueType, 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, 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

@@ -497,6 +497,7 @@ var componentSchema = z3.enum(
     "n-columns",
     "n-rows",
     "network-graph",
+    "search-bar",
     "table",
     "text",
     "timeline",
@@ -635,7 +636,7 @@ function parsePersons(persons) {
   return returnPersons;
 }
 function parseLink(linkRaw) {
-  const links = "resource" in linkRaw ? linkRaw.resource : "spatialUnit" in linkRaw ? linkRaw.spatialUnit : "concept" in linkRaw ? linkRaw.concept : "set" in linkRaw ? linkRaw.set : "tree" in linkRaw ? linkRaw.tree : "person" in linkRaw ? linkRaw.person : "bibliography" in linkRaw ? linkRaw.bibliography : "epigraphicUnit" in linkRaw ? linkRaw.epigraphicUnit : null;
+  const links = "resource" in linkRaw ? linkRaw.resource : "spatialUnit" in linkRaw ? linkRaw.spatialUnit : "concept" in linkRaw ? linkRaw.concept : "set" in linkRaw ? linkRaw.set : "tree" in linkRaw ? linkRaw.tree : "person" in linkRaw ? linkRaw.person : "bibliography" in linkRaw ? linkRaw.bibliography : "epigraphicUnit" in linkRaw ? linkRaw.epigraphicUnit : "propertyValue" in linkRaw ? linkRaw.propertyValue : null;
   if (!links) {
     throw new Error(
       `Invalid link provided: ${JSON.stringify(linkRaw, null, 2)}`
@@ -645,7 +646,7 @@ function parseLink(linkRaw) {
   const returnLinks = [];
   for (const link of linksToParse) {
     const returnLink = {
-      category: "resource" in linkRaw ? "resource" : "spatialUnit" in linkRaw ? "spatialUnit" : "concept" in linkRaw ? "concept" : "set" in linkRaw ? "set" : "person" in linkRaw ? "person" : "tree" in linkRaw ? "tree" : "bibliography" in linkRaw ? "bibliography" : "epigraphicUnit" in linkRaw ? "epigraphicUnit" : null,
+      category: "resource" in linkRaw ? "resource" : "spatialUnit" in linkRaw ? "spatialUnit" : "concept" in linkRaw ? "concept" : "set" in linkRaw ? "set" : "person" in linkRaw ? "person" : "tree" in linkRaw ? "tree" : "bibliography" in linkRaw ? "bibliography" : "epigraphicUnit" in linkRaw ? "epigraphicUnit" : "propertyValue" in linkRaw ? "propertyValue" : null,
       content: "content" in link ? link.content != null ? parseFakeString(link.content) : null : null,
       href: "href" in link && link.href != null ? link.href : null,
       uuid: link.uuid,
@@ -940,6 +941,31 @@ function parseBibliographies(bibliographies) {
   }
   return returnBibliographies;
 }
+function parsePropertyValue(propertyValue) {
+  return {
+    uuid: propertyValue.uuid,
+    category: "propertyValue",
+    n: propertyValue.n,
+    publicationDateTime: propertyValue.publicationDateTime ? new Date(propertyValue.publicationDateTime) : null,
+    identification: parseIdentification(propertyValue.identification),
+    description: ["string", "number", "boolean"].includes(
+      typeof propertyValue.description
+    ) ? parseFakeString(propertyValue.description) : parseStringContent(propertyValue.description),
+    notes: propertyValue.notes ? parseNotes(
+      Array.isArray(propertyValue.notes.note) ? propertyValue.notes.note : [propertyValue.notes.note]
+    ) : [],
+    links: propertyValue.links ? parseLinks(
+      Array.isArray(propertyValue.links) ? propertyValue.links : [propertyValue.links]
+    ) : []
+  };
+}
+function parsePropertyValues(propertyValues) {
+  const returnPropertyValues = [];
+  for (const propertyValue of propertyValues) {
+    returnPropertyValues.push(parsePropertyValue(propertyValue));
+  }
+  return returnPropertyValues;
+}
 function parseTree(tree) {
   let creators = [];
   if (tree.creators) {
@@ -957,6 +983,7 @@ function parseTree(tree) {
   let periods = [];
   let bibliographies = [];
   let persons = [];
+  let propertyValues = [];
   if (typeof tree.items !== "string" && "resource" in tree.items) {
     resources = parseResources(
       Array.isArray(tree.items.resource) ? tree.items.resource : [tree.items.resource]
@@ -987,6 +1014,11 @@ function parseTree(tree) {
       Array.isArray(tree.items.person) ? tree.items.person : [tree.items.person]
     );
   }
+  if (typeof tree.items !== "string" && "propertyValue" in tree.items) {
+    propertyValues = parsePropertyValues(
+      Array.isArray(tree.items.propertyValue) ? tree.items.propertyValue : [tree.items.propertyValue]
+    );
+  }
   const returnTree = {
     uuid: tree.uuid,
     category: "tree",
@@ -1003,7 +1035,8 @@ function parseTree(tree) {
       concepts,
       periods,
       bibliographies,
-      persons
+      persons,
+      propertyValues
     },
     properties: tree.properties ? parseProperties(
       Array.isArray(tree.properties.property) ? tree.properties.property : [tree.properties.property]
@@ -1018,6 +1051,7 @@ function parseSet(set) {
   let periods = [];
   let bibliographies = [];
   let persons = [];
+  let propertyValues = [];
   if (typeof set.items !== "string" && "resource" in set.items) {
     resources = parseResources(
       Array.isArray(set.items.resource) ? set.items.resource : [set.items.resource],
@@ -1051,6 +1085,11 @@ function parseSet(set) {
       Array.isArray(set.items.person) ? set.items.person : [set.items.person]
     );
   }
+  if (typeof set.items !== "string" && "propertyValue" in set.items) {
+    propertyValues = parsePropertyValues(
+      Array.isArray(set.items.propertyValue) ? set.items.propertyValue : [set.items.propertyValue]
+    );
+  }
   return {
     uuid: set.uuid,
     category: "set",
@@ -1071,7 +1110,8 @@ function parseSet(set) {
       concepts,
       periods,
       bibliographies,
-      persons
+      persons,
+      propertyValues
     }
   };
 }
@@ -1635,6 +1675,15 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.tableId = tableLink.uuid;
       break;
     }
+    case "search-bar": {
+      let variant = getPropertyValueByLabel(
+        componentProperty.properties,
+        "variant"
+      );
+      variant ??= "default";
+      properties.variant = variant;
+      break;
+    }
     case "text": {
       if (!document) {
         throw new Error(
@@ -2414,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 {
@@ -2534,6 +2613,7 @@ export {
   fetchConcept,
   fetchGallery,
   fetchPeriod,
+  fetchPropertyValue,
   fetchResource,
   fetchSet,
   fetchSpatialUnit,
@@ -2571,6 +2651,8 @@ export {
   parsePerson,
   parsePersons,
   parseProperties,
+  parsePropertyValue,
+  parsePropertyValues,
   parseResource,
   parseResources,
   parseSet,

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.5.10",
+  "version": "0.5.12",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
   "author": "Firat Ciftci <firatciftci@uchicago.edu> (https://digitalculture.uchicago.edu)",
-  "homepage": "https://github.com/forumfordigitalculture/ochre-sdk",
+  "homepage": "https://github.com/uchicago-digitalculture-webdev/ochre-sdk",
   "bugs": {
-    "url": "https://github.com/forumfordigitalculture/ochre-sdk/issues"
+    "url": "https://github.com/uchicago-digitalculture-webdev/ochre-sdk/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/forumfordigitalculture/ochre-sdk.git"
+    "url": "git+https://github.com/uchicago-digitalculture-webdev/ochre-sdk.git"
   },
   "keywords": [
     "ochre",