Changelog

All notable changes to the Heap.js 5 library will be documented in this file.

To check which version you are using, follow these instructions.

The format is based on Keep a Changelog and this project adheres to
Semantic Versioning.

[5.2.6] - 2025-01-02

Added

• Aborts Heap initialization if storage is not accessible (Likely due to browser settings)
• Support for enabling cookie compression via server side config

Changed

• Update telemetry endpoint to https://heapanalytics.com so no CSP update is required
• Updates timing of request triggers in Contentsquare integration
• Prevents requests from being sent in hidden tabs

Fixed

• Creates new user and session if necessary when heap.trackPageview() is called

[5.2.5] - 2024-12-16

Changed

• Updates retry logic to not automatically retry a 5xx
• Removed check for a blank Contentsquare tag and avoid waiting for metadata/initiating if necessary

Added

• Implement telemetry

Fixed

• Bug fix for version 5.2.4

[5.2.4] - 2024-11-21

Added

• Support for 1:N mappings between with Contentsquare
• Fallback session time in v4 → v5 migration
• Check for a blank Contentsquare tag and avoid waiting for metadata/initiating if necessary
• Validate session info in track messages + remove from retry buffer if invalid

Changed

• Skip blocking transformer if Contentsquare has already been initialized
• Clean info level logs
• Creates new session if session time is invalid

[5.2.3] - 2024-11-11

Added

• Additional logging
• Error handling on shadowdom autocapture implementation

Changed

• Block identify calls until metadata has been sent to network
• Update method to wait for metadata from Contentsquare in Contentsquare integration

Fixed

• Execution time of onReady queue in Contentsquare integration
• Block event processing queue until metadata is queued in Contentsquare integration
• Bug fix in version reporting on heap.getConfig().sdk when self-hosting

[5.2.2] - 2024-10-30

Added

• New config option compressCookies to enable cookie compression (disabled by default)

Fixed

• Bug fix on heap.identify where identify request was not being sent if current identity matched passed identity

[5.2.1] - 2024-10-23

Added

• heap.identifyHashed

Fixed

• Bug fix on internal setReferrer
• Integration mismatch

Changed

• Improved random ID generator

[5.2.0] - 2024-09-23

Added

• User/session sync between mobile and webviews
• queueCustomEvent dependency for use in adapters

[5.1.4] - 2024-09-09

Added

• Validation to network requests

Fixed

• Bug fix on cross domain iFrames causing session spike

Changed

• Move execution of onReady queue after metadata is stored

[5.1.3] - 2024-08-28

Added

• cs_crosswrites_heap to HeapTagStatus
• Verify userId is available on addUserProperties calls

Changed

• Lower time to flush buffer for INP
• Replace deprecated mutation events

Fixed

• Bug fix on heap.setLogLevel()

[5.1.2] - 2024-08-12

Fixed

• Lodash conflict
• Update rage click PointerEvent vs MouseEvent

Added

• Capture library_version and library_domain on requests

[5.1.1] - 2024-07-29

Fixed

• Missing envId when Heap is loaded twice

Added

• Support Contentsquare as a client side source

[5.1.0] - 2024-07-12

Added

• Handle session + pageview behavior when identify is called in Contentsquare tag
• Block heap driving logic on heap env on Contentsquare domain
• Set content-type=application/javascript; charset=utf-8 in heap.js headers
• Add Contentsquare project id to hjs config

[5.0.0] - 2024-06-25

Fixed

• Updated release version to 5.0.0

[1.0.0] - 2024-06-18

Fixed

• cmd+click not working as expected

Added

• Increase retry logic to 7 days
• Updated integrations to use public addPageviewProperties API instead of internal