@digitalculture/ochre-sdk 0.4.11 → 0.4.12

package/dist/index.cjs

@@ -1882,6 +1882,14 @@ async function parseWebElement(elementResource, elementProperties) {
     const cssStyle = property.values[0].content;
     cssStyles.push({ label: property.label, value: cssStyle });
   }
+  const mobileCssProperties = elementResourceProperties.find(
+    (property) => property.label === "presentation" && property.values[0].content === "css-mobile"
+  )?.properties ?? [];
+  const cssStylesMobile = [];
+  for (const property of mobileCssProperties) {
+    const cssStyle = property.values[0].content;
+    cssStylesMobile.push({ label: property.label, value: cssStyle });
+  }
   const titleProperties = elementResourceProperties.find(
     (property) => property.label === "presentation" && property.values[0].content === "title"
   )?.properties;
@@ -1926,6 +1934,7 @@ async function parseWebElement(elementResource, elementProperties) {
       }
     },
     cssStyles,
+    cssStylesMobile,
     ...properties
   };
 }
@@ -1975,12 +1984,14 @@ async function parseWebpage(webpageResource) {
           blocks: [],
           elements,
           properties: {
-            spacing: null,
-            gap: "none",
+            spacing: void 0,
+            gap: void 0,
             alignItems: "start",
             justifyContent: "stretch"
           },
-          cssStyles: []
+          propertiesMobile: null,
+          cssStyles: [],
+          cssStylesMobile: []
         };
         blocks.push(block);
         elementsToHandle = [];
@@ -1997,12 +2008,14 @@ async function parseWebpage(webpageResource) {
       blocks: [],
       elements,
       properties: {
-        spacing: null,
-        gap: "none",
+        spacing: void 0,
+        gap: void 0,
         alignItems: "start",
         justifyContent: "stretch"
       },
-      cssStyles: []
+      propertiesMobile: null,
+      cssStyles: [],
+      cssStylesMobile: []
     };
     blocks.push(block);
   }
@@ -2055,6 +2068,18 @@ async function parseWebpage(webpageResource) {
       });
     }
   }
+  const mobileCssStyleSubProperties = webpageProperties.find(
+    (property) => property.label === "presentation" && property.values[0]?.content === "css-mobile"
+  )?.properties;
+  const cssStylesMobile = [];
+  if (mobileCssStyleSubProperties) {
+    for (const property of mobileCssStyleSubProperties) {
+      cssStylesMobile.push({
+        label: property.label,
+        value: property.values[0].content
+      });
+    }
+  }
   return {
     title: identification.label,
     slug,
@@ -2065,7 +2090,8 @@ async function parseWebpage(webpageResource) {
       variant,
       backgroundImageUrl: imageLink ? `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&load` : null,
       isSidebarDisplayed,
-      cssStyles
+      cssStyles,
+      cssStylesMobile
     },
     webpages
   };
@@ -2088,12 +2114,14 @@ async function parseBlock(blockResource) {
     blocks: [],
     elements: [],
     properties: {
-      spacing: null,
-      gap: "none",
+      spacing: void 0,
+      gap: void 0,
       alignItems: "start",
       justifyContent: "stretch"
     },
-    cssStyles: []
+    propertiesMobile: null,
+    cssStyles: [],
+    cssStylesMobile: []
   };
   const blockProperties = blockResource.properties ? parseProperties(
     Array.isArray(blockResource.properties.property) ? blockResource.properties.property : [blockResource.properties.property]
@@ -2132,6 +2160,17 @@ async function parseBlock(blockResource) {
     if (justifyContentProperty) {
       returnBlock.properties.justifyContent = justifyContentProperty.content;
     }
+    const mobileOverwriteProperty = blockMainProperties.find(
+      (property) => property.label === "overwrite-mobile"
+    );
+    if (mobileOverwriteProperty) {
+      const mobileOverwriteProperties = mobileOverwriteProperty.properties;
+      const propertiesMobile = {};
+      for (const property of mobileOverwriteProperties) {
+        propertiesMobile[property.label] = property.values[0].content;
+      }
+      returnBlock.propertiesMobile = propertiesMobile;
+    }
   }
   const blockBlocks = blockResource.resource ? await parseWebpageResources(
     Array.isArray(blockResource.resource) ? blockResource.resource : [blockResource.resource],
@@ -2158,6 +2197,17 @@ async function parseBlock(blockResource) {
       });
     }
   }
+  const blockMobileCssStyles = blockProperties.find(
+    (property) => property.label === "presentation" && property.values[0]?.content === "css-mobile"
+  )?.properties;
+  if (blockMobileCssStyles) {
+    for (const property of blockMobileCssStyles) {
+      returnBlock.cssStylesMobile.push({
+        label: property.label,
+        value: property.values[0].content
+      });
+    }
+  }
   return returnBlock;
 }
 function parseWebsiteProperties(properties) {
@@ -2296,6 +2346,7 @@ async function parseWebsite(websiteTree, projectName, website) {
   let sidebarLayout = "start";
   let sidebarMobileLayout = "default";
   const sidebarCssStyles = [];
+  const sidebarCssStylesMobile = [];
   const sidebarResource = resources.find((resource) => {
     const resourceProperties = resource.properties ? parseProperties(
       Array.isArray(resource.properties.property) ? resource.properties.property : [resource.properties.property]
@@ -2333,6 +2384,13 @@ async function parseWebsite(websiteTree, projectName, website) {
       const cssStyle = property.values[0].content;
       sidebarCssStyles.push({ label: property.label, value: cssStyle });
     }
+    const mobileCssProperties = sidebarBaseProperties.find(
+      (property) => property.label === "presentation" && property.values[0].content === "css-mobile"
+    )?.properties ?? [];
+    for (const property of mobileCssProperties) {
+      const cssStyle = property.values[0].content;
+      sidebarCssStylesMobile.push({ label: property.label, value: cssStyle });
+    }
     const titleProperties = sidebarBaseProperties.find(
       (property) => property.label === "presentation" && property.values[0].content === "title"
     )?.properties;
@@ -2379,7 +2437,8 @@ async function parseWebsite(websiteTree, projectName, website) {
       title: sidebarTitle,
       layout: sidebarLayout,
       mobileLayout: sidebarMobileLayout,
-      cssStyles: sidebarCssStyles
+      cssStyles: sidebarCssStyles,
+      cssStylesMobile: sidebarCssStylesMobile
     };
   }
   return {

package/dist/index.d.cts

@@ -415,6 +415,7 @@ type Website = {
         layout: "start" | "end";
         mobileLayout: "default" | "inline";
         cssStyles: Array<Style>;
+        cssStylesMobile: Array<Style>;
     } | null;
     properties: WebsiteProperties;
 };
@@ -439,7 +440,7 @@ type Webpage = {
     title: string;
     slug: string;
     properties: WebpageProperties;
-    blocks: Array<Block>;
+    blocks: Array<WebBlock>;
     webpages: Array<Webpage>;
 };
 /**
@@ -452,6 +453,7 @@ type WebpageProperties = {
     backgroundImageUrl: string | null;
     isSidebarDisplayed: boolean;
     cssStyles: Array<Style>;
+    cssStylesMobile: Array<Style>;
 };
 /**
  * Base properties for web elements
@@ -469,6 +471,7 @@ type WebElement = {
         };
     };
     cssStyles: Array<Style>;
+    cssStylesMobile: Array<Style>;
 } & WebElementComponent;
 /**
  * Union type of all possible web element components
@@ -583,20 +586,20 @@ type Style = {
 /**
  * Represents a block of vertical or horizontal content alignment
  */
-type Block = {
+type WebBlock = {
     uuid: string;
     layout: "vertical" | "horizontal" | "grid";
-    blocks: Array<Block>;
+    blocks: Array<WebBlock>;
     elements: Array<WebElement>;
     properties: {
         /**
          * valid `gridTemplateColumns` or `gridTemplateRows` CSS property value
          */
-        spacing: string | null;
+        spacing: string | undefined;
         /**
          * `gap` CSS property value
          */
-        gap: "none" | "small" | "medium" | "large";
+        gap: string | undefined;
         /**
          * `align-items` CSS property value
          */
@@ -606,7 +609,9 @@ type Block = {
          */
         justifyContent: "stretch" | "start" | "center" | "end" | "space-between";
     };
+    propertiesMobile: Record<string, string> | null;
     cssStyles: Array<Style>;
+    cssStylesMobile: Array<Style>;
 };
 
 /**
@@ -1841,4 +1846,4 @@ declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnote
  */
 declare function parseStringContent(content: OchreStringContent, language?: string): string;
 
-export { type Bibliography, type Block, 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 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, parseEmailAndUrl, 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 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, parseEmailAndUrl, 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 };

package/dist/index.d.ts

@@ -415,6 +415,7 @@ type Website = {
         layout: "start" | "end";
         mobileLayout: "default" | "inline";
         cssStyles: Array<Style>;
+        cssStylesMobile: Array<Style>;
     } | null;
     properties: WebsiteProperties;
 };
@@ -439,7 +440,7 @@ type Webpage = {
     title: string;
     slug: string;
     properties: WebpageProperties;
-    blocks: Array<Block>;
+    blocks: Array<WebBlock>;
     webpages: Array<Webpage>;
 };
 /**
@@ -452,6 +453,7 @@ type WebpageProperties = {
     backgroundImageUrl: string | null;
     isSidebarDisplayed: boolean;
     cssStyles: Array<Style>;
+    cssStylesMobile: Array<Style>;
 };
 /**
  * Base properties for web elements
@@ -469,6 +471,7 @@ type WebElement = {
         };
     };
     cssStyles: Array<Style>;
+    cssStylesMobile: Array<Style>;
 } & WebElementComponent;
 /**
  * Union type of all possible web element components
@@ -583,20 +586,20 @@ type Style = {
 /**
  * Represents a block of vertical or horizontal content alignment
  */
-type Block = {
+type WebBlock = {
     uuid: string;
     layout: "vertical" | "horizontal" | "grid";
-    blocks: Array<Block>;
+    blocks: Array<WebBlock>;
     elements: Array<WebElement>;
     properties: {
         /**
          * valid `gridTemplateColumns` or `gridTemplateRows` CSS property value
          */
-        spacing: string | null;
+        spacing: string | undefined;
         /**
          * `gap` CSS property value
          */
-        gap: "none" | "small" | "medium" | "large";
+        gap: string | undefined;
         /**
          * `align-items` CSS property value
          */
@@ -606,7 +609,9 @@ type Block = {
          */
         justifyContent: "stretch" | "start" | "center" | "end" | "space-between";
     };
+    propertiesMobile: Record<string, string> | null;
     cssStyles: Array<Style>;
+    cssStylesMobile: Array<Style>;
 };
 
 /**
@@ -1841,4 +1846,4 @@ declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnote
  */
 declare function parseStringContent(content: OchreStringContent, language?: string): string;
 
-export { type Bibliography, type Block, 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 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, parseEmailAndUrl, 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 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, parseEmailAndUrl, 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 };

package/dist/index.js

@@ -1805,6 +1805,14 @@ async function parseWebElement(elementResource, elementProperties) {
     const cssStyle = property.values[0].content;
     cssStyles.push({ label: property.label, value: cssStyle });
   }
+  const mobileCssProperties = elementResourceProperties.find(
+    (property) => property.label === "presentation" && property.values[0].content === "css-mobile"
+  )?.properties ?? [];
+  const cssStylesMobile = [];
+  for (const property of mobileCssProperties) {
+    const cssStyle = property.values[0].content;
+    cssStylesMobile.push({ label: property.label, value: cssStyle });
+  }
   const titleProperties = elementResourceProperties.find(
     (property) => property.label === "presentation" && property.values[0].content === "title"
   )?.properties;
@@ -1849,6 +1857,7 @@ async function parseWebElement(elementResource, elementProperties) {
       }
     },
     cssStyles,
+    cssStylesMobile,
     ...properties
   };
 }
@@ -1898,12 +1907,14 @@ async function parseWebpage(webpageResource) {
           blocks: [],
           elements,
           properties: {
-            spacing: null,
-            gap: "none",
+            spacing: void 0,
+            gap: void 0,
             alignItems: "start",
             justifyContent: "stretch"
           },
-          cssStyles: []
+          propertiesMobile: null,
+          cssStyles: [],
+          cssStylesMobile: []
         };
         blocks.push(block);
         elementsToHandle = [];
@@ -1920,12 +1931,14 @@ async function parseWebpage(webpageResource) {
       blocks: [],
       elements,
       properties: {
-        spacing: null,
-        gap: "none",
+        spacing: void 0,
+        gap: void 0,
         alignItems: "start",
         justifyContent: "stretch"
       },
-      cssStyles: []
+      propertiesMobile: null,
+      cssStyles: [],
+      cssStylesMobile: []
     };
     blocks.push(block);
   }
@@ -1978,6 +1991,18 @@ async function parseWebpage(webpageResource) {
       });
     }
   }
+  const mobileCssStyleSubProperties = webpageProperties.find(
+    (property) => property.label === "presentation" && property.values[0]?.content === "css-mobile"
+  )?.properties;
+  const cssStylesMobile = [];
+  if (mobileCssStyleSubProperties) {
+    for (const property of mobileCssStyleSubProperties) {
+      cssStylesMobile.push({
+        label: property.label,
+        value: property.values[0].content
+      });
+    }
+  }
   return {
     title: identification.label,
     slug,
@@ -1988,7 +2013,8 @@ async function parseWebpage(webpageResource) {
       variant,
       backgroundImageUrl: imageLink ? `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&load` : null,
       isSidebarDisplayed,
-      cssStyles
+      cssStyles,
+      cssStylesMobile
     },
     webpages
   };
@@ -2011,12 +2037,14 @@ async function parseBlock(blockResource) {
     blocks: [],
     elements: [],
     properties: {
-      spacing: null,
-      gap: "none",
+      spacing: void 0,
+      gap: void 0,
       alignItems: "start",
       justifyContent: "stretch"
     },
-    cssStyles: []
+    propertiesMobile: null,
+    cssStyles: [],
+    cssStylesMobile: []
   };
   const blockProperties = blockResource.properties ? parseProperties(
     Array.isArray(blockResource.properties.property) ? blockResource.properties.property : [blockResource.properties.property]
@@ -2055,6 +2083,17 @@ async function parseBlock(blockResource) {
     if (justifyContentProperty) {
       returnBlock.properties.justifyContent = justifyContentProperty.content;
     }
+    const mobileOverwriteProperty = blockMainProperties.find(
+      (property) => property.label === "overwrite-mobile"
+    );
+    if (mobileOverwriteProperty) {
+      const mobileOverwriteProperties = mobileOverwriteProperty.properties;
+      const propertiesMobile = {};
+      for (const property of mobileOverwriteProperties) {
+        propertiesMobile[property.label] = property.values[0].content;
+      }
+      returnBlock.propertiesMobile = propertiesMobile;
+    }
   }
   const blockBlocks = blockResource.resource ? await parseWebpageResources(
     Array.isArray(blockResource.resource) ? blockResource.resource : [blockResource.resource],
@@ -2081,6 +2120,17 @@ async function parseBlock(blockResource) {
       });
     }
   }
+  const blockMobileCssStyles = blockProperties.find(
+    (property) => property.label === "presentation" && property.values[0]?.content === "css-mobile"
+  )?.properties;
+  if (blockMobileCssStyles) {
+    for (const property of blockMobileCssStyles) {
+      returnBlock.cssStylesMobile.push({
+        label: property.label,
+        value: property.values[0].content
+      });
+    }
+  }
   return returnBlock;
 }
 function parseWebsiteProperties(properties) {
@@ -2219,6 +2269,7 @@ async function parseWebsite(websiteTree, projectName, website) {
   let sidebarLayout = "start";
   let sidebarMobileLayout = "default";
   const sidebarCssStyles = [];
+  const sidebarCssStylesMobile = [];
   const sidebarResource = resources.find((resource) => {
     const resourceProperties = resource.properties ? parseProperties(
       Array.isArray(resource.properties.property) ? resource.properties.property : [resource.properties.property]
@@ -2256,6 +2307,13 @@ async function parseWebsite(websiteTree, projectName, website) {
       const cssStyle = property.values[0].content;
       sidebarCssStyles.push({ label: property.label, value: cssStyle });
     }
+    const mobileCssProperties = sidebarBaseProperties.find(
+      (property) => property.label === "presentation" && property.values[0].content === "css-mobile"
+    )?.properties ?? [];
+    for (const property of mobileCssProperties) {
+      const cssStyle = property.values[0].content;
+      sidebarCssStylesMobile.push({ label: property.label, value: cssStyle });
+    }
     const titleProperties = sidebarBaseProperties.find(
       (property) => property.label === "presentation" && property.values[0].content === "title"
     )?.properties;
@@ -2302,7 +2360,8 @@ async function parseWebsite(websiteTree, projectName, website) {
       title: sidebarTitle,
       layout: sidebarLayout,
       mobileLayout: sidebarMobileLayout,
-      cssStyles: sidebarCssStyles
+      cssStyles: sidebarCssStyles,
+      cssStylesMobile: sidebarCssStylesMobile
     };
   }
   return {

package/package.json

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