ochre-sdk 1.3.12 → 1.3.13

package/dist/xml/types.d.mts

@@ -139,6 +139,8 @@ export type XMLCoordinate = {
   latitude: number;
   longitude: number;
   altitude?: number;
+  WKID?: number;
+  rawValue?: string;
   source?: XMLCoordinatesSource;
 } | {
   type: "plane";
@@ -887,23 +889,49 @@ export type XMLSetItemsData = {
     };
   };
 };
-export type XMLSetItemLocation = {
+export type XMLItemLocation = {
   uuid: string;
   category: string;
+  scopeUuid: string;
   publicationDateTime?: Date;
   identification: XMLIdentification;
   coordinates?: XMLCoordinates;
+  mapData?: XMLSpatialUnit["mapData"];
   value?: Array<{
     variable: string;
     uuid: string;
   } & XMLContent>;
 };
-export type XMLSetItemLocationsData = {
+export type XMLItemLocationsData = {
   result: {
     ochre: {
       items: {
         totalCount: number;
-        itemLocation?: Array<XMLSetItemLocation>;
+        itemLocation?: Array<XMLItemLocation>;
+      };
+    };
+  };
+};
+export type XMLMapLayer = {
+  uuid: string;
+  category: string;
+  type?: string;
+  href?: string;
+  WKID?: number;
+  identification: XMLIdentification;
+};
+export type XMLMapSource = {
+  uuid: string;
+  category: string;
+  WKID?: number;
+  identification: XMLIdentification;
+  mapLayer?: Array<XMLMapLayer>;
+};
+export type XMLMapSourcesData = {
+  result: {
+    ochre: {
+      mapSources: {
+        mapSource?: Array<XMLMapSource>;
       };
     };
   };
@@ -930,6 +958,11 @@ export type XMLWebsiteData = {
       metadata: XMLMetadata;
       persistentUrl?: string;
       tree: Array<XMLWebsiteTree>;
+      styleLabels?: {
+        styleLabel?: Array<{
+          valueUuid: string;
+        } & XMLContent>;
+      };
     };
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "1.3.12",
+  "version": "1.3.13",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -66,8 +66,8 @@
   "scripts": {
     "dev": "tsdown src/index.ts --watch",
     "build": "tsdown",
-    "lint": "knip && eslint --concurrency auto .",
-    "lint:fix": "knip --fix && eslint --concurrency auto --fix .",
+    "lint": "knip && eslint .",
+    "lint:fix": "knip --fix && eslint --fix .",
     "format": "oxfmt --check",
     "format:fix": "oxfmt",
     "check-types": "tsc --noEmit",

package/dist/fetchers/set/item-locations.d.mts

@@ -1,35 +0,0 @@
-import { Query, SetItemLocation } from "../../types/index.mjs";
-import { FetchBaseOptions, FetchLanguages } from "../../parsers/helpers.mjs";
-//#region src/fetchers/set/item-locations.d.ts
-/**
- * Fetches the location of every Set item that matches a query, without paging
- *
- * Each item carries only its identification, its publication date, its coordinates and the values of
- * the requested property variables (inherited values included), which is what a
- * map needs to draw and colour every match while a list pages through the same
- * query with {@link fetchSetItems}.
- *
- * @param parameters - The parameters for the fetch
- * @param parameters.setScopeUuids - The Set scope UUIDs to filter by
- * @param parameters.queries - Recursive query tree used to filter matching items
- * @param parameters.propertyVariableUuids - The property variables whose values each item should carry
- * @param options - Options for the fetch
- * @param options.fetch - The fetch function to use
- * @returns The item locations, or an error if the fetch/parse fails
- */
-export declare function fetchSetItemLocations<const TLanguages extends ReadonlyArray<string> | undefined = undefined>(parameters: {
-  setScopeUuids: Array<string>;
-  queries?: Query | null;
-  propertyVariableUuids?: Array<string>;
-}, options?: FetchBaseOptions<TLanguages>): Promise<{
-  totalCount: number;
-  items: Array<SetItemLocation<FetchLanguages<TLanguages>>>;
-  error: null;
-  detailedError: null;
-} | {
-  totalCount: null;
-  items: null;
-  error: string;
-  detailedError: string;
-}>;
-//#endregion

package/dist/fetchers/set/item-locations.mjs

@@ -1,83 +0,0 @@
-import { normalizeItemCategory } from "../../categories.mjs";
-import { getErrorOutput } from "../../errors.mjs";
-import { requestOchre } from "../request.mjs";
-import { setItemLocationsParametersSchema } from "../../schemas.mjs";
-import { parseRequiredContentLike } from "../../parsers/helpers.mjs";
-import { parseRequestedLanguages, resolveContentLanguages } from "../../parsers/languages.mjs";
-import { parseCoordinates, parseIdentification } from "../../parsers/index.mjs";
-import { XMLSetItemLocationsData } from "../../xml/schemas.mjs";
-import { getContentLanguage, stringLiteral } from "../../xquery.mjs";
-import { compileContainerItemsQuery } from "../../query.mjs";
-import * as v from "valibot";
-//#region src/fetchers/set/item-locations.ts
-async function fetchSetItemLocations(parameters, options) {
-	try {
-		const { setScopeUuids, belongsToCollectionScopeUuids, queries, propertyVariableUuids } = v.parse(setItemLocationsParametersSchema, parameters);
-		const output = await requestOchre({
-			xquery: compileContainerItemsQuery({
-				container: "set",
-				scopeUuids: setScopeUuids,
-				belongsToCollectionScopeUuids,
-				queries,
-				contentLanguage: getContentLanguage(options),
-				body: ({ items }) => `  let $propertyVariableUuids := (${Array.from(propertyVariableUuids, (uuid) => stringLiteral(uuid)).join(", ")})
-
-  return <items totalCount="{count(${items})}">{
-    for $item in ${items}
-    return <itemLocation uuid="{$item/@uuid}" category="{local-name($item)}">{
-      $item/@publicationDateTime,
-      $item/identification,
-      $item/coordinates,
-      for $value in $item//properties//property[label/@uuid = $propertyVariableUuids]/value[@uuid]
-      return <value variable="{$value/../label/@uuid}" uuid="{$value/@uuid}">{$value/content}</value>
-    }</itemLocation>
-  }</items>`
-			}),
-			schema: XMLSetItemLocationsData,
-			label: "OCHRE Set item locations",
-			options
-		});
-		const languages = resolveContentLanguages(output.result.ochre.items, parseRequestedLanguages(options?.languages));
-		const itemsByUuid = /* @__PURE__ */ new Map();
-		const itemLocations = output.result.ochre.items.itemLocation ?? [];
-		for (const itemLocation of itemLocations) {
-			const category = normalizeItemCategory(itemLocation.category);
-			if (category == null || itemsByUuid.has(itemLocation.uuid)) continue;
-			const propertyValues = [];
-			const seenPropertyValues = /* @__PURE__ */ new Set();
-			const values = itemLocation.value ?? [];
-			for (const value of values) {
-				const key = `${value.variable}:${value.uuid}`;
-				if (seenPropertyValues.has(key)) continue;
-				seenPropertyValues.add(key);
-				propertyValues.push({
-					variableUuid: value.variable,
-					valueUuid: value.uuid,
-					label: parseRequiredContentLike(value, { languages })
-				});
-			}
-			itemsByUuid.set(itemLocation.uuid, {
-				uuid: itemLocation.uuid,
-				category,
-				publicationDateTime: itemLocation.publicationDateTime ?? null,
-				identification: parseIdentification(itemLocation.identification, { languages }),
-				coordinates: parseCoordinates(itemLocation.coordinates, { languages }),
-				propertyValues
-			});
-		}
-		return {
-			totalCount: output.result.ochre.items.totalCount,
-			items: itemsByUuid.values().toArray(),
-			error: null,
-			detailedError: null
-		};
-	} catch (error) {
-		return {
-			totalCount: null,
-			items: null,
-			...getErrorOutput(error, "Failed to fetch Set item locations")
-		};
-	}
-}
-//#endregion
-export { fetchSetItemLocations };