ochre-sdk 1.1.0 → 1.1.2

package/dist/types/index.d.mts

@@ -779,6 +779,15 @@ export type SetItemsSort = {
   target: "title";
   direction?: SetItemsSortDirection;
   language?: string;
+} |
+/**
+ * Sort on the item's own date, falling back to its first interpretation's
+ * date. A Concept carries no date of its own and dates its interpretations
+ * instead, so the two together are the one date an item has.
+ */
+{
+  target: "date";
+  direction?: SetItemsSortDirection;
 } | {
   target: "propertyValue";
   propertyVariableUuid: string;
@@ -888,4 +897,34 @@ export type QueryGroup = {
  * Represents a query for Set items
  */
 export type Query = QueryLeaf | QueryGroup;
+export type AnyBibliography<T extends LanguageCodes = LanguageCodes> = Bibliography<T, ItemPayloadKind>;
+export type AnyConcept<T extends LanguageCodes = LanguageCodes> = Concept<T, ItemPayloadKind>;
+export type AnyItem<U extends ItemCategory = ItemCategory, V extends ContainedItemCategory<U> = ContainedItemCategory<U>, T extends LanguageCodes = LanguageCodes> = Item<U, V, T, ItemPayloadKind>;
+export type AnyPeriod<T extends LanguageCodes = LanguageCodes> = Period<T, ItemPayloadKind>;
+export type AnyPerson<T extends LanguageCodes = LanguageCodes> = Person<T, ItemPayloadKind>;
+export type AnyPropertyValue<T extends LanguageCodes = LanguageCodes> = PropertyValue<T, ItemPayloadKind>;
+export type AnyPropertyVariable<T extends LanguageCodes = LanguageCodes> = PropertyVariable<T, ItemPayloadKind>;
+export type AnyResource<T extends LanguageCodes = LanguageCodes> = Resource<T, ItemPayloadKind>;
+export type AnySet<U extends SetItemCategory = SetItemCategory, T extends LanguageCodes = LanguageCodes> = Set<U, T, ItemPayloadKind>;
+export type AnySpatialUnit<T extends LanguageCodes = LanguageCodes> = SpatialUnit<T, ItemPayloadKind>;
+export type AnyText<T extends LanguageCodes = LanguageCodes> = Text<T, ItemPayloadKind>;
+export type AnyTree<U extends TreeItemCategory = TreeItemCategory, T extends LanguageCodes = LanguageCodes> = Tree<U, T, ItemPayloadKind>;
+export type EmbeddedBibliography<T extends LanguageCodes = LanguageCodes> = Bibliography<T, "embedded">;
+export type EmbeddedConcept<T extends LanguageCodes = LanguageCodes> = Concept<T, "embedded">;
+export type EmbeddedItem<U extends ItemCategory = ItemCategory, V extends ContainedItemCategory<U> = ContainedItemCategory<U>, T extends LanguageCodes = LanguageCodes> = Item<U, V, T, "embedded">;
+export type EmbeddedPeriod<T extends LanguageCodes = LanguageCodes> = Period<T, "embedded">;
+export type EmbeddedPerson<T extends LanguageCodes = LanguageCodes> = Person<T, "embedded">;
+export type EmbeddedPropertyValue<T extends LanguageCodes = LanguageCodes> = PropertyValue<T, "embedded">;
+export type EmbeddedPropertyVariable<T extends LanguageCodes = LanguageCodes> = PropertyVariable<T, "embedded">;
+export type EmbeddedResource<T extends LanguageCodes = LanguageCodes> = Resource<T, "embedded">;
+export type EmbeddedSet<U extends SetItemCategory = SetItemCategory, T extends LanguageCodes = LanguageCodes> = Set<U, T, "embedded">;
+export type EmbeddedSpatialUnit<T extends LanguageCodes = LanguageCodes> = SpatialUnit<T, "embedded">;
+export type EmbeddedText<T extends LanguageCodes = LanguageCodes> = Text<T, "embedded">;
+export type EmbeddedTree<U extends TreeItemCategory = TreeItemCategory, T extends LanguageCodes = LanguageCodes> = Tree<U, T, "embedded">;
+export type ItemProperty<T extends LanguageCodes = LanguageCodes> = Property<T> | SetItemProperty<T>;
+/**
+ * The category of items that expose recursive subitem structures.
+ */
+export type RecursiveItemCategory = Exclude<ItemCategory, "tree" | "person" | "propertyVariable" | "propertyValue" | "set">;
+export type TopLevelItem<U extends ItemCategory = ItemCategory, V extends ContainedItemCategory<U> = ContainedItemCategory<U>, T extends LanguageCodes = LanguageCodes> = Item<U, V, T, "topLevel">;
 //#endregion

package/dist/types/website.d.mts

@@ -1,6 +1,6 @@
 import { MultilingualString } from "../parsers/multilingual.mjs";
 import { Prettify } from "./utilities.mjs";
-import { Bibliography, Identification, LanguageCodes, License, Metadata, Person, QueryablePropertyValueDataType } from "./index.mjs";
+import { Bibliography, Identification, ItemCategory, LanguageCodes, License, Metadata, Person, QueryablePropertyValueDataType } from "./index.mjs";
 //#region src/types/website.d.ts
 /**
  * Represents a context tree level item with a variable and value
@@ -552,4 +552,9 @@ export type ProtectedWebsite<T extends LanguageCodes = LanguageCodes> = {
     privacy: "password" | "credentials-ochre";
   };
 };
+export type AccordionWebBlock<T extends LanguageCodes = LanguageCodes> = WebBlock<T, "accordion">;
+/**
+ * Represents a stylesheet item with its UUID and category
+ */
+export type StylesheetCategory = Extract<ItemCategory, "propertyVariable" | "propertyValue">;
 //#endregion

package/dist/xml/schemas.d.mts

@@ -1816,7 +1816,7 @@ export declare const XMLGalleryData: v.ObjectSchema<{
                     rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
                     whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
                   }, "XMLString: Shape error">], undefined>, undefined>, undefined>;
-                  readonly identification: v.OptionalSchema<v.ObjectSchema<{
+                  readonly identification: v.OptionalSchema<v.OptionalSchema<v.ObjectSchema<{
                     readonly label: v.UnionSchema<[v.ObjectSchema<{
                       readonly content: v.ArraySchema<v.ObjectSchema<{
                         readonly links: v.OptionalSchema<v.LazySchema<v.GenericSchema<unknown, XMLLink$1>>, undefined>;
@@ -1914,7 +1914,11 @@ export declare const XMLGalleryData: v.ObjectSchema<{
                       rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
                       whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
                     }, "XMLString: Shape error">, v.StringSchema<"XMLIdentification: website is string and optional">], undefined>, undefined>;
-                  }, "XMLIdentification: Shape error">, undefined>;
+                  }, "XMLIdentification: Shape error">, {
+                    readonly label: {
+                      readonly content: readonly [];
+                    };
+                  }>, undefined>;
                   readonly context: v.OptionalSchema<v.OptionalSchema<v.ArraySchema<v.UnionSchema<[v.ObjectSchema<{
                     readonly context: v.ArraySchema<v.UnionSchema<[v.ObjectWithRestSchema<{
                       readonly project: v.ObjectSchema<{
@@ -2213,7 +2217,7 @@ export declare const XMLGalleryData: v.ObjectSchema<{
                 rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
                 whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
               }, "XMLString: Shape error">], undefined>, undefined>;
-              readonly identification: v.ObjectSchema<{
+              readonly identification: v.OptionalSchema<v.ObjectSchema<{
                 readonly label: v.UnionSchema<[v.ObjectSchema<{
                   readonly content: v.ArraySchema<v.ObjectSchema<{
                     readonly links: v.OptionalSchema<v.LazySchema<v.GenericSchema<unknown, XMLLink$1>>, undefined>;
@@ -2311,7 +2315,11 @@ export declare const XMLGalleryData: v.ObjectSchema<{
                   rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
                   whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
                 }, "XMLString: Shape error">, v.StringSchema<"XMLIdentification: website is string and optional">], undefined>, undefined>;
-              }, "XMLIdentification: Shape error">;
+              }, "XMLIdentification: Shape error">, {
+                readonly label: {
+                  readonly content: readonly [];
+                };
+              }>;
               readonly context: v.OptionalSchema<v.ArraySchema<v.UnionSchema<[v.ObjectSchema<{
                 readonly context: v.ArraySchema<v.UnionSchema<[v.ObjectWithRestSchema<{
                   readonly project: v.ObjectSchema<{
@@ -2961,7 +2969,7 @@ export declare const XMLGalleryData: v.ObjectSchema<{
                 rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
                 whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
               }, "XMLString: Shape error">], undefined>, undefined>, undefined>;
-              readonly identification: v.OptionalSchema<v.ObjectSchema<{
+              readonly identification: v.OptionalSchema<v.OptionalSchema<v.ObjectSchema<{
                 readonly label: v.UnionSchema<[v.ObjectSchema<{
                   readonly content: v.ArraySchema<v.ObjectSchema<{
                     readonly links: v.OptionalSchema<v.LazySchema<v.GenericSchema<unknown, XMLLink$1>>, undefined>;
@@ -3059,7 +3067,11 @@ export declare const XMLGalleryData: v.ObjectSchema<{
                   rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
                   whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
                 }, "XMLString: Shape error">, v.StringSchema<"XMLIdentification: website is string and optional">], undefined>, undefined>;
-              }, "XMLIdentification: Shape error">, undefined>;
+              }, "XMLIdentification: Shape error">, {
+                readonly label: {
+                  readonly content: readonly [];
+                };
+              }>, undefined>;
               readonly context: v.OptionalSchema<v.OptionalSchema<v.ArraySchema<v.UnionSchema<[v.ObjectSchema<{
                 readonly context: v.ArraySchema<v.UnionSchema<[v.ObjectWithRestSchema<{
                   readonly project: v.ObjectSchema<{
@@ -3351,7 +3363,7 @@ export declare const XMLGalleryData: v.ObjectSchema<{
             rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
             whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
           }, "XMLString: Shape error">], undefined>, undefined>;
-          readonly identification: v.ObjectSchema<{
+          readonly identification: v.OptionalSchema<v.ObjectSchema<{
             readonly label: v.UnionSchema<[v.ObjectSchema<{
               readonly content: v.ArraySchema<v.ObjectSchema<{
                 readonly links: v.OptionalSchema<v.LazySchema<v.GenericSchema<unknown, XMLLink$1>>, undefined>;
@@ -3449,7 +3461,11 @@ export declare const XMLGalleryData: v.ObjectSchema<{
               rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
               whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
             }, "XMLString: Shape error">, v.StringSchema<"XMLIdentification: website is string and optional">], undefined>, undefined>;
-          }, "XMLIdentification: Shape error">;
+          }, "XMLIdentification: Shape error">, {
+            readonly label: {
+              readonly content: readonly [];
+            };
+          }>;
           readonly context: v.OptionalSchema<v.ArraySchema<v.UnionSchema<[v.ObjectSchema<{
             readonly context: v.ArraySchema<v.UnionSchema<[v.ObjectWithRestSchema<{
               readonly project: v.ObjectSchema<{
@@ -5668,7 +5684,7 @@ export declare const XMLWebsiteData: v.ObjectSchema<{
           rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
           whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
         }, "XMLString: Shape error">], undefined>, undefined>;
-        readonly identification: v.ObjectSchema<{
+        readonly identification: v.OptionalSchema<v.ObjectSchema<{
           readonly label: v.UnionSchema<[v.ObjectSchema<{
             readonly content: v.ArraySchema<v.ObjectSchema<{
               readonly links: v.OptionalSchema<v.LazySchema<v.GenericSchema<unknown, XMLLink$1>>, undefined>;
@@ -5766,7 +5782,11 @@ export declare const XMLWebsiteData: v.ObjectSchema<{
             rend: v.OptionalSchema<v.StringSchema<"XMLString: rend is string and optional">, undefined>;
             whitespace: v.OptionalSchema<v.StringSchema<"XMLString: whitespace is string and optional">, undefined>;
           }, "XMLString: Shape error">, v.StringSchema<"XMLIdentification: website is string and optional">], undefined>, undefined>;
-        }, "XMLIdentification: Shape error">;
+        }, "XMLIdentification: Shape error">, {
+          readonly label: {
+            readonly content: readonly [];
+          };
+        }>;
         readonly context: v.OptionalSchema<v.ArraySchema<v.UnionSchema<[v.ObjectSchema<{
           readonly context: v.ArraySchema<v.UnionSchema<[v.ObjectWithRestSchema<{
             readonly project: v.ObjectSchema<{

package/dist/xml/schemas.mjs

@@ -286,7 +286,7 @@ const XMLBaseItem = v.object({
 	availability: v.optional(v.object({ license: XMLLicense })),
 	copyright: v.optional(v.union([XMLContent, XMLString])),
 	watermark: v.optional(v.union([XMLContent, XMLString])),
-	identification: XMLIdentification,
+	identification: v.optional(XMLIdentification, { label: { content: [] } }),
 	context: v.optional(XMLContext),
 	creators: v.optional(v.object({ creator: v.array(v.lazy(() => XMLPerson)) }, "XMLBaseItem: creators is object with creator array of XMLPerson")),
 	description: v.optional(XMLContent),
@@ -402,7 +402,8 @@ const XMLHeading = v.intersect([v.object({
 	v.optional(v.object({ propertyValue: v.array(v.lazy(() => XMLPropertyValue)) })),
 	v.optional(v.object({ resource: v.array(v.union([v.lazy(() => XMLResource), v.object({ resource: v.array(v.lazy(() => XMLResource)) })])) })),
 	v.optional(v.object({ text: v.array(v.lazy(() => XMLText)) })),
-	v.optional(v.object({ set: v.array(v.lazy(() => XMLSet)) }))
+	v.optional(v.object({ set: v.array(v.lazy(() => XMLSet)) })),
+	v.object({})
 ])]);
 const XMLTree = v.object({
 	...XMLBaseItem.entries,

package/dist/xml/types.d.mts

@@ -1,5 +1,5 @@
 declare namespace types_d_exports {
-  export { XMLBaseItem, XMLBibliography, XMLConcept, XMLContent, XMLContext, XMLContextGroup, XMLContextItem, XMLContextValue, XMLCoordinate, XMLCoordinates, XMLCoordinatesSource, XMLData, XMLDataItem, XMLDictionaryUnit, XMLEmptyContext, XMLEvent, XMLGallery, XMLGalleryData, XMLHeading, XMLIdentification, XMLImage, XMLImageMap, XMLImageMapArea, XMLInterpretation, XMLItemCategory, XMLItemLinks, XMLItemLinksData, XMLLicense, XMLLink, XMLLinkedBaseItem, XMLLinkedBibliography, XMLLinkedConcept, XMLLinkedPeriod, XMLLinkedPerson, XMLLinkedPropertyValue, XMLLinkedPropertyVariable, XMLLinkedResource, XMLLinkedSet, XMLLinkedSpatialUnit, XMLLinkedText, XMLLinkedTree, XMLMetadata, XMLNote, XMLObservation, XMLPeriod, XMLPerson, XMLProperty, XMLPropertyRelation, XMLPropertyValue, XMLPropertyVariable, XMLRecursiveItemCategory, XMLResource, XMLRichTextEnvelope, XMLSection, XMLSet, XMLSetItems, XMLSetItemsData, XMLSimplifiedProperty, XMLSpatialUnit, XMLString, XMLText, XMLTree, XMLWebsiteContext, XMLWebsiteContextItem, XMLWebsiteContextLevel, XMLWebsiteData, XMLWebsiteFilterContext, XMLWebsiteFilterContextItem, XMLWebsiteOptions, XMLWebsiteProperties, XMLWebsiteResource, XMLWebsiteResourceGroup, XMLWebsiteResourceItem, XMLWebsiteScope, XMLWebsiteSegment, XMLWebsiteStyle, XMLWebsiteTree };
+  export { XMLBaseItem, XMLBibliography, XMLConcept, XMLContent, XMLContext, XMLContextGroup, XMLContextItem, XMLContextValue, XMLCoordinate, XMLCoordinates, XMLCoordinatesSource, XMLData, XMLDataItem, XMLDictionaryUnit, XMLEmptyContext, XMLEvent, XMLGallery, XMLGalleryData, XMLHeading, XMLHeadingItemCategory, XMLIdentification, XMLImage, XMLImageMap, XMLImageMapArea, XMLInterpretation, XMLItemCategory, XMLItemLinks, XMLItemLinksData, XMLLicense, XMLLink, XMLLinkedBaseItem, XMLLinkedBibliography, XMLLinkedConcept, XMLLinkedPeriod, XMLLinkedPerson, XMLLinkedPropertyValue, XMLLinkedPropertyVariable, XMLLinkedResource, XMLLinkedSet, XMLLinkedSpatialUnit, XMLLinkedText, XMLLinkedTree, XMLMetadata, XMLNote, XMLObservation, XMLPeriod, XMLPerson, XMLProperty, XMLPropertyRelation, XMLPropertyValue, XMLPropertyVariable, XMLRecursiveItemCategory, XMLResource, XMLRichTextEnvelope, XMLSection, XMLSet, XMLSetItems, XMLSetItemsData, XMLSimplifiedProperty, XMLSpatialUnit, XMLString, XMLText, XMLTree, XMLWebsiteContext, XMLWebsiteContextItem, XMLWebsiteContextLevel, XMLWebsiteData, XMLWebsiteFilterContext, XMLWebsiteFilterContextItem, XMLWebsiteOptions, XMLWebsiteProperties, XMLWebsiteResource, XMLWebsiteResourceGroup, XMLWebsiteResourceItem, XMLWebsiteScope, XMLWebsiteSegment, XMLWebsiteStyle, XMLWebsiteTree };
 }
 export type XMLItemCategory = "tree" | "bibliography" | "spatialUnit" | "concept" | "period" | "person" | "propertyVariable" | "variable" | "propertyValue" | "value" | "text" | "resource" | "set";
 export type XMLRecursiveItemCategory = Exclude<XMLItemCategory, "tree" | "person" | "propertyVariable" | "propertyValue" | "set">;
@@ -901,5 +901,6 @@ export type XMLWebsiteData = {
     };
   };
 };
+export type XMLHeadingItemCategory = Exclude<XMLItemCategory, "tree" | "bibliography" | "spatialUnit" | "concept" | "period">;
 //#endregion
 export { types_d_exports };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -47,18 +47,18 @@
   "dependencies": {
     "fast-equals": "^6.0.3",
     "fast-xml-parser": "^5.11.1",
-    "valibot": "^1.4.2"
+    "valibot": "^1.5.0"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^9.5.1",
-    "@types/node": "^24.13.3",
+    "@types/node": "^24.13.4",
     "bumpp": "^12.3.0",
-    "eslint": "^10.9.1",
+    "eslint": "^10.10.0",
     "eslint-plugin-erasable-syntax-only": "^0.7.1",
     "eslint-plugin-slop": "^0.1.3",
     "eslint-plugin-sonarjs": "^4.2.0",
-    "knip": "^6.34.0",
-    "oxfmt": "^0.66.0",
+    "knip": "^6.35.1",
+    "oxfmt": "^0.67.0",
     "tsdown": "^0.23.0",
     "typescript": "^6.0.3",
     "vitest": "^5.0.0"