@atlaskit/link-picker 1.10.2 → 1.10.4

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.2",
+  "version": "1.10.4",
   "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": {
@@ -42,12 +49,14 @@
     "@atlaskit/theme": "^12.2.0",
     "@atlaskit/tokens": "^0.10.0",
     "@atlaskit/tooltip": "^17.5.0",
+    "@atlaskit/ufo": "^0.1.0",
     "@atlaskit/visually-hidden": "^1.1.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "date-fns": "^2.17.0",
     "linkify-it": "^2.0.3",
-    "react-loosely-lazy": "^0.5.0"
+    "react-loosely-lazy": "^0.5.0",
+    "uuid": "^3.1.0"
   },
   "peerDependencies": {
     "react": "^16.8.0",
@@ -72,18 +81,19 @@
     "@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",
+    "jest-extended": "^0.11.2",
     "js-yaml": "^3.13.1",
     "lodash": "^4.17.21",
     "mockdate": "^3.0.2",
     "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)
 ```