@atlaskit/link-picker 1.1.1 → 1.1.4

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

@@ -0,0 +1,52 @@
+/** @jsx jsx */
+import React from 'react';
+import { WrappedComponentProps } from 'react-intl-next';
+import { LinkSearchListItemData, LinkInputType, LinkPickerPlugin } from '../types';
+export declare const RECENT_SEARCH_LIST_SIZE = 5;
+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) => void;
+    /** Callback to fire when the cancel button is clicked. */
+    onCancel: () => 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 State {
+    items: LinkSearchListItemData[];
+    selectedIndex: number;
+    activeIndex: number;
+    url: string;
+    isLoading: boolean;
+    isEditing: boolean;
+    displayText: string;
+    invalidUrl: string | null;
+}
+export declare const LinkPickerWithIntl: React.FC<import("react-intl-next").WithIntlProps<WrappedComponentProps<"intl"> & LinkPickerProps>> & {
+    WrappedComponent: React.ComponentType<WrappedComponentProps<"intl"> & LinkPickerProps>;
+};
+export {};

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

@@ -0,0 +1,20 @@
+/** @jsx jsx */
+import { PureComponent } from 'react';
+import { jsx } from '@emotion/react';
+import { LinkSearchListItemData } from '../../types';
+export interface Props {
+    items?: LinkSearchListItemData[];
+    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;
+}
+export default class LinkSearchList extends PureComponent<Props, {}> {
+    render(): jsx.JSX.Element;
+}

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

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

package/dist/types/ui/link-search-no-results/index.d.ts

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

package/dist/types/ui/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/ui/link-search-no-results/no-results-svg/styled.d.ts

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

package/dist/types/ui/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/ui/list-item/styled.d.ts

@@ -0,0 +1,7 @@
+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 itemIconStyles: import("@emotion/react").SerializedStyles;
+export declare const imgStyles: import("@emotion/react").SerializedStyles;

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

@@ -0,0 +1,4 @@
+export declare const recentListStyles: import("@emotion/react").SerializedStyles;
+export declare const containerStyles: import("@emotion/react").SerializedStyles;
+export declare const searchIconStyles: import("@emotion/react").SerializedStyles;
+export declare const listTitleStyles: import("@emotion/react").SerializedStyles;

package/dist/types/ui/text-input/index.d.ts

@@ -0,0 +1,17 @@
+import { jsx } from '@emotion/react';
+import { TextFieldProps } from '@atlaskit/textfield';
+export interface Props extends Omit<TextFieldProps, 'value' | 'onChange' | 'autoFocus' | 'onSubmit'> {
+    name: string;
+    label?: string;
+    autoFocus?: boolean;
+    value: string;
+    onChange: (value: string) => void;
+    onSubmit?: (value: string) => void;
+    onUndo?: Function;
+    onRedo?: Function;
+    onClear?: () => void;
+    clearLabel?: string;
+    error?: string | null;
+}
+declare const PanelTextInput: (props: Props) => jsx.JSX.Element;
+export default PanelTextInput;

package/dist/types/ui/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/url.d.ts

@@ -0,0 +1,5 @@
+export declare const isSafeUrl: (url: string) => boolean;
+/**
+ * Adds protocol to url if needed.
+ */
+export declare function normalizeUrl(url?: string | null): string | null;

package/dist/types/utils.d.ts

@@ -0,0 +1,3 @@
+import { KeyboardEvent } from 'react';
+export declare const isUndoEvent: (e: KeyboardEvent<HTMLInputElement>) => boolean;
+export declare const isRedoEvent: (e: KeyboardEvent<HTMLInputElement>) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-picker",
-  "version": "1.1.1",
+  "version": "1.1.4",
   "description": "Standalone link picker",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
@@ -50,7 +50,6 @@
   },
   "devDependencies": {
     "@atlaskit/activity-provider": "^2.3.2",
-    "@atlaskit/button": "^16.3.0",
     "@atlaskit/docs": "*",
     "@atlaskit/link-test-helpers": "^1.1.0",
     "@atlaskit/popup": "^1.3.5",

package/report.api.md

@@ -10,11 +10,9 @@ import { default as React_2 } from 'react';
 import { WithIntlProps } from 'react-intl-next';
 import { WrappedComponentProps } from 'react-intl-next';
 
-// @public (undocumented)
-export type LinkInputType = 'manual' | 'typeAhead';
+export declare type LinkInputType = 'manual' | 'typeAhead';
 
-// @public (undocumented)
-export const LinkPicker: React_2.FC<
+export declare const LinkPicker: React_2.FC<
   WithIntlProps<WrappedComponentProps<'intl'> & LinkPickerProps>
 > & {
   WrappedComponent: React_2.ComponentType<
@@ -22,44 +20,81 @@ export const LinkPicker: React_2.FC<
   >;
 };
 
-// @public (undocumented)
-export interface LinkPickerPlugin {
-  // (undocumented)
+export declare interface LinkPickerPlugin {
   resolve: (
     state: LinkPickerState,
   ) => Promise<ResolveResult> | AsyncGenerator<ResolveResult, ResolveResult>;
 }
 
-// @public (undocumented)
-export interface LinkPickerProps {
-  displayText?: string | null;
-  onCancel: () => void;
+export declare interface LinkPickerProps {
+  /** Callback to fire on form submission. */
   onSubmit: (arg: OnSubmitParameter) => void;
-  plugins?: LinkPickerPlugin[];
+  /** Callback to fire when the cancel button is clicked. */
+  onCancel: () => 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[];
 }
 
-// @public (undocumented)
-export interface LinkPickerState {
+export declare interface LinkPickerState {
+  /** Current query string / URL input field value */
   query: string;
 }
 
-// @public (undocumented)
-export interface LinkSearchListItemData {
-  container?: 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 */
   icon:
     | string
     | React.ComponentType<{
         alt: string;
       }>;
+  /** Alt text describing the icon */
   iconAlt: string | MessageDescriptor;
-  lastUpdatedDate?: Date;
+  /** Context to display in link result */
+  container?: string;
+  /** Optional last view date to display in link result */
   lastViewedDate?: Date;
-  name: string;
-  objectId: string;
+  /** Optional last updated date to display in link result */
+  lastUpdatedDate?: Date;
+  /** Whether the result is pre-fetched from activity provider */
   prefetch?: boolean;
+}
+
+declare interface Meta {
+  /** Indicates how the link was picked. */
+  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. */
+  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;
+}
+
+declare interface ResolveResult {
+  data: LinkSearchListItemData[];
 }
 
-// (No @packageDocumentation comment for this package)
+export {};
 ```

package/example-helpers/flight-deck/_manifest.json

@@ -1,9 +0,0 @@
-{
-  "name": "recent-work-service",
-  "publishMetadata": {
-    "metricTags": {}
-  },
-  "dimensions": {},
-  "tagScheme": "v001-n_$name$",
-  "frontend": true
-}

package/example-helpers/flight-deck/mockFDResponse.json

@@ -1,133 +0,0 @@
-{
-    "hydrators": {
-        "TownsquareGoal": {
-            "hydratorPaths": {
-                "id": [
-                    "id"
-                ],
-                "key": [
-                    "key"
-                ],
-                "name": [
-                    "name"
-                ],
-                "url": [
-                    "url"
-                ],
-                "icon": [
-                    "iconData"
-                ]
-            }
-        },
-        "TownsquareProject": {
-            "hydratorPaths": {
-                "id": [
-                    "id"
-                ],
-                "key": [
-                    "key"
-                ],
-                "name": [
-                    "name"
-                ],
-                "url": [
-                    "url"
-                ],
-                "icon": [
-                    "iconData"
-                ]
-            }
-        },
-        "TownsquareComment": {
-            "hydratorPaths": {
-                "id": [
-                    "id"
-                ],
-                "name": [
-                    "object.name"
-                ],
-                "url": [
-                    "object.url"
-                ],
-                "icon": [
-                    "object.iconData"
-                ]
-            }
-        },
-        "ConfluencePage": {
-            "hydratorPaths": {
-                "id": [
-                    "id"
-                ],
-                "name": [
-                    "title"
-                ],
-                "localResourceId": [
-                    "pageId"
-                ],
-                "url": [
-                    "links.base",
-                    "links.webUi"
-                ],
-                "containers": [
-                    "space.name"
-                ],
-                "icon": [
-                  "metadata.titleEmojiDraft",
-                  "metadata.titleEmojiPublished"
-                ]
-            },
-            "staticFallbacks": {
-                "icon": "https://home-static.us-east-1.staging.public.atl-paas.net/confluence-page-icon.svg"
-            }
-        },
-        "ConfluenceBlogPost": {
-            "hydratorPaths": {
-                "id": [
-                    "id"
-                ],
-                "name": [
-                    "title"
-                ],
-                "localResourceId": [
-                    "blogPostId"
-                ],
-                "url": [
-                    "links.base",
-                    "links.webUi"
-                ],
-                "containers": [
-                    "space.name"
-                ],
-                "icon": [
-                  "metadata.titleEmojiDraft",
-                  "metadata.titleEmojiPublished"
-                ]
-            },
-            "staticFallbacks": {
-                "icon": "https://home-static.us-east-1.prod.public.atl-paas.net/confluence-blogpost-icon.svg"
-            }
-        },
-        "ConfluenceComment": {
-            "hydratorPaths": {
-                "id": [
-                    "id"
-                ],
-                "name": [
-                    "container.title"
-                ],
-                "url": [
-                    "links.base",
-                    "links.webUi"
-                ],
-                "containers": [
-                    "container.space.name"
-                ]
-            },
-            "staticFallbacks": {
-                "icon": "https://home-static.us-east-1.staging.public.atl-paas.net/confluence-page-icon.svg"
-            }
-        }
-    },
-    "queryFragments": "\n\n  fragment townsquareGoal on TownsquareGoal {\n    id\n    key\n    name\n    url\n    iconData\n  }\n\n\n  fragment townsquareProject on TownsquareProject {\n    id\n    key\n    name\n    url\n    iconData\n  }\n\n\n  fragment townsquareComment on TownsquareComment {\n    id\n    url\n    object {\n      name\n      iconData\n      url\n    }\n  }\n\n\n  fragment confluencePage on ConfluencePage {\n    id\n    title\n    pageId\n    links {\n      base\n      webUi\n    }\n    space {\n      name\n    }\n  }\n\n\n  fragment confluenceBlogPost on ConfluenceBlogPost {\n    id\n    title\n    blogPostId\n    links {\n      base\n      webUi\n    }\n    space {\n      name\n    }\n  }\n\n\n  fragment confluenceComment on ConfluenceComment {\n    id\n    links {\n      base\n      webUi\n    }\n    container {\n      __typename\n      ...confluenceBlogPost\n      ...confluencePage\n    }\n  }\n\nfragment activityItemEdge on ActivityItemEdge {\n  cursor\n  node {\n    id\n    object {\n      id\n      type\n      product\n      rootContainerId\n      contributors {\n        profile {\n          name\n          picture\n          accountId\n        }\n      }\n      data {\n        __typename\n\t...townsquareGoal\n\t...townsquareProject\n\t...townsquareComment\n\t...confluencePage\n\t...confluenceBlogPost\n\t...confluenceComment\n      }\n    }\n    event {\n      id\n      timestamp\n      eventType\n    }\n  }\n}\nfragment activityItemConnection on ActivityConnection {\n  edges {\n    ...activityItemEdge\n  }\n}\n\n"
-}