@atlaskit/link-picker 1.6.1 → 1.7.0

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

@@ -0,0 +1,14 @@
+import _extends from "@babel/runtime/helpers/extends";
+import React from 'react';
+import EmptyState from '@atlaskit/empty-state';
+import GenericErrorSVG from '../../../common/generic-error-svg';
+
+var LinkSearchError = function LinkSearchError(props) {
+  return /*#__PURE__*/React.createElement(EmptyState, _extends({}, props, {
+    renderImage: function renderImage() {
+      return /*#__PURE__*/React.createElement(GenericErrorSVG, null);
+    }
+  }));
+};
+
+export default LinkSearchError;

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

@@ -104,5 +104,15 @@ export var messages = defineMessages({
     id: 'fabric.linkPicker.button.save',
     defaultMessage: 'Save',
     description: 'Button to save edited link'
+  },
+  searchErrorHeader: {
+    id: 'fabric.linkPicker.search.error.heading',
+    defaultMessage: 'We’re having trouble loading data.',
+    description: 'Heading message shown when a search throws an error'
+  },
+  searchErrorDescription: {
+    id: 'fabric.linkPicker.search.error.description',
+    defaultMessage: 'Refresh the page, or contact <a>Atlassian Support</a> if this keeps happening.',
+    description: 'Describes possible actions when search throws an error'
   }
 });

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

@@ -64,11 +64,6 @@ var linkifyMatch = function linkifyMatch(text) {
 
 export var isSafeUrl = function isSafeUrl(url) {
   var urlTrimmed = url.trim();
-
-  if (urlTrimmed.length === 0) {
-    return true;
-  }
-
   return whitelistedURLPatterns.some(function (p) {
     return p.test(urlTrimmed);
   });

package/dist/esm/version.json

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

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
 export { ComposedLinkPicker as LinkPicker } from './ui';
 export type { LinkPickerProps } from './ui/link-picker';
-export type { LinkInputType, LinkPickerPlugin, LinkPickerState, LinkSearchListItemData, } from './ui/types';
+export type { LinkInputType, LinkPickerPlugin, LinkPickerState, LinkSearchListItemData, LinkPickerPluginErrorFallback, } from './ui/types';

package/dist/types/services/use-plugins/index.d.ts

@@ -1,12 +1,13 @@
-import { PickerState } from '../../ui/link-picker';
-import { LinkPickerPlugin, LinkSearchListItemData } from '../../ui/types';
+import { LinkPickerPlugin, LinkPickerPluginErrorFallback, LinkPickerState, LinkSearchListItemData } from '../../ui/types';
 export interface LinkPickerPluginsService {
-    items: LinkSearchListItemData[];
+    items: LinkSearchListItemData[] | null;
     isLoading: boolean;
-    isSelectedItem: boolean;
     isActivePlugin: boolean;
     tabs: {
         tabTitle: string;
     }[];
+    error: unknown | null;
+    retry: () => void;
+    errorFallback?: LinkPickerPluginErrorFallback;
 }
-export declare function usePlugins(state: PickerState, plugins?: LinkPickerPlugin[]): LinkPickerPluginsService;
+export declare function usePlugins(state: LinkPickerState | null, activeTab: number, plugins?: LinkPickerPlugin[]): LinkPickerPluginsService;

package/dist/types/services/use-search-query/index.d.ts

@@ -0,0 +1,3 @@
+import { LinkPickerState } from '../../ui/types';
+import { PickerState } from '../../ui/link-picker';
+export declare function useSearchQuery(state: PickerState): LinkPickerState | null;

package/dist/types/ui/link-picker/index.d.ts

@@ -1,6 +1,7 @@
 import { jsx } from '@emotion/react';
 import { LinkInputType, LinkPickerPlugin } from '../types';
 export declare const RECENT_SEARCH_LIST_SIZE = 5;
+export declare const CONTACT_SUPPORT_LINK = "https://support.atlassian.com/contact/";
 export declare const testIds: {
     linkPicker: string;
     urlInputField: string;
@@ -17,6 +18,7 @@ export declare const testIds: {
     urlError: string;
     tabList: string;
     tabItem: string;
+    searchError: string;
 };
 interface Meta {
     /** Indicates how the link was picked. */

package/dist/types/ui/link-picker/link-search-error/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { EmptyStateProps } from '@atlaskit/empty-state';
+declare const LinkSearchError: (props: EmptyStateProps) => JSX.Element;
+export default LinkSearchError;

package/dist/types/ui/link-picker/messages.d.ts

@@ -104,4 +104,14 @@ export declare const messages: {
         defaultMessage: string;
         description: string;
     };
+    searchErrorHeader: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    searchErrorDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
 };

package/dist/types/ui/types.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="react" />
+import { ReactNode } from 'react';
 import { MessageDescriptor } from 'react-intl-next';
 export declare type LinkInputType = 'manual' | 'typeAhead';
 export interface LinkSearchListItemData {
@@ -36,9 +36,12 @@ export interface ResolveResult {
     data: LinkSearchListItemData[];
 }
 export interface LinkPickerPlugin {
+    resolve: (state: LinkPickerState) => Promise<ResolveResult> | AsyncGenerator<ResolveResult, ResolveResult>;
     /** Uniquely identify the tab */
     tabKey?: string;
     /** Human-readable label for the plugin */
     tabTitle?: string;
-    resolve: (state: LinkPickerState) => Promise<ResolveResult> | AsyncGenerator<ResolveResult, ResolveResult>;
+    /** Render function to customise the UI that is displayed when an error occurs resolving results */
+    errorFallback?: LinkPickerPluginErrorFallback;
 }
+export declare type LinkPickerPluginErrorFallback = (error: unknown, retry: () => void) => ReactNode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-picker",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "Standalone link picker",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
@@ -54,15 +54,15 @@
   "devDependencies": {
     "@atlaskit/activity-provider": "^2.3.2",
     "@atlaskit/docs": "*",
-    "@atlaskit/link-test-helpers": "^1.3.0",
+    "@atlaskit/link-test-helpers": "^1.4.0",
     "@atlaskit/popup": "^1.4.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/toggle": "^12.4.0",
     "@atlaskit/visual-regression": "*",
     "@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": "^16.0.0",
-    "@atlassian/link-picker-plugins": "^3.0.0",
+    "@atlassian/link-picker-atlassian-plugin": "^17.0.0",
+    "@atlassian/link-picker-plugins": "^4.0.0",
     "@atlassian/search-provider": "^2.3.0",
     "@testing-library/dom": "^7.7.3",
     "@testing-library/jest-dom": "^4.1.0",

package/report.api.md

@@ -5,10 +5,9 @@
 [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ```ts
-/// <reference types="react" />
-
 import { MessageDescriptor } from 'react-intl-next';
 import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
 
 export declare type LinkInputType = 'manual' | 'typeAhead';
 
@@ -17,15 +16,22 @@ export declare const LinkPicker: React_2.MemoExoticComponent<(
 ) => JSX.Element>;
 
 export declare interface LinkPickerPlugin {
+  resolve: (
+    state: LinkPickerState,
+  ) => Promise<ResolveResult> | AsyncGenerator<ResolveResult, ResolveResult>;
   /** Uniquely identify the tab */
   tabKey?: string;
   /** Human-readable label for the plugin */
   tabTitle?: string;
-  resolve: (
-    state: LinkPickerState,
-  ) => Promise<ResolveResult> | AsyncGenerator<ResolveResult, ResolveResult>;
+  /** Render function to customise the UI that is displayed when an error occurs resolving results */
+  errorFallback?: LinkPickerPluginErrorFallback;
 }
 
+export declare type LinkPickerPluginErrorFallback = (
+  error: unknown,
+  retry: () => void,
+) => ReactNode;
+
 export declare interface LinkPickerProps {
   /** Callback to fire on form submission. */
   onSubmit: (arg: OnSubmitParameter) => void;