@atlaskit/link-picker 1.1.3 → 1.1.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/link-picker
 
+## 1.1.4
+
+### Patch Changes
+
+- [`97cfed0aa0d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/97cfed0aa0d) - Add tests around how the link picker handles editing links
+
 ## 1.1.3
 
 ### Patch Changes

package/dist/cjs/messages.js

@@ -107,6 +107,11 @@ var messages = (0, _reactIntlNext.defineMessages)({
     id: 'fabric.linkPicker.search.noResults.description',
     defaultMessage: 'Try again with a different term.',
     description: 'Describes possible action when a search returns no results'
+  },
+  saveButton: {
+    id: 'fabric.linkPicker.button.save',
+    defaultMessage: 'Save',
+    description: 'Button to save edited link'
   }
 });
 exports.messages = messages;

package/dist/cjs/ui/link-picker.js

@@ -316,6 +316,7 @@ var LinkPicker = /*#__PURE__*/function (_PureComponent) {
       selectedIndex: -1,
       activeIndex: -1,
       isLoading: false,
+      isEditing: !!props.url,
       url: (0, _url.normalizeUrl)(props.url) || '',
       displayText: props.displayText || '',
       items: [],
@@ -473,6 +474,7 @@ var LinkPicker = /*#__PURE__*/function (_PureComponent) {
       var _this$state7 = this.state,
           items = _this$state7.items,
           isLoading = _this$state7.isLoading,
+          isEditing = _this$state7.isEditing,
           activeIndex = _this$state7.activeIndex,
           selectedIndex = _this$state7.selectedIndex,
           url = _this$state7.url,
@@ -584,7 +586,7 @@ var LinkPicker = /*#__PURE__*/function (_PureComponent) {
         appearance: "primary",
         onClick: this.handleSubmit,
         testId: "link-picker-insert-button"
-      }, formatMessage(_messages.messages.insertButton))))));
+      }, formatMessage(isEditing ? _messages.messages.saveButton : _messages.messages.insertButton))))));
     }
   }]);
   return LinkPicker;

package/dist/cjs/version.json

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

package/dist/es2019/messages.js

@@ -99,5 +99,10 @@ export const messages = defineMessages({
     id: 'fabric.linkPicker.search.noResults.description',
     defaultMessage: 'Try again with a different term.',
     description: 'Describes possible action when a search returns no results'
+  },
+  saveButton: {
+    id: 'fabric.linkPicker.button.save',
+    defaultMessage: 'Save',
+    description: 'Button to save edited link'
   }
 });

package/dist/es2019/ui/link-picker.js

@@ -265,6 +265,7 @@ class LinkPicker extends PureComponent {
       selectedIndex: -1,
       activeIndex: -1,
       isLoading: false,
+      isEditing: !!props.url,
       url: normalizeUrl(props.url) || '',
       displayText: props.displayText || '',
       items: [],
@@ -358,6 +359,7 @@ class LinkPicker extends PureComponent {
     const {
       items,
       isLoading,
+      isEditing,
       activeIndex,
       selectedIndex,
       url,
@@ -474,7 +476,7 @@ class LinkPicker extends PureComponent {
       appearance: "primary",
       onClick: this.handleSubmit,
       testId: "link-picker-insert-button"
-    }, formatMessage(messages.insertButton))))));
+    }, formatMessage(isEditing ? messages.saveButton : messages.insertButton))))));
   }
 
 }

package/dist/es2019/version.json

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

package/dist/esm/messages.js

@@ -99,5 +99,10 @@ export var messages = defineMessages({
     id: 'fabric.linkPicker.search.noResults.description',
     defaultMessage: 'Try again with a different term.',
     description: 'Describes possible action when a search returns no results'
+  },
+  saveButton: {
+    id: 'fabric.linkPicker.button.save',
+    defaultMessage: 'Save',
+    description: 'Button to save edited link'
   }
 });

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

@@ -294,6 +294,7 @@ var LinkPicker = /*#__PURE__*/function (_PureComponent) {
       selectedIndex: -1,
       activeIndex: -1,
       isLoading: false,
+      isEditing: !!props.url,
       url: normalizeUrl(props.url) || '',
       displayText: props.displayText || '',
       items: [],
@@ -451,6 +452,7 @@ var LinkPicker = /*#__PURE__*/function (_PureComponent) {
       var _this$state7 = this.state,
           items = _this$state7.items,
           isLoading = _this$state7.isLoading,
+          isEditing = _this$state7.isEditing,
           activeIndex = _this$state7.activeIndex,
           selectedIndex = _this$state7.selectedIndex,
           url = _this$state7.url,
@@ -562,7 +564,7 @@ var LinkPicker = /*#__PURE__*/function (_PureComponent) {
         appearance: "primary",
         onClick: this.handleSubmit,
         testId: "link-picker-insert-button"
-      }, formatMessage(messages.insertButton))))));
+      }, formatMessage(isEditing ? messages.saveButton : messages.insertButton))))));
     }
   }]);
 

package/dist/esm/version.json

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

package/dist/types/messages.d.ts

@@ -99,4 +99,9 @@ export declare const messages: {
         defaultMessage: string;
         description: string;
     };
+    saveButton: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
 };

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

@@ -42,6 +42,7 @@ export interface State {
     activeIndex: number;
     url: string;
     isLoading: boolean;
+    isEditing: boolean;
     displayText: string;
     invalidUrl: string | null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-picker",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Standalone link picker",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {

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 {};
 ```