Skip to content

CHANGELOG.md

Latest commit

 

History

History
110 lines (78 loc) · 4.27 KB

CHANGELOG.md

File metadata and controls

110 lines (78 loc) · 4.27 KB

Change Log

Only features and major fixes are listed. Everything else can be considered a minor bugfix or maintenance release.

v8.0.0
  • BREAKING CHANGE: DimensionFunction has been replaced with GeometryFunction, changing both the option name and the shape of the expected return value
  • Can now probe the image stream for tile size information
  • Information document (info.json) is now rendered using tile size information from the image (or from the GeometryFunction), falling back to a default of 256
v7.0.0
  • Made entire suite able to pass the IIIF Image API Validator
  • Added automatic redirect for requests that don't specify a transformation or info.json
  • Added return types for redirect and error as well as content, eliminating most situations in which IIIFError was thrown
  • Improved test suite
  • Added validator to test suite
v6.1.1
  • Auto-orient images based on EXIF orientation before transforming
v6.0.0
  • Complete refactor of entire library into TypeScript
  • StreamResolver is now Promise-only: the single-argument resolver must return a Promise<ReadableStream>; update examples and tests accordingly.
  • Deprecate the 2-argument callback resolver form; it continues to work for now but will be removed in a future major version. Prefer the promise-based resolver.
  • Add strict typecheck scripts and internal TypeScript type contracts to reduce any usage.
  • Improve TypeScript style and CI workflows [blimmer]
v5.2.0
  • Refactor pipeline creation to simplify scaling
  • Add Clover IIIF manifest viewer and sample manifest/images to tiny-iiif example
v5.1.0
  • Update pathPrefix constructor option to accept a {{version}} placeholder and RegExp elements (default: /iiif/{{version}}/)
v5.0.0
  • Export Calculator
  • Make sharp an optional dependency for those who just want to use Calculator
v4.0.0
  • Add support for IIIF Image API v3.0.0 alongside support for v2.1.1
  • Add canonicalLink and profileLink properties to the response to support the respective link header features (see example of how to use this)
  • Add version to IIIF.Processor constructor options
  • [BREAKING CHANGE] The maxWidth option was changed to max: { width, height, area } in order to support the IIIF maxHeight and maxArea constraints
v3.2.0
  • Major refactor to support multi-resolution source images
  • Backward-compatible overhaul of dimensionFunction
  • Split Calculator out from Operations to make certain pre-transform information available with low overhead
  • Use sharp.metadata() instead of probe-image-size in default dimension function
v3.1.0
  • Support dimension probing for JPEG 2000 images
v3.0.0
  • Add pathPrefix option (default: /iiif/2/) to constructor instead of popping a specific number of path segments off of the end of the URL
v2.0.0

  • [BREAKING CHANGE] The id parameter passed to the stream resolver and dimensions callback was changed from a string to an object containing the id and baseUrl.

    To maintain the existing behavior, you can use destructuring of the argument. For example:

    streamResolver(id) { }               // old
streamResolver(id, callback) { }     // old
streamResolver({ id }) { }           // new
streamResolver({ id }, callback) { } // new

dimensionFunction(id) { }            // old
dimensionFunction({ id }) { }        // new

    See issue #19 for context on why this change was made.

  • Use a consistent name for dimensions function in README.md

v1.0.0
  • Add pixel density option
  • Improve documentation
  • Full test coverage
v0.3.6
  • Allow transformation to include existing metadata
v0.3.5
  • Allow .tiff and .webp requests
  • Accept .tif and .jpeg
v0.3.0
  • Add optional dimension function and maxWidth parameter to initializer
v0.2.0
  • Initial release

Contributors