@digitalculture/ochre-sdk 0.4.3 → 0.4.5

package/dist/index.cjs

@@ -72,11 +72,13 @@ __export(index_exports, {
   parseStringItem: () => parseStringItem,
   parseTree: () => parseTree,
   parseWebsite: () => parseWebsite,
-  trimEndLineBreaks: () => trimEndLineBreaks
+  trimEndLineBreaks: () => trimEndLineBreaks,
+  trimStartLineBreaks: () => trimStartLineBreaks
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/utils/parse.ts
+var import_uuid = require("uuid");
 var import_zod3 = require("zod");
 
 // src/utils/fetchers/generic.ts
@@ -198,13 +200,11 @@ function parseWhitespace(contentString, whitespace) {
     console.warn(`Invalid whitespace string provided: \u201C${whitespace}\u201D`);
     return contentString;
   }
-  for (const [index, option] of result.data.entries()) {
+  for (const option of result.data) {
     switch (option) {
       case "newline": {
-        if (index !== 0) {
-          returnString = `<br />
+        returnString = `<br />
 ${returnString}`;
-        }
         break;
       }
       case "trailing": {
@@ -259,7 +259,7 @@ function parseStringItem(item) {
       break;
     }
   }
-  return returnString.replaceAll("&#39;", "'");
+  return trimStartLineBreaks(trimEndLineBreaks(returnString));
 }
 function parseStringDocumentItem(item, footnotes) {
   if (typeof item === "string" || typeof item === "number" || typeof item === "boolean") {
@@ -382,7 +382,7 @@ function parseStringDocumentItem(item, footnotes) {
       );
     }
   }
-  return returnString.replaceAll("&#39;", "'");
+  return trimStartLineBreaks(trimEndLineBreaks(returnString));
 }
 function trimEndLineBreaks(string) {
   const trimmedString = string.replaceAll(/^\n<br \/>|\n<br \/>$/g, "");
@@ -392,6 +392,14 @@ function trimEndLineBreaks(string) {
   }
   return trimmedString;
 }
+function trimStartLineBreaks(string) {
+  const trimmedString = string.replaceAll(/^<br \/>\n|<br \/>\n$/g, "");
+  const leadingLineBreaks = /^<br \/>\n/.exec(trimmedString);
+  if (leadingLineBreaks) {
+    return trimStartLineBreaks(trimmedString);
+  }
+  return trimmedString;
+}
 function parseStringContent(content, language = "eng") {
   switch (typeof content.content) {
     case "string":
@@ -1560,7 +1568,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       }
       let captionLayout = getPropertyValueByLabel(
         componentProperty.properties,
-        "caption-layout"
+        "layout-caption"
       );
       if (captionLayout === null) {
         captionLayout = "bottom";
@@ -1736,7 +1744,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       }
       let captionLayout = getPropertyValueByLabel(
         componentProperty.properties,
-        "caption-layout"
+        "layout-caption"
       );
       if (captionLayout === null) {
         captionLayout = "bottom";
@@ -1930,16 +1938,16 @@ async function parseWebpage(webpageResource) {
     if (!resourceType) {
       continue;
     }
-    if (resourceType !== "block") {
+    if (resourceType === "element") {
       elementsToHandle.push(resource);
-    } else {
+    } else if (resourceType === "block") {
       if (elementsToHandle.length > 0) {
         const elements = await parseWebpageResources(
           elementsToHandle,
           "element"
         );
         const block = {
-          uuid: resource.uuid,
+          uuid: (0, import_uuid.v4)(),
           layout: "vertical",
           blocks: [],
           elements,
@@ -1961,7 +1969,7 @@ async function parseWebpage(webpageResource) {
   if (elementsToHandle.length > 0) {
     const elements = await parseWebpageResources(elementsToHandle, "element");
     const block = {
-      uuid: webpageResource.uuid,
+      uuid: (0, import_uuid.v4)(),
       layout: "vertical",
       blocks: [],
       elements,
@@ -2168,7 +2176,6 @@ function parseWebsiteProperties(properties) {
   let isHeaderProjectDisplayed = true;
   let isFooterDisplayed = true;
   let isSidebarDisplayed = false;
-  let sidebarVariant = "default";
   let searchCollectionUuid = null;
   let supportsThemeToggle = true;
   const headerProperty = websiteProperties.find(
@@ -2207,12 +2214,6 @@ function parseWebsiteProperties(properties) {
   if (sidebarProperty) {
     isSidebarDisplayed = sidebarProperty.content === "Yes";
   }
-  const sidebarVariantProperty = websiteProperties.find(
-    (property) => property.label === "sidebar-variant"
-  )?.values[0];
-  if (sidebarVariantProperty) {
-    sidebarVariant = sidebarVariantProperty.content;
-  }
   const collectionSearchProperty = websiteProperties.find(
     (property) => property.label === "search-collection"
   )?.values[0];
@@ -2240,7 +2241,6 @@ function parseWebsiteProperties(properties) {
     isHeaderProjectDisplayed,
     isFooterDisplayed,
     isSidebarDisplayed,
-    sidebarVariant,
     supportsThemeToggle,
     searchCollectionUuid,
     logoUrl: logoUuid !== null ? `https://ochre.lib.uchicago.edu/ochre?uuid=${logoUuid}&load` : null
@@ -2271,6 +2271,7 @@ async function parseWebsite(websiteTree, projectName, website) {
     }
   };
   let sidebarLayout = "start";
+  let sidebarMobileLayout = "default";
   const sidebarCssStyles = [];
   const sidebarResource = resources.find((resource) => {
     const resourceProperties = resource.properties ? parseProperties(
@@ -2296,6 +2297,12 @@ async function parseWebsite(websiteTree, projectName, website) {
     if (sidebarLayoutProperty) {
       sidebarLayout = sidebarLayoutProperty.values[0].content;
     }
+    const sidebarMobileLayoutProperty = sidebarProperties.find(
+      (property) => property.label === "layout-mobile"
+    );
+    if (sidebarMobileLayoutProperty) {
+      sidebarMobileLayout = sidebarMobileLayoutProperty.values[0].content;
+    }
     const cssProperties = sidebarBaseProperties.find(
       (property) => property.label === "presentation" && property.values[0].content === "css"
     )?.properties ?? [];
@@ -2348,6 +2355,7 @@ async function parseWebsite(websiteTree, projectName, website) {
       elements: sidebarElements,
       title: sidebarTitle,
       layout: sidebarLayout,
+      mobileLayout: sidebarMobileLayout,
       cssStyles: sidebarCssStyles
     };
   }
@@ -2675,5 +2683,6 @@ async function fetchWebsite(abbreviation) {
   parseStringItem,
   parseTree,
   parseWebsite,
-  trimEndLineBreaks
+  trimEndLineBreaks,
+  trimStartLineBreaks
 });

package/dist/index.d.cts

@@ -413,6 +413,7 @@ type Website = {
         elements: Array<WebElement>;
         title: WebElement["title"];
         layout: "start" | "end";
+        mobileLayout: "default" | "inline";
         cssStyles: Array<Style>;
     } | null;
     properties: WebsiteProperties;
@@ -430,7 +431,6 @@ type WebsiteProperties = {
     isHeaderProjectDisplayed: boolean;
     isFooterDisplayed: boolean;
     isSidebarDisplayed: boolean;
-    sidebarVariant: "default" | "inline";
     supportsThemeToggle: boolean;
     searchCollectionUuid: string | null;
     logoUrl: string | null;
@@ -1838,6 +1838,19 @@ declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnote
  * ```
  */
 declare function trimEndLineBreaks(string: string): string;
+/**
+ * Removes leading line breaks from a string
+ *
+ * @param string - Input string to trim
+ * @returns String with leading line breaks removed
+ *
+ * @example
+ * ```ts
+ * const trimmed = trimStartLineBreaks("<br />\n<br />\nHello");
+ * // Returns: "Hello"
+ * ```
+ */
+declare function trimStartLineBreaks(string: string): string;
 /**
  * Parses raw string content into a formatted string
  *
@@ -1847,4 +1860,4 @@ declare function trimEndLineBreaks(string: string): string;
  */
 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, trimEndLineBreaks };
+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, trimEndLineBreaks, trimStartLineBreaks };

package/dist/index.d.ts

@@ -413,6 +413,7 @@ type Website = {
         elements: Array<WebElement>;
         title: WebElement["title"];
         layout: "start" | "end";
+        mobileLayout: "default" | "inline";
         cssStyles: Array<Style>;
     } | null;
     properties: WebsiteProperties;
@@ -430,7 +431,6 @@ type WebsiteProperties = {
     isHeaderProjectDisplayed: boolean;
     isFooterDisplayed: boolean;
     isSidebarDisplayed: boolean;
-    sidebarVariant: "default" | "inline";
     supportsThemeToggle: boolean;
     searchCollectionUuid: string | null;
     logoUrl: string | null;
@@ -1838,6 +1838,19 @@ declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnote
  * ```
  */
 declare function trimEndLineBreaks(string: string): string;
+/**
+ * Removes leading line breaks from a string
+ *
+ * @param string - Input string to trim
+ * @returns String with leading line breaks removed
+ *
+ * @example
+ * ```ts
+ * const trimmed = trimStartLineBreaks("<br />\n<br />\nHello");
+ * // Returns: "Hello"
+ * ```
+ */
+declare function trimStartLineBreaks(string: string): string;
 /**
  * Parses raw string content into a formatted string
  *
@@ -1847,4 +1860,4 @@ declare function trimEndLineBreaks(string: string): string;
  */
 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, trimEndLineBreaks };
+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, trimEndLineBreaks, trimStartLineBreaks };

package/dist/index.js

@@ -1,4 +1,5 @@
 // src/utils/parse.ts
+import { v4 as uuidv4 } from "uuid";
 import { z as z3 } from "zod";
 
 // src/utils/fetchers/generic.ts
@@ -120,13 +121,11 @@ function parseWhitespace(contentString, whitespace) {
     console.warn(`Invalid whitespace string provided: \u201C${whitespace}\u201D`);
     return contentString;
   }
-  for (const [index, option] of result.data.entries()) {
+  for (const option of result.data) {
     switch (option) {
       case "newline": {
-        if (index !== 0) {
-          returnString = `<br />
+        returnString = `<br />
 ${returnString}`;
-        }
         break;
       }
       case "trailing": {
@@ -181,7 +180,7 @@ function parseStringItem(item) {
       break;
     }
   }
-  return returnString.replaceAll("&#39;", "'");
+  return trimStartLineBreaks(trimEndLineBreaks(returnString));
 }
 function parseStringDocumentItem(item, footnotes) {
   if (typeof item === "string" || typeof item === "number" || typeof item === "boolean") {
@@ -304,7 +303,7 @@ function parseStringDocumentItem(item, footnotes) {
       );
     }
   }
-  return returnString.replaceAll("&#39;", "'");
+  return trimStartLineBreaks(trimEndLineBreaks(returnString));
 }
 function trimEndLineBreaks(string) {
   const trimmedString = string.replaceAll(/^\n<br \/>|\n<br \/>$/g, "");
@@ -314,6 +313,14 @@ function trimEndLineBreaks(string) {
   }
   return trimmedString;
 }
+function trimStartLineBreaks(string) {
+  const trimmedString = string.replaceAll(/^<br \/>\n|<br \/>\n$/g, "");
+  const leadingLineBreaks = /^<br \/>\n/.exec(trimmedString);
+  if (leadingLineBreaks) {
+    return trimStartLineBreaks(trimmedString);
+  }
+  return trimmedString;
+}
 function parseStringContent(content, language = "eng") {
   switch (typeof content.content) {
     case "string":
@@ -1482,7 +1489,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       }
       let captionLayout = getPropertyValueByLabel(
         componentProperty.properties,
-        "caption-layout"
+        "layout-caption"
       );
       if (captionLayout === null) {
         captionLayout = "bottom";
@@ -1658,7 +1665,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       }
       let captionLayout = getPropertyValueByLabel(
         componentProperty.properties,
-        "caption-layout"
+        "layout-caption"
       );
       if (captionLayout === null) {
         captionLayout = "bottom";
@@ -1852,16 +1859,16 @@ async function parseWebpage(webpageResource) {
     if (!resourceType) {
       continue;
     }
-    if (resourceType !== "block") {
+    if (resourceType === "element") {
       elementsToHandle.push(resource);
-    } else {
+    } else if (resourceType === "block") {
       if (elementsToHandle.length > 0) {
         const elements = await parseWebpageResources(
           elementsToHandle,
           "element"
         );
         const block = {
-          uuid: resource.uuid,
+          uuid: uuidv4(),
           layout: "vertical",
           blocks: [],
           elements,
@@ -1883,7 +1890,7 @@ async function parseWebpage(webpageResource) {
   if (elementsToHandle.length > 0) {
     const elements = await parseWebpageResources(elementsToHandle, "element");
     const block = {
-      uuid: webpageResource.uuid,
+      uuid: uuidv4(),
       layout: "vertical",
       blocks: [],
       elements,
@@ -2090,7 +2097,6 @@ function parseWebsiteProperties(properties) {
   let isHeaderProjectDisplayed = true;
   let isFooterDisplayed = true;
   let isSidebarDisplayed = false;
-  let sidebarVariant = "default";
   let searchCollectionUuid = null;
   let supportsThemeToggle = true;
   const headerProperty = websiteProperties.find(
@@ -2129,12 +2135,6 @@ function parseWebsiteProperties(properties) {
   if (sidebarProperty) {
     isSidebarDisplayed = sidebarProperty.content === "Yes";
   }
-  const sidebarVariantProperty = websiteProperties.find(
-    (property) => property.label === "sidebar-variant"
-  )?.values[0];
-  if (sidebarVariantProperty) {
-    sidebarVariant = sidebarVariantProperty.content;
-  }
   const collectionSearchProperty = websiteProperties.find(
     (property) => property.label === "search-collection"
   )?.values[0];
@@ -2162,7 +2162,6 @@ function parseWebsiteProperties(properties) {
     isHeaderProjectDisplayed,
     isFooterDisplayed,
     isSidebarDisplayed,
-    sidebarVariant,
     supportsThemeToggle,
     searchCollectionUuid,
     logoUrl: logoUuid !== null ? `https://ochre.lib.uchicago.edu/ochre?uuid=${logoUuid}&load` : null
@@ -2193,6 +2192,7 @@ async function parseWebsite(websiteTree, projectName, website) {
     }
   };
   let sidebarLayout = "start";
+  let sidebarMobileLayout = "default";
   const sidebarCssStyles = [];
   const sidebarResource = resources.find((resource) => {
     const resourceProperties = resource.properties ? parseProperties(
@@ -2218,6 +2218,12 @@ async function parseWebsite(websiteTree, projectName, website) {
     if (sidebarLayoutProperty) {
       sidebarLayout = sidebarLayoutProperty.values[0].content;
     }
+    const sidebarMobileLayoutProperty = sidebarProperties.find(
+      (property) => property.label === "layout-mobile"
+    );
+    if (sidebarMobileLayoutProperty) {
+      sidebarMobileLayout = sidebarMobileLayoutProperty.values[0].content;
+    }
     const cssProperties = sidebarBaseProperties.find(
       (property) => property.label === "presentation" && property.values[0].content === "css"
     )?.properties ?? [];
@@ -2270,6 +2276,7 @@ async function parseWebsite(websiteTree, projectName, website) {
       elements: sidebarElements,
       title: sidebarTitle,
       layout: sidebarLayout,
+      mobileLayout: sidebarMobileLayout,
       cssStyles: sidebarCssStyles
     };
   }
@@ -2596,5 +2603,6 @@ export {
   parseStringItem,
   parseTree,
   parseWebsite,
-  trimEndLineBreaks
+  trimEndLineBreaks,
+  trimStartLineBreaks
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -41,6 +41,7 @@
   ],
   "dependencies": {
     "iso-639-3": "^3.0.1",
+    "uuid": "^11.1.0",
     "zod": "^3.24.2"
   },
   "devDependencies": {