ochre-sdk 1.0.2 → 1.0.4

package/dist/index.d.mts

@@ -404,6 +404,7 @@ type ImageMapArea = {
   publicationDateTime: Date | null;
   type: string;
   title: string;
+  slug: string | null;
   items: Array<{
     shape: "rectangle";
     coords: [number, number, number, number];
@@ -1319,6 +1320,7 @@ type WebsiteType = "traditional" | "digital-collection" | "plum" | "cedar" | "el
  */
 type Website<T extends LanguageCodes = LanguageCodes> = {
   uuid: string;
+  type: "website" | "segment";
   belongsTo: {
     uuid: string;
     abbreviation: string;
@@ -1328,7 +1330,7 @@ type Website<T extends LanguageCodes = LanguageCodes> = {
   identification: Identification<T>;
   creators: Array<Person<T, "embedded">>;
   license: License | null;
-  items: Array<Webpage<T> | WebSegment<T>>;
+  items: Array<Webpage<T>>;
   properties: {
     type: WebsiteType;
     status: "development" | "preview" | "production";
@@ -1399,6 +1401,9 @@ type Website<T extends LanguageCodes = LanguageCodes> = {
     };
   };
 };
+type WebsiteSegment<T extends LanguageCodes = LanguageCodes> = Website<T> & {
+  type: "segment";
+};
 /**
  * Represents a webpage with its title, slug, properties, items and subpages
  */
@@ -1408,7 +1413,8 @@ type Webpage<T extends LanguageCodes = LanguageCodes> = {
   title: MultilingualString<T>;
   slug: string;
   publicationDateTime: Date | null;
-  items: Array<WebSegment<T> | WebElement<T> | WebBlock<T>>;
+  items: Array<WebElement<T> | WebBlock<T>>;
+  segments: Array<WebsiteSegment<T>>;
   properties: {
     width: "full" | "large" | "narrow" | "default";
     variant: "default" | "no-background";
@@ -1425,28 +1431,6 @@ type Webpage<T extends LanguageCodes = LanguageCodes> = {
   };
   webpages: Array<Webpage<T>>;
 };
-/**
- * Represents a web segment
- */
-type WebSegment<T extends LanguageCodes = LanguageCodes> = {
-  uuid: string;
-  type: "segment";
-  title: MultilingualString<T>;
-  slug: string;
-  publicationDateTime: Date | null;
-  items: Array<WebSegmentItem<T>>;
-};
-/**
- * Represents a web segment item
- */
-type WebSegmentItem<T extends LanguageCodes = LanguageCodes> = {
-  uuid: string;
-  type: "segment-item";
-  title: MultilingualString<T>;
-  slug: string;
-  publicationDateTime: Date | null;
-  items: Array<Webpage<T> | WebSegment<T>>;
-};
 /**
  * Represents a title with its label and variant
  */
@@ -1960,4 +1944,4 @@ declare const DEFAULT_PAGE_SIZE = 48;
  */
 declare function flattenItemProperties<U extends ItemCategory = ItemCategory, V extends ContainedItemCategory<U> = ContainedItemCategory<U>, T extends LanguageCodes = LanguageCodes, W extends ItemPayloadKind = "topLevel">(item: Item<U, V, T, W>): FlattenedItem<Item<U, V, T, W>, T>;
 //#endregion
-export { AccordionWebBlock, AnyBibliography, AnyConcept, AnyItem, AnyPeriod, AnyPerson, AnyPropertyValue, AnyPropertyVariable, AnyResource, AnySet, AnySpatialUnit, AnyText, AnyTree, BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, ContainedItemCategory, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Context, ContextItem, ContextItemCategory, ContextNode, ContextTree, ContextTreeFilterLevel, ContextTreeLevel, ContextTreeLevelItem, Coordinates, CoordinatesSource, DEFAULT_PAGE_SIZE, DictionaryUnitItemLink, EmbeddedBibliography, EmbeddedConcept, EmbeddedItem, EmbeddedPeriod, EmbeddedPerson, EmbeddedPropertyValue, EmbeddedPropertyVariable, EmbeddedResource, EmbeddedSet, EmbeddedSpatialUnit, EmbeddedText, EmbeddedTree, Event, Gallery, Heading, HeadingItemCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemCategory, ItemContainerCategory, ItemLink, ItemLinkCategory, ItemLinks, ItemPayloadKind, ItemProperty, LanguageCodes, License, Metadata, type MultilingualOptions, MultilingualString, type MultilingualStringEntries, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringObject, type MultilingualStringText, Note, Observation, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyLike, PropertyOptions, PropertyValue, PropertyValueContent, PropertyValueDataType, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, QueryablePropertyValueDataType, RecursiveItemCategory, Resource, ResourceItemLink, Scope, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemCategory, SetItemLink, SetItemProperty, SetItemSimplifiedProperty, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetTree, SimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Style, StylesheetCategory, StylesheetItem, Text, TextItemLink, TopLevelItem, Tree, TreeItemCategory, TreeItemLink, WebBlock, WebBlockByLayout, WebBlockLayout, WebElement, WebElementComponent, WebElementComponentName, WebElementComponentOf, WebElementOf, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteType, defineLanguages, fetchGallery, fetchItem, fetchItemLinks, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByVariableLabel, getPropertyByVariableLabelAndValue, getPropertyByVariableLabelAndValueContent, getPropertyByVariableLabelAndValueContents, getPropertyByVariableLabelAndValues, getPropertyByVariableUuid, getPropertyValueByVariableLabel, getPropertyValueByVariableUuid, getPropertyValueContentByVariableLabel, getPropertyValueContentByVariableUuid, getPropertyValueContentsByVariableUuid, getPropertyValuesByVariableLabel, getPropertyValuesByVariableUuid, getUniqueProperties, getUniquePropertyVariableLabels, withLanguages };
+export { AccordionWebBlock, AnyBibliography, AnyConcept, AnyItem, AnyPeriod, AnyPerson, AnyPropertyValue, AnyPropertyVariable, AnyResource, AnySet, AnySpatialUnit, AnyText, AnyTree, BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, ContainedItemCategory, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Context, ContextItem, ContextItemCategory, ContextNode, ContextTree, ContextTreeFilterLevel, ContextTreeLevel, ContextTreeLevelItem, Coordinates, CoordinatesSource, DEFAULT_PAGE_SIZE, DictionaryUnitItemLink, EmbeddedBibliography, EmbeddedConcept, EmbeddedItem, EmbeddedPeriod, EmbeddedPerson, EmbeddedPropertyValue, EmbeddedPropertyVariable, EmbeddedResource, EmbeddedSet, EmbeddedSpatialUnit, EmbeddedText, EmbeddedTree, Event, Gallery, Heading, HeadingItemCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemCategory, ItemContainerCategory, ItemLink, ItemLinkCategory, ItemLinks, ItemPayloadKind, ItemProperty, LanguageCodes, License, Metadata, type MultilingualOptions, MultilingualString, type MultilingualStringEntries, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringObject, type MultilingualStringText, Note, Observation, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyLike, PropertyOptions, PropertyValue, PropertyValueContent, PropertyValueDataType, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, QueryablePropertyValueDataType, RecursiveItemCategory, Resource, ResourceItemLink, Scope, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemCategory, SetItemLink, SetItemProperty, SetItemSimplifiedProperty, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetTree, SimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Style, StylesheetCategory, StylesheetItem, Text, TextItemLink, TopLevelItem, Tree, TreeItemCategory, TreeItemLink, WebBlock, WebBlockByLayout, WebBlockLayout, WebElement, WebElementComponent, WebElementComponentName, WebElementComponentOf, WebElementOf, WebImage, WebTitle, Webpage, Website, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteSegment, WebsiteType, defineLanguages, fetchGallery, fetchItem, fetchItemLinks, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByVariableLabel, getPropertyByVariableLabelAndValue, getPropertyByVariableLabelAndValueContent, getPropertyByVariableLabelAndValueContents, getPropertyByVariableLabelAndValues, getPropertyByVariableUuid, getPropertyValueByVariableLabel, getPropertyValueByVariableUuid, getPropertyValueContentByVariableLabel, getPropertyValueContentByVariableUuid, getPropertyValueContentsByVariableUuid, getPropertyValuesByVariableLabel, getPropertyValuesByVariableUuid, getUniqueProperties, getUniquePropertyVariableLabels, withLanguages };

package/dist/index.mjs

@@ -1788,6 +1788,7 @@ function parseImageMapArea(area) {
 		publicationDateTime: area.publicationDateTime,
 		type: area.type,
 		title: area.title,
+		slug: area.slug ?? null,
 		items: shape === "rectangle" ? [{
 			shape,
 			coords: [
@@ -2909,6 +2910,7 @@ const XMLImageMapArea = v.object({
 	publicationDateTime: customDateTime("XMLImageMapArea: publicationDateTime is not a valid datetime"),
 	type: v.string("XMLImageMapArea: type is string and required"),
 	title: v.string("XMLImageMapArea: title is string and required"),
+	slug: v.optional(v.string("XMLImageMapArea: slug is string and optional")),
 	shape: v.picklist([
 		"rect",
 		"circle",
@@ -5885,7 +5887,11 @@ function normalizeWebsiteResources(resources) {
 	return normalized;
 }
 const SEGMENT_UNIQUE_SLUG_PREFIX_REGEX = /^\$[^-]*-/;
-const TRAILING_SLASH_REGEX = /\/$/;
+function prefixSlug(slug, slugPrefix) {
+	if (slugPrefix == null || slugPrefix === "") return slug;
+	if (slug === "") return slugPrefix;
+	return `${slugPrefix}/${slug}`;
+}
 function formatXMLWebsiteResourceMetadata(resource) {
 	const metadata = [`label “${parseStringContent(resource.identification.label)}”`, `uuid “${resource.uuid}”`];
 	if (resource.slug != null) metadata.push(`slug “${resource.slug}”`);
@@ -6556,43 +6562,12 @@ function parseWebElement(elementResource, options) {
 	};
 }
 /**
-* Parses raw webpage resources into standardized WebElement or Webpage objects
-*
-* @param webpageResources - Array of raw webpage resources in OCHRE format
-* @param type - Type of resource to parse ("element" or "page")
-* @returns Array of parsed WebElement or Webpage objects
-*/
-const parseWebpageResources = (webpageResources, type, options) => {
-	const returnElements = [];
-	for (const resource of webpageResources) {
-		if (websitePresentationReader(resource.properties ? parseSimplifiedProperties(resource.properties, options) : []).propertyByValue("presentation", type) === null) continue;
-		switch (type) {
-			case "element": {
-				const element = parseWebElement(resource, options);
-				returnElements.push(element);
-				break;
-			}
-			case "page": {
-				const webpage = parseWebpage(resource, options);
-				if (webpage) returnElements.push(webpage);
-				break;
-			}
-			case "block": {
-				const block = parseWebBlock(resource, options);
-				if (block) returnElements.push(block);
-				break;
-			}
-		}
-	}
-	return returnElements;
-};
-/**
 * Parses raw webpage data into a standardized Webpage structure
 *
 * @param webpageResource - Raw webpage resource data in OCHRE format
 * @returns Parsed Webpage object
 */
-function parseWebpage(webpageResource, options, slugPrefix) {
+function parseWebpage(webpageResource, options, context, slugPrefix) {
 	const webpageProperties = webpageResource.properties ? parseSimplifiedProperties(webpageResource.properties, options) : [];
 	const webpageReader = websitePresentationReader(webpageProperties);
 	if (webpageReader.value("presentation") !== "page") return null;
@@ -6603,9 +6578,10 @@ function parseWebpage(webpageResource, options, slugPrefix) {
 		uuid: webpageResource.uuid,
 		type: "page",
 		title: identification.label,
-		slug: slugPrefix != null ? `${slugPrefix}/${slug}`.replace(TRAILING_SLASH_REGEX, "") : slug,
+		slug: prefixSlug(slug, slugPrefix),
 		publicationDateTime: webpageResource.publicationDateTime ?? null,
 		items: [],
+		segments: [],
 		properties: {
 			width: "default",
 			variant: "default",
@@ -6629,11 +6605,6 @@ function parseWebpage(webpageResource, options, slugPrefix) {
 		const resourceType = websitePresentationReader(resource.properties != null ? parseSimplifiedProperties(resource.properties, options) : []).value("presentation");
 		if (resourceType === null) continue;
 		switch (resourceType) {
-			case "segment": {
-				const segment = parseWebSegment(resource, options);
-				if (segment) items.push(segment);
-				break;
-			}
 			case "element": {
 				const element = parseWebElement(resource, options);
 				items.push(element);
@@ -6647,7 +6618,8 @@ function parseWebpage(webpageResource, options, slugPrefix) {
 		}
 	}
 	returnWebpage.items = items;
-	returnWebpage.webpages = webpageResource.resource != null ? parseWebpageResources(normalizeWebsiteResources(webpageResource.resource), "page", options) : [];
+	returnWebpage.webpages = parseWebpages(webpageResources, options, context, slugPrefix == null ? void 0 : returnWebpage.slug);
+	returnWebpage.segments = parseWebsiteSegments(webpageResource.resource, context, options, returnWebpage.slug);
 	const pageReader = webpageReader.nestedByValue("presentation", "page");
 	if (pageReader.size > 0) {
 		returnWebpage.properties.isDisplayedInNavbar = pageReader.valueOr("displayed-in-navbar", true);
@@ -6674,86 +6646,25 @@ function parseWebpage(webpageResource, options, slugPrefix) {
 * @param webpageResources - Array of raw webpage resources in OCHRE format
 * @returns Array of parsed Webpage objects
 */
-function parseWebpages(webpageResources, options, slugPrefix) {
+function parseWebpages(webpageResources, options, context, slugPrefix) {
 	const returnPages = [];
 	for (const webpageResource of webpageResources) {
-		const webpage = parseWebpage(webpageResource, options, slugPrefix);
+		const webpage = parseWebpage(webpageResource, options, context, slugPrefix);
 		if (webpage !== null) returnPages.push(webpage);
 	}
 	return returnPages;
 }
-/**
-* Parses raw segment resource into a standardized WebSegment object
-*
-* @param segmentResource - Raw segment resource in OCHRE format
-* @returns Parsed WebSegment object
-*/
-function parseWebSegment(segmentResource, options, slugPrefix) {
-	if (websitePresentationReader(segmentResource.properties ? parseSimplifiedProperties(segmentResource.properties, options) : []).value("presentation") !== "segment") return null;
-	const identification = parseIdentification(segmentResource.identification, options);
-	const slug = segmentResource.identification.abbreviation != null ? parseStringContent(segmentResource.identification.abbreviation, options) : null;
-	if (slug == null) throw new Error(`Slug not found for segment (${formatXMLWebsiteResourceMetadata(segmentResource)})`);
-	const returnSegment = {
-		uuid: segmentResource.uuid,
-		type: "segment",
-		title: identification.label,
-		slug,
-		publicationDateTime: segmentResource.publicationDateTime ?? null,
-		items: []
-	};
-	returnSegment.items = parseWebSegmentItems(segmentResource.resource ? normalizeWebsiteResources(segmentResource.resource) : [], options, slugPrefix != null ? `${slugPrefix}/${slug}`.replace(TRAILING_SLASH_REGEX, "") : slug);
-	return returnSegment;
-}
-/**
-* Parses raw segment resources into an array of WebSegment objects
-*
-* @param segmentResources - Array of raw segment resources in OCHRE format
-* @returns Array of parsed WebSegment objects
-*/
-function parseSegments(segmentResources, options, slugPrefix) {
-	const returnSegments = [];
-	for (const segmentResource of segmentResources) {
-		const segment = parseWebSegment(segmentResource, options, slugPrefix);
-		if (segment !== null) returnSegments.push(segment);
-	}
-	return returnSegments;
-}
-/**
-* Parses raw segment item into a standardized WebSegmentItem object
-*
-* @param segmentItemResource - Raw segment item resource in OCHRE format
-* @returns Parsed WebSegmentItem object
-*/
-function parseWebSegmentItem(segmentItemResource, options, slugPrefix) {
-	if (websitePresentationReader(segmentItemResource.properties ? parseSimplifiedProperties(segmentItemResource.properties, options) : []).value("presentation") !== "segment-item") return null;
-	const identification = parseIdentification(segmentItemResource.identification, options);
-	const slug = segmentItemResource.identification.abbreviation != null ? parseStringContent(segmentItemResource.identification.abbreviation, options) : null;
-	if (slug == null) throw new Error(`Slug not found for segment item (${formatXMLWebsiteResourceMetadata(segmentItemResource)})`);
-	const returnSegmentItem = {
-		uuid: segmentItemResource.uuid,
-		type: "segment-item",
-		title: identification.label,
-		slug,
-		publicationDateTime: segmentItemResource.publicationDateTime ?? null,
-		items: []
-	};
-	const resources = segmentItemResource.resource ? normalizeWebsiteResources(segmentItemResource.resource) : [];
-	returnSegmentItem.items.push(...parseWebpages(resources, options, slugPrefix != null ? `${slugPrefix}/${slug}`.replace(TRAILING_SLASH_REGEX, "") : slug), ...parseSegments(resources, options, slugPrefix != null ? `${slugPrefix}/${slug}`.replace(TRAILING_SLASH_REGEX, "") : slug));
-	return returnSegmentItem;
-}
-/**
-* Parses raw segment items into an array of WebSegmentItem objects
-*
-* @param segmentItems - Array of raw segment items in OCHRE format
-* @returns Array of parsed WebSegmentItem objects
-*/
-function parseWebSegmentItems(segmentItems, options, slugPrefix) {
-	const returnItems = [];
-	for (const segmentItem of segmentItems) {
-		const segmentItemParsed = parseWebSegmentItem(segmentItem, options, slugPrefix);
-		if (segmentItemParsed !== null) returnItems.push(segmentItemParsed);
+function parseWebsiteSegments(resources, context, options, slugPrefix) {
+	const segments = [];
+	for (const resource of resources ?? []) {
+		if (!("segments" in resource)) continue;
+		for (const tree of resource.segments.tree) {
+			const segmentSlug = tree.identification.abbreviation == null ? null : parseStringContent(tree.identification.abbreviation, options);
+			if (segmentSlug == null) throw new Error(`Slug not found for segment website (website uuid “${tree.uuid}”)`);
+			segments.push(parseWebsiteTree(tree, context, "segment", options, prefixSlug(segmentSlug, slugPrefix)));
+		}
 	}
-	return returnItems;
+	return segments;
 }
 /**
 * Parses raw sidebar data into a standardized Sidebar structure
@@ -7131,6 +7042,25 @@ function parseFilterContexts(filterContextLevels, options) {
 	});
 	return filterContextTreeLevels;
 }
+function parseWebsiteTree(websiteTree, context, type, options, slugPrefix) {
+	if (!websiteTree.properties) throw new Error(`Website properties not found (website uuid “${websiteTree.uuid}”)`);
+	if (type === "website" && websiteTree.items?.resource == null) throw new Error(`Website pages not found (website uuid “${websiteTree.uuid}”)`);
+	const resources = normalizeWebsiteResources(websiteTree.items?.resource);
+	const sidebar = parseSidebar(resources, options);
+	const properties = parseWebsiteProperties(websiteTree.properties.property, websiteTree, sidebar, options);
+	return {
+		uuid: websiteTree.uuid,
+		type,
+		belongsTo: context.belongsTo,
+		metadata: context.metadata,
+		publicationDateTime: websiteTree.publicationDateTime ?? null,
+		identification: parseIdentification(websiteTree.identification, options),
+		creators: websiteTree.creators ? parsePersonList(websiteTree.creators.creator, options) : [],
+		license: parseLicense(websiteTree.availability),
+		items: parseWebpages(resources, options, context, slugPrefix),
+		properties
+	};
+}
 function parseWebsite(data, options) {
 	const rawOchre = data.result.ochre;
 	const metadataLanguages = parseMetadataLanguages(rawOchre);
@@ -7139,26 +7069,13 @@ function parseWebsite(data, options) {
 	const defaultLanguage = resolveDefaultLanguage(rawOchre, languages);
 	const websiteTree = rawOchre.tree[0];
 	if (websiteTree == null) throw new Error("Website tree not found");
-	if (!websiteTree.properties) throw new Error(`Website properties not found (website uuid “${websiteTree.uuid}”)`);
-	if (websiteTree.items?.resource == null) throw new Error(`Website pages not found (website uuid “${websiteTree.uuid}”)`);
-	const resources = normalizeWebsiteResources(websiteTree.items.resource);
-	const items = [...parseWebpages(resources, parserOptions), ...parseSegments(resources, parserOptions)];
-	const sidebar = parseSidebar(resources, parserOptions);
-	const properties = parseWebsiteProperties(websiteTree.properties.property, websiteTree, sidebar, parserOptions);
-	return {
-		uuid: websiteTree.uuid,
+	return parseWebsiteTree(websiteTree, {
 		belongsTo: {
 			uuid: rawOchre.uuidBelongsTo,
 			abbreviation: rawOchre.belongsTo
 		},
-		metadata: parseMetadata(rawOchre, parserOptions, defaultLanguage),
-		publicationDateTime: websiteTree.publicationDateTime ?? null,
-		identification: parseIdentification(websiteTree.identification, parserOptions),
-		creators: websiteTree.creators ? parsePersonList(websiteTree.creators.creator, parserOptions) : [],
-		license: parseLicense(websiteTree.availability),
-		items,
-		properties
-	};
+		metadata: parseMetadata(rawOchre, parserOptions, defaultLanguage)
+	}, "website", parserOptions);
 }
 //#endregion
 //#region src/fetchers/website.ts

package/package.json

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