ochre-sdk 1.0.71 → 1.0.72

package/dist/parsers/string.mjs

@@ -468,11 +468,15 @@ function parseXMLContent(item, options) {
 }
 function parseXMLContentItem(contentItem, options) {
 	const rawMDXBlocks = [];
-	const richText = parseNestedStringItems(contentItem.string, contentItem, {
+	const nestedRichText = parseNestedStringItems(contentItem.string, contentItem, {
 		...options,
 		rendering: "rich",
 		rawMDXBlocks
 	});
+	const richText = hasRichTextEnvelope(contentItem) ? renderRichTextItem(contentItem, nestedRichText, contentItem, {
+		...options,
+		rendering: "rich"
+	}) : nestedRichText;
 	let serializedRichText = serializeMDXContent(richText);
 	for (const [index, rawMDXBlock] of rawMDXBlocks.entries()) serializedRichText = serializedRichText.replaceAll(`${RAW_MDX_BLOCK_PLACEHOLDER_PREFIX}${index}${RAW_MDX_BLOCK_PLACEHOLDER_SUFFIX}`, () => rawMDXBlock);
 	return {

package/dist/xml/schemas.mjs

@@ -42,19 +42,23 @@ const ITEM_CATEGORIES = [
 	"set"
 ];
 const XMLItemCategory = v.picklist(ITEM_CATEGORIES);
+const XMLRichTextEnvelope = {
+	links: v.optional(v.lazy(() => XMLLink)),
+	properties: v.optional(v.object({ property: v.array(v.lazy(() => XMLProperty), "XMLRichTextEnvelope: properties is array of XMLProperty") })),
+	annotation: v.optional(v.string("XMLRichTextEnvelope: annotation is string and optional"))
+};
 const XMLString = v.lazy(() => v.object({
 	payload: v.optional(v.string("XMLString: payload is string and optional")),
 	rend: v.optional(v.string("XMLString: rend is string and optional")),
 	whitespace: v.optional(v.string("XMLString: whitespace is string and optional")),
-	links: v.optional(v.lazy(() => XMLLink)),
-	properties: v.optional(v.object({ property: v.array(v.lazy(() => XMLProperty), "XMLString: properties is array of XMLProperty") })),
-	annotation: v.optional(v.string("XMLString: annotation is string and optional")),
+	...XMLRichTextEnvelope,
 	string: v.optional(v.array(XMLString, "XMLString: string is array of XMLString"))
 }, "XMLString: Shape error"));
 const XMLContent = v.object({ content: v.array(v.object({
 	string: v.array(XMLString),
 	title: v.optional(v.string("XMLContent: title is string and optional")),
-	lang: v.string("XMLContent: lang is string and required")
+	lang: v.string("XMLContent: lang is string and required"),
+	...XMLRichTextEnvelope
 }), "XMLContent: content is array of object with string, title, and lang") }, "XMLContent: Shape error");
 const XMLNumber = v.pipe(v.union([v.string("XMLNumber: string is string and required"), XMLString]), v.check(isXMLNumber, "XMLNumber: string is not a number"), v.transform(parseXMLNumber));
 const XMLOptionalNumber = v.optional(v.pipe(v.union([v.string("XMLNumber: string is string and required"), XMLString]), v.check(isOptionalXMLNumber, "XMLNumber: string is not a number"), v.transform(parseOptionalXMLNumber)));

package/dist/xml/types.d.mts

@@ -2,19 +2,26 @@
 type XMLItemCategory = "tree" | "bibliography" | "spatialUnit" | "concept" | "period" | "person" | "propertyVariable" | "variable" | "propertyValue" | "value" | "text" | "resource" | "set";
 type XMLHeadingItemCategory = Exclude<XMLItemCategory, "tree" | "bibliography" | "spatialUnit" | "concept" | "period">;
 type XMLRecursiveItemCategory = Exclude<XMLItemCategory, "tree" | "person" | "propertyVariable" | "propertyValue" | "set">;
-type XMLString = {
-  payload?: string;
-  rend?: string;
-  whitespace?: string;
+/**
+ * Rich text envelope shared by `<string>` and `<content>` nodes, carrying the
+ * inline links, presentation properties and annotation identifier that turn a
+ * span of text into an annotation.
+ */
+type XMLRichTextEnvelope = {
   links?: XMLLink;
   properties?: {
     property: Array<XMLProperty>;
   };
   annotation?: string;
+};
+type XMLString = XMLRichTextEnvelope & {
+  payload?: string;
+  rend?: string;
+  whitespace?: string;
   string?: Array<XMLString>;
 };
 type XMLContent = {
-  content: Array<{
+  content: Array<XMLRichTextEnvelope & {
     string: Array<XMLString>;
     lang: string;
     title?: string;
@@ -956,4 +963,4 @@ type XMLWebsiteData = {
   };
 };
 //#endregion
-export { XMLBaseItem, XMLBibliography, XMLBoolean, XMLConcept, XMLContent, XMLContext, XMLContextGroup, XMLContextItem, XMLContextValue, XMLCoordinate, XMLCoordinates, XMLCoordinatesSource, XMLData, XMLDataItem, XMLDictionaryUnit, XMLEmptyContext, XMLEvent, XMLGallery, XMLGalleryData, XMLHeading, XMLHeadingItemCategory, XMLIdentification, XMLImage, XMLImageMap, XMLImageMapArea, XMLInterpretation, XMLItemCategory, XMLItemLinks, XMLItemLinksData, XMLLicense, XMLLink, XMLLinkedBaseItem, XMLLinkedBibliography, XMLLinkedConcept, XMLLinkedPeriod, XMLLinkedPerson, XMLLinkedPropertyValue, XMLLinkedPropertyVariable, XMLLinkedResource, XMLLinkedSet, XMLLinkedSpatialUnit, XMLLinkedText, XMLLinkedTree, XMLMetadata, XMLNote, XMLNumber, XMLObservation, XMLOcr, XMLOcrMatch, XMLOcrMatchItem, XMLOcrMatchesData, XMLOcrPage, XMLOcrString, XMLOcrTextBlock, XMLOcrTextLine, XMLPeriod, XMLPerson, XMLProperty, XMLPropertyRelation, XMLPropertyValue, XMLPropertyVariable, XMLRecursiveItemCategory, XMLResource, XMLSection, XMLSet, XMLSetItems, XMLSetItemsData, XMLSimplifiedProperty, XMLSpatialUnit, XMLString, XMLText, XMLTree, XMLWebsiteContext, XMLWebsiteContextItem, XMLWebsiteContextLevel, XMLWebsiteData, XMLWebsiteFilterContext, XMLWebsiteFilterContextItem, XMLWebsiteOptions, XMLWebsiteProperties, XMLWebsiteResource, XMLWebsiteResourceGroup, XMLWebsiteResourceItem, XMLWebsiteScope, XMLWebsiteSegment, XMLWebsiteStyle, XMLWebsiteTree };
+export { XMLBaseItem, XMLBibliography, XMLBoolean, XMLConcept, XMLContent, XMLContext, XMLContextGroup, XMLContextItem, XMLContextValue, XMLCoordinate, XMLCoordinates, XMLCoordinatesSource, XMLData, XMLDataItem, XMLDictionaryUnit, XMLEmptyContext, XMLEvent, XMLGallery, XMLGalleryData, XMLHeading, XMLHeadingItemCategory, XMLIdentification, XMLImage, XMLImageMap, XMLImageMapArea, XMLInterpretation, XMLItemCategory, XMLItemLinks, XMLItemLinksData, XMLLicense, XMLLink, XMLLinkedBaseItem, XMLLinkedBibliography, XMLLinkedConcept, XMLLinkedPeriod, XMLLinkedPerson, XMLLinkedPropertyValue, XMLLinkedPropertyVariable, XMLLinkedResource, XMLLinkedSet, XMLLinkedSpatialUnit, XMLLinkedText, XMLLinkedTree, XMLMetadata, XMLNote, XMLNumber, XMLObservation, XMLOcr, XMLOcrMatch, XMLOcrMatchItem, XMLOcrMatchesData, XMLOcrPage, XMLOcrString, XMLOcrTextBlock, XMLOcrTextLine, XMLPeriod, XMLPerson, XMLProperty, XMLPropertyRelation, XMLPropertyValue, XMLPropertyVariable, XMLRecursiveItemCategory, XMLResource, XMLRichTextEnvelope, XMLSection, XMLSet, XMLSetItems, XMLSetItemsData, XMLSimplifiedProperty, XMLSpatialUnit, XMLString, XMLText, XMLTree, XMLWebsiteContext, XMLWebsiteContextItem, XMLWebsiteContextLevel, XMLWebsiteData, XMLWebsiteFilterContext, XMLWebsiteFilterContextItem, XMLWebsiteOptions, XMLWebsiteProperties, XMLWebsiteResource, XMLWebsiteResourceGroup, XMLWebsiteResourceItem, XMLWebsiteScope, XMLWebsiteSegment, XMLWebsiteStyle, XMLWebsiteTree };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "1.0.71",
+  "version": "1.0.72",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -56,7 +56,7 @@
     "bumpp": "^12.1.1",
     "eslint": "^10.8.0",
     "knip": "^6.31.0",
-    "oxfmt": "^0.61.0",
+    "oxfmt": "^0.62.0",
     "tsdown": "^0.22.14",
     "typescript": "^6.0.3",
     "vitest": "^4.1.10"