@atlaskit/quick-search 10.0.0 → 10.0.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/quick-search
 
+## 10.0.2
+
+### Patch Changes
+
+- [#114055](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/114055)
+  [`5011ea90ffebe`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/5011ea90ffebe) -
+  Add deprecation notice
+
+## 10.0.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 10.0.0
 
 ### Major Changes

package/README.md

@@ -1 +1 @@
-This package has been deprecated. Please use the `search-dialog` package instead.
+This package has been deprecated. Please use the `@atlassian/search-dialog` package instead.

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

@@ -110,7 +110,7 @@ export declare class QuickSearch extends React.Component<Props, State> {
     acceptAutocomplete: (event: React.KeyboardEvent<HTMLInputElement>, text?: string) => void;
     setSearchInputRef: (refs: any) => void;
     focusSearchInput: () => void;
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
 /**
  * HOCs:

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

@@ -25,6 +25,6 @@ type Props = {
 };
 declare class ResultItem extends React.PureComponent<Props> {
     static defaultProps: Partial<Props>;
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
 export default ResultItem;

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

@@ -6,6 +6,6 @@ type Props = {
     children?: React.ReactNode;
 };
 export default class ResultItemGroup extends React.Component<Props> {
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
 export {};

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

@@ -14,6 +14,6 @@ export type Props = CommonResultProps & {
  * Generic result type for Atlassian containers.
  */
 export default class ContainerResult extends React.PureComponent<Props> {
-    getAvatar: () => string | number | true | React.ReactFragment | JSX.Element;
-    render(): JSX.Element;
+    getAvatar: () => string | number | true | Iterable<React.ReactNode> | React.JSX.Element;
+    render(): React.JSX.Element;
 }

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

@@ -16,7 +16,7 @@ export type Props = CommonResultProps & {
  * Generic result type for Atlassian objects.
  */
 export default class ObjectResult extends React.PureComponent<Props> {
-    getAvatar: () => string | number | true | React.ReactFragment | JSX.Element;
-    getSubtext(): string | number | boolean | React.ReactFragment | JSX.Element | null | undefined;
-    render(): JSX.Element;
+    getAvatar: () => string | number | true | Iterable<React.ReactNode> | React.JSX.Element;
+    getSubtext(): string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element | null | undefined;
+    render(): React.JSX.Element;
 }

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

@@ -15,6 +15,6 @@ export type Props = CommonResultProps & {
 export default class PersonResult extends React.PureComponent<Props> {
     static defaultProps: Partial<Props>;
     getMention: () => string | undefined;
-    getAvatar: () => string | number | true | React.ReactFragment | JSX.Element;
-    render(): JSX.Element;
+    getAvatar: () => string | number | true | Iterable<React.ReactNode> | React.JSX.Element;
+    render(): React.JSX.Element;
 }

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

@@ -31,7 +31,7 @@ export declare class ResultBase extends React.PureComponent<DefaultProps & Props
     handleClick: (e: MouseEvent) => void;
     handleMouseEnter: (event: MouseEvent) => void;
     handleMouseLeave: () => void;
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
-declare const _default: (props: Props) => JSX.Element;
+declare const _default: (props: Props) => React.JSX.Element;
 export default _default;

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

@@ -24,8 +24,8 @@ export default class Search extends React.PureComponent<Props> {
     static defaultProps: Partial<Props>;
     onInputKeyDown: (event: React.KeyboardEvent<HTMLInputElement>) => void;
     setInputRef: (ref: React.Ref<any>) => void;
-    renderInputControls: () => JSX.Element | null;
+    renderInputControls: () => React.JSX.Element | null;
     inputRef?: React.Ref<any>;
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
 export {};

package/dist/types-ts4.5/components/QuickSearch.d.ts

@@ -110,7 +110,7 @@ export declare class QuickSearch extends React.Component<Props, State> {
     acceptAutocomplete: (event: React.KeyboardEvent<HTMLInputElement>, text?: string) => void;
     setSearchInputRef: (refs: any) => void;
     focusSearchInput: () => void;
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
 /**
  * HOCs:

package/dist/types-ts4.5/components/ResultItem/ResultItem.d.ts

@@ -25,6 +25,6 @@ type Props = {
 };
 declare class ResultItem extends React.PureComponent<Props> {
     static defaultProps: Partial<Props>;
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
 export default ResultItem;

package/dist/types-ts4.5/components/ResultItem/ResultItemGroup.d.ts

@@ -6,6 +6,6 @@ type Props = {
     children?: React.ReactNode;
 };
 export default class ResultItemGroup extends React.Component<Props> {
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
 export {};

package/dist/types-ts4.5/components/Results/ContainerResult.d.ts

@@ -14,6 +14,6 @@ export type Props = CommonResultProps & {
  * Generic result type for Atlassian containers.
  */
 export default class ContainerResult extends React.PureComponent<Props> {
-    getAvatar: () => string | number | true | React.ReactFragment | JSX.Element;
-    render(): JSX.Element;
+    getAvatar: () => string | number | true | Iterable<React.ReactNode> | React.JSX.Element;
+    render(): React.JSX.Element;
 }

package/dist/types-ts4.5/components/Results/ObjectResult.d.ts

@@ -16,7 +16,7 @@ export type Props = CommonResultProps & {
  * Generic result type for Atlassian objects.
  */
 export default class ObjectResult extends React.PureComponent<Props> {
-    getAvatar: () => string | number | true | React.ReactFragment | JSX.Element;
-    getSubtext(): string | number | boolean | React.ReactFragment | JSX.Element | null | undefined;
-    render(): JSX.Element;
+    getAvatar: () => string | number | true | Iterable<React.ReactNode> | React.JSX.Element;
+    getSubtext(): string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element | null | undefined;
+    render(): React.JSX.Element;
 }

package/dist/types-ts4.5/components/Results/PersonResult.d.ts

@@ -15,6 +15,6 @@ export type Props = CommonResultProps & {
 export default class PersonResult extends React.PureComponent<Props> {
     static defaultProps: Partial<Props>;
     getMention: () => string | undefined;
-    getAvatar: () => string | number | true | React.ReactFragment | JSX.Element;
-    render(): JSX.Element;
+    getAvatar: () => string | number | true | Iterable<React.ReactNode> | React.JSX.Element;
+    render(): React.JSX.Element;
 }

package/dist/types-ts4.5/components/Results/ResultBase.d.ts

@@ -31,7 +31,7 @@ export declare class ResultBase extends React.PureComponent<DefaultProps & Props
     handleClick: (e: MouseEvent) => void;
     handleMouseEnter: (event: MouseEvent) => void;
     handleMouseLeave: () => void;
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
-declare const _default: (props: Props) => JSX.Element;
+declare const _default: (props: Props) => React.JSX.Element;
 export default _default;

package/dist/types-ts4.5/components/Search/Search.d.ts

@@ -24,8 +24,8 @@ export default class Search extends React.PureComponent<Props> {
     static defaultProps: Partial<Props>;
     onInputKeyDown: (event: React.KeyboardEvent<HTMLInputElement>) => void;
     setInputRef: (ref: React.Ref<any>) => void;
-    renderInputControls: () => JSX.Element | null;
+    renderInputControls: () => React.JSX.Element | null;
     inputRef?: React.Ref<any>;
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
 export {};

package/docs/0-intro.tsx

@@ -1,11 +1,21 @@
 import React from 'react';
 import { md, Example, Props, code, AtlassianInternalWarning } from '@atlaskit/docs';
+import SectionMessage from '@atlaskit/section-message';
+import { Code } from '@atlaskit/code';
 
 export default md`
+  ${(
+		<SectionMessage appearance="error" title="@atlaskit/quick-search is deprecated">
+			This package has been deprecated. Please use <Code>@atlassian/search-dialog</Code> instead.
+		</SectionMessage>
+	)}
+
+	<br />
+
   ${(<AtlassianInternalWarning />)}
 
   This is a barebones quick-search component that can render different types of search results.
-  
+
   ## Usage
   ${code`import { QuickSearch, ObjectResult, ContainerResult, ResultItemGroup } from '@atlaskit/quick-search';
 
@@ -19,11 +29,11 @@ export default md`
       >
         // render search results:
         <ResultItemGroup title="Issues">
-          <ObjectResult name="Fix this and that" objectKey="JRA-123" /> 
-          <ObjectResult name="More stuff" objectKey="JRA-124" /> 
+          <ObjectResult name="Fix this and that" objectKey="JRA-123" />
+          <ObjectResult name="More stuff" objectKey="JRA-124" />
         </ResultItemGroup>
         <ResultItemGroup title="Spaces">
-          <ContainerResult name="Search and Smarts" /> 
+          <ContainerResult name="Search and Smarts" />
         </ResultItemGroup>
       </QuickSearch>
     );

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/quick-search",
-	"version": "10.0.0",
+	"version": "10.0.2",
 	"description": "A quick-search component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -24,7 +24,8 @@
 	"atlassian": {
 		"team": "Search Platform: Search Experience",
 		"website": {
-			"name": "Quick Search"
+			"name": "Quick Search",
+			"deprecated": "This package is deprecated, please use @atlassian/search-dialog."
 		}
 	},
 	"dependencies": {
@@ -32,7 +33,7 @@
 		"@atlaskit/avatar": "^21.18.0",
 		"@atlaskit/menu": "^2.14.0",
 		"@atlaskit/spinner": "^17.1.0",
-		"@atlaskit/theme": "^14.1.0",
+		"@atlaskit/theme": "^15.0.0",
 		"@atlaskit/tokens": "^3.3.0",
 		"@babel/runtime": "^7.0.0",
 		"keycode": "^2.1.7"