ochre-sdk 1.1.5 → 1.2.0

package/dist/xml/schemas.mjs

@@ -68,6 +68,7 @@ const XMLContent = v.object({ content: v.array(v.object({
 	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 XMLOptionalContent = v.optional(v.pipe(v.union([XMLContent, v.object({ payload: v.literal("", "XMLOptionalContent: payload is an empty string") }, "XMLOptionalContent: empty element is object with empty payload")], "XMLOptionalContent: content is XMLContent or an empty element"), v.transform((content) => "content" in content ? content : void 0)));
 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)));
 const XMLBoolean = v.pipe(v.union([v.string("XMLBoolean: string is string and required"), XMLString]), v.check((value) => {
@@ -152,7 +153,7 @@ const XMLEvent = v.object({
 		uuid: v.pipe(v.string("XMLEvent: uuid is string and required"), v.check(isPseudoUuid, "XMLEvent: uuid is not a valid pseudo-UUID")),
 		publicationDateTime: v.optional(customDateTime("XMLEvent: publicationDateTime is not a valid datetime"))
 	}, "XMLEvent: location is object with uuid")),
-	comment: v.optional(XMLContent),
+	comment: XMLOptionalContent,
 	label: XMLContent,
 	other: v.optional(v.object({
 		...XMLContent.entries,
@@ -267,7 +268,8 @@ const XMLProperty = v.lazy(() => v.object({
 		href: v.optional(v.string("XMLProperty: href is string and optional")),
 		payload: v.optional(v.string("XMLProperty: payload is string and optional"))
 	}), "XMLProperty: value is array of objects with payload")),
-	comment: v.optional(XMLContent),
+	comment: XMLOptionalContent,
+	styleProperties: v.optional(v.object({ payload: v.string("XMLProperty: styleProperties payload is string and required") }, "XMLProperty: styleProperties is object with payload")),
 	property: v.optional(v.array(XMLProperty, "XMLProperty: property is array of XMLProperty"))
 }, "XMLProperty: Shape error"));
 /**
@@ -289,7 +291,7 @@ const XMLBaseItem = v.object({
 	identification: v.optional(XMLIdentification, { label: { content: [] } }),
 	context: v.optional(XMLContext),
 	creators: v.optional(v.object({ creator: v.array(v.lazy(() => XMLPerson)) }, "XMLBaseItem: creators is object with creator array of XMLPerson")),
-	description: v.optional(XMLContent),
+	description: XMLOptionalContent,
 	events: v.optional(v.object({ event: v.array(XMLEvent) }, "XMLBaseItem: events is object with event array of XMLEvent"))
 }, "XMLBaseItem: Shape error");
 const XMLLinkedBaseItem = v.object({
@@ -433,6 +435,12 @@ const XMLTree = v.object({
 		set: v.optional(v.array(v.lazy(() => XMLSet)))
 	}))
 }, "XMLTree: Shape error");
+const XMLSetStyle = v.object({
+	content: v.optional(XMLContent.entries.content),
+	date: v.optional(customDateTime("XMLSetStyle: date is not a valid datetime")),
+	authors: v.optional(v.object({ author: v.array(v.lazy(() => XMLPerson)) }, "XMLSetStyle: authors is object with author array of XMLPerson")),
+	properties: v.optional(v.object({ property: v.array(XMLProperty) }, "XMLSetStyle: properties is object with property array of XMLProperty"))
+}, "XMLSetStyle: Shape error");
 const XMLSet = v.object({
 	...XMLBaseItem.entries,
 	type: v.optional(v.string("XMLSet: type is string and optional")),
@@ -446,6 +454,7 @@ const XMLSet = v.object({
 	])),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
+	styles: v.optional(v.object({ style: v.array(XMLSetStyle) }, "XMLSet: styles is object with style array of XMLSetStyle")),
 	items: v.optional(v.object({
 		tree: v.optional(v.array(v.lazy(() => XMLTree))),
 		bibliography: v.optional(v.array(v.lazy(() => XMLBibliography))),
@@ -635,7 +644,7 @@ const XMLResource = v.object({
 	width: XMLOptionalNumber,
 	image: v.optional(XMLImage),
 	imagemap: v.optional(XMLImageMap),
-	document: v.optional(XMLContent),
+	document: XMLOptionalContent,
 	coordinates: v.optional(XMLCoordinates),
 	periods: v.optional(v.object({ period: v.array(XMLPeriod) })),
 	links: v.optional(v.lazy(() => XMLLink)),
@@ -710,7 +719,7 @@ const XMLWebsiteContextLevel = v.intersect([XMLString, v.object({
 }, "XMLWebsiteContextLevel: Shape error")]);
 const XMLWebsiteContextItemEntries = {
 	identification: XMLIdentification,
-	description: v.optional(XMLContent),
+	description: XMLOptionalContent,
 	levels: v.optional(v.object({ level: v.array(XMLWebsiteContextLevel) }, "XMLWebsiteContextItem: levels is object with level"))
 };
 const XMLWebsiteContextItem = v.object(XMLWebsiteContextItemEntries, "XMLWebsiteContextItem: Shape error");
@@ -806,7 +815,7 @@ const XMLWebsiteResource = v.lazy(() => v.object({
 	width: XMLOptionalNumber,
 	image: v.optional(XMLImage),
 	imagemap: v.optional(XMLImageMap),
-	document: v.optional(XMLContent),
+	document: XMLOptionalContent,
 	coordinates: v.optional(XMLCoordinates),
 	periods: v.optional(v.object({ period: v.array(XMLPeriod) })),
 	links: v.optional(v.lazy(() => XMLLink)),
@@ -919,6 +928,20 @@ const XMLSetItems = v.intersect([XMLItemLinks, v.object({
 	pageSize: XMLNumber
 }, "XMLSetItems: Shape error")]);
 const XMLSetItemsData = v.object({ result: v.object({ ochre: v.object({ items: XMLSetItems }, "XMLSetItemsData: ochre") }) }, "XMLSetItemsData: Shape error");
+const XMLSetItemLocation = v.object({
+	uuid: v.string("XMLSetItemLocation: uuid is string and required"),
+	category: v.string("XMLSetItemLocation: category is string and required"),
+	identification: XMLIdentification,
+	coordinates: v.optional(XMLCoordinates),
+	value: v.optional(v.array(v.object({
+		variable: v.string("XMLSetItemLocation: value variable is string and required"),
+		uuid: v.string("XMLSetItemLocation: value uuid is string and required")
+	}, "XMLSetItemLocation: value is object with variable and uuid")))
+}, "XMLSetItemLocation: Shape error");
+const XMLSetItemLocationsData = v.object({ result: v.object({ ochre: v.object({ items: v.object({
+	totalCount: XMLNumber,
+	itemLocation: v.optional(v.array(XMLSetItemLocation, "XMLSetItemLocationsData: itemLocation is array of XMLSetItemLocation"))
+}, "XMLSetItemLocationsData: items is object with totalCount") }, "XMLSetItemLocationsData: ochre") }) }, "XMLSetItemLocationsData: Shape error");
 const XMLData = v.object({ result: v.object({ ochre: v.intersect([v.object({
 	uuid: v.pipe(v.string("XMLData: uuid is string and required"), v.check(isPseudoUuid, "XMLData: uuid is not a valid pseudo-UUID")),
 	belongsTo: v.string("XMLData: belongsTo is string and required"),
@@ -939,4 +962,4 @@ const XMLWebsiteData = v.object({ result: v.object({ ochre: v.object({
 	tree: v.array(XMLWebsiteTree)
 }, "XMLWebsiteData: ochre is object with website tree") }, "XMLWebsiteData: result is object with ochre") }, "XMLWebsiteData: Shape error");
 //#endregion
-export { XMLData, XMLDataItem, XMLGalleryData, XMLItemLinksData, XMLLink, XMLSetItemsData, XMLWebsiteData };
+export { XMLData, XMLDataItem, XMLGalleryData, XMLItemLinksData, XMLLink, XMLSetItemLocationsData, XMLSetItemsData, XMLWebsiteData };

package/dist/xml/types.d.mts

@@ -1,5 +1,5 @@
 declare namespace types_d_exports {
-  export { XMLBaseItem, XMLBibliography, 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, XMLObservation, 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 };
+  export { XMLBaseItem, XMLBibliography, 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, XMLObservation, XMLPeriod, XMLPerson, XMLProperty, XMLPropertyRelation, XMLPropertyValue, XMLPropertyVariable, XMLRecursiveItemCategory, XMLResource, XMLRichTextEnvelope, XMLSection, XMLSet, XMLSetItemLocation, XMLSetItemLocationsData, XMLSetItems, XMLSetItemsData, XMLSetStyle, XMLSimplifiedProperty, XMLSpatialUnit, XMLString, XMLText, XMLTree, XMLWebsiteContext, XMLWebsiteContextItem, XMLWebsiteContextLevel, XMLWebsiteData, XMLWebsiteFilterContext, XMLWebsiteFilterContextItem, XMLWebsiteOptions, XMLWebsiteProperties, XMLWebsiteResource, XMLWebsiteResourceGroup, XMLWebsiteResourceItem, XMLWebsiteScope, XMLWebsiteSegment, XMLWebsiteStyle, XMLWebsiteTree };
 }
 export type XMLItemCategory = "tree" | "bibliography" | "spatialUnit" | "concept" | "period" | "person" | "propertyVariable" | "variable" | "propertyValue" | "value" | "text" | "resource" | "set";
 export type XMLRecursiveItemCategory = Exclude<XMLItemCategory, "tree" | "person" | "propertyVariable" | "propertyValue" | "set">;
@@ -215,6 +215,9 @@ export type XMLProperty = {
     payload?: string;
   }>;
   comment?: XMLContent;
+  styleProperties?: {
+    payload: string;
+  };
   property?: Array<XMLProperty>;
 };
 /**
@@ -741,6 +744,15 @@ export type XMLWebsiteTree = Omit<XMLTree, "items" | "properties"> & {
     resource?: Array<XMLWebsiteResourceItem>;
   };
 };
+export type XMLSetStyle = Partial<XMLContent> & {
+  date?: Date;
+  authors?: {
+    author: Array<XMLPerson>;
+  };
+  properties?: {
+    property: Array<XMLProperty>;
+  };
+};
 export type XMLSet = XMLBaseItem & {
   type?: string;
   suppressBlanks?: boolean;
@@ -753,6 +765,9 @@ export type XMLSet = XMLBaseItem & {
   properties?: {
     property: Array<XMLProperty>;
   };
+  styles?: {
+    style: Array<XMLSetStyle>;
+  };
   items?: {
     tree?: Array<XMLTree>;
     bibliography?: Array<XMLBibliography>;
@@ -874,6 +889,26 @@ export type XMLSetItemsData = {
     };
   };
 };
+export type XMLSetItemLocation = {
+  uuid: string;
+  category: string;
+  identification: XMLIdentification;
+  coordinates?: XMLCoordinates;
+  value?: Array<{
+    variable: string;
+    uuid: string;
+  }>;
+};
+export type XMLSetItemLocationsData = {
+  result: {
+    ochre: {
+      items: {
+        totalCount: number;
+        itemLocation?: Array<XMLSetItemLocation>;
+      };
+    };
+  };
+};
 export type XMLData = {
   result: {
     ochre: {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "ochre-sdk",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
-  "author": "Firat Ciftci <firatciftci@uchicago.edu> (https://digitalculture.uchicago.edu)",
+  "author": "Firat Ciftci <firatciftci@uchicago.edu> (https://corpus.uchicago.edu)",
   "homepage": "https://github.com/uchicago-digitalculture-webdev/ochre-sdk",
   "bugs": {
     "url": "https://github.com/uchicago-digitalculture-webdev/ochre-sdk/issues"
@@ -46,7 +46,7 @@
   ],
   "dependencies": {
     "fast-equals": "^6.0.4",
-    "fast-xml-parser": "^5.11.1",
+    "fast-xml-parser": "^5.11.2",
     "valibot": "^1.5.0"
   },
   "devDependencies": {
@@ -56,12 +56,12 @@
     "eslint": "^10.11.0",
     "eslint-plugin-erasable-syntax-only": "^0.7.2",
     "eslint-plugin-slop": "^0.1.3",
-    "eslint-plugin-sonarjs": "^4.2.1",
-    "knip": "^6.38.0",
-    "oxfmt": "^0.70.0",
+    "eslint-plugin-sonarjs": "^4.2.2",
+    "knip": "^6.39.0",
+    "oxfmt": "^0.71.0",
     "tsdown": "^0.23.0",
     "typescript": "^6.0.3",
-    "vitest": "^5.0.2"
+    "vitest": "^5.0.3"
   },
   "scripts": {
     "dev": "tsdown src/index.ts --watch",