cozy-iiif 0.2.0 → 0.2.1

package/README.md

@@ -7,7 +7,7 @@ A developer-friendly API for working with IIIF resources. Built on top of the II
 - Resource identification for any URL: IIIF collection and presentation manifests, image services, static image, and more.
 - Developer-friendly TypeScript API for parsing and working with IIIF resources.
 - Seamless upgrade from IIIF Presentation API v2 to v3 (using `@iiif/parser` under the hood).
-- Preserves access to underlying `@iiif-presentation/3` types.
+- Preserves access to underlying `@iiif/presentation-3` types.
 - Helpers for stitching thumbnails and cropping regions from IIIF Level 0 tilesets.
 - Helpers for adding annotations to Canvases and Presentation manifests.
 
@@ -69,12 +69,15 @@ console.log(manifest.getLabel('de'));
 
 // Metadata as normalized CozyMetada[]
 console.log(manifest.getMetadata());
+
+// The raw source data, @iiif/presentation-3 typed
+console.log(manifest.source);
 ```
 
 ### Thumbnail Helper
 
 CozyCanvas has a simple helper for getting a Thumbnail URL. The URL
-will use the `thumbnail` property if available, or the image service
+will use the `thumbnail` property of the original resource if available, or the image service
 otherwise.
 
 ```ts
@@ -94,19 +97,19 @@ based on the manifest's `structures` property.
 
 ```ts
 // Returns a list of CozyTOCNode objects.
-const root = manifest.getTableOfContents(); 
+const toc = manifest.getTableOfContents(); 
 
 const logTOCNode = (node: CozyTOCNode) => {
   console.log(node.getLabel());
   node.children.forEach(logTOCNode);
 }
     
-root.forEach(logTOCNode);
+root.forEach(logTOCNode.root);
 ```
 
-### Working with different Image Types and Levels
+### Image Types and Levels
 
-The **CozyImageResource** type provides a helper property for identify the type and level of 
+The **CozyImageResource** provides a helper properties that identify the type and level of 
 an image.
 
 ```ts
@@ -204,8 +207,11 @@ const annotations: Annotation[] = [{
 
 // Generates a new CozyManifest with annotations from an original CozyManifest.
 const updated = importAnnotations(original, annotations);
+
+// The source field has the raw manifest JSON (annotations included!)
+console.log(updated.source);
 ```
 
 ## License
 
-MIT License - see the [LICENSE](LICENSE) file for details.
+MIT License - see the [LICENSE](LICENSE) file for details.

package/dist/core/manifest.d.ts

@@ -1,2 +1,2 @@
-import { CozyRange, CozyTOCNode } from '../types';
-export declare const getTableOfContents: (ranges: CozyRange[]) => () => CozyTOCNode[];
+import { CozyRange, CozyTOC } from '../types';
+export declare const getTableOfContents: (ranges: CozyRange[]) => () => CozyTOC;

package/dist/index.js

@@ -1,14 +1,14 @@
-import { g as v, a as x, b as L } from "./resource-DS2brz47.js";
+import { g as h, a as $, b as w } from "./resource-DS2brz47.js";
 import { c as Ft } from "./resource-DS2brz47.js";
 var ce = "http://library.stanford.edu/iiif/image-api/compliance.html#level0", le = "http://library.stanford.edu/iiif/image-api/compliance.html#level1", V = "http://library.stanford.edu/iiif/image-api/compliance.html#level2", pe = "http://library.stanford.edu/iiif/image-api/conformance.html#level0", ve = "http://library.stanford.edu/iiif/image-api/conformance.html#level1", F = "http://library.stanford.edu/iiif/image-api/conformance.html#level2", he = "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level0", ue = "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level1", W = "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level2", fe = "http://library.stanford.edu/iiif/image-api/1.1/conformance.html#level0", me = "http://library.stanford.edu/iiif/image-api/1.1/conformance.html#level1", B = "http://library.stanford.edu/iiif/image-api/1.1/conformance.html#level2", ge = "http://iiif.io/api/image/1/level0.json", de = "http://iiif.io/api/image/1/profiles/level0.json", ye = "http://iiif.io/api/image/1/level1.json", Ae = "http://iiif.io/api/image/1/profiles/level1.json", H = "http://iiif.io/api/image/1/level2.json", J = "http://iiif.io/api/image/1/profiles/level2.json", Ce = "http://iiif.io/api/image/2/level0.json", be = "http://iiif.io/api/image/2/profiles/level0.json", Re = "http://iiif.io/api/image/2/level1.json", Le = "http://iiif.io/api/image/2/profiles/level1.json", G = "http://iiif.io/api/image/2/level2.json", z = "http://iiif.io/api/image/2/profiles/level2.json", we = "level0", Ie = "level1", K = "level2", Se = "http://iiif.io/api/image/2/level0", Te = "http://iiif.io/api/image/2/level1", Q = "http://iiif.io/api/image/2/level2", xe = [Q, V, F, W, B, H, J, G, z, K], $e = [Se, Te, Q, ce, le, V, pe, ve, F, he, ue, W, fe, me, B, ge, de, ye, Ae, H, J, Ce, be, Re, Le, G, z, we, Ie, K], Me = $e;
-function h(t) {
+function u(t) {
   for (let e in t) (typeof t[e] > "u" || t[e] === null) && delete t[e];
   return t;
 }
 function b(t) {
   return Array.isArray(t) ? t : t ? [t] : [];
 }
-var je = Object.defineProperty, ke = (t, e, r) => e in t ? je(t, e, { enumerable: !0, configurable: !0, writable: !0, value: r }) : t[e] = r, y = (t, e, r) => (ke(t, typeof e != "symbol" ? e + "" : e, r), r), U = ["sc:Collection", "sc:Manifest", "sc:Canvas", "sc:AnnotationList", "oa:Annotation", "sc:Range", "sc:Layer", "sc:Sequence", "oa:Choice", "Service", "ContentResource"];
+var je = Object.defineProperty, ke = (t, e, r) => e in t ? je(t, e, { enumerable: !0, configurable: !0, writable: !0, value: r }) : t[e] = r, A = (t, e, r) => (ke(t, typeof e != "symbol" ? e + "" : e, r), r), U = ["sc:Collection", "sc:Manifest", "sc:Canvas", "sc:AnnotationList", "oa:Annotation", "sc:Range", "sc:Layer", "sc:Sequence", "oa:Choice", "Service", "ContentResource"];
 function Pe(t) {
   if (typeof t > "u" || t === null) throw new Error("Null or undefined is not a valid entity.");
   if (Array.isArray(t)) throw new Error("Array is not a valid entity");
@@ -23,7 +23,7 @@ function Pe(t) {
 }
 var Oe = class X {
   constructor(e, r = {}) {
-    y(this, "traversals"), y(this, "options"), this.traversals = { collection: [], manifest: [], canvas: [], annotationList: [], sequence: [], annotation: [], contentResource: [], choice: [], range: [], service: [], layer: [], ...e }, this.options = { convertPropsToArray: !0, mergeMemberProperties: !0, allowUndefinedReturn: !1, ...r };
+    A(this, "traversals"), A(this, "options"), this.traversals = { collection: [], manifest: [], canvas: [], annotationList: [], sequence: [], annotation: [], contentResource: [], choice: [], range: [], service: [], layer: [], ...e }, this.options = { convertPropsToArray: !0, mergeMemberProperties: !0, allowUndefinedReturn: !1, ...r };
   }
   static all(e) {
     return new X({ collection: [e], manifest: [e], canvas: [e], annotationList: [e], sequence: [e], annotation: [e], contentResource: [e], choice: [e], range: [e], service: [e], layer: [e] });
@@ -152,7 +152,7 @@ var Oe = class X {
       return typeof n > "u" && !this.options.allowUndefinedReturn ? i : n;
     }, e);
   }
-}, Ue = "http://library.stanford.edu/iiif/image-api/compliance.html#level1", De = "http://library.stanford.edu/iiif/image-api/compliance.html#level2", Ee = "http://library.stanford.edu/iiif/image-api/conformance.html#level1", Ne = "http://library.stanford.edu/iiif/image-api/conformance.html#level2", qe = "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level1", _e = "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level2", Ve = "http://library.stanford.edu/iiif/image-api/1.1/conformance.html#level1", Fe = "http://library.stanford.edu/iiif/image-api/1.1/conformance.html#level2", We = "http://iiif.io/api/image/1/level1.json", Be = "http://iiif.io/api/image/1/profiles/level1.json", He = "http://iiif.io/api/image/1/level2.json", Je = "http://iiif.io/api/image/1/profiles/level2.json", Ge = "http://iiif.io/api/image/2/level1.json", ze = "http://iiif.io/api/image/2/profiles/level1.json", Ke = "http://iiif.io/api/image/2/level2.json", Qe = "http://iiif.io/api/image/2/profiles/level2.json", Xe = "level1", Ye = "level2", Ze = "http://iiif.io/api/image/2/level1", et = "http://iiif.io/api/image/2/level2", tt = [Ze, et, Ue, De, Ee, Ne, qe, _e, Ve, Fe, We, Be, He, Je, Ge, ze, Ke, Qe, Xe, Ye], $ = { attributionLabel: "Attribution", providerId: "http://example.org/provider", providerName: "Unknown" };
+}, Ue = "http://library.stanford.edu/iiif/image-api/compliance.html#level1", De = "http://library.stanford.edu/iiif/image-api/compliance.html#level2", Ee = "http://library.stanford.edu/iiif/image-api/conformance.html#level1", Ne = "http://library.stanford.edu/iiif/image-api/conformance.html#level2", qe = "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level1", _e = "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level2", Ve = "http://library.stanford.edu/iiif/image-api/1.1/conformance.html#level1", Fe = "http://library.stanford.edu/iiif/image-api/1.1/conformance.html#level2", We = "http://iiif.io/api/image/1/level1.json", Be = "http://iiif.io/api/image/1/profiles/level1.json", He = "http://iiif.io/api/image/1/level2.json", Je = "http://iiif.io/api/image/1/profiles/level2.json", Ge = "http://iiif.io/api/image/2/level1.json", ze = "http://iiif.io/api/image/2/profiles/level1.json", Ke = "http://iiif.io/api/image/2/level2.json", Qe = "http://iiif.io/api/image/2/profiles/level2.json", Xe = "level1", Ye = "level2", Ze = "http://iiif.io/api/image/2/level1", et = "http://iiif.io/api/image/2/level2", tt = [Ze, et, Ue, De, Ee, Ne, qe, _e, Ve, Fe, We, Be, He, Je, Ge, ze, Ke, Qe, Xe, Ye], M = { attributionLabel: "Attribution", providerId: "http://example.org/provider", providerName: "Unknown" };
 function rt(t) {
   if (typeof t == "string") return [t];
   if (!t) return [];
@@ -237,7 +237,7 @@ function D(t) {
   return t;
 }
 var nt = ["Collection", "Manifest", "Annotation", "AnnotationPage", "Range", "Service"];
-function j(t) {
+function k(t) {
   let e = t["@id"] || t.id, r = t["@type"] || t.type, i = t.profile || void 0, s = t["@context"] || void 0;
   if (i) {
     let n = st(i);
@@ -282,12 +282,12 @@ function ot(t) {
 function ct(t, e = "Rights/License", r = "none") {
   let i = null, s = [], n = Array.isArray(t) ? t : [t];
   for (let a of n) {
-    let o = a ? ot(a) : void 0;
-    if (o && (o.indexOf("creativecommons.org") !== -1 || o.indexOf("rightsstatements.org") !== -1)) {
-      o.startsWith("https://") ? i = `http://${o.slice(8)}` : i = o;
+    let c = a ? ot(a) : void 0;
+    if (c && (c.indexOf("creativecommons.org") !== -1 || c.indexOf("rightsstatements.org") !== -1)) {
+      c.startsWith("https://") ? i = `http://${c.slice(8)}` : i = c;
       continue;
     }
-    o && s.push({ label: { [r]: [e] }, value: { [r]: [o] } });
+    c && s.push({ label: { [r]: [e] }, value: { [r]: [c] } });
   }
   return [i, s];
 }
@@ -307,15 +307,15 @@ function Z(t, e) {
   let r = encodeURI(t.id || t["@id"] || "").trim();
   return r && e ? `${r}/${e}` : r || (E++, `http://example.org/${t["@type"]}${e ? `/${e}` : ""}/${E}`);
 }
-function m(t) {
+function d(t) {
   let e = [...t.behavior || []];
   t.viewingHint && e.push(t.viewingHint);
   let r;
-  return Array.isArray(t.motivation) ? r = t.motivation.map(D) : t.motivation && (r = D(t.motivation)), { "@context": t["@context"] ? pt(t["@context"]) : void 0, id: (t["@id"] || Z(t)).trim(), type: j(t), behavior: e.length ? e : void 0, height: t.height ? t.height : void 0, width: t.width ? t.width : void 0, motivation: r, viewingDirection: t.viewingDirection, profile: t.profile, format: t.format ? t.format : void 0, duration: void 0, timeMode: void 0 };
+  return Array.isArray(t.motivation) ? r = t.motivation.map(D) : t.motivation && (r = D(t.motivation)), { "@context": t["@context"] ? pt(t["@context"]) : void 0, id: (t["@id"] || Z(t)).trim(), type: k(t), behavior: e.length ? e : void 0, height: t.height ? t.height : void 0, width: t.width ? t.width : void 0, motivation: r, viewingDirection: t.viewingDirection, profile: t.profile, format: t.format ? t.format : void 0, duration: void 0, timeMode: void 0 };
 }
-function g(t) {
+function y(t) {
   let [e, r] = ct(t.license), i = [...t.metadata ? vt(t.metadata) : [], ...r];
-  return { rights: e, metadata: i.length ? i : void 0, label: t.label ? R(t.label) : void 0, requiredStatement: t.attribution ? { label: R($.attributionLabel), value: R(t.attribution) } : void 0, navDate: t.navDate, summary: t.description ? R(t.description) : void 0, thumbnail: ht(t.thumbnail) };
+  return { rights: e, metadata: i.length ? i : void 0, label: t.label ? R(t.label) : void 0, requiredStatement: t.attribution ? { label: R(M.attributionLabel), value: R(t.attribution) } : void 0, navDate: t.navDate, summary: t.description ? R(t.description) : void 0, thumbnail: ht(t.thumbnail) };
 }
 function ht(t) {
   return t && (Array.isArray(t) ? t : [t]).map((e) => typeof e == "string" ? { id: e, type: "Image" } : (e.type === "unknown" && (e.type = "Image"), e));
@@ -329,24 +329,24 @@ function ut(t) {
         r.push({ id: i, type: "Collection" });
         break;
     }
-  } else i["@id"] && r.push({ id: i["@id"], type: j(i) });
+  } else i["@id"] && r.push({ id: i["@id"], type: k(i) });
   return r.length ? r : void 0;
 }
-function A(t) {
+function C(t) {
   let e = t.related ? Array.isArray(t.related) ? t.related : [t.related] : [], r = t.contentLayer;
-  return { provider: t.logo || e.length ? [{ id: $.providerId, type: "Agent", homepage: e.length ? [e[0]] : void 0, logo: t.logo ? Array.isArray(t.logo) ? t.logo : [t.logo] : void 0, label: R($.providerName) }] : void 0, partOf: ut(t), rendering: t.rendering, seeAlso: t.seeAlso, start: t.startCanvas, service: t.service ? b(t.service) : void 0, supplementary: r ? [r] : void 0 };
+  return { provider: t.logo || e.length ? [{ id: M.providerId, type: "Agent", homepage: e.length ? [e[0]] : void 0, logo: t.logo ? Array.isArray(t.logo) ? t.logo : [t.logo] : void 0, label: R(M.providerName) }] : void 0, partOf: ut(t), rendering: t.rendering, seeAlso: t.seeAlso, start: t.startCanvas, service: t.service ? b(t.service) : void 0, supplementary: r ? [r] : void 0 };
 }
 function ft(t) {
   return { chars: t.chars, format: t.format ? t.format : void 0, language: t.language };
 }
 function mt(t) {
-  return h({ ...m(t), ...g(t), ...A(t), items: t.members });
+  return u({ ...d(t), ...y(t), ...C(t), items: t.members });
 }
 function gt(t) {
   let e = [], r = [], i;
   for (let n of t.sequences || []) n.canvases.length && e.push(...n.canvases), n.behavior && r.push(...n.behavior), n.startCanvas && (i = n.startCanvas);
-  let s = m(t);
-  return r.length && (s.behavior ? s.behavior.push(...r) : s.behavior = r), h({ ...s, ...g(t), ...A(t), start: i, items: e, structures: dt(t.structures) });
+  let s = d(t);
+  return r.length && (s.behavior ? s.behavior.push(...r) : s.behavior = r), u({ ...s, ...y(t), ...C(t), start: i, items: e, structures: dt(t.structures) });
 }
 function dt(t) {
   if (!t) return t;
@@ -360,10 +360,10 @@ function dt(t) {
   return t.filter((i) => r.indexOf(i.id) === -1);
 }
 function yt(t) {
-  return h({ ...m(t), ...g(t), ...A(t), annotations: t.otherContent && t.otherContent.length ? t.otherContent : void 0, items: t.images && t.images.length ? [{ id: Z(t, "annotation-page"), type: "AnnotationPage", items: t.images }] : void 0 });
+  return u({ ...d(t), ...y(t), ...C(t), annotations: t.otherContent && t.otherContent.length ? t.otherContent : void 0, items: t.images && t.images.length ? [{ id: Z(t, "annotation-page"), type: "AnnotationPage", items: t.images }] : void 0 });
 }
 function At(t) {
-  return h({ ...m(t), ...g(t), ...A(t), items: t.resources && t.resources.length ? t.resources : void 0 });
+  return u({ ...d(t), ...y(t), ...C(t), items: t.resources && t.resources.length ? t.resources : void 0 });
 }
 function Ct(t) {
   return !t.canvases || t.canvases.length === 0 ? { canvases: [], behavior: [] } : { canvases: t.canvases, behavior: t.viewingHint ? [t.viewingHint] : [], startCanvas: t.startCanvas };
@@ -381,47 +381,47 @@ function bt(t) {
       else if (r.full["@type"] === "dctypes:Image") i = { id: r.full["@id"], type: "Image" };
       else if (r.full["@type"] === "sc:Canvas") i = { id: r.full["@id"], type: "Canvas" };
       else throw new Error(`Unsupported source type on annotation: ${r.full["@type"]}`);
-      return { type: "SpecificResource", source: i, selector: M(r.selector) };
+      return { type: "SpecificResource", source: i, selector: j(r.selector) };
     } else return encodeURI(r["@id"]).trim();
   }
-  return h({ ...m(t), ...g(t), ...A(t), target: e(t.on), body: Array.isArray(t.resource) ? t.resource.map(N) : N(t.resource) });
+  return u({ ...d(t), ...y(t), ...C(t), target: e(t.on), body: Array.isArray(t.resource) ? t.resource.map(N) : N(t.resource) });
 }
 function N(t) {
   return t.type === "Choice" ? t : ee(t);
 }
 function ee(t) {
   let e = t;
-  return h({ ...m(e), ...g(e), ...A(e), ...ft(e) });
+  return u({ ...d(e), ...y(e), ...C(e), ...ft(e) });
 }
 function Rt(t) {
   let e = [];
-  return t.default && t.default !== "rdf:nil" && e.push(t.default), t.item && t.item !== "rdf:nil" && e.push(...t.item), h({ ...m(t), ...g(t), items: e });
+  return t.default && t.default !== "rdf:nil" && e.push(t.default), t.item && t.item !== "rdf:nil" && e.push(...t.item), u({ ...d(t), ...y(t), items: e });
 }
 function Lt(t) {
-  return h({ ...m(t), ...g(t), ...A(t), items: t.members });
+  return u({ ...d(t), ...y(t), ...C(t), items: t.members });
 }
 function wt(t) {
   let { "@id": e, "@type": r, "@context": i, profile: s, ...n } = t, a = {};
-  return e && (a["@id"] = e), a["@type"] = j(t), a["@type"] === "unknown" && (i && i.length && (a["@context"] = i), a["@type"] = "Service"), s && (a.profile = Y(s)), h({ ...a, ...n });
+  return e && (a["@id"] = e), a["@type"] = k(t), a["@type"] === "unknown" && (i && i.length && (a["@context"] = i), a["@type"] = "Service"), s && (a.profile = Y(s)), u({ ...a, ...n });
 }
 function It(t) {
-  return h({ ...m(t), ...g(t), ...A(t) });
+  return u({ ...d(t), ...y(t), ...C(t) });
 }
 var St = new Oe({ collection: [mt], manifest: [gt], canvas: [yt], annotationList: [At], sequence: [Ct], annotation: [bt], contentResource: [ee], choice: [Rt], range: [Lt], service: [wt], layer: [It] });
 function te(t) {
   return t && t["@context"] && (t["@context"] === "http://iiif.io/api/presentation/2/context.json" || t["@context"].indexOf("http://iiif.io/api/presentation/2/context.json") !== -1 || t["@context"] === "http://www.shared-canvas.org/ns/context.json") || t["@context"] === "http://iiif.io/api/image/2/context.json" ? St.traverseUnknown(t) : t;
 }
-function M(t) {
+function j(t) {
   if ((Array.isArray(t["@type"]) && t["@type"].includes("oa:SvgSelector") || t["@type"] == "oa:SvgSelector") && ("chars" in t || "value" in t)) return { type: "SvgSelector", value: "chars" in t ? t.chars : t.value };
   if (t["@type"] === "oa:FragmentSelector") return { type: "FragmentSelector", value: t.value };
-  if (t["@type"] === "oa:Choice") return [M(t.default), ...(Array.isArray(t.item) ? t.item : [t.item]).map(M)];
+  if (t["@type"] === "oa:Choice") return [j(t.default), ...(Array.isArray(t.item) ? t.item : [t.item]).map(j)];
   if (t["@type"] == "iiif:ImageApiSelector") return { type: "ImageApiSelector", region: "region" in t ? t.region : void 0, rotation: "rotation" in t ? t.rotation : void 0 };
   throw new Error(`Unsupported selector type: ${t["@type"]}`);
 }
-function T(t) {
+function x(t) {
   return typeof t == "string" ? !1 : t && !t.type && "source" in t ? (t.type = "SpecificResource", !0) : !!t && t.type === "SpecificResource";
 }
-function w(...t) {
+function S(...t) {
   return (e) => t.reduce((r, i) => i(r), e);
 }
 var q = ["Collection", "Manifest", "Canvas", "AnnotationPage", "AnnotationCollection", "Annotation", "ContentResource", "Range", "Service", "Selector", "Agent"];
@@ -439,9 +439,9 @@ function Tt(t, e) {
   if (t.profile) return "Service";
   throw new Error("Resource type is not known");
 }
-var k = class re {
+var P = class re {
   constructor(e, r = {}) {
-    y(this, "traversals"), y(this, "options"), y(this, "_traverseManifest", w(this.traverseManifestItems.bind(this), this.traverseLinking.bind(this), this.traverseDescriptive.bind(this), this.traverseLinkedCanvases.bind(this), this.traverseManifestStructures.bind(this), this.traverseInlineAnnotationPages.bind(this))), y(this, "_traverseCanvas", w(this.traverseCanvasItems.bind(this), this.traverseLinking.bind(this), this.traverseDescriptive.bind(this), this.traverseLinkedCanvases.bind(this), this.traverseInlineAnnotationPages.bind(this))), y(this, "_traverseAnnotationPage", w(this.traverseAnnotationPageItems.bind(this), this.traverseLinking.bind(this), this.traverseDescriptive.bind(this))), y(this, "_traverseRange", w(this.traverseRangeRanges.bind(this), this.traverseLinking.bind(this), this.traverseDescriptive.bind(this), this.traverseLinkedCanvases.bind(this))), this.traversals = { collection: [], manifest: [], canvas: [], annotationCollection: [], annotationPage: [], annotation: [], contentResource: [], choice: [], range: [], service: [], agent: [], specificResource: [], geoJson: [], ...e }, this.options = { allowUndefinedReturn: !1, ...r };
+    A(this, "traversals"), A(this, "options"), A(this, "_traverseManifest", S(this.traverseManifestItems.bind(this), this.traverseLinking.bind(this), this.traverseDescriptive.bind(this), this.traverseLinkedCanvases.bind(this), this.traverseManifestStructures.bind(this), this.traverseInlineAnnotationPages.bind(this))), A(this, "_traverseCanvas", S(this.traverseCanvasItems.bind(this), this.traverseLinking.bind(this), this.traverseDescriptive.bind(this), this.traverseLinkedCanvases.bind(this), this.traverseInlineAnnotationPages.bind(this))), A(this, "_traverseAnnotationPage", S(this.traverseAnnotationPageItems.bind(this), this.traverseLinking.bind(this), this.traverseDescriptive.bind(this))), A(this, "_traverseRange", S(this.traverseRangeRanges.bind(this), this.traverseLinking.bind(this), this.traverseDescriptive.bind(this), this.traverseLinkedCanvases.bind(this))), this.traversals = { collection: [], manifest: [], canvas: [], annotationCollection: [], annotationPage: [], annotation: [], contentResource: [], choice: [], range: [], service: [], agent: [], specificResource: [], geoJson: [], ...e }, this.options = { allowUndefinedReturn: !1, ...r };
   }
   static all(e) {
     return new re({ collection: [e], manifest: [e], canvas: [e], annotationCollection: [e], annotationPage: [e], annotation: [e], contentResource: [e], choice: [e], range: [e], service: [e], geoJson: [e], specificResource: [e], agent: [e] });
@@ -450,7 +450,7 @@ var k = class re {
     return e.thumbnail && (e.thumbnail = b(e.thumbnail).map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.provider && (e.provider = e.provider.map((r) => this.traverseAgent(r, e))), e;
   }
   traverseLinking(e) {
-    return e.seeAlso && (e.seeAlso = e.seeAlso.map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.service && (e.service = b(e.service).map((r) => this.traverseService(r))), e.services && (e.services = b(e.services).map((r) => this.traverseService(r, e))), e.logo && (e.logo = e.logo.map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.homepage && (e.homepage = b(e.homepage).map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.partOf && (e.partOf = e.partOf.map((r) => typeof r == "string" || !r.type ? this.traverseType(r, { parent: e }, this.traversals.contentResource) : r.type === "Canvas" ? this.traverseType(r, { parent: e }, this.traversals.canvas) : r.type === "AnnotationCollection" ? this.traverseType(r, { parent: e }, this.traversals.annotationCollection) : r.type === "Collection" ? this.traverseType(r, { parent: e }, this.traversals.collection) : this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.start && (T(e.start) ? e.start = this.traverseSpecificResource(e.start, "Canvas", e) : e.start = this.traverseType(e.start, { parent: e }, this.traversals.canvas)), e.rendering && (e.rendering = e.rendering.map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.supplementary && (e.supplementary = e.supplementary.map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e;
+    return e.seeAlso && (e.seeAlso = e.seeAlso.map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.service && (e.service = b(e.service).map((r) => this.traverseService(r))), e.services && (e.services = b(e.services).map((r) => this.traverseService(r, e))), e.logo && (e.logo = e.logo.map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.homepage && (e.homepage = b(e.homepage).map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.partOf && (e.partOf = e.partOf.map((r) => typeof r == "string" || !r.type ? this.traverseType(r, { parent: e }, this.traversals.contentResource) : r.type === "Canvas" ? this.traverseType(r, { parent: e }, this.traversals.canvas) : r.type === "AnnotationCollection" ? this.traverseType(r, { parent: e }, this.traversals.annotationCollection) : r.type === "Collection" ? this.traverseType(r, { parent: e }, this.traversals.collection) : this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.start && (x(e.start) ? e.start = this.traverseSpecificResource(e.start, "Canvas", e) : e.start = this.traverseType(e.start, { parent: e }, this.traversals.canvas)), e.rendering && (e.rendering = e.rendering.map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e.supplementary && (e.supplementary = e.supplementary.map((r) => this.traverseType(r, { parent: e }, this.traversals.contentResource))), e;
   }
   traverseCollectionItems(e) {
     return e.items && e.items.map((r) => r.type === "Collection" ? this.traverseCollection(r) : this.traverseManifest(r)), e;
@@ -501,14 +501,14 @@ var k = class re {
     return typeof e == "string" || !e || e && e.service && (e.service = b(e.service || []).map((r) => this.traverseService(r, e))), e;
   }
   traverseContentResource(e, r) {
-    return e.type === "Choice" && (e.items = e.items.map((i) => this.traverseContentResource(i, e))), T(e) ? this.traverseSpecificResource(e, "ContentResource") : this.traverseType(this.traverseInlineAnnotationPages(this.traverseContentResourceLinking(e)), { parent: r }, this.traversals.contentResource);
+    return e.type === "Choice" && (e.items = e.items.map((i) => this.traverseContentResource(i, e))), x(e) ? this.traverseSpecificResource(e, "ContentResource") : this.traverseType(this.traverseInlineAnnotationPages(this.traverseContentResourceLinking(e)), { parent: r }, this.traversals.contentResource);
   }
   traverseSpecificResource(e, r, i) {
     let s = e.source;
     return typeof e.source == "string" && (s = { id: e.source, type: r || "unknown" }), this.traverseType({ ...e, source: r === "Canvas" || s.type === "Canvas" ? this.traverseType(s, { parent: i }, this.traversals.canvas) : r === "ContentResource" ? this.traverseContentResource(s, { parent: i }) : this.traverseUnknown(s, { parent: i, typeHint: r }) }, { parent: i }, this.traversals.specificResource);
   }
   traverseRangeRanges(e) {
-    return e.items && (e.items = e.items.map((r) => typeof r == "string" ? this.traverseCanvas({ id: r, type: "Canvas" }, e) : T(r) ? this.traverseSpecificResource(r, "Canvas", e) : r.type === "Manifest" ? this.traverseManifest(r, e) : this.traverseRange(r, e))), e;
+    return e.items && (e.items = e.items.map((r) => typeof r == "string" ? this.traverseCanvas({ id: r, type: "Canvas" }, e) : x(r) ? this.traverseSpecificResource(r, "Canvas", e) : r.type === "Manifest" ? this.traverseManifest(r, e) : this.traverseRange(r, e))), e;
   }
   traverseRange(e, r) {
     return this.traverseType(this._traverseRange(e), { parent: r }, this.traversals.range);
@@ -552,18 +552,18 @@ var k = class re {
     }
   }
 };
-const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.profile.toString().includes("iiif.io/api/image/"), se = (t) => {
-  const e = v(t, "type"), r = v(t, "context");
+const ie = (t) => h(t, "type").startsWith("ImageService") || t.profile && t.profile.toString().includes("iiif.io/api/image/"), se = (t) => {
+  const e = h(t, "type"), r = h(t, "context");
   if (e === "ImageService2" || r != null && r.includes("image/2")) {
     const i = t, s = ["level0", "level1", "level2"];
-    return { majorVersion: 2, profileLevel: (Array.isArray(i.profile) ? i.profile : [i.profile]).map((o) => s.findIndex((c) => o.toString().includes(c))).filter((o) => o > -1).sort((o, c) => c - o)[0] };
+    return { majorVersion: 2, profileLevel: (Array.isArray(i.profile) ? i.profile : [i.profile]).map((c) => s.findIndex((l) => c.toString().includes(l))).filter((c) => c > -1).sort((c, l) => l - c)[0] };
   } else if (e || r)
     return { majorVersion: 3, profileLevel: parseInt(t.profile) };
 }, _ = (t, e, r) => {
-  const i = v(t, "id"), s = t.profile || "";
+  const i = h(t, "id"), s = t.profile || "";
   if (typeof s == "string" && (s.includes("level0") || s.includes("level:0"))) {
     if ("sizes" in t && Array.isArray(t.sizes)) {
-      const a = t.sizes.sort((o, c) => c.width * c.height - o.width * o.height).filter((o) => o.width * o.height >= e * r)[0];
+      const a = t.sizes.sort((c, l) => l.width * l.height - c.width * c.height).filter((c) => c.width * c.height >= e * r)[0];
       if (a)
         return `${i}/full/${a.width},${a.height}/0/default.jpg`;
     }
@@ -571,10 +571,10 @@ const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.prof
   }
   return `${i}/full/!${e},${r}/0/default.jpg`;
 }, xt = (t, e, r) => {
-  const i = v(t, "id"), s = t.profile || "";
+  const i = h(t, "id"), s = t.profile || "";
   if (typeof s == "string" && (s.includes("level0") || s.includes("level:0"))) return;
-  const { x: a, y: o, w: c, h: p } = e, u = c / p, C = u < 1, I = Math.ceil(C ? r / u : r), l = Math.ceil(C ? r : r / u), d = `${Math.round(a)},${Math.round(o)},${Math.round(c)},${Math.round(p)}`;
-  return `${i}/${d}/!${l},${I}/0/default.jpg`;
+  const { x: a, y: c, w: l, h: p } = e, v = l / p, f = v < 1, L = Math.ceil(f ? r / v : r), o = Math.ceil(f ? r : r / v), m = `${Math.round(a)},${Math.round(c)},${Math.round(l)},${Math.round(p)}`;
+  return `${i}/${m}/!${o},${L}/0/default.jpg`;
 }, $t = (t) => (e, r = 400) => {
   if (t.type === "dynamic")
     return xt(t.service, e, r);
@@ -582,37 +582,37 @@ const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.prof
 }, Mt = (t, e = []) => (r = 400) => {
   const { width: i, height: s } = t;
   if (!i || !s) return;
-  const n = i / s, a = n < 1, o = Math.ceil(a ? r / n : r), c = Math.ceil(a ? r : r / n);
+  const n = i / s, a = n < 1, c = Math.ceil(a ? r / n : r), l = Math.ceil(a ? r : r / n);
   if (t.thumbnail && t.thumbnail.length > 0) {
     const p = t.thumbnail[0];
     if ("service" in p && Array.isArray(p.service)) {
-      const u = p.service.find((C) => ie(C));
-      if (u)
-        return _(u, c, o);
+      const v = p.service.find((f) => ie(f));
+      if (v)
+        return _(v, l, c);
     }
     if ("id" in p) return p.id;
   }
   for (const p of e) {
     if (p.type === "dynamic" || p.type === "level0")
-      return _(p.service, c, o);
+      return _(p.service, l, c);
     if (p.type === "static")
       return p.url;
   }
 }, ne = (t) => t.endsWith("/info.json") ? t : `${t.endsWith("/") ? t : `${t}/`}info.json`, jt = (t) => {
-  const { format: e, height: r, width: i } = t, s = v(t, "id"), n = (t.service || []).find(ie), a = n ? se(n) : void 0;
+  const { format: e, height: r, width: i } = t, s = h(t, "id"), n = (t.service || []).find(ie), a = n ? se(n) : void 0;
   if (a) {
-    const o = {
+    const c = {
       source: t,
       type: a.profileLevel === 0 ? "level0" : "dynamic",
       service: n,
       width: i,
       height: r,
       majorVersion: a.majorVersion,
-      serviceUrl: ne(v(n, "id"))
+      serviceUrl: ne(h(n, "id"))
     };
-    return a.profileLevel === 0 ? o : {
-      ...o,
-      getRegionURL: $t(o)
+    return a.profileLevel === 0 ? c : {
+      ...c,
+      getRegionURL: $t(c)
     };
   } else
     return {
@@ -625,7 +625,7 @@ const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.prof
     };
 }, kt = (t) => {
   const e = [];
-  return new k({
+  return new P({
     annotation: [(i) => {
       if (i.motivation === "painting" || !i.motivation) {
         const n = (i.body ? Array.isArray(i.body) ? i.body : [i.body] : []).filter((a) => a.type === "Image");
@@ -634,34 +634,42 @@ const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.prof
     }]
   }).traverseCanvas(t), e;
 }, Pt = (t) => () => {
-  const e = (i, s, n = 0) => {
-    const a = {
-      id: i.id,
+  const e = /* @__PURE__ */ new Map(), r = (a, c, l = 0) => {
+    const p = {
+      id: a.id,
       type: "range",
-      getLabel: i.getLabel,
+      source: a,
       children: [],
-      parent: s,
-      level: n
+      navItems: [],
+      navSections: [],
+      parent: c,
+      level: l,
+      getLabel: a.getLabel
     };
-    return i.items && i.items.length > 0 && i.items.forEach((o) => {
+    a.items && a.items.length > 0 && a.items.forEach((o) => {
       if (o.source.type === "Range") {
-        const c = e(o, a, n + 1);
-        a.children.push(c);
+        const I = r(o, p, l + 1);
+        p.children.push(I);
       } else
-        a.children.push({
+        p.children.push({
           id: o.id,
           type: "canvas",
-          getLabel: o.getLabel,
+          source: o,
           children: [],
-          parent: a,
-          level: n + 1
+          navItems: [],
+          navSections: [],
+          parent: p,
+          level: l + 1,
+          getLabel: o.getLabel
         });
-    }), a;
+    });
+    const v = p.children.map((o) => o.type === "canvas" ? o.source : o.children.length === 1 && o.children[0].type === "canvas" ? o.children[0].source : o.source), f = v.filter((o) => o.source.type === "Canvas"), L = v.filter((o) => o.source.type === "Range");
+    return p.navItems.push(...f), p.navSections.push(...L), e.set(p.id, p), p;
   };
-  return t.filter((i) => {
-    var s;
-    return (s = i.source.behavior) == null ? void 0 : s.includes("top");
-  }).map((i) => e(i, void 0));
+  return { root: t.filter((a) => {
+    var c;
+    return (c = a.source.behavior) == null ? void 0 : c.includes("top");
+  }).map((a) => r(a, void 0)), getNode: (a) => e.get(a) };
 }, Ot = async (t) => {
   try {
     new URL(t);
@@ -716,7 +724,7 @@ const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.prof
       code: "INVALID_MANIFEST",
       message: "Missing @context"
     };
-  const i = v(t, "id");
+  const i = h(t, "id");
   if (!i)
     return {
       type: "error",
@@ -725,7 +733,7 @@ const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.prof
     };
   if (r.includes("presentation/2") || r.includes("presentation/3")) {
     const s = r.includes("presentation/2") ? 2 : 3;
-    return v(t, "type").includes("Collection") ? {
+    return h(t, "type").includes("Collection") ? {
       type: "collection",
       url: e || i,
       resource: Ut(t, s)
@@ -755,13 +763,13 @@ const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.prof
 }, Ut = (t, e) => {
   const r = (n) => {
     const a = [];
-    return new k({
-      manifest: [(c) => a.push(c)]
-    }).traverseCollection(n), a.map((c) => ({
-      id: c.id,
-      type: c.type,
-      getLabel: L(c),
-      source: c
+    return new P({
+      manifest: [(l) => a.push(l)]
+    }).traverseCollection(n), a.map((l) => ({
+      id: l.id,
+      type: l.type,
+      getLabel: w(l),
+      source: l
     }));
   }, i = e === 2 ? te(t) : t, s = r(i);
   return {
@@ -769,46 +777,46 @@ const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.prof
     id: i.id,
     majorVersion: e,
     items: s,
-    getLabel: L(i),
-    getMetadata: x(i)
+    getLabel: w(i),
+    getMetadata: $(i)
   };
 }, Dt = (t, e) => {
   const r = (a) => {
-    const o = [], c = [];
-    new k({
-      canvas: [(l) => {
-        l.items && o.push(l);
+    const c = [], l = [];
+    new P({
+      canvas: [(o) => {
+        o.items && c.push(o);
       }],
-      range: [(l) => {
-        l.type === "Range" && c.push(l);
+      range: [(o) => {
+        o.type === "Range" && l.push(o);
       }]
     }).traverseManifest(a);
-    const u = o.map((l) => {
-      const d = kt(l);
+    const v = c.map((o) => {
+      const m = kt(o);
       return {
-        source: l,
-        id: l.id,
-        width: l.width,
-        height: l.height,
-        images: d,
-        annotations: l.annotations || [],
-        getLabel: L(l),
-        getMetadata: x(l),
-        getThumbnailURL: Mt(l, d)
+        source: o,
+        id: o.id,
+        width: o.width,
+        height: o.height,
+        images: m,
+        annotations: o.annotations || [],
+        getLabel: w(o),
+        getMetadata: $(o),
+        getThumbnailURL: Mt(o, m)
       };
-    }), C = (l) => {
-      const d = l.items || [], P = d.filter((f) => f.type === "Canvas").map((f) => u.find((S) => S.id === f.id)).filter(Boolean), O = d.filter((f) => f.type === "Range").map((f) => C(f)), oe = [...P, ...O];
+    }), f = (o) => {
+      const m = o.items || [], I = m.filter((g) => g.type === "Canvas").map((g) => v.find((T) => T.id === g.id)).filter(Boolean), O = m.filter((g) => g.type === "Range").map((g) => f(g)), oe = [...I, ...O];
       return {
-        source: l,
-        id: l.id,
+        source: o,
+        id: o.id,
         // Maintain original order
-        items: d.map((f) => oe.find((S) => S.id === f.id)),
-        canvases: P,
+        items: m.map((g) => oe.find((T) => T.id === g.id)),
+        canvases: I,
         ranges: O,
-        getLabel: L(l)
+        getLabel: w(o)
       };
-    }, I = c.map((l) => C(l));
-    return { canvases: u, ranges: I };
+    }, L = l.map((o) => f(o));
+    return { canvases: v, ranges: L };
   }, i = e === 2 ? te(t) : t, { canvases: s, ranges: n } = r(i);
   return {
     source: i,
@@ -816,8 +824,8 @@ const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.prof
     majorVersion: e,
     canvases: s,
     structure: n,
-    getLabel: L(i),
-    getMetadata: x(i),
+    getLabel: w(i),
+    getMetadata: $(i),
     getTableOfContents: Pt(n)
   };
 }, Et = (t) => {
@@ -829,16 +837,16 @@ const ie = (t) => v(t, "type").startsWith("ImageService") || t.profile && t.prof
       width: e,
       height: r,
       majorVersion: i.majorVersion,
-      serviceUrl: ne(v(t, "id"))
+      serviceUrl: ne(h(t, "id"))
     };
 }, qt = { parse: ae, parseURL: Ot };
 export {
   qt as Cozy,
   _ as getImageURLFromService,
   kt as getImages,
-  L as getLabel,
-  x as getMetadata,
-  v as getPropertyValue,
+  w as getLabel,
+  $ as getMetadata,
+  h as getPropertyValue,
   $t as getRegionURL,
   xt as getRegionURLFromService,
   Ft as getStringValue,

package/dist/types.d.ts

@@ -43,7 +43,7 @@ export interface CozyManifest {
     readonly canvases: CozyCanvas[];
     readonly structure: CozyRange[];
     getLabel(locale?: string): string | undefined;
-    getTableOfContents(): CozyTOCNode[];
+    getTableOfContents(): CozyTOC;
     getMetadata(locale?: string): CozyMetadata[];
 }
 export interface CozyRange {
@@ -69,13 +69,20 @@ export interface CozyMetadata {
     readonly label: string;
     readonly value: string;
 }
+export interface CozyTOC {
+    root: CozyTOCNode[];
+    getNode(id: string): CozyTOCNode | undefined;
+}
 export interface CozyTOCNode {
     readonly id: string;
     readonly type: 'range' | 'canvas';
+    readonly source: CozyRange | CozyCanvas;
+    readonly children: CozyTOCNode[];
+    readonly navItems: CozyCanvas[];
+    readonly navSections: CozyRange[];
+    readonly parent?: CozyTOCNode;
+    readonly level: number;
     getLabel(locale?: string): string | undefined;
-    children: CozyTOCNode[];
-    parent?: CozyTOCNode;
-    level: number;
 }
 export type CozyImageResource = StaticImageResource | ImageServiceResource;
 export type ImageServiceResource = DynamicImageServiceResource | Level0ImageServiceResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-iiif",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A developer-friendly collection of abstractions and utilities built on top of @iiif/presentation-3 and @iiif/parser",
   "license": "MIT",
   "author": "Rainer Simon",

package/src/core/manifest.ts

@@ -1,38 +1,75 @@
-import type { CozyRange, CozyTOCNode } from '../types';
+import type { CozyCanvas, CozyRange, CozyTOC, CozyTOCNode } from '../types';
 
-export const getTableOfContents = (ranges: CozyRange[]) => () => {
+export const getTableOfContents = (ranges: CozyRange[]) => (): CozyTOC => {
+
+  const index = new Map<string, CozyTOCNode>();
 
   const buildTree = (range: CozyRange, parent: CozyTOCNode | undefined, level: number = 0): CozyTOCNode => {
     const node: CozyTOCNode = {
       id: range.id,
       type: 'range',
-      getLabel: range.getLabel,
+      source: range,
       children: [],
+      navItems: [],
+      navSections: [],
       parent,
-      level
+      level,
+      getLabel: range.getLabel,
     };
     
     if (range.items && range.items.length > 0) {
       range.items.forEach(item => {
         if (item.source.type === 'Range') {
-          const childNode = buildTree(item as CozyRange, node, level + 1);
+          const r = item as CozyRange;
+          const childNode = buildTree(r, node, level + 1);
           node.children.push(childNode);
         } else {
+          // This child is Canvas, i.e. a TOCNode with
+          // no further children.
           node.children.push({
             id: item.id,
             type: 'canvas',
-            getLabel: item.getLabel,
+            source: item as CozyCanvas,
             children: [],
+            navItems: [],
+            navSections: [],
             parent: node,
-            level: level + 1
+            level: level + 1,
+            getLabel: item.getLabel
           });
         }
       });
     }
+
+    // From the actual child ToC Nodes, infer the "logical" child navItems
+    // (canvases) and navSections (ranges).
+    const navChildren = node.children.map(n => {
+      if (n.type === 'canvas') {
+        // An actual leaf node
+        return n.source as CozyCanvas;
+      } else if (n.children.length === 1 && n.children[0].type === 'canvas') {
+        // A range with a single canvas child - logical leaf node!
+        return n.children[0].source as CozyCanvas;
+      } else {
+        return n.source as CozyRange;
+      }
+    });
+
+    const navItems = navChildren.filter(c => c.source.type === 'Canvas') as CozyCanvas[];
+    const navSections = navChildren.filter(c => c.source.type === 'Range') as CozyRange[];
     
+    node.navItems.push(...navItems);
+    node.navSections.push(...navSections);
+
+    index.set(node.id, node);
+
     return node;
   };
 
   const topRanges = ranges.filter(range => range.source.behavior?.includes('top'));
-  return topRanges.map(range => buildTree(range, undefined));
+  const root = topRanges.map(range => buildTree(range, undefined));
+
+  const getNode = (id: string) => index.get(id);
+
+  return { root, getNode };
 }

package/src/types.ts

@@ -1,4 +1,13 @@
-import type { Manifest, Canvas, ImageService2, ImageService3, IIIFExternalWebResource, Collection, Range, Annotation, AnnotationPage } from '@iiif/presentation-3';
+import type {
+  Manifest, 
+  Canvas, 
+  ImageService2, 
+  ImageService3, 
+  IIIFExternalWebResource, 
+  Collection, 
+  Range, 
+  AnnotationPage 
+} from '@iiif/presentation-3';
 
 export type CozyParseResult = 
   | { type: 'collection', url: string, resource: CozyCollection }
@@ -54,7 +63,7 @@ export interface CozyManifest {
 
   getLabel(locale?: string): string | undefined;
 
-  getTableOfContents(): CozyTOCNode[];
+  getTableOfContents(): CozyTOC;
 
   getMetadata(locale?: string): CozyMetadata[];
 
@@ -106,19 +115,33 @@ export interface CozyMetadata {
 
 }
 
+export interface CozyTOC {
+
+  root: CozyTOCNode[];
+
+  getNode(id: string): CozyTOCNode | undefined;
+
+}
+
 export interface CozyTOCNode {
 
   readonly id: string;
 
   readonly type: 'range' | 'canvas';
 
-  getLabel(locale?: string): string | undefined;
+  readonly source: CozyRange | CozyCanvas;
+
+  readonly children: CozyTOCNode[];
+
+  readonly navItems: CozyCanvas[]; 
 
-  children: CozyTOCNode[];
+  readonly navSections: CozyRange[];
 
-  parent?: CozyTOCNode;
+  readonly parent?: CozyTOCNode;
 
-  level: number;
+  readonly level: number;
+
+  getLabel(locale?: string): string | undefined;
 
 }