@atlaskit/link-picker 1.1.3 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-picker",
-  "version": "1.1.3",
+  "version": "1.2.1",
   "description": "Standalone link picker",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
@@ -29,6 +29,7 @@
     "ak-postbuild": "ls -d dist/* | grep -v dist/types | xargs -n 1 copyfiles -u 1 -V src/**/*.svg"
   },
   "dependencies": {
+    "@atlaskit/analytics-next": "^8.3.1",
     "@atlaskit/button": "^16.2.0",
     "@atlaskit/empty-state": "^7.3.0",
     "@atlaskit/form": "^8.5.1",
@@ -57,7 +58,7 @@
     "@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": "^11.0.0",
+    "@atlassian/link-picker-atlassian-plugin": "^12.0.0",
     "@atlassian/search-provider": "^2.3.0",
     "@testing-library/dom": "^7.7.3",
     "@testing-library/react": "^8.0.1",

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/dist/cjs/ui/styled.js

@@ -1,32 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.searchIconStyles = exports.recentListStyles = exports.listTitleStyles = exports.containerStyles = void 0;
-
-var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
-
-var _tokens = require("@atlaskit/tokens");
-
-var _react = require("@emotion/react");
-
-var _colors = require("@atlaskit/theme/colors");
-
-var _theme = require("@atlaskit/theme");
-
-var _constants = require("@atlaskit/theme/constants");
-
-var _templateObject, _templateObject2, _templateObject3, _templateObject4;
-
-var LINK_PICKER_WIDTH_IN_PX = 342;
-var recentListStyles = (0, _react.css)(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n  width: ", "px;\n"])), LINK_PICKER_WIDTH_IN_PX);
-exports.recentListStyles = recentListStyles;
-var containerStyles = (0, _react.css)(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n  padding: ", "px;\n  width: 100%;\n  overflow: hidden;\n  line-height: initial;\n  box-sizing: border-box;\n"])), (0, _constants.gridSize)() * 2);
-exports.containerStyles = containerStyles;
-var searchIconStyles = (0, _react.css)(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2.default)(["\n  margin-left: ", "px;\n  color: ", ";\n  cursor: default;\n"])), (0, _constants.gridSize)() / 2, (0, _tokens.token)('color.icon', _colors.N500));
-exports.searchIconStyles = searchIconStyles;
-var listTitleStyles = (0, _react.css)(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2.default)(["\n  ", "\n  text-transform: uppercase;\n  margin-bottom: ", "px;\n"])), _theme.typography.h100(), (0, _constants.gridSize)() / 2);
-exports.listTitleStyles = listTitleStyles;

package/dist/esm/ui/styled.js

@@ -1,16 +0,0 @@
-import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
-
-var _templateObject, _templateObject2, _templateObject3, _templateObject4;
-
-import { token } from '@atlaskit/tokens';
-import { css } from '@emotion/react';
-import { N500 } from '@atlaskit/theme/colors'; // AFP-2532 TODO: Fix automatic suppressions below
-// eslint-disable-next-line @atlassian/tangerine/import/entry-points
-
-import { typography } from '@atlaskit/theme';
-import { gridSize } from '@atlaskit/theme/constants';
-var LINK_PICKER_WIDTH_IN_PX = 342;
-export var recentListStyles = css(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n  width: ", "px;\n"])), LINK_PICKER_WIDTH_IN_PX);
-export var containerStyles = css(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n  padding: ", "px;\n  width: 100%;\n  overflow: hidden;\n  line-height: initial;\n  box-sizing: border-box;\n"])), gridSize() * 2);
-export var searchIconStyles = css(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n  margin-left: ", "px;\n  color: ", ";\n  cursor: default;\n"])), gridSize() / 2, token('color.icon', N500));
-export var listTitleStyles = css(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["\n  ", "\n  text-transform: uppercase;\n  margin-bottom: ", "px;\n"])), typography.h100(), gridSize() / 2);