@digitalculture/ochre-sdk 0.4.7 → 0.4.9

package/dist/index.cjs

@@ -71,9 +71,7 @@ __export(index_exports, {
   parseStringDocumentItem: () => parseStringDocumentItem,
   parseStringItem: () => parseStringItem,
   parseTree: () => parseTree,
-  parseWebsite: () => parseWebsite,
-  trimEndLineBreaks: () => trimEndLineBreaks,
-  trimStartLineBreaks: () => trimStartLineBreaks
+  parseWebsite: () => parseWebsite
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -259,7 +257,7 @@ function parseStringItem(item) {
       break;
     }
   }
-  return trimStartLineBreaks(trimEndLineBreaks(returnString));
+  return returnString;
 }
 function parseStringDocumentItem(item, footnotes) {
   if (typeof item === "string" || typeof item === "number" || typeof item === "boolean") {
@@ -382,23 +380,7 @@ function parseStringDocumentItem(item, footnotes) {
       );
     }
   }
-  return trimStartLineBreaks(trimEndLineBreaks(returnString));
-}
-function trimEndLineBreaks(string) {
-  const trimmedString = string.replaceAll(/^\n<br \/>|\n<br \/>$/g, "");
-  const finalLineBreaks = /\n<br \/>$/.exec(trimmedString);
-  if (finalLineBreaks) {
-    return trimEndLineBreaks(trimmedString);
-  }
-  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;
+  return returnString;
 }
 function parseStringContent(content, language = "eng") {
   switch (typeof content.content) {
@@ -801,7 +783,6 @@ function parseDocument(document, language = "eng") {
       returnString += parseStringDocumentItem(item, footnotes);
     }
   }
-  returnString = trimEndLineBreaks(returnString);
   return { content: returnString, footnotes };
 }
 function parseImage(image) {
@@ -1626,6 +1607,22 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (altTextSource === null) {
         altTextSource = "name";
       }
+      let isTransparentBackground = false;
+      const isTransparentBackgroundProperty = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-transparent"
+      );
+      if (isTransparentBackgroundProperty !== null) {
+        isTransparentBackground = isTransparentBackgroundProperty === "Yes";
+      }
+      let isCover = false;
+      const isCoverProperty = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-cover"
+      );
+      if (isCoverProperty !== null) {
+        isCover = isCoverProperty === "Yes";
+      }
       let carouselOptions = null;
       if (images.length > 1) {
         const variantProperty = getPropertyByLabel(
@@ -1656,6 +1653,8 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.captionLayout = captionLayout;
       properties.captionSource = captionSource;
       properties.altTextSource = altTextSource;
+      properties.isTransparentBackground = isTransparentBackground;
+      properties.isCover = isCover;
       properties.carouselOptions = carouselOptions;
       break;
     }
@@ -2700,7 +2699,5 @@ async function fetchWebsite(abbreviation) {
   parseStringDocumentItem,
   parseStringItem,
   parseTree,
-  parseWebsite,
-  trimEndLineBreaks,
-  trimStartLineBreaks
+  parseWebsite
 });

package/dist/index.d.cts

@@ -518,6 +518,8 @@ type WebElementComponent = {
     captionSource: "name" | "abbreviation" | "description";
     captionLayout: "top" | "bottom" | "suppress";
     altTextSource: "name" | "abbreviation" | "description";
+    isTransparentBackground: boolean;
+    isCover: boolean;
     carouselOptions: {
         secondsPerImage: number;
     } | null;
@@ -1827,32 +1829,6 @@ declare function parseStringItem(item: OchreStringItem): string;
  * @returns Formatted string with HTML/markdown elements
  */
 declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnotes?: Array<Footnote>): string;
-/**
- * Removes trailing line breaks from a string
- *
- * @param string - Input string to trim
- * @returns String with trailing line breaks removed
- *
- * @example
- * ```ts
- * const trimmed = trimEndLineBreaks("Hello\n<br />\n<br />");
- * // Returns: "Hello"
- * ```
- */
-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
  *
@@ -1862,4 +1838,4 @@ declare function trimStartLineBreaks(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, trimStartLineBreaks };
+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 };

package/dist/index.d.ts

@@ -518,6 +518,8 @@ type WebElementComponent = {
     captionSource: "name" | "abbreviation" | "description";
     captionLayout: "top" | "bottom" | "suppress";
     altTextSource: "name" | "abbreviation" | "description";
+    isTransparentBackground: boolean;
+    isCover: boolean;
     carouselOptions: {
         secondsPerImage: number;
     } | null;
@@ -1827,32 +1829,6 @@ declare function parseStringItem(item: OchreStringItem): string;
  * @returns Formatted string with HTML/markdown elements
  */
 declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnotes?: Array<Footnote>): string;
-/**
- * Removes trailing line breaks from a string
- *
- * @param string - Input string to trim
- * @returns String with trailing line breaks removed
- *
- * @example
- * ```ts
- * const trimmed = trimEndLineBreaks("Hello\n<br />\n<br />");
- * // Returns: "Hello"
- * ```
- */
-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
  *
@@ -1862,4 +1838,4 @@ declare function trimStartLineBreaks(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, trimStartLineBreaks };
+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 };

package/dist/index.js

@@ -180,7 +180,7 @@ function parseStringItem(item) {
       break;
     }
   }
-  return trimStartLineBreaks(trimEndLineBreaks(returnString));
+  return returnString;
 }
 function parseStringDocumentItem(item, footnotes) {
   if (typeof item === "string" || typeof item === "number" || typeof item === "boolean") {
@@ -303,23 +303,7 @@ function parseStringDocumentItem(item, footnotes) {
       );
     }
   }
-  return trimStartLineBreaks(trimEndLineBreaks(returnString));
-}
-function trimEndLineBreaks(string) {
-  const trimmedString = string.replaceAll(/^\n<br \/>|\n<br \/>$/g, "");
-  const finalLineBreaks = /\n<br \/>$/.exec(trimmedString);
-  if (finalLineBreaks) {
-    return trimEndLineBreaks(trimmedString);
-  }
-  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;
+  return returnString;
 }
 function parseStringContent(content, language = "eng") {
   switch (typeof content.content) {
@@ -722,7 +706,6 @@ function parseDocument(document, language = "eng") {
       returnString += parseStringDocumentItem(item, footnotes);
     }
   }
-  returnString = trimEndLineBreaks(returnString);
   return { content: returnString, footnotes };
 }
 function parseImage(image) {
@@ -1547,6 +1530,22 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (altTextSource === null) {
         altTextSource = "name";
       }
+      let isTransparentBackground = false;
+      const isTransparentBackgroundProperty = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-transparent"
+      );
+      if (isTransparentBackgroundProperty !== null) {
+        isTransparentBackground = isTransparentBackgroundProperty === "Yes";
+      }
+      let isCover = false;
+      const isCoverProperty = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-cover"
+      );
+      if (isCoverProperty !== null) {
+        isCover = isCoverProperty === "Yes";
+      }
       let carouselOptions = null;
       if (images.length > 1) {
         const variantProperty = getPropertyByLabel(
@@ -1577,6 +1576,8 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.captionLayout = captionLayout;
       properties.captionSource = captionSource;
       properties.altTextSource = altTextSource;
+      properties.isTransparentBackground = isTransparentBackground;
+      properties.isCover = isCover;
       properties.carouselOptions = carouselOptions;
       break;
     }
@@ -2620,7 +2621,5 @@ export {
   parseStringDocumentItem,
   parseStringItem,
   parseTree,
-  parseWebsite,
-  trimEndLineBreaks,
-  trimStartLineBreaks
+  parseWebsite
 };

package/package.json

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