ochre-sdk 1.0.14 → 1.0.16

package/dist/parsers/string.mjs

@@ -1,7 +1,7 @@
 import { TEXT_ANNOTATION_UUID } from "../constants.mjs";
 import { serializeMDXText } from "./mdx.mjs";
 import { MultilingualString } from "./multilingual.mjs";
-import { renderOptionsSchema, whitespaceSchema } from "../schemas.mjs";
+import { renderOptionsSchema } from "../schemas.mjs";
 import { getXMLSourceIndex } from "../xml/metadata.mjs";
 import * as v from "valibot";
 //#region src/parsers/string.ts
@@ -63,49 +63,26 @@ function applyMDXRenderElements(contentString, options) {
 	}
 	return result;
 }
-/**
-* Applies whitespace options to a string (newline)
-*
-* @param contentString - The string content to modify
-* @param whitespace - Space-separated string of whitespace options
-* @param rendering - Which text rendering to produce
-* @returns String with whitespace modifications applied
-*
-* @internal
-*/
-function parseWhitespace(contentString, whitespace, rendering) {
-	let returnString = contentString;
-	const { success, output } = v.safeParse(whitespaceSchema, whitespace);
-	if (!success) return contentString;
-	for (const option of output) switch (option) {
-		case "newline":
-			if (rendering === "rich") returnString = returnString.trim() === "***" ? `${returnString}\n` : `<br />\n${returnString}`;
-			else returnString = `\n${returnString}`;
-			break;
-		case "trailing":
-			returnString = `${returnString} `;
-			break;
-		case "leading":
-			returnString = ` ${returnString}`;
-			break;
-	}
-	return returnString.replaceAll("&#39;", "'");
+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 whitespace and rendering options
+* Parses XML string into a formatted string with rendering options
 *
 * @param string - XML string to parse
 * @param options - Options for parsing
 * @param options.rendering - Which text rendering to produce
-* @returns Formatted string with whitespace and rendering options
+* @returns Formatted string with rendering options
 *
 * @internal
 */
 function parseXMLStringVariant(string, options) {
 	let returnString = parseXMLStringPayload(string, options);
 	if (string.rend != null) returnString = parseRenderOptions(returnString, string.rend, options.rendering);
-	if (string.whitespace != null) returnString = parseWhitespace(returnString, string.whitespace, options.rendering);
-	return returnString;
+	return applyNewlineWhitespace(returnString, string.whitespace, options.rendering);
 }
 function parseXMLStringPayload(string, options) {
 	const payload = string.payload ?? "";
@@ -162,9 +139,6 @@ function createMDXStringAttribute(name, value) {
 	if (value == null || value === "") return "";
 	return ` ${name}=${MDX_QUOTED_ATTRIBUTE_ESCAPE_REGEX.test(value) ? `{${JSON.stringify(value)}}` : `"${value}"`}`;
 }
-function applyWhitespaceToResult(result, whitespace, rendering) {
-	return whitespace == null ? result : parseWhitespace(result, whitespace, rendering);
-}
 function getPropertyValueUuid(property) {
 	const value = property?.value?.[0];
 	return value?.uuid == null || value.uuid === "" ? null : value.uuid;
@@ -264,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 item.whitespace == null ? "" : parseWhitespace("", item.whitespace, options.rendering);
+	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 applyWhitespaceToResult(linkString, item.whitespace, options.rendering);
+		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 applyWhitespaceToResult(result, item.whitespace, options.rendering);
+	return applyNewlineWhitespace(result, item.whitespace, options.rendering);
 }
 function parseNestedStringItems(items, contentItem, options) {
 	let result = "";
@@ -324,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 applyWhitespaceToResult(wrapWithTextStyling(linkString, annotationMetadata.textStyling), item.whitespace, rendering);
+	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);
@@ -341,7 +315,7 @@ function renderRichTextItem(item, linkString, contentItem, options) {
 						content: contentText,
 						text: linkString
 					});
-					result += applyWhitespaceToResult(component, item.whitespace, rendering);
+					result += component;
 				} else if (link.publicationDateTime != null) {
 					const component = createInternalLinkComponent({
 						uuid: getLinkStringProperty(link, "uuid"),
@@ -349,14 +323,14 @@ function renderRichTextItem(item, linkString, contentItem, options) {
 						content: contentText,
 						annotationMetadata
 					});
-					result += applyWhitespaceToResult(component, item.whitespace, rendering);
+					result += component;
 				} else {
 					const component = createMDXComponent("tooltipSpan", {
 						uuid: getLinkStringProperty(link, "uuid"),
 						text: linkString,
 						content: contentText
 					});
-					result += applyWhitespaceToResult(component, item.whitespace, rendering);
+					result += component;
 				}
 				break;
 			case "internalDocument": {
@@ -367,7 +341,7 @@ function renderRichTextItem(item, linkString, contentItem, options) {
 					annotationMetadata,
 					propertyMetadata: getFirstPropertyMetadata(item)
 				});
-				result += applyWhitespaceToResult(component, item.whitespace, rendering);
+				result += component;
 				break;
 			}
 			case "externalDocument": {
@@ -380,7 +354,7 @@ function renderRichTextItem(item, linkString, contentItem, options) {
 					text: linkString,
 					content: contentText
 				});
-				result += applyWhitespaceToResult(component, item.whitespace, rendering);
+				result += component;
 				break;
 			}
 			case "webpage": {
@@ -390,7 +364,7 @@ function renderRichTextItem(item, linkString, contentItem, options) {
 					text: linkString,
 					content: contentText
 				});
-				result += applyWhitespaceToResult(component, item.whitespace, rendering);
+				result += component;
 				break;
 			}
 		}
@@ -401,17 +375,17 @@ function renderRichTextItem(item, linkString, contentItem, options) {
 				content: contentText,
 				annotationMetadata
 			});
-			result += applyWhitespaceToResult(component, item.whitespace, rendering);
+			result += component;
 		} else {
 			const component = createMDXComponent("tooltipSpan", {
 				uuid: getLinkStringProperty(link, "uuid"),
 				text: linkString,
 				content: contentText
 			});
-			result += applyWhitespaceToResult(component, item.whitespace, rendering);
+			result += component;
 		}
 	}
-	return result;
+	return applyNewlineWhitespace(result, item.whitespace, rendering);
 }
 /**
 * Parses rich text content into a formatted string with links and annotations

package/dist/schemas.d.mts

@@ -32,11 +32,6 @@ declare const gallerySchema: v.ObjectSchema<{
  * @internal
  */
 declare const renderOptionsSchema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string[]>, v.ArraySchema<v.PicklistSchema<["bold", "italic", "underline"], undefined>, undefined>]>;
-/**
- * Schema for validating and parsing whitespace options
- * @internal
- */
-declare const whitespaceSchema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string[]>, v.ArraySchema<v.PicklistSchema<["newline", "trailing", "leading"], undefined>, undefined>]>;
 /**
  * Schema for validating the parameters for the Set property values fetching function
  * @internal
@@ -81,4 +76,4 @@ declare const setItemsParamsSchema: v.ObjectSchema<{
   readonly pageSize: v.OptionalSchema<v.GenericSchema<unknown, number>, 48>;
 }, undefined>;
 //#endregion
-export { componentSchema, gallerySchema, iso639_3Schema, renderOptionsSchema, setItemsParamsSchema, setPropertyValuesParamsSchema, uuidSchema, whitespaceSchema };
+export { componentSchema, gallerySchema, iso639_3Schema, renderOptionsSchema, setItemsParamsSchema, setPropertyValuesParamsSchema, uuidSchema };

package/dist/schemas.mjs

@@ -63,15 +63,6 @@ const renderOptionsSchema = v.pipe(v.string(), v.transform((str) => str.split("
 	"underline"
 ])));
 /**
-* Schema for validating and parsing whitespace options
-* @internal
-*/
-const whitespaceSchema = v.pipe(v.string(), v.transform((str) => str.split(" ")), v.array(v.picklist([
-	"newline",
-	"trailing",
-	"leading"
-])));
-/**
 * Schema for validating date data types
 * @internal
 */
@@ -229,4 +220,4 @@ const setItemsParamsSchema = v.object({
 	pageSize: v.optional(positiveNumber("Page size must be positive"), 48)
 });
 //#endregion
-export { componentSchema, gallerySchema, iso639_3Schema, renderOptionsSchema, setItemsParamsSchema, setPropertyValuesParamsSchema, uuidSchema, whitespaceSchema };
+export { componentSchema, gallerySchema, iso639_3Schema, renderOptionsSchema, setItemsParamsSchema, setPropertyValuesParamsSchema, uuidSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -64,8 +64,8 @@
   "scripts": {
     "dev": "tsdown src/index.ts --watch",
     "build": "tsdown",
-    "lint": "knip && eslint .",
-    "lint:fix": "knip fix && eslint . --fix",
+    "lint": "knip; eslint .",
+    "lint:fix": "knip --fix; eslint . --fix",
     "format": "prettier --check .",
     "format:fix": "prettier --write --list-different .",
     "check-types": "tsc --noEmit",