Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@atlassianlabs/jql-editor-autocomplete-rest

atlassian3k1.1.2TypeScript support: included

Autocomplete REST API integration for the JQL Editor.

readme

JQL Editor Autocomplete REST

Atlassian license

This package wraps the callbacks needed to fetch autocomplete data for the JQL editor, and provides simple hooks to delegate to Jira Cloud REST API's.

We require these configurable hooks to allow consumers to define their own fetch library given their app environment, e.g. Jira, Connect, Forge etc.

Usage

A minimal configuration of the autocomplete provider is as follows:

`typescript jsx import { useAutocompleteProvider } from '@atlassianlabs/jql-editor-autocomplete-rest';

const getInitialData = async (url: string) => { const response = await fetch(url, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ includeCollapsedFields: true }) }); const data = response.json();

return { jqlFields: data.visibleFieldNames, jqlFunctions: data.visibleFunctionNames, }; };

const getSuggestions = async (url: string) => { const response = await fetch(url); return response.json(); };

const useMyAutocompleteProvider = () => { return useAutocompleteProvider('my-app', getInitialData, getSuggestions); };


## Installation

```sh
yarn add @atlassianlabs/jql-editor-autocomplete-rest

Support

For developers outside of Atlassian looking for help, or to report issues, please make a post on the community forum. We will monitor the forums and redirect topics to the appropriate maintainers.

License

Copyright (c) 2021 - 2022 Atlassian and others. Apache 2.0 licensed, see LICENSE file.

changelog

@atlassianlabs/jql-editor-autocomplete-rest

1.1.4

Labs version

Patch Changes

  • f04004ec277 - Extract common JQL editor types, constants and utilities to separate package.

1.1.3

Labs version

Patch Changes

  • 9d00501a414 - Ensure legacy types are published for TS 4.5-4.8

1.1.2

Patch Changes

1.1.1

Patch Changes

  • 5fbee461cc7 - Internal change to enforce token usage for spacing properties. There is no expected visual or behaviour change.

1.1.0

Minor Changes

Patch Changes

  • Updated dependencies

1.0.14

Patch Changes

  • fbd7a36e956 - Upgrade react-sweet-state from 2.5.2 to 2.6.5

1.0.13

Patch Changes

  • Updated dependencies

1.0.12

Patch Changes

1.0.11

Labs version

Patch Changes

  • b2e81642b07 - Use default import for version.json and specify fixed prosemirror-transform dependency version.

1.0.10

Patch Changes

  • cdd62ddf: Add deprecated field and deprecatedSearcherKey field to jql autocomplete

1.0.9

Patch Changes

  • Internal changes to rxjs imports to improve treeshaking and reduce bundle size

1.0.8

Labs version

Patch Changes

1.0.7

Labs version

Patch Changes

  • 6c31f29: Migrate packages from tslint to eslint
  • 0df8576: Move analytics hook into jql-editor package.
  • Updated dependencies [80bebea]
  • Updated dependencies [6c31f29]
  • Updated dependencies [0df8576]

1.0.6

Patch Changes

1.0.5

Patch Changes

1.0.4

Patch Changes

1.0.3

Patch Changes

1.0.2

Patch Changes

1.0.1

Patch Changes

  • 19d9d06: Improve autocomplete behavior for list functions
  • Updated dependencies [f646f32]
  • Updated dependencies [e1b9399]
  • Updated dependencies [669d464]
  • Updated dependencies [9bdef19]
  • Updated dependencies [d6ad0b8]
  • Updated dependencies [6d6996d]
  • Updated dependencies [19d9d06]
  • Updated dependencies [fe01952]
  • Updated dependencies [c3cef8a]

1.0.0

Major Changes

  • 94c794c: Bump all TypeScript packages to 1.0.0 for release to production. From this point on, semver will be used in all packages.

Patch Changes

0.2.0

Minor Changes

  • cf9e417: Add analyticsSource for analytic events.

Patch Changes

0.1.3

Patch Changes

  • 17f2a3c: Remove email from from user nodes on autocomplete insertion when data is provided by REST API
  • Updated dependencies [17f2a3c]

0.1.2

Patch Changes

  • bed8a9f: Refactor autocomplete state logic and fix autocomplete positioning following operands
  • a3b9113: User rich inline node UI
  • Updated dependencies [04c6137]
  • Updated dependencies [25c1cf0]
  • Updated dependencies [04c6137]
  • Updated dependencies [587e213]
  • Updated dependencies [ab711f7]
  • Updated dependencies [aadaabb]
  • Updated dependencies [6f00e0d]
  • Updated dependencies [d93a20d]
  • Updated dependencies [155ac26]
  • Updated dependencies [bed8a9f]
  • Updated dependencies [a3b9113]
  • Updated dependencies [fbf252f]
  • Updated dependencies [6d76a16]
  • Updated dependencies [629bda6]
  • Updated dependencies [04c6137]
  • Updated dependencies [96d6447]
  • Updated dependencies [f9bbcd7]
  • Updated dependencies [29a84e6]
  • Updated dependencies [d4c7b04]

0.1.1

Patch Changes

0.1.0

Minor Changes

  • 6f1a925: Update JQL editor API to accept autocompleteProvider prop.

Patch Changes

  • 3742dc5: Add package to enable REST API integration for JQL editor autocomplete.
  • 6f1a925: Use Intl.Collator for string comparison.
  • Updated dependencies [6f1a925]
  • Updated dependencies [6f1a925]
  • Updated dependencies [a71c3ac]
  • Updated dependencies [20eb798]
  • Updated dependencies [b7bed94]
  • Updated dependencies [23ff3b9]
  • Updated dependencies [0a4e249]
  • Updated dependencies [8608c19]
  • Updated dependencies [0a2125a]
  • Updated dependencies [95d6d7f]
  • Updated dependencies [e0835ee]