<!-- API Report Version: 2.3 -->

## API Report File for "@atlaskit/jql-editor-autocomplete-rest"

> Do not edit this file. This report is auto-generated using
> [API Extractor](https://api-extractor.com/).
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)

### Table of contents

- [Main Entry Types](#main-entry-types)
- [Peer Dependencies](#peer-dependencies)

### Main Entry Types

<!--SECTION START: Main Entry Types-->

```ts
import { AutocompleteProvider } from '@atlaskit/jql-editor-common';
import { ContainerComponent } from 'react-sweet-state';

// @public (undocumented)
type AutocompleteInitialDataResponse = {
	jqlFields: JQLFieldResponse[];
	jqlFunctions: JQLFunctionResponse[];
};

// @public (undocumented)
type AutocompleteSuggestionsResponse = {
	results: JQLFieldValueResponse[];
};

// @public (undocumented)
export type GetAutocompleteInitialData = (url: string) => Promise<AutocompleteInitialDataResponse>;

// @public (undocumented)
export type GetAutocompleteSuggestions = (url: string) => Promise<AutocompleteSuggestionsResponse>;

// @public
export const JQLAutocompleteContainer: ContainerComponent<{}>;

// @public (undocumented)
export type JQLAutocompleteResponse = {
	visibleFieldNames: JQLFieldResponse[];
	visibleFunctionNames: JQLFunctionResponse[];
};

// @public (undocumented)
export type JQLAutocompleteSuggestionsResponse = {
	results: JQLFieldValueResponse[];
};

// @public (undocumented)
type JQLFieldResponse = {
	displayName: string;
	value: string;
	types: string[];
	operators: string[];
	searchable?: string;
	deprecated?: string;
	deprecatedSearcherKey?: string;
	orderable?: string;
	auto?: string;
	cfid?: string;
};

// @public (undocumented)
type JQLFieldValueResponse = {
	displayName: string;
	value: string;
};

// @public (undocumented)
type JQLFunctionResponse = {
	displayName: string;
	value: string;
	types: string[];
	isList?: string;
	supportsListAndSingleValueOperators?: string;
};

// @public (undocumented)
export const useAutocompleteProvider: (
	analyticsSource: string,
	getInitialData: GetAutocompleteInitialData,
	getSuggestions: GetAutocompleteSuggestions,
) => AutocompleteProvider;

// (No @packageDocumentation comment for this package)
```

<!--SECTION END: Main Entry Types-->

### Peer Dependencies

<!--SECTION START: Peer Dependencies-->

```json
{
	"react": "^16.8.0"
}
```

<!--SECTION END: Peer Dependencies-->