ochre-sdk 1.0.15 → 1.0.17

package/dist/parsers/mdx.d.mts

@@ -1,4 +1,5 @@
 //#region src/parsers/mdx.d.ts
 declare function serializeMDXText(value: string): string;
+declare function serializeMDXContent(value: string): string;
 //#endregion
-export { serializeMDXText };
+export { serializeMDXContent, serializeMDXText };

package/dist/parsers/mdx.mjs

@@ -1,9 +1,22 @@
 //#region src/parsers/mdx.ts
 const MDX_LITERAL_EXPRESSION_REGEX = /[!#*<>[\]_`{|}~]/;
 const MDX_LITERAL_BLOCK_REGEX = /(?:^|\n)[\t ]*(?:import|export|[+>-]|\d+[).])(?:[\t ]|$)/;
+const MDX_MULTIPLE_SPACES_REGEX = / {2,}/g;
+const MDX_INLINE_BOUNDARY_PATTERN = "(?:Annotation|ExternalLink|InlineImage|InternalLink|TooltipSpan|em|strong|u)";
+const MDX_INLINE_BOUNDARY_SPACES_REGEX = new RegExp(String.raw`(\}|<\/${MDX_INLINE_BOUNDARY_PATTERN}>|\/>)([\t ]+)(?=\{|<\/?${MDX_INLINE_BOUNDARY_PATTERN}\b)`, "g");
+const MDX_INLINE_BOUNDARY_REGEX = new RegExp(String.raw`(?:\}[\t ]*|<\/${MDX_INLINE_BOUNDARY_PATTERN}>|\/>)(?=\{|<\/?${MDX_INLINE_BOUNDARY_PATTERN}\b)`);
+function preserveMultipleSpaces(value) {
+	return value.replaceAll(MDX_MULTIPLE_SPACES_REGEX, (spaces) => `${spaces.slice(0, 1)}${"\xA0".repeat(spaces.length - 1)}`);
+}
 function serializeMDXText(value) {
-	if (value === "" || !MDX_LITERAL_EXPRESSION_REGEX.test(value) && !MDX_LITERAL_BLOCK_REGEX.test(value)) return value;
-	return `{${JSON.stringify(value)}}`;
+	const displaySafeValue = preserveMultipleSpaces(value);
+	if (displaySafeValue === "" || !(displaySafeValue !== value) && !MDX_LITERAL_EXPRESSION_REGEX.test(displaySafeValue) && !MDX_LITERAL_BLOCK_REGEX.test(displaySafeValue)) return displaySafeValue;
+	return `{${JSON.stringify(displaySafeValue)}}`;
+}
+function serializeMDXContent(value) {
+	const content = value.replaceAll(MDX_INLINE_BOUNDARY_SPACES_REGEX, (_, previousBoundary, spaces) => `${previousBoundary}{${JSON.stringify(preserveMultipleSpaces(spaces))}}`);
+	if (!MDX_INLINE_BOUNDARY_REGEX.test(content)) return content;
+	return content.endsWith("\n") ? `<>\n${content}</>` : `<>\n${content}\n</>`;
 }
 //#endregion
-export { serializeMDXText };
+export { serializeMDXContent, serializeMDXText };

package/dist/parsers/string.mjs

@@ -1,5 +1,5 @@
 import { TEXT_ANNOTATION_UUID } from "../constants.mjs";
-import { serializeMDXText } from "./mdx.mjs";
+import { serializeMDXContent, serializeMDXText } from "./mdx.mjs";
 import { MultilingualString } from "./multilingual.mjs";
 import { renderOptionsSchema } from "../schemas.mjs";
 import { getXMLSourceIndex } from "../xml/metadata.mjs";
@@ -63,6 +63,12 @@ function applyMDXRenderElements(contentString, options) {
 	}
 	return result;
 }
+function applyNewlineWhitespace(contentString, whitespace, rendering) {
+	if (whitespace == null) return contentString;
+	if (!whitespace.split(" ").includes("newline")) return contentString;
+	if (rendering === "rich") return contentString.trim() === "***" ? `${contentString}\n` : `<br />\n${contentString}`;
+	return `\n${contentString}`;
+}
 /**
 * Parses XML string into a formatted string with rendering options
 *
@@ -76,7 +82,7 @@ function applyMDXRenderElements(contentString, options) {
 function parseXMLStringVariant(string, options) {
 	let returnString = parseXMLStringPayload(string, options);
 	if (string.rend != null) returnString = parseRenderOptions(returnString, string.rend, options.rendering);
-	return returnString;
+	return applyNewlineWhitespace(returnString, string.whitespace, options.rendering);
 }
 function parseXMLStringPayload(string, options) {
 	const payload = string.payload ?? "";
@@ -232,17 +238,17 @@ function hasRichTextEnvelope(item) {
 	return item.properties?.property[0] != null || getXMLRichTextLinks(item).length > 0;
 }
 function parseXMLStringItem(item, contentItem, options) {
-	if (!(item.payload != null || item.string != null) && getXMLRichTextLinks(item).length === 0) return "";
+	if (!(item.payload != null || item.string != null) && getXMLRichTextLinks(item).length === 0) return applyNewlineWhitespace("", item.whitespace, options.rendering);
 	if (hasRichTextEnvelope(item)) {
 		let linkString = item.payload != null ? parseXMLStringPayload(item, { rendering: options.rendering }) : parseNestedStringItems(item.string ?? [], contentItem, { ...options });
 		if (item.rend != null) linkString = parseRenderOptions(linkString, item.rend, options.rendering);
-		if (options.rendering === "plain") return linkString;
+		if (options.rendering === "plain") return applyNewlineWhitespace(linkString, item.whitespace, options.rendering);
 		return renderRichTextItem(item, linkString, contentItem, options);
 	}
 	if (item.payload != null) return parseXMLStringVariant(item, { rendering: options.rendering });
 	let result = parseNestedStringItems(item.string ?? [], contentItem, options);
 	if (item.rend != null) result = parseRenderOptions(result, item.rend, options.rendering);
-	return result;
+	return applyNewlineWhitespace(result, item.whitespace, options.rendering);
 }
 function parseNestedStringItems(items, contentItem, options) {
 	let result = "";
@@ -292,7 +298,7 @@ function renderRichTextItem(item, linkString, contentItem, options) {
 	const { languages, rendering } = options;
 	const annotationMetadata = extractAnnotationMetadata(item, { language: contentItem.lang });
 	const links = getXMLRichTextLinks(item);
-	if (links.length === 0) return wrapWithTextStyling(linkString, annotationMetadata.textStyling);
+	if (links.length === 0) return applyNewlineWhitespace(wrapWithTextStyling(linkString, annotationMetadata.textStyling), item.whitespace, rendering);
 	let result = "";
 	for (const link of links) {
 		const linkContent = link.identification != null ? "content" in link.identification.label ? parseXMLContent(link.identification.label, { languages }) : MultilingualString.create(contentItem.lang, parseXMLString(link.identification.label), languages) : MultilingualString.create(contentItem.lang, "", languages);
@@ -379,7 +385,7 @@ function renderRichTextItem(item, linkString, contentItem, options) {
 			result += component;
 		}
 	}
-	return result;
+	return applyNewlineWhitespace(result, item.whitespace, rendering);
 }
 /**
 * Parses rich text content into a formatted string with links and annotations
@@ -413,15 +419,16 @@ function parseXMLContent(item, options) {
 	return MultilingualString.empty(languages, { aliases });
 }
 function parseXMLContentItem(contentItem, options) {
+	const richText = parseNestedStringItems(contentItem.string, contentItem, {
+		...options,
+		rendering: "rich"
+	});
 	return {
 		text: parseNestedStringItems(contentItem.string, contentItem, {
 			...options,
 			rendering: "plain"
 		}),
-		richText: parseNestedStringItems(contentItem.string, contentItem, {
-			...options,
-			rendering: "rich"
-		})
+		richText: serializeMDXContent(richText)
 	};
 }
 /**

package/package.json

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