cozy-iiif 0.1.3 → 0.1.5

package/dist/types.d.ts

@@ -1,5 +1,9 @@
-import { Manifest, Canvas, ImageService2, ImageService3, IIIFExternalWebResource } from '@iiif/presentation-3';
+import { Manifest, Canvas, ImageService2, ImageService3, IIIFExternalWebResource, Collection, Range } from '@iiif/presentation-3';
 export type CozyParseResult = {
+    type: 'collection';
+    url: string;
+    resource: CozyCollection;
+} | {
     type: 'manifest';
     url: string;
     resource: CozyManifest;
@@ -18,14 +22,38 @@ export type CozyParseResult = {
     code: 'INVALID_URL' | 'INVALID_HTTP_RESPONSE' | 'FETCH_ERROR' | 'INVALID_MANIFEST' | 'UNSUPPORTED_FORMAT';
     message: string;
 };
+export interface CozyCollection {
+    readonly majorVersion: number;
+    readonly source: Collection;
+    readonly id: string;
+    readonly items: CozyCollectionItem[];
+    getLabel(locale?: string): string | undefined;
+    getMetadata(locale?: string): CozyMetadata[];
+}
+export interface CozyCollectionItem {
+    readonly id: string;
+    readonly type: string;
+    readonly source: any;
+    getLabel(locale?: string): string | undefined;
+}
 export interface CozyManifest {
     readonly majorVersion: number;
     readonly source: Manifest;
     readonly id: string;
     readonly canvases: CozyCanvas[];
+    readonly structure: CozyRange[];
     getLabel(locale?: string): string | undefined;
+    getTableOfContents(): CozyTOCNode[];
     getMetadata(locale?: string): CozyMetadata[];
 }
+export interface CozyRange {
+    readonly source: Range;
+    readonly id: string;
+    readonly items: (CozyCanvas | CozyRange)[];
+    readonly canvases: CozyCanvas[];
+    readonly ranges: CozyRange[];
+    getLabel(locale?: string): string | undefined;
+}
 export interface CozyCanvas {
     readonly source: Canvas;
     readonly id: string;
@@ -37,45 +65,53 @@ export interface CozyCanvas {
     getThumbnailURL(minSize?: number): string;
 }
 export interface CozyMetadata {
-    label: string;
-    value: string;
+    readonly label: string;
+    readonly value: string;
+}
+export interface CozyTOCNode {
+    readonly id: string;
+    readonly type: 'range' | 'canvas';
+    getLabel(locale?: string): string | undefined;
+    children: CozyTOCNode[];
+    parent?: CozyTOCNode;
+    level: number;
 }
 export type CozyImageResource = StaticImageResource | ImageServiceResource;
 export type ImageServiceResource = DynamicImageServiceResource | Level0ImageServiceResource;
 interface BaseImageResource {
     readonly source: IIIFExternalWebResource;
-    type: 'static' | 'dynamic' | 'level0';
-    width: number;
-    height: number;
+    readonly type: 'static' | 'dynamic' | 'level0';
+    readonly width: number;
+    readonly height: number;
 }
 export interface StaticImageResource extends BaseImageResource {
-    type: 'static';
-    url: string;
+    readonly type: 'static';
+    readonly url: string;
 }
 export interface DynamicImageServiceResource extends BaseImageResource {
-    type: 'dynamic';
-    service: ImageService2 | ImageService3;
-    serviceUrl: string;
-    majorVersion: number;
+    readonly type: 'dynamic';
+    readonly service: ImageService2 | ImageService3;
+    readonly serviceUrl: string;
+    readonly majorVersion: number;
     getRegionURL(bounds: Bounds, minSize?: number): string;
 }
 export interface Level0ImageServiceResource extends BaseImageResource {
-    type: 'level0';
-    majorVersion: number;
-    service: ImageService2 | ImageService3;
-    serviceUrl: string;
+    readonly type: 'level0';
+    readonly majorVersion: number;
+    readonly service: ImageService2 | ImageService3;
+    readonly serviceUrl: string;
 }
 export interface ImageRequestOptions {
-    width?: number;
-    height?: number;
-    region?: 'full' | 'square' | {
+    readonly width?: number;
+    readonly height?: number;
+    readonly region?: 'full' | 'square' | {
         x: number;
         y: number;
         width: number;
         height: number;
     };
-    quality?: 'default' | 'color' | 'gray' | 'bitonal';
-    format?: 'jpg' | 'png' | 'gif' | 'webp';
+    readonly quality?: 'default' | 'color' | 'gray' | 'bitonal';
+    readonly format?: 'jpg' | 'png' | 'gif' | 'webp';
 }
 export interface Bounds {
     x: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-iiif",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "A developer-friendly collection of abstractions and utilities built on top of @iiif/presentation-3 and @iiif/parser",
   "license": "MIT",
   "author": "Rainer Simon",
@@ -19,15 +19,17 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "vite build"
+    "build": "vite build",
+    "test": "vitest"
   },
   "exports": {
     ".": "./dist/index.js",
     "./level-0": "./dist/level-0/index.js"
   },
   "devDependencies": {
-    "vite": "^6.2.2",
-    "vite-plugin-dts": "^4.5.3"
+    "vite": "^6.2.5",
+    "vite-plugin-dts": "^4.5.3",
+    "vitest": "^3.1.1"
   },
   "dependencies": {
     "@iiif/parser": "^2.1.7",

package/src/Cozy.ts

@@ -1,16 +1,25 @@
-import type { Canvas, Manifest } from '@iiif/presentation-3';
+import type { Canvas, Collection, Manifest, Range } from '@iiif/presentation-3';
 import { convertPresentation2  } from '@iiif/parser/presentation-2';
 import { Traverse } from '@iiif/parser';
-import type { CozyCanvas, CozyManifest, CozyParseResult, ImageServiceResource } from './types';
 import { 
   getImages, 
   getLabel, 
   getMetadata, 
   getPropertyValue, 
+  getTableOfContents,
   getThumbnailURL, 
   normalizeServiceUrl, 
   parseImageService 
 } from './core';
+import type { 
+  CozyCanvas, 
+  CozyCollection, 
+  CozyCollectionItem, 
+  CozyManifest, 
+  CozyParseResult, 
+  CozyRange, 
+  ImageServiceResource 
+} from './types';
 
 export const Cozy = {
   
@@ -88,7 +97,13 @@ export const Cozy = {
       if (context.includes('presentation/2') || context.includes('presentation/3')) {
         const majorVersion = context.includes('presentation/2') ? 2 : 3;
 
-        return {
+        const type = getPropertyValue(json, 'type');
+
+        return type.includes('Collection') ? {
+          type: 'collection',
+          url: input,
+          resource: parseCollectionResource(json, majorVersion)
+        } : {
           type: 'manifest',
           url: input,
           resource: parseManifestResource(json, majorVersion)
@@ -125,18 +140,53 @@ export const Cozy = {
 
 }
 
+const parseCollectionResource = (resource: any, majorVersion: number): CozyCollection => {
+
+  const parseV3 = (collection: Collection) => {
+    const items: any[] = [];
+
+    const modelBuilder = new Traverse({
+      manifest: [item => items.push(item)]
+    });
+
+    modelBuilder.traverseCollection(collection);
+
+    return items.map(source => ({
+      id: source.id,
+      type: source.type,
+      getLabel: getLabel(source),
+      source
+    }) as CozyCollectionItem);
+  }
+
+  const v3: Collection = majorVersion === 2 ? convertPresentation2(resource) : resource;
+
+  const items = parseV3(v3);
+
+  return {
+    source: v3,
+    id: v3.id,
+    majorVersion,
+    items,
+    getLabel: getLabel(v3),
+    getMetadata: getMetadata(v3)
+  };
+}
+
 const parseManifestResource = (resource: any, majorVersion: number): CozyManifest => {
 
   const parseV3 = (manifest: Manifest) => {
-    const canvases: Canvas[] = [];
+    const sourceCanvases: Canvas[] = [];
+    const sourceRanges: Range[] = [];
 
     const modelBuilder = new Traverse({
-      canvas: [canvas => { if (canvas.items) canvases.push(canvas) }]
+      canvas: [canvas => { if (canvas.items) sourceCanvases.push(canvas) }],
+      range: [range => { if (range.type === 'Range') sourceRanges.push(range) }]
     });
   
     modelBuilder.traverseManifest(manifest);
     
-    return canvases.map((c: Canvas) => {
+    const canvases = sourceCanvases.map((c: Canvas) => {
       const images = getImages(c);
       return {
         source: c,
@@ -149,19 +199,49 @@ const parseManifestResource = (resource: any, majorVersion: number): CozyManifes
         getThumbnailURL: getThumbnailURL(c, images)
       } as CozyCanvas;
     });
+
+    const toRange = (source: Range): CozyRange => {
+      const items = source.items || [];
+
+      const nestedCanvases: CozyCanvas[] = items
+        .filter((item: any) => item.type === 'Canvas')
+        .map((item: any) => canvases.find(c => c.id === item.id)!)
+        .filter(Boolean);
+
+      const nestedRanges = items
+        .filter((item: any) => item.type === 'Range')
+        .map((item: any) => toRange(item));
+
+      const nestedItems = [...nestedCanvases, ...nestedRanges];
+        
+      return {
+        source,
+        id: source.id,
+        // Maintain original order
+        items: items.map((i: any) => nestedItems.find(cozy => cozy.id === i.id)),
+        canvases: nestedCanvases,
+        ranges: nestedRanges,
+        getLabel: getLabel(source)
+      } as CozyRange;
+    }
+
+    const ranges = sourceRanges.map((source: Range) => toRange(source));
+    return { canvases, ranges };
   }
 
   const v3: Manifest = majorVersion === 2 ? convertPresentation2(resource) : resource;
 
-  const canvases = parseV3(v3);
+  const { canvases, ranges } = parseV3(v3);
 
   return {
     source: v3,
     id: v3.id,
     majorVersion,
     canvases,
+    structure: ranges,
     getLabel: getLabel(v3),
-    getMetadata: getMetadata(v3)
+    getMetadata: getMetadata(v3),
+    getTableOfContents: getTableOfContents(ranges)
   }
 }
 

package/src/core/index.ts

@@ -1,3 +1,4 @@
 export * from './canvas';
 export * from './image-service';
+export * from './manifest';
 export * from './resource';

package/src/core/manifest.ts

@@ -0,0 +1,38 @@
+import type { CozyRange, CozyTOCNode } from '../types';
+
+export const getTableOfContents = (ranges: CozyRange[]) => () => {
+
+  const buildTree = (range: CozyRange, parent: CozyTOCNode | undefined, level: number = 0): CozyTOCNode => {
+    const node: CozyTOCNode = {
+      id: range.id,
+      type: 'range',
+      getLabel: range.getLabel,
+      children: [],
+      parent,
+      level
+    };
+    
+    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);
+          node.children.push(childNode);
+        } else {
+          node.children.push({
+            id: item.id,
+            type: 'canvas',
+            getLabel: item.getLabel,
+            children: [],
+            parent: node,
+            level: level + 1
+          });
+        }
+      });
+    }
+    
+    return node;
+  };
+
+  const topRanges = ranges.filter(range => range.source.behavior?.includes('top'));
+  return topRanges.map(range => buildTree(range, undefined));
+}

package/src/types.ts

@@ -1,6 +1,7 @@
-import type { Manifest, Canvas, ImageService2, ImageService3, IIIFExternalWebResource } from '@iiif/presentation-3';
+import type { Manifest, Canvas, ImageService2, ImageService3, IIIFExternalWebResource, Collection, Range } from '@iiif/presentation-3';
 
 export type CozyParseResult = 
+  | { type: 'collection', url: string, resource: CozyCollection }
   | { type: 'manifest'; url: string, resource: CozyManifest }
   | { type: 'iiif-image'; url: string, resource: CozyImageResource }
   | { type: 'plain-image'; url: string }
@@ -11,6 +12,34 @@ export type CozyParseResult =
       message: string;
     };
 
+export interface CozyCollection {
+
+  readonly majorVersion: number;
+
+  readonly source: Collection;
+
+  readonly id: string;
+
+  readonly items: CozyCollectionItem[];
+
+  getLabel(locale?: string): string | undefined;
+
+  getMetadata(locale?: string): CozyMetadata[];
+
+}
+
+export interface CozyCollectionItem {
+
+  readonly id: string;
+
+  readonly type: string;
+
+  readonly source: any;
+
+  getLabel(locale?: string): string | undefined;
+
+}
+
 export interface CozyManifest {
 
   readonly majorVersion: number;
@@ -21,12 +50,32 @@ export interface CozyManifest {
 
   readonly canvases: CozyCanvas[];
 
+  readonly structure: CozyRange[];
+
   getLabel(locale?: string): string | undefined;
 
+  getTableOfContents(): CozyTOCNode[];
+
   getMetadata(locale?: string): CozyMetadata[];
 
 }
 
+export interface CozyRange {
+
+  readonly source: Range;
+
+  readonly id: string;
+
+  readonly items: (CozyCanvas | CozyRange)[];
+
+  readonly canvases: CozyCanvas[];
+
+  readonly ranges: CozyRange[];
+
+  getLabel(locale?: string): string | undefined;
+
+}
+
 export interface CozyCanvas {
 
   readonly source: Canvas;
@@ -49,9 +98,25 @@ export interface CozyCanvas {
 
 export interface CozyMetadata {
 
-  label: string;
+  readonly label: string;
 
-  value: string;
+  readonly value: string;
+
+}
+
+export interface CozyTOCNode {
+
+  readonly id: string;
+
+  readonly type: 'range' | 'canvas';
+
+  getLabel(locale?: string): string | undefined;
+
+  children: CozyTOCNode[];
+
+  parent?: CozyTOCNode;
+
+  level: number;
 
 }
 
@@ -67,31 +132,31 @@ interface BaseImageResource {
 
   readonly source: IIIFExternalWebResource;
 
-  type: 'static' | 'dynamic' | 'level0';
+  readonly type: 'static' | 'dynamic' | 'level0';
 
-  width: number;
+  readonly width: number;
 
-  height: number;
+  readonly height: number;
 
 }
 
 export interface StaticImageResource extends BaseImageResource {
 
-  type: 'static';
+  readonly type: 'static';
 
-  url: string;
+  readonly url: string;
 
 }
 
 export interface DynamicImageServiceResource extends BaseImageResource {
 
-  type: 'dynamic';
+  readonly type: 'dynamic';
 
-  service: ImageService2 | ImageService3;
+  readonly service: ImageService2 | ImageService3;
 
-  serviceUrl: string;
+  readonly serviceUrl: string;
 
-  majorVersion: number;
+  readonly majorVersion: number;
 
   getRegionURL(bounds: Bounds, minSize?: number): string;
 
@@ -99,28 +164,28 @@ export interface DynamicImageServiceResource extends BaseImageResource {
 
 export interface Level0ImageServiceResource extends BaseImageResource {
 
-  type: 'level0';
+  readonly type: 'level0';
 
-  majorVersion: number;
+  readonly majorVersion: number;
 
-  service: ImageService2 | ImageService3;
+  readonly service: ImageService2 | ImageService3;
 
-  serviceUrl: string;
+  readonly serviceUrl: string;
 
 }
 
 
 export interface ImageRequestOptions {
 
-  width?: number;
+  readonly width?: number;
 
-  height?: number;
+  readonly height?: number;
 
-  region?: 'full' | 'square' | { x: number; y: number; width: number; height: number };
+  readonly region?: 'full' | 'square' | { x: number; y: number; width: number; height: number };
 
-  quality?: 'default' | 'color' | 'gray' | 'bitonal';
+  readonly quality?: 'default' | 'color' | 'gray' | 'bitonal';
 
-  format?: 'jpg' | 'png' | 'gif' | 'webp';
+  readonly format?: 'jpg' | 'png' | 'gif' | 'webp';
 
 }
 

package/test/Cozy.test.ts

@@ -0,0 +1,27 @@
+import { describe, it, expect } from 'vitest';
+import { Cozy, CozyManifest } from '../src';
+
+import { COLLECTION, WITH_STRUCTURES } from './fixtures';
+
+describe('Cozy', () => {
+
+  it('should parse collection manifests correctly', async () => {
+    const result = await Cozy.parseURL(COLLECTION);
+    expect(result.type).toBe('collection');
+  });
+
+  it('should parse strctures in presentation manifests', async () => {
+    const result = await Cozy.parseURL(WITH_STRUCTURES);
+    expect(result.type).toBe('manifest');
+    expect('resource' in result).toBeTruthy();
+
+    const manifest = (result as any).resource as CozyManifest;
+    expect(manifest.structure.length > 0).toBeTruthy();
+
+    const tableOfContents = manifest.getTableOfContents();
+    expect(tableOfContents.length).toBe(1);
+    expect(tableOfContents[0].children.length).toBe(14);
+  })
+
+});
+

package/test/fixtures.ts

@@ -0,0 +1,5 @@
+export const COLLECTION =
+  'https://www.davidrumsey.com/luna/servlet/iiif/collection/s/1k986a';
+
+export const WITH_STRUCTURES =
+  'https://lib.is/IE19255085/manifest';

package/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    watch: false
+  }
+});