@atlaskit/link-picker 1.13.0 → 1.13.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/link-picker
 
+## 1.13.2
+
+### Patch Changes
+
+- Updated dependencies
+
+## 1.13.1
+
+### Patch Changes
+
+- [`2933e4ddeb0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2933e4ddeb0) - Add searchResults shown analytic event for pre-query and post-query results
+
 ## 1.13.0
 
 ### Minor Changes

package/dist/cjs/analytics.codegen.js

@@ -10,7 +10,7 @@ exports.default = void 0;
  *
  * Generates analytics utilities from the package analytics spec yaml
  *
- * @codegen <<SignedSource::c0fb3bb39f50f3a7c35ebd90e8903280>>
+ * @codegen <<SignedSource::758b8a20cae1b6d410cecd4493453a21>>
  * @codegenCommand yarn workspace @atlaskit/link-picker run codegen-analytics
  */
 function createEventPayload(eventKey, attributes) {

package/dist/cjs/common/analytics/context.js

@@ -132,8 +132,10 @@ function withLinkPickerAnalyticsContext(WrappedComponent) {
         getAttributes = _useLinkPickerAnalyti.getAttributes;
 
     var onEvent = (0, _react.useCallback)(function (event) {
+      var _event$payload$attrib;
+
       event.update({
-        attributes: getAttributes()
+        attributes: _objectSpread(_objectSpread({}, getAttributes()), (_event$payload$attrib = event.payload.attributes) !== null && _event$payload$attrib !== void 0 ? _event$payload$attrib : {})
       });
     }, [getAttributes]);
     return /*#__PURE__*/_react.default.createElement(_analyticsNext.AnalyticsListener, {

package/dist/cjs/ui/link-picker/index.js

@@ -194,12 +194,12 @@ function LinkPicker(_ref) {
     dispatch({
       url: e.currentTarget.value
     });
-  }, [trackAttribute]);
+  }, [dispatch, trackAttribute]);
   var handleChangeText = (0, _react.useCallback)(function (e) {
     dispatch({
       displayText: e.currentTarget.value
     });
-  }, []);
+  }, [dispatch]);
   var handleKeyDown = (0, _react.useCallback)(function (event) {
     var key = event.key;
     var KEY_ARROW_DOWN = 'ArrowDown';
@@ -241,10 +241,10 @@ function LinkPicker(_ref) {
         invalidUrl: false
       });
     }
-  }, [activeIndex, items, trackAttribute, activePlugin]);
+  }, [dispatch, activeIndex, items, trackAttribute, activePlugin]);
   var handleClear = (0, _react.useCallback)(function (field) {
     dispatch((0, _defineProperty2.default)({}, field, ''));
-  }, []);
+  }, [dispatch]);
   var handleUrlClear = (0, _react.useCallback)(function () {
     trackAttribute('linkFieldContentInputSource', null);
     handleClear('url');
@@ -256,7 +256,7 @@ function LinkPicker(_ref) {
     dispatch({
       activeIndex: index !== null && index !== void 0 ? index : -1
     });
-  }, [items]);
+  }, [dispatch, items]);
   var handleMouseLeaveResultItem = (0, _react.useCallback)(function (objectId) {
     var index = items === null || items === void 0 ? void 0 : items.findIndex(function (item) {
       return item.objectId === objectId;
@@ -267,7 +267,7 @@ function LinkPicker(_ref) {
         activeIndex: -1
       });
     }
-  }, [activeIndex, items]);
+  }, [dispatch, activeIndex, items]);
   var handleInsert = (0, _react.useCallback)(function (url, title, inputType) {
     var event = createAnalyticsEvent((0, _analytics.default)('ui.form.submitted.linkPicker', {})); // Clone the event so that it can be emitted for consumer usage
     // This must happen BEFORE the original event is fired!
@@ -326,7 +326,7 @@ function LinkPicker(_ref) {
     return dispatch({
       invalidUrl: true
     });
-  }, [handleInsert, isSelectedItem, selectedItem, url]);
+  }, [dispatch, handleInsert, isSelectedItem, selectedItem, url]);
   var handleTabChange = (0, _react.useCallback)(function (activeTab) {
     var _plugins$activeTab$ta, _plugins$activeTab;
 

package/dist/cjs/ui/link-picker/link-search-list/index.js

@@ -31,6 +31,8 @@ var _styled = require("./styled");
 
 var _linkSearchNoResults = _interopRequireWildcard(require("./link-search-no-results"));
 
+var _useTrackResultsShown = require("./use-track-results-shown");
+
 var _excluded = ["onSelect", "onMouseEnter", "onMouseLeave", "items", "activeIndex", "selectedIndex", "isLoading", "ariaControls", "ariaLabelledBy", "role", "id", "hasSearchTerm"];
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
@@ -85,6 +87,7 @@ var LinkSearchList = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var itemsContent;
   var loadingContent;
   var linkListTitle = hasSearchTerm ? messages.titleResults : messages.titleRecentlyViewed;
+  (0, _useTrackResultsShown.useTrackResultsShown)(isLoading, items, hasSearchTerm);
 
   if ((items === null || items === void 0 ? void 0 : items.length) === 0) {
     return (0, _react2.jsx)(_linkSearchNoResults.default, null);

package/dist/cjs/ui/link-picker/link-search-list/use-track-results-shown/index.js

@@ -0,0 +1,58 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useTrackResultsShown = void 0;
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _react = require("react");
+
+var _useDebounce3 = require("use-debounce");
+
+var _analyticsNext = require("@atlaskit/analytics-next");
+
+var _constants = require("../../../../common/constants");
+
+var _analytics = _interopRequireDefault(require("../../../../analytics.codegen"));
+
+var DEBOUNCE_MS = 400;
+
+var useTrackResultsShown = function useTrackResultsShown(isLoading, items, hasSearchTerm) {
+  var _useAnalyticsEvents = (0, _analyticsNext.useAnalyticsEvents)(),
+      createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+
+  var hasSearchTermRef = (0, _react.useRef)(hasSearchTerm); // Using ref so that not required in the dependency array
+  // Analytics should be entirely dependent on change of items being viewed
+
+  (0, _react.useEffect)(function () {
+    hasSearchTermRef.current = hasSearchTerm;
+  }, [hasSearchTerm]); // Filters isLoading/items to only return the array of items if no longer loading more items
+  // Loading state IS a factor here because some tabs will
+  // load intermediate results whilst loading additional results (Atlassian tab)
+  // Considered to only have "shown" results once we are in a final state (no longer loading)
+
+  var finalItems = (0, _react.useMemo)(function () {
+    return !isLoading ? items : null;
+  }, [isLoading, items]); // Because Atlassian tab resolves intermediate results on every keystroke (may never be loading)
+  // Debounce the items so that we only consider the results to have been shown
+  // after they have been stable for DEBOUNCE_MS
+
+  var _useDebounce = (0, _useDebounce3.useDebounce)(finalItems, DEBOUNCE_MS),
+      _useDebounce2 = (0, _slicedToArray2.default)(_useDebounce, 1),
+      debouncedItems = _useDebounce2[0];
+
+  (0, _react.useEffect)(function () {
+    if (debouncedItems) {
+      var event = !hasSearchTermRef.current ? 'ui.searchResults.shown.preQuerySearchResults' : 'ui.searchResults.shown.postQuerySearchResults';
+      createAnalyticsEvent((0, _analytics.default)(event, {
+        resultCount: debouncedItems.length
+      })).fire(_constants.ANALYTICS_CHANNEL);
+    }
+  }, [debouncedItems, createAnalyticsEvent]);
+};
+
+exports.useTrackResultsShown = useTrackResultsShown;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-picker",
-	"version": "1.13.0",
+	"version": "1.13.2",
 	"sideEffects": false
 }

package/dist/es2019/analytics.codegen.js

@@ -3,7 +3,7 @@
  *
  * Generates analytics utilities from the package analytics spec yaml
  *
- * @codegen <<SignedSource::c0fb3bb39f50f3a7c35ebd90e8903280>>
+ * @codegen <<SignedSource::758b8a20cae1b6d410cecd4493453a21>>
  * @codegenCommand yarn workspace @atlaskit/link-picker run codegen-analytics
  */
 function createEventPayload(eventKey, attributes) {

package/dist/es2019/common/analytics/context.js

@@ -90,8 +90,12 @@ export function withLinkPickerAnalyticsContext(WrappedComponent) {
       getAttributes
     } = useLinkPickerAnalytics();
     const onEvent = useCallback(event => {
+      var _event$payload$attrib;
+
       event.update({
-        attributes: getAttributes()
+        attributes: { ...getAttributes(),
+          ...((_event$payload$attrib = event.payload.attributes) !== null && _event$payload$attrib !== void 0 ? _event$payload$attrib : {})
+        }
       });
     }, [getAttributes]);
     return /*#__PURE__*/React.createElement(AnalyticsListener, {

package/dist/es2019/ui/link-picker/index.js

@@ -138,12 +138,12 @@ function LinkPicker({
     dispatch({
       url: e.currentTarget.value
     });
-  }, [trackAttribute]);
+  }, [dispatch, trackAttribute]);
   const handleChangeText = useCallback(e => {
     dispatch({
       displayText: e.currentTarget.value
     });
-  }, []);
+  }, [dispatch]);
   const handleKeyDown = useCallback(event => {
     const {
       key
@@ -187,12 +187,12 @@ function LinkPicker({
         invalidUrl: false
       });
     }
-  }, [activeIndex, items, trackAttribute, activePlugin]);
+  }, [dispatch, activeIndex, items, trackAttribute, activePlugin]);
   const handleClear = useCallback(field => {
     dispatch({
       [field]: ''
     });
-  }, []);
+  }, [dispatch]);
   const handleUrlClear = useCallback(() => {
     trackAttribute('linkFieldContentInputSource', null);
     handleClear('url');
@@ -202,7 +202,7 @@ function LinkPicker({
     dispatch({
       activeIndex: index !== null && index !== void 0 ? index : -1
     });
-  }, [items]);
+  }, [dispatch, items]);
   const handleMouseLeaveResultItem = useCallback(objectId => {
     const index = items === null || items === void 0 ? void 0 : items.findIndex(item => item.objectId === objectId); // This is to avoid updating index that was set by other mouseenter event
 
@@ -211,7 +211,7 @@ function LinkPicker({
         activeIndex: -1
       });
     }
-  }, [activeIndex, items]);
+  }, [dispatch, activeIndex, items]);
   const handleInsert = useCallback((url, title, inputType) => {
     const event = createAnalyticsEvent(createEventPayload('ui.form.submitted.linkPicker', {})); // Clone the event so that it can be emitted for consumer usage
     // This must happen BEFORE the original event is fired!
@@ -271,7 +271,7 @@ function LinkPicker({
     return dispatch({
       invalidUrl: true
     });
-  }, [handleInsert, isSelectedItem, selectedItem, url]);
+  }, [dispatch, handleInsert, isSelectedItem, selectedItem, url]);
   const handleTabChange = useCallback(activeTab => {
     var _plugins$activeTab$ta, _plugins$activeTab;
 

package/dist/es2019/ui/link-picker/link-search-list/index.js

@@ -9,6 +9,7 @@ import VisuallyHidden from '@atlaskit/visually-hidden';
 import LinkSearchListItem from '../list-item';
 import { listContainerStyles, spinnerContainerStyles, listStyles, listTitleStyles } from './styled';
 import LinkSearchNoResults, { testIds as noResultsTestIds } from './link-search-no-results';
+import { useTrackResultsShown } from './use-track-results-shown';
 export const messages = defineMessages({
   titleRecentlyViewed: {
     id: 'fabric.linkPicker.listTitle.recentlyViewed',
@@ -50,6 +51,7 @@ const LinkSearchList = /*#__PURE__*/forwardRef(({
   let itemsContent;
   let loadingContent;
   const linkListTitle = hasSearchTerm ? messages.titleResults : messages.titleRecentlyViewed;
+  useTrackResultsShown(isLoading, items, hasSearchTerm);
 
   if ((items === null || items === void 0 ? void 0 : items.length) === 0) {
     return jsx(LinkSearchNoResults, null);

package/dist/es2019/ui/link-picker/link-search-list/use-track-results-shown/index.js

@@ -0,0 +1,34 @@
+import { useEffect, useMemo, useRef } from 'react';
+import { useDebounce } from 'use-debounce';
+import { useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { ANALYTICS_CHANNEL } from '../../../../common/constants';
+import createEventPayload from '../../../../analytics.codegen';
+const DEBOUNCE_MS = 400;
+export const useTrackResultsShown = (isLoading, items, hasSearchTerm) => {
+  const {
+    createAnalyticsEvent
+  } = useAnalyticsEvents();
+  const hasSearchTermRef = useRef(hasSearchTerm); // Using ref so that not required in the dependency array
+  // Analytics should be entirely dependent on change of items being viewed
+
+  useEffect(() => {
+    hasSearchTermRef.current = hasSearchTerm;
+  }, [hasSearchTerm]); // Filters isLoading/items to only return the array of items if no longer loading more items
+  // Loading state IS a factor here because some tabs will
+  // load intermediate results whilst loading additional results (Atlassian tab)
+  // Considered to only have "shown" results once we are in a final state (no longer loading)
+
+  const finalItems = useMemo(() => !isLoading ? items : null, [isLoading, items]); // Because Atlassian tab resolves intermediate results on every keystroke (may never be loading)
+  // Debounce the items so that we only consider the results to have been shown
+  // after they have been stable for DEBOUNCE_MS
+
+  const [debouncedItems] = useDebounce(finalItems, DEBOUNCE_MS);
+  useEffect(() => {
+    if (debouncedItems) {
+      const event = !hasSearchTermRef.current ? 'ui.searchResults.shown.preQuerySearchResults' : 'ui.searchResults.shown.postQuerySearchResults';
+      createAnalyticsEvent(createEventPayload(event, {
+        resultCount: debouncedItems.length
+      })).fire(ANALYTICS_CHANNEL);
+    }
+  }, [debouncedItems, createAnalyticsEvent]);
+};

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-picker",
-	"version": "1.13.0",
+	"version": "1.13.2",
 	"sideEffects": false
 }

package/dist/esm/analytics.codegen.js

@@ -3,7 +3,7 @@
  *
  * Generates analytics utilities from the package analytics spec yaml
  *
- * @codegen <<SignedSource::c0fb3bb39f50f3a7c35ebd90e8903280>>
+ * @codegen <<SignedSource::758b8a20cae1b6d410cecd4493453a21>>
  * @codegenCommand yarn workspace @atlaskit/link-picker run codegen-analytics
  */
 function createEventPayload(eventKey, attributes) {

package/dist/esm/common/analytics/context.js

@@ -105,8 +105,10 @@ export function withLinkPickerAnalyticsContext(WrappedComponent) {
         getAttributes = _useLinkPickerAnalyti.getAttributes;
 
     var onEvent = useCallback(function (event) {
+      var _event$payload$attrib;
+
       event.update({
-        attributes: getAttributes()
+        attributes: _objectSpread(_objectSpread({}, getAttributes()), (_event$payload$attrib = event.payload.attributes) !== null && _event$payload$attrib !== void 0 ? _event$payload$attrib : {})
       });
     }, [getAttributes]);
     return /*#__PURE__*/React.createElement(AnalyticsListener, {

package/dist/esm/ui/link-picker/index.js

@@ -146,12 +146,12 @@ function LinkPicker(_ref) {
     dispatch({
       url: e.currentTarget.value
     });
-  }, [trackAttribute]);
+  }, [dispatch, trackAttribute]);
   var handleChangeText = useCallback(function (e) {
     dispatch({
       displayText: e.currentTarget.value
     });
-  }, []);
+  }, [dispatch]);
   var handleKeyDown = useCallback(function (event) {
     var key = event.key;
     var KEY_ARROW_DOWN = 'ArrowDown';
@@ -193,10 +193,10 @@ function LinkPicker(_ref) {
         invalidUrl: false
       });
     }
-  }, [activeIndex, items, trackAttribute, activePlugin]);
+  }, [dispatch, activeIndex, items, trackAttribute, activePlugin]);
   var handleClear = useCallback(function (field) {
     dispatch(_defineProperty({}, field, ''));
-  }, []);
+  }, [dispatch]);
   var handleUrlClear = useCallback(function () {
     trackAttribute('linkFieldContentInputSource', null);
     handleClear('url');
@@ -208,7 +208,7 @@ function LinkPicker(_ref) {
     dispatch({
       activeIndex: index !== null && index !== void 0 ? index : -1
     });
-  }, [items]);
+  }, [dispatch, items]);
   var handleMouseLeaveResultItem = useCallback(function (objectId) {
     var index = items === null || items === void 0 ? void 0 : items.findIndex(function (item) {
       return item.objectId === objectId;
@@ -219,7 +219,7 @@ function LinkPicker(_ref) {
         activeIndex: -1
       });
     }
-  }, [activeIndex, items]);
+  }, [dispatch, activeIndex, items]);
   var handleInsert = useCallback(function (url, title, inputType) {
     var event = createAnalyticsEvent(createEventPayload('ui.form.submitted.linkPicker', {})); // Clone the event so that it can be emitted for consumer usage
     // This must happen BEFORE the original event is fired!
@@ -278,7 +278,7 @@ function LinkPicker(_ref) {
     return dispatch({
       invalidUrl: true
     });
-  }, [handleInsert, isSelectedItem, selectedItem, url]);
+  }, [dispatch, handleInsert, isSelectedItem, selectedItem, url]);
   var handleTabChange = useCallback(function (activeTab) {
     var _plugins$activeTab$ta, _plugins$activeTab;
 

package/dist/esm/ui/link-picker/link-search-list/index.js

@@ -16,6 +16,7 @@ import VisuallyHidden from '@atlaskit/visually-hidden';
 import LinkSearchListItem from '../list-item';
 import { listContainerStyles, spinnerContainerStyles, listStyles, listTitleStyles } from './styled';
 import LinkSearchNoResults, { testIds as noResultsTestIds } from './link-search-no-results';
+import { useTrackResultsShown } from './use-track-results-shown';
 export var messages = defineMessages({
   titleRecentlyViewed: {
     id: 'fabric.linkPicker.listTitle.recentlyViewed',
@@ -57,6 +58,7 @@ var LinkSearchList = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var itemsContent;
   var loadingContent;
   var linkListTitle = hasSearchTerm ? messages.titleResults : messages.titleRecentlyViewed;
+  useTrackResultsShown(isLoading, items, hasSearchTerm);
 
   if ((items === null || items === void 0 ? void 0 : items.length) === 0) {
     return jsx(LinkSearchNoResults, null);

package/dist/esm/ui/link-picker/link-search-list/use-track-results-shown/index.js

@@ -0,0 +1,40 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { useEffect, useMemo, useRef } from 'react';
+import { useDebounce } from 'use-debounce';
+import { useAnalyticsEvents } from '@atlaskit/analytics-next';
+import { ANALYTICS_CHANNEL } from '../../../../common/constants';
+import createEventPayload from '../../../../analytics.codegen';
+var DEBOUNCE_MS = 400;
+export var useTrackResultsShown = function useTrackResultsShown(isLoading, items, hasSearchTerm) {
+  var _useAnalyticsEvents = useAnalyticsEvents(),
+      createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+
+  var hasSearchTermRef = useRef(hasSearchTerm); // Using ref so that not required in the dependency array
+  // Analytics should be entirely dependent on change of items being viewed
+
+  useEffect(function () {
+    hasSearchTermRef.current = hasSearchTerm;
+  }, [hasSearchTerm]); // Filters isLoading/items to only return the array of items if no longer loading more items
+  // Loading state IS a factor here because some tabs will
+  // load intermediate results whilst loading additional results (Atlassian tab)
+  // Considered to only have "shown" results once we are in a final state (no longer loading)
+
+  var finalItems = useMemo(function () {
+    return !isLoading ? items : null;
+  }, [isLoading, items]); // Because Atlassian tab resolves intermediate results on every keystroke (may never be loading)
+  // Debounce the items so that we only consider the results to have been shown
+  // after they have been stable for DEBOUNCE_MS
+
+  var _useDebounce = useDebounce(finalItems, DEBOUNCE_MS),
+      _useDebounce2 = _slicedToArray(_useDebounce, 1),
+      debouncedItems = _useDebounce2[0];
+
+  useEffect(function () {
+    if (debouncedItems) {
+      var event = !hasSearchTermRef.current ? 'ui.searchResults.shown.preQuerySearchResults' : 'ui.searchResults.shown.postQuerySearchResults';
+      createAnalyticsEvent(createEventPayload(event, {
+        resultCount: debouncedItems.length
+      })).fire(ANALYTICS_CHANNEL);
+    }
+  }, [debouncedItems, createAnalyticsEvent]);
+};

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/link-picker",
-	"version": "1.13.0",
+	"version": "1.13.2",
 	"sideEffects": false
 }

package/dist/types/analytics.codegen.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates analytics utilities from the package analytics spec yaml
  *
- * @codegen <<SignedSource::c0fb3bb39f50f3a7c35ebd90e8903280>>
+ * @codegen <<SignedSource::758b8a20cae1b6d410cecd4493453a21>>
  * @codegenCommand yarn workspace @atlaskit/link-picker run codegen-analytics
  */
 export declare type PackageMetaDataType = {
@@ -32,6 +32,12 @@ export declare type LinkPickerUnhandledErrorCaughtAttributesType = {
     error: string;
     componentStack: string | null;
 };
+export declare type SearchResultsShownPreQuerySearchResultsAttributesType = {
+    resultCount: number;
+};
+export declare type SearchResultsShownPostQuerySearchResultsAttributesType = {
+    resultCount: number;
+};
 export declare type ResultsResolveFailedAttributesType = {
     error: string;
 };
@@ -43,6 +49,8 @@ declare type AnalyticsEventAttributes = {
     'ui.textField.updated.displayTextField': TextFieldUpdatedDisplayTextFieldAttributesType;
     'ui.tab.viewed': TabViewedAttributesType;
     'ui.linkPicker.unhandledErrorCaught': LinkPickerUnhandledErrorCaughtAttributesType;
+    'ui.searchResults.shown.preQuerySearchResults': SearchResultsShownPreQuerySearchResultsAttributesType;
+    'ui.searchResults.shown.postQuerySearchResults': SearchResultsShownPostQuerySearchResultsAttributesType;
     'operational.resultsResolve.failed': ResultsResolveFailedAttributesType;
 };
 declare function createEventPayload<K extends keyof AnalyticsEventAttributes>(eventKey: K, attributes: AnalyticsEventAttributes[K]): {

package/dist/types/common/analytics/context.d.ts

@@ -1,6 +1,7 @@
 import React from 'react';
 import { LinkPickerAnalyticsContextType } from '../../analytics.codegen';
-export declare type TrackAttribute = <K extends keyof LinkPickerAnalyticsContextType>(attribute: K, value: LinkPickerAnalyticsContextType[K]) => void;
+declare type AnalyticsContextAttributesType = LinkPickerAnalyticsContextType;
+export declare type TrackAttribute = <K extends keyof LinkPickerAnalyticsContextType>(attribute: K, value: AnalyticsContextAttributesType[K]) => void;
 interface AnalyticsContextType {
     /**
      * Update a single attribute in the analytics context

package/dist/types/ui/link-picker/link-search-list/use-track-results-shown/index.d.ts

@@ -0,0 +1,2 @@
+import { LinkSearchListItemData } from '../../../types';
+export declare const useTrackResultsShown: (isLoading: boolean, items?: LinkSearchListItemData[] | null | undefined, hasSearchTerm?: boolean | undefined) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-picker",
-  "version": "1.13.0",
+  "version": "1.13.2",
   "description": "Standalone link picker",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
@@ -20,14 +20,6 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
-  "typesVersions": {
-    ">=4.0 <4.5": {
-      "*": [
-        "dist/types-ts4.0/*",
-        "dist/types-ts4.0/index.d.ts"
-      ]
-    }
-  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "af:exports": {
@@ -43,13 +35,13 @@
     "@atlaskit/button": "^16.4.0",
     "@atlaskit/empty-state": "^7.4.0",
     "@atlaskit/form": "^8.7.0",
-    "@atlaskit/frontend-utilities": "^2.0.0",
+    "@atlaskit/frontend-utilities": "^2.1.0",
     "@atlaskit/icon": "^21.11.0",
     "@atlaskit/spinner": "^15.2.0",
     "@atlaskit/tabs": "^13.3.0",
     "@atlaskit/textfield": "^5.3.0",
     "@atlaskit/theme": "^12.2.0",
-    "@atlaskit/tokens": "^0.10.0",
+    "@atlaskit/tokens": "^0.11.0",
     "@atlaskit/tooltip": "^17.6.0",
     "@atlaskit/ufo": "^0.1.0",
     "@atlaskit/visually-hidden": "^1.1.0",
@@ -59,6 +51,7 @@
     "date-fns": "^2.17.0",
     "linkify-it": "^2.0.3",
     "react-loosely-lazy": "^1.0.0",
+    "use-debounce": "^3.4.0",
     "uuid": "^3.1.0"
   },
   "peerDependencies": {
@@ -81,7 +74,7 @@
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "@atlassian/link-picker-atlassian-plugin": "^23.0.0",
-    "@atlassian/link-picker-plugins": "^11.0.0",
+    "@atlassian/link-picker-plugins": "^11.1.0",
     "@atlassian/recent-work-client": "^1.6.0",
     "@atlassian/search-provider": "^2.3.0",
     "@testing-library/dom": "^8.17.1",
@@ -97,7 +90,7 @@
     "lodash": "^4.17.21",
     "mockdate": "^3.0.2",
     "node-fetch": "^2.6.7",
-    "prettier": "^2.1.1",
+    "prettier": "^2.7.0",
     "react-dom": "^16.8.0",
     "sinon": "^2.2.0",
     "typescript": "4.5.5"

package/report.api.md

@@ -25,9 +25,9 @@ import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 export type LinkInputType = 'manual' | 'typeAhead';
 
 // @public (undocumented)
-export const LinkPicker: React_2.MemoExoticComponent<(
-  props: LinkPickerProps,
-) => JSX.Element>;
+export const LinkPicker: React_2.MemoExoticComponent<
+  (props: LinkPickerProps) => JSX.Element
+>;
 
 // @public (undocumented)
 export interface LinkPickerPlugin {

package/dist/types-ts4.0/analytics.codegen.d.ts

@@ -1,55 +0,0 @@
-/**
- * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- *
- * Generates analytics utilities from the package analytics spec yaml
- *
- * @codegen <<SignedSource::c0fb3bb39f50f3a7c35ebd90e8903280>>
- * @codegenCommand yarn workspace @atlaskit/link-picker run codegen-analytics
- */
-export declare type PackageMetaDataType = {
-    packageName: '@atlaskit/link-picker';
-    packageVersion: string;
-    source: 'linkPicker';
-    componentName: 'linkPicker';
-};
-export declare type LinkPickerAnalyticsContextType = {
-    linkState: 'editLink' | 'newLink';
-    linkFieldContent: 'url' | 'text_string' | null;
-    linkFieldContentInputMethod: 'manual' | 'paste' | 'searchResult' | null;
-    linkFieldContentInputSource: string | null;
-    displayTextFieldContent: 'text_string' | null;
-    displayTextFieldContentInputMethod: 'manual' | 'paste' | null;
-    tab: string | null;
-};
-export declare type FormSubmittedLinkPickerAttributesType = {};
-export declare type InlineDialogViewedLinkPickerAttributesType = {};
-export declare type InlineDialogClosedLinkPickerAttributesType = {};
-export declare type TextFieldUpdatedLinkFieldAttributesType = {};
-export declare type TextFieldUpdatedDisplayTextFieldAttributesType = {};
-export declare type TabViewedAttributesType = {};
-export declare type LinkPickerUnhandledErrorCaughtAttributesType = {
-    browserInfo: string;
-    error: string;
-    componentStack: string | null;
-};
-export declare type ResultsResolveFailedAttributesType = {
-    error: string;
-};
-declare type AnalyticsEventAttributes = {
-    'ui.form.submitted.linkPicker': FormSubmittedLinkPickerAttributesType;
-    'ui.inlineDialog.viewed.linkPicker': InlineDialogViewedLinkPickerAttributesType;
-    'ui.inlineDialog.closed.linkPicker': InlineDialogClosedLinkPickerAttributesType;
-    'ui.textField.updated.linkField': TextFieldUpdatedLinkFieldAttributesType;
-    'ui.textField.updated.displayTextField': TextFieldUpdatedDisplayTextFieldAttributesType;
-    'ui.tab.viewed': TabViewedAttributesType;
-    'ui.linkPicker.unhandledErrorCaught': LinkPickerUnhandledErrorCaughtAttributesType;
-    'operational.resultsResolve.failed': ResultsResolveFailedAttributesType;
-};
-declare function createEventPayload<K extends keyof AnalyticsEventAttributes>(eventKey: K, attributes: AnalyticsEventAttributes[K]): {
-    eventType: string;
-    actionSubject: string;
-    action: string;
-    actionSubjectId: string;
-    attributes: AnalyticsEventAttributes[K];
-};
-export default createEventPayload;