@digitalculture/ochre-sdk 0.4.13 → 0.4.15

package/dist/index.cjs

@@ -42,7 +42,7 @@ __export(index_exports, {
   parseContext: () => parseContext,
   parseCoordinates: () => parseCoordinates,
   parseDocument: () => parseDocument,
-  parseEmailAndUrl: () => parseEmailAndUrl,
+  parseEmail: () => parseEmail,
   parseEvents: () => parseEvents,
   parseFakeString: () => parseFakeString,
   parseIdentification: () => parseIdentification,
@@ -125,21 +125,11 @@ var whitespaceSchema = import_zod2.z.string().transform((str) => str.split(" "))
   )
 );
 var emailSchema = import_zod2.z.string().email({ message: "Invalid email" });
-var urlSchema = import_zod2.z.string().refine((v) => v ? isUrlValid(v) : false, {
-  message: "Invalid URL"
-});
-function isUrlValid(url) {
-  const pattern = (
-    // eslint-disable-next-line regexp/no-useless-quantifier, regexp/no-unused-capturing-group
-    /((([A-Za-z]{3,9}:(?:\/\/)?)(?:[\w$&+,:;=-]+@)?[\d.A-Za-z-]+(:\d+)?|(?:www.|[\w$&+,:;=-]+@)[\d.A-Za-z-]+)((?:\/[\w%+./~-]*)?\??[\w%&+.;=@-]*#?\w*)?)/
-  );
-  return !!pattern.test(url);
-}
 function getStringItemByLanguage(content, language) {
   const stringItemToFind = content.find((item) => item.lang === language);
   return stringItemToFind ?? null;
 }
-function parseEmailAndUrl(string) {
+function parseEmail(string) {
   const splitString = string.split(" ");
   const returnSplitString = [];
   for (const string2 of splitString) {
@@ -155,13 +145,6 @@ function parseEmailAndUrl(string) {
       );
       continue;
     }
-    const isUrl = urlSchema.safeParse(cleanString).success;
-    if (isUrl) {
-      returnSplitString.push(
-        `${before}<ExternalLink href="${cleanString}">${cleanString}</ExternalLink>${after}`
-      );
-      continue;
-    }
     returnSplitString.push(string2);
   }
   return returnSplitString.join(" ");
@@ -265,7 +248,7 @@ function parseStringItem(item) {
 }
 function parseStringDocumentItem(item, footnotes) {
   if (typeof item === "string" || typeof item === "number" || typeof item === "boolean") {
-    return parseEmailAndUrl(parseFakeString(item));
+    return parseEmail(parseFakeString(item));
   }
   if ("whitespace" in item && !("content" in item) && !("string" in item)) {
     if (item.whitespace === "newline") {
@@ -275,7 +258,12 @@ function parseStringDocumentItem(item, footnotes) {
     }
   }
   if ("links" in item) {
-    const itemString = parseFakeString(item.string).replaceAll("<", String.raw`\<`).replaceAll("{", String.raw`\{`);
+    let itemString = "";
+    if (typeof item.string === "object") {
+      itemString = parseStringContent(item.string);
+    } else {
+      itemString = parseFakeString(item.string).replaceAll("<", String.raw`\<`).replaceAll("{", String.raw`\{`);
+    }
     const itemLinks = Array.isArray(item.links) ? item.links : [item.links];
     for (const link of itemLinks) {
       if ("resource" in link) {
@@ -366,25 +354,16 @@ function parseStringDocumentItem(item, footnotes) {
       returnString += parseStringDocumentItem(stringItem, footnotes);
     }
     if ("whitespace" in item && item.whitespace != null) {
-      returnString = parseWhitespace(
-        parseEmailAndUrl(returnString),
-        item.whitespace
-      );
+      returnString = parseWhitespace(parseEmail(returnString), item.whitespace);
     }
     return returnString.replaceAll("&#39;", "'").replaceAll(/^(\d+)\./gm, String.raw`$1\.`);
   } else {
     returnString = parseFakeString(item.content);
     if (item.rend != null) {
-      returnString = parseRenderOptions(
-        parseEmailAndUrl(returnString),
-        item.rend
-      );
+      returnString = parseRenderOptions(parseEmail(returnString), item.rend);
     }
     if (item.whitespace != null) {
-      returnString = parseWhitespace(
-        parseEmailAndUrl(returnString),
-        item.whitespace
-      );
+      returnString = parseWhitespace(parseEmail(returnString), item.whitespace);
     }
   }
   return returnString.replaceAll(/^(\d+)\./gm, String.raw`$1\.`);
@@ -781,9 +760,7 @@ function parseDocument(document, language = "eng") {
   const footnotes = [];
   const documentWithLanguage = Array.isArray(document) ? document.find((doc) => doc.lang === language) : document;
   if (typeof documentWithLanguage.string === "string" || typeof documentWithLanguage.string === "number" || typeof documentWithLanguage.string === "boolean") {
-    returnString += parseEmailAndUrl(
-      parseFakeString(documentWithLanguage.string)
-    );
+    returnString += parseEmail(parseFakeString(documentWithLanguage.string));
   } else {
     const documentItems = Array.isArray(documentWithLanguage.string) ? documentWithLanguage.string : [documentWithLanguage.string];
     for (const item of documentItems) {
@@ -835,9 +812,9 @@ function parseNotes(notes, language = "eng") {
       }
     }
     if (typeof noteWithLanguage.string === "string" || typeof noteWithLanguage.string === "number" || typeof noteWithLanguage.string === "boolean") {
-      content = parseEmailAndUrl(parseFakeString(noteWithLanguage.string));
+      content = parseEmail(parseFakeString(noteWithLanguage.string));
     } else {
-      content = parseEmailAndUrl(parseDocument(noteWithLanguage).content);
+      content = parseEmail(parseDocument(noteWithLanguage).content);
     }
     returnNotes.push({
       number: note.noteNo,
@@ -2738,7 +2715,7 @@ async function fetchWebsite(abbreviation) {
   parseContext,
   parseCoordinates,
   parseDocument,
-  parseEmailAndUrl,
+  parseEmail,
   parseEvents,
   parseFakeString,
   parseIdentification,

package/dist/index.d.cts

@@ -751,7 +751,7 @@ type OchreStringRichTextItemContent = {
  */
 type OchreStringRichTextItemAnnotation = {
   annotation: string; // UUID
-  string: FakeString;
+  string: FakeString | OchreStringRichTextItemContent;
   links: OchreLink | Array<OchreLink>;
 };
 
@@ -1796,19 +1796,18 @@ declare function parseConcepts(concepts: Array<OchreConcept> | Array<OchreNested
 declare function parseWebsite(websiteTree: OchreTree, projectName: FakeString, website: FakeString | null): Promise<Website>;
 
 /**
- * Parses email addresses and URLs in a string into HTML links
+ * Parses email addresses in a string into HTML links
  *
  * @param string - Input string to parse
- * @returns String with emails and URLs converted to HTML links
+ * @returns String with emails converted to HTML links
  *
  * @example
  * ```ts
- * const parsed = parseEmailAndUrl("Contact us at info@example.com or visit www.example.com");
- * // Returns: "Contact us at <ExternalLink href="mailto:info@example.com">info@example.com</ExternalLink>
- * //          or visit <ExternalLink href="www.example.com">www.example.com</ExternalLink>"
+ * const parsed = parseEmail("Contact us at info@example.com");
+ * // Returns: "Contact us at <ExternalLink href="mailto:info@example.com">info@example.com</ExternalLink>"
  * ```
  */
-declare function parseEmailAndUrl(string: string): string;
+declare function parseEmail(string: string): string;
 /**
  * Converts a FakeString (string|number|boolean) to a proper string
  *
@@ -1847,4 +1846,4 @@ declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnote
  */
 declare function parseStringContent(content: OchreStringContent, language?: string): string;
 
-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 };
+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, parseEmail, 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

@@ -751,7 +751,7 @@ type OchreStringRichTextItemContent = {
  */
 type OchreStringRichTextItemAnnotation = {
   annotation: string; // UUID
-  string: FakeString;
+  string: FakeString | OchreStringRichTextItemContent;
   links: OchreLink | Array<OchreLink>;
 };
 
@@ -1796,19 +1796,18 @@ declare function parseConcepts(concepts: Array<OchreConcept> | Array<OchreNested
 declare function parseWebsite(websiteTree: OchreTree, projectName: FakeString, website: FakeString | null): Promise<Website>;
 
 /**
- * Parses email addresses and URLs in a string into HTML links
+ * Parses email addresses in a string into HTML links
  *
  * @param string - Input string to parse
- * @returns String with emails and URLs converted to HTML links
+ * @returns String with emails converted to HTML links
  *
  * @example
  * ```ts
- * const parsed = parseEmailAndUrl("Contact us at info@example.com or visit www.example.com");
- * // Returns: "Contact us at <ExternalLink href="mailto:info@example.com">info@example.com</ExternalLink>
- * //          or visit <ExternalLink href="www.example.com">www.example.com</ExternalLink>"
+ * const parsed = parseEmail("Contact us at info@example.com");
+ * // Returns: "Contact us at <ExternalLink href="mailto:info@example.com">info@example.com</ExternalLink>"
  * ```
  */
-declare function parseEmailAndUrl(string: string): string;
+declare function parseEmail(string: string): string;
 /**
  * Converts a FakeString (string|number|boolean) to a proper string
  *
@@ -1847,4 +1846,4 @@ declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnote
  */
 declare function parseStringContent(content: OchreStringContent, language?: string): string;
 
-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 };
+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, parseEmail, 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

@@ -48,21 +48,11 @@ var whitespaceSchema = z2.string().transform((str) => str.split(" ")).pipe(
   )
 );
 var emailSchema = z2.string().email({ message: "Invalid email" });
-var urlSchema = z2.string().refine((v) => v ? isUrlValid(v) : false, {
-  message: "Invalid URL"
-});
-function isUrlValid(url) {
-  const pattern = (
-    // eslint-disable-next-line regexp/no-useless-quantifier, regexp/no-unused-capturing-group
-    /((([A-Za-z]{3,9}:(?:\/\/)?)(?:[\w$&+,:;=-]+@)?[\d.A-Za-z-]+(:\d+)?|(?:www.|[\w$&+,:;=-]+@)[\d.A-Za-z-]+)((?:\/[\w%+./~-]*)?\??[\w%&+.;=@-]*#?\w*)?)/
-  );
-  return !!pattern.test(url);
-}
 function getStringItemByLanguage(content, language) {
   const stringItemToFind = content.find((item) => item.lang === language);
   return stringItemToFind ?? null;
 }
-function parseEmailAndUrl(string) {
+function parseEmail(string) {
   const splitString = string.split(" ");
   const returnSplitString = [];
   for (const string2 of splitString) {
@@ -78,13 +68,6 @@ function parseEmailAndUrl(string) {
       );
       continue;
     }
-    const isUrl = urlSchema.safeParse(cleanString).success;
-    if (isUrl) {
-      returnSplitString.push(
-        `${before}<ExternalLink href="${cleanString}">${cleanString}</ExternalLink>${after}`
-      );
-      continue;
-    }
     returnSplitString.push(string2);
   }
   return returnSplitString.join(" ");
@@ -188,7 +171,7 @@ function parseStringItem(item) {
 }
 function parseStringDocumentItem(item, footnotes) {
   if (typeof item === "string" || typeof item === "number" || typeof item === "boolean") {
-    return parseEmailAndUrl(parseFakeString(item));
+    return parseEmail(parseFakeString(item));
   }
   if ("whitespace" in item && !("content" in item) && !("string" in item)) {
     if (item.whitespace === "newline") {
@@ -198,7 +181,12 @@ function parseStringDocumentItem(item, footnotes) {
     }
   }
   if ("links" in item) {
-    const itemString = parseFakeString(item.string).replaceAll("<", String.raw`\<`).replaceAll("{", String.raw`\{`);
+    let itemString = "";
+    if (typeof item.string === "object") {
+      itemString = parseStringContent(item.string);
+    } else {
+      itemString = parseFakeString(item.string).replaceAll("<", String.raw`\<`).replaceAll("{", String.raw`\{`);
+    }
     const itemLinks = Array.isArray(item.links) ? item.links : [item.links];
     for (const link of itemLinks) {
       if ("resource" in link) {
@@ -289,25 +277,16 @@ function parseStringDocumentItem(item, footnotes) {
       returnString += parseStringDocumentItem(stringItem, footnotes);
     }
     if ("whitespace" in item && item.whitespace != null) {
-      returnString = parseWhitespace(
-        parseEmailAndUrl(returnString),
-        item.whitespace
-      );
+      returnString = parseWhitespace(parseEmail(returnString), item.whitespace);
     }
     return returnString.replaceAll("&#39;", "'").replaceAll(/^(\d+)\./gm, String.raw`$1\.`);
   } else {
     returnString = parseFakeString(item.content);
     if (item.rend != null) {
-      returnString = parseRenderOptions(
-        parseEmailAndUrl(returnString),
-        item.rend
-      );
+      returnString = parseRenderOptions(parseEmail(returnString), item.rend);
     }
     if (item.whitespace != null) {
-      returnString = parseWhitespace(
-        parseEmailAndUrl(returnString),
-        item.whitespace
-      );
+      returnString = parseWhitespace(parseEmail(returnString), item.whitespace);
     }
   }
   return returnString.replaceAll(/^(\d+)\./gm, String.raw`$1\.`);
@@ -704,9 +683,7 @@ function parseDocument(document, language = "eng") {
   const footnotes = [];
   const documentWithLanguage = Array.isArray(document) ? document.find((doc) => doc.lang === language) : document;
   if (typeof documentWithLanguage.string === "string" || typeof documentWithLanguage.string === "number" || typeof documentWithLanguage.string === "boolean") {
-    returnString += parseEmailAndUrl(
-      parseFakeString(documentWithLanguage.string)
-    );
+    returnString += parseEmail(parseFakeString(documentWithLanguage.string));
   } else {
     const documentItems = Array.isArray(documentWithLanguage.string) ? documentWithLanguage.string : [documentWithLanguage.string];
     for (const item of documentItems) {
@@ -758,9 +735,9 @@ function parseNotes(notes, language = "eng") {
       }
     }
     if (typeof noteWithLanguage.string === "string" || typeof noteWithLanguage.string === "number" || typeof noteWithLanguage.string === "boolean") {
-      content = parseEmailAndUrl(parseFakeString(noteWithLanguage.string));
+      content = parseEmail(parseFakeString(noteWithLanguage.string));
     } else {
-      content = parseEmailAndUrl(parseDocument(noteWithLanguage).content);
+      content = parseEmail(parseDocument(noteWithLanguage).content);
     }
     returnNotes.push({
       number: note.noteNo,
@@ -2660,7 +2637,7 @@ export {
   parseContext,
   parseCoordinates,
   parseDocument,
-  parseEmailAndUrl,
+  parseEmail,
   parseEvents,
   parseFakeString,
   parseIdentification,

package/package.json

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