Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@atlaskit/analytics-listeners

atlassian36.5kApache-2.09.0.1TypeScript support: included

Fabric analytics listeners to be used by the products

fabric, ui

readme

changelog

@atlaskit/analytics-listeners

9.0.1

Patch Changes

9.0.0

Major Changes

Patch Changes

  • Updated dependencies

8.15.0

Minor Changes

Patch Changes

  • Updated dependencies

8.14.0

Minor Changes

Patch Changes

  • Updated dependencies

8.13.1

Patch Changes

  • #182077 efe589f6d9ed0 - (internal) Minor code changes; updated tests to be compatible with SWC transpilation

8.13.0

Minor Changes

  • #167243 e96979b15083b - Add non privacy safe attributes to the media analytics listenr, so they get passed along if they were included.

8.12.0

Minor Changes

8.11.1

Patch Changes

8.11.0

Minor Changes

  • #127511 db30e29344013 - Widening range of react and react-dom peer dependencies from ^16.8.0 || ^17.0.0 || ~18.2.0 to the wider range of ^16.8.0 || ^17.0.0 || ^18.0.0` (where applicable).

    This change has been done to enable usage of `react@18.3as well as to have a consistent peer dependency range forreactandreact-domfor/platform` packages.

Patch Changes

  • Updated dependencies

8.10.2

Patch Changes

  • Updated dependencies

8.10.1

Patch Changes

8.10.0

Minor Changes

Patch Changes

  • Updated dependencies

8.9.2

Patch Changes

8.9.1

Patch Changes

  • #67410 155e3b00ce67 - Migrate @atlaskit/analytics-listeners to use declarative entry points

8.9.0

Minor Changes

Patch Changes

  • Updated dependencies

8.8.0

Minor Changes

Patch Changes

  • Updated dependencies

8.7.5

Patch Changes

8.7.4

Patch Changes

8.7.3

Patch Changes

8.7.2

Patch Changes

8.7.1

Patch Changes

8.7.0

Minor Changes

Patch Changes

  • Updated dependencies

8.6.1

Patch Changes

8.6.0

Minor Changes

  • #32042 adde244c8b4 - CUI-24: set namespaces based on the context for crossFlow channel

8.5.1

Patch Changes

  • Updated dependencies

8.5.0

Minor Changes

  • #28452 e8ee5a82bf4 - First draft of discovery-analytics, type definitions and APIs, and implement fire viewed and clicked events. Add new listener for crossFlow.

8.4.0

Minor Changes

Patch Changes

  • Updated dependencies

8.3.2

Patch Changes

8.3.1

Patch Changes

8.3.0

Minor Changes

Patch Changes

  • Updated dependencies

8.2.1

Patch Changes

8.2.0

Minor Changes

Patch Changes

  • Updated dependencies

8.1.3

Patch Changes

8.1.2

Patch Changes

8.1.1

Patch Changes

8.1.0

Minor Changes

Patch Changes

  • Updated dependencies

8.0.0

Major Changes

  • #8644 d59eaef1c0d - Changes in MediaAnalyticsListener's processEvent(): not using namespace context anymore, AnalyticsContext will be solely used for retrieving packageName&version and computing packageHierarchy

Patch Changes

  • 4f1d3a6b22a - Refactored Media Analytics Namespaced Context (now delivered by our HOC in media-common)
  • Updated dependencies

7.0.6

Patch Changes

7.0.5

Patch Changes

  • #5497 5f58283e1f - Export types using Typescript's new "export type" syntax to satisfy Typescript's --isolatedModules compiler option. This requires version 3.8 of Typescript, read more about how we handle Typescript versions here: https://atlaskit.atlassian.com/get-started Also add typescript to devDependencies to denote version that the package was built with.

7.0.4

Patch Changes

  • Updated dependencies

7.0.3

Patch Changes

  • #3885 6c525a8229 - Upgraded to TypeScript 3.9.6 and tslib to 2.0.0

    Since tslib is a dependency for all our packages we recommend that products also follow this tslib upgrade to prevent duplicates of tslib being bundled.

7.0.2

Patch Changes

  • #3823 bb931c93a4 - Make it possible to override package version and name with the analytic payload
  • Updated dependencies

7.0.1

Patch Changes

  • #3226 0c532edf6e - Use the 'lodash' package instead of single-function 'lodash.*' packages

7.0.0

Major Changes

Patch Changes

  • Updated dependencies

6.4.1

Patch Changes

6.4.0

Minor Changes

Patch Changes

  • Updated dependencies

6.3.0

Minor Changes

  • [minor]11ff95c0f0:

    Using media api region in analytics events- [minor]69b678b38c:

    Refactor media analytics listener to properly include context data. Add and use new media namespace analytics context in MediaCard

Patch Changes

6.2.4

Patch Changes

  • [patch]c1992227dc:

    Bump to lodash.merge to 4.6.2

6.2.3

Patch Changes

6.2.2

Patch Changes

  • [patch]35d2229b2a:

    Adding missing license to packages and update to Copyright 2019 Atlassian Pty Ltd.

6.2.1

Patch Changes

  • [patch]a2d0043716:

    Updated version of analytics-next to fix potential incompatibilities with TS 3.6

6.2.0

Minor Changes

  • [minor]af72468517:

    Media card now emit analytics events which payload and context stuctures reflect GASv3 payload specification. Media Analytics Listener merges Payload and Context data before sending it to the backend. The merge is based on attributes.packageName equality Media Analytics Listener adds packageHierarchy attribute to merged payload, the same way Atlaskit Listener does.

6.1.7

Patch Changes

  • [patch]097b696613:

    Components now depend on TS 3.6 internally, in order to fix an issue with TS resolving non-relative imports as relative imports

6.1.6

Patch Changes

6.1.5

Patch Changes

  • [patch]926b43142b:

    Analytics-next has been converted to Typescript. Typescript consumers will now get static type safety. Flow types are no longer provided. No behavioural changes.

    Breaking changes

    • withAnalyticsForSumTypeProps alias has been removed, please use withAnalyticsEvents
    • AnalyticsContextWrappedComp alias has been removed, please use withAnalyticsContext

    Breaking changes to TypeScript annotations

    • withAnalyticsEvents now infers proptypes automatically, consumers no longer need to provide props as a generic type.
    • withAnalyticsContext now infers proptypes automatically, consumers no longer need to provide props as a generic type.
    • Type WithAnalyticsEventProps has been renamed to WithAnalyticsEventsProps to match source code
    • Type CreateUIAnalyticsEventSignature has been renamed to CreateUIAnalyticsEvent to match source code
    • Type UIAnalyticsEventHandlerSignature has been renamed to UIAnalyticsEventHandler to match source code
    • Type AnalyticsEventsPayload has been renamed to AnalyticsEventPayload
    • Type ObjectType has been removed, please use Record<string, any> or [key: string]: any
    • Type UIAnalyticsEventInterface has been removed, please use UIAnalyticsEvent
    • Type AnalyticsEventInterface has been removed, please use AnalyticsEvent
    • Type CreateAndFireEventFunction removed and should now be inferred by TypeScript
    • Type AnalyticsEventUpdater removed and should now be inferred by TypeScript

6.1.4

Patch Changes

  • [patch]9f8ab1084b:

    Consume analytics-next ts type definitions as an ambient declaration.

6.1.3

Patch Changes

  • [patch]bbff8a7d87:

    Fixes bug, missing version.json file

6.1.2

Patch Changes

  • [patch]18dfac7332:

    In this PR, we are:

    • Re-introducing dist build folders
    • Adding back cjs
    • Replacing es5 by cjs and es2015 by esm
    • Creating folders at the root for entry-points
    • Removing the generation of the entry-points at the root Please see this ticket or this page for further details

6.1.1

Patch Changes

  • [patch]d0db01b410:

    TypeScript users of withAnalyticsEvents and withAnalyticsContext are now required to provide props as a generic type. This is so that TypeScript can correctly calculate the props and defaultProps of the returned component.

    Before:

    withAnalyticsEvents()(Button) as ComponentClass<Props>;

    After:

    withAnalyticsEvents<Props>()(Button);

6.1.0

  • [minor]f53003a5ed:

    • ED-6741 Add 'appearance' to all editor analytics events

6.0.0

  • [major]7c17b35107:

    • Updates react and react-dom peer dependencies to react@^16.8.0 and react-dom@^16.8.0. To use this package, please ensure you use at least this version of react and react-dom.

5.0.5

5.0.4

  • [patch]3f28e6443c:

    • @atlaskit/analytics-next-types is deprecated. Now you can use types for @atlaskit/analytics-next supplied from itself.

5.0.3

5.0.2

  • [patch]d13fad66df:

    • Enable esModuleInterop for typescript, this allows correct use of default exports

5.0.1

  • [patch]1bcaa1b991:

    • Add npmignore for index.ts to prevent some jest tests from resolving that instead of index.js

5.0.0

  • [major]9d5cc39394:

    • Dropped ES5 distributables from the typescript packages

4.2.1

4.2.0

  • [minor]8c65a38bfc:

    • enable noImplicitAny for elements analytics packages. Fix related issues.

4.1.5

  • [patch]a3b8046:

    • Add more specific types to analytics-listener webclient type

4.1.4

4.1.3

  • [patch]dff4f0e:

    • AnalyticsListeners should accept any promise-like client

4.1.2

  • [patch]e981882:

    • Add media tag to analytics tags sent by media listener

4.1.1

4.1.0

  • [minor]dd0a73c:

    • Allow consumers to pass promise of analytics web client as well as the client itself

4.0.7

  • [patch]1d30f7e:

    • Make analytics-web-client non-mandatory

4.0.6

4.0.5

  • [patch] Analytics event's 'source' field from GasPayload type is now optional. In most cases, the 'source' field is expected to be set by the integrator through AnalyticsContext. Thus it's recommended that components do not set it to avoid overriding the one provided by the integrating product. Analytics listeners are handling the case where the 'source' field couldn't be found by setting the default value "unknown" before sending the event through the client. 1c0ea95

4.0.4

  • [patch] FS-3057 pick fields from context 187d175

4.0.3

  • [patch] Introduce media analytics listener e7d7ab1

4.0.2

4.0.1

  • [patch] fixed imports, docs and made GasPayload package attributes optional 6be5eed
  • [patch] use createAndFire function from analytics-next 095f356
  • [patch] Fixed TS errors and code improvements b290312
  • [patch] enable analytics-next TDs on analytics-listeners and analytics-namespaced-context e65f377

4.0.0

  • [patch] fixed async tests and removed redundant componenthelpers 3599b88
  • [patch] Fixed async test expectations b8c167d
  • [major] removed promise from FabricAnalyticsListener.client property 90ba6bd

3.4.1

  • [patch] Fix elements listener listening on wrong channel 2b817e1

3.4.0

3.3.1

3.3.0

  • [minor] Update navigation listener to process operational events 2d53fc1
  • [none] Updated dependencies 2d53fc1

3.2.0

3.1.1

3.1.0

  • [minor] Add navigation listener that listens to events fired from within the new @atlaskit/navigation-next and @atlaskit/global-navigation packages. fb67997
  • [minor] Add excludedChannels prop to exclude listeners on certain channels from being rendered. This is primarily intended to prevent the events fired on the atlaskit channel from being captured so that duplicate events are not sent for atlaskit/core components. d43b8a2

3.0.3

3.0.2

3.0.1

  • [patch] fixes problem caused by source not always being set 00b1a71

3.0.0

2.1.3

2.1.2

2.1.1

2.1.0

  • [patch] merge analytics-next context into GAS payload attributes in FabricElementsListener 5d25e8b
  • [minor] moved Atlaskit tests from src to tests 1f78c33

2.0.2

  • [patch] Clean Changelogs - remove duplicates and empty entries e7756cd
  • [none] Updated dependencies e7756cd

2.0.1

2.0.0

  • [major] client parameter changed to a Promise in the listeners given Confluence gets the AnalyticsWebClient instance asynchronously 628e427

1.2.0

  • [patch] Throw error on component construction when client prop is missing rather than silently failing until an event is fired 4bbce97
  • [minor] Add some debug/error logging to listener which can be enabled via the logLevel prop 191a1ff

1.1.1

1.1.0

1.0.2

  • [patch] Moved event tag to FabricElementsListener 639ae5e

1.0.1

  • [patch] code improvements 44e55aa
  • [patch] added analytics-listeners package 8e71e9a