@digitalculture/ochre-sdk 0.2.12 → 0.3.0

package/dist/index.cjs

@@ -2065,8 +2065,20 @@ async function parseWebsite(websiteTree, projectName, website) {
   }
   const resources = Array.isArray(websiteTree.items.resource) ? websiteTree.items.resource : [websiteTree.items.resource];
   const pages = await parseWebpages(resources);
+  let sidebar = null;
   const sidebarElements = [];
-  const sidebar = resources.find((resource) => {
+  const sidebarTitle = {
+    label: "title",
+    variant: "default",
+    properties: {
+      isNameDisplayed: false,
+      isDescriptionDisplayed: false,
+      isDateDisplayed: false,
+      isCreatorsDisplayed: false
+    }
+  };
+  const sidebarCssStyles = [];
+  const sidebarResource = resources.find((resource) => {
     const resourceProperties = resource.properties ? parseProperties(
       Array.isArray(resource.properties.property) ? resource.properties.property : [resource.properties.property]
     ) : [];
@@ -2074,8 +2086,8 @@ async function parseWebsite(websiteTree, projectName, website) {
       (property) => property.label === "presentation" && property.values[0]?.content === "element" && property.properties[0]?.label === "component" && property.properties[0]?.values[0]?.content === "sidebar"
     );
   });
-  if (sidebar) {
-    const sidebarResources = sidebar.resource ? Array.isArray(sidebar.resource) ? sidebar.resource : [sidebar.resource] : [];
+  if (sidebarResource) {
+    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]
@@ -2087,8 +2099,51 @@ async function parseWebsite(websiteTree, projectName, website) {
         )?.properties ?? []
       );
       sidebarElements.push(element);
+      const cssProperties = sidebarResourceProperties.find(
+        (property) => property.label === "presentation" && property.values[0].content === "css"
+      )?.properties ?? [];
+      for (const property of cssProperties) {
+        const cssStyle = property.values[0].content;
+        sidebarCssStyles.push({ label: property.label, value: cssStyle });
+      }
+      const titleProperties = sidebarResourceProperties.find(
+        (property) => property.label === "title"
+      )?.properties;
+      if (titleProperties) {
+        const titleVariant = getPropertyValueByLabel(
+          titleProperties,
+          "variant"
+        );
+        if (titleVariant) {
+          sidebarTitle.variant = titleVariant;
+        }
+        const titleShow = titleProperties.filter(
+          (property) => property.label === "display"
+        );
+        if (titleShow.length > 0) {
+          sidebarTitle.properties.isNameDisplayed = titleShow.some(
+            (property) => property.values[0].content === "name"
+          );
+          sidebarTitle.properties.isDescriptionDisplayed = titleShow.some(
+            (property) => property.values[0].content === "description"
+          );
+          sidebarTitle.properties.isDateDisplayed = titleShow.some(
+            (property) => property.values[0].content === "date"
+          );
+          sidebarTitle.properties.isCreatorsDisplayed = titleShow.some(
+            (property) => property.values[0].content === "creators"
+          );
+        }
+      }
     }
   }
+  if (sidebarElements.length > 0) {
+    sidebar = {
+      elements: sidebarElements,
+      title: sidebarTitle,
+      cssStyles: sidebarCssStyles
+    };
+  }
   return {
     uuid: websiteTree.uuid,
     publicationDateTime: websiteTree.publicationDateTime ? new Date(websiteTree.publicationDateTime) : null,
@@ -2102,7 +2157,7 @@ async function parseWebsite(websiteTree, projectName, website) {
     ) : [],
     license: parseLicense(websiteTree.availability),
     pages,
-    sidebarElements,
+    sidebar,
     properties
   };
 }

package/dist/index.d.cts

@@ -409,7 +409,11 @@ type Website = {
     creators: Array<Person>;
     license: License | null;
     pages: Array<Webpage>;
-    sidebarElements: Array<WebElement>;
+    sidebar: {
+        elements: Array<WebElement>;
+        title: WebElement["title"];
+        cssStyles: Array<Style>;
+    } | null;
     properties: WebsiteProperties;
 };
 /**

package/dist/index.d.ts

@@ -409,7 +409,11 @@ type Website = {
     creators: Array<Person>;
     license: License | null;
     pages: Array<Webpage>;
-    sidebarElements: Array<WebElement>;
+    sidebar: {
+        elements: Array<WebElement>;
+        title: WebElement["title"];
+        cssStyles: Array<Style>;
+    } | null;
     properties: WebsiteProperties;
 };
 /**

package/dist/index.js

@@ -1987,8 +1987,20 @@ async function parseWebsite(websiteTree, projectName, website) {
   }
   const resources = Array.isArray(websiteTree.items.resource) ? websiteTree.items.resource : [websiteTree.items.resource];
   const pages = await parseWebpages(resources);
+  let sidebar = null;
   const sidebarElements = [];
-  const sidebar = resources.find((resource) => {
+  const sidebarTitle = {
+    label: "title",
+    variant: "default",
+    properties: {
+      isNameDisplayed: false,
+      isDescriptionDisplayed: false,
+      isDateDisplayed: false,
+      isCreatorsDisplayed: false
+    }
+  };
+  const sidebarCssStyles = [];
+  const sidebarResource = resources.find((resource) => {
     const resourceProperties = resource.properties ? parseProperties(
       Array.isArray(resource.properties.property) ? resource.properties.property : [resource.properties.property]
     ) : [];
@@ -1996,8 +2008,8 @@ async function parseWebsite(websiteTree, projectName, website) {
       (property) => property.label === "presentation" && property.values[0]?.content === "element" && property.properties[0]?.label === "component" && property.properties[0]?.values[0]?.content === "sidebar"
     );
   });
-  if (sidebar) {
-    const sidebarResources = sidebar.resource ? Array.isArray(sidebar.resource) ? sidebar.resource : [sidebar.resource] : [];
+  if (sidebarResource) {
+    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]
@@ -2009,8 +2021,51 @@ async function parseWebsite(websiteTree, projectName, website) {
         )?.properties ?? []
       );
       sidebarElements.push(element);
+      const cssProperties = sidebarResourceProperties.find(
+        (property) => property.label === "presentation" && property.values[0].content === "css"
+      )?.properties ?? [];
+      for (const property of cssProperties) {
+        const cssStyle = property.values[0].content;
+        sidebarCssStyles.push({ label: property.label, value: cssStyle });
+      }
+      const titleProperties = sidebarResourceProperties.find(
+        (property) => property.label === "title"
+      )?.properties;
+      if (titleProperties) {
+        const titleVariant = getPropertyValueByLabel(
+          titleProperties,
+          "variant"
+        );
+        if (titleVariant) {
+          sidebarTitle.variant = titleVariant;
+        }
+        const titleShow = titleProperties.filter(
+          (property) => property.label === "display"
+        );
+        if (titleShow.length > 0) {
+          sidebarTitle.properties.isNameDisplayed = titleShow.some(
+            (property) => property.values[0].content === "name"
+          );
+          sidebarTitle.properties.isDescriptionDisplayed = titleShow.some(
+            (property) => property.values[0].content === "description"
+          );
+          sidebarTitle.properties.isDateDisplayed = titleShow.some(
+            (property) => property.values[0].content === "date"
+          );
+          sidebarTitle.properties.isCreatorsDisplayed = titleShow.some(
+            (property) => property.values[0].content === "creators"
+          );
+        }
+      }
     }
   }
+  if (sidebarElements.length > 0) {
+    sidebar = {
+      elements: sidebarElements,
+      title: sidebarTitle,
+      cssStyles: sidebarCssStyles
+    };
+  }
   return {
     uuid: websiteTree.uuid,
     publicationDateTime: websiteTree.publicationDateTime ? new Date(websiteTree.publicationDateTime) : null,
@@ -2024,7 +2079,7 @@ async function parseWebsite(websiteTree, projectName, website) {
     ) : [],
     license: parseLicense(websiteTree.availability),
     pages,
-    sidebarElements,
+    sidebar,
     properties
   };
 }

package/package.json

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