@digitalculture/ochre-sdk 0.6.2 → 0.6.3

package/dist/index.cjs

@@ -23,6 +23,7 @@ __export(index_exports, {
   fetchByUuid: () => fetchByUuid,
   fetchGallery: () => fetchGallery,
   fetchItem: () => fetchItem,
+  fetchWebsite: () => fetchWebsite,
   filterProperties: () => filterProperties,
   getAllPropertyLabels: () => getAllPropertyLabels,
   getPropertyByLabel: () => getPropertyByLabel,
@@ -2666,11 +2667,38 @@ async function fetchGallery(uuid, filter, page, perPage) {
     };
   }
 }
+
+// src/utils/fetchers/website.ts
+async function fetchWebsite(abbreviation) {
+  try {
+    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 data = await response.json();
+    if (!("ochre" in data.result) || !("tree" in data.result.ochre)) {
+      throw new Error("Failed to fetch website");
+    }
+    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) {
+    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

@@ -1290,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
  */
@@ -1678,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, fetchGallery, 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

@@ -1290,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
  */
@@ -1678,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, fetchGallery, 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

@@ -2593,10 +2593,37 @@ async function fetchGallery(uuid, filter, page, perPage) {
     };
   }
 }
+
+// src/utils/fetchers/website.ts
+async function fetchWebsite(abbreviation) {
+  try {
+    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 data = await response.json();
+    if (!("ochre" in data.result) || !("tree" in data.result.ochre)) {
+      throw new Error("Failed to fetch website");
+    }
+    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) {
+    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.2",
+  "version": "0.6.3",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",