@digitalculture/ochre-sdk 0.12.18 → 0.13.0

package/dist/index.d.mts

@@ -9,10 +9,16 @@ type Data<T extends DataCategory, U extends DataCategory> = {
     abbreviation: string;
   };
   publicationDateTime: Date;
-  metadata: Metadata;
-  item: Tree<T, U> | Set<T> | Resource | SpatialUnit | Concept | Period | Bibliography | Person | PropertyValue;
+  item: Item<T, U>;
 };
+/**
+ * Represents the category of the data
+ */
 type DataCategory = "tree" | "set" | "resource" | "spatialUnit" | "concept" | "period" | "bibliography" | "person" | "propertyValue";
+/**
+ * Represents the item of the data
+ */
+type Item<T extends DataCategory, U extends DataCategory> = Tree<T, U> | Set<T> | Resource | SpatialUnit | Concept | Period | Bibliography | Person | PropertyValue;
 /**
  * Basic identification information used across multiple types
  */
@@ -79,6 +85,7 @@ type License = {
 type Person = {
   uuid: string;
   category: "person";
+  metadata: Metadata | null;
   publicationDateTime: Date | null;
   type: string | null;
   number: number | null;
@@ -273,6 +280,7 @@ type Interpretation = {
 type Resource = {
   uuid: string;
   category: "resource";
+  metadata: Metadata | null;
   publicationDateTime: Date | null;
   type: string;
   number: number;
@@ -305,6 +313,7 @@ type Resource = {
 type SpatialUnit = {
   uuid: string;
   category: "spatialUnit";
+  metadata: Metadata | null;
   publicationDateTime: Date | null;
   number: number;
   context: Context | null;
@@ -330,6 +339,7 @@ type SpatialUnit = {
 type Concept = {
   uuid: string;
   category: "concept";
+  metadata: Metadata | null;
   publicationDateTime: Date | null;
   number: number;
   license: License | null;
@@ -347,6 +357,7 @@ type Concept = {
 type Set<T extends DataCategory> = {
   uuid: string;
   category: "set";
+  metadata: Metadata | null;
   itemCategory: T;
   publicationDateTime: Date | null;
   type: string;
@@ -366,6 +377,7 @@ type Bibliography = {
   uuid: string | null;
   zoteroId: string | null;
   category: "bibliography";
+  metadata: Metadata | null;
   publicationDateTime: Date | null;
   type: string | null;
   number: number | null;
@@ -400,6 +412,7 @@ type Bibliography = {
 type Period = {
   uuid: string;
   category: "period";
+  metadata: Metadata | null;
   publicationDateTime: Date | null;
   type: string | null;
   number: number | null;
@@ -412,6 +425,7 @@ type Period = {
 type PropertyValue = {
   uuid: string;
   category: "propertyValue";
+  metadata: Metadata | null;
   number: number;
   publicationDateTime: Date | null;
   context: Context | null;
@@ -456,6 +470,7 @@ type Property<T extends PropertyValueContentType = PropertyValueContentType> = {
 type Tree<T extends DataCategory, U extends DataCategory> = {
   uuid: string;
   category: "tree";
+  metadata: Metadata | null;
   publicationDateTime: Date | null;
   type: string;
   number: number;
@@ -954,7 +969,7 @@ declare function fetchItem<T extends DataCategory, U extends DataCategory>(uuid:
     uuid: string;
     abbreviation: string;
   };
-  item: T extends "resource" ? Resource : T extends "spatialUnit" ? SpatialUnit : T extends "concept" ? Concept : T extends "period" ? Period : T extends "bibliography" ? Bibliography : T extends "person" ? Person : T extends "propertyValue" ? PropertyValue : T extends "set" ? Set<U> : T extends "tree" ? Tree<T, U> : never;
+  item: Item<T, U>;
   category: T;
 } | {
   error: string;
@@ -1225,4 +1240,4 @@ declare function filterProperties(property: Property, filter: {
   value: string | number | boolean | Date;
 }, options?: PropertyOptions): boolean;
 //#endregion
-export { Bibliography, Concept, Context, ContextItem, ContextNode, Coordinates, CoordinatesItem, Data, DataCategory, Event, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyQueryItem, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Set, SpatialUnit, Style, Tree, UuidMetadata, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebTitle, Webpage, Website, fetchByUuidMetadata, fetchGallery, fetchItem, fetchPropertyQuery, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { Bibliography, Concept, Context, ContextItem, ContextNode, Coordinates, CoordinatesItem, Data, DataCategory, Event, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyQueryItem, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Set, SpatialUnit, Style, Tree, UuidMetadata, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebTitle, Webpage, Website, fetchByUuidMetadata, fetchGallery, fetchItem, fetchPropertyQuery, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/dist/index.mjs

@@ -856,10 +856,11 @@ function parseLicense(license) {
 * @param person - Raw person data from OCHRE format
 * @returns Parsed Person object
 */
-function parsePerson(person) {
+function parsePerson(person, metadata) {
 	return {
 		uuid: person.uuid,
 		category: "person",
+		metadata: metadata ?? null,
 		publicationDateTime: person.publicationDateTime != null ? new Date(person.publicationDateTime) : null,
 		type: person.type ?? null,
 		number: person.n ?? null,
@@ -1269,10 +1270,11 @@ function parseImageMap(imageMap) {
 * @param period - Raw period data in OCHRE format
 * @returns Parsed Period object
 */
-function parsePeriod(period) {
+function parsePeriod(period, metadata) {
 	return {
 		uuid: period.uuid,
 		category: "period",
+		metadata: metadata ?? null,
 		publicationDateTime: period.publicationDateTime != null ? new Date(period.publicationDateTime) : null,
 		type: period.type ?? null,
 		number: period.n ?? null,
@@ -1297,7 +1299,7 @@ function parsePeriods(periods) {
 * @param bibliography - Raw bibliography data in OCHRE format
 * @returns Parsed Bibliography object
 */
-function parseBibliography(bibliography) {
+function parseBibliography(bibliography, metadata) {
 	let resource = null;
 	if (bibliography.source?.resource) resource = {
 		uuid: bibliography.source.resource.uuid,
@@ -1321,6 +1323,7 @@ function parseBibliography(bibliography) {
 		uuid: bibliography.uuid ?? null,
 		zoteroId: bibliography.zoteroId ?? null,
 		category: "bibliography",
+		metadata: metadata ?? null,
 		publicationDateTime: bibliography.publicationDateTime != null ? new Date(bibliography.publicationDateTime) : null,
 		type: bibliography.type ?? null,
 		number: bibliography.n ?? null,
@@ -1367,10 +1370,11 @@ function parseBibliographies(bibliographies) {
 * @param propertyValue - Raw property value data in OCHRE format
 * @returns Parsed PropertyValue object
 */
-function parsePropertyValue(propertyValue) {
+function parsePropertyValue(propertyValue, metadata) {
 	return {
 		uuid: propertyValue.uuid,
 		category: "propertyValue",
+		metadata: metadata ?? null,
 		number: propertyValue.n,
 		publicationDateTime: propertyValue.publicationDateTime ? new Date(propertyValue.publicationDateTime) : null,
 		context: propertyValue.context ? parseContext(propertyValue.context) : null,
@@ -1400,7 +1404,7 @@ function parsePropertyValues(propertyValues) {
 * @param tree - Raw tree data in OCHRE format
 * @returns Parsed Tree object or null if invalid
 */
-function parseTree(tree, itemCategory, itemSubCategory) {
+function parseTree(tree, itemCategory, itemSubCategory, metadata) {
 	if (typeof tree.items === "string") throw new TypeError("Invalid OCHRE data: Tree has no items");
 	let creators = [];
 	if (tree.creators) creators = parsePersons(Array.isArray(tree.creators.creator) ? tree.creators.creator : [tree.creators.creator]);
@@ -1449,6 +1453,7 @@ function parseTree(tree, itemCategory, itemSubCategory) {
 	return {
 		uuid: tree.uuid,
 		category: "tree",
+		metadata: metadata ?? null,
 		publicationDateTime: new Date(tree.publicationDateTime),
 		identification: parseIdentification(tree.identification),
 		creators,
@@ -1466,7 +1471,7 @@ function parseTree(tree, itemCategory, itemSubCategory) {
 * @param set - Raw set data in OCHRE format
 * @returns Parsed Set object
 */
-function parseSet(set, itemCategory) {
+function parseSet(set, itemCategory, metadata) {
 	if (typeof set.items === "string") throw new TypeError("Invalid OCHRE data: Set has no items");
 	const parsedItemCategory = itemCategory ?? getItemCategory(Object.keys(set.items));
 	let items = [];
@@ -1504,6 +1509,7 @@ function parseSet(set, itemCategory) {
 	return {
 		uuid: set.uuid,
 		category: "set",
+		metadata: metadata ?? null,
 		itemCategory,
 		publicationDateTime: set.publicationDateTime ? new Date(set.publicationDateTime) : null,
 		date: set.date ?? null,
@@ -1527,10 +1533,11 @@ function parseSet(set, itemCategory) {
 * @param resource - Raw resource data in OCHRE format
 * @returns Parsed Resource object
 */
-function parseResource(resource) {
+function parseResource(resource, metadata) {
 	return {
 		uuid: resource.uuid,
 		category: "resource",
+		metadata: metadata ?? null,
 		publicationDateTime: resource.publicationDateTime ? new Date(resource.publicationDateTime) : null,
 		type: resource.type,
 		number: resource.n,
@@ -1580,10 +1587,11 @@ function parseResources(resources) {
 * @param spatialUnit - Raw spatial unit in OCHRE format
 * @returns Parsed SpatialUnit object
 */
-function parseSpatialUnit(spatialUnit) {
+function parseSpatialUnit(spatialUnit, metadata) {
 	return {
 		uuid: spatialUnit.uuid,
 		category: "spatialUnit",
+		metadata: metadata ?? null,
 		publicationDateTime: spatialUnit.publicationDateTime != null ? new Date(spatialUnit.publicationDateTime) : null,
 		number: spatialUnit.n,
 		context: "context" in spatialUnit && spatialUnit.context ? parseContext(spatialUnit.context) : null,
@@ -1621,10 +1629,11 @@ function parseSpatialUnits(spatialUnits) {
 * @param concept - Raw concept data in OCHRE format
 * @returns Parsed Concept object
 */
-function parseConcept(concept) {
+function parseConcept(concept, metadata) {
 	return {
 		uuid: concept.uuid,
 		category: "concept",
+		metadata: metadata ?? null,
 		publicationDateTime: concept.publicationDateTime ? new Date(concept.publicationDateTime) : null,
 		number: concept.n,
 		license: "availability" in concept && concept.availability ? parseLicense(concept.availability) : null,
@@ -2920,49 +2929,50 @@ async function fetchItem(uuid, category, setCategory, options) {
 		});
 		if (error !== null) throw new Error(error);
 		const categoryKey = getItemCategory(Object.keys(data.ochre));
+		const metadata = parseMetadata(data.ochre.metadata);
 		let item;
 		switch (categoryKey) {
 			case "resource":
 				if (!("resource" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'resource' key");
-				item = parseResource(data.ochre.resource);
+				item = parseResource(data.ochre.resource, metadata);
 				break;
 			case "spatialUnit":
 				if (!("spatialUnit" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'spatialUnit' key");
-				item = parseSpatialUnit(data.ochre.spatialUnit);
+				item = parseSpatialUnit(data.ochre.spatialUnit, metadata);
 				break;
 			case "concept":
 				if (!("concept" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'concept' key");
-				item = parseConcept(data.ochre.concept);
+				item = parseConcept(data.ochre.concept, metadata);
 				break;
 			case "period":
 				if (!("period" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'period' key");
-				item = parsePeriod(data.ochre.period);
+				item = parsePeriod(data.ochre.period, metadata);
 				break;
 			case "bibliography":
 				if (!("bibliography" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'bibliography' key");
-				item = parseBibliography(data.ochre.bibliography);
+				item = parseBibliography(data.ochre.bibliography, metadata);
 				break;
 			case "person":
 				if (!("person" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'person' key");
-				item = parsePerson(data.ochre.person);
+				item = parsePerson(data.ochre.person, metadata);
 				break;
 			case "propertyValue":
 				if (!("propertyValue" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'propertyValue' key");
-				item = parsePropertyValue(data.ochre.propertyValue);
+				item = parsePropertyValue(data.ochre.propertyValue, metadata);
 				break;
 			case "set":
 				if (!("set" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'set' key");
-				item = parseSet(data.ochre.set, setCategory);
+				item = parseSet(data.ochre.set, setCategory, metadata);
 				break;
 			case "tree":
 				if (!("tree" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'tree' key");
-				item = parseTree(data.ochre.tree, category, setCategory);
+				item = parseTree(data.ochre.tree, category, setCategory, metadata);
 				break;
 			default: throw new Error("Invalid category");
 		}
 		return {
 			error: null,
-			metadata: parseMetadata(data.ochre.metadata),
+			metadata,
 			belongsTo: {
 				uuid: data.ochre.uuidBelongsTo,
 				abbreviation: parseFakeString(data.ochre.belongsTo)

package/package.json

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