cozy-iiif 0.1.6 → 0.2.1

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.1.6",
+  "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",
@@ -24,6 +24,7 @@
   },
   "exports": {
     ".": "./dist/index.js",
+    "./helpers": "./dist/helpers/index.js",
     "./level-0": "./dist/level-0/index.js"
   },
   "devDependencies": {

package/src/Cozy.ts

@@ -1,7 +1,6 @@
 import type { Canvas, Collection, Manifest, Range } from '@iiif/presentation-3';
 import { convertPresentation2  } from '@iiif/parser/presentation-2';
 import { Traverse } from '@iiif/parser';
-import * as Helpers from './helpers';
 import { 
   getImages, 
   getLabel, 
@@ -261,4 +260,4 @@ const parseImageResource = (resource: any) => {
   }
 }
 
-export const Cozy = { parse, parseURL, Helpers };
+export const Cozy = { parse, parseURL };

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;
 
 }
 

package/vite.config.ts

@@ -8,6 +8,7 @@ export default defineConfig({
     lib: {
       entry: {
         'index': resolve(__dirname, 'src/index.ts'),
+        'helpers/index': resolve(__dirname, 'src/helpers/index.ts'),
         'level-0/index': resolve(__dirname, 'src/level-0/index.ts'),
       },
       formats: ['es']