Versioning

This document outlines the versioning strategy used by the PDF Web Viewer library.

Semantic Versioning

The PDF Web Viewer follows Semantic Versioning 2.0.0. This means that version numbers are formatted as MAJOR.MINOR.PATCH:

• MAJOR version increments indicate incompatible API changes
• MINOR version increments add functionality in a backward-compatible manner
• PATCH version increments make backward-compatible bug fixes

Version Compatibility

When upgrading your PDF Web Viewer dependency, you can expect:

• Safe to upgrade: Patch and minor version updates (e.g., 1.0.0 → 1.0.1 or 1.0.0 → 1.1.0)
• Careful review required: Major version updates (e.g., 1.0.0 → 2.0.0)

Release Cycle

The PDF Web Viewer typically follows these release practices:

• Patch releases: As needed for bug fixes and performance improvements
• Minor releases: Regular feature additions (approximately monthly)
• Major releases: Less frequent, with advance notice for breaking changes

Changelog

All notable changes to the PDF Web Viewer are documented in the repository. Each release includes:

• New features
• Bug fixes
• Performance improvements
• Breaking changes (with migration instructions)

Asset Versioning

Static assets used by the PDF Web Viewer (such as worker scripts and WebAssembly files) include hash-based versioning in their filenames to ensure proper cache invalidation when updated.

Version Checking

You can check the current version of the PDF Web Viewer at runtime:

import { version } from '@avanquest/pdf-web-viewer';

console.log(`Using PDF Web Viewer version: ${version}`);
Copy

Deprecation Policy

Features marked as deprecated will:

1. Continue to work for at least one major version after deprecation
2. Include warning messages in the console
3. Have documentation with migration instructions

Long-Term Support (LTS)

Major versions may receive extended support for critical security fixes. For enterprise support options and SLAs, please contact the sales team.