ochre-sdk 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/index.d.mts

@@ -228,9 +228,11 @@ type ItemLocation = "topLevel" | "nested";
 type ItemOrigin<T extends ReadonlyArray<string>, U extends ItemLocation> = U extends "topLevel" ? {
   belongsTo: BelongsTo;
   metadata: Metadata<T>;
+  persistentUrl: string | null;
 } : {
   belongsTo: null;
   metadata: null;
+  persistentUrl: null;
 };
 /**
  *  License in OCHRE

package/dist/index.mjs

@@ -725,7 +725,7 @@ function getLinkStringProperty(link, property) {
 		case "width": return "width" in link && typeof link.width === "string" ? link.width : null;
 	}
 }
-function transformPermanentIdentificationUrl$1(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=");
 }
 /**
@@ -740,7 +740,7 @@ function parseEmail(string) {
 	const splitString = string.split(" ");
 	const returnSplitString = [];
 	for (const string of splitString) {
-		const cleanString = transformPermanentIdentificationUrl$1(string).replaceAll(EMAIL_BRACKET_CLEANUP_REGEX, "").replaceAll(EMAIL_PUNCTUATION_CLEANUP_REGEX, "").replace(EMAIL_TRAILING_PERIOD_REGEX, "");
+		const cleanString = transformPermanentIdentificationUrl(string).replaceAll(EMAIL_BRACKET_CLEANUP_REGEX, "").replaceAll(EMAIL_PUNCTUATION_CLEANUP_REGEX, "").replace(EMAIL_TRAILING_PERIOD_REGEX, "");
 		const index = string.indexOf(cleanString);
 		const { success } = v.safeParse(emailSchema, cleanString);
 		if (success) {
@@ -852,7 +852,7 @@ function createMDXComponent(variant, properties) {
 			returnString = `<InternalLink uuid="${uuid}"${content != null && content !== "" ? ` content="${content}"` : ""}>${text}</InternalLink>`;
 			break;
 		case "externalLink":
-			returnString = `<ExternalLink href="${href == null ? "#" : transformPermanentIdentificationUrl$1(href)}"${content != null && content !== "" ? ` content="${content}"` : ""}>${text}</ExternalLink>`;
+			returnString = `<ExternalLink href="${href == null ? "#" : transformPermanentIdentificationUrl(href)}"${content != null && content !== "" ? ` content="${content}"` : ""}>${text}</ExternalLink>`;
 			break;
 		case "documentLink":
 			returnString = String.raw`<ExternalLink href="https:\/\/ochre.lib.uchicago.edu/ochre/v2/ochre.php?uuid=${uuid}&load"${content != null && content !== "" ? ` content="${content}"` : ""}>${text}</ExternalLink>`;
@@ -1426,6 +1426,7 @@ function parseBaseItem(category, rawItem, options) {
 		category,
 		belongsTo: null,
 		metadata: null,
+		persistentUrl: null,
 		publicationDateTime: parseOptionalDate(rawItem.publicationDateTime),
 		context: rawItem.context == null ? null : parseContext(rawItem.context),
 		date: parseOptionalDateLike(rawItem.date),
@@ -1502,7 +1503,7 @@ function parseImage(rawImage, options) {
 	return {
 		publicationDateTime: parseOptionalDate(rawImage.publicationDateTime),
 		identification: rawImage.identification == null ? null : parseIdentification(rawImage.identification, options),
-		href: rawImage.href ?? null,
+		href: parseHref(rawImage.href),
 		htmlImgSrcPrefix: rawImage.htmlImgSrcPrefix ?? null,
 		height: parseNumber(rawImage.height),
 		width: parseNumber(rawImage.width),
@@ -1510,6 +1511,9 @@ function parseImage(rawImage, options) {
 		base64: rawImage.payload ?? null
 	};
 }
+function parseHref(href) {
+	return href == null ? null : transformPermanentIdentificationUrl(href);
+}
 function parseCoordinatesSource(source, options) {
 	if (source == null) return null;
 	switch (source.context) {
@@ -2439,7 +2443,8 @@ function parseItem(rawData, options) {
 			uuid: rawOchre.uuidBelongsTo,
 			abbreviation: rawOchre.belongsTo
 		},
-		metadata: parseMetadata(rawOchre, parserOptions, defaultLanguage)
+		metadata: parseMetadata(rawOchre, parserOptions, defaultLanguage),
+		persistentUrl: rawOchre.persistentUrl ?? null
 	};
 }
 //#endregion
@@ -3213,7 +3218,10 @@ const XMLItemLinks = v.object({
 	text: v.optional(v.array(XMLText, "XMLItemLinks: text is array of XMLText")),
 	set: v.optional(v.array(XMLSet, "XMLItemLinks: set is array of XMLSet"))
 }, "XMLItemLinks: Shape error");
-const XMLItemLinksData = v.object({ result: v.object({ ochre: v.object({ items: XMLItemLinks }, "XMLItemLinksData: ochre") }) }, "XMLItemLinksData: Shape error");
+const XMLItemLinksData = v.object({ result: v.object({ ochre: v.object({
+	payload: v.optional(v.string("XMLItemLinksData: payload is string and optional")),
+	items: v.optional(XMLItemLinks)
+}, "XMLItemLinksData: ochre") }) }, "XMLItemLinksData: Shape error");
 const XMLGallery = v.object({
 	payload: v.optional(v.string("XMLGallery: payload is string and optional")),
 	project: v.object({
@@ -5572,15 +5580,7 @@ function parseStringContent(value, options = FALLBACK_WEBSITE_OPTIONS) {
 		parseEmail: true
 	});
 }
-function parseFakeString(value) {
-	if (typeof value === "string") return value;
-	if (typeof value === "number" || typeof value === "boolean") return value.toString();
-	return "";
-}
-function parseFakeStringOrContent(value, options = FALLBACK_WEBSITE_OPTIONS) {
-	return parseStringContent(value, options);
-}
-function transformPermanentIdentificationUrl(url) {
+function transformPermanentIdentificationUrlToItemLink(url) {
 	return url.replace("https://pi.lib.uchicago.edu/1001/org/ochre/", "/item/");
 }
 function parseLicense(availability) {
@@ -5609,7 +5609,7 @@ const TRAILING_SLASH_REGEX = /\/$/;
 function formatXMLWebsiteResourceMetadata(resource) {
 	const metadata = [`label “${parseStringContent(resource.identification.label)}”`, `uuid “${resource.uuid}”`];
 	if (resource.slug != null) metadata.push(`slug “${resource.slug}”`);
-	if (resource.identification.abbreviation != null) metadata.push(`abbreviation “${parseFakeStringOrContent(resource.identification.abbreviation)}”`);
+	if (resource.identification.abbreviation != null) metadata.push(`abbreviation “${parseStringContent(resource.identification.abbreviation)}”`);
 	return metadata.join(", ");
 }
 function formatComponentError(message, componentName, elementResource) {
@@ -5695,9 +5695,10 @@ function parseStylesheets(styles) {
 		const defaultStyles = [];
 		for (const [label, value] of Object.entries(style)) {
 			if (label === "variableUuid" || label === "valueUuid" || label === "category" || label === "payload" || label === "content") continue;
-			defaultStyles.push({
+			const valueString = value?.toString();
+			if (valueString != null) defaultStyles.push({
 				label,
-				value: parseFakeString(value)
+				value: valueString
 			});
 		}
 		const stylesByViewport = {
@@ -5756,7 +5757,7 @@ function parseWebElementProperties(componentProperty, elementResource, options)
 		case "advanced-search": {
 			const boundElementPropertyUuid = getPropertyByLabelName(componentProperty.properties, "bound-element")?.values[0]?.uuid ?? null;
 			const linkToProperty = getPropertyByLabelName(componentProperty.properties, "link-to");
-			const href = linkToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrl(linkToProperty.values[0].href) : linkToProperty?.values[0]?.slug ?? null;
+			const href = linkToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrlToItemLink(linkToProperty.values[0].href) : linkToProperty?.values[0]?.slug ?? null;
 			if (boundElementPropertyUuid == null && href == null) throw new Error(formatComponentError("Bound element or href not found", componentName, elementResource));
 			properties = {
 				component: "advanced-search",
@@ -5835,10 +5836,10 @@ function parseWebElementProperties(componentProperty, elementResource, options)
 			variant ??= "default";
 			let isExternal = false;
 			const navigateToProperty = getPropertyByLabelName(componentProperty.properties, "navigate-to");
-			let href = navigateToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrl(navigateToProperty.values[0].href) : navigateToProperty?.values[0]?.slug ?? null;
+			let href = navigateToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrlToItemLink(navigateToProperty.values[0].href) : navigateToProperty?.values[0]?.slug ?? null;
 			if (href === null) {
 				const linkToProperty = getPropertyByLabelName(componentProperty.properties, "link-to");
-				href = linkToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrl(linkToProperty.values[0].href) : linkToProperty?.values[0]?.slug ?? null;
+				href = linkToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrlToItemLink(linkToProperty.values[0].href) : linkToProperty?.values[0]?.slug ?? null;
 				if (href === null) throw new Error(formatComponentError("Properties “navigate-to” or “link-to” not found", componentName, elementResource));
 				else isExternal = true;
 			}
@@ -5969,7 +5970,7 @@ function parseWebElementProperties(componentProperty, elementResource, options)
 			const width = getPropertyValueContentByLabelName(componentProperty.properties, "width");
 			properties = {
 				component: "iframe",
-				href: transformPermanentIdentificationUrl(webpageLink.href),
+				href: transformPermanentIdentificationUrlToItemLink(webpageLink.href),
 				height: height?.toString() ?? null,
 				width: width?.toString() ?? null
 			};
@@ -6215,7 +6216,7 @@ function parseWebElementProperties(componentProperty, elementResource, options)
 			queryVariant ??= "submit";
 			const boundElementUuid = getPropertyByLabelName(componentProperty.properties, "bound-element")?.values[0]?.uuid ?? null;
 			const linkToProperty = getPropertyByLabelName(componentProperty.properties, "link-to");
-			const href = linkToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrl(linkToProperty.values[0].href) : linkToProperty?.values[0]?.slug ?? null;
+			const href = linkToProperty?.values[0]?.href != null ? transformPermanentIdentificationUrlToItemLink(linkToProperty.values[0].href) : linkToProperty?.values[0]?.slug ?? null;
 			if (!boundElementUuid && !href) throw new Error(formatComponentError("Bound element or href not found", componentName, elementResource));
 			let placeholder = getPropertyValueContentByLabelName(componentProperty.properties, "placeholder-text");
 			placeholder ??= null;
@@ -6472,7 +6473,7 @@ function parseWebSegment(segmentResource, options, slugPrefix) {
 	const webpageProperties = segmentResource.properties ? parseProperties(segmentResource.properties, options) : [];
 	if (webpageProperties.length === 0 || getPropertyValueContentByLabelName(webpageProperties, "presentation") !== "segment") return null;
 	const identification = parseIdentification(segmentResource.identification, options);
-	const slug = segmentResource.identification.abbreviation != null ? parseFakeStringOrContent(segmentResource.identification.abbreviation, options) : null;
+	const slug = segmentResource.identification.abbreviation != null ? parseStringContent(segmentResource.identification.abbreviation, options) : null;
 	if (slug == null) throw new Error(`Slug not found for segment (${formatXMLWebsiteResourceMetadata(segmentResource)})`);
 	const returnSegment = {
 		uuid: segmentResource.uuid,
@@ -6509,7 +6510,7 @@ function parseWebSegmentItem(segmentItemResource, options, slugPrefix) {
 	const webpageProperties = segmentItemResource.properties ? parseProperties(segmentItemResource.properties, options) : [];
 	if (webpageProperties.length === 0 || getPropertyValueContentByLabelName(webpageProperties, "presentation") !== "segment-item") return null;
 	const identification = parseIdentification(segmentItemResource.identification, options);
-	const slug = segmentItemResource.identification.abbreviation != null ? parseFakeStringOrContent(segmentItemResource.identification.abbreviation, options) : null;
+	const slug = segmentItemResource.identification.abbreviation != null ? parseStringContent(segmentItemResource.identification.abbreviation, options) : null;
 	if (slug == null) throw new Error(`Slug not found for segment item (${formatXMLWebsiteResourceMetadata(segmentItemResource)})`);
 	const returnSegmentItem = {
 		uuid: segmentItemResource.uuid,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -50,11 +50,11 @@
   },
   "devDependencies": {
     "@antfu/eslint-config": "^8.2.0",
-    "@types/node": "^24.12.2",
-    "bumpp": "^11.0.1",
+    "@types/node": "^24.12.3",
+    "bumpp": "^11.1.0",
     "eslint": "^10.3.0",
     "prettier": "^3.8.3",
-    "tsdown": "^0.21.10",
+    "tsdown": "^0.22.0",
     "typescript": "^6.0.3",
     "vitest": "^4.1.5"
   },