ochre-sdk 1.0.78 → 1.1.0

package/README.md

@@ -176,12 +176,40 @@ types, query types, property getters, and small data helpers:
 
 - `Item`, `SetItem`, `ItemLink`, `Website`, `WebElementOf`,
   `WebElementComponentOf`, `WebBlockByLayout`, `Query`, and related types.
-- `getPropertyByVariableUuid`, `getPropertyValueContentByVariableUuid`,
-  `getPropertyByVariableLabel`, `getUniqueProperties`, `filterProperties`, and
-  related property helpers.
+- `getProperty`, `getPropertyValues`, `getPropertyValue`,
+  `getUniqueProperties`, `getUniquePropertyVariableLabels`, and
+  `isPropertyMatchingFilter` for reading properties off a parsed item.
 - `flattenItemProperties` and `DEFAULT_PAGE_SIZE` for common collection UI
   workflows.
 
+### Property Access
+
+Every property lookup takes a `PropertySelector`, which names a property either
+by its variable UUID or by its variable label. A label can be narrowed by the
+values the property carries.
+
+```ts
+import { getProperty, getPropertyValue, getPropertyValues } from "ochre-sdk";
+
+const properties = result.item.properties;
+
+getProperty(properties, { uuid: "<variable-uuid>" });
+getProperty(properties, { label: "Material" });
+getProperty(properties, { label: "Material", valueContent: "Ceramic" });
+
+getPropertyValues(properties, { label: "Material" });
+getPropertyValue(properties, { label: "Material" })?.content;
+```
+
+Labels are matched case-insensitively, and spaces and underscores are treated
+as hyphens, so `"Media type"`, `"media_type"` and `"media-type"` all name the
+same property.
+
+Pass `{ includeNestedProperties: true }` to descend into nested properties, and
+`{ limitToLeafPropertyValues: false }` to keep non-leaf values. Leaf filtering
+applies to `getPropertyValues` and `getPropertyValue`; `getProperty` returns a
+property exactly as the item carries it.
+
 ## Development
 
 The package source lives in `src/`, and `src/index.ts` is the public entrypoint.

package/dist/_virtual/_rolldown/runtime.mjs

@@ -0,0 +1,13 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+export { __exportAll };

package/dist/categories.d.mts

@@ -0,0 +1,249 @@
+import { ContextItemCategory, HeadingItemCategory, ItemCategory, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemLinkCategory, TreeItemCategory } from "./types/index.mjs";
+//#region src/categories.d.ts
+/**
+ * Every category an item hierarchy entry can carry, including the
+ * pseudo-category OCHRE uses to group entries
+ */
+export type HierarchyEntryCategory = ItemLinkCategory | "heading";
+/**
+ * The one table describing the OCHRE item categories
+ * @internal
+ */
+export declare const ITEM_CATEGORY_FACTS: {
+  readonly tree: {
+    readonly aliases: readonly ["tree"];
+    readonly label: "tree";
+    readonly hasCollection: true;
+    readonly isTreeItem: false;
+    readonly isSetItem: true;
+    readonly isHeadingItem: false;
+    readonly isContextItem: false;
+    readonly isContainer: true;
+    readonly hasEmbeddedItems: true;
+  };
+  readonly bibliography: {
+    readonly aliases: readonly ["bibliography"];
+    readonly label: "bibliography";
+    readonly hasCollection: true;
+    readonly isTreeItem: true;
+    readonly isSetItem: true;
+    readonly isHeadingItem: false;
+    readonly isContextItem: true;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: true;
+  };
+  readonly concept: {
+    readonly aliases: readonly ["concept"];
+    readonly label: "concept";
+    readonly hasCollection: true;
+    readonly isTreeItem: true;
+    readonly isSetItem: true;
+    readonly isHeadingItem: false;
+    readonly isContextItem: true;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: true;
+  };
+  readonly spatialUnit: {
+    readonly aliases: readonly ["spatialUnit"];
+    readonly label: "spatial unit";
+    readonly hasCollection: true;
+    readonly isTreeItem: true;
+    readonly isSetItem: true;
+    readonly isHeadingItem: false;
+    readonly isContextItem: true;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: true;
+  };
+  readonly period: {
+    readonly aliases: readonly ["period"];
+    readonly label: "period";
+    readonly hasCollection: true;
+    readonly isTreeItem: true;
+    readonly isSetItem: true;
+    readonly isHeadingItem: false;
+    readonly isContextItem: true;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: true;
+  };
+  readonly person: {
+    readonly aliases: readonly ["person"];
+    readonly label: "person";
+    readonly hasCollection: true;
+    readonly isTreeItem: true;
+    readonly isSetItem: true;
+    readonly isHeadingItem: true;
+    readonly isContextItem: false;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: false;
+  };
+  readonly propertyVariable: {
+    readonly aliases: readonly ["propertyVariable", "variable"];
+    readonly label: "property variable";
+    readonly hasCollection: true;
+    readonly isTreeItem: true;
+    readonly isSetItem: true;
+    readonly isHeadingItem: true;
+    readonly isContextItem: true;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: false;
+  };
+  readonly propertyValue: {
+    readonly aliases: readonly ["propertyValue", "value"];
+    readonly label: "property value";
+    readonly hasCollection: true;
+    readonly isTreeItem: true;
+    readonly isSetItem: true;
+    readonly isHeadingItem: true;
+    readonly isContextItem: true;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: false;
+  };
+  readonly resource: {
+    readonly aliases: readonly ["resource"];
+    readonly label: "resource";
+    readonly hasCollection: true;
+    readonly isTreeItem: true;
+    readonly isSetItem: true;
+    readonly isHeadingItem: true;
+    readonly isContextItem: true;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: true;
+  };
+  readonly text: {
+    readonly aliases: readonly ["text"];
+    readonly label: "text";
+    readonly hasCollection: true;
+    readonly isTreeItem: true;
+    readonly isSetItem: true;
+    readonly isHeadingItem: true;
+    readonly isContextItem: true;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: false;
+  };
+  readonly set: {
+    readonly aliases: readonly ["set"];
+    readonly label: "set";
+    readonly hasCollection: true;
+    readonly isTreeItem: true;
+    readonly isSetItem: true;
+    readonly isHeadingItem: true;
+    readonly isContextItem: false;
+    readonly isContainer: true;
+    readonly hasEmbeddedItems: true;
+  };
+  readonly dictionaryUnit: {
+    readonly aliases: readonly ["dictionaryUnit"];
+    readonly label: "dictionary unit";
+    readonly hasCollection: false;
+    readonly isTreeItem: false;
+    readonly isSetItem: false;
+    readonly isHeadingItem: false;
+    readonly isContextItem: false;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: false;
+  };
+  readonly heading: {
+    readonly aliases: readonly ["heading"];
+    readonly label: "heading";
+    readonly hasCollection: false;
+    readonly isTreeItem: false;
+    readonly isSetItem: false;
+    readonly isHeadingItem: false;
+    readonly isContextItem: false;
+    readonly isContainer: false;
+    readonly hasEmbeddedItems: false;
+  };
+};
+/**
+ * Every element name OCHRE serves an item category under, canonical name first
+ * @internal
+ */
+export declare const ITEM_CATEGORY_ALIASES: {
+  readonly tree: readonly ["tree"];
+  readonly bibliography: readonly ["bibliography"];
+  readonly concept: readonly ["concept"];
+  readonly spatialUnit: readonly ["spatialUnit"];
+  readonly period: readonly ["period"];
+  readonly person: readonly ["person"];
+  readonly propertyVariable: readonly ["propertyVariable", "variable"];
+  readonly propertyValue: readonly ["propertyValue", "value"];
+  readonly resource: readonly ["resource"];
+  readonly text: readonly ["text"];
+  readonly set: readonly ["set"];
+  readonly dictionaryUnit: readonly ["dictionaryUnit"];
+};
+/**
+ * The canonical category each element name maps to
+ * @internal
+ */
+export declare const ITEM_CATEGORY_BY_ALIAS: ReadonlyMap<string, HierarchyEntryCategory>;
+/**
+ * The OCHRE collections an item document can live in
+ *
+ * Document URIs are bare item UUIDs, so a lookup by UUID does not need these.
+ * A search does: `fn:collection("ochre/<category>")`.
+ * @internal
+ */
+export declare const OCHRE_COLLECTION_CATEGORIES: Array<ItemCategory>;
+/**
+ * The item categories that can sit directly inside a Tree
+ * @internal
+ */
+export declare const TREE_ITEM_CATEGORIES: Array<TreeItemCategory>;
+/**
+ * The item categories that can sit directly inside a Set
+ * @internal
+ */
+export declare const SET_ITEM_CATEGORIES: Array<ItemCategory>;
+/**
+ * The item categories that can sit under a heading
+ * @internal
+ */
+export declare const HEADING_ITEM_CATEGORIES: Array<HeadingItemCategory>;
+/**
+ * The item categories that hold other items under a `containedItemCategory`
+ * @internal
+ */
+export declare const ITEM_CONTAINER_CATEGORIES: Array<ItemContainerCategory>;
+/**
+ * The item categories that carry an embedded item hierarchy
+ * @internal
+ */
+export declare const ITEM_CATEGORIES_WITH_EMBEDDED_ITEMS: Array<ItemCategoryWithEmbeddedItems>;
+/**
+ * Each element name that can appear in a context path, and the category it means
+ * @internal
+ */
+export declare const CONTEXT_CATEGORY_ALIASES: ReadonlyArray<{
+  alias: string;
+  category: ContextItemCategory;
+}>;
+/**
+ * Whether an item of this category holds other items
+ * @param category - The item category
+ * @returns True when the category accepts a `containedItemCategory`
+ * @internal
+ */
+export declare function isItemContainerCategory(category: ItemCategory): category is ItemContainerCategory;
+/**
+ * Whether an item of this category carries an embedded item hierarchy
+ * @param category - The item category
+ * @returns True when the category exposes embedded items
+ * @internal
+ */
+export declare function isItemCategoryWithEmbeddedItems(category: ItemCategory): category is ItemCategoryWithEmbeddedItems;
+/**
+ * Whether an item of this category can sit under a heading
+ * @param category - The item category
+ * @returns True when the category is allowed under a heading
+ * @internal
+ */
+export declare function isHeadingItemCategory(category: TreeItemCategory): category is HeadingItemCategory;
+/**
+ * Resolve an OCHRE element name to the category it means
+ * @param category - The element name, which may be an alias
+ * @returns The canonical category, or null when the name is not one
+ * @internal
+ */
+export declare function normalizeItemCategory(category: string | undefined): ItemCategory | null;
+//#endregion

package/dist/categories.mjs

@@ -0,0 +1,259 @@
+//#region src/categories.ts
+/**
+* The one table describing the OCHRE item categories
+* @internal
+*/
+const ITEM_CATEGORY_FACTS = {
+	tree: {
+		aliases: ["tree"],
+		label: "tree",
+		hasCollection: true,
+		isTreeItem: false,
+		isSetItem: true,
+		isHeadingItem: false,
+		isContextItem: false,
+		isContainer: true,
+		hasEmbeddedItems: true
+	},
+	bibliography: {
+		aliases: ["bibliography"],
+		label: "bibliography",
+		hasCollection: true,
+		isTreeItem: true,
+		isSetItem: true,
+		isHeadingItem: false,
+		isContextItem: true,
+		isContainer: false,
+		hasEmbeddedItems: true
+	},
+	concept: {
+		aliases: ["concept"],
+		label: "concept",
+		hasCollection: true,
+		isTreeItem: true,
+		isSetItem: true,
+		isHeadingItem: false,
+		isContextItem: true,
+		isContainer: false,
+		hasEmbeddedItems: true
+	},
+	spatialUnit: {
+		aliases: ["spatialUnit"],
+		label: "spatial unit",
+		hasCollection: true,
+		isTreeItem: true,
+		isSetItem: true,
+		isHeadingItem: false,
+		isContextItem: true,
+		isContainer: false,
+		hasEmbeddedItems: true
+	},
+	period: {
+		aliases: ["period"],
+		label: "period",
+		hasCollection: true,
+		isTreeItem: true,
+		isSetItem: true,
+		isHeadingItem: false,
+		isContextItem: true,
+		isContainer: false,
+		hasEmbeddedItems: true
+	},
+	person: {
+		aliases: ["person"],
+		label: "person",
+		hasCollection: true,
+		isTreeItem: true,
+		isSetItem: true,
+		isHeadingItem: true,
+		isContextItem: false,
+		isContainer: false,
+		hasEmbeddedItems: false
+	},
+	propertyVariable: {
+		aliases: ["propertyVariable", "variable"],
+		label: "property variable",
+		hasCollection: true,
+		isTreeItem: true,
+		isSetItem: true,
+		isHeadingItem: true,
+		isContextItem: true,
+		isContainer: false,
+		hasEmbeddedItems: false
+	},
+	propertyValue: {
+		aliases: ["propertyValue", "value"],
+		label: "property value",
+		hasCollection: true,
+		isTreeItem: true,
+		isSetItem: true,
+		isHeadingItem: true,
+		isContextItem: true,
+		isContainer: false,
+		hasEmbeddedItems: false
+	},
+	resource: {
+		aliases: ["resource"],
+		label: "resource",
+		hasCollection: true,
+		isTreeItem: true,
+		isSetItem: true,
+		isHeadingItem: true,
+		isContextItem: true,
+		isContainer: false,
+		hasEmbeddedItems: true
+	},
+	text: {
+		aliases: ["text"],
+		label: "text",
+		hasCollection: true,
+		isTreeItem: true,
+		isSetItem: true,
+		isHeadingItem: true,
+		isContextItem: true,
+		isContainer: false,
+		hasEmbeddedItems: false
+	},
+	set: {
+		aliases: ["set"],
+		label: "set",
+		hasCollection: true,
+		isTreeItem: true,
+		isSetItem: true,
+		isHeadingItem: true,
+		isContextItem: false,
+		isContainer: true,
+		hasEmbeddedItems: true
+	},
+	dictionaryUnit: {
+		aliases: ["dictionaryUnit"],
+		label: "dictionary unit",
+		hasCollection: false,
+		isTreeItem: false,
+		isSetItem: false,
+		isHeadingItem: false,
+		isContextItem: false,
+		isContainer: false,
+		hasEmbeddedItems: false
+	},
+	heading: {
+		aliases: ["heading"],
+		label: "heading",
+		hasCollection: false,
+		isTreeItem: false,
+		isSetItem: false,
+		isHeadingItem: false,
+		isContextItem: false,
+		isContainer: false,
+		hasEmbeddedItems: false
+	}
+};
+/**
+* Every element name OCHRE serves an item category under, canonical name first
+* @internal
+*/
+const ITEM_CATEGORY_ALIASES = {
+	tree: ITEM_CATEGORY_FACTS.tree.aliases,
+	bibliography: ITEM_CATEGORY_FACTS.bibliography.aliases,
+	concept: ITEM_CATEGORY_FACTS.concept.aliases,
+	spatialUnit: ITEM_CATEGORY_FACTS.spatialUnit.aliases,
+	period: ITEM_CATEGORY_FACTS.period.aliases,
+	person: ITEM_CATEGORY_FACTS.person.aliases,
+	propertyVariable: ITEM_CATEGORY_FACTS.propertyVariable.aliases,
+	propertyValue: ITEM_CATEGORY_FACTS.propertyValue.aliases,
+	resource: ITEM_CATEGORY_FACTS.resource.aliases,
+	text: ITEM_CATEGORY_FACTS.text.aliases,
+	set: ITEM_CATEGORY_FACTS.set.aliases,
+	dictionaryUnit: ITEM_CATEGORY_FACTS.dictionaryUnit.aliases
+};
+function categoriesWhere(isIncluded) {
+	const categories = [];
+	for (const [category, facts] of Object.entries(ITEM_CATEGORY_FACTS)) if (isIncluded(facts)) categories.push(category);
+	return categories;
+}
+/**
+* The canonical category each element name maps to
+* @internal
+*/
+const ITEM_CATEGORY_BY_ALIAS = new Map(Object.entries(ITEM_CATEGORY_FACTS).flatMap(([category, facts]) => facts.aliases.map((alias) => [alias, category])));
+/**
+* The OCHRE collections an item document can live in
+*
+* Document URIs are bare item UUIDs, so a lookup by UUID does not need these.
+* A search does: `fn:collection("ochre/<category>")`.
+* @internal
+*/
+const OCHRE_COLLECTION_CATEGORIES = categoriesWhere((facts) => facts.hasCollection);
+/**
+* The item categories that can sit directly inside a Tree
+* @internal
+*/
+const TREE_ITEM_CATEGORIES = categoriesWhere((facts) => facts.isTreeItem);
+/**
+* The item categories that can sit directly inside a Set
+* @internal
+*/
+const SET_ITEM_CATEGORIES = categoriesWhere((facts) => facts.isSetItem);
+/**
+* The item categories that can sit under a heading
+* @internal
+*/
+const HEADING_ITEM_CATEGORIES = categoriesWhere((facts) => facts.isHeadingItem);
+/**
+* The item categories that hold other items under a `containedItemCategory`
+* @internal
+*/
+const ITEM_CONTAINER_CATEGORIES = categoriesWhere((facts) => facts.isContainer);
+/**
+* The item categories that carry an embedded item hierarchy
+* @internal
+*/
+const ITEM_CATEGORIES_WITH_EMBEDDED_ITEMS = categoriesWhere((facts) => facts.hasEmbeddedItems);
+/**
+* Each element name that can appear in a context path, and the category it means
+* @internal
+*/
+const CONTEXT_CATEGORY_ALIASES = Object.entries(ITEM_CATEGORY_FACTS).flatMap(([category, facts]) => facts.isContextItem ? facts.aliases.map((alias) => ({
+	alias,
+	category
+})) : []);
+/**
+* Whether an item of this category holds other items
+* @param category - The item category
+* @returns True when the category accepts a `containedItemCategory`
+* @internal
+*/
+function isItemContainerCategory(category) {
+	return ITEM_CATEGORY_FACTS[category].isContainer;
+}
+/**
+* Whether an item of this category carries an embedded item hierarchy
+* @param category - The item category
+* @returns True when the category exposes embedded items
+* @internal
+*/
+function isItemCategoryWithEmbeddedItems(category) {
+	return ITEM_CATEGORY_FACTS[category].hasEmbeddedItems;
+}
+/**
+* Whether an item of this category can sit under a heading
+* @param category - The item category
+* @returns True when the category is allowed under a heading
+* @internal
+*/
+function isHeadingItemCategory(category) {
+	return ITEM_CATEGORY_FACTS[category].isHeadingItem;
+}
+/**
+* Resolve an OCHRE element name to the category it means
+* @param category - The element name, which may be an alias
+* @returns The canonical category, or null when the name is not one
+* @internal
+*/
+function normalizeItemCategory(category) {
+	if (category == null) return null;
+	const normalizedCategory = ITEM_CATEGORY_BY_ALIAS.get(category);
+	return normalizedCategory != null && ITEM_CATEGORY_FACTS[normalizedCategory].isSetItem ? normalizedCategory : null;
+}
+//#endregion
+export { CONTEXT_CATEGORY_ALIASES, HEADING_ITEM_CATEGORIES, ITEM_CATEGORIES_WITH_EMBEDDED_ITEMS, ITEM_CATEGORY_ALIASES, ITEM_CATEGORY_BY_ALIAS, ITEM_CATEGORY_FACTS, ITEM_CONTAINER_CATEGORIES, OCHRE_COLLECTION_CATEGORIES, SET_ITEM_CATEGORIES, TREE_ITEM_CATEGORIES, isHeadingItemCategory, isItemCategoryWithEmbeddedItems, isItemContainerCategory, normalizeItemCategory };

package/dist/constants.d.mts

@@ -3,6 +3,20 @@ import { X2jOptions } from "fast-xml-parser";
 export declare const XML_ARRAY_TAGS: ReadonlyArray<string>;
 export declare const XML_PARSER_OPTIONS: X2jOptions;
 export declare const DEFAULT_LANGUAGES: readonly ["eng"];
+/**
+ * The default page size to use for fetching paginated items
+ */
+export declare const DEFAULT_PAGE_SIZE = 48;
+export declare const OCHRE_ENDPOINT = "https://ochre.lib.uchicago.edu/ochre/v2/ochre.php";
+export declare const PERMANENT_IDENTIFICATION_URL_PREFIX = "https://pi.lib.uchicago.edu/1001/org/ochre/";
+/**
+ * Build the URL of an OCHRE item document
+ * @param uuid - The UUID of the OCHRE item
+ * @param searchParameters - Extra query string parameters to append
+ * @returns The item document URL
+ * @internal
+ */
+export declare function getOchreItemUrl(uuid: string, searchParameters?: string): string;
 export declare const BELONGS_TO_COLLECTION_UUID = "30054cb2-909a-4f34-8db9-8fe7369d691d";
 export declare const PRESENTATION_ITEM_UUID = "f1c131b6-1498-48a4-95bf-a9edae9fd518";
 export declare const TEXT_ANNOTATION_UUID = "b9ca2732-78f4-416e-b77f-dae7647e68a9";

package/dist/constants.mjs

@@ -72,6 +72,23 @@ const XML_PARSER_OPTIONS = {
 	}
 };
 const DEFAULT_LANGUAGES = ["eng"];
+/**
+* The default page size to use for fetching paginated items
+*/
+const DEFAULT_PAGE_SIZE = 48;
+const OCHRE_ENDPOINT = "https://ochre.lib.uchicago.edu/ochre/v2/ochre.php";
+const PERMANENT_IDENTIFICATION_URL_PREFIX = "https://pi.lib.uchicago.edu/1001/org/ochre/";
+/**
+* Build the URL of an OCHRE item document
+* @param uuid - The UUID of the OCHRE item
+* @param searchParameters - Extra query string parameters to append
+* @returns The item document URL
+* @internal
+*/
+function getOchreItemUrl(uuid, searchParameters) {
+	const suffix = searchParameters == null ? "" : `&${searchParameters}`;
+	return `${OCHRE_ENDPOINT}?uuid=${uuid}${suffix}`;
+}
 const BELONGS_TO_COLLECTION_UUID = "30054cb2-909a-4f34-8db9-8fe7369d691d";
 const PRESENTATION_ITEM_UUID = "f1c131b6-1498-48a4-95bf-a9edae9fd518";
 const TEXT_ANNOTATION_UUID = "b9ca2732-78f4-416e-b77f-dae7647e68a9";
@@ -82,4 +99,4 @@ const TEXT_ANNOTATION_TEXT_STYLING_UUID = "3e6f86ab-df81-45ae-8257-e2867357df56"
 const TEXT_ANNOTATION_TEXT_STYLING_VARIANT_UUID = "e1647bef-d801-4100-bdde-d081c422f763";
 const TEXT_ANNOTATION_TEXT_STYLING_HEADING_LEVEL_UUID = "d4266f0b-3f8d-4b32-8c15-4b229c8bb11e";
 //#endregion
-export { BELONGS_TO_COLLECTION_UUID, DEFAULT_LANGUAGES, PRESENTATION_ITEM_UUID, TEXT_ANNOTATION_ENTRY_PAGE_VARIANT_UUID, TEXT_ANNOTATION_HOVER_CARD_UUID, TEXT_ANNOTATION_ITEM_PAGE_VARIANT_UUID, TEXT_ANNOTATION_TEXT_STYLING_HEADING_LEVEL_UUID, TEXT_ANNOTATION_TEXT_STYLING_UUID, TEXT_ANNOTATION_TEXT_STYLING_VARIANT_UUID, TEXT_ANNOTATION_UUID, XML_ARRAY_TAGS, XML_PARSER_OPTIONS };
+export { BELONGS_TO_COLLECTION_UUID, DEFAULT_LANGUAGES, DEFAULT_PAGE_SIZE, OCHRE_ENDPOINT, PERMANENT_IDENTIFICATION_URL_PREFIX, PRESENTATION_ITEM_UUID, TEXT_ANNOTATION_ENTRY_PAGE_VARIANT_UUID, TEXT_ANNOTATION_HOVER_CARD_UUID, TEXT_ANNOTATION_ITEM_PAGE_VARIANT_UUID, TEXT_ANNOTATION_TEXT_STYLING_HEADING_LEVEL_UUID, TEXT_ANNOTATION_TEXT_STYLING_UUID, TEXT_ANNOTATION_TEXT_STYLING_VARIANT_UUID, TEXT_ANNOTATION_UUID, XML_ARRAY_TAGS, XML_PARSER_OPTIONS, getOchreItemUrl };

package/dist/errors.d.mts

@@ -0,0 +1,23 @@
+import * as v from "valibot";
+//#region src/errors.d.ts
+type SchemaValidationIssue = v.BaseIssue<unknown>;
+/**
+ * Render an error as a short message and a fully detailed report
+ * @param error - The thrown value
+ * @param fallbackMessage - The message to use when the value is not an Error
+ * @returns The message and the detailed report
+ * @internal
+ */
+export declare function getErrorOutput(error: unknown, fallbackMessage: string): {
+  error: string;
+  detailedError: string;
+};
+/**
+ * Wrap schema validation issues in an error {@link getErrorOutput} can render
+ * @param message - The failure message
+ * @param issues - The validation issues to carry as the cause
+ * @returns The error
+ * @internal
+ */
+export declare function createSchemaValidationError(message: string, issues: ReadonlyArray<SchemaValidationIssue>): Error;
+//#endregion