@digitalculture/ochre-sdk 0.2.2 → 0.2.4

package/dist/index.cjs

@@ -331,7 +331,11 @@ function parseStringDocumentItem(item, footnotes) {
         }
       } else if ("person" in link) {
         const linkPerson = Array.isArray(link.person) ? link.person[0] : link.person;
-        const linkContent = linkPerson.identification ? parseStringContent(linkPerson.identification.label) : null;
+        const linkContent = linkPerson.identification ? ["string", "number", "boolean"].includes(
+          typeof linkPerson.identification.label
+        ) ? parseFakeString(linkPerson.identification.label) : parseStringContent(
+          linkPerson.identification.label
+        ) : null;
         if (linkPerson.publicationDateTime != null) {
           return `<ExternalLink href="https:\\/\\/ochre.lib.uchicago.edu/ochre?uuid=${linkPerson.uuid}" type="${linkPerson.type ?? "person"}" ${linkContent !== null ? `content="${linkContent}"` : ""}>${itemString}</ExternalLink>`;
         } else {
@@ -602,7 +606,7 @@ var componentSchema = import_zod3.z.enum(
 function parseIdentification(identification) {
   try {
     const returnIdentification = {
-      label: parseStringContent(identification.label),
+      label: ["string", "number", "boolean"].includes(typeof identification.label) ? parseFakeString(identification.label) : parseStringContent(identification.label),
       abbreviation: ""
     };
     for (const key of Object.keys(identification).filter(
@@ -622,6 +626,9 @@ function parseIdentification(identification) {
   }
 }
 function parseLanguages(language) {
+  if (language == null) {
+    return ["eng"];
+  }
   if (Array.isArray(language)) {
     return language.map((lang) => parseStringContent(lang));
   } else {
@@ -1124,7 +1131,7 @@ function parseSet(set) {
     license: parseLicense(set.availability),
     identification: parseIdentification(set.identification),
     isSuppressingBlanks: set.suppressBlanks ?? false,
-    description: set.description ? parseStringContent(set.description) : "",
+    description: set.description ? ["string", "number", "boolean"].includes(typeof set.description) ? parseFakeString(set.description) : parseStringContent(set.description) : "",
     creators: set.creators ? parsePersons(
       Array.isArray(set.creators.creator) ? set.creators.creator : [set.creators.creator]
     ) : [],
@@ -1220,7 +1227,9 @@ function parseSpatialUnit(spatialUnit, isNested = false) {
     license: "availability" in spatialUnit && spatialUnit.availability ? parseLicense(spatialUnit.availability) : null,
     identification: parseIdentification(spatialUnit.identification),
     image: spatialUnit.image ? parseImage(spatialUnit.image) : null,
-    description: spatialUnit.description ? parseStringContent(spatialUnit.description) : "",
+    description: spatialUnit.description ? ["string", "number", "boolean"].includes(
+      typeof spatialUnit.description
+    ) ? parseFakeString(spatialUnit.description) : parseStringContent(spatialUnit.description) : "",
     coordinates: spatialUnit.coordinates ? parseCoordinates(spatialUnit.coordinates) : null,
     observations: "observations" in spatialUnit && spatialUnit.observations ? parseObservations(
       Array.isArray(spatialUnit.observations.observation) ? spatialUnit.observations.observation : [spatialUnit.observations.observation]
@@ -1416,7 +1425,9 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       }
       properties.href = href;
       properties.isExternal = isExternal;
-      properties.label = parseStringContent(
+      properties.label = ["string", "number", "boolean"].includes(
+        typeof elementResource.identification.label
+      ) ? parseFakeString(elementResource.identification.label) : parseStringContent(
         elementResource.identification.label
       );
       break;

package/dist/index.d.cts

@@ -752,7 +752,7 @@ type OchreMetadata = {
   publisher: OchreStringContent;
   dataset: OchreStringContent;
   project?: { identification: OchreIdentification };
-  language: OchreLanguage | Array<OchreLanguage>;
+  language?: OchreLanguage | Array<OchreLanguage>;
   description: OchreStringContent;
 };
 
@@ -792,7 +792,7 @@ type OchreSet = {
   identification: OchreIdentification;
   date?: string; // YYYY-MM-DD
   suppressBlanks?: boolean;
-  description?: OchreStringContent;
+  description?: OchreStringContent | FakeString;
   creators?: { creator: OchrePerson | Array<OchrePerson> };
   items:
     | string
@@ -857,7 +857,7 @@ type OchreSpatialUnit = {
   context?: OchreContext;
   identification: OchreIdentification;
   image?: OchreImage;
-  description?: OchreStringContent;
+  description?: OchreStringContent | FakeString;
   coordinates?: OchreCoordinates;
   events?: { event: OchreEvent | Array<OchreEvent> };
   observations?: { observation: OchreObservation | Array<OchreObservation> };
@@ -918,8 +918,8 @@ type OchreProperty = {
  * Raw identification structure corresponding to the parsed Identification type
  */
 type OchreIdentification = {
-  label: OchreStringContent;
-  abbreviation?: OchreStringContent;
+  label: OchreStringContent | FakeString;
+  abbreviation?: OchreStringContent | FakeString;
   MIMEType?: string;
   widthPreview?: number;
   heightPreview?: number;
@@ -1506,7 +1506,7 @@ declare function parseIdentification(identification: OchreIdentification): Ident
  * @param language - Raw language data, either single or array
  * @returns Array of language codes as strings
  */
-declare function parseLanguages(language: OchreLanguage | Array<OchreLanguage>): Array<string>;
+declare function parseLanguages(language: OchreLanguage | Array<OchreLanguage> | undefined): Array<string>;
 /**
  * Parses raw metadata into the standardized Metadata type
  *

package/dist/index.d.ts

@@ -752,7 +752,7 @@ type OchreMetadata = {
   publisher: OchreStringContent;
   dataset: OchreStringContent;
   project?: { identification: OchreIdentification };
-  language: OchreLanguage | Array<OchreLanguage>;
+  language?: OchreLanguage | Array<OchreLanguage>;
   description: OchreStringContent;
 };
 
@@ -792,7 +792,7 @@ type OchreSet = {
   identification: OchreIdentification;
   date?: string; // YYYY-MM-DD
   suppressBlanks?: boolean;
-  description?: OchreStringContent;
+  description?: OchreStringContent | FakeString;
   creators?: { creator: OchrePerson | Array<OchrePerson> };
   items:
     | string
@@ -857,7 +857,7 @@ type OchreSpatialUnit = {
   context?: OchreContext;
   identification: OchreIdentification;
   image?: OchreImage;
-  description?: OchreStringContent;
+  description?: OchreStringContent | FakeString;
   coordinates?: OchreCoordinates;
   events?: { event: OchreEvent | Array<OchreEvent> };
   observations?: { observation: OchreObservation | Array<OchreObservation> };
@@ -918,8 +918,8 @@ type OchreProperty = {
  * Raw identification structure corresponding to the parsed Identification type
  */
 type OchreIdentification = {
-  label: OchreStringContent;
-  abbreviation?: OchreStringContent;
+  label: OchreStringContent | FakeString;
+  abbreviation?: OchreStringContent | FakeString;
   MIMEType?: string;
   widthPreview?: number;
   heightPreview?: number;
@@ -1506,7 +1506,7 @@ declare function parseIdentification(identification: OchreIdentification): Ident
  * @param language - Raw language data, either single or array
  * @returns Array of language codes as strings
  */
-declare function parseLanguages(language: OchreLanguage | Array<OchreLanguage>): Array<string>;
+declare function parseLanguages(language: OchreLanguage | Array<OchreLanguage> | undefined): Array<string>;
 /**
  * Parses raw metadata into the standardized Metadata type
  *

package/dist/index.js

@@ -254,7 +254,11 @@ function parseStringDocumentItem(item, footnotes) {
         }
       } else if ("person" in link) {
         const linkPerson = Array.isArray(link.person) ? link.person[0] : link.person;
-        const linkContent = linkPerson.identification ? parseStringContent(linkPerson.identification.label) : null;
+        const linkContent = linkPerson.identification ? ["string", "number", "boolean"].includes(
+          typeof linkPerson.identification.label
+        ) ? parseFakeString(linkPerson.identification.label) : parseStringContent(
+          linkPerson.identification.label
+        ) : null;
         if (linkPerson.publicationDateTime != null) {
           return `<ExternalLink href="https:\\/\\/ochre.lib.uchicago.edu/ochre?uuid=${linkPerson.uuid}" type="${linkPerson.type ?? "person"}" ${linkContent !== null ? `content="${linkContent}"` : ""}>${itemString}</ExternalLink>`;
         } else {
@@ -525,7 +529,7 @@ var componentSchema = z3.enum(
 function parseIdentification(identification) {
   try {
     const returnIdentification = {
-      label: parseStringContent(identification.label),
+      label: ["string", "number", "boolean"].includes(typeof identification.label) ? parseFakeString(identification.label) : parseStringContent(identification.label),
       abbreviation: ""
     };
     for (const key of Object.keys(identification).filter(
@@ -545,6 +549,9 @@ function parseIdentification(identification) {
   }
 }
 function parseLanguages(language) {
+  if (language == null) {
+    return ["eng"];
+  }
   if (Array.isArray(language)) {
     return language.map((lang) => parseStringContent(lang));
   } else {
@@ -1047,7 +1054,7 @@ function parseSet(set) {
     license: parseLicense(set.availability),
     identification: parseIdentification(set.identification),
     isSuppressingBlanks: set.suppressBlanks ?? false,
-    description: set.description ? parseStringContent(set.description) : "",
+    description: set.description ? ["string", "number", "boolean"].includes(typeof set.description) ? parseFakeString(set.description) : parseStringContent(set.description) : "",
     creators: set.creators ? parsePersons(
       Array.isArray(set.creators.creator) ? set.creators.creator : [set.creators.creator]
     ) : [],
@@ -1143,7 +1150,9 @@ function parseSpatialUnit(spatialUnit, isNested = false) {
     license: "availability" in spatialUnit && spatialUnit.availability ? parseLicense(spatialUnit.availability) : null,
     identification: parseIdentification(spatialUnit.identification),
     image: spatialUnit.image ? parseImage(spatialUnit.image) : null,
-    description: spatialUnit.description ? parseStringContent(spatialUnit.description) : "",
+    description: spatialUnit.description ? ["string", "number", "boolean"].includes(
+      typeof spatialUnit.description
+    ) ? parseFakeString(spatialUnit.description) : parseStringContent(spatialUnit.description) : "",
     coordinates: spatialUnit.coordinates ? parseCoordinates(spatialUnit.coordinates) : null,
     observations: "observations" in spatialUnit && spatialUnit.observations ? parseObservations(
       Array.isArray(spatialUnit.observations.observation) ? spatialUnit.observations.observation : [spatialUnit.observations.observation]
@@ -1339,7 +1348,9 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       }
       properties.href = href;
       properties.isExternal = isExternal;
-      properties.label = parseStringContent(
+      properties.label = ["string", "number", "boolean"].includes(
+        typeof elementResource.identification.label
+      ) ? parseFakeString(elementResource.identification.label) : parseStringContent(
         elementResource.identification.label
       );
       break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -44,16 +44,17 @@
     "zod": "^3.24.1"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^4.1.0",
+    "@antfu/eslint-config": "^4.1.1",
     "@arethetypeswrong/cli": "^0.17.3",
     "@changesets/cli": "^2.27.12",
     "@total-typescript/ts-reset": "^0.6.1",
-    "@types/node": "^22.10.10",
+    "@types/node": "^22.13.1",
+    "eslint": "^9.19.0",
     "eslint-plugin-unused-imports": "^4.1.4",
     "prettier": "^3.4.2",
     "tsup": "^8.3.6",
     "typescript": "^5.7.3",
-    "vitest": "^3.0.4"
+    "vitest": "^3.0.5"
   },
   "scripts": {
     "dev": "tsup src/index.ts --watch",