Skip to content

Releases: avalynx/avalynx-ref

1.0.2

25 Feb 10:12
206eb8e

Choose a tag to compare

Release 1.0.2 – Changelog Summary

Version 1.0.2 focuses on reliability and maintainability: it adds a full CI + coverage pipeline, locks dependencies for reproducible installs, and improves packaging/documentation consistency. These changes help consumers trust the release and make contributing safer.

  • CI Testing & Codecov Integration
    Added a GitHub Actions workflow to run tests on Node.js 20 and upload coverage reports to Codecov.
    Provides continuous validation so regressions are caught early.

  • Coverage Enforcement via Jest
    Enabled coverage collection/reporting and introduced strict global coverage thresholds (100%).
    Helps keep the library stable and well-tested as it evolves.

  • Dependency Locking for Reproducible Builds
    Added package-lock.json and updated .gitignore to ignore coverage output while keeping dependencies trackable.
    Ensures consistent installs across machines and CI environments.

  • Packaging Compatibility (CommonJS Export Guard)
    Improved module.exports handling and annotated it with /* istanbul ignore next */.
    Strengthens compatibility with CommonJS consumers without impacting coverage results.

  • Documentation & Version Alignment
    Updated all version references to 1.0.2, refreshed README content, and added a German README translation.
    Makes adoption clearer and reduces confusion across distribution channels and examples.

  • Example Updates for Local Development
    Switched the example to load the local source file instead of a pinned CDN version.
    Simplifies local testing and development against the repository code.

Compatibility: Backward compatible


Full Changelog: 1.0.1...1.0.2

1.0.1

10 Oct 12:46
372fdbd

Choose a tag to compare

Release 1.0.1 – Changelog Summary

This patch strengthens robustness and ecosystem compatibility: safer option handling, fuller test coverage, and broader module support. It also modernizes the dev environment (Docker, Node, Yarn) and tidies docs/CDN links.

  • Version Bump & CDN Updates
    README, examples, and dist now reference @1.0.1.
    Ensures developers load the intended stable assets.

  • Safer Defaults for Options
    Guards against null or non-object options during construction.
    Prevents runtime errors and makes usage more forgiving.

  • CommonJS Export Support
    Added conditional module.exports in both ESM and UMD builds.
    Enables seamless use with Jest/Node and mixed module ecosystems.

  • Bootstrap Import in ESM Build
    ESM bundle now imports Bootstrap explicitly.
    Avoids “missing Bootstrap” issues when consumed via modern bundlers.

  • Expanded Jest Test Suite
    Hundreds of new tests covering selectors, value updates, batching via requestAnimationFrame, HTML/text modes, and edge cases.
    Increases reliability and confidence in production.

  • Build Process Refinements
    Build script adjusted to generate clean ESM output and align with module export strategy.
    Results in consistent artifacts across environments.

  • Modernized Docker Image
    Dockerfile updated to PHP 8.3 and adds Node 18 + Yarn.
    Improves local dev parity with current stacks.

  • Repository Hygiene
    .gitignore now excludes ai.txt.
    Keeps the repo clean and avoids accidental commits.

Compatibility: Backward compatible


Full Changelog: 1.0.0...1.0.1

1.0.0

05 Jun 20:32
7bec9c0

Choose a tag to compare

Release 1.0.0 – Changelog Summary

This release marks the first stable version of AvalynxRef, focused on improving integration options, refining documentation, and ensuring compatibility with modern asset management workflows such as Symfony’s AssetComposer. It also finalizes distribution consistency across examples and CDN references.

  • Stable 1.0.0 Release
    Version bump to 1.0.0 across all files and assets.
    Establishes a stable foundation for production environments.

  • Symfony AssetComposer Support
    Added installation and usage examples for Symfony’s AssetComposer.
    Simplifies integration in Symfony-based projects with managed asset pipelines.

  • Updated CDN References
    README and examples now use pinned jsDelivr links for @1.0.0.
    Guarantees correct and predictable asset loading for developers.

  • Improved Documentation
    Expanded README with clear installation paths (NPM, Composer, AssetComposer).
    Enhances accessibility for users in different ecosystems.

  • Changelog Cleanup
    Removed outdated CHANGELOG.md to streamline maintenance and avoid duplication.
    Keeps the repository concise and current.

  • Distribution Consistency
    Updated headers in all source and dist files to reflect the correct version and metadata.
    Ensures accurate attribution and better version tracking.

Compatibility: Backward compatible


Full Changelog: 0.0.4...1.0.0

0.0.4

07 Mar 23:11
0bbf685

Choose a tag to compare

Release 0.0.4 – Changelog Summary

This release refines AvalynxRef’s build and packaging workflow, improves documentation consistency, and adds support for asset management through assetscomposer.json. It focuses on cleaner distribution, automated builds, and dependency hygiene.

  • New Build Process Added
    Introduced a build.js script and npm build command for generating both ESM and JS distributions automatically.
    Simplifies publishing and ensures consistent artifact output.

  • Clean Build Pipeline
    The build process now clears the dist directory before regenerating files.
    Prevents stale or mismatched files from previous builds.

  • Added assetscomposer.json
    Introduces a new configuration file listing production and development JS assets.
    Streamlines integration with Symfony’s AssetComposer and similar asset managers.

  • Updated Package Metadata
    Fixed repository URLs, normalized author formatting, and improved description accuracy.
    Provides cleaner npm and GitHub project presentation.

  • NPM Fix & Dependency Updates
    Addressed minor npm publication issues and added shelljs/shx for build scripting.
    Enhances cross-platform build reliability.

  • Improved Documentation and Headers
    Unified class and file docstrings with a clearer project description for all JS sources.
    Ensures developer clarity and better API documentation.

  • Dependabot Maintenance
    Security update applied for ws (v8.17.1).
    Keeps dependencies secure and up to date.

  • Minor Cleanup and Housekeeping
    .gitignore and CHANGELOG.md updated, redundant files like package-lock.json removed.
    Keeps repository lean and easier to maintain.

Compatibility: Backward compatible


Full Changelog: 0.0.3...0.0.4

0.0.3

30 May 11:36
8f965c5

Choose a tag to compare

Release 0.0.3 – Changelog Summary

This release polishes docs, improves distribution options, and clarifies API usage. It also adds Composer support and updates examples/CDN links so you can integrate AvalynxRef more easily across environments.

  • Version Bump to 0.0.3
    All source and dist headers now reflect 0.0.3.
    Ensures consistency across builds and artifacts.

  • Docs & README Enhancements
    Clearer install instructions, corrected descriptions, and added quick links (jsDelivr, npm, Packagist).
    Speeds up onboarding and reduces setup friction.

  • Pinned CDN Usage
    Examples now use jsDelivr with a pinned @0.0.3 path.
    Guarantees you load the intended stable version.

  • Composer Support Added
    New composer.json enables installation via Packagist.
    Makes PHP/Symfony projects adopt AvalynxRef with familiar tooling.

  • NPM & Package Metadata Cleanup
    Fixed package description and aligned metadata in package.json.
    Improves discoverability and accuracy on npm.

  • API JSDoc Clarifications
    Parameter docs now specify types, defaults, and semantics (e.g., isHtml handling).
    Reduces ambiguity and improves IDE intellisense.

  • Example Updates
    Demo pages switched to CDN-hosted builds for copy-paste simplicity.
    Helps users validate quickly without a build step.

  • Docker Compose Tidy-Up
    Minor YAML cleanups (version header removal, newline fix).
    Keeps dev environment configuration lean and compatible.

Compatibility: Backward compatible


Full Changelog: 0.0.2...0.0.3

0.0.2

27 May 19:15
fc4ce30

Choose a tag to compare