@digitalculture/ochre-sdk 0.1.19 → 0.1.21

package/dist/index.cjs

@@ -732,7 +732,7 @@ function parseLink(linkRaw) {
   const returnLinks = [];
   for (const link of linksToParse) {
     const returnLink = {
-      variant: "resource" in linkRaw ? "resource" : "concept" in linkRaw ? "concept" : "set" in linkRaw ? "set" : "person" in linkRaw ? "person" : "tree" in linkRaw ? "tree" : "bibliography" in linkRaw ? "bibliography" : "epigraphicUnit" in linkRaw ? "epigraphicUnit" : null,
+      category: "resource" in linkRaw ? "resource" : "concept" in linkRaw ? "concept" : "set" in linkRaw ? "set" : "person" in linkRaw ? "person" : "tree" in linkRaw ? "tree" : "bibliography" in linkRaw ? "bibliography" : "epigraphicUnit" in linkRaw ? "epigraphicUnit" : null,
       content: "content" in link ? link.content != null ? parseFakeString(link.content) : null : null,
       uuid: link.uuid,
       type: link.type ?? null,
@@ -1048,7 +1048,7 @@ function parseTree(tree) {
   }
   const returnTree = {
     uuid: tree.uuid,
-    variant: "tree",
+    category: "tree",
     publicationDateTime: new Date(tree.publicationDateTime),
     identification: parseIdentification(tree.identification),
     creators,
@@ -1098,7 +1098,7 @@ function parseSet(set) {
   }
   return {
     uuid: set.uuid,
-    variant: "set",
+    category: "set",
     publicationDateTime: set.publicationDateTime ? new Date(set.publicationDateTime) : null,
     date: set.date != null ? new Date(set.date) : null,
     license: parseLicense(set.availability),
@@ -1121,7 +1121,7 @@ function parseSet(set) {
 function parseResource(resource, isNested = false) {
   const returnResource = {
     uuid: resource.uuid,
-    variant: "resource",
+    category: "resource",
     publicationDateTime: resource.publicationDateTime ? new Date(resource.publicationDateTime) : null,
     type: resource.type,
     number: resource.n,
@@ -1191,7 +1191,7 @@ function parseResources(resources, isNested = false) {
 function parseSpatialUnit(spatialUnit, isNested = false) {
   const returnSpatialUnit = {
     uuid: spatialUnit.uuid,
-    variant: "spatialUnit",
+    category: "spatialUnit",
     publicationDateTime: spatialUnit.publicationDateTime != null ? new Date(spatialUnit.publicationDateTime) : null,
     type: spatialUnit.type,
     number: spatialUnit.n,
@@ -1236,7 +1236,7 @@ function parseSpatialUnits(spatialUnits, isNested = false) {
 function parseConcept(concept, isNested = false) {
   const returnConcept = {
     uuid: concept.uuid,
-    variant: "concept",
+    category: "concept",
     publicationDateTime: concept.publicationDateTime ? new Date(concept.publicationDateTime) : null,
     number: concept.n,
     license: "availability" in concept && concept.availability ? parseLicense(concept.availability) : null,
@@ -1347,7 +1347,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
     }
     case "bibliography": {
       const bibliographyLink = links.find(
-        (link) => link.variant === "bibliography"
+        (link) => link.category === "bibliography"
       );
       if (!bibliographyLink) {
         throw new Error(
@@ -1371,7 +1371,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "blog": {
-      const blogLink = links.find((link) => link.variant === "tree");
+      const blogLink = links.find((link) => link.category === "tree");
       if (!blogLink) {
         throw new Error(
           `Blog link not found for the following component: \u201C${componentName}\u201D`
@@ -1404,14 +1404,12 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "collection": {
-      const variant = getPropertyValueByLabel(
+      let variant = getPropertyValueByLabel(
         componentProperty.properties,
         "variant"
       );
       if (variant === null) {
-        throw new Error(
-          `Property \u201Cvariant\u201D not found for the following component: \u201C${componentName}\u201D`
-        );
+        variant = "full";
       }
       let layout = getPropertyValueByLabel(
         componentProperty.properties,
@@ -1420,7 +1418,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (layout === null) {
         layout = "image-start";
       }
-      const collectionLink = links.find((link) => link.variant === "set");
+      const collectionLink = links.find((link) => link.category === "set");
       if (!collectionLink) {
         throw new Error(
           `Collection link not found for the following component: \u201C${componentName}\u201D`
@@ -1432,7 +1430,13 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "iiif-viewer": {
-      properties.manifestUrl = "";
+      const manifestLink = links.find((link) => link.type === "IIIF");
+      if (!manifestLink) {
+        throw new Error(
+          `Manifest link not found for the following component: \u201C${componentName}\u201D`
+        );
+      }
+      properties.IIIFId = manifestLink.uuid;
       break;
     }
     case "image": {
@@ -1450,7 +1454,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "image-gallery": {
-      const galleryLink = links.find((link) => link.variant === "tree");
+      const galleryLink = links.find((link) => link.category === "tree");
       if (!galleryLink) {
         throw new Error(
           `Image gallery link not found for the following component: \u201C${componentName}\u201D`
@@ -1463,7 +1467,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "item-gallery": {
-      const galleryLink = links.find((link) => link.variant === "tree");
+      const galleryLink = links.find((link) => link.category === "tree");
       if (!galleryLink) {
         throw new Error(
           `Item gallery link not found for the following component: \u201C${componentName}\u201D`
@@ -1498,8 +1502,13 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "table": {
-      properties.headers = [];
-      properties.tableId = "";
+      const tableLink = links.find((link) => link.category === "set");
+      if (!tableLink) {
+        throw new Error(
+          `Table link not found for the following component: \u201C${componentName}\u201D`
+        );
+      }
+      properties.tableId = tableLink.uuid;
       break;
     }
     case "text": {
@@ -1734,6 +1743,7 @@ function parseWebsiteProperties(properties) {
   }
   const logoUuid = websiteProperties.find((property) => property.label === "logo")?.values[0]?.uuid ?? null;
   let isHeaderDisplayed = true;
+  let headerVariant = "default";
   let isFooterDisplayed = true;
   let isSidebarDisplayed = false;
   let searchCollectionUuid = null;
@@ -1743,6 +1753,12 @@ function parseWebsiteProperties(properties) {
   if (headerProperty) {
     isHeaderDisplayed = headerProperty.content === "Yes";
   }
+  const headerVariantProperty = websiteProperties.find(
+    (property) => property.label === "navbar-variant"
+  )?.values[0];
+  if (headerVariantProperty) {
+    headerVariant = headerVariantProperty.content;
+  }
   const footerProperty = websiteProperties.find(
     (property) => property.label === "footer-visible"
   )?.values[0];
@@ -1771,6 +1787,7 @@ function parseWebsiteProperties(properties) {
     privacy: validatedPrivacy,
     status: validatedStatus,
     isHeaderDisplayed,
+    headerVariant,
     isFooterDisplayed,
     isSidebarDisplayed,
     searchCollectionUuid,

package/dist/index.d.cts

@@ -108,7 +108,7 @@ type Link = {
     uuid: string;
     publicationDateTime: Date | null;
     type: string | null;
-    variant: "resource" | "concept" | "set" | "tree" | "person" | "bibliography" | "epigraphicUnit" | null;
+    category: "resource" | "concept" | "set" | "tree" | "person" | "bibliography" | "epigraphicUnit" | null;
     identification: Identification | null;
     content: string | null;
     image: {
@@ -198,7 +198,7 @@ type Footnote = {
  */
 type Resource = {
     uuid: string;
-    variant: "resource";
+    category: "resource";
     publicationDateTime: Date | null;
     type: string;
     number: number;
@@ -231,7 +231,7 @@ type NestedResource = Omit<Resource, "publicationDateTime" | "license" | "copyri
  */
 type SpatialUnit = {
     uuid: string;
-    variant: "spatialUnit";
+    category: "spatialUnit";
     publicationDateTime: Date | null;
     type: string;
     number: number;
@@ -255,7 +255,7 @@ type NestedSpatialUnit = Omit<SpatialUnit, "publicationDateTime" | "license" | "
  */
 type Concept = {
     uuid: string;
-    variant: "concept";
+    category: "concept";
     publicationDateTime: Date | null;
     number: number;
     license: License | null;
@@ -272,7 +272,7 @@ type NestedConcept = Omit<Concept, "publicationDateTime" | "license">;
  */
 type Set = {
     uuid: string;
-    variant: "set";
+    category: "set";
     publicationDateTime: Date | null;
     type: string;
     number: number;
@@ -359,7 +359,7 @@ type Property = {
  */
 type Tree = {
     uuid: string;
-    variant: "tree";
+    category: "tree";
     publicationDateTime: Date | null;
     type: string;
     number: number;
@@ -400,6 +400,7 @@ type WebsiteProperties = {
     privacy: "public" | "password" | "private";
     status: "development" | "preview" | "production";
     isHeaderDisplayed: boolean;
+    headerVariant: "default" | "floating";
     isFooterDisplayed: boolean;
     isSidebarDisplayed: boolean;
     searchCollectionUuid: string | null;
@@ -458,7 +459,7 @@ type WebElementComponent = {
     collectionId: string;
 } | {
     component: "iiif-viewer";
-    manifestUrl: string;
+    IIIFId: string;
 } | {
     component: "image";
     image: WebImage;
@@ -484,7 +485,6 @@ type WebElementComponent = {
     component: "network-graph";
 } | {
     component: "table";
-    headers: Array<string>;
     tableId: string;
 } | {
     component: "text";

package/dist/index.d.ts

@@ -108,7 +108,7 @@ type Link = {
     uuid: string;
     publicationDateTime: Date | null;
     type: string | null;
-    variant: "resource" | "concept" | "set" | "tree" | "person" | "bibliography" | "epigraphicUnit" | null;
+    category: "resource" | "concept" | "set" | "tree" | "person" | "bibliography" | "epigraphicUnit" | null;
     identification: Identification | null;
     content: string | null;
     image: {
@@ -198,7 +198,7 @@ type Footnote = {
  */
 type Resource = {
     uuid: string;
-    variant: "resource";
+    category: "resource";
     publicationDateTime: Date | null;
     type: string;
     number: number;
@@ -231,7 +231,7 @@ type NestedResource = Omit<Resource, "publicationDateTime" | "license" | "copyri
  */
 type SpatialUnit = {
     uuid: string;
-    variant: "spatialUnit";
+    category: "spatialUnit";
     publicationDateTime: Date | null;
     type: string;
     number: number;
@@ -255,7 +255,7 @@ type NestedSpatialUnit = Omit<SpatialUnit, "publicationDateTime" | "license" | "
  */
 type Concept = {
     uuid: string;
-    variant: "concept";
+    category: "concept";
     publicationDateTime: Date | null;
     number: number;
     license: License | null;
@@ -272,7 +272,7 @@ type NestedConcept = Omit<Concept, "publicationDateTime" | "license">;
  */
 type Set = {
     uuid: string;
-    variant: "set";
+    category: "set";
     publicationDateTime: Date | null;
     type: string;
     number: number;
@@ -359,7 +359,7 @@ type Property = {
  */
 type Tree = {
     uuid: string;
-    variant: "tree";
+    category: "tree";
     publicationDateTime: Date | null;
     type: string;
     number: number;
@@ -400,6 +400,7 @@ type WebsiteProperties = {
     privacy: "public" | "password" | "private";
     status: "development" | "preview" | "production";
     isHeaderDisplayed: boolean;
+    headerVariant: "default" | "floating";
     isFooterDisplayed: boolean;
     isSidebarDisplayed: boolean;
     searchCollectionUuid: string | null;
@@ -458,7 +459,7 @@ type WebElementComponent = {
     collectionId: string;
 } | {
     component: "iiif-viewer";
-    manifestUrl: string;
+    IIIFId: string;
 } | {
     component: "image";
     image: WebImage;
@@ -484,7 +485,6 @@ type WebElementComponent = {
     component: "network-graph";
 } | {
     component: "table";
-    headers: Array<string>;
     tableId: string;
 } | {
     component: "text";

package/dist/index.js

@@ -658,7 +658,7 @@ function parseLink(linkRaw) {
   const returnLinks = [];
   for (const link of linksToParse) {
     const returnLink = {
-      variant: "resource" in linkRaw ? "resource" : "concept" in linkRaw ? "concept" : "set" in linkRaw ? "set" : "person" in linkRaw ? "person" : "tree" in linkRaw ? "tree" : "bibliography" in linkRaw ? "bibliography" : "epigraphicUnit" in linkRaw ? "epigraphicUnit" : null,
+      category: "resource" in linkRaw ? "resource" : "concept" in linkRaw ? "concept" : "set" in linkRaw ? "set" : "person" in linkRaw ? "person" : "tree" in linkRaw ? "tree" : "bibliography" in linkRaw ? "bibliography" : "epigraphicUnit" in linkRaw ? "epigraphicUnit" : null,
       content: "content" in link ? link.content != null ? parseFakeString(link.content) : null : null,
       uuid: link.uuid,
       type: link.type ?? null,
@@ -974,7 +974,7 @@ function parseTree(tree) {
   }
   const returnTree = {
     uuid: tree.uuid,
-    variant: "tree",
+    category: "tree",
     publicationDateTime: new Date(tree.publicationDateTime),
     identification: parseIdentification(tree.identification),
     creators,
@@ -1024,7 +1024,7 @@ function parseSet(set) {
   }
   return {
     uuid: set.uuid,
-    variant: "set",
+    category: "set",
     publicationDateTime: set.publicationDateTime ? new Date(set.publicationDateTime) : null,
     date: set.date != null ? new Date(set.date) : null,
     license: parseLicense(set.availability),
@@ -1047,7 +1047,7 @@ function parseSet(set) {
 function parseResource(resource, isNested = false) {
   const returnResource = {
     uuid: resource.uuid,
-    variant: "resource",
+    category: "resource",
     publicationDateTime: resource.publicationDateTime ? new Date(resource.publicationDateTime) : null,
     type: resource.type,
     number: resource.n,
@@ -1117,7 +1117,7 @@ function parseResources(resources, isNested = false) {
 function parseSpatialUnit(spatialUnit, isNested = false) {
   const returnSpatialUnit = {
     uuid: spatialUnit.uuid,
-    variant: "spatialUnit",
+    category: "spatialUnit",
     publicationDateTime: spatialUnit.publicationDateTime != null ? new Date(spatialUnit.publicationDateTime) : null,
     type: spatialUnit.type,
     number: spatialUnit.n,
@@ -1162,7 +1162,7 @@ function parseSpatialUnits(spatialUnits, isNested = false) {
 function parseConcept(concept, isNested = false) {
   const returnConcept = {
     uuid: concept.uuid,
-    variant: "concept",
+    category: "concept",
     publicationDateTime: concept.publicationDateTime ? new Date(concept.publicationDateTime) : null,
     number: concept.n,
     license: "availability" in concept && concept.availability ? parseLicense(concept.availability) : null,
@@ -1273,7 +1273,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
     }
     case "bibliography": {
       const bibliographyLink = links.find(
-        (link) => link.variant === "bibliography"
+        (link) => link.category === "bibliography"
       );
       if (!bibliographyLink) {
         throw new Error(
@@ -1297,7 +1297,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "blog": {
-      const blogLink = links.find((link) => link.variant === "tree");
+      const blogLink = links.find((link) => link.category === "tree");
       if (!blogLink) {
         throw new Error(
           `Blog link not found for the following component: \u201C${componentName}\u201D`
@@ -1330,14 +1330,12 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "collection": {
-      const variant = getPropertyValueByLabel(
+      let variant = getPropertyValueByLabel(
         componentProperty.properties,
         "variant"
       );
       if (variant === null) {
-        throw new Error(
-          `Property \u201Cvariant\u201D not found for the following component: \u201C${componentName}\u201D`
-        );
+        variant = "full";
       }
       let layout = getPropertyValueByLabel(
         componentProperty.properties,
@@ -1346,7 +1344,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (layout === null) {
         layout = "image-start";
       }
-      const collectionLink = links.find((link) => link.variant === "set");
+      const collectionLink = links.find((link) => link.category === "set");
       if (!collectionLink) {
         throw new Error(
           `Collection link not found for the following component: \u201C${componentName}\u201D`
@@ -1358,7 +1356,13 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "iiif-viewer": {
-      properties.manifestUrl = "";
+      const manifestLink = links.find((link) => link.type === "IIIF");
+      if (!manifestLink) {
+        throw new Error(
+          `Manifest link not found for the following component: \u201C${componentName}\u201D`
+        );
+      }
+      properties.IIIFId = manifestLink.uuid;
       break;
     }
     case "image": {
@@ -1376,7 +1380,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "image-gallery": {
-      const galleryLink = links.find((link) => link.variant === "tree");
+      const galleryLink = links.find((link) => link.category === "tree");
       if (!galleryLink) {
         throw new Error(
           `Image gallery link not found for the following component: \u201C${componentName}\u201D`
@@ -1389,7 +1393,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "item-gallery": {
-      const galleryLink = links.find((link) => link.variant === "tree");
+      const galleryLink = links.find((link) => link.category === "tree");
       if (!galleryLink) {
         throw new Error(
           `Item gallery link not found for the following component: \u201C${componentName}\u201D`
@@ -1424,8 +1428,13 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "table": {
-      properties.headers = [];
-      properties.tableId = "";
+      const tableLink = links.find((link) => link.category === "set");
+      if (!tableLink) {
+        throw new Error(
+          `Table link not found for the following component: \u201C${componentName}\u201D`
+        );
+      }
+      properties.tableId = tableLink.uuid;
       break;
     }
     case "text": {
@@ -1660,6 +1669,7 @@ function parseWebsiteProperties(properties) {
   }
   const logoUuid = websiteProperties.find((property) => property.label === "logo")?.values[0]?.uuid ?? null;
   let isHeaderDisplayed = true;
+  let headerVariant = "default";
   let isFooterDisplayed = true;
   let isSidebarDisplayed = false;
   let searchCollectionUuid = null;
@@ -1669,6 +1679,12 @@ function parseWebsiteProperties(properties) {
   if (headerProperty) {
     isHeaderDisplayed = headerProperty.content === "Yes";
   }
+  const headerVariantProperty = websiteProperties.find(
+    (property) => property.label === "navbar-variant"
+  )?.values[0];
+  if (headerVariantProperty) {
+    headerVariant = headerVariantProperty.content;
+  }
   const footerProperty = websiteProperties.find(
     (property) => property.label === "footer-visible"
   )?.values[0];
@@ -1697,6 +1713,7 @@ function parseWebsiteProperties(properties) {
     privacy: validatedPrivacy,
     status: validatedStatus,
     isHeaderDisplayed,
+    headerVariant,
     isFooterDisplayed,
     isSidebarDisplayed,
     searchCollectionUuid,

package/package.json

@@ -1,18 +1,10 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.1.19",
+  "version": "0.1.21",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
-  "homepage": "https://github.com/forumfordigitalculture/ochre-js",
-  "bugs": {
-    "url": "https://github.com/forumfordigitalculture/ochre-js/issues"
-  },
   "author": "Firat Ciftci <firatciftci@uchicago.edu> (https://digitalculture.uchicago.edu)",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/forumfordigitalculture/ochre-js.git"
-  },
   "keywords": [
     "ochre",
     "uchicago",
@@ -44,25 +36,28 @@
     "zod": "^3.24.1"
   },
   "devDependencies": {
+    "@antfu/eslint-config": "^4.1.0",
     "@arethetypeswrong/cli": "^0.17.3",
-    "@changesets/cli": "^2.27.11",
+    "@changesets/cli": "^2.27.12",
     "@types/node": "^22.10.10",
-    "tsup": "^8.3.5",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "prettier": "^3.4.2",
+    "tsup": "^8.3.6",
     "typescript": "^5.7.3",
-    "vitest": "^3.0.4",
-    "@digitalculture/eslint-config": "^1.0.0",
-    "@digitalculture/typescript-config": "1.0.0"
+    "vitest": "^3.0.4"
   },
   "scripts": {
     "dev": "tsup src/index.ts --watch",
-    "build-package": "tsup",
-    "lint-package": "eslint .",
-    "format-package": "prettier --write --list-different .",
-    "test-package": "vitest run",
-    "check-types-package": "tsc --noEmit",
-    "check-format-package": "prettier --check .",
-    "check-exports-package": "attw --pack .",
-    "ci-package": "pnpm run build-package && pnpm run check-format-package && pnpm run check-exports-package && pnpm run lint-package && pnpm run test-package",
-    "publish-package": "pnpm install --frozen-lockfile && changeset version && changeset publish"
+    "build": "tsup",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --check .",
+    "format:fix": "prettier --write --list-different .",
+    "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",
+    "changeset": "changeset add",
+    "release": "changeset version && changeset publish"
   }
 }