@digitalculture/ochre-sdk 0.5.0 → 0.5.2

package/dist/index.cjs

@@ -567,6 +567,7 @@ var componentSchema = import_zod3.z.enum(
     "button",
     "collection",
     "empty-space",
+    "iframe",
     "iiif-viewer",
     "image",
     "image-gallery",
@@ -725,6 +726,7 @@ function parseLink(linkRaw) {
     const returnLink = {
       category: "resource" in linkRaw ? "resource" : "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,
       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,
       type: link.type ?? null,
       identification: link.identification ? parseIdentification(link.identification) : null,
@@ -1174,7 +1176,7 @@ function parseResource(resource, isNested = false) {
         Array.isArray(resource.notes.note) ? resource.notes.note : [resource.notes.note]
       ) : []
     ),
-    description: resource.description ? parseStringContent(resource.description) : "",
+    description: resource.description ? ["string", "number", "boolean"].includes(typeof resource.description) ? parseFakeString(resource.description) : parseStringContent(resource.description) : "",
     document: resource.document ? parseDocument(resource.document.content) : null,
     href: resource.href ?? null,
     imageMap: resource.imagemap ? parseImageMap(resource.imagemap) : null,
@@ -1408,9 +1410,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "layout"
       );
-      if (layout === null) {
-        layout = "long";
-      }
+      layout ??= "long";
       properties.bibliographies = bibliographyLink.bibliographies;
       properties.layout = layout;
       break;
@@ -1430,9 +1430,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "variant"
       );
-      if (variant === null) {
-        variant = "default";
-      }
+      variant ??= "default";
       let isExternal = false;
       let href = getPropertyValueByLabel(
         componentProperty.properties,
@@ -1463,16 +1461,12 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "variant"
       );
-      if (variant === null) {
-        variant = "full";
-      }
+      variant ??= "full";
       let layout = getPropertyValueByLabel(
         componentProperty.properties,
         "layout"
       );
-      if (layout === null) {
-        layout = "image-start";
-      }
+      layout ??= "image-start";
       const collectionLink = links.find((link) => link.category === "set");
       if (!collectionLink) {
         throw new Error(
@@ -1497,6 +1491,16 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.width = width;
       break;
     }
+    case "iframe": {
+      const url = links.find((link) => link.type === "webpage")?.href;
+      if (!url) {
+        throw new Error(
+          `URL not found for the following component: \u201C${componentName}\u201D`
+        );
+      }
+      properties.url = url;
+      break;
+    }
     case "iiif-viewer": {
       const manifestLink = links.find((link) => link.type === "IIIF");
       if (!manifestLink) {
@@ -1526,16 +1530,12 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "variant"
       );
-      if (variant === null) {
-        variant = "default";
-      }
+      variant ??= "default";
       let captionLayout = getPropertyValueByLabel(
         componentProperty.properties,
         "layout-caption"
       );
-      if (captionLayout === null) {
-        captionLayout = "bottom";
-      }
+      captionLayout ??= "bottom";
       let width = null;
       const widthProperty = getPropertyValueByLabel(
         componentProperty.properties,
@@ -1572,23 +1572,17 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "image-quality"
       );
-      if (imageQuality === null) {
-        imageQuality = "high";
-      }
+      imageQuality ??= "high";
       let captionSource = getPropertyValueByLabel(
         componentProperty.properties,
         "caption-source"
       );
-      if (captionSource === null) {
-        captionSource = "name";
-      }
+      captionSource ??= "name";
       let altTextSource = getPropertyValueByLabel(
         componentProperty.properties,
         "alt-text-source"
       );
-      if (altTextSource === null) {
-        altTextSource = "name";
-      }
+      altTextSource ??= "name";
       let isTransparentBackground = false;
       const isTransparentBackgroundProperty = getPropertyValueByLabel(
         componentProperty.properties,
@@ -1709,9 +1703,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "variant"
       );
-      if (variant === null) {
-        variant = "block";
-      }
+      variant ??= "block";
       const heading = getPropertyValueByLabel(
         componentProperty.properties,
         "heading"
@@ -1731,23 +1723,17 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "variant"
       );
-      if (variant === null) {
-        variant = "block";
-      }
+      variant ??= "block";
       let layout = getPropertyValueByLabel(
         componentProperty.properties,
         "layout"
       );
-      if (layout === null) {
-        layout = "image-start";
-      }
+      layout ??= "image-start";
       let captionLayout = getPropertyValueByLabel(
         componentProperty.properties,
         "layout-caption"
       );
-      if (captionLayout === null) {
-        captionLayout = "bottom";
-      }
+      captionLayout ??= "bottom";
       const imageLink = links.find(
         (link) => link.type === "image" || link.type === "IIIF"
       );
@@ -1762,23 +1748,17 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "image-quality"
       );
-      if (imageQuality === null) {
-        imageQuality = "high";
-      }
+      imageQuality ??= "high";
       let captionSource = getPropertyValueByLabel(
         componentProperty.properties,
         "caption-source"
       );
-      if (captionSource === null) {
-        captionSource = "name";
-      }
+      captionSource ??= "name";
       let altTextSource = getPropertyValueByLabel(
         componentProperty.properties,
         "alt-text-source"
       );
-      if (altTextSource === null) {
-        altTextSource = "name";
-      }
+      altTextSource ??= "name";
       properties.variant = variant;
       properties.image = {
         url: `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&preview`,
@@ -1815,9 +1795,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "chapters-displayed"
       );
-      if (isChaptersDislayed == null) {
-        isChaptersDislayed = "Yes";
-      }
+      isChaptersDislayed ??= "Yes";
       properties.videoId = videoLink.uuid;
       properties.isChaptersDislayed = isChaptersDislayed === "Yes";
       break;
@@ -2199,9 +2177,7 @@ function parseWebsiteProperties(properties) {
   let privacy = websiteProperties.find(
     (property) => property.label === "privacy"
   )?.values[0]?.content;
-  if (privacy == null) {
-    privacy = "public";
-  }
+  privacy ??= "public";
   const result = websiteSchema.safeParse({
     type,
     status,

package/dist/index.d.cts

@@ -115,6 +115,7 @@ type Link = {
     category: "resource" | "concept" | "set" | "tree" | "person" | "bibliography" | "epigraphicUnit" | null;
     identification: Identification | null;
     content: string | null;
+    href: string | null;
     image: {
         isInline: boolean;
         heightPreview: number;
@@ -507,6 +508,9 @@ type WebElementComponent = {
     component: "empty-space";
     height: string | null;
     width: string | null;
+} | {
+    component: "iframe";
+    url: string;
 } | {
     component: "iiif-viewer";
     IIIFId: string;
@@ -889,7 +893,7 @@ type OchreResource = {
   copyright?: FakeString;
   identification: OchreIdentification;
   href?: string;
-  description?: OchreStringContent;
+  description?: OchreStringContent | FakeString;
   date?: string; // YYYY-MM-DD
   image?: OchreImage;
   creators?: { creator: OchrePerson | Array<OchrePerson> };

package/dist/index.d.ts

@@ -115,6 +115,7 @@ type Link = {
     category: "resource" | "concept" | "set" | "tree" | "person" | "bibliography" | "epigraphicUnit" | null;
     identification: Identification | null;
     content: string | null;
+    href: string | null;
     image: {
         isInline: boolean;
         heightPreview: number;
@@ -507,6 +508,9 @@ type WebElementComponent = {
     component: "empty-space";
     height: string | null;
     width: string | null;
+} | {
+    component: "iframe";
+    url: string;
 } | {
     component: "iiif-viewer";
     IIIFId: string;
@@ -889,7 +893,7 @@ type OchreResource = {
   copyright?: FakeString;
   identification: OchreIdentification;
   href?: string;
-  description?: OchreStringContent;
+  description?: OchreStringContent | FakeString;
   date?: string; // YYYY-MM-DD
   image?: OchreImage;
   creators?: { creator: OchrePerson | Array<OchrePerson> };

package/dist/index.js

@@ -490,6 +490,7 @@ var componentSchema = z3.enum(
     "button",
     "collection",
     "empty-space",
+    "iframe",
     "iiif-viewer",
     "image",
     "image-gallery",
@@ -648,6 +649,7 @@ function parseLink(linkRaw) {
     const returnLink = {
       category: "resource" in linkRaw ? "resource" : "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,
       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,
       type: link.type ?? null,
       identification: link.identification ? parseIdentification(link.identification) : null,
@@ -1097,7 +1099,7 @@ function parseResource(resource, isNested = false) {
         Array.isArray(resource.notes.note) ? resource.notes.note : [resource.notes.note]
       ) : []
     ),
-    description: resource.description ? parseStringContent(resource.description) : "",
+    description: resource.description ? ["string", "number", "boolean"].includes(typeof resource.description) ? parseFakeString(resource.description) : parseStringContent(resource.description) : "",
     document: resource.document ? parseDocument(resource.document.content) : null,
     href: resource.href ?? null,
     imageMap: resource.imagemap ? parseImageMap(resource.imagemap) : null,
@@ -1331,9 +1333,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "layout"
       );
-      if (layout === null) {
-        layout = "long";
-      }
+      layout ??= "long";
       properties.bibliographies = bibliographyLink.bibliographies;
       properties.layout = layout;
       break;
@@ -1353,9 +1353,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "variant"
       );
-      if (variant === null) {
-        variant = "default";
-      }
+      variant ??= "default";
       let isExternal = false;
       let href = getPropertyValueByLabel(
         componentProperty.properties,
@@ -1386,16 +1384,12 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "variant"
       );
-      if (variant === null) {
-        variant = "full";
-      }
+      variant ??= "full";
       let layout = getPropertyValueByLabel(
         componentProperty.properties,
         "layout"
       );
-      if (layout === null) {
-        layout = "image-start";
-      }
+      layout ??= "image-start";
       const collectionLink = links.find((link) => link.category === "set");
       if (!collectionLink) {
         throw new Error(
@@ -1420,6 +1414,16 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.width = width;
       break;
     }
+    case "iframe": {
+      const url = links.find((link) => link.type === "webpage")?.href;
+      if (!url) {
+        throw new Error(
+          `URL not found for the following component: \u201C${componentName}\u201D`
+        );
+      }
+      properties.url = url;
+      break;
+    }
     case "iiif-viewer": {
       const manifestLink = links.find((link) => link.type === "IIIF");
       if (!manifestLink) {
@@ -1449,16 +1453,12 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "variant"
       );
-      if (variant === null) {
-        variant = "default";
-      }
+      variant ??= "default";
       let captionLayout = getPropertyValueByLabel(
         componentProperty.properties,
         "layout-caption"
       );
-      if (captionLayout === null) {
-        captionLayout = "bottom";
-      }
+      captionLayout ??= "bottom";
       let width = null;
       const widthProperty = getPropertyValueByLabel(
         componentProperty.properties,
@@ -1495,23 +1495,17 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "image-quality"
       );
-      if (imageQuality === null) {
-        imageQuality = "high";
-      }
+      imageQuality ??= "high";
       let captionSource = getPropertyValueByLabel(
         componentProperty.properties,
         "caption-source"
       );
-      if (captionSource === null) {
-        captionSource = "name";
-      }
+      captionSource ??= "name";
       let altTextSource = getPropertyValueByLabel(
         componentProperty.properties,
         "alt-text-source"
       );
-      if (altTextSource === null) {
-        altTextSource = "name";
-      }
+      altTextSource ??= "name";
       let isTransparentBackground = false;
       const isTransparentBackgroundProperty = getPropertyValueByLabel(
         componentProperty.properties,
@@ -1632,9 +1626,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "variant"
       );
-      if (variant === null) {
-        variant = "block";
-      }
+      variant ??= "block";
       const heading = getPropertyValueByLabel(
         componentProperty.properties,
         "heading"
@@ -1654,23 +1646,17 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "variant"
       );
-      if (variant === null) {
-        variant = "block";
-      }
+      variant ??= "block";
       let layout = getPropertyValueByLabel(
         componentProperty.properties,
         "layout"
       );
-      if (layout === null) {
-        layout = "image-start";
-      }
+      layout ??= "image-start";
       let captionLayout = getPropertyValueByLabel(
         componentProperty.properties,
         "layout-caption"
       );
-      if (captionLayout === null) {
-        captionLayout = "bottom";
-      }
+      captionLayout ??= "bottom";
       const imageLink = links.find(
         (link) => link.type === "image" || link.type === "IIIF"
       );
@@ -1685,23 +1671,17 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "image-quality"
       );
-      if (imageQuality === null) {
-        imageQuality = "high";
-      }
+      imageQuality ??= "high";
       let captionSource = getPropertyValueByLabel(
         componentProperty.properties,
         "caption-source"
       );
-      if (captionSource === null) {
-        captionSource = "name";
-      }
+      captionSource ??= "name";
       let altTextSource = getPropertyValueByLabel(
         componentProperty.properties,
         "alt-text-source"
       );
-      if (altTextSource === null) {
-        altTextSource = "name";
-      }
+      altTextSource ??= "name";
       properties.variant = variant;
       properties.image = {
         url: `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&preview`,
@@ -1738,9 +1718,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
         componentProperty.properties,
         "chapters-displayed"
       );
-      if (isChaptersDislayed == null) {
-        isChaptersDislayed = "Yes";
-      }
+      isChaptersDislayed ??= "Yes";
       properties.videoId = videoLink.uuid;
       properties.isChaptersDislayed = isChaptersDislayed === "Yes";
       break;
@@ -2122,9 +2100,7 @@ function parseWebsiteProperties(properties) {
   let privacy = websiteProperties.find(
     (property) => property.label === "privacy"
   )?.values[0]?.content;
-  if (privacy == null) {
-    privacy = "public";
-  }
+  privacy ??= "public";
   const result = websiteSchema.safeParse({
     type,
     status,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -41,16 +41,15 @@
   ],
   "dependencies": {
     "iso-639-3": "^3.0.1",
-    "uuid": "^11.1.0",
     "zod": "^3.24.2"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^4.10.1",
+    "@antfu/eslint-config": "^4.11.0",
     "@arethetypeswrong/cli": "^0.17.4",
     "@changesets/cli": "^2.28.1",
     "@total-typescript/ts-reset": "^0.6.1",
-    "@types/node": "^22.13.10",
-    "eslint": "^9.22.0",
+    "@types/node": "^22.13.14",
+    "eslint": "^9.23.0",
     "eslint-plugin-unused-imports": "^4.1.4",
     "prettier": "^3.5.3",
     "tsup": "^8.4.0",