@atlaskit/quick-search 8.1.0 → 8.1.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/quick-search
 
+## 8.1.1
+
+### Patch Changes
+
+- [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
+
 ## 8.1.0
 
 ### Minor Changes

package/dist/cjs/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/quick-search",
-	"version": "8.1.0"
+	"version": "8.1.1"
 }

package/dist/es2019/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/quick-search",
-	"version": "8.1.0"
+	"version": "8.1.1"
 }

package/dist/esm/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/quick-search",
-	"version": "8.1.0"
+	"version": "8.1.1"
 }

package/dist/types/components/QuickSearch.d.ts

@@ -2,7 +2,7 @@ import React from 'react';
 import { ResultData, SelectedResultId } from './Results/types';
 import { ResultContextType } from './context';
 import { ResultBase } from './Results/ResultBase';
-export declare type Props = {
+export type Props = {
     /** Search results in the form of ResultItemGroups containing Result components */
     children: React.ReactNode;
     /** Set search loading state */
@@ -31,7 +31,7 @@ export declare type Props = {
     /** One string that is used to autocomplete the current search query */
     autocompleteText?: string;
 };
-export declare type State = {
+export type State = {
     selectedResultId: SelectedResultId;
     context: ResultContextType;
     value?: string;
@@ -107,16 +107,16 @@ export declare class QuickSearch extends React.Component<Props, State> {
      * Tab / ArrowRight - Accept autocomplete
      */
     handleSearchKeyDown: (event: React.KeyboardEvent<HTMLInputElement>) => void;
-    acceptAutocomplete: (event: React.KeyboardEvent<HTMLInputElement>, text?: string | undefined) => void;
+    acceptAutocomplete: (event: React.KeyboardEvent<HTMLInputElement>, text?: string) => void;
     setSearchInputRef: (refs: any) => void;
     focusSearchInput: () => void;
     render(): JSX.Element;
 }
-declare const _default: React.ComponentClass<Props, any>;
 /**
  * HOCs:
  * `decorateWithAnalyticsData` - Wrapper that decorates analytics events with additional data.
  * `withAnalytics` - Injects analytics firing methods that are picked up by
  * @atlaskit/analytics/AnalyticsListener.
  */
+declare const _default: React.ComponentClass<Props, any>;
 export default _default;

package/dist/types/components/ResultItem/ResultItem.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-declare type Props = {
+type Props = {
     /** Text to appear to the right of the text. It has a lower font-weight. */
     caption?: string;
     /** Location to link out to on click. This is passed down to the custom link component if one is provided. */

package/dist/types/components/ResultItem/ResultItemGroup.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-declare type Props = {
+type Props = {
     /** Text to appear as heading above group. Will be auto-capitalised. */
     title: React.ReactNode;
     /** React Elements to be displayed within the group. This should generally be a collection of ResultItems. */

package/dist/types/components/Results/ContainerResult.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { CommonResultProps } from './types';
-export declare type Props = CommonResultProps & {
+export type Props = CommonResultProps & {
     /** Name of the container. Provides the main text to be displayed as the item. */
     name: React.ReactNode;
     /** Text to appear to the right of the text. It has a lower font-weight. */

package/dist/types/components/Results/ObjectResult.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { CommonResultProps } from './types';
-export declare type Props = CommonResultProps & {
+export type Props = CommonResultProps & {
     /** Name of the container. Provides the main text to be displayed as the item. */
     name: React.ReactNode;
     /** Text to appear to the right of the text. It has a lower font-weight. */

package/dist/types/components/Results/PersonResult.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { CommonResultProps } from './types';
-export declare type Props = CommonResultProps & {
+export type Props = CommonResultProps & {
     /** Name of the container. Provides the main text to be displayed as the item. */
     name: React.ReactNode;
     /** A user's custom handle. Appears to the right of their `name`. It has a lower font-weight. */

package/dist/types/components/Results/ResultBase.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { AnalyticsData, CommonResultProps } from './types';
 import { ResultContextType } from '../context';
-export declare type Props = CommonResultProps & {
+export type Props = CommonResultProps & {
     /** Type of the result. This is passed as a parameter to certain callbacks. */
     type: string;
     /** Main text to be displayed as the item. */
@@ -15,7 +15,7 @@ export declare type Props = CommonResultProps & {
     /** The context provided by QuickSearch. */
     context?: ResultContextType;
 };
-declare type DefaultProps = {
+type DefaultProps = {
     context: ResultContextType;
 };
 export declare class ResultBase extends React.PureComponent<DefaultProps & Props> {

package/dist/types/components/Results/types.d.ts

@@ -1,14 +1,14 @@
 import { ReactNode } from 'react';
-export declare type AnalyticsData = Object;
-export declare type ResultId = string | number;
-export declare type SelectedResultId = ResultId | null;
-export declare type CancelableEvent = KeyboardEvent | MouseEvent | React.KeyboardEvent<HTMLInputElement> | React.MouseEvent<HTMLElement>;
-export declare type ResultData = {
+export type AnalyticsData = Object;
+export type ResultId = string | number;
+export type SelectedResultId = ResultId | null;
+export type CancelableEvent = KeyboardEvent | MouseEvent | React.KeyboardEvent<HTMLInputElement> | React.MouseEvent<HTMLElement>;
+export type ResultData = {
     resultId: ResultId;
     type: string;
     event: CancelableEvent;
 };
-export declare type CommonResultProps = {
+export type CommonResultProps = {
     /** Unique ID of the result. This is passed as a parameter to certain callbacks */
     resultId: string | number;
     /** Type of the result. This is passed as a parameter to certain callbacks. */

package/dist/types/components/Search/Search.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 export declare const controlKeys: string[];
-declare type Props = {
+type Props = {
     /** The elements to render as options to search from. */
     children?: React.ReactNode;
     /** The elements to render to the right of the search input. */

package/dist/types/components/context.d.ts

@@ -2,7 +2,7 @@ import React from 'react';
 import { ComponentType } from 'react';
 import { ResultData, ResultId, SelectedResultId } from './Results/types';
 import { ResultBase } from './Results/ResultBase';
-export declare type ResultContextType = {
+export type ResultContextType = {
     /** Register result as keyboard navigation target */
     registerResult: (result: ResultBase) => void;
     /** Unregister result as keyboard navigation target */

package/dist/types/components/isReactElement.d.ts

@@ -1,6 +1,6 @@
-declare const _default: (element: any) => boolean;
 /**
  * Heuristically check whether an element is a react element or not.
  * React elements have constructors for their type property but native elements use strings.
  */
+declare const _default: (element: any) => boolean;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/quick-search",
-  "version": "8.1.0",
+  "version": "8.1.1",
   "description": "A quick-search component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,14 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
   "atlaskit:src": "src/index.ts",
   "atlassian": {
     "team": "Search Platform: Search Experience",
@@ -27,7 +35,7 @@
     "@atlaskit/item": "^12.1.0",
     "@atlaskit/spinner": "^15.5.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.3.0",
+    "@atlaskit/tokens": "^1.4.0",
     "@babel/runtime": "^7.0.0",
     "keycode": "^2.1.7"
   },
@@ -46,7 +54,7 @@
     "prop-types": "^15.5.10",
     "react": "^16.8.0",
     "sinon": "^2.2.0",
-    "typescript": "4.5.5",
+    "typescript": "~4.9.5",
     "uuid": "^3.1.0"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"

package/report.api.md

@@ -84,7 +84,7 @@ export type ContainerResultProps = CommonResultProps & {
   subText?: React_2.ReactNode;
 };
 
-// @public (undocumented)
+// @public
 const _default: React_2.ComponentClass<Props_3, any>;
 export { _default as AkQuickSearch };
 export { _default as QuickSearch };

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,263 @@
+## API Report File for "@atlaskit/quick-search"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ComponentType } from 'react';
+import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
+
+// @public (undocumented)
+export class AkNavigationItem extends React_2.PureComponent<Props_2> {
+    // (undocumented)
+    static defaultProps: Partial<Props_2>;
+    // (undocumented)
+    render(): JSX.Element;
+}
+
+// @public (undocumented)
+export class AkSearch extends React_2.PureComponent<Props_4> {
+    // (undocumented)
+    static defaultProps: Partial<Props_4>;
+    // (undocumented)
+    inputRef?: React_2.Ref<any>;
+    // (undocumented)
+    onInputKeyDown: (event: React_2.KeyboardEvent<HTMLInputElement>) => void;
+    // (undocumented)
+    render(): JSX.Element;
+    // (undocumented)
+    renderInputControls: () => JSX.Element | null;
+    // (undocumented)
+    setInputRef: (ref: React_2.Ref<any>) => void;
+}
+
+// @public (undocumented)
+type AnalyticsData = Object;
+
+// @public (undocumented)
+export type CancelableEvent = KeyboardEvent | MouseEvent | React.KeyboardEvent<HTMLInputElement> | React.MouseEvent<HTMLElement>;
+
+// @public (undocumented)
+type CommonResultProps = {
+    resultId: number | string;
+    type?: string;
+    avatarUrl?: string;
+    avatar?: ReactNode;
+    elemAfter?: ReactNode;
+    selectedIcon?: ReactNode;
+    href?: string;
+    target?: string;
+    isCompact?: boolean;
+    onClick?: (resultData: ResultData) => void;
+    analyticsData?: (() => AnalyticsData) | AnalyticsData;
+};
+
+// @public
+export class ContainerResult extends React_2.PureComponent<ContainerResultProps> {
+    // (undocumented)
+    getAvatar: () => {};
+    // (undocumented)
+    render(): JSX.Element;
+}
+
+// @public (undocumented)
+export type ContainerResultProps = CommonResultProps & {
+    name: React_2.ReactNode;
+    caption?: string;
+    isPrivate?: boolean;
+    subText?: React_2.ReactNode;
+};
+
+// @public
+const _default: React_2.ComponentClass<Props_3, any>;
+export { _default as AkQuickSearch }
+export { _default as QuickSearch }
+
+// @public (undocumented)
+type DefaultProps = {
+    context: ResultContextType;
+};
+
+// @public
+export class ObjectResult extends React_2.PureComponent<ObjectResultProps> {
+    // (undocumented)
+    getAvatar: () => {};
+    // (undocumented)
+    getSubtext(): null | undefined | {};
+    // (undocumented)
+    render(): JSX.Element;
+}
+
+// @public (undocumented)
+export type ObjectResultProps = CommonResultProps & {
+    name: React_2.ReactNode;
+    caption?: string;
+    containerName?: React_2.ReactNode;
+    isPrivate?: boolean;
+    objectKey?: React_2.ReactNode;
+};
+
+// @public (undocumented)
+export class PersonResult extends React_2.PureComponent<PersonResultProps> {
+    // (undocumented)
+    static defaultProps: Partial<PersonResultProps>;
+    // (undocumented)
+    getAvatar: () => {};
+    // (undocumented)
+    getMention: () => string | undefined;
+    // (undocumented)
+    render(): JSX.Element;
+}
+
+// @public (undocumented)
+export type PersonResultProps = CommonResultProps & {
+    name: React_2.ReactNode;
+    mentionName?: string;
+    mentionPrefix?: string;
+    presenceMessage?: React_2.ReactNode;
+    presenceState?: 'busy' | 'offline' | 'online' | null;
+};
+
+// @public (undocumented)
+type Props = {
+    title: React_2.ReactNode;
+    children?: React_2.ReactNode;
+};
+
+// @public (undocumented)
+type Props_2 = {
+    caption?: string;
+    href?: string;
+    target?: string;
+    icon?: React_2.ReactNode;
+    isCompact?: boolean;
+    isSelected?: boolean;
+    isMouseSelected?: boolean;
+    onClick?(e: MouseEvent): void;
+    onMouseEnter?: (e: MouseEvent) => void;
+    onMouseLeave?: (e: MouseEvent) => void;
+    subText?: React_2.ReactNode;
+    text?: React_2.ReactNode;
+    textAfter?: React_2.ReactNode;
+    selectedIcon?: React_2.ReactNode;
+    linkComponent?: React_2.ComponentType;
+};
+
+// @public (undocumented)
+type Props_3 = {
+    children: React_2.ReactNode;
+    isLoading?: boolean;
+    onSearchBlur?: (event: React_2.FocusEvent<HTMLInputElement>) => void;
+    onSearchInput?: (event: React_2.FormEvent<HTMLInputElement>, isAutocompleted?: boolean) => void;
+    onSearchKeyDown?: (event: React_2.KeyboardEvent<HTMLInputElement>) => void;
+    onSearchSubmit?: (event: React_2.KeyboardEvent<HTMLInputElement>) => void;
+    placeholder?: string;
+    value?: string;
+    selectedResultId?: SelectedResultId;
+    onSelectedResultIdChanged?: (id: SelectedResultId) => void;
+    firePrivateAnalyticsEvent?: (eventName: string, eventData: Object) => void;
+    linkComponent?: React_2.ComponentType<any>;
+    inputControls?: React_2.ReactNode;
+    autocompleteText?: string;
+};
+
+// @public (undocumented)
+type Props_4 = {
+    children?: React_2.ReactNode;
+    inputControls?: React_2.ReactNode;
+    isLoading?: boolean;
+    onBlur?: (event: React_2.FocusEvent<HTMLInputElement>) => void;
+    onInput?: (event: React_2.FormEvent<HTMLInputElement>) => void;
+    onKeyDown?: (event: React_2.KeyboardEvent<HTMLInputElement>) => void;
+    placeholder?: string;
+    value?: string;
+    autocompleteText?: string;
+};
+
+declare namespace quickSearchResultTypes {
+    export {
+        ContainerResult,
+        ObjectResult,
+        PersonResult,
+        ResultBase
+    }
+}
+export { quickSearchResultTypes }
+
+// @public (undocumented)
+export const ResultBase: (props: ResultBaseProps) => JSX.Element;
+
+// @public (undocumented)
+class ResultBase_2 extends React_2.PureComponent<DefaultProps & ResultBaseProps> {
+    // (undocumented)
+    componentDidMount(): void;
+    // (undocumented)
+    componentDidUpdate(): void;
+    // (undocumented)
+    componentWillUnmount(): void;
+    // (undocumented)
+    static defaultProps: Partial<ResultBaseProps>;
+    // (undocumented)
+    getAnalyticsData(): AnalyticsData;
+    // (undocumented)
+    handleClick: (e: MouseEvent) => void;
+    // (undocumented)
+    handleMouseEnter: (event: MouseEvent) => void;
+    // (undocumented)
+    handleMouseLeave: () => void;
+    // (undocumented)
+    registerResult(): void;
+    // (undocumented)
+    render(): JSX.Element;
+    // (undocumented)
+    state: {
+        isMouseSelected: boolean;
+    };
+}
+
+// @public (undocumented)
+export type ResultBaseProps = CommonResultProps & {
+    type: string;
+    text: React_2.ReactNode;
+    subText?: React_2.ReactNode;
+    caption?: string;
+    icon?: React_2.ReactNode;
+    context?: ResultContextType;
+};
+
+// @public (undocumented)
+type ResultContextType = {
+    registerResult: (result: ResultBase_2) => void;
+    unregisterResult: (result: ResultBase_2) => void;
+    onMouseEnter: (resultData: ResultData) => void;
+    onMouseLeave: () => void;
+    sendAnalytics?: (eventName: string, eventData: Object) => void;
+    getIndex: (resultId: ResultId) => null | number;
+    linkComponent?: ComponentType;
+};
+
+// @public (undocumented)
+export type ResultData = {
+    resultId: ResultId;
+    type: string;
+    event: CancelableEvent;
+};
+
+// @public (undocumented)
+type ResultId = number | string;
+
+// @public (undocumented)
+class ResultItemGroup extends React_2.Component<Props> {
+    // (undocumented)
+    render(): JSX.Element;
+}
+export { ResultItemGroup as AkNavigationItemGroup }
+export { ResultItemGroup }
+
+// @public (undocumented)
+type SelectedResultId = ResultId | null;
+
+// (No @packageDocumentation comment for this package)
+
+```