@iiif/presentation-3 v2.2.2

IIIF Presentation 3 types

A set of types that describe the format of the IIIF Presentation 3.0 specification as accurately as possible.

Installation:

$ npm i @iiif/presentation-3

Installation (yarn):

$ yarn add @iiif/presentation-3

Usage (Typescript):

import { Manifest } from '@iiif/presentation-3';

const manifest = getManifestFromSomewhere() as Manifest;

function doSomethingWithManifest(manifest: Manifest) {
  // ...
}

Usage (Javascript):

/**
 * @typedef { import("@iiif/presentation-3").Manifest } Manifest
 */

/**
 * @type {Manifest}
 */
const manifest = {};


/**
 * @param manifest {Manifest}
 */
function doSomethingWithManifest(manifest) {
  console.log(manifest.label);
}

// You can also inline the import:

/**
 * @type {import("@iiif/presentation-3").Manifest}
 */
const manifest2 = {};

This will enable types completions in VSCode and IDEA, along with inline documentation from the IIIF specification:

Support

The following types are supported:

• Manifest
• Collection
• Canvas
• Annotation
• Annotation Collection
• Annotation Page
• Content Resource
• Provider
• Range
• Service

With some other types that aim to cover common services:

• Auth service
• GeoJSON service
• Image service
• Search service

Full List of types

Basic types

Resources

Resource items (structural)

Services

W3C Annotations

Most of these types are not exported, but internally follows the full W3C specification.

W3C Model Specification

Normalized resources

The normalized types have moved to @iiif/presentation-3-normalized.

Partial / Abstract types

These types are building blocks of other types.

Helpers