@digitalculture/ochre-sdk 0.6.1 → 0.6.3

package/dist/index.cjs

@@ -21,7 +21,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   fetchByUuid: () => fetchByUuid,
+  fetchGallery: () => fetchGallery,
   fetchItem: () => fetchItem,
+  fetchWebsite: () => fetchWebsite,
   filterProperties: () => filterProperties,
   getAllPropertyLabels: () => getAllPropertyLabels,
   getPropertyByLabel: () => getPropertyByLabel,
@@ -158,28 +160,6 @@ var whitespaceSchema = import_zod.z.string().transform((str) => str.split(" ")).
 );
 var emailSchema = import_zod.z.string().email({ message: "Invalid email" });
 
-// src/utils/helpers.ts
-function getItemCategory(keys) {
-  const categoryFound = keys.find(
-    (key) => categorySchema.safeParse(key).success
-  );
-  if (!categoryFound) {
-    const unknownKey = keys.find(
-      (key) => ![
-        "uuid",
-        "uuidBelongsTo",
-        "belongsTo",
-        "publicationDateTime",
-        "metadata",
-        "languages"
-      ].includes(key)
-    );
-    throw new Error(`Invalid OCHRE data; found unexpected "${unknownKey}" key`);
-  }
-  const categoryKey = categorySchema.parse(categoryFound);
-  return categoryKey;
-}
-
 // src/utils/getters.ts
 var DEFAULT_OPTIONS = {
   searchNestedProperties: false
@@ -588,6 +568,164 @@ ${JSON.stringify(
   }
 }
 
+// src/utils/helpers.ts
+function getItemCategory(keys) {
+  const categoryFound = keys.find(
+    (key) => categorySchema.safeParse(key).success
+  );
+  if (!categoryFound) {
+    const unknownKey = keys.find(
+      (key) => ![
+        "uuid",
+        "uuidBelongsTo",
+        "belongsTo",
+        "publicationDateTime",
+        "metadata",
+        "languages"
+      ].includes(key)
+    );
+    throw new Error(`Invalid OCHRE data; found unexpected "${unknownKey}" key`);
+  }
+  const categoryKey = categorySchema.parse(categoryFound);
+  return categoryKey;
+}
+
+// src/utils/fetchers/uuid.ts
+async function fetchByUuid(uuid) {
+  try {
+    const parsedUuid = uuidSchema.parse(uuid);
+    const response = await fetch(
+      `https://ochre.lib.uchicago.edu/ochre?uuid=${parsedUuid}&format=json&lang="*"`
+    );
+    if (!response.ok) {
+      throw new Error("Failed to fetch OCHRE data");
+    }
+    const dataRaw = await response.json();
+    if (!("ochre" in dataRaw)) {
+      throw new Error("Invalid OCHRE data: API response missing 'ochre' key");
+    }
+    return [null, dataRaw];
+  } catch (error) {
+    return [error instanceof Error ? error.message : "Unknown error", null];
+  }
+}
+
+// src/utils/fetchers/item.ts
+async function fetchItem(uuid, category) {
+  try {
+    const [error, data] = await fetchByUuid(uuid);
+    if (error !== null) {
+      throw new Error(error);
+    }
+    const categoryKey = getItemCategory(Object.keys(data.ochre));
+    let item;
+    switch (categoryKey) {
+      case "resource": {
+        if (!("resource" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'resource' key"
+          );
+        }
+        item = parseResource(data.ochre.resource);
+        break;
+      }
+      case "spatialUnit": {
+        if (!("spatialUnit" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'spatialUnit' key"
+          );
+        }
+        item = parseSpatialUnit(data.ochre.spatialUnit);
+        break;
+      }
+      case "concept": {
+        if (!("concept" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'concept' key"
+          );
+        }
+        item = parseConcept(data.ochre.concept);
+        break;
+      }
+      case "period": {
+        if (!("period" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'period' key"
+          );
+        }
+        item = parsePeriod(data.ochre.period);
+        break;
+      }
+      case "bibliography": {
+        if (!("bibliography" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'bibliography' key"
+          );
+        }
+        item = parseBibliography(data.ochre.bibliography);
+        break;
+      }
+      case "person": {
+        if (!("person" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'person' key"
+          );
+        }
+        item = parsePerson(data.ochre.person);
+        break;
+      }
+      case "propertyValue": {
+        if (!("propertyValue" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'propertyValue' key"
+          );
+        }
+        item = parsePropertyValue(data.ochre.propertyValue);
+        break;
+      }
+      case "set": {
+        if (!("set" in data.ochre)) {
+          throw new Error("Invalid OCHRE data: API response missing 'set' key");
+        }
+        item = parseSet(data.ochre.set);
+        break;
+      }
+      case "tree": {
+        if (!("tree" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'tree' key"
+          );
+        }
+        item = parseTree(data.ochre.tree);
+        break;
+      }
+      default: {
+        throw new Error("Invalid category");
+      }
+    }
+    const metadata = parseMetadata(data.ochre.metadata);
+    const belongsTo = {
+      uuid: data.ochre.uuidBelongsTo,
+      abbreviation: parseFakeString(data.ochre.belongsTo)
+    };
+    return {
+      error: null,
+      metadata,
+      belongsTo,
+      item,
+      category
+    };
+  } catch (error) {
+    return {
+      error: error instanceof Error ? error.message : "Unknown error",
+      metadata: void 0,
+      belongsTo: void 0,
+      item: void 0,
+      category: void 0
+    };
+  }
+}
+
 // src/utils/parse.ts
 function parseIdentification(identification) {
   try {
@@ -2480,145 +2618,87 @@ async function parseWebsite(websiteTree, projectName, website) {
   };
 }
 
-// src/utils/fetchers/uuid.ts
-async function fetchByUuid(uuid) {
+// src/utils/fetchers/gallery.ts
+async function fetchGallery(uuid, filter, page, perPage) {
   try {
-    const parsedUuid = uuidSchema.parse(uuid);
+    const {
+      uuid: parsedUuid,
+      filter: parsedFilter,
+      page: parsedPage,
+      perPage: parsedPerPage
+    } = gallerySchema.parse({ uuid, filter, page, perPage });
     const response = await fetch(
-      `https://ochre.lib.uchicago.edu/ochre?uuid=${parsedUuid}&format=json&lang="*"`
+      `https://ochre.lib.uchicago.edu/ochre?xquery=${encodeURIComponent(`
+        for $q in input()/ochre[@uuid='${parsedUuid}']
+        let $filtered := $q/tree/items/resource[contains(lower-case(identification/label), lower-case('${parsedFilter}'))]
+        let $maxLength := count($filtered)
+        return <gallery maxLength='{$maxLength}'>
+          {$q/metadata/project}
+          {$q/metadata/item}
+          {$filtered[position() >= ${((parsedPage - 1) * parsedPerPage + 1).toString()} and position() < ${(parsedPage * parsedPerPage + 1).toString()}]}
+        </gallery>
+      `)}&format=json`
     );
     if (!response.ok) {
-      throw new Error("Failed to fetch OCHRE data");
+      throw new Error("Error fetching gallery items, please try again later.");
     }
-    const dataRaw = await response.json();
-    if (!("ochre" in dataRaw)) {
-      throw new Error("Invalid OCHRE data: API response missing 'ochre' key");
+    const data = await response.json();
+    if (!("gallery" in data.result)) {
+      throw new Error("Failed to fetch gallery");
     }
-    return [null, dataRaw];
+    const galleryIdentification = parseIdentification(
+      data.result.gallery.item.identification
+    );
+    const galleryProjectIdentification = parseIdentification(
+      data.result.gallery.project.identification
+    );
+    const gallery = {
+      identification: galleryIdentification,
+      projectIdentification: galleryProjectIdentification,
+      resources: data.result.gallery.resource ? Array.isArray(data.result.gallery.resource) ? parseResources(data.result.gallery.resource) : [parseResource(data.result.gallery.resource)] : [],
+      maxLength: data.result.gallery.maxLength
+    };
+    return { item: gallery, error: null };
   } catch (error) {
-    return [error instanceof Error ? error.message : "Unknown error", null];
+    console.error(error);
+    return {
+      item: null,
+      error: error instanceof Error ? error.message : "Failed to fetch gallery"
+    };
   }
 }
 
-// src/utils/fetchers/item.ts
-async function fetchItem(uuid, category) {
+// src/utils/fetchers/website.ts
+async function fetchWebsite(abbreviation) {
   try {
-    const [error, data] = await fetchByUuid(uuid);
-    if (error !== null) {
-      throw new Error(error);
+    const response = await fetch(
+      `https://ochre.lib.uchicago.edu/ochre?xquery=for $q in input()/ochre[tree[@type='lesson'][identification/abbreviation='${abbreviation.toLocaleLowerCase("en-US")}']] return $q&format=json`
+    );
+    if (!response.ok) {
+      throw new Error("Failed to fetch website");
     }
-    const categoryKey = getItemCategory(Object.keys(data.ochre));
-    let item;
-    switch (categoryKey) {
-      case "resource": {
-        if (!("resource" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'resource' key"
-          );
-        }
-        item = parseResource(data.ochre.resource);
-        break;
-      }
-      case "spatialUnit": {
-        if (!("spatialUnit" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'spatialUnit' key"
-          );
-        }
-        item = parseSpatialUnit(data.ochre.spatialUnit);
-        break;
-      }
-      case "concept": {
-        if (!("concept" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'concept' key"
-          );
-        }
-        item = parseConcept(data.ochre.concept);
-        break;
-      }
-      case "period": {
-        if (!("period" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'period' key"
-          );
-        }
-        item = parsePeriod(data.ochre.period);
-        break;
-      }
-      case "bibliography": {
-        if (!("bibliography" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'bibliography' key"
-          );
-        }
-        item = parseBibliography(data.ochre.bibliography);
-        break;
-      }
-      case "person": {
-        if (!("person" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'person' key"
-          );
-        }
-        item = parsePerson(data.ochre.person);
-        break;
-      }
-      case "propertyValue": {
-        if (!("propertyValue" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'propertyValue' key"
-          );
-        }
-        item = parsePropertyValue(data.ochre.propertyValue);
-        break;
-      }
-      case "set": {
-        if (!("set" in data.ochre)) {
-          throw new Error("Invalid OCHRE data: API response missing 'set' key");
-        }
-        item = parseSet(data.ochre.set);
-        break;
-      }
-      case "tree": {
-        if (!("tree" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'tree' key"
-          );
-        }
-        item = parseTree(data.ochre.tree);
-        break;
-      }
-      default: {
-        throw new Error("Invalid category");
-      }
+    const data = await response.json();
+    if (!("ochre" in data.result) || !("tree" in data.result.ochre)) {
+      throw new Error("Failed to fetch website");
     }
-    const metadata = parseMetadata(data.ochre.metadata);
-    const belongsTo = {
-      uuid: data.ochre.uuidBelongsTo,
-      abbreviation: parseFakeString(data.ochre.belongsTo)
-    };
-    return {
-      error: null,
-      metadata,
-      belongsTo,
-      item,
-      category
-    };
+    const projectIdentification = data.result.ochre.metadata.project?.identification ? parseIdentification(data.result.ochre.metadata.project.identification) : null;
+    const website = await parseWebsite(
+      data.result.ochre.tree,
+      projectIdentification?.label ?? "",
+      data.result.ochre.metadata.project?.identification.website ?? null
+    );
+    return website;
   } catch (error) {
-    return {
-      error: error instanceof Error ? error.message : "Unknown error",
-      metadata: void 0,
-      belongsTo: void 0,
-      item: void 0,
-      category: void 0
-    };
+    console.error(error);
+    return null;
   }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   fetchByUuid,
+  fetchGallery,
   fetchItem,
+  fetchWebsite,
   filterProperties,
   getAllPropertyLabels,
   getPropertyByLabel,

package/dist/index.d.cts

@@ -619,6 +619,40 @@ type WebBlock = {
     cssStylesMobile: Array<Style>;
 };
 
+/**
+ * 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 perPage - The number of items per page
+ * @returns The parsed gallery or null if the fetch/parse fails
+ *
+ * @example
+ * ```ts
+ * const gallery = await fetchGallery("9c4da06b-f15e-40af-a747-0933eaf3587e", "1978", 1, 12);
+ * if (gallery === null) {
+ *   console.error("Failed to fetch gallery");
+ *   return;
+ * }
+ * console.log(`Fetched gallery: ${gallery.identification.label}`);
+ * console.log(`Contains ${gallery.resources.length.toLocaleString()} resources`);
+ * ```
+ *
+ * @remarks
+ * The returned gallery includes:
+ * - Gallery metadata and identification
+ * - Project identification
+ * - Resources (gallery items)
+ */
+declare function fetchGallery(uuid: string, filter: string, page: number, perPage: number): Promise<{
+    item: Gallery | null;
+    error: null;
+} | {
+    item: null;
+    error: string;
+}>;
+
 /**
  * Fetches and parses an OCHRE item from the OCHRE API
  *
@@ -1256,6 +1290,37 @@ type OchrePropertyValue = {
  */
 declare function fetchByUuid(uuid: string): Promise<[null, OchreData] | [string, null]>;
 
+/**
+ * Fetches and parses a website configuration from the OCHRE API
+ *
+ * @param abbreviation - The abbreviation identifier for the website
+ * @returns The parsed website configuration or null if the fetch/parse fails
+ *
+ * @example
+ * ```ts
+ * const website = await fetchWebsite("guerrilla-television");
+ * if (website === null) {
+ *   console.error("Failed to fetch website");
+ *   return;
+ * }
+ * console.log(`Fetched website: ${website.identification.label}`);
+ * console.log(`Contains ${website.pages.length.toLocaleString()} pages`);
+ * ```
+ *
+ * @remarks
+ * The returned website configuration includes:
+ * - Website metadata and identification
+ * - Page structure and content
+ * - Layout and styling properties
+ * - Navigation configuration
+ * - Sidebar elements
+ * - Project information
+ * - Creator details
+ *
+ * The abbreviation is case-insensitive and should match the website's configured abbreviation in OCHRE.
+ */
+declare function fetchWebsite(abbreviation: string): Promise<Website | null>;
+
 /**
  * Options for property search operations
  */
@@ -1644,4 +1709,4 @@ declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnote
  */
 declare function parseStringContent(content: OchreStringContent, language?: string): string;
 
-export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, type DataCategory, type Document, type Event, type Footnote, type Gallery, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type License, type Link, type Metadata, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueContent, type PropertyValueContentType, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebBlock, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchByUuid, fetchItem, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmail, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePerson, parsePersons, parseProperties, parseProperty, parsePropertyValue, parsePropertyValues, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite };
+export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, type DataCategory, type Document, type Event, type Footnote, type Gallery, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type License, type Link, type Metadata, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueContent, type PropertyValueContentType, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebBlock, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchByUuid, fetchGallery, fetchItem, fetchWebsite, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmail, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePerson, parsePersons, parseProperties, parseProperty, parsePropertyValue, parsePropertyValues, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite };

package/dist/index.d.ts

@@ -619,6 +619,40 @@ type WebBlock = {
     cssStylesMobile: Array<Style>;
 };
 
+/**
+ * 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 perPage - The number of items per page
+ * @returns The parsed gallery or null if the fetch/parse fails
+ *
+ * @example
+ * ```ts
+ * const gallery = await fetchGallery("9c4da06b-f15e-40af-a747-0933eaf3587e", "1978", 1, 12);
+ * if (gallery === null) {
+ *   console.error("Failed to fetch gallery");
+ *   return;
+ * }
+ * console.log(`Fetched gallery: ${gallery.identification.label}`);
+ * console.log(`Contains ${gallery.resources.length.toLocaleString()} resources`);
+ * ```
+ *
+ * @remarks
+ * The returned gallery includes:
+ * - Gallery metadata and identification
+ * - Project identification
+ * - Resources (gallery items)
+ */
+declare function fetchGallery(uuid: string, filter: string, page: number, perPage: number): Promise<{
+    item: Gallery | null;
+    error: null;
+} | {
+    item: null;
+    error: string;
+}>;
+
 /**
  * Fetches and parses an OCHRE item from the OCHRE API
  *
@@ -1256,6 +1290,37 @@ type OchrePropertyValue = {
  */
 declare function fetchByUuid(uuid: string): Promise<[null, OchreData] | [string, null]>;
 
+/**
+ * Fetches and parses a website configuration from the OCHRE API
+ *
+ * @param abbreviation - The abbreviation identifier for the website
+ * @returns The parsed website configuration or null if the fetch/parse fails
+ *
+ * @example
+ * ```ts
+ * const website = await fetchWebsite("guerrilla-television");
+ * if (website === null) {
+ *   console.error("Failed to fetch website");
+ *   return;
+ * }
+ * console.log(`Fetched website: ${website.identification.label}`);
+ * console.log(`Contains ${website.pages.length.toLocaleString()} pages`);
+ * ```
+ *
+ * @remarks
+ * The returned website configuration includes:
+ * - Website metadata and identification
+ * - Page structure and content
+ * - Layout and styling properties
+ * - Navigation configuration
+ * - Sidebar elements
+ * - Project information
+ * - Creator details
+ *
+ * The abbreviation is case-insensitive and should match the website's configured abbreviation in OCHRE.
+ */
+declare function fetchWebsite(abbreviation: string): Promise<Website | null>;
+
 /**
  * Options for property search operations
  */
@@ -1644,4 +1709,4 @@ declare function parseStringDocumentItem(item: OchreStringRichTextItem, footnote
  */
 declare function parseStringContent(content: OchreStringContent, language?: string): string;
 
-export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, type DataCategory, type Document, type Event, type Footnote, type Gallery, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type License, type Link, type Metadata, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueContent, type PropertyValueContentType, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebBlock, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchByUuid, fetchItem, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmail, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePerson, parsePersons, parseProperties, parseProperty, parsePropertyValue, parsePropertyValues, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite };
+export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, type DataCategory, type Document, type Event, type Footnote, type Gallery, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type License, type Link, type Metadata, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueContent, type PropertyValueContentType, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebBlock, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchByUuid, fetchGallery, fetchItem, fetchWebsite, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmail, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePerson, parsePersons, parseProperties, parseProperty, parsePropertyValue, parsePropertyValues, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite };

package/dist/index.js

@@ -86,28 +86,6 @@ var whitespaceSchema = z.string().transform((str) => str.split(" ")).pipe(
 );
 var emailSchema = z.string().email({ message: "Invalid email" });
 
-// src/utils/helpers.ts
-function getItemCategory(keys) {
-  const categoryFound = keys.find(
-    (key) => categorySchema.safeParse(key).success
-  );
-  if (!categoryFound) {
-    const unknownKey = keys.find(
-      (key) => ![
-        "uuid",
-        "uuidBelongsTo",
-        "belongsTo",
-        "publicationDateTime",
-        "metadata",
-        "languages"
-      ].includes(key)
-    );
-    throw new Error(`Invalid OCHRE data; found unexpected "${unknownKey}" key`);
-  }
-  const categoryKey = categorySchema.parse(categoryFound);
-  return categoryKey;
-}
-
 // src/utils/getters.ts
 var DEFAULT_OPTIONS = {
   searchNestedProperties: false
@@ -516,6 +494,164 @@ ${JSON.stringify(
   }
 }
 
+// src/utils/helpers.ts
+function getItemCategory(keys) {
+  const categoryFound = keys.find(
+    (key) => categorySchema.safeParse(key).success
+  );
+  if (!categoryFound) {
+    const unknownKey = keys.find(
+      (key) => ![
+        "uuid",
+        "uuidBelongsTo",
+        "belongsTo",
+        "publicationDateTime",
+        "metadata",
+        "languages"
+      ].includes(key)
+    );
+    throw new Error(`Invalid OCHRE data; found unexpected "${unknownKey}" key`);
+  }
+  const categoryKey = categorySchema.parse(categoryFound);
+  return categoryKey;
+}
+
+// src/utils/fetchers/uuid.ts
+async function fetchByUuid(uuid) {
+  try {
+    const parsedUuid = uuidSchema.parse(uuid);
+    const response = await fetch(
+      `https://ochre.lib.uchicago.edu/ochre?uuid=${parsedUuid}&format=json&lang="*"`
+    );
+    if (!response.ok) {
+      throw new Error("Failed to fetch OCHRE data");
+    }
+    const dataRaw = await response.json();
+    if (!("ochre" in dataRaw)) {
+      throw new Error("Invalid OCHRE data: API response missing 'ochre' key");
+    }
+    return [null, dataRaw];
+  } catch (error) {
+    return [error instanceof Error ? error.message : "Unknown error", null];
+  }
+}
+
+// src/utils/fetchers/item.ts
+async function fetchItem(uuid, category) {
+  try {
+    const [error, data] = await fetchByUuid(uuid);
+    if (error !== null) {
+      throw new Error(error);
+    }
+    const categoryKey = getItemCategory(Object.keys(data.ochre));
+    let item;
+    switch (categoryKey) {
+      case "resource": {
+        if (!("resource" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'resource' key"
+          );
+        }
+        item = parseResource(data.ochre.resource);
+        break;
+      }
+      case "spatialUnit": {
+        if (!("spatialUnit" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'spatialUnit' key"
+          );
+        }
+        item = parseSpatialUnit(data.ochre.spatialUnit);
+        break;
+      }
+      case "concept": {
+        if (!("concept" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'concept' key"
+          );
+        }
+        item = parseConcept(data.ochre.concept);
+        break;
+      }
+      case "period": {
+        if (!("period" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'period' key"
+          );
+        }
+        item = parsePeriod(data.ochre.period);
+        break;
+      }
+      case "bibliography": {
+        if (!("bibliography" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'bibliography' key"
+          );
+        }
+        item = parseBibliography(data.ochre.bibliography);
+        break;
+      }
+      case "person": {
+        if (!("person" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'person' key"
+          );
+        }
+        item = parsePerson(data.ochre.person);
+        break;
+      }
+      case "propertyValue": {
+        if (!("propertyValue" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'propertyValue' key"
+          );
+        }
+        item = parsePropertyValue(data.ochre.propertyValue);
+        break;
+      }
+      case "set": {
+        if (!("set" in data.ochre)) {
+          throw new Error("Invalid OCHRE data: API response missing 'set' key");
+        }
+        item = parseSet(data.ochre.set);
+        break;
+      }
+      case "tree": {
+        if (!("tree" in data.ochre)) {
+          throw new Error(
+            "Invalid OCHRE data: API response missing 'tree' key"
+          );
+        }
+        item = parseTree(data.ochre.tree);
+        break;
+      }
+      default: {
+        throw new Error("Invalid category");
+      }
+    }
+    const metadata = parseMetadata(data.ochre.metadata);
+    const belongsTo = {
+      uuid: data.ochre.uuidBelongsTo,
+      abbreviation: parseFakeString(data.ochre.belongsTo)
+    };
+    return {
+      error: null,
+      metadata,
+      belongsTo,
+      item,
+      category
+    };
+  } catch (error) {
+    return {
+      error: error instanceof Error ? error.message : "Unknown error",
+      metadata: void 0,
+      belongsTo: void 0,
+      item: void 0,
+      category: void 0
+    };
+  }
+}
+
 // src/utils/parse.ts
 function parseIdentification(identification) {
   try {
@@ -2408,144 +2544,86 @@ async function parseWebsite(websiteTree, projectName, website) {
   };
 }
 
-// src/utils/fetchers/uuid.ts
-async function fetchByUuid(uuid) {
+// src/utils/fetchers/gallery.ts
+async function fetchGallery(uuid, filter, page, perPage) {
   try {
-    const parsedUuid = uuidSchema.parse(uuid);
+    const {
+      uuid: parsedUuid,
+      filter: parsedFilter,
+      page: parsedPage,
+      perPage: parsedPerPage
+    } = gallerySchema.parse({ uuid, filter, page, perPage });
     const response = await fetch(
-      `https://ochre.lib.uchicago.edu/ochre?uuid=${parsedUuid}&format=json&lang="*"`
+      `https://ochre.lib.uchicago.edu/ochre?xquery=${encodeURIComponent(`
+        for $q in input()/ochre[@uuid='${parsedUuid}']
+        let $filtered := $q/tree/items/resource[contains(lower-case(identification/label), lower-case('${parsedFilter}'))]
+        let $maxLength := count($filtered)
+        return <gallery maxLength='{$maxLength}'>
+          {$q/metadata/project}
+          {$q/metadata/item}
+          {$filtered[position() >= ${((parsedPage - 1) * parsedPerPage + 1).toString()} and position() < ${(parsedPage * parsedPerPage + 1).toString()}]}
+        </gallery>
+      `)}&format=json`
     );
     if (!response.ok) {
-      throw new Error("Failed to fetch OCHRE data");
+      throw new Error("Error fetching gallery items, please try again later.");
     }
-    const dataRaw = await response.json();
-    if (!("ochre" in dataRaw)) {
-      throw new Error("Invalid OCHRE data: API response missing 'ochre' key");
+    const data = await response.json();
+    if (!("gallery" in data.result)) {
+      throw new Error("Failed to fetch gallery");
     }
-    return [null, dataRaw];
+    const galleryIdentification = parseIdentification(
+      data.result.gallery.item.identification
+    );
+    const galleryProjectIdentification = parseIdentification(
+      data.result.gallery.project.identification
+    );
+    const gallery = {
+      identification: galleryIdentification,
+      projectIdentification: galleryProjectIdentification,
+      resources: data.result.gallery.resource ? Array.isArray(data.result.gallery.resource) ? parseResources(data.result.gallery.resource) : [parseResource(data.result.gallery.resource)] : [],
+      maxLength: data.result.gallery.maxLength
+    };
+    return { item: gallery, error: null };
   } catch (error) {
-    return [error instanceof Error ? error.message : "Unknown error", null];
+    console.error(error);
+    return {
+      item: null,
+      error: error instanceof Error ? error.message : "Failed to fetch gallery"
+    };
   }
 }
 
-// src/utils/fetchers/item.ts
-async function fetchItem(uuid, category) {
+// src/utils/fetchers/website.ts
+async function fetchWebsite(abbreviation) {
   try {
-    const [error, data] = await fetchByUuid(uuid);
-    if (error !== null) {
-      throw new Error(error);
+    const response = await fetch(
+      `https://ochre.lib.uchicago.edu/ochre?xquery=for $q in input()/ochre[tree[@type='lesson'][identification/abbreviation='${abbreviation.toLocaleLowerCase("en-US")}']] return $q&format=json`
+    );
+    if (!response.ok) {
+      throw new Error("Failed to fetch website");
     }
-    const categoryKey = getItemCategory(Object.keys(data.ochre));
-    let item;
-    switch (categoryKey) {
-      case "resource": {
-        if (!("resource" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'resource' key"
-          );
-        }
-        item = parseResource(data.ochre.resource);
-        break;
-      }
-      case "spatialUnit": {
-        if (!("spatialUnit" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'spatialUnit' key"
-          );
-        }
-        item = parseSpatialUnit(data.ochre.spatialUnit);
-        break;
-      }
-      case "concept": {
-        if (!("concept" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'concept' key"
-          );
-        }
-        item = parseConcept(data.ochre.concept);
-        break;
-      }
-      case "period": {
-        if (!("period" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'period' key"
-          );
-        }
-        item = parsePeriod(data.ochre.period);
-        break;
-      }
-      case "bibliography": {
-        if (!("bibliography" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'bibliography' key"
-          );
-        }
-        item = parseBibliography(data.ochre.bibliography);
-        break;
-      }
-      case "person": {
-        if (!("person" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'person' key"
-          );
-        }
-        item = parsePerson(data.ochre.person);
-        break;
-      }
-      case "propertyValue": {
-        if (!("propertyValue" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'propertyValue' key"
-          );
-        }
-        item = parsePropertyValue(data.ochre.propertyValue);
-        break;
-      }
-      case "set": {
-        if (!("set" in data.ochre)) {
-          throw new Error("Invalid OCHRE data: API response missing 'set' key");
-        }
-        item = parseSet(data.ochre.set);
-        break;
-      }
-      case "tree": {
-        if (!("tree" in data.ochre)) {
-          throw new Error(
-            "Invalid OCHRE data: API response missing 'tree' key"
-          );
-        }
-        item = parseTree(data.ochre.tree);
-        break;
-      }
-      default: {
-        throw new Error("Invalid category");
-      }
+    const data = await response.json();
+    if (!("ochre" in data.result) || !("tree" in data.result.ochre)) {
+      throw new Error("Failed to fetch website");
     }
-    const metadata = parseMetadata(data.ochre.metadata);
-    const belongsTo = {
-      uuid: data.ochre.uuidBelongsTo,
-      abbreviation: parseFakeString(data.ochre.belongsTo)
-    };
-    return {
-      error: null,
-      metadata,
-      belongsTo,
-      item,
-      category
-    };
+    const projectIdentification = data.result.ochre.metadata.project?.identification ? parseIdentification(data.result.ochre.metadata.project.identification) : null;
+    const website = await parseWebsite(
+      data.result.ochre.tree,
+      projectIdentification?.label ?? "",
+      data.result.ochre.metadata.project?.identification.website ?? null
+    );
+    return website;
   } catch (error) {
-    return {
-      error: error instanceof Error ? error.message : "Unknown error",
-      metadata: void 0,
-      belongsTo: void 0,
-      item: void 0,
-      category: void 0
-    };
+    console.error(error);
+    return null;
   }
 }
 export {
   fetchByUuid,
+  fetchGallery,
   fetchItem,
+  fetchWebsite,
   filterProperties,
   getAllPropertyLabels,
   getPropertyByLabel,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",