@atlaskit/link-picker 1.10.1 → 1.10.3

package/dist/types-ts4.0/ui/link-picker/browser.d.ts

@@ -0,0 +1,15 @@
+declare const result: {
+    mac: boolean;
+    ie: boolean;
+    ie_version: number;
+    gecko: boolean;
+    chrome: boolean;
+    chrome_version: number;
+    android: boolean;
+    ios: boolean;
+    webkit: boolean;
+    safari: boolean;
+    supportsIntersectionObserver: boolean;
+    supportsResizeObserver: boolean;
+};
+export { result as browser };

package/dist/types-ts4.0/ui/link-picker/form-footer/index.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+export declare const testIds: {
+    readonly insertButton: "link-picker-insert-button";
+    readonly cancelButton: "link-picker-cancel-button";
+};
+interface FormFooterProps extends React.HTMLAttributes<HTMLElement> {
+    isEditing?: boolean;
+    onCancel?: () => void;
+}
+declare const _default: import("react").MemoExoticComponent<({ isEditing, onCancel, ...restProps }: FormFooterProps) => jsx.JSX.Element>;
+export default _default;

package/dist/types-ts4.0/ui/link-picker/form-footer/styled.d.ts

@@ -0,0 +1 @@
+export declare const formFooterStyles: import("@emotion/react").SerializedStyles;

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

@@ -0,0 +1,69 @@
+/// <reference types="react" />
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { LinkInputType, LinkPickerPlugin } from '../types';
+export declare const RECENT_SEARCH_LIST_SIZE = 5;
+export declare const testIds: {
+    readonly clearUrlButton: "clear-text";
+    readonly urlError: "link-error";
+    readonly tabList: "link-picker-tabs";
+    readonly tabItem: "link-picker-tab";
+    readonly resultListTitle: string;
+    readonly searchResultItem: string;
+    readonly searchResultList: string;
+    readonly searchResultLoadingIndicator: string;
+    readonly emptyResultPage: string;
+    readonly searchError: string;
+    readonly insertButton: "link-picker-insert-button";
+    readonly cancelButton: "link-picker-cancel-button";
+    readonly linkPicker: "link-picker";
+    readonly urlInputField: "link-url";
+    readonly textInputField: "link-text";
+    readonly searchIcon: "link-picker-search-icon";
+};
+interface Meta {
+    /** Indicates how the link was picked. */
+    inputMethod: LinkInputType;
+}
+interface OnSubmitParameter {
+    /** The `url` of the linked resource. */
+    url: string;
+    /** The desired text to be displayed alternatively to the title of the linked resource. */
+    displayText: string | null;
+    /** The resolved `title` of the resource at the time of link picking (if applicable, null if not known). */
+    title: string | null;
+    /** Meta data about the link picking submission. */
+    meta: Meta;
+    /**
+     * The input value of the `url` field at time of submission if inserted "manually".
+     * This can useful if the `url` was manually inserted with a value that is different from the normalised value returned as `url`.
+     * @example
+     * { url: 'https://google.com', rawUrl: 'google.com' }
+     */
+    rawUrl?: string;
+}
+export interface LinkPickerProps {
+    /**
+     * Callback to fire on form submission.
+     */
+    onSubmit: (arg: OnSubmitParameter, analytic?: UIAnalyticsEvent | null) => void;
+    /** Callback to fire when the cancel button is clicked. */
+    onCancel: () => void;
+    /** Callback to fire when content is changed inside the link picker e.g. items, when loading, tabs */
+    onContentResize?: () => void;
+    /** The url of the linked resource for editing. */
+    url?: string;
+    /** The desired text to be displayed alternatively to the title of the linked resource for editing. */
+    displayText?: string | null;
+    /** Plugins that provide link suggestions / search capabilities. */
+    plugins?: LinkPickerPlugin[];
+}
+export interface PickerState {
+    selectedIndex: number;
+    activeIndex: number;
+    url: string;
+    displayText: string;
+    invalidUrl: boolean;
+    activeTab: number;
+}
+declare const _default: import("react").ComponentType<LinkPickerProps>;
+export default _default;

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

@@ -0,0 +1,20 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+export declare const CONTACT_SUPPORT_LINK = "https://support.atlassian.com/contact/";
+export declare const messages: {
+    searchErrorHeader: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    searchErrorDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export declare const testIds: {
+    searchError: string;
+};
+declare const LinkSearchError: () => jsx.JSX.Element;
+export default LinkSearchError;

package/dist/types-ts4.0/ui/link-picker/link-search-list/index.d.ts

@@ -0,0 +1,43 @@
+/// <reference types="react" />
+import { LinkSearchListItemData } from '../../types';
+export declare const messages: {
+    titleRecentlyViewed: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    titleResults: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    searchLinkResults: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export declare const testIds: {
+    resultListTitle: string;
+    searchResultItem: string;
+    searchResultList: string;
+    searchResultLoadingIndicator: string;
+    emptyResultPage: string;
+};
+export interface LinkSearchListProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'onSelect' | 'onMouseEnter' | 'onMouseLeave'> {
+    items?: LinkSearchListItemData[] | null;
+    isLoading: boolean;
+    selectedIndex: number;
+    activeIndex: number;
+    onSelect: (objectId: string) => void;
+    onMouseEnter: (objectId: string) => void;
+    onMouseLeave: (objectId: string) => void;
+    ariaControls?: string;
+    ariaLabelledBy?: string;
+    role?: string;
+    id?: string;
+    error?: unknown;
+    hasSearchTerm?: boolean;
+}
+declare const LinkSearchList: import("react").ForwardRefExoticComponent<LinkSearchListProps & import("react").RefAttributes<HTMLDivElement>>;
+export default LinkSearchList;

package/dist/types-ts4.0/ui/link-picker/link-search-list/link-search-no-results/index.d.ts

@@ -0,0 +1,19 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+export declare const messages: {
+    noResults: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    noResultsDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export declare const testIds: {
+    emptyResultPage: string;
+};
+declare const NoResults: () => jsx.JSX.Element;
+export default NoResults;

package/dist/types-ts4.0/ui/link-picker/link-search-list/link-search-no-results/no-results-svg/index.d.ts

@@ -0,0 +1,4 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+declare const NoResultsSVG: () => jsx.JSX.Element;
+export default NoResultsSVG;

package/dist/types-ts4.0/ui/link-picker/link-search-list/link-search-no-results/no-results-svg/styled.d.ts

@@ -0,0 +1 @@
+export declare const noResultsSVGStyles: import("@emotion/react").SerializedStyles;

package/dist/types-ts4.0/ui/link-picker/link-search-list/link-search-no-results/styled.d.ts

@@ -0,0 +1 @@
+export declare const emptyStateWrapperStyles: import("@emotion/react").SerializedStyles;

package/dist/types-ts4.0/ui/link-picker/link-search-list/styled.d.ts

@@ -0,0 +1,4 @@
+export declare const listContainerStyles: import("@emotion/react").SerializedStyles;
+export declare const spinnerContainerStyles: import("@emotion/react").SerializedStyles;
+export declare const listStyles: import("@emotion/react").SerializedStyles;
+export declare const listTitleStyles: import("@emotion/react").SerializedStyles;

package/dist/types-ts4.0/ui/link-picker/list-item/index.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="react" />
+import { WrappedComponentProps } from 'react-intl-next';
+import { LinkSearchListItemData } from '../../types';
+export interface Props {
+    item: LinkSearchListItemData;
+    selected: boolean;
+    active: boolean;
+    onSelect: (objectId: string) => void;
+    onMouseEnter: (objectId: string) => void;
+    onMouseLeave: (objectId: string) => void;
+    id?: string;
+    role?: string;
+}
+declare const _default: import("react").FC<import("react-intl-next").WithIntlProps<WrappedComponentProps<"intl"> & Props>> & {
+    WrappedComponent: import("react").ComponentType<WrappedComponentProps<"intl"> & Props>;
+};
+export default _default;

package/dist/types-ts4.0/ui/link-picker/list-item/styled.d.ts

@@ -0,0 +1,9 @@
+export declare const relativeFontSizeToBase16: (px: number | string) => string;
+export declare const composeListItemStyles: (active?: boolean, selected?: boolean) => import("@emotion/react").SerializedStyles;
+export declare const itemNameStyles: import("@emotion/react").SerializedStyles;
+export declare const listItemNameStyles: import("@emotion/react").SerializedStyles;
+export declare const listItemContextStyles: import("@emotion/react").SerializedStyles;
+export declare const listItemContainerStyles: import("@emotion/react").SerializedStyles;
+export declare const listItemContainerInnerStyles: import("@emotion/react").SerializedStyles;
+export declare const itemIconStyles: import("@emotion/react").SerializedStyles;
+export declare const imgStyles: import("@emotion/react").SerializedStyles;

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

@@ -0,0 +1,85 @@
+export declare const searchMessages: {
+    linkLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    linkAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    linkPlaceholder: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export declare const linkMessages: {
+    linkLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    linkAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    linkPlaceholder: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export declare const formMessages: {
+    linkInvalid: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    clearLink: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export declare const linkTextMessages: {
+    linkTextLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    linkTextAriaLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    linkTextPlaceholder: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    clearLinkText: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export declare const messages: {
+    timeUpdated: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    timeViewed: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    timeAgo: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.0/ui/link-picker/styled.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Half padding on the top as the form field has a `gridSize()` margin top that cannot be overridden
+ */
+export declare const rootContainerStyles: import("@emotion/react").SerializedStyles;
+export declare const rootContainerStylesForLoader: import("@emotion/react").SerializedStyles;
+export declare const searchIconStyles: import("@emotion/react").SerializedStyles;
+export declare const tabsWrapperStyles: import("@emotion/react").SerializedStyles;
+export declare const flexColumnStyles: import("@emotion/react").SerializedStyles;
+export declare const formFooterMargin: import("@emotion/react").SerializedStyles;

package/dist/types-ts4.0/ui/link-picker/text-input/index.d.ts

@@ -0,0 +1,14 @@
+import { jsx } from '@emotion/react';
+import { TextFieldProps } from '@atlaskit/textfield';
+export declare type TextInputProps = Omit<TextFieldProps, 'name' | 'value'> & {
+    name: string;
+    value: string;
+    label?: string;
+    onUndo?: Function;
+    onRedo?: Function;
+    onClear?: (name: string) => void;
+    clearLabel?: string;
+    error?: string | null;
+};
+declare const TextInput: ({ name, label, autoFocus, onRedo, onUndo, onKeyDown, onClear, clearLabel, error, ...restProps }: TextInputProps) => jsx.JSX.Element;
+export default TextInput;

package/dist/types-ts4.0/ui/link-picker/text-input/styled.d.ts

@@ -0,0 +1,2 @@
+export declare const clearTextButtonStyles: import("@emotion/react").SerializedStyles;
+export declare const fieldStyles: import("@emotion/react").SerializedStyles;

package/dist/types-ts4.0/ui/link-picker/transformTimeStamp.d.ts

@@ -0,0 +1,3 @@
+import { IntlShape } from 'react-intl-next';
+import { ListItemTimeStamp } from '../types';
+export declare const transformTimeStamp: (intl: IntlShape, lastViewedDate?: Date | undefined, lastUpdatedDate?: Date | undefined) => ListItemTimeStamp | undefined;

package/dist/types-ts4.0/ui/link-picker/utils.d.ts

@@ -0,0 +1,10 @@
+import { KeyboardEvent } from 'react';
+import { IntlShape } from 'react-intl-next';
+import { LinkPickerPlugin, LinkSearchListItemData } from '../types';
+export declare const isUndoEvent: (e: KeyboardEvent<HTMLInputElement>) => boolean;
+export declare const isRedoEvent: (e: KeyboardEvent<HTMLInputElement>) => boolean;
+/**
+ * Retrieve the data source for a link given the item and the plugin that resolved it
+ */
+export declare const getDataSource: (item: LinkSearchListItemData, plugin?: LinkPickerPlugin | undefined) => string;
+export declare function getScreenReaderText(items: LinkSearchListItemData[], selectedIndex: number, intl: IntlShape): string | undefined;

package/dist/types-ts4.0/ui/loader-fallback/index.d.ts

@@ -0,0 +1,3 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+export declare const LoaderFallback: jsx.JSX.Element;

package/dist/types-ts4.0/ui/types.d.ts

@@ -0,0 +1,57 @@
+import { ReactNode } from 'react';
+import { MessageDescriptor } from 'react-intl-next';
+export declare type LinkInputType = 'manual' | 'typeAhead';
+export interface LinkSearchListItemData {
+    /** Unique identifiable attribute for the item */
+    objectId: string;
+    /** Name / title / display text of the link */
+    name: string;
+    /** URL of the resource being linked to */
+    url: string;
+    /** Icon to display in link result */
+    icon: string | React.ComponentType<{
+        alt: string;
+    }>;
+    /** Alt text describing the icon */
+    iconAlt: string | MessageDescriptor;
+    /** Context to display in link result */
+    container?: string;
+    /** Optional last view date to display in link result */
+    lastViewedDate?: Date;
+    /** Optional last updated date to display in link result */
+    lastUpdatedDate?: Date;
+    /** Whether the result is pre-fetched from activity provider */
+    prefetch?: boolean;
+    /** Metadata about the result */
+    meta?: {
+        /** The data source that provided the result */
+        source?: string;
+    };
+}
+export declare type ListItemTimeStamp = {
+    pageAction: string;
+    dateString: string;
+    timeSince?: string | undefined;
+};
+export interface LinkPickerState {
+    /** Current query string / URL input field value */
+    query: string;
+}
+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;
+    /** Render function to customise the UI that is displayed when an error occurs resolving results */
+    errorFallback?: LinkPickerPluginErrorFallback;
+    /** Metadata about the plugin */
+    meta?: {
+        /** The data source that provides all results provided by the plugin */
+        source?: string;
+    };
+}
+export declare type LinkPickerPluginErrorFallback = (error: unknown, retry: () => void) => ReactNode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-picker",
-  "version": "1.10.1",
+  "version": "1.10.3",
   "description": "Standalone link picker",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
@@ -20,6 +20,13 @@
   "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/*"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "af:exports": {
@@ -72,8 +79,8 @@
     "@testing-library/dom": "^8.17.1",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^12.1.5",
-    "@testing-library/react-hooks": "^1.1.0",
-    "@testing-library/user-event": "^13.5.0",
+    "@testing-library/react-hooks": "^8.0.1",
+    "@testing-library/user-event": "^14.4.3",
     "@types/js-yaml": "^3.12.5",
     "enzyme": "^3.10.0",
     "fetch-mock": "^8.0.0",
@@ -83,7 +90,7 @@
     "prettier": "^2.1.1",
     "react-dom": "^16.8.0",
     "sinon": "^2.2.0",
-    "typescript": "4.3.5"
+    "typescript": "4.5.5"
   },
   "techstack": {
     "@repo/internal": {

package/report.api.md

@@ -1,6 +1,10 @@
-## API Report File for "@atlaskit/link-picker".
+## API Report File for "@atlaskit/link-picker"
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+<!--
+	Generated API Report version: 2.0
+-->
 
 [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
@@ -12,115 +16,91 @@ import { default as React_2 } from 'react';
 import { ReactNode } from 'react';
 import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 
-export declare type LinkInputType = 'manual' | 'typeAhead';
+// @public (undocumented)
+export type LinkInputType = 'manual' | 'typeAhead';
 
-export declare const LinkPicker: React_2.MemoExoticComponent<(
+// @public (undocumented)
+export const LinkPicker: React_2.MemoExoticComponent<(
   props: LinkPickerProps,
 ) => JSX.Element>;
 
-export declare interface LinkPickerPlugin {
+// @public (undocumented)
+export interface LinkPickerPlugin {
+  errorFallback?: LinkPickerPluginErrorFallback;
+  meta?: {
+    source?: string;
+  };
+  // (undocumented)
   resolve: (
     state: LinkPickerState,
   ) => Promise<ResolveResult> | AsyncGenerator<ResolveResult, ResolveResult>;
-  /** Uniquely identify the tab */
   tabKey?: string;
-  /** Human-readable label for the plugin */
   tabTitle?: string;
-  /** Render function to customise the UI that is displayed when an error occurs resolving results */
-  errorFallback?: LinkPickerPluginErrorFallback;
-  /** Metadata about the plugin */
-  meta?: {
-    /** The data source that provides all results provided by the plugin */
-    source?: string;
-  };
 }
 
-export declare type LinkPickerPluginErrorFallback = (
+// @public (undocumented)
+export type LinkPickerPluginErrorFallback = (
   error: unknown,
   retry: () => void,
 ) => ReactNode;
 
-export declare interface LinkPickerProps {
-  /**
-   * Callback to fire on form submission.
-   */
+// @public (undocumented)
+export interface LinkPickerProps {
+  displayText?: string | null;
+  onCancel: () => void;
+  onContentResize?: () => void;
   onSubmit: (
     arg: OnSubmitParameter,
     analytic?: UIAnalyticsEvent | null,
   ) => void;
-  /** Callback to fire when the cancel button is clicked. */
-  onCancel: () => void;
-  /** Callback to fire when content is changed inside the link picker e.g. items, when loading, tabs */
-  onContentResize?: () => void;
-  /** The url of the linked resource for editing. */
-  url?: string;
-  /** The desired text to be displayed alternatively to the title of the linked resource for editing. */
-  displayText?: string | null;
-  /** Plugins that provide link suggestions / search capabilities. */
   plugins?: LinkPickerPlugin[];
+  url?: string;
 }
 
-export declare interface LinkPickerState {
-  /** Current query string / URL input field value */
+// @public (undocumented)
+export interface LinkPickerState {
   query: string;
 }
 
-export declare interface LinkSearchListItemData {
-  /** Unique identifiable attribute for the item */
-  objectId: string;
-  /** Name / title / display text of the link */
-  name: string;
-  /** URL of the resource being linked to */
-  url: string;
-  /** Icon to display in link result */
+// @public (undocumented)
+export interface LinkSearchListItemData {
+  container?: string;
   icon:
     | string
     | React.ComponentType<{
         alt: string;
       }>;
-  /** Alt text describing the icon */
   iconAlt: string | MessageDescriptor;
-  /** Context to display in link result */
-  container?: string;
-  /** Optional last view date to display in link result */
-  lastViewedDate?: Date;
-  /** Optional last updated date to display in link result */
   lastUpdatedDate?: Date;
-  /** Whether the result is pre-fetched from activity provider */
-  prefetch?: boolean;
-  /** Metadata about the result */
+  lastViewedDate?: Date;
   meta?: {
-    /** The data source that provided the result */
     source?: string;
   };
+  name: string;
+  objectId: string;
+  prefetch?: boolean;
+  url: string;
 }
 
-declare interface Meta {
-  /** Indicates how the link was picked. */
+// @public (undocumented)
+interface Meta {
   inputMethod: LinkInputType;
 }
 
-declare interface OnSubmitParameter {
-  /** The `url` of the linked resource. */
-  url: string;
-  /** The desired text to be displayed alternatively to the title of the linked resource. */
+// @public (undocumented)
+interface OnSubmitParameter {
   displayText: string | null;
-  /** The resolved `title` of the resource at the time of link picking (if applicable, null if not known). */
-  title: string | null;
-  /** Meta data about the link picking submission. */
   meta: Meta;
-  /**
-   * The input value of the `url` field at time of submission if inserted "manually".
-   * This can useful if the `url` was manually inserted with a value that is different from the normalised value returned as `url`.
-   * @example
-   * { url: 'https://google.com', rawUrl: 'google.com' }
-   */
   rawUrl?: string;
+  title: string | null;
+  url: string;
 }
 
-declare interface ResolveResult {
+// @public (undocumented)
+interface ResolveResult {
+  // (undocumented)
   data: LinkSearchListItemData[];
 }
 
-export {};
+// (No @packageDocumentation comment for this package)
 ```