sgauthier
6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
439 lines
17 KiB
JavaScript
439 lines
17 KiB
JavaScript
/**
|
|
* @module ol/format/IIIFInfo
|
|
*/
|
|
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
|
|
if (ar || !(i in from)) {
|
|
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
|
|
ar[i] = from[i];
|
|
}
|
|
}
|
|
return to.concat(ar || Array.prototype.slice.call(from));
|
|
};
|
|
import { assert } from '../asserts.js';
|
|
import { includes } from '../array.js';
|
|
/**
|
|
* @typedef {Object} PreferredOptions
|
|
* @property {string} [format] Preferred image format. Will be used if the image information
|
|
* indicates support for that format.
|
|
* @property {string} [quality] IIIF image qualitiy. Will be used if the image information
|
|
* indicates support for that quality.
|
|
*/
|
|
/**
|
|
* @typedef {Object} SupportedFeatures
|
|
* @property {Array<string>} [supports] Supported IIIF image size and region
|
|
* calculation features.
|
|
* @property {Array<string>} [formats] Supported image formats.
|
|
* @property {Array<string>} [qualities] Supported IIIF image qualities.
|
|
*/
|
|
/**
|
|
* @typedef {Object} TileInfo
|
|
* @property {Array<number>} scaleFactors Supported resolution scaling factors.
|
|
* @property {number} width Tile width in pixels.
|
|
* @property {number} [height] Tile height in pixels. Same as tile width if height is
|
|
* not given.
|
|
*/
|
|
/**
|
|
* @typedef {Object} IiifProfile
|
|
* @property {Array<string>} [formats] Supported image formats for the image service.
|
|
* @property {Array<string>} [qualities] Supported IIIF image qualities.
|
|
* @property {Array<string>} [supports] Supported features.
|
|
* @property {number} [maxArea] Maximum area (pixels) available for this image service.
|
|
* @property {number} [maxHeight] Maximum height.
|
|
* @property {number} [maxWidth] Maximum width.
|
|
*/
|
|
/**
|
|
* @typedef {Object<string,string|number|Array<number|string|IiifProfile|Object<string, number>|TileInfo>>}
|
|
* ImageInformationResponse
|
|
*/
|
|
/**
|
|
* Enum representing the major IIIF Image API versions
|
|
* @enum {string}
|
|
*/
|
|
export var Versions = {
|
|
VERSION1: 'version1',
|
|
VERSION2: 'version2',
|
|
VERSION3: 'version3',
|
|
};
|
|
/**
|
|
* Supported image formats, qualities and supported region / size calculation features
|
|
* for different image API versions and compliance levels
|
|
* @const
|
|
* @type {Object<string, Object<string, SupportedFeatures>>}
|
|
*/
|
|
var IIIF_PROFILE_VALUES = {};
|
|
IIIF_PROFILE_VALUES[Versions.VERSION1] = {
|
|
'level0': {
|
|
supports: [],
|
|
formats: [],
|
|
qualities: ['native'],
|
|
},
|
|
'level1': {
|
|
supports: ['regionByPx', 'sizeByW', 'sizeByH', 'sizeByPct'],
|
|
formats: ['jpg'],
|
|
qualities: ['native'],
|
|
},
|
|
'level2': {
|
|
supports: [
|
|
'regionByPx',
|
|
'regionByPct',
|
|
'sizeByW',
|
|
'sizeByH',
|
|
'sizeByPct',
|
|
'sizeByConfinedWh',
|
|
'sizeByWh',
|
|
],
|
|
formats: ['jpg', 'png'],
|
|
qualities: ['native', 'color', 'grey', 'bitonal'],
|
|
},
|
|
};
|
|
IIIF_PROFILE_VALUES[Versions.VERSION2] = {
|
|
'level0': {
|
|
supports: [],
|
|
formats: ['jpg'],
|
|
qualities: ['default'],
|
|
},
|
|
'level1': {
|
|
supports: ['regionByPx', 'sizeByW', 'sizeByH', 'sizeByPct'],
|
|
formats: ['jpg'],
|
|
qualities: ['default'],
|
|
},
|
|
'level2': {
|
|
supports: [
|
|
'regionByPx',
|
|
'regionByPct',
|
|
'sizeByW',
|
|
'sizeByH',
|
|
'sizeByPct',
|
|
'sizeByConfinedWh',
|
|
'sizeByDistortedWh',
|
|
'sizeByWh',
|
|
],
|
|
formats: ['jpg', 'png'],
|
|
qualities: ['default', 'bitonal'],
|
|
},
|
|
};
|
|
IIIF_PROFILE_VALUES[Versions.VERSION3] = {
|
|
'level0': {
|
|
supports: [],
|
|
formats: ['jpg'],
|
|
qualities: ['default'],
|
|
},
|
|
'level1': {
|
|
supports: ['regionByPx', 'regionSquare', 'sizeByW', 'sizeByH', 'sizeByWh'],
|
|
formats: ['jpg'],
|
|
qualities: ['default'],
|
|
},
|
|
'level2': {
|
|
supports: [
|
|
'regionByPx',
|
|
'regionSquare',
|
|
'regionByPct',
|
|
'sizeByW',
|
|
'sizeByH',
|
|
'sizeByPct',
|
|
'sizeByConfinedWh',
|
|
'sizeByWh',
|
|
],
|
|
formats: ['jpg', 'png'],
|
|
qualities: ['default'],
|
|
},
|
|
};
|
|
IIIF_PROFILE_VALUES['none'] = {
|
|
'none': {
|
|
supports: [],
|
|
formats: [],
|
|
qualities: [],
|
|
},
|
|
};
|
|
var COMPLIANCE_VERSION1 = /^https?:\/\/library\.stanford\.edu\/iiif\/image-api\/(?:1\.1\/)?compliance\.html#level[0-2]$/;
|
|
var COMPLIANCE_VERSION2 = /^https?:\/\/iiif\.io\/api\/image\/2\/level[0-2](?:\.json)?$/;
|
|
var COMPLIANCE_VERSION3 = /(^https?:\/\/iiif\.io\/api\/image\/3\/level[0-2](?:\.json)?$)|(^level[0-2]$)/;
|
|
function generateVersion1Options(iiifInfo) {
|
|
var levelProfile = iiifInfo.getComplianceLevelSupportedFeatures();
|
|
// Version 1.0 and 1.1 do not require a profile.
|
|
if (levelProfile === undefined) {
|
|
levelProfile = IIIF_PROFILE_VALUES[Versions.VERSION1]['level0'];
|
|
}
|
|
return {
|
|
url: iiifInfo.imageInfo['@id'] === undefined
|
|
? undefined
|
|
: iiifInfo.imageInfo['@id'].replace(/\/?(?:info\.json)?$/g, ''),
|
|
supports: levelProfile.supports,
|
|
formats: __spreadArray(__spreadArray([], levelProfile.formats, true), [
|
|
iiifInfo.imageInfo.formats === undefined
|
|
? []
|
|
: iiifInfo.imageInfo.formats,
|
|
], false),
|
|
qualities: __spreadArray(__spreadArray([], levelProfile.qualities, true), [
|
|
iiifInfo.imageInfo.qualities === undefined
|
|
? []
|
|
: iiifInfo.imageInfo.qualities,
|
|
], false),
|
|
resolutions: iiifInfo.imageInfo.scale_factors,
|
|
tileSize: iiifInfo.imageInfo.tile_width !== undefined
|
|
? iiifInfo.imageInfo.tile_height !== undefined
|
|
? [iiifInfo.imageInfo.tile_width, iiifInfo.imageInfo.tile_height]
|
|
: [iiifInfo.imageInfo.tile_width, iiifInfo.imageInfo.tile_width]
|
|
: iiifInfo.imageInfo.tile_height != undefined
|
|
? [iiifInfo.imageInfo.tile_height, iiifInfo.imageInfo.tile_height]
|
|
: undefined,
|
|
};
|
|
}
|
|
function generateVersion2Options(iiifInfo) {
|
|
var levelProfile = iiifInfo.getComplianceLevelSupportedFeatures(), additionalProfile = Array.isArray(iiifInfo.imageInfo.profile) &&
|
|
iiifInfo.imageInfo.profile.length > 1, profileSupports = additionalProfile && iiifInfo.imageInfo.profile[1].supports
|
|
? iiifInfo.imageInfo.profile[1].supports
|
|
: [], profileFormats = additionalProfile && iiifInfo.imageInfo.profile[1].formats
|
|
? iiifInfo.imageInfo.profile[1].formats
|
|
: [], profileQualities = additionalProfile && iiifInfo.imageInfo.profile[1].qualities
|
|
? iiifInfo.imageInfo.profile[1].qualities
|
|
: [];
|
|
return {
|
|
url: iiifInfo.imageInfo['@id'].replace(/\/?(?:info\.json)?$/g, ''),
|
|
sizes: iiifInfo.imageInfo.sizes === undefined
|
|
? undefined
|
|
: iiifInfo.imageInfo.sizes.map(function (size) {
|
|
return [size.width, size.height];
|
|
}),
|
|
tileSize: iiifInfo.imageInfo.tiles === undefined
|
|
? undefined
|
|
: [
|
|
iiifInfo.imageInfo.tiles.map(function (tile) {
|
|
return tile.width;
|
|
})[0],
|
|
iiifInfo.imageInfo.tiles.map(function (tile) {
|
|
return tile.height === undefined ? tile.width : tile.height;
|
|
})[0],
|
|
],
|
|
resolutions: iiifInfo.imageInfo.tiles === undefined
|
|
? undefined
|
|
: iiifInfo.imageInfo.tiles.map(function (tile) {
|
|
return tile.scaleFactors;
|
|
})[0],
|
|
supports: __spreadArray(__spreadArray([], levelProfile.supports, true), profileSupports, true),
|
|
formats: __spreadArray(__spreadArray([], levelProfile.formats, true), profileFormats, true),
|
|
qualities: __spreadArray(__spreadArray([], levelProfile.qualities, true), profileQualities, true),
|
|
};
|
|
}
|
|
function generateVersion3Options(iiifInfo) {
|
|
var levelProfile = iiifInfo.getComplianceLevelSupportedFeatures(), formats = iiifInfo.imageInfo.extraFormats === undefined
|
|
? levelProfile.formats
|
|
: __spreadArray(__spreadArray([], levelProfile.formats, true), iiifInfo.imageInfo.extraFormats, true), preferredFormat = iiifInfo.imageInfo.preferredFormats !== undefined &&
|
|
Array.isArray(iiifInfo.imageInfo.preferredFormats) &&
|
|
iiifInfo.imageInfo.preferredFormats.length > 0
|
|
? iiifInfo.imageInfo.preferredFormats
|
|
.filter(function (format) {
|
|
return includes(['jpg', 'png', 'gif'], format);
|
|
})
|
|
.reduce(function (acc, format) {
|
|
return acc === undefined && includes(formats, format)
|
|
? format
|
|
: acc;
|
|
}, undefined)
|
|
: undefined;
|
|
return {
|
|
url: iiifInfo.imageInfo['id'],
|
|
sizes: iiifInfo.imageInfo.sizes === undefined
|
|
? undefined
|
|
: iiifInfo.imageInfo.sizes.map(function (size) {
|
|
return [size.width, size.height];
|
|
}),
|
|
tileSize: iiifInfo.imageInfo.tiles === undefined
|
|
? undefined
|
|
: [
|
|
iiifInfo.imageInfo.tiles.map(function (tile) {
|
|
return tile.width;
|
|
})[0],
|
|
iiifInfo.imageInfo.tiles.map(function (tile) {
|
|
return tile.height;
|
|
})[0],
|
|
],
|
|
resolutions: iiifInfo.imageInfo.tiles === undefined
|
|
? undefined
|
|
: iiifInfo.imageInfo.tiles.map(function (tile) {
|
|
return tile.scaleFactors;
|
|
})[0],
|
|
supports: iiifInfo.imageInfo.extraFeatures === undefined
|
|
? levelProfile.supports
|
|
: __spreadArray(__spreadArray([], levelProfile.supports, true), iiifInfo.imageInfo.extraFeatures, true),
|
|
formats: formats,
|
|
qualities: iiifInfo.imageInfo.extraQualities === undefined
|
|
? levelProfile.qualities
|
|
: __spreadArray(__spreadArray([], levelProfile.qualities, true), iiifInfo.imageInfo.extraQualities, true),
|
|
preferredFormat: preferredFormat,
|
|
};
|
|
}
|
|
var versionFunctions = {};
|
|
versionFunctions[Versions.VERSION1] = generateVersion1Options;
|
|
versionFunctions[Versions.VERSION2] = generateVersion2Options;
|
|
versionFunctions[Versions.VERSION3] = generateVersion3Options;
|
|
/**
|
|
* @classdesc
|
|
* Format for transforming IIIF Image API image information responses into
|
|
* IIIF tile source ready options
|
|
*
|
|
* @api
|
|
*/
|
|
var IIIFInfo = /** @class */ (function () {
|
|
/**
|
|
* @param {string|ImageInformationResponse} imageInfo
|
|
* Deserialized image information JSON response object or JSON response as string
|
|
*/
|
|
function IIIFInfo(imageInfo) {
|
|
this.setImageInfo(imageInfo);
|
|
}
|
|
/**
|
|
* @param {string|ImageInformationResponse} imageInfo
|
|
* Deserialized image information JSON response object or JSON response as string
|
|
* @api
|
|
*/
|
|
IIIFInfo.prototype.setImageInfo = function (imageInfo) {
|
|
if (typeof imageInfo == 'string') {
|
|
this.imageInfo = JSON.parse(imageInfo);
|
|
}
|
|
else {
|
|
this.imageInfo = imageInfo;
|
|
}
|
|
};
|
|
/**
|
|
* @return {Versions} Major IIIF version.
|
|
* @api
|
|
*/
|
|
IIIFInfo.prototype.getImageApiVersion = function () {
|
|
if (this.imageInfo === undefined) {
|
|
return;
|
|
}
|
|
var context = this.imageInfo['@context'] || 'ol-no-context';
|
|
if (typeof context == 'string') {
|
|
context = [context];
|
|
}
|
|
for (var i = 0; i < context.length; i++) {
|
|
switch (context[i]) {
|
|
case 'http://library.stanford.edu/iiif/image-api/1.1/context.json':
|
|
case 'http://iiif.io/api/image/1/context.json':
|
|
return Versions.VERSION1;
|
|
case 'http://iiif.io/api/image/2/context.json':
|
|
return Versions.VERSION2;
|
|
case 'http://iiif.io/api/image/3/context.json':
|
|
return Versions.VERSION3;
|
|
case 'ol-no-context':
|
|
// Image API 1.0 has no '@context'
|
|
if (this.getComplianceLevelEntryFromProfile(Versions.VERSION1) &&
|
|
this.imageInfo.identifier) {
|
|
return Versions.VERSION1;
|
|
}
|
|
break;
|
|
default:
|
|
}
|
|
}
|
|
assert(false, 61);
|
|
};
|
|
/**
|
|
* @param {Versions} version Optional IIIF image API version
|
|
* @return {string} Compliance level as it appears in the IIIF image information
|
|
* response.
|
|
*/
|
|
IIIFInfo.prototype.getComplianceLevelEntryFromProfile = function (version) {
|
|
if (this.imageInfo === undefined || this.imageInfo.profile === undefined) {
|
|
return;
|
|
}
|
|
if (version === undefined) {
|
|
version = this.getImageApiVersion();
|
|
}
|
|
switch (version) {
|
|
case Versions.VERSION1:
|
|
if (COMPLIANCE_VERSION1.test(this.imageInfo.profile)) {
|
|
return this.imageInfo.profile;
|
|
}
|
|
break;
|
|
case Versions.VERSION3:
|
|
if (COMPLIANCE_VERSION3.test(this.imageInfo.profile)) {
|
|
return this.imageInfo.profile;
|
|
}
|
|
break;
|
|
case Versions.VERSION2:
|
|
if (typeof this.imageInfo.profile === 'string' &&
|
|
COMPLIANCE_VERSION2.test(this.imageInfo.profile)) {
|
|
return this.imageInfo.profile;
|
|
}
|
|
if (Array.isArray(this.imageInfo.profile) &&
|
|
this.imageInfo.profile.length > 0 &&
|
|
typeof this.imageInfo.profile[0] === 'string' &&
|
|
COMPLIANCE_VERSION2.test(this.imageInfo.profile[0])) {
|
|
return this.imageInfo.profile[0];
|
|
}
|
|
break;
|
|
default:
|
|
}
|
|
};
|
|
/**
|
|
* @param {Versions} version Optional IIIF image API version
|
|
* @return {string} Compliance level, on of 'level0', 'level1' or 'level2' or undefined
|
|
*/
|
|
IIIFInfo.prototype.getComplianceLevelFromProfile = function (version) {
|
|
var complianceLevel = this.getComplianceLevelEntryFromProfile(version);
|
|
if (complianceLevel === undefined) {
|
|
return undefined;
|
|
}
|
|
var level = complianceLevel.match(/level[0-2](?:\.json)?$/g);
|
|
return Array.isArray(level) ? level[0].replace('.json', '') : undefined;
|
|
};
|
|
/**
|
|
* @return {SupportedFeatures} Image formats, qualities and region / size calculation
|
|
* methods that are supported by the IIIF service.
|
|
*/
|
|
IIIFInfo.prototype.getComplianceLevelSupportedFeatures = function () {
|
|
if (this.imageInfo === undefined) {
|
|
return;
|
|
}
|
|
var version = this.getImageApiVersion();
|
|
var level = this.getComplianceLevelFromProfile(version);
|
|
if (level === undefined) {
|
|
return IIIF_PROFILE_VALUES['none']['none'];
|
|
}
|
|
return IIIF_PROFILE_VALUES[version][level];
|
|
};
|
|
/**
|
|
* @param {PreferredOptions} [opt_preferredOptions] Optional options for preferred format and quality.
|
|
* @return {import("../source/IIIF.js").Options} IIIF tile source ready constructor options.
|
|
* @api
|
|
*/
|
|
IIIFInfo.prototype.getTileSourceOptions = function (opt_preferredOptions) {
|
|
var options = opt_preferredOptions || {}, version = this.getImageApiVersion();
|
|
if (version === undefined) {
|
|
return;
|
|
}
|
|
var imageOptions = version === undefined ? undefined : versionFunctions[version](this);
|
|
if (imageOptions === undefined) {
|
|
return;
|
|
}
|
|
return {
|
|
url: imageOptions.url,
|
|
version: version,
|
|
size: [this.imageInfo.width, this.imageInfo.height],
|
|
sizes: imageOptions.sizes,
|
|
format: options.format !== undefined &&
|
|
includes(imageOptions.formats, options.format)
|
|
? options.format
|
|
: imageOptions.preferredFormat !== undefined
|
|
? imageOptions.preferredFormat
|
|
: 'jpg',
|
|
supports: imageOptions.supports,
|
|
quality: options.quality && includes(imageOptions.qualities, options.quality)
|
|
? options.quality
|
|
: includes(imageOptions.qualities, 'native')
|
|
? 'native'
|
|
: 'default',
|
|
resolutions: Array.isArray(imageOptions.resolutions)
|
|
? imageOptions.resolutions.sort(function (a, b) {
|
|
return b - a;
|
|
})
|
|
: undefined,
|
|
tileSize: imageOptions.tileSize,
|
|
};
|
|
};
|
|
return IIIFInfo;
|
|
}());
|
|
export default IIIFInfo;
|
|
//# sourceMappingURL=IIIFInfo.js.map
|