@digitalculture/ochre-sdk 0.4.15 → 0.5.0

package/README.md

@@ -25,7 +25,7 @@ bun add @digitalculture/ochre-sdk
 From the root directory of the project, run the following command:
 
 ```bash
-pnpm run dev:ochre-sdk
+pnpm run dev
 ```
 
 ## Build production server

package/dist/index.cjs

@@ -76,7 +76,6 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/utils/parse.ts
-var import_uuid = require("uuid");
 var import_zod3 = require("zod");
 
 // src/utils/fetchers/generic.ts
@@ -1307,10 +1306,7 @@ var parseWebpageResources = async (webpageResources, type) => {
     if (!resourceProperty) continue;
     switch (type) {
       case "element": {
-        const element = await parseWebElement(
-          resource,
-          resourceProperty.properties
-        );
+        const element = await parseWebElement(resource);
         returnElements.push(
           element
         );
@@ -1837,9 +1833,20 @@ async function parseWebElementProperties(componentProperty, elementResource) {
   }
   return properties;
 }
-async function parseWebElement(elementResource, elementProperties) {
+async function parseWebElement(elementResource) {
   const identification = parseIdentification(elementResource.identification);
-  const componentProperty = elementProperties.find(
+  const elementProperties = elementResource.properties?.property ? parseProperties(
+    Array.isArray(elementResource.properties.property) ? elementResource.properties.property : [elementResource.properties.property]
+  ) : [];
+  const presentationProperty = elementProperties.find(
+    (property) => property.label === "presentation"
+  );
+  if (!presentationProperty) {
+    throw new Error(
+      `Presentation property not found for element \u201C${identification.label}\u201D`
+    );
+  }
+  const componentProperty = presentationProperty.properties.find(
     (property) => property.label === "component"
   );
   if (!componentProperty) {
@@ -1903,6 +1910,7 @@ async function parseWebElement(elementResource, elementProperties) {
   }
   return {
     uuid: elementResource.uuid,
+    type: "element",
     title: {
       label: identification.label,
       variant,
@@ -1937,8 +1945,7 @@ async function parseWebpage(webpageResource) {
     (link) => link.type === "image" || link.type === "IIIF"
   );
   const webpageResources = webpageResource.resource ? Array.isArray(webpageResource.resource) ? webpageResource.resource : [webpageResource.resource] : [];
-  const blocks = [];
-  let elementsToHandle = [];
+  const items = [];
   for (const resource of webpageResources) {
     const resourceProperties = resource.properties ? parseProperties(
       Array.isArray(resource.properties.property) ? resource.properties.property : [resource.properties.property]
@@ -1950,55 +1957,21 @@ async function parseWebpage(webpageResource) {
     if (!resourceType) {
       continue;
     }
-    if (resourceType === "element") {
-      elementsToHandle.push(resource);
-    } else if (resourceType === "block") {
-      if (elementsToHandle.length > 0) {
-        const elements = await parseWebpageResources(
-          elementsToHandle,
-          "element"
-        );
-        const block = {
-          uuid: (0, import_uuid.v4)(),
-          layout: "vertical",
-          blocks: [],
-          elements,
-          properties: {
-            spacing: void 0,
-            gap: void 0,
-            alignItems: "start",
-            justifyContent: "stretch"
-          },
-          propertiesMobile: null,
-          cssStyles: [],
-          cssStylesMobile: []
-        };
-        blocks.push(block);
-        elementsToHandle = [];
+    switch (resourceType) {
+      case "element": {
+        const element = await parseWebElement(resource);
+        items.push(element);
+        break;
+      }
+      case "block": {
+        const block = await parseBlock(resource);
+        if (block) {
+          items.push(block);
+        }
+        break;
       }
-      const parsedBlocks = await parseWebpageResources([resource], "block");
-      blocks.push(...parsedBlocks);
     }
   }
-  if (elementsToHandle.length > 0) {
-    const elements = await parseWebpageResources(elementsToHandle, "element");
-    const block = {
-      uuid: (0, import_uuid.v4)(),
-      layout: "vertical",
-      blocks: [],
-      elements,
-      properties: {
-        spacing: void 0,
-        gap: void 0,
-        alignItems: "start",
-        justifyContent: "stretch"
-      },
-      propertiesMobile: null,
-      cssStyles: [],
-      cssStylesMobile: []
-    };
-    blocks.push(block);
-  }
   const webpages = webpageResource.resource ? await parseWebpageResources(
     Array.isArray(webpageResource.resource) ? webpageResource.resource : [webpageResource.resource],
     "page"
@@ -2063,7 +2036,7 @@ async function parseWebpage(webpageResource) {
   return {
     title: identification.label,
     slug,
-    blocks,
+    items,
     properties: {
       displayedInHeader,
       width,
@@ -2090,9 +2063,9 @@ async function parseWebpages(webpageResources) {
 async function parseBlock(blockResource) {
   const returnBlock = {
     uuid: blockResource.uuid,
+    type: "block",
     layout: "vertical",
-    blocks: [],
-    elements: [],
+    items: [],
     properties: {
       spacing: void 0,
       gap: void 0,
@@ -2152,20 +2125,35 @@ async function parseBlock(blockResource) {
       returnBlock.propertiesMobile = propertiesMobile;
     }
   }
-  const blockBlocks = blockResource.resource ? await parseWebpageResources(
-    Array.isArray(blockResource.resource) ? blockResource.resource : [blockResource.resource],
-    "block"
-  ) : [];
-  for (const block of blockBlocks) {
-    returnBlock.blocks.push(block);
-  }
-  const blockElements = blockResource.resource ? await parseWebpageResources(
-    Array.isArray(blockResource.resource) ? blockResource.resource : [blockResource.resource],
-    "element"
-  ) : [];
-  for (const element of blockElements) {
-    returnBlock.elements.push(element);
+  const blockResources = blockResource.resource ? Array.isArray(blockResource.resource) ? blockResource.resource : [blockResource.resource] : [];
+  const blockItems = [];
+  for (const resource of blockResources) {
+    const resourceProperties = resource.properties ? parseProperties(
+      Array.isArray(resource.properties.property) ? resource.properties.property : [resource.properties.property]
+    ) : [];
+    const resourceType = getPropertyValueByLabel(
+      resourceProperties,
+      "presentation"
+    );
+    if (!resourceType) {
+      continue;
+    }
+    switch (resourceType) {
+      case "element": {
+        const element = await parseWebElement(resource);
+        blockItems.push(element);
+        break;
+      }
+      case "block": {
+        const block = await parseBlock(resource);
+        if (block) {
+          blockItems.push(block);
+        }
+        break;
+      }
+    }
   }
+  returnBlock.items = blockItems;
   const blockCssStyles = blockProperties.find(
     (property) => property.label === "presentation" && property.values[0]?.content === "css"
   )?.properties;
@@ -2399,15 +2387,7 @@ async function parseWebsite(websiteTree, projectName, website) {
     }
     const sidebarResources = sidebarResource.resource ? Array.isArray(sidebarResource.resource) ? sidebarResource.resource : [sidebarResource.resource] : [];
     for (const resource of sidebarResources) {
-      const sidebarResourceProperties = resource.properties ? parseProperties(
-        Array.isArray(resource.properties.property) ? resource.properties.property : [resource.properties.property]
-      ) : [];
-      const element = await parseWebElement(
-        resource,
-        sidebarResourceProperties.find(
-          (property) => property.label === "presentation" && property.values[0]?.content === "element"
-        )?.properties ?? []
-      );
+      const element = await parseWebElement(resource);
       sidebarElements.push(element);
     }
   }

package/dist/index.d.cts

@@ -440,7 +440,7 @@ type Webpage = {
     title: string;
     slug: string;
     properties: WebpageProperties;
-    blocks: Array<WebBlock>;
+    items: Array<WebElement | WebBlock>;
     webpages: Array<Webpage>;
 };
 /**
@@ -460,6 +460,7 @@ type WebpageProperties = {
  */
 type WebElement = {
     uuid: string;
+    type: "element";
     title: {
         label: string;
         variant: "default" | "simple";
@@ -588,9 +589,9 @@ type Style = {
  */
 type WebBlock = {
     uuid: string;
+    type: "block";
     layout: "vertical" | "horizontal" | "grid";
-    blocks: Array<WebBlock>;
-    elements: Array<WebElement>;
+    items: Array<WebElement | WebBlock>;
     properties: {
         /**
          * valid `gridTemplateColumns` or `gridTemplateRows` CSS property value

package/dist/index.d.ts

@@ -440,7 +440,7 @@ type Webpage = {
     title: string;
     slug: string;
     properties: WebpageProperties;
-    blocks: Array<WebBlock>;
+    items: Array<WebElement | WebBlock>;
     webpages: Array<Webpage>;
 };
 /**
@@ -460,6 +460,7 @@ type WebpageProperties = {
  */
 type WebElement = {
     uuid: string;
+    type: "element";
     title: {
         label: string;
         variant: "default" | "simple";
@@ -588,9 +589,9 @@ type Style = {
  */
 type WebBlock = {
     uuid: string;
+    type: "block";
     layout: "vertical" | "horizontal" | "grid";
-    blocks: Array<WebBlock>;
-    elements: Array<WebElement>;
+    items: Array<WebElement | WebBlock>;
     properties: {
         /**
          * valid `gridTemplateColumns` or `gridTemplateRows` CSS property value

package/dist/index.js

@@ -1,5 +1,4 @@
 // src/utils/parse.ts
-import { v4 as uuidv4 } from "uuid";
 import { z as z3 } from "zod";
 
 // src/utils/fetchers/generic.ts
@@ -1230,10 +1229,7 @@ var parseWebpageResources = async (webpageResources, type) => {
     if (!resourceProperty) continue;
     switch (type) {
       case "element": {
-        const element = await parseWebElement(
-          resource,
-          resourceProperty.properties
-        );
+        const element = await parseWebElement(resource);
         returnElements.push(
           element
         );
@@ -1760,9 +1756,20 @@ async function parseWebElementProperties(componentProperty, elementResource) {
   }
   return properties;
 }
-async function parseWebElement(elementResource, elementProperties) {
+async function parseWebElement(elementResource) {
   const identification = parseIdentification(elementResource.identification);
-  const componentProperty = elementProperties.find(
+  const elementProperties = elementResource.properties?.property ? parseProperties(
+    Array.isArray(elementResource.properties.property) ? elementResource.properties.property : [elementResource.properties.property]
+  ) : [];
+  const presentationProperty = elementProperties.find(
+    (property) => property.label === "presentation"
+  );
+  if (!presentationProperty) {
+    throw new Error(
+      `Presentation property not found for element \u201C${identification.label}\u201D`
+    );
+  }
+  const componentProperty = presentationProperty.properties.find(
     (property) => property.label === "component"
   );
   if (!componentProperty) {
@@ -1826,6 +1833,7 @@ async function parseWebElement(elementResource, elementProperties) {
   }
   return {
     uuid: elementResource.uuid,
+    type: "element",
     title: {
       label: identification.label,
       variant,
@@ -1860,8 +1868,7 @@ async function parseWebpage(webpageResource) {
     (link) => link.type === "image" || link.type === "IIIF"
   );
   const webpageResources = webpageResource.resource ? Array.isArray(webpageResource.resource) ? webpageResource.resource : [webpageResource.resource] : [];
-  const blocks = [];
-  let elementsToHandle = [];
+  const items = [];
   for (const resource of webpageResources) {
     const resourceProperties = resource.properties ? parseProperties(
       Array.isArray(resource.properties.property) ? resource.properties.property : [resource.properties.property]
@@ -1873,55 +1880,21 @@ async function parseWebpage(webpageResource) {
     if (!resourceType) {
       continue;
     }
-    if (resourceType === "element") {
-      elementsToHandle.push(resource);
-    } else if (resourceType === "block") {
-      if (elementsToHandle.length > 0) {
-        const elements = await parseWebpageResources(
-          elementsToHandle,
-          "element"
-        );
-        const block = {
-          uuid: uuidv4(),
-          layout: "vertical",
-          blocks: [],
-          elements,
-          properties: {
-            spacing: void 0,
-            gap: void 0,
-            alignItems: "start",
-            justifyContent: "stretch"
-          },
-          propertiesMobile: null,
-          cssStyles: [],
-          cssStylesMobile: []
-        };
-        blocks.push(block);
-        elementsToHandle = [];
+    switch (resourceType) {
+      case "element": {
+        const element = await parseWebElement(resource);
+        items.push(element);
+        break;
+      }
+      case "block": {
+        const block = await parseBlock(resource);
+        if (block) {
+          items.push(block);
+        }
+        break;
       }
-      const parsedBlocks = await parseWebpageResources([resource], "block");
-      blocks.push(...parsedBlocks);
     }
   }
-  if (elementsToHandle.length > 0) {
-    const elements = await parseWebpageResources(elementsToHandle, "element");
-    const block = {
-      uuid: uuidv4(),
-      layout: "vertical",
-      blocks: [],
-      elements,
-      properties: {
-        spacing: void 0,
-        gap: void 0,
-        alignItems: "start",
-        justifyContent: "stretch"
-      },
-      propertiesMobile: null,
-      cssStyles: [],
-      cssStylesMobile: []
-    };
-    blocks.push(block);
-  }
   const webpages = webpageResource.resource ? await parseWebpageResources(
     Array.isArray(webpageResource.resource) ? webpageResource.resource : [webpageResource.resource],
     "page"
@@ -1986,7 +1959,7 @@ async function parseWebpage(webpageResource) {
   return {
     title: identification.label,
     slug,
-    blocks,
+    items,
     properties: {
       displayedInHeader,
       width,
@@ -2013,9 +1986,9 @@ async function parseWebpages(webpageResources) {
 async function parseBlock(blockResource) {
   const returnBlock = {
     uuid: blockResource.uuid,
+    type: "block",
     layout: "vertical",
-    blocks: [],
-    elements: [],
+    items: [],
     properties: {
       spacing: void 0,
       gap: void 0,
@@ -2075,20 +2048,35 @@ async function parseBlock(blockResource) {
       returnBlock.propertiesMobile = propertiesMobile;
     }
   }
-  const blockBlocks = blockResource.resource ? await parseWebpageResources(
-    Array.isArray(blockResource.resource) ? blockResource.resource : [blockResource.resource],
-    "block"
-  ) : [];
-  for (const block of blockBlocks) {
-    returnBlock.blocks.push(block);
-  }
-  const blockElements = blockResource.resource ? await parseWebpageResources(
-    Array.isArray(blockResource.resource) ? blockResource.resource : [blockResource.resource],
-    "element"
-  ) : [];
-  for (const element of blockElements) {
-    returnBlock.elements.push(element);
+  const blockResources = blockResource.resource ? Array.isArray(blockResource.resource) ? blockResource.resource : [blockResource.resource] : [];
+  const blockItems = [];
+  for (const resource of blockResources) {
+    const resourceProperties = resource.properties ? parseProperties(
+      Array.isArray(resource.properties.property) ? resource.properties.property : [resource.properties.property]
+    ) : [];
+    const resourceType = getPropertyValueByLabel(
+      resourceProperties,
+      "presentation"
+    );
+    if (!resourceType) {
+      continue;
+    }
+    switch (resourceType) {
+      case "element": {
+        const element = await parseWebElement(resource);
+        blockItems.push(element);
+        break;
+      }
+      case "block": {
+        const block = await parseBlock(resource);
+        if (block) {
+          blockItems.push(block);
+        }
+        break;
+      }
+    }
   }
+  returnBlock.items = blockItems;
   const blockCssStyles = blockProperties.find(
     (property) => property.label === "presentation" && property.values[0]?.content === "css"
   )?.properties;
@@ -2322,15 +2310,7 @@ async function parseWebsite(websiteTree, projectName, website) {
     }
     const sidebarResources = sidebarResource.resource ? Array.isArray(sidebarResource.resource) ? sidebarResource.resource : [sidebarResource.resource] : [];
     for (const resource of sidebarResources) {
-      const sidebarResourceProperties = resource.properties ? parseProperties(
-        Array.isArray(resource.properties.property) ? resource.properties.property : [resource.properties.property]
-      ) : [];
-      const element = await parseWebElement(
-        resource,
-        sidebarResourceProperties.find(
-          (property) => property.label === "presentation" && property.values[0]?.content === "element"
-        )?.properties ?? []
-      );
+      const element = await parseWebElement(resource);
       sidebarElements.push(element);
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.4.15",
+  "version": "0.5.0",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -45,17 +45,17 @@
     "zod": "^3.24.2"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^4.3.0",
+    "@antfu/eslint-config": "^4.10.1",
     "@arethetypeswrong/cli": "^0.17.4",
     "@changesets/cli": "^2.28.1",
     "@total-typescript/ts-reset": "^0.6.1",
-    "@types/node": "^22.13.5",
-    "eslint": "^9.21.0",
+    "@types/node": "^22.13.10",
+    "eslint": "^9.22.0",
     "eslint-plugin-unused-imports": "^4.1.4",
-    "prettier": "^3.5.2",
+    "prettier": "^3.5.3",
     "tsup": "^8.4.0",
-    "typescript": "^5.7.3",
-    "vitest": "^3.0.7"
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
   },
   "scripts": {
     "dev": "tsup src/index.ts --watch",