@digitalculture/ochre-sdk 0.1.21 → 0.1.23

package/README.md

@@ -1,15 +1,45 @@
 # OCHRE SDK
 
-A JavaScript/TypeScript SDK for working with OCHRE (Online Cultural and Historical Research Environment) data.
+This is the OCHRE JavaScript/TypeScript SDK for interacting with OCHRE (Online Cultural and Historical Research Environment) data.
 
 ## Installation
 
 ```bash
-pnpm add @uchicago/ochre
+pnpm add @digital-culture/ochre-sdk
+```
+
 or
-npm install @uchicago/ochre
+
+```bash
+npm install @digital-culture/ochre-sdk
+```
+
 or
-bun install @uchicago/ochre
+
+```bash
+bun add @digital-culture/ochre-sdk
+```
+
+## Start development server
+
+From the root directory of the project, run the following command:
+
+```bash
+pnpm run dev:ochre-sdk
+```
+
+## Build production server
+
+From the root directory of the project, run the following command:
+
+```bash
+pnpm run ci
+```
+
+## Release new version to NPM
+
+```bash
+pnpm run release
 ```
 
 ## Features

package/dist/index.cjs

@@ -22,6 +22,7 @@ var index_exports = {};
 __export(index_exports, {
   fetchByUuid: () => fetchByUuid,
   fetchConcept: () => fetchConcept,
+  fetchGallery: () => fetchGallery,
   fetchResource: () => fetchResource,
   fetchSet: () => fetchSet,
   fetchSpatialUnit: () => fetchSpatialUnit,
@@ -593,7 +594,8 @@ var componentSchema = import_zod3.z.enum(
     "network-graph",
     "table",
     "text",
-    "text-image"
+    "text-image",
+    "timeline"
   ],
   { message: "Invalid component" }
 );
@@ -933,6 +935,7 @@ function parseImageMap(imageMap) {
 function parsePeriod(period) {
   return {
     uuid: period.uuid,
+    category: "period",
     publicationDateTime: period.publicationDateTime != null ? new Date(period.publicationDateTime) : null,
     type: period.type ?? null,
     number: period.n ?? null,
@@ -961,6 +964,7 @@ function parseBibliography(bibliography) {
   }
   return {
     uuid: bibliography.uuid,
+    category: "bibliography",
     publicationDateTime: bibliography.publicationDateTime != null ? new Date(bibliography.publicationDateTime) : null,
     type: bibliography.type ?? null,
     number: bibliography.n ?? null,
@@ -1026,6 +1030,7 @@ function parseTree(tree) {
   let spatialUnits = [];
   let concepts = [];
   let periods = [];
+  let bibliographies = [];
   if (typeof tree.items !== "string" && "resource" in tree.items) {
     resources = parseResources(
       Array.isArray(tree.items.resource) ? tree.items.resource : [tree.items.resource]
@@ -1046,6 +1051,11 @@ function parseTree(tree) {
       Array.isArray(tree.items.period) ? tree.items.period : [tree.items.period]
     );
   }
+  if (typeof tree.items !== "string" && "bibliography" in tree.items) {
+    bibliographies = parseBibliographies(
+      Array.isArray(tree.items.bibliography) ? tree.items.bibliography : [tree.items.bibliography]
+    );
+  }
   const returnTree = {
     uuid: tree.uuid,
     category: "tree",
@@ -1060,7 +1070,8 @@ function parseTree(tree) {
       resources,
       spatialUnits,
       concepts,
-      periods
+      periods,
+      bibliographies
     },
     properties: tree.properties ? parseProperties(
       Array.isArray(tree.properties.property) ? tree.properties.property : [tree.properties.property]
@@ -1073,6 +1084,7 @@ function parseSet(set) {
   let spatialUnits = [];
   let concepts = [];
   let periods = [];
+  let bibliographies = [];
   if (typeof set.items !== "string" && "resource" in set.items) {
     resources = parseResources(
       Array.isArray(set.items.resource) ? set.items.resource : [set.items.resource],
@@ -1096,6 +1108,11 @@ function parseSet(set) {
       Array.isArray(set.items.period) ? set.items.period : [set.items.period]
     );
   }
+  if (typeof set.items !== "string" && "bibliography" in set.items) {
+    bibliographies = parseBibliographies(
+      Array.isArray(set.items.bibliography) ? set.items.bibliography : [set.items.bibliography]
+    );
+  }
   return {
     uuid: set.uuid,
     category: "set",
@@ -1114,7 +1131,8 @@ function parseSet(set) {
       resources,
       spatialUnits,
       concepts,
-      periods
+      periods,
+      bibliographies
     }
   };
 }
@@ -1578,6 +1596,16 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.imageOpacity = null;
       break;
     }
+    case "timeline": {
+      const timelineLink = links.find((link) => link.category === "tree");
+      if (!timelineLink) {
+        throw new Error(
+          `Timeline link not found for the following component: \u201C${componentName}\u201D`
+        );
+      }
+      properties.timelineId = timelineLink.uuid;
+      break;
+    }
     default: {
       console.warn(
         `Invalid or non-implemented component name \u201C${componentName}\u201D for the following element: \u201C${parseStringContent(
@@ -1876,6 +1904,56 @@ async function fetchConcept(uuid) {
   }
 }
 
+// src/utils/fetchers/gallery.ts
+var import_zod4 = require("zod");
+var gallerySchema = import_zod4.z.object({
+  uuid: import_zod4.z.string().uuid({ message: "Invalid UUID" }),
+  filter: import_zod4.z.string().optional(),
+  page: import_zod4.z.number().positive({ message: "Page must be positive" }),
+  perPage: import_zod4.z.number().positive({ message: "Per page must be positive" })
+}).strict();
+async function fetchGallery(uuid, filter, page, perPage) {
+  try {
+    const parsed = gallerySchema.safeParse({ uuid, filter, page, perPage });
+    if (!parsed.success) {
+      throw new Error(parsed.error.message);
+    }
+    const response = await fetch(
+      `https://ochre.lib.uchicago.edu/ochre?xquery=${encodeURIComponent(`
+        for $q in input()/ochre[@uuid='${uuid}']
+        let $filtered := $q/tree/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() >= ${((page - 1) * perPage + 1).toString()} and position() < ${(page * perPage + 1).toString()}]}
+        </gallery>
+      `)}&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");
+    }
+    const galleryIdentification = parseIdentification(data.result.gallery.item);
+    const galleryProjectIdentification = parseIdentification(
+      data.result.gallery.project.identification
+    );
+    const gallery = {
+      identification: galleryIdentification,
+      projectIdentification: galleryProjectIdentification,
+      resources: Array.isArray(data.result.gallery.resource) ? parseResources(data.result.gallery.resource) : [parseResource(data.result.gallery.resource)],
+      maxLength: data.result.gallery.maxLength
+    };
+    return gallery;
+  } catch (error) {
+    console.error(error);
+    return null;
+  }
+}
+
 // src/utils/fetchers/set.ts
 async function fetchSet(uuid) {
   try {
@@ -1994,6 +2072,7 @@ async function fetchWebsite(abbreviation) {
 0 && (module.exports = {
   fetchByUuid,
   fetchConcept,
+  fetchGallery,
   fetchResource,
   fetchSet,
   fetchSpatialUnit,

package/dist/index.d.cts

@@ -287,6 +287,7 @@ type Set = {
         spatialUnits: Array<NestedSpatialUnit>;
         concepts: Array<NestedConcept>;
         periods: Array<Period>;
+        bibliographies: Array<Bibliography>;
     };
 };
 /**
@@ -294,6 +295,7 @@ type Set = {
  */
 type Bibliography = {
     uuid: string;
+    category: "bibliography";
     publicationDateTime: Date | null;
     type: string | null;
     number: number | null;
@@ -325,6 +327,7 @@ type Bibliography = {
  */
 type Period = {
     uuid: string;
+    category: "period";
     publicationDateTime: Date | null;
     type: string | null;
     number: number | null;
@@ -372,9 +375,19 @@ type Tree = {
         spatialUnits: Array<SpatialUnit>;
         concepts: Array<Concept>;
         periods: Array<Period>;
+        bibliographies: Array<Bibliography>;
     };
     properties: Array<Property>;
 };
+/**
+ * Represents a gallery with its identification, project identification, resources and max length
+ */
+type Gallery = {
+    identification: Identification;
+    projectIdentification: Identification;
+    resources: Array<Resource>;
+    maxLength: number;
+};
 /**
  * Represents a website with its properties and elements
  */
@@ -498,6 +511,9 @@ type WebElementComponent = {
     image: WebImage;
     imageOpacity: number | null;
     content: string;
+} | {
+    component: "timeline";
+    timelineId: string;
 };
 /**
  * Represents an image used in web elements
@@ -545,6 +561,34 @@ declare function fetchConcept(uuid: string): Promise<{
     concept: Concept;
 } | null>;
 
+/**
+ * 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<Gallery | null>;
+
 /**
  * Raw string value that can be a string, number, or boolean
  */
@@ -681,7 +725,8 @@ type OchreTree = {
       }
     | { spatialUnit: OchreSpatialUnit | Array<OchreSpatialUnit> }
     | { concept: OchreConcept | Array<OchreConcept> }
-    | { period: OchrePeriod | Array<OchrePeriod> };
+    | { period: OchrePeriod | Array<OchrePeriod> }
+    | { bibliography: OchreBibliography | Array<OchreBibliography> };
   properties?: { property: OchreProperty | Array<OchreProperty> };
 };
 
@@ -704,7 +749,8 @@ type OchreSet = {
     | { resource: OchreResource | Array<OchreResource> }
     | { spatialUnit: OchreSpatialUnit | Array<OchreSpatialUnit> }
     | { concept: OchreConcept | Array<OchreConcept> }
-    | { period: OchrePeriod | Array<OchrePeriod> };
+    | { period: OchrePeriod | Array<OchrePeriod> }
+    | { bibliography: OchreBibliography | Array<OchreBibliography> };
 };
 
 /**
@@ -1651,4 +1697,4 @@ declare function trimEndLineBreaks(string: string): string;
  */
 declare function parseStringContent(content: OchreStringContent, language?: string): string;
 
-export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, type Document, type Event, type Footnote, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type License, type Link, type Metadata, type NestedConcept, type NestedResource, type NestedSpatialUnit, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueType, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchByUuid, fetchConcept, fetchResource, fetchSet, fetchSpatialUnit, fetchTree, fetchWebsite, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmailAndUrl, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePersons, parseProperties, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite, trimEndLineBreaks };
+export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, 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 NestedConcept, type NestedResource, type NestedSpatialUnit, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueType, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchByUuid, fetchConcept, fetchGallery, fetchResource, fetchSet, fetchSpatialUnit, fetchTree, fetchWebsite, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmailAndUrl, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePersons, parseProperties, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite, trimEndLineBreaks };

package/dist/index.d.ts

@@ -287,6 +287,7 @@ type Set = {
         spatialUnits: Array<NestedSpatialUnit>;
         concepts: Array<NestedConcept>;
         periods: Array<Period>;
+        bibliographies: Array<Bibliography>;
     };
 };
 /**
@@ -294,6 +295,7 @@ type Set = {
  */
 type Bibliography = {
     uuid: string;
+    category: "bibliography";
     publicationDateTime: Date | null;
     type: string | null;
     number: number | null;
@@ -325,6 +327,7 @@ type Bibliography = {
  */
 type Period = {
     uuid: string;
+    category: "period";
     publicationDateTime: Date | null;
     type: string | null;
     number: number | null;
@@ -372,9 +375,19 @@ type Tree = {
         spatialUnits: Array<SpatialUnit>;
         concepts: Array<Concept>;
         periods: Array<Period>;
+        bibliographies: Array<Bibliography>;
     };
     properties: Array<Property>;
 };
+/**
+ * Represents a gallery with its identification, project identification, resources and max length
+ */
+type Gallery = {
+    identification: Identification;
+    projectIdentification: Identification;
+    resources: Array<Resource>;
+    maxLength: number;
+};
 /**
  * Represents a website with its properties and elements
  */
@@ -498,6 +511,9 @@ type WebElementComponent = {
     image: WebImage;
     imageOpacity: number | null;
     content: string;
+} | {
+    component: "timeline";
+    timelineId: string;
 };
 /**
  * Represents an image used in web elements
@@ -545,6 +561,34 @@ declare function fetchConcept(uuid: string): Promise<{
     concept: Concept;
 } | null>;
 
+/**
+ * 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<Gallery | null>;
+
 /**
  * Raw string value that can be a string, number, or boolean
  */
@@ -681,7 +725,8 @@ type OchreTree = {
       }
     | { spatialUnit: OchreSpatialUnit | Array<OchreSpatialUnit> }
     | { concept: OchreConcept | Array<OchreConcept> }
-    | { period: OchrePeriod | Array<OchrePeriod> };
+    | { period: OchrePeriod | Array<OchrePeriod> }
+    | { bibliography: OchreBibliography | Array<OchreBibliography> };
   properties?: { property: OchreProperty | Array<OchreProperty> };
 };
 
@@ -704,7 +749,8 @@ type OchreSet = {
     | { resource: OchreResource | Array<OchreResource> }
     | { spatialUnit: OchreSpatialUnit | Array<OchreSpatialUnit> }
     | { concept: OchreConcept | Array<OchreConcept> }
-    | { period: OchrePeriod | Array<OchrePeriod> };
+    | { period: OchrePeriod | Array<OchrePeriod> }
+    | { bibliography: OchreBibliography | Array<OchreBibliography> };
 };
 
 /**
@@ -1651,4 +1697,4 @@ declare function trimEndLineBreaks(string: string): string;
  */
 declare function parseStringContent(content: OchreStringContent, language?: string): string;
 
-export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, type Document, type Event, type Footnote, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type License, type Link, type Metadata, type NestedConcept, type NestedResource, type NestedSpatialUnit, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueType, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchByUuid, fetchConcept, fetchResource, fetchSet, fetchSpatialUnit, fetchTree, fetchWebsite, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmailAndUrl, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePersons, parseProperties, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite, trimEndLineBreaks };
+export { type Bibliography, type Concept, type Context, type ContextItem, type ContextNode, type Coordinates, type Data, 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 NestedConcept, type NestedResource, type NestedSpatialUnit, type Note, type Observation, type Period, type Person, type Property, type PropertyValue, type PropertyValueType, type Resource, type Set, type SpatialUnit, type Style, type Tree, type WebElement, type WebElementComponent, type WebImage, type Webpage, type WebpageProperties, type Website, type WebsiteProperties, fetchByUuid, fetchConcept, fetchGallery, fetchResource, fetchSet, fetchSpatialUnit, fetchTree, fetchWebsite, filterProperties, getAllPropertyLabels, getPropertyByLabel, getPropertyValueByLabel, getPropertyValuesByLabel, parseBibliographies, parseBibliography, parseConcept, parseConcepts, parseContext, parseCoordinates, parseDocument, parseEmailAndUrl, parseEvents, parseFakeString, parseIdentification, parseImage, parseImageMap, parseInterpretations, parseLanguages, parseLicense, parseLink, parseLinks, parseMetadata, parseNotes, parseObservation, parseObservations, parsePeriod, parsePeriods, parsePersons, parseProperties, parseResource, parseResources, parseSet, parseSpatialUnit, parseSpatialUnits, parseStringContent, parseStringDocumentItem, parseStringItem, parseTree, parseWebsite, trimEndLineBreaks };

package/dist/index.js

@@ -519,7 +519,8 @@ var componentSchema = z3.enum(
     "network-graph",
     "table",
     "text",
-    "text-image"
+    "text-image",
+    "timeline"
   ],
   { message: "Invalid component" }
 );
@@ -859,6 +860,7 @@ function parseImageMap(imageMap) {
 function parsePeriod(period) {
   return {
     uuid: period.uuid,
+    category: "period",
     publicationDateTime: period.publicationDateTime != null ? new Date(period.publicationDateTime) : null,
     type: period.type ?? null,
     number: period.n ?? null,
@@ -887,6 +889,7 @@ function parseBibliography(bibliography) {
   }
   return {
     uuid: bibliography.uuid,
+    category: "bibliography",
     publicationDateTime: bibliography.publicationDateTime != null ? new Date(bibliography.publicationDateTime) : null,
     type: bibliography.type ?? null,
     number: bibliography.n ?? null,
@@ -952,6 +955,7 @@ function parseTree(tree) {
   let spatialUnits = [];
   let concepts = [];
   let periods = [];
+  let bibliographies = [];
   if (typeof tree.items !== "string" && "resource" in tree.items) {
     resources = parseResources(
       Array.isArray(tree.items.resource) ? tree.items.resource : [tree.items.resource]
@@ -972,6 +976,11 @@ function parseTree(tree) {
       Array.isArray(tree.items.period) ? tree.items.period : [tree.items.period]
     );
   }
+  if (typeof tree.items !== "string" && "bibliography" in tree.items) {
+    bibliographies = parseBibliographies(
+      Array.isArray(tree.items.bibliography) ? tree.items.bibliography : [tree.items.bibliography]
+    );
+  }
   const returnTree = {
     uuid: tree.uuid,
     category: "tree",
@@ -986,7 +995,8 @@ function parseTree(tree) {
       resources,
       spatialUnits,
       concepts,
-      periods
+      periods,
+      bibliographies
     },
     properties: tree.properties ? parseProperties(
       Array.isArray(tree.properties.property) ? tree.properties.property : [tree.properties.property]
@@ -999,6 +1009,7 @@ function parseSet(set) {
   let spatialUnits = [];
   let concepts = [];
   let periods = [];
+  let bibliographies = [];
   if (typeof set.items !== "string" && "resource" in set.items) {
     resources = parseResources(
       Array.isArray(set.items.resource) ? set.items.resource : [set.items.resource],
@@ -1022,6 +1033,11 @@ function parseSet(set) {
       Array.isArray(set.items.period) ? set.items.period : [set.items.period]
     );
   }
+  if (typeof set.items !== "string" && "bibliography" in set.items) {
+    bibliographies = parseBibliographies(
+      Array.isArray(set.items.bibliography) ? set.items.bibliography : [set.items.bibliography]
+    );
+  }
   return {
     uuid: set.uuid,
     category: "set",
@@ -1040,7 +1056,8 @@ function parseSet(set) {
       resources,
       spatialUnits,
       concepts,
-      periods
+      periods,
+      bibliographies
     }
   };
 }
@@ -1504,6 +1521,16 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.imageOpacity = null;
       break;
     }
+    case "timeline": {
+      const timelineLink = links.find((link) => link.category === "tree");
+      if (!timelineLink) {
+        throw new Error(
+          `Timeline link not found for the following component: \u201C${componentName}\u201D`
+        );
+      }
+      properties.timelineId = timelineLink.uuid;
+      break;
+    }
     default: {
       console.warn(
         `Invalid or non-implemented component name \u201C${componentName}\u201D for the following element: \u201C${parseStringContent(
@@ -1802,6 +1829,56 @@ async function fetchConcept(uuid) {
   }
 }
 
+// src/utils/fetchers/gallery.ts
+import { z as z4 } from "zod";
+var gallerySchema = z4.object({
+  uuid: z4.string().uuid({ message: "Invalid UUID" }),
+  filter: z4.string().optional(),
+  page: z4.number().positive({ message: "Page must be positive" }),
+  perPage: z4.number().positive({ message: "Per page must be positive" })
+}).strict();
+async function fetchGallery(uuid, filter, page, perPage) {
+  try {
+    const parsed = gallerySchema.safeParse({ uuid, filter, page, perPage });
+    if (!parsed.success) {
+      throw new Error(parsed.error.message);
+    }
+    const response = await fetch(
+      `https://ochre.lib.uchicago.edu/ochre?xquery=${encodeURIComponent(`
+        for $q in input()/ochre[@uuid='${uuid}']
+        let $filtered := $q/tree/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() >= ${((page - 1) * perPage + 1).toString()} and position() < ${(page * perPage + 1).toString()}]}
+        </gallery>
+      `)}&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");
+    }
+    const galleryIdentification = parseIdentification(data.result.gallery.item);
+    const galleryProjectIdentification = parseIdentification(
+      data.result.gallery.project.identification
+    );
+    const gallery = {
+      identification: galleryIdentification,
+      projectIdentification: galleryProjectIdentification,
+      resources: Array.isArray(data.result.gallery.resource) ? parseResources(data.result.gallery.resource) : [parseResource(data.result.gallery.resource)],
+      maxLength: data.result.gallery.maxLength
+    };
+    return gallery;
+  } catch (error) {
+    console.error(error);
+    return null;
+  }
+}
+
 // src/utils/fetchers/set.ts
 async function fetchSet(uuid) {
   try {
@@ -1919,6 +1996,7 @@ async function fetchWebsite(abbreviation) {
 export {
   fetchByUuid,
   fetchConcept,
+  fetchGallery,
   fetchResource,
   fetchSet,
   fetchSpatialUnit,

package/package.json

@@ -1,10 +1,18 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.1.21",
+  "version": "0.1.23",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
   "author": "Firat Ciftci <firatciftci@uchicago.edu> (https://digitalculture.uchicago.edu)",
+  "homepage": "https://github.com/forumfordigitalculture/ochre-sdk",
+  "bugs": {
+    "url": "https://github.com/forumfordigitalculture/ochre-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/forumfordigitalculture/ochre-sdk.git"
+  },
   "keywords": [
     "ochre",
     "uchicago",
@@ -39,6 +47,7 @@
     "@antfu/eslint-config": "^4.1.0",
     "@arethetypeswrong/cli": "^0.17.3",
     "@changesets/cli": "^2.27.12",
+    "@total-typescript/ts-reset": "^0.6.1",
     "@types/node": "^22.10.10",
     "eslint-plugin-unused-imports": "^4.1.4",
     "prettier": "^3.4.2",
@@ -48,7 +57,7 @@
   },
   "scripts": {
     "dev": "tsup src/index.ts --watch",
-    "build": "tsup",
+    "build:ochre-sdk": "tsup",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "format": "prettier --check .",
@@ -56,7 +65,7 @@
     "check-types": "tsc --noEmit",
     "check-exports": "attw --pack .",
     "test": "vitest run",
-    "ci": "pnpm run build && pnpm run lint && pnpm run format && pnpm run check-types && pnpm run check-exports && pnpm run test",
+    "ci": "pnpm run build:ochre-sdk && pnpm run lint && pnpm run format && pnpm run check-types && pnpm run check-exports && pnpm run test",
     "changeset": "changeset add",
     "release": "changeset version && changeset publish"
   }