ochre-sdk 0.22.10 → 0.22.12

package/dist/index.d.mts

@@ -756,36 +756,44 @@ type Query = QueryLeaf | QueryGroup;
 //#endregion
 //#region src/types/website.d.ts
 /**
- * Represents a level context item with a variable and value
+ * Represents a context tree level item with a variable and value
  */
-type LevelContextItem = {
+type ContextTreeLevelItem = {
   variableUuid: string;
   valueUuid: string | null;
 };
 /**
- * Represents a level context with a context item
+ * Represents a context tree level with a context item
  */
-type LevelContext = {
-  context: Array<LevelContextItem>;
+type ContextTreeLevel = {
+  context: Array<ContextTreeLevelItem>;
   identification: Identification;
   type: string;
 };
 /**
- * Represents property contexts with its levels
+ * Represents a filter context tree level with a context item
  */
-type PropertyContexts = {
-  flatten: Array<LevelContext>;
-  suppress: Array<LevelContext>;
-  filter: Array<LevelContext & {
-    isInlineDisplayed: boolean;
-    isSidebarDisplayed: boolean;
-    isSidebarOpen: boolean;
-  }>;
-  sort: Array<LevelContext>;
-  detail: Array<LevelContext>;
-  download: Array<LevelContext>;
-  label: Array<LevelContext>;
-  prominent: Array<LevelContext>;
+type ContextTreeFilterLevel = {
+  context: Array<ContextTreeLevelItem>;
+  identification: Identification;
+  type: string;
+  filterType: "property" | "coordinates" | "bibliography" | "period";
+  isInlineDisplayed: boolean;
+  isSidebarDisplayed: boolean;
+  isSidebarOpen: boolean;
+};
+/**
+ * Represents a context tree with levels grouped by behavior
+ */
+type ContextTree = {
+  flatten: Array<ContextTreeLevel>;
+  suppress: Array<ContextTreeLevel>;
+  filter: Array<ContextTreeFilterLevel>;
+  sort: Array<ContextTreeLevel>;
+  detail: Array<ContextTreeLevel>;
+  download: Array<ContextTreeLevel>;
+  label: Array<ContextTreeLevel>;
+  prominent: Array<ContextTreeLevel>;
 };
 /**
  * Represents a scope with its UUID, type and identification
@@ -907,7 +915,7 @@ type Website = {
       iiifViewer: "universal-viewer" | "clover";
     };
     options: {
-      contexts: PropertyContexts | null;
+      contextTree: ContextTree | null;
       scopes: Array<Scope> | null;
       labels: {
         title: string | null;
@@ -1049,11 +1057,10 @@ type WebElementComponent = {
     uuid: string;
     label: string;
   }> | null;
-  variant: "detailed" | "card" | "tile" | "showcase";
+  variant: "slide" | "table" | "card" | "tile" | "showcase";
   paginationVariant: "default" | "numeric";
   loadingVariant: "spinner" | "skeleton" | "animation" | "none";
-  layout: "image-top" | "image-bottom" | "image-start" | "image-end";
-  imageQuality: "high" | "low";
+  imageLayout: "top" | "bottom" | "start" | "end" | null;
   isSortDisplayed: boolean;
   isUsingQueryParams: boolean;
   filter: {
@@ -1066,12 +1073,8 @@ type WebElementComponent = {
     sidebarSort: "default" | "alphabetical";
   };
   options: {
-    attributeFilters: {
-      bibliographies: boolean;
-      periods: boolean;
-    };
     scopes: Array<Scope> | null;
-    contexts: PropertyContexts | null;
+    contextTree: ContextTree | null;
     labels: {
       title: string | null;
     };
@@ -1135,12 +1138,8 @@ type WebElementComponent = {
     endIcon: string | null;
   }>;
   options: {
-    attributeFilters: {
-      bibliographies: boolean;
-      periods: boolean;
-    };
     scopes: Array<Scope> | null;
-    contexts: PropertyContexts | null;
+    contextTree: ContextTree | null;
     labels: {
       title: string | null;
     };
@@ -1158,9 +1157,9 @@ type WebElementComponent = {
     loadingVariant: Extract<WebElementComponent, {
       component: "collection";
     }>["loadingVariant"];
-    layout: Extract<WebElementComponent, {
+    imageLayout: Extract<WebElementComponent, {
       component: "collection";
-    }>["layout"];
+    }>["imageLayout"];
   };
 } | {
   component: "search-bar";
@@ -1594,4 +1593,4 @@ declare const DEFAULT_PAGE_SIZE = 48;
  */
 declare function flattenItemProperties<T extends DataCategory = DataCategory, U extends DataCategory | Array<DataCategory> = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? Array<DataCategory> : never)>(item: Item<T, U>): Item<T, U>;
 //#endregion
-export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Query, QueryGroup, QueryLeaf, Resource, Scope, Section, Set, SetAttributeValueQueryItem, SetItemsSort, SetItemsSortDirection, SpatialUnit, Style, StylesheetCategory, StylesheetItem, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteType, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValueContent, getPropertyByLabelAndValueContents, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValueContentByLabel, getPropertyValueContentByUuid, getPropertyValueContentsByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, ContextTree, ContextTreeFilterLevel, ContextTreeLevel, ContextTreeLevelItem, Coordinate, DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Query, QueryGroup, QueryLeaf, Resource, Scope, Section, Set, SetAttributeValueQueryItem, SetItemsSort, SetItemsSortDirection, SpatialUnit, Style, StylesheetCategory, StylesheetItem, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteType, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValueContent, getPropertyByLabelAndValueContents, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValueContentByLabel, getPropertyValueContentByUuid, getPropertyValueContentsByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/dist/index.mjs

@@ -3912,13 +3912,11 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			if (setLinks.every((link) => link.uuid === null)) throw new Error(`Set links not found for the following component: “${componentName}”`);
 			const displayedProperties = getPropertyByLabel(componentProperty.properties, "use-property");
 			let variant = getPropertyValueContentByLabel(componentProperty.properties, "variant");
-			variant ??= "detailed";
+			variant ??= "slide";
 			let paginationVariant = getPropertyValueContentByLabel(componentProperty.properties, "pagination-variant");
 			paginationVariant ??= "default";
 			let loadingVariant = getPropertyValueContentByLabel(componentProperty.properties, "loading-variant");
 			loadingVariant ??= "skeleton";
-			let imageQuality = getPropertyValueContentByLabel(componentProperty.properties, "image-quality");
-			imageQuality ??= "low";
 			let isUsingQueryParams = getPropertyValueContentByLabel(componentProperty.properties, "is-using-query-params");
 			isUsingQueryParams ??= false;
 			let isFilterResultsBarDisplayed = getPropertyValueContentByLabel(componentProperty.properties, "filter-results-bar-displayed");
@@ -3937,23 +3935,19 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			isFilterSidebarDisplayed ??= false;
 			let filterSidebarSort = getPropertyValueContentByLabel(componentProperty.properties, "filter-sidebar-sort");
 			filterSidebarSort ??= "default";
-			let layout = getPropertyValueContentByLabel(componentProperty.properties, "layout");
-			layout ??= "image-start";
+			let imageLayout = getPropertyValueContentByLabel(componentProperty.properties, "image-layout");
+			imageLayout ??= "start";
 			const options = {
-				attributeFilters: {
-					bibliographies: elementResource.options?.filterBibliography ?? false,
-					periods: elementResource.options?.filterPeriods ?? false
-				},
 				scopes: elementResource.options?.scopes != null ? ensureArray(elementResource.options.scopes.scope).map((scope) => ({
 					uuid: scope.uuid.content,
 					type: scope.uuid.type,
 					identification: parseIdentification(scope.identification)
 				})) : null,
-				contexts: null,
+				contextTree: null,
 				labels: { title: null }
 			};
 			if ("options" in elementResource && elementResource.options) {
-				options.contexts = parseAllOptionContexts(elementResource.options);
+				options.contextTree = parseAllOptionContexts(elementResource.options);
 				if ("notes" in elementResource.options && elementResource.options.notes) {
 					const labelNotes = parseNotes(ensureArray(elementResource.options.notes.note));
 					options.labels.title = labelNotes.find((note) => note.title === "Title label")?.content ?? null;
@@ -3969,8 +3963,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 				variant,
 				paginationVariant,
 				loadingVariant,
-				layout,
-				imageQuality,
+				imageLayout,
 				isUsingQueryParams,
 				isSortDisplayed,
 				filter: {
@@ -4205,20 +4198,16 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			}
 			if (items.length === 0) throw new Error(`No queries found for the following component: “${componentName}”`);
 			const options = {
-				attributeFilters: {
-					bibliographies: elementResource.options?.filterBibliography ?? false,
-					periods: elementResource.options?.filterPeriods ?? false
-				},
 				scopes: elementResource.options?.scopes != null ? ensureArray(elementResource.options.scopes.scope).map((scope) => ({
 					uuid: scope.uuid.content,
 					type: scope.uuid.type,
 					identification: parseIdentification(scope.identification)
 				})) : null,
-				contexts: null,
+				contextTree: null,
 				labels: { title: null }
 			};
 			if ("options" in elementResource && elementResource.options) {
-				options.contexts = parseAllOptionContexts(elementResource.options);
+				options.contextTree = parseAllOptionContexts(elementResource.options);
 				if ("notes" in elementResource.options && elementResource.options.notes) {
 					const labelNotes = parseNotes(ensureArray(elementResource.options.notes.note));
 					options.labels.title = labelNotes.find((note) => note.title === "Title label")?.content ?? null;
@@ -4226,13 +4215,13 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			}
 			const displayedProperties = getPropertyByLabel(componentProperty.properties, "use-property");
 			let variant = getPropertyValueContentByLabel(componentProperty.properties, "variant");
-			variant ??= "detailed";
+			variant ??= "slide";
 			let paginationVariant = getPropertyValueContentByLabel(componentProperty.properties, "pagination-variant");
 			paginationVariant ??= "default";
 			let loadingVariant = getPropertyValueContentByLabel(componentProperty.properties, "loading-variant");
 			loadingVariant ??= "skeleton";
-			let layout = getPropertyValueContentByLabel(componentProperty.properties, "layout");
-			layout ??= "image-start";
+			let imageLayout = getPropertyValueContentByLabel(componentProperty.properties, "image-layout");
+			imageLayout ??= "start";
 			properties = {
 				component: "query",
 				linkUuids: setLinks.map((link) => link.uuid).filter((uuid) => uuid !== null),
@@ -4246,7 +4235,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 					variant,
 					paginationVariant,
 					loadingVariant,
-					layout
+					imageLayout
 				}
 			};
 			break;
@@ -4872,7 +4861,7 @@ function parseWebsiteProperties(properties, websiteTree, sidebar) {
 			iiifViewer: "universal-viewer"
 		},
 		options: {
-			contexts: null,
+			contextTree: null,
 			scopes: null,
 			labels: { title: null },
 			stylesheets: { properties: [] }
@@ -4918,7 +4907,7 @@ function parseWebsiteProperties(properties, websiteTree, sidebar) {
 			type: scope.uuid.type,
 			identification: parseIdentification(scope.identification)
 		})) : null;
-		returnProperties.options.contexts = parseAllOptionContexts(websiteTree.options);
+		returnProperties.options.contextTree = parseAllOptionContexts(websiteTree.options);
 		if ("notes" in websiteTree.options && websiteTree.options.notes != null) {
 			const labelNotes = parseNotes(ensureArray(websiteTree.options.notes.note));
 			returnProperties.options.labels.title = labelNotes.find((note) => note.title === "Title label")?.content ?? null;
@@ -4928,7 +4917,7 @@ function parseWebsiteProperties(properties, websiteTree, sidebar) {
 	return returnProperties;
 }
 function parseContextItem(contextItemToParse) {
-	const levelsToParse = ensureArray(contextItemToParse.levels.level);
+	const levelsToParse = contextItemToParse.levels != null ? ensureArray(contextItemToParse.levels.level) : [];
 	let type = "";
 	return {
 		context: levelsToParse.map((level) => {
@@ -4987,18 +4976,19 @@ function parseFilterContextDisplay(filterOption) {
 		};
 	}
 }
-function parseContexts(contexts) {
-	const contextsParsed = [];
-	for (const mainContext of contexts) for (const contextItemToParse of ensureArray(mainContext.context)) contextsParsed.push(parseContextItem(contextItemToParse));
-	return contextsParsed;
+function parseContexts(contextLevels) {
+	const contextTreeLevels = [];
+	for (const contextLevel of contextLevels) for (const contextItemToParse of ensureArray(contextLevel.context)) contextTreeLevels.push(parseContextItem(contextItemToParse));
+	return contextTreeLevels;
 }
-function parseFilterContexts(contexts) {
-	const contextsParsed = [];
-	for (const mainContext of contexts) for (const contextItemToParse of ensureArray(mainContext.context)) contextsParsed.push({
+function parseFilterContexts(filterContextLevels) {
+	const filterContextTreeLevels = [];
+	for (const filterContextLevel of filterContextLevels) for (const contextItemToParse of ensureArray(filterContextLevel.context)) filterContextTreeLevels.push({
 		...parseContextItem(contextItemToParse),
+		filterType: contextItemToParse.filterType,
 		...parseFilterContextDisplay(contextItemToParse.filterOption)
 	});
-	return contextsParsed;
+	return filterContextTreeLevels;
 }
 function parseWebsite(websiteTree, metadata, belongsTo, { version = 2 } = {}) {
 	if (!websiteTree.properties) throw new Error("Website properties not found");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "0.22.10",
+  "version": "0.22.12",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -55,7 +55,7 @@
     "eslint": "^10.2.0",
     "prettier": "^3.8.3",
     "tsdown": "^0.21.9",
-    "typescript": "^6.0.2",
+    "typescript": "^6.0.3",
     "vitest": "^4.1.4"
   },
   "scripts": {