ochre-sdk 0.22.5 → 0.22.7

package/dist/index.d.mts

@@ -776,7 +776,11 @@ type LevelContext = {
 type PropertyContexts = {
   flatten: Array<LevelContext>;
   suppress: Array<LevelContext>;
-  filter: Array<LevelContext>;
+  filter: Array<LevelContext & {
+    isInlineDisplayed: boolean;
+    isSidebarDisplayed: boolean;
+    isSidebarOpen: boolean;
+  }>;
   sort: Array<LevelContext>;
   detail: Array<LevelContext>;
   download: Array<LevelContext>;

package/dist/index.mjs

@@ -919,7 +919,6 @@ const setItemsParamsSchema = z.object({
 });
 //#endregion
 //#region src/utils/parse/index.ts
-const TRAILING_ELLIPSIS_REGEX = /\s*\.{3}$/;
 /**
 * Parses raw identification data into the standardized Identification type
 *
@@ -1018,7 +1017,7 @@ function parseMetadata(metadata) {
 * @param contextItem - Raw context item data from OCHRE format
 * @returns Parsed ContextItem object
 */
-function parseContextItem(contextItem) {
+function parseContextItem$1(contextItem) {
 	return {
 		uuid: contextItem.uuid,
 		publicationDateTime: parseOptionalDate(contextItem.publicationDateTime),
@@ -1035,9 +1034,9 @@ function parseContextItem(contextItem) {
 function parseContext(context) {
 	return {
 		nodes: ensureArray(context.context).map((ctx) => ({
-			tree: parseContextItem(ctx.tree),
-			project: parseContextItem(ctx.project),
-			spatialUnit: "spatialUnit" in ctx && ctx.spatialUnit ? ensureArray(ctx.spatialUnit).map((element) => parseContextItem(element)) : []
+			tree: parseContextItem$1(ctx.tree),
+			project: parseContextItem$1(ctx.project),
+			spatialUnit: "spatialUnit" in ctx && ctx.spatialUnit ? ensureArray(ctx.spatialUnit).map((element) => parseContextItem$1(element)) : []
 		})),
 		displayPath: context.displayPath
 	};
@@ -1426,7 +1425,7 @@ function parseProperty(property, language = "eng") {
 	});
 	return {
 		uuid: property.label.uuid,
-		label: parseStringContent(property.label, language).replace(TRAILING_ELLIPSIS_REGEX, "").trim(),
+		label: parseStringContent(property.label, language).trim(),
 		values,
 		comment: property.comment != null ? parseStringContent(property.comment) : null,
 		properties: property.property ? parseProperties(ensureArray(property.property)) : []
@@ -3713,10 +3712,13 @@ function parseAllOptionContexts(options) {
 	function handleContexts(v) {
 		return parseContexts(v != null ? ensureArray(v) : []);
 	}
+	function handleFilterContexts(v) {
+		return parseFilterContexts(v != null ? ensureArray(v) : []);
+	}
 	return {
 		flatten: handleContexts(options.flattenContexts),
 		suppress: handleContexts(options.suppressContexts),
-		filter: handleContexts(options.filterContexts),
+		filter: handleFilterContexts(options.filterContexts),
 		sort: handleContexts(options.sortContexts),
 		detail: handleContexts(options.detailContexts),
 		download: handleContexts(options.downloadContexts),
@@ -4919,12 +4921,11 @@ function parseWebsiteProperties(properties, websiteTree, sidebar) {
 	if ("styleOptions" in websiteTree && websiteTree.styleOptions != null) returnProperties.options.stylesheets.properties = parseStylesheets(ensureArray(websiteTree.styleOptions.style));
 	return returnProperties;
 }
-function parseContexts(contexts) {
-	const contextsParsed = [];
-	for (const mainContext of contexts) for (const contextItemToParse of ensureArray(mainContext.context)) {
-		const levelsToParse = ensureArray(contextItemToParse.levels.level);
-		let type = "";
-		const levels = levelsToParse.map((level) => {
+function parseContextItem(contextItemToParse) {
+	const levelsToParse = ensureArray(contextItemToParse.levels.level);
+	let type = "";
+	return {
+		context: levelsToParse.map((level) => {
 			let variableUuid = "";
 			let valueUuid = null;
 			if (typeof level === "string") {
@@ -4941,13 +4942,56 @@ function parseContexts(contexts) {
 				variableUuid,
 				valueUuid
 			};
-		});
-		contextsParsed.push({
-			context: levels,
-			type,
-			identification: parseIdentification(contextItemToParse.identification)
-		});
+		}),
+		type,
+		identification: parseIdentification(contextItemToParse.identification)
+	};
+}
+function parseFilterContextDisplay(filterOption) {
+	switch (filterOption) {
+		case "inline-displayed": return {
+			isInlineDisplayed: true,
+			isSidebarDisplayed: false,
+			isSidebarOpen: false
+		};
+		case "inline-sidebar-displayed-closed": return {
+			isInlineDisplayed: true,
+			isSidebarDisplayed: true,
+			isSidebarOpen: false
+		};
+		case "inline-sidebar-displayed-open": return {
+			isInlineDisplayed: true,
+			isSidebarDisplayed: true,
+			isSidebarOpen: true
+		};
+		case "sidebar-displayed-closed": return {
+			isInlineDisplayed: false,
+			isSidebarDisplayed: true,
+			isSidebarOpen: false
+		};
+		case "sidebar-displayed-open": return {
+			isInlineDisplayed: false,
+			isSidebarDisplayed: true,
+			isSidebarOpen: true
+		};
+		default: return {
+			isInlineDisplayed: false,
+			isSidebarDisplayed: false,
+			isSidebarOpen: false
+		};
 	}
+}
+function parseContexts(contexts) {
+	const contextsParsed = [];
+	for (const mainContext of contexts) for (const contextItemToParse of ensureArray(mainContext.context)) contextsParsed.push(parseContextItem(contextItemToParse));
+	return contextsParsed;
+}
+function parseFilterContexts(contexts) {
+	const contextsParsed = [];
+	for (const mainContext of contexts) for (const contextItemToParse of ensureArray(mainContext.context)) contextsParsed.push({
+		...parseContextItem(contextItemToParse),
+		...parseFilterContextDisplay(contextItemToParse.filterOption)
+	});
 	return contextsParsed;
 }
 function parseWebsite(websiteTree, metadata, belongsTo, { version = 2 } = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "0.22.5",
+  "version": "0.22.7",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -49,12 +49,12 @@
     "zod": "^4.3.6"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^8.1.0",
+    "@antfu/eslint-config": "^8.2.0",
     "@types/node": "^24.12.2",
     "bumpp": "^11.0.1",
     "eslint": "^10.2.0",
-    "prettier": "^3.8.1",
-    "tsdown": "^0.21.7",
+    "prettier": "^3.8.2",
+    "tsdown": "^0.21.8",
     "typescript": "^6.0.2",
     "vitest": "^4.1.4"
   },