@newrelic/video-core 3.0.1

package/CHANGELOG.md

@@ -0,0 +1,362 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [3.0.1] - 2025-05-14
+
+### Enhancements
+
+* **Publishing to npm:** The package can now be published to npm, making it easily accessible.
+
+### Build
+
+* **Distribution Formats:** Added `cjs`, `esm`, and `umd` builds to the `dist` folder, ensuring compatibility with CommonJS, ES Modules, and UMD module formats.
+
+## [3.0.0] - 2025/02/20
+
+### New Event Type Introduced [VideoAction, VideoErrorAction, VideoAdAction, VideoCustomAction]
+
+- PageAction Deprecated.
+- New Attributes Introduced.
+- The `recordCustomEvent` function is used to send data.
+
+## [0.32.4] - 2024/05/08
+
+### Fix
+
+- Fix `isAd` attribute value in `sendError`.
+
+## [0.32.3] - 2023/09/08
+
+### Fix
+
+- Fix issue in `tracker.customData.deviceType`.
+
+## [0.32.2] - 2021/04/27
+
+### Update
+
+- Improve `totalAdPlaytime`.
+
+## [0.32.1] - 2021/04/26
+
+### Fix
+
+- Only put `totalAdPlaytime` on START.
+
+## [0.32.0] - 2021/04/26
+
+### Add
+
+- Attribute `totalAdPlaytime`.
+
+## [0.31.0] - 2021/02/08
+
+### Add
+
+- Function `state.removeTimeSinceAttribute(...)`, to remove a custom timeSince attribute.
+
+## [0.30.0] - 2020/11/18
+
+### Fix
+
+- Reset `totalPlaytime` after an END.
+
+## [0.29.0] - 2020/11/11
+
+### Add
+
+- Attribute `timeSinceSeekEnd` to BUFFER events.
+
+## [0.28.0] - 2020/10/23
+
+### Fix
+
+- Initial bufferType when video is a live stream.
+
+## [0.27.0] - 2020/10/20
+
+### Fix
+
+- Increment time margin for initial `bufferType`.
+
+## [0.26.0] - 2020/10/08
+
+### Fix
+
+- When buffering happens before START, BUFFER events not being sent.
+
+## [0.25.0] - 2020/10/02
+
+### Add
+
+- Attribute `isBackgroundEvent` to indicate when an event happend during the browser tab is in background.
+
+## [0.24.0] - 2020/10/01
+
+### Fix
+
+- Report `bufferType` as "pause" when it happens right after a RESUME event.
+
+## [0.23.0] - 2020/09/29
+
+### Add
+
+- Method `sendCustom` to send a custom action with a timeSince attribute.
+
+## [0.22.0] - 2020/09/01
+
+### Fix
+
+- Use the same `bufferType` value for both BUFFER events.
+
+## [0.21.0] - 2020/08/13
+
+### Add
+
+- Call `trackerInit` method when a tracker is added.
+
+## [0.20.0] - 2020/08/11
+
+### Add
+
+- `bufferType` attribute to all BUFFER events.
+- `timeSinceResumed` attribute to all BUFFER events.
+
+## [0.19.0] - 2020/06/15
+
+### Fix
+
+- `isInitialBuffering` attribute.
+
+## [0.18.0] - 2020/06/15
+
+### Fix
+
+- `adPosition`, use state.isStarted from parent tracker (contents tracker) to determine current ad position.
+
+## [0.17.0] - 2020/05/13
+
+### Fix
+
+- Minor issues on CAF Receiver environment.
+
+## [0.16.0] - 2020/04/30
+
+### Update
+
+- `diff` package to version 3.5.0.
+
+## [0.15.0] - 2020/04/30
+
+### Fix
+
+- Updated dependencies to fix multiple vulnerabilities reported by `npm audit`.
+
+## [0.14.0] - 2020/04/23
+
+### Add
+
+- Event backend system.
+
+## [0.13.0] - 2019/12/03
+
+### Fix
+
+- Issue with `isInitialBuffering` attribute.
+
+## [0.12.0] - 2019/12/02
+
+### Add
+
+- Add `isInitialBuffering` attribute.
+
+## [0.11.0] - 2019/11/22
+
+### Fix
+
+- Fix issue with AD_BREAK_END and recovering CONTENT tracker state.
+
+## [0.10.0] - 2018/02/08
+
+### Add
+
+- Add `playtimeSinceLastEvent` and `totalPlaytime` as attributes.
+
+## [0.9.3] - 2018/01/02
+
+### Fix
+
+- Fix `isAd` not being correctly reported.
+
+## [0.9.2] - 2017/12/19
+
+### Fix
+
+- Reset `timeSinceAdStart` at `CONTENT_REQUEST`.
+
+## [0.9.1] - 2017/11/21
+
+### Fix
+
+- Fix `Tracker#sendHeartbeat` not passing attributes.
+
+### Change
+
+- `sendXXXXX` methods from `VideoTracker` will now use `send` internally instead of `emit`.
+- Added a boolean as a parameter in `VideoTracker#getRenditionShift(bool)`. If true, it will store the new rendition. This way you can call `getRenditionShift()` without disrupting `RENDITION_CHANGE` events.
+
+## [0.9.0] - 2017/11/10
+
+### Add
+
+- Add `isPlayerReady` to `VideoTrackerState`.
+- Add `shift` in `*_RENDITION_CHANGE` events. Will report `up` or `down` depending on the change of rendition bitrate since last change.
+
+### Remove
+
+- Remove `TRACKER_READY` and `PLAYER_INIT` events.
+- Remove `sendPlayerInit` from `VideoTracker`.
+- Remove `timeSincePlayerInit` from `VideoTrackerState`. Use `timeSinceLoad`.
+- Remove `goPlayerInit` and `isPlayerReadying` from `VideoTrackerState`.
+
+### Change
+
+- First `HEARTBEAT` will now contain `timeSinceLastHeartbeat` counting since it was started.
+- Extend events of `VideoTracker` to cover all posibilities: from `END` to `CONTENT_END` and `AD_END`.
+
+## [0.8.0] - 2017/11/03
+
+### Add
+
+- Add `adCreativeId`, `adPartner` and `contentId/adId` attributes.
+
+## [0.7.0] - 2017/11/02
+
+### Add
+
+- Add `numberOfVideos` attribute, it shows the amount of videos reproduced.
+
+### Fix
+
+- Fix a bug with `viewId` being incremented ad `CONTENT_START` instead on on `CONTENT_REQUEST`.
+
+## [0.6.1] - 2017/10/17
+
+### Add
+
+- Add `addEventHandler` to `Log.debugCommonVideoEvents`.
+
+## [0.6.0] - 2017/10/16
+
+### Change
+
+- Move `heartbeat` support from `VideoTracker` to `Tracker`.
+
+### Fix
+
+- Fix minnor bug with `Tracker` class not reporting `customData`.
+
+## [0.5.0] - 2017/09/28
+
+### Add
+
+- `viewSession` attribute.
+- `VideoTrackerState#goViewCountUp` to increment `viewCount`.
+
+### Fix
+
+- `viewCount` going up BEFORE `CONTENT_END` is sent.
+
+### Remove
+
+- `VideoTracker#getViewId`.
+
+## [0.4.4] - 2017/09/28
+
+### Fix
+
+- `VideoTracker` not reporting user-defined attributes correctly.
+
+## [0.4.3] - 2017/09/26
+
+### Add
+
+- Expose `Chrono` class.
+
+## [0.4.2] - 2017/09/26
+
+### Change
+
+- Changed `timeSinceTrackerReady` behaviour.
+
+### Fix
+
+- `TrackerState` class not found error.
+
+## [0.4.1] - 2017/09/26
+
+### Change
+
+- Move `getTrackerName` and `getTrackerVersion` from `VideoTracker` to `Tracker` class.
+
+## [0.4.0] - 2017/09/26
+
+### Change
+
+- Rename `Tracker` to `VideoTracker` and `TrackerState` to `VideoTrackerState`.
+- Create a new `Tracker` intermediate class between `Emitter` and `VideoTracker` to provide support for non-video platforms.
+
+## [0.3.1] - 2017/09/20
+
+### Added
+
+- Add `coreVersion` as attribute for all events.
+
+## [0.3.0] - 2017/09/19
+
+### Added
+
+- Add `getHeartbeat` for `Tracker` class.
+
+### Change
+
+- Set default hearbeat to 30s.
+
+## [0.2.1] - 2017/09/19
+
+## Change
+
+- If you do not define a heartbeat for an adsTracker, it will take its parent value.
+
+## [0.2.0] - 2017/09/18
+
+### Add
+
+- Add `setOptions` for `Tracker` class.
+
+## [0.1.3] - 2017/09/12
+
+### Fix
+
+- Stop heartbeat when disposing.
+
+## [0.1.2] - 2017/08/28
+
+### Remove
+
+- Remove `adIsFullscreen`, `adIsAutoplayed`, `adIsLive`, `adPlayrate` and `adPreload` attributes from ad events.
+
+## [0.1.1] - 2017/08/23
+
+### Fix
+
+- `Tracker#sendXXXXX` methods, now they distinguish between ads and no ads for `timeSinceXXXX` attrs.
+
+### Added
+
+- Add `CONTRIBUTING.md` file
+
+## [0.1.0] - 2017/08/06
+
+- First Version

package/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 New Relic, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,95 @@
+[![Community Project header](https://github.com/newrelic/open-source-office/raw/master/examples/categories/images/Community_Project.png)](https://github.com/newrelic/open-source-office/blob/master/examples/categories/index.md#community-project)
+
+# New Relic Video Core - JavaScript
+
+The New Relic video tracking core library is the base for all video trackers in the browser platform. It contains the classes and core mechanisms used by the player specific trackers.
+It segregates the events into different event types based on action, such as video-related events going to `VideoAction`, ad-related events to `VideoAdAction`, errors to `VideoErrorAction`, and custom actions to `VideoCustomAction`.
+
+## Build
+
+Install dependencies:
+
+```
+$ npm install
+```
+
+And build:
+
+```
+$ npm run build:dev
+```
+
+Or if you need a production build:
+
+```
+$ npm run build
+```
+
+## Usage
+
+Add **scripts** inside `dist` folder to your page.
+
+> If you want to know how to generate `dist` folder, refer to **npm commands** section.
+
+### Registering Trackers
+
+`nrvideo` provides a class called `VideoTracker` that will serve as an interface with
+_Browser Agent_, allowing you to manage and send events to New Relic.
+
+First of all, you have to add a tracker in the core class:
+
+```javascript
+var tracker = new VideoTracker(player);
+```
+
+Once the tracker is added, any event it emits will be sent to New Relic and processed by the following functions:
+
+```javascript
+tracker.sendVideoAction("VideoEvent", { data: 1 });
+tracker.sendVideoAdAction("AdEvent", { data: "test-1" });
+tracker.sendVideoErrorAction("ErrorEvent", { data: "error-test" });
+tracker.sendVideoCustomAction("CustomEvent", { data: "custom-test" });
+```
+
+Of course, you may want to use built-in events for video. Luckily for you, this core library
+provides an easy way of sending video-related content, using `tracker.sendXXXXX` methods.
+
+```javascript
+tracker.sendRequest(); // Will send CONTENT_REQUEST
+```
+
+Search for `Tracker#sendXXXX` events in the documentation to read more about it.
+
+## Data Model
+
+To understand which actions and attributes are captured and emitted by the tracker under different event types, see [DataModel.md](./DATAMODEL.md).
+
+## Documentation
+
+All classes are documented using autodocs. The documents, generated with [jsdoc](https://github.com/jsdoc/jsdoc), can be found in the `documentation` directory of the current repo.
+
+# Open source license
+
+This project is distributed under the [Apache 2 license](LICENSE).
+
+# Support
+
+New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.
+
+We encourage you to bring your experiences and questions to the [Explorers Hub](https://discuss.newrelic.com) where our community members collaborate on solutions and new ideas.
+
+## Community
+
+New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:
+
+https://discuss.newrelic.com/t/video-core-js-tracker/100303
+
+## Issues / enhancement requests
+
+Issues and enhancement requests can be submitted in the [Issues tab of this repository](../../issues). Please search for and review the existing open issues before submitting a new issue.
+
+# Contributing
+
+Contributions are encouraged! If you submit an enhancement request, we'll invite you to contribute the change yourself. Please review our [Contributors Guide](CONTRIBUTING.md).
+
+Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource+videoagent@newrelic.com.