@digitalculture/ochre-sdk 0.6.5 → 0.7.0

package/dist/index.cjs

@@ -134,6 +134,17 @@ var categorySchema = import_zod.z.enum([
   "set",
   "tree"
 ]);
+var propertyValueContentTypeSchema = import_zod.z.enum([
+  "string",
+  "integer",
+  "decimal",
+  "boolean",
+  "date",
+  "dateTime",
+  "time",
+  "coordinate",
+  "IDREF"
+]);
 var gallerySchema = import_zod.z.object({
   uuid: import_zod.z.string().uuid({ message: "Invalid UUID" }),
   filter: import_zod.z.string().optional(),
@@ -1016,7 +1027,7 @@ function parseEvents(events) {
   }
   return returnEvents;
 }
-function parseProperty(property, type, language = "eng") {
+function parseProperty(property, language = "eng") {
   const valuesToParse = "value" in property && property.value ? Array.isArray(property.value) ? property.value : [property.value] : [];
   const values = valuesToParse.map((value) => {
     let content = null;
@@ -1026,14 +1037,15 @@ function parseProperty(property, type, language = "eng") {
       const returnValue = {
         content,
         booleanValue,
-        type,
+        type: "string",
         category: "value",
         uuid: null,
-        publicationDateTime: null
+        publicationDateTime: null,
+        unit: null
       };
       return returnValue;
     } else {
-      switch (type) {
+      switch (value.type) {
         case "integer":
         case "decimal": {
           content = Number(value.content);
@@ -1049,19 +1061,32 @@ function parseProperty(property, type, language = "eng") {
           } else if (value.content != null) {
             content = parseStringContent({ content: value.content });
           }
-          if (type === "boolean") {
+          if (value.type === "boolean") {
             booleanValue = value.booleanValue ?? null;
           }
           break;
         }
       }
+      let parsedType = "string";
+      if (value.type != null) {
+        const { data, error } = propertyValueContentTypeSchema.safeParse(
+          value.type
+        );
+        if (error) {
+          throw new Error(
+            `Invalid property value content type: "${value.type}"`
+          );
+        }
+        parsedType = data;
+      }
       const returnValue = {
         content,
         booleanValue,
-        type,
+        type: parsedType,
         category: value.category ?? "value",
         uuid: value.uuid ?? null,
-        publicationDateTime: value.publicationDateTime != null ? new Date(value.publicationDateTime) : null
+        publicationDateTime: value.publicationDateTime != null ? new Date(value.publicationDateTime) : null,
+        unit: value.unit ?? null
       };
       return returnValue;
     }
@@ -1078,9 +1103,7 @@ function parseProperty(property, type, language = "eng") {
 function parseProperties(properties, language = "eng") {
   const returnProperties = [];
   for (const property of properties) {
-    returnProperties.push(
-      parseProperty(property, "string", language)
-    );
+    returnProperties.push(parseProperty(property, language));
   }
   return returnProperties;
 }
@@ -1420,14 +1443,11 @@ function parseResource(resource) {
     creators: resource.creators ? parsePersons(
       Array.isArray(resource.creators.creator) ? resource.creators.creator : [resource.creators.creator]
     ) : [],
-    notes: (
-      // TODO: Remove this check once the { rend: "splitNotes" } issue is fixed
-      resource.notes && "note" in resource.notes ? parseNotes(
-        Array.isArray(resource.notes.note) ? resource.notes.note : [resource.notes.note]
-      ) : []
-    ),
+    notes: resource.notes ? parseNotes(
+      Array.isArray(resource.notes.note) ? resource.notes.note : [resource.notes.note]
+    ) : [],
     description: resource.description ? ["string", "number", "boolean"].includes(typeof resource.description) ? parseFakeString(resource.description) : parseStringContent(resource.description) : "",
-    document: resource.document ? parseDocument(resource.document.content) : null,
+    document: resource.document && "content" in resource.document ? parseDocument(resource.document.content) : null,
     href: resource.href ?? null,
     imageMap: resource.imagemap ? parseImageMap(resource.imagemap) : null,
     periods: resource.periods ? parsePeriods(
@@ -1570,7 +1590,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
   const imageLinks = links.filter(
     (link) => link.type === "image" || link.type === "IIIF"
   );
-  let document = elementResource.document ? parseDocument(elementResource.document.content) : null;
+  let document = elementResource.document && "content" in elementResource.document ? parseDocument(elementResource.document.content) : null;
   if (document === null) {
     const documentLink = links.find((link) => link.type === "internalDocument");
     if (documentLink) {
@@ -2656,7 +2676,9 @@ async function fetchGallery(uuid, filter, page, perPage) {
     const gallery = {
       identification: galleryIdentification,
       projectIdentification: galleryProjectIdentification,
-      resources: data.result.gallery.resource ? Array.isArray(data.result.gallery.resource) ? parseResources(data.result.gallery.resource) : [parseResource(data.result.gallery.resource)] : [],
+      resources: parseResources(
+        data.result.gallery.resource ? Array.isArray(data.result.gallery.resource) ? data.result.gallery.resource : [data.result.gallery.resource] : []
+      ),
       maxLength: data.result.gallery.maxLength
     };
     return { item: gallery, error: null };

package/dist/index.d.cts

@@ -346,20 +346,21 @@ type PropertyValueContentType = "string" | "integer" | "decimal" | "boolean" | "
 /**
  * Represents a property value with type information
  */
-type PropertyValueContent<T extends PropertyValueContentType> = {
-    content: T extends "number" ? number : T extends "integer" ? number : T extends "decimal" ? number : T extends "dateTime" ? Date | null : string;
-    booleanValue: T extends "boolean" ? boolean : null;
-    type: T;
+type PropertyValueContent = {
+    content: string | number | boolean | Date | null;
+    booleanValue: boolean | null;
+    type: PropertyValueContentType;
     category: string;
     uuid: string | null;
     publicationDateTime: Date | null;
+    unit: string | null;
 };
 /**
  * Represents a property with label, values and nested properties
  */
 type Property = {
     label: string;
-    values: Array<PropertyValueContent<PropertyValueContentType>>;
+    values: Array<PropertyValueContent>;
     comment: string | null;
     properties: Array<Property>;
 };
@@ -898,9 +899,11 @@ type OchreResource = {
   image?: OchreImage;
   creators?: { creator: OchrePerson | Array<OchrePerson> };
   notes?: { note: OchreNote | Array<OchreNote> };
-  document?: {
-    content: OchreStringRichText | Array<OchreStringRichText>;
-  };
+  document?:
+    | {
+        content: OchreStringRichText | Array<OchreStringRichText>;
+      }
+    | object;
   imagemap?: OchreImageMap;
   periods?: { period: OchrePeriod | Array<OchrePeriod> };
   links?: OchreLink | Array<OchreLink>;
@@ -953,9 +956,10 @@ type OchreConcept = {
 type OchrePropertyValueContent = {
   uuid?: string;
   publicationDateTime?: string; // YYYY-MM-DDThh:mm:ssZ
-  type: string;
+  type?: string;
   category?: string;
   slug?: FakeString;
+  unit?: string;
   booleanValue?: boolean;
   content?: FakeString | OchreStringItem | Array<OchreStringItem>;
 };
@@ -1536,7 +1540,7 @@ declare function parseObservations(observations: Array<OchreObservation>): Array
  * @returns Array of parsed Event objects
  */
 declare function parseEvents(events: Array<OchreEvent>): Array<Event>;
-declare function parseProperty<T extends PropertyValueContentType>(property: OchreProperty, type: T, language?: string): Property;
+declare function parseProperty(property: OchreProperty, language?: string): Property;
 /**
  * Parses raw properties into standardized Property objects
  *

package/dist/index.d.ts

@@ -346,20 +346,21 @@ type PropertyValueContentType = "string" | "integer" | "decimal" | "boolean" | "
 /**
  * Represents a property value with type information
  */
-type PropertyValueContent<T extends PropertyValueContentType> = {
-    content: T extends "number" ? number : T extends "integer" ? number : T extends "decimal" ? number : T extends "dateTime" ? Date | null : string;
-    booleanValue: T extends "boolean" ? boolean : null;
-    type: T;
+type PropertyValueContent = {
+    content: string | number | boolean | Date | null;
+    booleanValue: boolean | null;
+    type: PropertyValueContentType;
     category: string;
     uuid: string | null;
     publicationDateTime: Date | null;
+    unit: string | null;
 };
 /**
  * Represents a property with label, values and nested properties
  */
 type Property = {
     label: string;
-    values: Array<PropertyValueContent<PropertyValueContentType>>;
+    values: Array<PropertyValueContent>;
     comment: string | null;
     properties: Array<Property>;
 };
@@ -898,9 +899,11 @@ type OchreResource = {
   image?: OchreImage;
   creators?: { creator: OchrePerson | Array<OchrePerson> };
   notes?: { note: OchreNote | Array<OchreNote> };
-  document?: {
-    content: OchreStringRichText | Array<OchreStringRichText>;
-  };
+  document?:
+    | {
+        content: OchreStringRichText | Array<OchreStringRichText>;
+      }
+    | object;
   imagemap?: OchreImageMap;
   periods?: { period: OchrePeriod | Array<OchrePeriod> };
   links?: OchreLink | Array<OchreLink>;
@@ -953,9 +956,10 @@ type OchreConcept = {
 type OchrePropertyValueContent = {
   uuid?: string;
   publicationDateTime?: string; // YYYY-MM-DDThh:mm:ssZ
-  type: string;
+  type?: string;
   category?: string;
   slug?: FakeString;
+  unit?: string;
   booleanValue?: boolean;
   content?: FakeString | OchreStringItem | Array<OchreStringItem>;
 };
@@ -1536,7 +1540,7 @@ declare function parseObservations(observations: Array<OchreObservation>): Array
  * @returns Array of parsed Event objects
  */
 declare function parseEvents(events: Array<OchreEvent>): Array<Event>;
-declare function parseProperty<T extends PropertyValueContentType>(property: OchreProperty, type: T, language?: string): Property;
+declare function parseProperty(property: OchreProperty, language?: string): Property;
 /**
  * Parses raw properties into standardized Property objects
  *

package/dist/index.js

@@ -60,6 +60,17 @@ var categorySchema = z.enum([
   "set",
   "tree"
 ]);
+var propertyValueContentTypeSchema = z.enum([
+  "string",
+  "integer",
+  "decimal",
+  "boolean",
+  "date",
+  "dateTime",
+  "time",
+  "coordinate",
+  "IDREF"
+]);
 var gallerySchema = z.object({
   uuid: z.string().uuid({ message: "Invalid UUID" }),
   filter: z.string().optional(),
@@ -942,7 +953,7 @@ function parseEvents(events) {
   }
   return returnEvents;
 }
-function parseProperty(property, type, language = "eng") {
+function parseProperty(property, language = "eng") {
   const valuesToParse = "value" in property && property.value ? Array.isArray(property.value) ? property.value : [property.value] : [];
   const values = valuesToParse.map((value) => {
     let content = null;
@@ -952,14 +963,15 @@ function parseProperty(property, type, language = "eng") {
       const returnValue = {
         content,
         booleanValue,
-        type,
+        type: "string",
         category: "value",
         uuid: null,
-        publicationDateTime: null
+        publicationDateTime: null,
+        unit: null
       };
       return returnValue;
     } else {
-      switch (type) {
+      switch (value.type) {
         case "integer":
         case "decimal": {
           content = Number(value.content);
@@ -975,19 +987,32 @@ function parseProperty(property, type, language = "eng") {
           } else if (value.content != null) {
             content = parseStringContent({ content: value.content });
           }
-          if (type === "boolean") {
+          if (value.type === "boolean") {
             booleanValue = value.booleanValue ?? null;
           }
           break;
         }
       }
+      let parsedType = "string";
+      if (value.type != null) {
+        const { data, error } = propertyValueContentTypeSchema.safeParse(
+          value.type
+        );
+        if (error) {
+          throw new Error(
+            `Invalid property value content type: "${value.type}"`
+          );
+        }
+        parsedType = data;
+      }
       const returnValue = {
         content,
         booleanValue,
-        type,
+        type: parsedType,
         category: value.category ?? "value",
         uuid: value.uuid ?? null,
-        publicationDateTime: value.publicationDateTime != null ? new Date(value.publicationDateTime) : null
+        publicationDateTime: value.publicationDateTime != null ? new Date(value.publicationDateTime) : null,
+        unit: value.unit ?? null
       };
       return returnValue;
     }
@@ -1004,9 +1029,7 @@ function parseProperty(property, type, language = "eng") {
 function parseProperties(properties, language = "eng") {
   const returnProperties = [];
   for (const property of properties) {
-    returnProperties.push(
-      parseProperty(property, "string", language)
-    );
+    returnProperties.push(parseProperty(property, language));
   }
   return returnProperties;
 }
@@ -1346,14 +1369,11 @@ function parseResource(resource) {
     creators: resource.creators ? parsePersons(
       Array.isArray(resource.creators.creator) ? resource.creators.creator : [resource.creators.creator]
     ) : [],
-    notes: (
-      // TODO: Remove this check once the { rend: "splitNotes" } issue is fixed
-      resource.notes && "note" in resource.notes ? parseNotes(
-        Array.isArray(resource.notes.note) ? resource.notes.note : [resource.notes.note]
-      ) : []
-    ),
+    notes: resource.notes ? parseNotes(
+      Array.isArray(resource.notes.note) ? resource.notes.note : [resource.notes.note]
+    ) : [],
     description: resource.description ? ["string", "number", "boolean"].includes(typeof resource.description) ? parseFakeString(resource.description) : parseStringContent(resource.description) : "",
-    document: resource.document ? parseDocument(resource.document.content) : null,
+    document: resource.document && "content" in resource.document ? parseDocument(resource.document.content) : null,
     href: resource.href ?? null,
     imageMap: resource.imagemap ? parseImageMap(resource.imagemap) : null,
     periods: resource.periods ? parsePeriods(
@@ -1496,7 +1516,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
   const imageLinks = links.filter(
     (link) => link.type === "image" || link.type === "IIIF"
   );
-  let document = elementResource.document ? parseDocument(elementResource.document.content) : null;
+  let document = elementResource.document && "content" in elementResource.document ? parseDocument(elementResource.document.content) : null;
   if (document === null) {
     const documentLink = links.find((link) => link.type === "internalDocument");
     if (documentLink) {
@@ -2582,7 +2602,9 @@ async function fetchGallery(uuid, filter, page, perPage) {
     const gallery = {
       identification: galleryIdentification,
       projectIdentification: galleryProjectIdentification,
-      resources: data.result.gallery.resource ? Array.isArray(data.result.gallery.resource) ? parseResources(data.result.gallery.resource) : [parseResource(data.result.gallery.resource)] : [],
+      resources: parseResources(
+        data.result.gallery.resource ? Array.isArray(data.result.gallery.resource) ? data.result.gallery.resource : [data.result.gallery.resource] : []
+      ),
       maxLength: data.result.gallery.maxLength
     };
     return { item: gallery, error: null };

package/package.json

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