@digitalculture/ochre-sdk 0.1.22 → 0.1.24

package/dist/index.cjs

@@ -20,9 +20,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  fetchBibliography: () => fetchBibliography,
   fetchByUuid: () => fetchByUuid,
   fetchConcept: () => fetchConcept,
   fetchGallery: () => fetchGallery,
+  fetchPeriod: () => fetchPeriod,
   fetchResource: () => fetchResource,
   fetchSet: () => fetchSet,
   fetchSpatialUnit: () => fetchSpatialUnit,
@@ -73,6 +75,9 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
+// src/utils/parse.ts
+var import_zod3 = require("zod");
+
 // src/utils/fetchers/generic.ts
 var import_zod = require("zod");
 var uuidSchema = import_zod.z.string().uuid({ message: "Invalid UUID provided" });
@@ -98,9 +103,6 @@ async function fetchByUuid(uuid) {
   }
 }
 
-// src/utils/parse.ts
-var import_zod3 = require("zod");
-
 // src/utils/string.ts
 var import_zod2 = require("zod");
 var renderOptionsSchema = import_zod2.z.string().transform((str) => str.split(" ")).pipe(
@@ -935,6 +937,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,
@@ -963,6 +966,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,
@@ -1874,6 +1878,36 @@ async function parseWebsite(websiteTree, projectName, website) {
   };
 }
 
+// src/utils/fetchers/bibliography.ts
+async function fetchBibliography(uuid) {
+  try {
+    const [error, dataRaw] = await fetchByUuid(uuid);
+    if (error !== null) {
+      throw new Error(error);
+    }
+    if (!("bibliography" in dataRaw.ochre)) {
+      throw new Error(
+        "Invalid OCHRE data: API response missing 'bibliography' key"
+      );
+    }
+    const bibliographyItem = parseBibliography(dataRaw.ochre.bibliography);
+    const data = {
+      uuid: parseFakeString(dataRaw.ochre.uuid),
+      publicationDateTime: new Date(dataRaw.ochre.publicationDateTime),
+      belongsTo: {
+        uuid: dataRaw.ochre.uuidBelongsTo,
+        abbreviation: parseFakeString(dataRaw.ochre.belongsTo)
+      },
+      metadata: parseMetadata(dataRaw.ochre.metadata),
+      item: bibliographyItem
+    };
+    return { metadata: data.metadata, resource: data.item };
+  } catch (error) {
+    console.error(error);
+    return null;
+  }
+}
+
 // src/utils/fetchers/concept.ts
 async function fetchConcept(uuid) {
   try {
@@ -1952,6 +1986,34 @@ async function fetchGallery(uuid, filter, page, perPage) {
   }
 }
 
+// src/utils/fetchers/period.ts
+async function fetchPeriod(uuid) {
+  try {
+    const [error, dataRaw] = await fetchByUuid(uuid);
+    if (error !== null) {
+      throw new Error(error);
+    }
+    if (!("period" in dataRaw.ochre)) {
+      throw new Error("Invalid OCHRE data: API response missing 'period' key");
+    }
+    const periodItem = parsePeriod(dataRaw.ochre.period);
+    const data = {
+      uuid: parseFakeString(dataRaw.ochre.uuid),
+      publicationDateTime: new Date(dataRaw.ochre.publicationDateTime),
+      belongsTo: {
+        uuid: dataRaw.ochre.uuidBelongsTo,
+        abbreviation: parseFakeString(dataRaw.ochre.belongsTo)
+      },
+      metadata: parseMetadata(dataRaw.ochre.metadata),
+      item: periodItem
+    };
+    return { metadata: data.metadata, resource: data.item };
+  } catch (error) {
+    console.error(error);
+    return null;
+  }
+}
+
 // src/utils/fetchers/set.ts
 async function fetchSet(uuid) {
   try {
@@ -2068,9 +2130,11 @@ async function fetchWebsite(abbreviation) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  fetchBibliography,
   fetchByUuid,
   fetchConcept,
   fetchGallery,
+  fetchPeriod,
   fetchResource,
   fetchSet,
   fetchSpatialUnit,

package/dist/index.d.cts

@@ -295,6 +295,7 @@ type Set = {
  */
 type Bibliography = {
     uuid: string;
+    category: "bibliography";
     publicationDateTime: Date | null;
     type: string | null;
     number: number | null;
@@ -326,6 +327,7 @@ type Bibliography = {
  */
 type Period = {
     uuid: string;
+    category: "period";
     publicationDateTime: Date | null;
     type: string | null;
     number: number | null;
@@ -530,6 +532,37 @@ type Style = {
     value: string;
 };
 
+/**
+ * Fetches and parses a bibliography from the OCHRE API
+ *
+ * @param uuid - The UUID of the bibliography to fetch
+ * @returns Object containing the parsed bibliography and its metadata, or null if the fetch/parse fails
+ *
+ * @example
+ * ```ts
+ * const result = await fetchBibliography("123e4567-e89b-12d3-a456-426614174000");
+ * if (result === null) {
+ *   console.error("Failed to fetch bibliography");
+ *   return;
+ * }
+ * const { metadata, item } = result;
+ * console.log(`Fetched bibliography: ${item.identification.label}`);
+ * ```
+ *
+ * @remarks
+ * The returned bibliography includes:
+ * - Full bibliography metadata
+ * - Citation and reference information
+ * - Publication information
+ * - Source information
+ * - Author information
+ * - Properties
+ */
+declare function fetchBibliography(uuid: string): Promise<{
+    metadata: Metadata;
+    resource: Bibliography;
+} | null>;
+
 /**
  * Fetches and parses a concept from the OCHRE API
  *
@@ -680,6 +713,7 @@ type OchreData = {
     | { resource: OchreResource }
     | { spatialUnit: OchreSpatialUnit }
     | { concept: OchreConcept }
+    | { period: OchrePeriod }
     | { bibliography: OchreBibliography }
   );
 };
@@ -1153,6 +1187,35 @@ type OchreInterpretation = {
  */
 declare function fetchByUuid(uuid: string): Promise<[null, OchreData] | [string, null]>;
 
+/**
+ * Fetches and parses a period from the OCHRE API
+ *
+ * @param uuid - The UUID of the period to fetch
+ * @returns Object containing the parsed period and its metadata, or null if the fetch/parse fails
+ *
+ * @example
+ * ```ts
+ * const result = await fetchPeriod("123e4567-e89b-12d3-a456-426614174000");
+ * if (result === null) {
+ *   console.error("Failed to fetch period");
+ *   return;
+ * }
+ * const { metadata, item } = result;
+ * console.log(`Fetched period: ${item.identification.label}`);
+ * ```
+ *
+ * @remarks
+ * The returned period includes:
+ * - Full period metadata
+ * - Identification information
+ * - Description
+ * - Properties
+ */
+declare function fetchPeriod(uuid: string): Promise<{
+    metadata: Metadata;
+    resource: Period;
+} | null>;
+
 /**
  * Fetches and parses a resource from the OCHRE API
  *
@@ -1695,4 +1758,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 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 };
+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, fetchBibliography, fetchByUuid, fetchConcept, fetchGallery, fetchPeriod, 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

@@ -295,6 +295,7 @@ type Set = {
  */
 type Bibliography = {
     uuid: string;
+    category: "bibliography";
     publicationDateTime: Date | null;
     type: string | null;
     number: number | null;
@@ -326,6 +327,7 @@ type Bibliography = {
  */
 type Period = {
     uuid: string;
+    category: "period";
     publicationDateTime: Date | null;
     type: string | null;
     number: number | null;
@@ -530,6 +532,37 @@ type Style = {
     value: string;
 };
 
+/**
+ * Fetches and parses a bibliography from the OCHRE API
+ *
+ * @param uuid - The UUID of the bibliography to fetch
+ * @returns Object containing the parsed bibliography and its metadata, or null if the fetch/parse fails
+ *
+ * @example
+ * ```ts
+ * const result = await fetchBibliography("123e4567-e89b-12d3-a456-426614174000");
+ * if (result === null) {
+ *   console.error("Failed to fetch bibliography");
+ *   return;
+ * }
+ * const { metadata, item } = result;
+ * console.log(`Fetched bibliography: ${item.identification.label}`);
+ * ```
+ *
+ * @remarks
+ * The returned bibliography includes:
+ * - Full bibliography metadata
+ * - Citation and reference information
+ * - Publication information
+ * - Source information
+ * - Author information
+ * - Properties
+ */
+declare function fetchBibliography(uuid: string): Promise<{
+    metadata: Metadata;
+    resource: Bibliography;
+} | null>;
+
 /**
  * Fetches and parses a concept from the OCHRE API
  *
@@ -680,6 +713,7 @@ type OchreData = {
     | { resource: OchreResource }
     | { spatialUnit: OchreSpatialUnit }
     | { concept: OchreConcept }
+    | { period: OchrePeriod }
     | { bibliography: OchreBibliography }
   );
 };
@@ -1153,6 +1187,35 @@ type OchreInterpretation = {
  */
 declare function fetchByUuid(uuid: string): Promise<[null, OchreData] | [string, null]>;
 
+/**
+ * Fetches and parses a period from the OCHRE API
+ *
+ * @param uuid - The UUID of the period to fetch
+ * @returns Object containing the parsed period and its metadata, or null if the fetch/parse fails
+ *
+ * @example
+ * ```ts
+ * const result = await fetchPeriod("123e4567-e89b-12d3-a456-426614174000");
+ * if (result === null) {
+ *   console.error("Failed to fetch period");
+ *   return;
+ * }
+ * const { metadata, item } = result;
+ * console.log(`Fetched period: ${item.identification.label}`);
+ * ```
+ *
+ * @remarks
+ * The returned period includes:
+ * - Full period metadata
+ * - Identification information
+ * - Description
+ * - Properties
+ */
+declare function fetchPeriod(uuid: string): Promise<{
+    metadata: Metadata;
+    resource: Period;
+} | null>;
+
 /**
  * Fetches and parses a resource from the OCHRE API
  *
@@ -1695,4 +1758,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 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 };
+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, fetchBibliography, fetchByUuid, fetchConcept, fetchGallery, fetchPeriod, 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

@@ -1,3 +1,6 @@
+// src/utils/parse.ts
+import { z as z3 } from "zod";
+
 // src/utils/fetchers/generic.ts
 import { z } from "zod";
 var uuidSchema = z.string().uuid({ message: "Invalid UUID provided" });
@@ -23,9 +26,6 @@ async function fetchByUuid(uuid) {
   }
 }
 
-// src/utils/parse.ts
-import { z as z3 } from "zod";
-
 // src/utils/string.ts
 import { z as z2 } from "zod";
 var renderOptionsSchema = z2.string().transform((str) => str.split(" ")).pipe(
@@ -860,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,
@@ -888,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,
@@ -1799,6 +1801,36 @@ async function parseWebsite(websiteTree, projectName, website) {
   };
 }
 
+// src/utils/fetchers/bibliography.ts
+async function fetchBibliography(uuid) {
+  try {
+    const [error, dataRaw] = await fetchByUuid(uuid);
+    if (error !== null) {
+      throw new Error(error);
+    }
+    if (!("bibliography" in dataRaw.ochre)) {
+      throw new Error(
+        "Invalid OCHRE data: API response missing 'bibliography' key"
+      );
+    }
+    const bibliographyItem = parseBibliography(dataRaw.ochre.bibliography);
+    const data = {
+      uuid: parseFakeString(dataRaw.ochre.uuid),
+      publicationDateTime: new Date(dataRaw.ochre.publicationDateTime),
+      belongsTo: {
+        uuid: dataRaw.ochre.uuidBelongsTo,
+        abbreviation: parseFakeString(dataRaw.ochre.belongsTo)
+      },
+      metadata: parseMetadata(dataRaw.ochre.metadata),
+      item: bibliographyItem
+    };
+    return { metadata: data.metadata, resource: data.item };
+  } catch (error) {
+    console.error(error);
+    return null;
+  }
+}
+
 // src/utils/fetchers/concept.ts
 async function fetchConcept(uuid) {
   try {
@@ -1877,6 +1909,34 @@ async function fetchGallery(uuid, filter, page, perPage) {
   }
 }
 
+// src/utils/fetchers/period.ts
+async function fetchPeriod(uuid) {
+  try {
+    const [error, dataRaw] = await fetchByUuid(uuid);
+    if (error !== null) {
+      throw new Error(error);
+    }
+    if (!("period" in dataRaw.ochre)) {
+      throw new Error("Invalid OCHRE data: API response missing 'period' key");
+    }
+    const periodItem = parsePeriod(dataRaw.ochre.period);
+    const data = {
+      uuid: parseFakeString(dataRaw.ochre.uuid),
+      publicationDateTime: new Date(dataRaw.ochre.publicationDateTime),
+      belongsTo: {
+        uuid: dataRaw.ochre.uuidBelongsTo,
+        abbreviation: parseFakeString(dataRaw.ochre.belongsTo)
+      },
+      metadata: parseMetadata(dataRaw.ochre.metadata),
+      item: periodItem
+    };
+    return { metadata: data.metadata, resource: data.item };
+  } catch (error) {
+    console.error(error);
+    return null;
+  }
+}
+
 // src/utils/fetchers/set.ts
 async function fetchSet(uuid) {
   try {
@@ -1992,9 +2052,11 @@ async function fetchWebsite(abbreviation) {
   }
 }
 export {
+  fetchBibliography,
   fetchByUuid,
   fetchConcept,
   fetchGallery,
+  fetchPeriod,
   fetchResource,
   fetchSet,
   fetchSpatialUnit,

package/package.json

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