ochre-sdk 0.20.10 → 0.20.11

package/dist/index.mjs

@@ -28,6 +28,15 @@ function getStringItemByLanguage(content, language) {
 	return content.find((item) => item.lang === language) ?? null;
 }
 /**
+* Transforms a permanent identification URL to a OCHRE API URL
+*
+* @param url - The permanent identification URL to transform
+* @returns The OCHRE API URL
+*/
+function transformPermanentIdentificationUrl(url) {
+	return url.replace("https://pi.lib.uchicago.edu/1001/org/ochre/", "https://ochre.lib.uchicago.edu/ochre/v2/ochre.php?uuid=");
+}
+/**
 * Parses email addresses in a string into HTML links
 *
 * @param string - Input string to parse
@@ -37,7 +46,7 @@ function parseEmail(string) {
 	const splitString = string.split(" ");
 	const returnSplitString = [];
 	for (const string of splitString) {
-		const cleanString = string.replaceAll(/(?<=\s|^)[([{]+|[)\]}]+(?=\s|$)/g, "").replaceAll(/[!),:;?\]]/g, "").replace(/\.$/, "");
+		const cleanString = transformPermanentIdentificationUrl(string).replaceAll(/(?<=\s|^)[([{]+|[)\]}]+(?=\s|$)/g, "").replaceAll(/[!),:;?\]]/g, "").replace(/\.$/, "");
 		const index = string.indexOf(cleanString);
 		const before = string.slice(0, index);
 		const after = string.slice(index + cleanString.length);
@@ -321,9 +330,9 @@ function parseStringDocumentItem(item) {
 					}
 					return applyWhitespaceToResult(linkElement, itemWhitespace);
 				}
-				case "externalDocument": if (linkResource.publicationDateTime != null) return applyWhitespaceToResult(String.raw`<ExternalLink href="https:\/\/ochre.lib.uchicago.edu/ochre?uuid=${linkResource.uuid}&load" ${linkContent !== null ? `content="${linkContent}"` : ""}>${itemString}</ExternalLink>`, itemWhitespace);
+				case "externalDocument": if (linkResource.publicationDateTime != null) return applyWhitespaceToResult(String.raw`<ExternalLink href="https:\/\/ochre.lib.uchicago.edu/ochre/v2/ochre.php?uuid=${linkResource.uuid}&load" ${linkContent !== null ? `content="${linkContent}"` : ""}>${itemString}</ExternalLink>`, itemWhitespace);
 				else return applyWhitespaceToResult(`<TooltipSpan${linkContent !== null ? ` content="${linkContent}"` : ""}>${itemString}</TooltipSpan>`, itemWhitespace);
-				case "webpage": return applyWhitespaceToResult(`<ExternalLink href="${linkResource.href}" ${linkContent !== null ? `content="${linkContent}"` : ""}>${itemString}</ExternalLink>`, itemWhitespace);
+				case "webpage": return applyWhitespaceToResult(`<ExternalLink href="${linkResource.href != null ? transformPermanentIdentificationUrl(linkResource.href) : "#"}" ${linkContent !== null ? `content="${linkContent}"` : ""}>${itemString}</ExternalLink>`, itemWhitespace);
 				default: return "";
 			}
 		} else if ("spatialUnit" in link) {
@@ -1075,7 +1084,7 @@ function parseLink(linkRaw) {
 		const returnLink = {
 			category: categoryKey,
 			content: "content" in link && link.content != null ? parseFakeString(link.content) : null,
-			href: "href" in link && link.href != null ? link.href : null,
+			href: "href" in link && link.href != null ? transformPermanentIdentificationUrl(link.href) : null,
 			fileFormat: "fileFormat" in link && link.fileFormat != null ? link.fileFormat : null,
 			fileSize: "fileSize" in link && link.fileSize != null ? link.fileSize : null,
 			uuid: link.uuid ?? null,
@@ -1132,9 +1141,9 @@ function parseImage(image) {
 	return {
 		publicationDateTime: parseOptionalDate(image.publicationDateTime),
 		identification: image.identification ? parseIdentification(image.identification) : null,
-		url: image.href ?? (image.htmlImgSrcPrefix == null && image.content != null ? parseFakeString(image.content) : null),
+		url: image.href != null ? transformPermanentIdentificationUrl(image.href) : image.htmlImgSrcPrefix == null && image.content != null ? transformPermanentIdentificationUrl(parseFakeString(image.content)) : null,
 		htmlPrefix: image.htmlImgSrcPrefix ?? null,
-		content: image.htmlImgSrcPrefix != null && image.content != null ? parseFakeString(image.content) : null,
+		content: image.htmlImgSrcPrefix != null && image.content != null ? transformPermanentIdentificationUrl(parseFakeString(image.content)) : null,
 		widthPreview: image.widthPreview ?? null,
 		heightPreview: image.heightPreview ?? null,
 		width: image.width ?? null,
@@ -1369,7 +1378,7 @@ function parseProperty(property, language = "eng") {
 				height: value.height ?? null,
 				width: value.width ?? null,
 				fileSize: value.fileSize ?? null,
-				href: value.href ?? null,
+				href: value.href != null ? transformPermanentIdentificationUrl(value.href) : null,
 				slug: value.slug ?? null
 			};
 		}
@@ -1471,7 +1480,7 @@ function parseBibliography(bibliography, metadata, persistentUrl, belongsTo) {
 		publicationDateTime: parseISO(resource.publicationDateTime),
 		type: resource.type,
 		identification: parseIdentification(resource.identification),
-		href: resource.href ?? null
+		href: resource.href != null ? transformPermanentIdentificationUrl(resource.href) : null
 	})) : [];
 	return {
 		uuid: bibliography.uuid ?? null,
@@ -1850,7 +1859,7 @@ function parseResource(resource, metadata, persistentUrl, belongsTo) {
 		description: resource.description ? parseFakeStringOrContent(resource.description) : "",
 		coordinates: resource.coordinates ? parseCoordinates(resource.coordinates) : [],
 		document: resource.document && "content" in resource.document ? parseDocument(resource.document.content) : null,
-		href: resource.href ?? null,
+		href: resource.href != null ? transformPermanentIdentificationUrl(resource.href) : null,
 		imageMap: resource.imagemap ? parseImageMap(resource.imagemap) : null,
 		periods: resource.periods ? parsePeriods(ensureArray(resource.periods.period)) : [],
 		links: resource.links ? parseLinks(ensureArray(resource.links)) : [],
@@ -2916,7 +2925,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 		case "advanced-search": {
 			const boundElementPropertyUuid = getPropertyByLabel(componentProperty.properties, "bound-element")?.values[0]?.uuid ?? null;
 			const linkToProperty = getPropertyByLabel(componentProperty.properties, "link-to");
-			const href = linkToProperty?.values[0]?.href ?? linkToProperty?.values[0]?.slug ?? null;
+			const href = linkToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrl(linkToProperty.values[0].href) : linkToProperty?.values[0]?.slug ?? null;
 			if (boundElementPropertyUuid == null && href == null) throw new Error(`Bound element or href not found for the following component: “${componentName}”`);
 			properties = {
 				component: "advanced-search",
@@ -2995,10 +3004,10 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			variant ??= "default";
 			let isExternal = false;
 			const navigateToProperty = getPropertyByLabel(componentProperty.properties, "navigate-to");
-			let href = navigateToProperty?.values[0]?.href ?? navigateToProperty?.values[0]?.slug ?? null;
+			let href = navigateToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrl(navigateToProperty.values[0].href) : navigateToProperty?.values[0]?.slug ?? null;
 			if (href === null) {
 				const linkToProperty = getPropertyByLabel(componentProperty.properties, "link-to");
-				href = linkToProperty?.values[0]?.href ?? linkToProperty?.values[0]?.slug ?? null;
+				href = linkToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrl(linkToProperty.values[0].href) : linkToProperty?.values[0]?.slug ?? null;
 				if (href === null) throw new Error(`Properties “navigate-to” or “link-to” not found for the following component: “${componentName}”`);
 				else isExternal = true;
 			}
@@ -3139,7 +3148,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			const width = getPropertyValueByLabel(componentProperty.properties, "width");
 			properties = {
 				component: "iframe",
-				href,
+				href: transformPermanentIdentificationUrl(href),
 				height: height?.toString() ?? null,
 				width: width?.toString() ?? null
 			};
@@ -3370,7 +3379,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			queryVariant ??= "submit";
 			const boundElementUuid = getPropertyByLabel(componentProperty.properties, "bound-element")?.values[0]?.uuid ?? null;
 			const linkToProperty = getPropertyByLabel(componentProperty.properties, "link-to");
-			const href = linkToProperty?.values[0]?.href ?? linkToProperty?.values[0]?.slug ?? null;
+			const href = linkToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrl(linkToProperty.values[0].href) : linkToProperty?.values[0]?.slug ?? null;
 			if (!boundElementUuid && !href) throw new Error(`Bound element or href not found for the following component: “${componentName}”`);
 			let placeholder = getPropertyValueByLabel(componentProperty.properties, "placeholder-text");
 			placeholder ??= null;

package/package.json

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