IIIF Parser

``
npm i @iiif/parser
`

This is a parser and set of low-level utilities for the following IIIF Specifications:

- IIIF Presentation 3 (current)
- IIIF Image 3 (current)
- IIIF Presentation 2

These include:
- W3C Annotations
- Open Annotations


> [!NOTE]
> A new version of the IIIF Presentation API is being developed (v4) which handles 3D content. This parser will
> support this version soon. You can read about the additions here

$3


`js
import { Traverse } from '@iiif/parser';

// Or for presentation 2 resources
// import { Traverse } from '@iiif/parser/presentation-2';

const ids = [];
const extractCanvasLabels = new Traverse({
canvas: [(canvas) => {
ids.push(canvas.id); // string
}],
});

extractCanvasLabels.traverseUnknown(loadSomeManifest());

console.log(ids); // all canvas ids.
`

#### IIIF Presentation 2
- Traverse utility for walking through IIIF v2 documents and running code at different "types"
- Upgrader utility built on-top of the Traverse utility for upgrading IIIF v2 to IIIF v3.

The intention for IIIF Presentation 2 is to upgrade it to 3 and then work with that. The tooling will always offer and upgrade to the latest version and tools on top of that.

`ts
import { Traverse, convertPresentation2 } from '@iiif/parser/presentation-2';

convertPresentation2(p2); // to latest IIIF version

const logAnnotations = new Traverse({
// Every type is a key on this record, with an array of functions to call
annotation: [
anno => {
console.log(anno['@id']);

// Optionally return to replace the resource.
}
]
});

logAnnotations.traverseManifest(someInputManifest); // Logs all annotation IDs.

// Also an "all" traversal.
const logAllIds = Traverse.all(resource => console.log(resource['@id']));

logAllIds.traverseUnknown(someInput);

`

The available types to traverse (v3) are:
`ts
export type TraversalMap = {
collection?: Array>;
manifest?: Array>;
canvas?: Array>;
annotationCollection?: Array>;
annotationPage?: Array>;
annotation?: Array>;
contentResource?: Array>;
choice?: Array>;
range?: Array>;
service?: Array>;
agent?: Array>;
specificResource?: Array>;
geoJson?: Array>;
};
`

#### Image 3

The Image 3 parser is adapted from an Image Server implementation, and supports:

- Parsing of IIIF Image API request URLs (including info.json)
- Extracting region
- Extracting rotation
- Extracting size
- Extracting quality
- Extracting format
- Parsing of IIIF profiles, and feature detection
- isLevel0(service)
- supports(service, { extraQualities: ['grey'] }) helper which accepts a service and partial service to compare
- imageServiceSupportsRequest() helper that can validate IIIF image requests before you make them
- Serializing of IIIF Image requests
- A custom structure for defining region, size, quality etc. and then creating a IIIF Image request URL.
- Support for Image 2.1 servers
- Handful of utilities for IIIF Image 3
- extracting fixes sized images from an image service
- extracting fixed sizes from scale factors (full tiles)
- canonicalServiceUrl(), getId(), getType() and isImageService() for compatibility and validation

`ts
import { parseImageServiceRequest, imageServiceRequestInfo } from '@iiif/parser/image-3';
import { ImageService } from '@iiif/presentation-3';

const parsed = parseImageServiceRequest(
'https://munch.emuseum.com/apis/iiif/image/v2/17261/full/max/0/default.jpg',
// Optionally provide a path, so the identifier can be extracted
'apis/iiif/image/v2'
);

// {
// "format": "jpg",
// "identifier": "17261",
// "originalPath": "/17261/full/max/0/default.jpg",
// "prefix": "apis/iiif/image/v2",
// "quality": "default",
// "region": {
// "full": true,
// },
// "rotation": {
// "angle": 0,
// },
// "scheme": "https",
// "server": "munch.emuseum.com",
// "size": {
// "confined": false,
// "max": true,
// "serialiseAsFull": false,
// "upscaled": false,
// },
// "type": "image",
// }

// Can be changed.
parsed.rotation.angle = 90;

const imageUrl = imageServiceRequestToString(parsed);
// https://munch.emuseum.com/apis/iiif/image/v2/17261/full/max/90/default.jpg

const infoJson = imageServiceRequestInfo(parsed);
// https://munch.emuseum.com/apis/iiif/image/v2/17261/info.json


const imageService: ImageService = await fetch(infoJson).then(r => r.json());

// Likely true - as its supported by level0, level1 and level2
const supportsSizes = supports(imageService, {
extraFeatures: ['sizeByWhListed']
});
`

$3

Upgrades IIIF JSON to the latest IIIF Presentation version (current: 3).

`ts
import { upgrade } from '@iiif/parser/upgrader';

upgrade(presentation2Manifest); // Presentation 3 Manifest or Collection
``