ochre-sdk 0.19.6 → 0.19.8

package/dist/index.d.mts

@@ -1079,23 +1079,29 @@ type WebBlock<T extends WebBlockLayout = WebBlockLayout> = {
 /**
  * Fetches and parses a gallery from the OCHRE API
  *
- * @param uuid - The UUID of the gallery
- * @param filter - The filter to apply to the gallery
- * @param page - The page number to fetch
- * @param pageSize - The number of items per page
+ * @param params - The parameters for the fetch
+ * @param params.uuid - The UUID of the gallery
+ * @param params.filter - The filter to apply to the gallery
+ * @param params.page - The page number to fetch
+ * @param params.pageSize - The number of items per page
  * @param options - The options for the fetch
  * @param options.fetch - The fetch function to use
  * @param options.version - The version of the OCHRE API to use
  * @returns The parsed gallery or an error message if the fetch/parse fails
  */
-declare function fetchGallery(uuid: string, filter: string, page: number, pageSize: number, options?: {
+declare function fetchGallery(params: {
+  uuid: string;
+  filter?: string;
+  page: number;
+  pageSize: number;
+}, options?: {
   fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
   version?: ApiVersion;
 }): Promise<{
-  item: Gallery | null;
+  gallery: Gallery | null;
   error: null;
 } | {
-  item: null;
+  gallery: null;
   error: string;
 }>;
 //#endregion
@@ -1208,7 +1214,13 @@ declare function fetchPropertyValuesByPropertyVariables(params: {
 declare function fetchWebsite(abbreviation: string, options?: {
   fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
   version?: ApiVersion;
-}): Promise<[null, Website] | [string, null]>;
+}): Promise<{
+  error: null;
+  website: Website;
+} | {
+  error: string;
+  website: null;
+}>;
 //#endregion
 //#region src/utils/getters.d.ts
 /**

package/dist/index.mjs

@@ -662,16 +662,6 @@ const propertyValueContentTypeSchema = z.enum([
 	"IDREF"
 ]);
 /**
-* Schema for validating gallery parameters
-* @internal
-*/
-const gallerySchema = z.object({
-	uuid: z.string().refine(isPseudoUuid, { error: "Invalid UUID" }),
-	filter: z.string().optional(),
-	page: z.number().positive({ error: "Page must be positive" }),
-	pageSize: z.number().positive({ error: "Page size must be positive" })
-}).strict();
-/**
 * Schema for validating and parsing render options
 * @internal
 */
@@ -721,6 +711,40 @@ const boundsSchema = z.string().transform((str, ctx) => {
 	}
 }).pipe(z.tuple([z.tuple([z.number(), z.number()]), z.tuple([z.number(), z.number()])], { message: "Must contain exactly 2 coordinate pairs" }));
 
+//#endregion
+//#region src/utils/helpers.ts
+/**
+* The default API version to use
+*
+* @remarks
+* Version 1 of the OCHRE API is deprecated and will be removed in the future.
+* It points to the old Tamino server.
+*
+* Version 2 of the OCHRE API is the current version and is the default.
+* It points to the new MarkLogic server.
+*/
+const DEFAULT_API_VERSION = 2;
+/**
+* The default page size to use for fetching paginated items
+*/
+const DEFAULT_PAGE_SIZE = 48;
+/**
+* Flatten the properties of an item
+* @param item - The item whose properties to flatten
+* @returns The item with the properties flattened
+*/
+function flattenItemProperties(item) {
+	const allProperties = [];
+	if ("properties" in item) allProperties.push(...item.properties);
+	if ("observations" in item) for (const observation of item.observations) allProperties.push(...observation.properties);
+	if ("interpretations" in item) for (const interpretation of item.interpretations) allProperties.push(...interpretation.properties);
+	if ("bibliographies" in item) for (const bibliography of item.bibliographies) allProperties.push(...bibliography.properties);
+	return {
+		...item,
+		properties: flattenProperties(allProperties)
+	};
+}
+
 //#endregion
 //#region src/utils/parse/index.ts
 /**
@@ -1795,90 +1819,62 @@ function parseConcepts(concepts) {
 //#endregion
 //#region src/utils/fetchers/gallery.ts
 /**
+* Schema for validating gallery parameters
+*/
+const galleryParamsSchema = z.object({
+	uuid: uuidSchema,
+	filter: z.string().optional(),
+	page: z.number().positive({ error: "Page must be positive" }),
+	pageSize: z.number().positive({ error: "Page size must be positive" })
+});
+/**
 * Fetches and parses a gallery from the OCHRE API
 *
-* @param uuid - The UUID of the gallery
-* @param filter - The filter to apply to the gallery
-* @param page - The page number to fetch
-* @param pageSize - The number of items per page
+* @param params - The parameters for the fetch
+* @param params.uuid - The UUID of the gallery
+* @param params.filter - The filter to apply to the gallery
+* @param params.page - The page number to fetch
+* @param params.pageSize - The number of items per page
 * @param options - The options for the fetch
 * @param options.fetch - The fetch function to use
 * @param options.version - The version of the OCHRE API to use
 * @returns The parsed gallery or an error message if the fetch/parse fails
 */
-async function fetchGallery(uuid, filter, page, pageSize, options) {
+async function fetchGallery(params, options) {
 	try {
-		const { uuid: parsedUuid, filter: parsedFilter, page: parsedPage, pageSize: parsedPageSize } = gallerySchema.parse({
-			uuid,
-			filter,
-			page,
-			pageSize
-		});
-		const response = await (options?.fetch ?? fetch)(`https://ochre.lib.uchicago.edu/ochre?xquery=${encodeURIComponent(`
-        for $q in input()/ochre[@uuid='${parsedUuid}']
-        let $filtered := $q//items/resource[contains(lower-case(identification/label), lower-case('${parsedFilter}'))]
+		const version = options?.version ?? DEFAULT_API_VERSION;
+		const { uuid, filter, page, pageSize } = galleryParamsSchema.parse(params);
+		const response = await (options?.fetch ?? fetch)(`${version === 2 ? "https://ochre.lib.uchicago.edu/ochre/v2/ochre.php" : "https://ochre.lib.uchicago.edu/ochre"}?xquery=${encodeURIComponent(`<ochre>{
+        for $q in ${version === 2 ? "doc()" : "input()"}/ochre[@uuid='${uuid}']
+        let $filtered := $q//items/resource[contains(lower-case(identification/label), lower-case('${filter}'))]
         let $maxLength := count($filtered)
         return <gallery maxLength='{$maxLength}'>
           {$q/metadata/project}
           {$q/metadata/item}
-          {$filtered[position() >= ${((parsedPage - 1) * parsedPageSize + 1).toString()} and position() < ${(parsedPage * parsedPageSize + 1).toString()}]}
+          {$filtered[position() >= ${((page - 1) * pageSize + 1).toString()} and position() < ${(page * pageSize + 1).toString()}]}
         </gallery>
-      `)}&format=json`);
+      }</ochre>`)}&format=json`);
 		if (!response.ok) throw new Error("Error fetching gallery items, please try again later.");
 		const data = await response.json();
-		if (!("gallery" in data.result)) throw new Error("Failed to fetch gallery");
+		if (!("gallery" in data.result.ochre)) throw new Error("Failed to fetch gallery");
 		return {
-			item: {
-				identification: parseIdentification(data.result.gallery.item.identification),
-				projectIdentification: parseIdentification(data.result.gallery.project.identification),
-				resources: parseResources(data.result.gallery.resource ? Array.isArray(data.result.gallery.resource) ? data.result.gallery.resource : [data.result.gallery.resource] : []),
-				maxLength: data.result.gallery.maxLength
+			gallery: {
+				identification: parseIdentification(data.result.ochre.gallery.item.identification),
+				projectIdentification: parseIdentification(data.result.ochre.gallery.project.identification),
+				resources: data.result.ochre.gallery.resource ? parseResources(Array.isArray(data.result.ochre.gallery.resource) ? data.result.ochre.gallery.resource : [data.result.ochre.gallery.resource]) : [],
+				maxLength: data.result.ochre.gallery.maxLength
 			},
 			error: null
 		};
 	} catch (error) {
 		console.error(error);
 		return {
-			item: null,
+			gallery: null,
 			error: error instanceof Error ? error.message : "Failed to fetch gallery"
 		};
 	}
 }
 
-//#endregion
-//#region src/utils/helpers.ts
-/**
-* The default API version to use
-*
-* @remarks
-* Version 1 of the OCHRE API is deprecated and will be removed in the future.
-* It points to the old Tamino server.
-*
-* Version 2 of the OCHRE API is the current version and is the default.
-* It points to the new MarkLogic server.
-*/
-const DEFAULT_API_VERSION = 2;
-/**
-* The default page size to use for fetching paginated items
-*/
-const DEFAULT_PAGE_SIZE = 48;
-/**
-* Flatten the properties of an item
-* @param item - The item whose properties to flatten
-* @returns The item with the properties flattened
-*/
-function flattenItemProperties(item) {
-	const allProperties = [];
-	if ("properties" in item) allProperties.push(...item.properties);
-	if ("observations" in item) for (const observation of item.observations) allProperties.push(...observation.properties);
-	if ("interpretations" in item) for (const interpretation of item.interpretations) allProperties.push(...interpretation.properties);
-	if ("bibliographies" in item) for (const bibliography of item.bibliographies) allProperties.push(...bibliography.properties);
-	return {
-		...item,
-		properties: flattenProperties(allProperties)
-	};
-}
-
 //#endregion
 //#region src/utils/fetchers/uuid.ts
 /**
@@ -3697,6 +3693,8 @@ function parseWebsiteProperties(properties, websiteTree, sidebar) {
 	returnProperties.theme.isThemeToggleDisplayed = getPropertyValueByLabel(websiteProperties, "supports-theme-toggle") ?? true;
 	returnProperties.theme.defaultTheme = getPropertyValueByLabel(websiteProperties, "default-theme") ?? "system";
 	returnProperties.icon.logoUuid = getPropertyByLabel(websiteProperties, "logo")?.values[0]?.uuid ?? null;
+	returnProperties.icon.faviconUuid = getPropertyByLabel(websiteProperties, "favicon-ico")?.values[0]?.uuid ?? null;
+	returnProperties.icon.appleTouchIconUuid = getPropertyByLabel(websiteProperties, "favicon-img")?.values[0]?.uuid ?? null;
 	returnProperties.navbar.isDisplayed = getPropertyValueByLabel(websiteProperties, "navbar-displayed") ?? true;
 	returnProperties.navbar.variant = getPropertyValueByLabel(websiteProperties, "navbar-variant") ?? "default";
 	returnProperties.navbar.alignment = getPropertyValueByLabel(websiteProperties, "navbar-alignment") ?? "start";
@@ -3841,10 +3839,16 @@ async function fetchWebsite(abbreviation, options) {
 				abbreviation: parseFakeString(result.ochre.belongsTo)
 			};
 		}
-		return [null, parseWebsite(tree, metadata, belongsTo, { version })];
+		return {
+			error: null,
+			website: parseWebsite(tree, metadata, belongsTo, { version })
+		};
 	} catch (error) {
 		console.error(error);
-		return [error instanceof Error ? error.message : "Unknown error", null];
+		return {
+			error: error instanceof Error ? error.message : "Unknown error",
+			website: null
+		};
 	}
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "0.19.6",
+  "version": "0.19.8",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -46,7 +46,7 @@
     "zod": "^4.3.6"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^7.4.2",
+    "@antfu/eslint-config": "^7.4.3",
     "@types/node": "^24.10.13",
     "bumpp": "^10.4.1",
     "eslint": "^10.0.0",
@@ -60,6 +60,8 @@
     "build": "tsdown",
     "lint": "eslint --cache .",
     "lint:fix": "eslint --cache . --fix",
+    "lint:nocache": "eslint .",
+    "lint:nocache:fix": "eslint . --fix",
     "format": "prettier --cache --check .",
     "format:fix": "prettier --cache --write --list-different .",
     "check-types": "tsc --noEmit",