@atlaskit/analytics-cross-product 1.0.0

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/analytics-cross-product

package/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2023 Atlassian Pty Ltd
+
+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,111 @@
+# AnalyticsCrossProduct
+
+Utilities to enable cross-product interaction session tracking
+
+This repository is the public facing version of
+`@atlassiansox/analytics-cross-product-interaction-client`. Functionality has been duplicated from
+the private package to enable `@atlaskit` components to use our library, with the eventual goal of
+deprecating these functions in the existing package to avoid code duplication.
+
+The functions in this library are designed to work in conjunction with `analytics-web-client` and
+`analytics-cross-product-interaction-client` on Atlassian products, and using these functions on
+their own will return a no-op.
+
+## Overview
+
+The Analytics Web Client generates interaction session data and stores it in Session Storage. The
+data is in the following shape:
+
+```Json
+"interactionSession": {
+    "id": "123456789",
+    "prevId": "912345678",
+    "bridge": "atlassianSwitcher",
+    "source": "jira"
+}
+```
+
+This package exposes: `useCrossProductUrlWrapper`, a React hook that can be used to retrieve
+interaction session data and append them as URL parameters onto cross-product navigation URLs
+
+## Usage within an Atlassian bridge
+
+A bridge is a component that provides a link/navigation to a different Atlassian page, for example:
+
+```TypeScript
+return <Link href="https://hello.atlassian.net/wiki"> Confluence </Link>
+```
+
+To embed the interaction session properties into the link as a UTM parameter, call our hook
+`useCrossProductUrlWrapper` which generates a function to wrap the link with.
+
+Then replace any instances of URLs with the URL wrapped in the hook
+
+```TypeScript
+import { useCrossProductUrlWrapper }  from '@atlaskit/analytics-cross-product';
+
+const withInteractionSession = useCrossProductUrlWrapper({
+    bridge: 'Bridge Name', // The name of your bridge component e.g. atlassianSwitcher
+    product: 'Product Name', // The product you are hosted on e.g. jira
+    subProduct: 'SubProduct Name', // Optional - include if required
+});
+
+return (
+    <Link href={withInteractionSession("https://hello.atlassian.net/wiki")}> Confluence </Link>
+)
+```
+
+The `useCrossProductUrlWrapper` hook takes in options of type `CrossProductUrlOptions` which can be
+imported from our library if required
+
+The returned wrapper function (`withInteractionSession` in the above example) takes a URL as a
+string, and returns a string as well. The return value of the above call would be something like:
+
+```
+https://hello.atlassian.net/wiki?xpis=e2JyaWRnZToiQnJpZGdlIE5hbWUiLGlkOiIxMjM0NTY3ODkiLHNvdXJjZToiUHJvZHVjdCBOYW1lLVN1YlByb2R1Y3QgTmFtZSJ9
+```
+
+with the interaction session data encoded in the `?xpis` query parameter (cross-product interaction
+session)
+
+See our [example](./examples/basic.tsx). To run the example locally:
+
+```bash
+yarn start @atlaskit/analytics-cross-product
+```
+
+### Parameter generation and re-generation
+
+Interaction session data will only be appended to the URL if it has already been generated by the
+Analytics Web Client and exists in Session Storage. If interaction session data cannot be found, the
+hook will not modify the URL. The hook is subscribed to a DOM event that will trigger a re-render if
+a new interaciton session is generated, and will dynamically update the URL to include the correct
+parameters
+
+### Relative URLs
+
+The wrapper supports relative URLs, for example:
+
+```TypeScript
+withInteractionSession("/wiki")
+```
+
+will return
+
+```TypeScript
+"/wiki?xpis=e2Jya..."
+```
+
+We use the `URL` class to perform operations. Note:
+
+- The URL must not have a trailing slash (i.e. use `/wiki` instead of `/wiki/`)
+- A leading slash will be added to the return output (i.e. `wiki` will become `/wiki?xpis=...`)
+- Existing query parameters will be preserved (`/wiki?a=b` becomes `/wiki?a=b&xpis=e2Jya...`)
+
+### Usage with Identity
+
+When a link is wrapped in Identity (passed as the `continue` paramater in the redirect), Identity
+encodes query parameters using percent encoding (i.e. `&key=value` becomes `%26key%3Dvalue`).
+
+Ensure that our wrapper is called on the `href` _before_ passing into identity. This will ensure our
+query parameters are also correctly percent encoded, and will persist after Identity redirect

package/dist/cjs/generateUrlWithParams.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateUrlWithParams = exports.URL_QUERY_PARAM_INTERACTION_SESSION = void 0;
+var URL_QUERY_PARAM_INTERACTION_SESSION = exports.URL_QUERY_PARAM_INTERACTION_SESSION = 'xpis';
+var generateUrlWithParams = exports.generateUrlWithParams = function generateUrlWithParams(url, bridge, interactionSessionId, product, subProduct) {
+  var interactionSource = subProduct ? "".concat(product, "-").concat(subProduct) : product;
+  var interactionSession = {
+    bridge: bridge,
+    id: interactionSessionId,
+    source: interactionSource
+  };
+  var paramValueEncoded = btoa(JSON.stringify(interactionSession));
+  var partialUrl = false;
+  var urlObj;
+
+  // If relative URL provided, add localhost as placeholder base, to be stripped later
+  try {
+    urlObj = new URL(url);
+  } catch (_unused) {
+    urlObj = new URL(url, 'http://localhost/');
+    partialUrl = true;
+  }
+  urlObj.searchParams.set(URL_QUERY_PARAM_INTERACTION_SESSION, paramValueEncoded);
+  if (partialUrl) {
+    return urlObj.pathname + urlObj.search;
+  } else {
+    return urlObj.toString();
+  }
+};

package/dist/cjs/globalInteractionSessionTracking.js

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.INTERNAL_CLIENT_WINDOW_KEY = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var INTERNAL_CLIENT_WINDOW_KEY = exports.INTERNAL_CLIENT_WINDOW_KEY = 'analyticsInteractionSesssionTrackingClient';
+var GlobalInteractionSessionTracking = exports.default = /*#__PURE__*/function () {
+  function GlobalInteractionSessionTracking() {
+    (0, _classCallCheck2.default)(this, GlobalInteractionSessionTracking);
+  }
+  return (0, _createClass2.default)(GlobalInteractionSessionTracking, null, [{
+    key: "getInstance",
+    value: function getInstance() {
+      var interactionSessionTracking;
+      try {
+        // Check if InteractionSessionTracking in global window object
+        if (INTERNAL_CLIENT_WINDOW_KEY in window) {
+          interactionSessionTracking = window[INTERNAL_CLIENT_WINDOW_KEY];
+        }
+      } catch (error) {
+        // eslint-disable-next-line no-console
+        console.error("Error fetching InteractionSessionTracking from window - ".concat(error instanceof Error ? error.message : String(error)));
+      }
+      return interactionSessionTracking;
+    }
+  }]);
+}();

package/dist/cjs/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "INTERACTION_SESSION_ID_UPDATED_EVENT", {
+  enumerable: true,
+  get: function get() {
+    return _useCrossProductUrlWrapper.INTERACTION_SESSION_ID_UPDATED_EVENT;
+  }
+});
+Object.defineProperty(exports, "INTERNAL_CLIENT_WINDOW_KEY", {
+  enumerable: true,
+  get: function get() {
+    return _globalInteractionSessionTracking.INTERNAL_CLIENT_WINDOW_KEY;
+  }
+});
+Object.defineProperty(exports, "useCrossProductUrlWrapper", {
+  enumerable: true,
+  get: function get() {
+    return _useCrossProductUrlWrapper.default;
+  }
+});
+var _globalInteractionSessionTracking = require("./globalInteractionSessionTracking");
+var _useCrossProductUrlWrapper = _interopRequireWildcard(require("./useCrossProductUrlWrapper"));
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }

package/dist/cjs/useCrossProductUrlWrapper.js

@@ -0,0 +1,81 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.INTERACTION_SESSION_ID_UPDATED_EVENT = void 0;
+exports.default = useCrossProductUrlWrapper;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = require("react");
+var _bindEventListener = require("bind-event-listener");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _generateUrlWithParams = require("./generateUrlWithParams");
+var _globalInteractionSessionTracking = _interopRequireDefault(require("./globalInteractionSessionTracking"));
+var INTERACTION_SESSION_ID_UPDATED_EVENT = exports.INTERACTION_SESSION_ID_UPDATED_EVENT = 'interactionSessionIdUpdated';
+
+/**
+ * @param bridge - The name of your navigation component e.g. atlassianSwitcher
+ * @param product - The product you are hosted on e.g. jira
+ * @param subProduct - If specified, will be appended to the end of product as: product-subProduct
+ */
+
+/**
+ * This React hook is called with the correct bridge, product and sub-product parameters.
+ * It returns a function that can be used to generate URLs with cross-product interaction parameters.
+ *
+ * @param options - Properties object that contains the following parameters:
+ *
+ * @returns A function that appends interaction session ID and other cross-product interaction parameters to a given URL.
+ */
+function useCrossProductUrlWrapper(options) {
+  var _useState = (0, _react.useState)(''),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    interactionSessionId = _useState2[0],
+    setInteractionSessionId = _useState2[1];
+  var bridge = options.bridge,
+    product = options.product,
+    subProduct = options.subProduct;
+  var isEnabled = (0, _platformFeatureFlags.fg)('atlaskit-analytics-cross-product');
+  var interactionSessionClient;
+  (0, _react.useEffect)(function () {
+    if (isEnabled) {
+      // Fetch interaction session client from window object
+      interactionSessionClient = _globalInteractionSessionTracking.default.getInstance();
+
+      // Fetch any initial interaction session ID
+      if (interactionSessionClient) {
+        var currentSessionId = interactionSessionClient.getCurrentInteractionSessionId();
+        currentSessionId && setInteractionSessionId(currentSessionId);
+      }
+
+      // Add event listener that subscribes to any future interaction session ID updates
+      var unbind = (0, _bindEventListener.bind)(document, {
+        type: INTERACTION_SESSION_ID_UPDATED_EVENT,
+        listener: function listener() {
+          // Re-attempt fetch Global interactionSessionClient if not present already
+          if (!interactionSessionClient) {
+            interactionSessionClient = _globalInteractionSessionTracking.default.getInstance();
+          }
+          if (interactionSessionClient) {
+            var _currentSessionId = interactionSessionClient.getCurrentInteractionSessionId();
+            _currentSessionId && setInteractionSessionId(_currentSessionId);
+          } else {
+            // eslint-disable-next-line no-console
+            console.error("INTERACTION_SESSION_ID_UPDATED_EVENT received but interactionSessionClient not present on window");
+          }
+        }
+      });
+      return unbind;
+    }
+    return function () {};
+  }, [interactionSessionClient, isEnabled]);
+  if (!isEnabled || !interactionSessionId) {
+    return function (url) {
+      return url;
+    };
+  }
+  return function (url) {
+    return (0, _generateUrlWithParams.generateUrlWithParams)(url, bridge, interactionSessionId, product, subProduct);
+  };
+}

package/dist/es2019/generateUrlWithParams.js

@@ -0,0 +1,26 @@
+export const URL_QUERY_PARAM_INTERACTION_SESSION = 'xpis';
+export const generateUrlWithParams = (url, bridge, interactionSessionId, product, subProduct) => {
+  const interactionSource = subProduct ? `${product}-${subProduct}` : product;
+  const interactionSession = {
+    bridge: bridge,
+    id: interactionSessionId,
+    source: interactionSource
+  };
+  const paramValueEncoded = btoa(JSON.stringify(interactionSession));
+  let partialUrl = false;
+  let urlObj;
+
+  // If relative URL provided, add localhost as placeholder base, to be stripped later
+  try {
+    urlObj = new URL(url);
+  } catch {
+    urlObj = new URL(url, 'http://localhost/');
+    partialUrl = true;
+  }
+  urlObj.searchParams.set(URL_QUERY_PARAM_INTERACTION_SESSION, paramValueEncoded);
+  if (partialUrl) {
+    return urlObj.pathname + urlObj.search;
+  } else {
+    return urlObj.toString();
+  }
+};

package/dist/es2019/globalInteractionSessionTracking.js

@@ -0,0 +1,16 @@
+export const INTERNAL_CLIENT_WINDOW_KEY = 'analyticsInteractionSesssionTrackingClient';
+export default class GlobalInteractionSessionTracking {
+  static getInstance() {
+    let interactionSessionTracking;
+    try {
+      // Check if InteractionSessionTracking in global window object
+      if (INTERNAL_CLIENT_WINDOW_KEY in window) {
+        interactionSessionTracking = window[INTERNAL_CLIENT_WINDOW_KEY];
+      }
+    } catch (error) {
+      // eslint-disable-next-line no-console
+      console.error(`Error fetching InteractionSessionTracking from window - ${error instanceof Error ? error.message : String(error)}`);
+    }
+    return interactionSessionTracking;
+  }
+}

package/dist/es2019/index.js

@@ -0,0 +1,3 @@
+import { INTERNAL_CLIENT_WINDOW_KEY } from './globalInteractionSessionTracking';
+import useCrossProductUrlWrapper, { INTERACTION_SESSION_ID_UPDATED_EVENT } from './useCrossProductUrlWrapper';
+export { useCrossProductUrlWrapper, INTERNAL_CLIENT_WINDOW_KEY, INTERACTION_SESSION_ID_UPDATED_EVENT };

package/dist/es2019/useCrossProductUrlWrapper.js

@@ -0,0 +1,67 @@
+import { useEffect, useState } from 'react';
+import { bind } from 'bind-event-listener';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { generateUrlWithParams } from './generateUrlWithParams';
+import GlobalInteractionSessionTracking from './globalInteractionSessionTracking';
+export const INTERACTION_SESSION_ID_UPDATED_EVENT = 'interactionSessionIdUpdated';
+
+/**
+ * @param bridge - The name of your navigation component e.g. atlassianSwitcher
+ * @param product - The product you are hosted on e.g. jira
+ * @param subProduct - If specified, will be appended to the end of product as: product-subProduct
+ */
+
+/**
+ * This React hook is called with the correct bridge, product and sub-product parameters.
+ * It returns a function that can be used to generate URLs with cross-product interaction parameters.
+ *
+ * @param options - Properties object that contains the following parameters:
+ *
+ * @returns A function that appends interaction session ID and other cross-product interaction parameters to a given URL.
+ */
+export default function useCrossProductUrlWrapper(options) {
+  const [interactionSessionId, setInteractionSessionId] = useState('');
+  const {
+    bridge,
+    product,
+    subProduct
+  } = options;
+  const isEnabled = fg('atlaskit-analytics-cross-product');
+  let interactionSessionClient;
+  useEffect(() => {
+    if (isEnabled) {
+      // Fetch interaction session client from window object
+      interactionSessionClient = GlobalInteractionSessionTracking.getInstance();
+
+      // Fetch any initial interaction session ID
+      if (interactionSessionClient) {
+        const currentSessionId = interactionSessionClient.getCurrentInteractionSessionId();
+        currentSessionId && setInteractionSessionId(currentSessionId);
+      }
+
+      // Add event listener that subscribes to any future interaction session ID updates
+      const unbind = bind(document, {
+        type: INTERACTION_SESSION_ID_UPDATED_EVENT,
+        listener: () => {
+          // Re-attempt fetch Global interactionSessionClient if not present already
+          if (!interactionSessionClient) {
+            interactionSessionClient = GlobalInteractionSessionTracking.getInstance();
+          }
+          if (interactionSessionClient) {
+            const currentSessionId = interactionSessionClient.getCurrentInteractionSessionId();
+            currentSessionId && setInteractionSessionId(currentSessionId);
+          } else {
+            // eslint-disable-next-line no-console
+            console.error(`INTERACTION_SESSION_ID_UPDATED_EVENT received but interactionSessionClient not present on window`);
+          }
+        }
+      });
+      return unbind;
+    }
+    return () => {};
+  }, [interactionSessionClient, isEnabled]);
+  if (!isEnabled || !interactionSessionId) {
+    return url => url;
+  }
+  return url => generateUrlWithParams(url, bridge, interactionSessionId, product, subProduct);
+}

package/dist/esm/generateUrlWithParams.js

@@ -0,0 +1,26 @@
+export var URL_QUERY_PARAM_INTERACTION_SESSION = 'xpis';
+export var generateUrlWithParams = function generateUrlWithParams(url, bridge, interactionSessionId, product, subProduct) {
+  var interactionSource = subProduct ? "".concat(product, "-").concat(subProduct) : product;
+  var interactionSession = {
+    bridge: bridge,
+    id: interactionSessionId,
+    source: interactionSource
+  };
+  var paramValueEncoded = btoa(JSON.stringify(interactionSession));
+  var partialUrl = false;
+  var urlObj;
+
+  // If relative URL provided, add localhost as placeholder base, to be stripped later
+  try {
+    urlObj = new URL(url);
+  } catch (_unused) {
+    urlObj = new URL(url, 'http://localhost/');
+    partialUrl = true;
+  }
+  urlObj.searchParams.set(URL_QUERY_PARAM_INTERACTION_SESSION, paramValueEncoded);
+  if (partialUrl) {
+    return urlObj.pathname + urlObj.search;
+  } else {
+    return urlObj.toString();
+  }
+};

package/dist/esm/globalInteractionSessionTracking.js

@@ -0,0 +1,25 @@
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+export var INTERNAL_CLIENT_WINDOW_KEY = 'analyticsInteractionSesssionTrackingClient';
+var GlobalInteractionSessionTracking = /*#__PURE__*/function () {
+  function GlobalInteractionSessionTracking() {
+    _classCallCheck(this, GlobalInteractionSessionTracking);
+  }
+  return _createClass(GlobalInteractionSessionTracking, null, [{
+    key: "getInstance",
+    value: function getInstance() {
+      var interactionSessionTracking;
+      try {
+        // Check if InteractionSessionTracking in global window object
+        if (INTERNAL_CLIENT_WINDOW_KEY in window) {
+          interactionSessionTracking = window[INTERNAL_CLIENT_WINDOW_KEY];
+        }
+      } catch (error) {
+        // eslint-disable-next-line no-console
+        console.error("Error fetching InteractionSessionTracking from window - ".concat(error instanceof Error ? error.message : String(error)));
+      }
+      return interactionSessionTracking;
+    }
+  }]);
+}();
+export { GlobalInteractionSessionTracking as default };

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+import { INTERNAL_CLIENT_WINDOW_KEY } from './globalInteractionSessionTracking';
+import useCrossProductUrlWrapper, { INTERACTION_SESSION_ID_UPDATED_EVENT } from './useCrossProductUrlWrapper';
+export { useCrossProductUrlWrapper, INTERNAL_CLIENT_WINDOW_KEY, INTERACTION_SESSION_ID_UPDATED_EVENT };

package/dist/esm/useCrossProductUrlWrapper.js

@@ -0,0 +1,73 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { useEffect, useState } from 'react';
+import { bind } from 'bind-event-listener';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { generateUrlWithParams } from './generateUrlWithParams';
+import GlobalInteractionSessionTracking from './globalInteractionSessionTracking';
+export var INTERACTION_SESSION_ID_UPDATED_EVENT = 'interactionSessionIdUpdated';
+
+/**
+ * @param bridge - The name of your navigation component e.g. atlassianSwitcher
+ * @param product - The product you are hosted on e.g. jira
+ * @param subProduct - If specified, will be appended to the end of product as: product-subProduct
+ */
+
+/**
+ * This React hook is called with the correct bridge, product and sub-product parameters.
+ * It returns a function that can be used to generate URLs with cross-product interaction parameters.
+ *
+ * @param options - Properties object that contains the following parameters:
+ *
+ * @returns A function that appends interaction session ID and other cross-product interaction parameters to a given URL.
+ */
+export default function useCrossProductUrlWrapper(options) {
+  var _useState = useState(''),
+    _useState2 = _slicedToArray(_useState, 2),
+    interactionSessionId = _useState2[0],
+    setInteractionSessionId = _useState2[1];
+  var bridge = options.bridge,
+    product = options.product,
+    subProduct = options.subProduct;
+  var isEnabled = fg('atlaskit-analytics-cross-product');
+  var interactionSessionClient;
+  useEffect(function () {
+    if (isEnabled) {
+      // Fetch interaction session client from window object
+      interactionSessionClient = GlobalInteractionSessionTracking.getInstance();
+
+      // Fetch any initial interaction session ID
+      if (interactionSessionClient) {
+        var currentSessionId = interactionSessionClient.getCurrentInteractionSessionId();
+        currentSessionId && setInteractionSessionId(currentSessionId);
+      }
+
+      // Add event listener that subscribes to any future interaction session ID updates
+      var unbind = bind(document, {
+        type: INTERACTION_SESSION_ID_UPDATED_EVENT,
+        listener: function listener() {
+          // Re-attempt fetch Global interactionSessionClient if not present already
+          if (!interactionSessionClient) {
+            interactionSessionClient = GlobalInteractionSessionTracking.getInstance();
+          }
+          if (interactionSessionClient) {
+            var _currentSessionId = interactionSessionClient.getCurrentInteractionSessionId();
+            _currentSessionId && setInteractionSessionId(_currentSessionId);
+          } else {
+            // eslint-disable-next-line no-console
+            console.error("INTERACTION_SESSION_ID_UPDATED_EVENT received but interactionSessionClient not present on window");
+          }
+        }
+      });
+      return unbind;
+    }
+    return function () {};
+  }, [interactionSessionClient, isEnabled]);
+  if (!isEnabled || !interactionSessionId) {
+    return function (url) {
+      return url;
+    };
+  }
+  return function (url) {
+    return generateUrlWithParams(url, bridge, interactionSessionId, product, subProduct);
+  };
+}

package/dist/types/generateUrlWithParams.d.ts

@@ -0,0 +1,2 @@
+export declare const URL_QUERY_PARAM_INTERACTION_SESSION = "xpis";
+export declare const generateUrlWithParams: (url: string, bridge: string, interactionSessionId: string, product: string, subProduct?: string) => string;

package/dist/types/globalInteractionSessionTracking.d.ts

@@ -0,0 +1,7 @@
+export declare const INTERNAL_CLIENT_WINDOW_KEY = "analyticsInteractionSesssionTrackingClient";
+export interface InteractionSessionTracking {
+    getCurrentInteractionSessionId(): string | null;
+}
+export default class GlobalInteractionSessionTracking {
+    static getInstance(): InteractionSessionTracking | undefined;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+import { INTERNAL_CLIENT_WINDOW_KEY } from './globalInteractionSessionTracking';
+import useCrossProductUrlWrapper, { type CrossProductUrlOptions, INTERACTION_SESSION_ID_UPDATED_EVENT } from './useCrossProductUrlWrapper';
+export { useCrossProductUrlWrapper, type CrossProductUrlOptions, INTERNAL_CLIENT_WINDOW_KEY, INTERACTION_SESSION_ID_UPDATED_EVENT, };

package/dist/types/useCrossProductUrlWrapper.d.ts

@@ -0,0 +1,20 @@
+export declare const INTERACTION_SESSION_ID_UPDATED_EVENT = "interactionSessionIdUpdated";
+/**
+ * @param bridge - The name of your navigation component e.g. atlassianSwitcher
+ * @param product - The product you are hosted on e.g. jira
+ * @param subProduct - If specified, will be appended to the end of product as: product-subProduct
+ */
+export type CrossProductUrlOptions = {
+    bridge: string;
+    product: string;
+    subProduct?: string;
+};
+/**
+ * This React hook is called with the correct bridge, product and sub-product parameters.
+ * It returns a function that can be used to generate URLs with cross-product interaction parameters.
+ *
+ * @param options - Properties object that contains the following parameters:
+ *
+ * @returns A function that appends interaction session ID and other cross-product interaction parameters to a given URL.
+ */
+export default function useCrossProductUrlWrapper(options: CrossProductUrlOptions): (url: string) => string;

package/dist/types-ts4.5/generateUrlWithParams.d.ts

@@ -0,0 +1,2 @@
+export declare const URL_QUERY_PARAM_INTERACTION_SESSION = "xpis";
+export declare const generateUrlWithParams: (url: string, bridge: string, interactionSessionId: string, product: string, subProduct?: string) => string;

package/dist/types-ts4.5/globalInteractionSessionTracking.d.ts

@@ -0,0 +1,7 @@
+export declare const INTERNAL_CLIENT_WINDOW_KEY = "analyticsInteractionSesssionTrackingClient";
+export interface InteractionSessionTracking {
+    getCurrentInteractionSessionId(): string | null;
+}
+export default class GlobalInteractionSessionTracking {
+    static getInstance(): InteractionSessionTracking | undefined;
+}

package/dist/types-ts4.5/index.d.ts

@@ -0,0 +1,3 @@
+import { INTERNAL_CLIENT_WINDOW_KEY } from './globalInteractionSessionTracking';
+import useCrossProductUrlWrapper, { type CrossProductUrlOptions, INTERACTION_SESSION_ID_UPDATED_EVENT } from './useCrossProductUrlWrapper';
+export { useCrossProductUrlWrapper, type CrossProductUrlOptions, INTERNAL_CLIENT_WINDOW_KEY, INTERACTION_SESSION_ID_UPDATED_EVENT, };

package/dist/types-ts4.5/useCrossProductUrlWrapper.d.ts

@@ -0,0 +1,20 @@
+export declare const INTERACTION_SESSION_ID_UPDATED_EVENT = "interactionSessionIdUpdated";
+/**
+ * @param bridge - The name of your navigation component e.g. atlassianSwitcher
+ * @param product - The product you are hosted on e.g. jira
+ * @param subProduct - If specified, will be appended to the end of product as: product-subProduct
+ */
+export type CrossProductUrlOptions = {
+    bridge: string;
+    product: string;
+    subProduct?: string;
+};
+/**
+ * This React hook is called with the correct bridge, product and sub-product parameters.
+ * It returns a function that can be used to generate URLs with cross-product interaction parameters.
+ *
+ * @param options - Properties object that contains the following parameters:
+ *
+ * @returns A function that appends interaction session ID and other cross-product interaction parameters to a given URL.
+ */
+export default function useCrossProductUrlWrapper(options: CrossProductUrlOptions): (url: string) => string;

package/package.json

@@ -0,0 +1,90 @@
+{
+	"atlassian": {
+		"team": "Atlassian Analytics Pipeline",
+		"website": {
+			"name": "AnalyticsCrossProduct",
+			"category": "Layout and structure"
+		}
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-monorepo",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <5.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": [
+		"*.compiled.css"
+	],
+	"dependencies": {
+		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@babel/runtime": "^7.0.0",
+		"@compiled/react": "^0.20.0",
+		"bind-event-listener": "^3.0.0"
+	},
+	"peerDependencies": {
+		"react": "^18.2.0"
+	},
+	"devDependencies": {
+		"@atlassian/feature-flags-test-utils": "^1.1.0",
+		"@testing-library/react": "^16.3.0",
+		"react-dom": "^18.2.0"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"code-structure": [
+				"tangerine-next"
+			],
+			"import-structure": [
+				"atlassian-conventions"
+			],
+			"circular-dependencies": [
+				"file-and-folder-level"
+			]
+		},
+		"@repo/internal": {
+			"dom-events": "use-bind-event-listener",
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color"
+			],
+			"theming": [
+				"react-context"
+			],
+			"ui-components": [
+				"lite-mode"
+			],
+			"deprecation": [
+				"no-deprecated-imports"
+			],
+			"styling": [
+				"static",
+				"compiled"
+			],
+			"imports": [
+				"import-no-extraneous-disable-for-examples-and-docs"
+			]
+		}
+	},
+	"name": "@atlaskit/analytics-cross-product",
+	"version": "1.0.0",
+	"description": "Utilities to enable cross-product interaction session tracking",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"platform-feature-flags": {
+		"atlaskit-analytics-cross-product": {
+			"type": "boolean"
+		}
+	}
+}