cozy-iiif 0.1.0

package/src/level-0/index.ts

@@ -0,0 +1,2 @@
+export * from './crop-region';
+export * from './get-thumbnail';

package/src/level-0/throttled-loader.ts

@@ -0,0 +1,85 @@
+import pThrottle from 'p-throttle';
+
+interface ThrottleConfig {
+
+  limit: number;
+
+  interval: number;
+
+}
+
+interface ThrottledLoaderOpts {
+
+  callsPerSecond?: number;
+
+}
+
+const createThrottleManager = () => {
+
+  // Default config: 5 calls/second
+  let config: ThrottleConfig = {
+    limit: 5,
+    interval: 1000
+  };
+  
+  let instance = pThrottle(config);
+
+  const getInstance = () => instance;
+
+  const setConfig = (updated: Partial<ThrottleConfig>) => {
+    config = {...config, ...updated };
+    instance = pThrottle(config);
+  }
+
+  const getConfig = () => ({ ...config });
+
+  return {
+    getInstance,
+    getConfig,
+    setConfig
+  };
+
+}
+
+// Singleton instance
+const throttleManager = createThrottleManager();
+
+const updateThrottleConfig = (opts?: Partial<ThrottleConfig>) => {
+  if (!opts) return;
+
+  const current = throttleManager.getConfig();
+
+  if (
+    (opts.limit && opts.limit !== current.limit) ||
+    (opts.interval && opts.interval !== current.interval)
+  ) {
+    console.log('updating throttle config!');
+    throttleManager.setConfig({ ...current, ...opts });
+  }
+}
+
+export const getThrottledLoader = (
+  opts?: ThrottledLoaderOpts
+) => {
+  if (opts) {
+    const throttleOpts = {
+      limit: opts.callsPerSecond || 5,
+      interval: 1000
+    }
+
+    updateThrottleConfig(throttleOpts);
+  }
+
+  const throttle = throttleManager.getInstance();
+
+  const loadImage = throttle((url: string) => new Promise<HTMLImageElement>((resolve, reject) => {
+    const img = new Image();
+    img.crossOrigin = 'anonymous';
+    img.onload = () => resolve(img);
+    img.onerror = reject;
+    img.src = url;
+  }));
+
+  return { loadImage };
+
+}

package/src/level-0/types.ts

@@ -0,0 +1,37 @@
+export interface ImageInfo {
+
+  id: string;
+  
+  width: number;
+  
+  height: number;
+  
+  tiles: TileInfo[];
+
+}
+
+export type Size = { width: number; height: number; };
+
+export interface TileInfo {
+
+  width: number;
+
+  height?: number;
+
+  scaleFactors: number[];
+
+}
+
+export interface Tile {
+
+  x: number;
+
+  y: number;
+
+  width: number;
+
+  height: number;
+
+  url: string;
+
+}

package/src/types.ts

@@ -0,0 +1,137 @@
+import type { Manifest, Canvas, ImageService2, ImageService3, IIIFExternalWebResource } from '@iiif/presentation-3';
+
+export type CozyParseResult = 
+  | { type: 'manifest'; url: string, resource: CozyManifest }
+  | { type: 'iiif-image'; url: string, resource: CozyImageResource }
+  | { type: 'plain-image'; url: string }
+  | { type: 'webpage'; url: string }
+  | { 
+      type: 'error';
+      code: 'INVALID_URL' | 'INVALID_HTTP_RESPONSE' | 'FETCH_ERROR' | 'INVALID_MANIFEST' | 'UNSUPPORTED_FORMAT';
+      message: string;
+    };
+
+export interface CozyManifest {
+
+  readonly majorVersion: number;
+
+  readonly source: Manifest;
+
+  readonly id: string;
+
+  readonly canvases: CozyCanvas[];
+
+  getLabel(locale?: string): string;
+
+  getMetadata(locale?: string): CozyMetadata[];
+
+}
+
+export interface CozyCanvas {
+
+  readonly source: Canvas;
+
+  readonly id: string;
+
+  readonly width: number;
+
+  readonly height: number;
+
+  readonly images: CozyImageResource[];
+
+  getLabel(locale?: string): string;
+
+  getMetadata(locale?: string): CozyMetadata[];
+
+  getThumbnailURL(minSize?: number): string;
+
+}
+
+export interface CozyMetadata {
+
+  label: string;
+
+  value: string;
+
+}
+
+export type CozyImageResource = 
+  | StaticImageResource 
+  | ImageServiceResource;
+
+export type ImageServiceResource =
+  | DynamicImageServiceResource
+  | Level0ImageServiceResource;
+
+interface BaseImageResource {
+
+  readonly source: IIIFExternalWebResource;
+
+  type: 'static' | 'dynamic' | 'level0';
+
+  width: number;
+
+  height: number;
+
+}
+
+export interface StaticImageResource extends BaseImageResource {
+
+  type: 'static';
+
+  url: string;
+
+}
+
+export interface DynamicImageServiceResource extends BaseImageResource {
+
+  type: 'dynamic';
+
+  service: ImageService2 | ImageService3;
+
+  serviceUrl: string;
+
+  majorVersion: number;
+
+  getRegionURL(bounds: Bounds, minSize?: number): string;
+
+}
+
+export interface Level0ImageServiceResource extends BaseImageResource {
+
+  type: 'level0';
+
+  majorVersion: number;
+
+  service: ImageService2 | ImageService3;
+
+  serviceUrl: string;
+
+}
+
+
+export interface ImageRequestOptions {
+
+  width?: number;
+
+  height?: number;
+
+  region?: 'full' | 'square' | { x: number; y: number; width: number; height: number };
+
+  quality?: 'default' | 'color' | 'gray' | 'bitonal';
+
+  format?: 'jpg' | 'png' | 'gif' | 'webp';
+
+}
+
+export interface Bounds {
+
+  x: number;
+
+  y: number;
+
+  w: number;
+
+  h: number;
+
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": ".",
+    "isolatedModules": true,
+    "lib": ["ES2021", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "noEmit": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "target": "ES6",
+    "useDefineForClassFields": true
+  },
+  "include": ["src"]
+}

package/vite.config.ts

@@ -0,0 +1,21 @@
+import { defineConfig } from 'vite';
+import { resolve } from 'path';
+import dts from 'vite-plugin-dts';
+
+export default defineConfig({
+  plugins: [dts()],
+  build: {
+    lib: {
+      entry: {
+        'index': resolve(__dirname, 'src/index.ts'),
+        'level-0/index': resolve(__dirname, 'src/level-0/index.ts'),
+      },
+      formats: ['es']
+    },
+    rollupOptions: {
+      output: {
+        preserveModules: true
+      }
+    }
+  }
+});