@atlaskit/jql-editor 5.5.1 → 5.5.2

package/dist/types/ui/jql-editor/types.d.ts

@@ -3,18 +3,18 @@ import { type Jast } from '@atlaskit/jql-ast';
 import { type AutocompleteProvider } from '../../plugins/autocomplete/types';
 import { type CustomComponents, type ExternalMessage } from '../../state/types';
 export type HydratedUser = {
-    type: 'user';
+    avatarUrl: string;
     id: string;
     name: string;
-    avatarUrl: string;
+    type: 'user';
 };
 export type HydratedDeprecatedField = {
-    type: 'deprecated-field';
+    deprecatedSearcherKey: string;
     /**
      * The jqlTerm of the field.
      */
     id: string;
-    deprecatedSearcherKey: string;
+    type: 'deprecated-field';
 };
 export type HydratedValue = HydratedUser | HydratedDeprecatedField;
 export type HydratedValues = {
@@ -26,38 +26,41 @@ export type JQLEditorUIProps = {
      */
     analyticsSource: string;
     /**
-     * The query to render in the editor.
-     */
-    query: string;
-    /**
-     * Custom messages to display.
+     * Provider object to fetch autocomplete data.
      */
-    messages?: ExternalMessage[];
+    autocompleteProvider: AutocompleteProvider;
     /**
-     * Flag to enable the searching indicator when a JQL search is in progress.
+     * Custom components to take over the rendering of certain parts of JQL editor
      */
-    isSearching?: boolean;
+    customComponents?: CustomComponents;
     /**
-     * Called when the JQL editor has been initialised.
+     * Enables rich inline nodes feature, which will replace user identifiers with a lozenge containing name and avatar.
+     * Note that you must specify an `onHydrate` prop which will return user data for a given query in order to see the
+     * following behaviour:
+     *  - Loading of user avatars
+     *  - Rendering of user lozenges on component initialisation
+     *  - Rendering of user lozenges on paste
      */
-    onEditorMounted?: () => void;
+    enableRichInlineNodes?: boolean;
     /**
-     * Called every time the editor needs to hydrate values for the current query.
+     * Ref callback to force the focus event
      */
-    onHydrate?: (query: string) => Promise<HydratedValues>;
+    inputRef?: Ref<{
+        focus: () => void;
+    }>;
     /**
-     * Called every time the editor is updated with the current query value and respective Jast object.
+     * `false` matches the Atlaskit default field styling
+     * `true` matches the Atlaskit compact field styling, generally used for search purposes.
      */
-    onUpdate?: (query: string, jast: Jast) => void;
+    isCompact?: boolean;
     /**
-     * Called every time the search command is given in the editor with the current query value and respective Jast object.
-     * If not passed, hides the search button/other search related functionality, allowing this to be usable as a form field.
+     * Flag to enable the searching indicator when a JQL search is in progress.
      */
-    onSearch?: (query: string, jast: Jast) => void;
+    isSearching?: boolean;
     /**
-     * Called if an unexpected error is thrown while rendering the editor.
+     * Custom messages to display.
      */
-    onRenderError?: (error: Error) => void;
+    messages?: ExternalMessage[];
     /**
      * Called when we want to debug a particular error or action that has occurred within the editor. The message may
      * contain PII, and as such consumers should treat as a privacy unsafe error.
@@ -66,40 +69,37 @@ export type JQLEditorUIProps = {
         [key: string]: string | number | boolean | void | null;
     }) => void;
     /**
-     * Called when the syntax help button is clicked. Consumers can return `true` to signify that this event has been
-     * handled which will prevent default behaviour of the help button, i.e. `e.preventDefault()`.
+     * Called when the JQL editor has been initialised.
      */
-    onSyntaxHelp?: (e: MouseEvent<HTMLElement>) => boolean;
+    onEditorMounted?: () => void;
     /**
      * Called when the editor input is focused.
      */
     onFocus?: (e: FocusEvent<HTMLElement>) => void;
     /**
-     * Provider object to fetch autocomplete data.
+     * Called every time the editor needs to hydrate values for the current query.
      */
-    autocompleteProvider: AutocompleteProvider;
+    onHydrate?: (query: string) => Promise<HydratedValues>;
     /**
-     * Enables rich inline nodes feature, which will replace user identifiers with a lozenge containing name and avatar.
-     * Note that you must specify an `onHydrate` prop which will return user data for a given query in order to see the
-     * following behaviour:
-     *  - Loading of user avatars
-     *  - Rendering of user lozenges on component initialisation
-     *  - Rendering of user lozenges on paste
+     * Called if an unexpected error is thrown while rendering the editor.
      */
-    enableRichInlineNodes?: boolean;
+    onRenderError?: (error: Error) => void;
     /**
-     * `false` matches the Atlaskit default field styling
-     * `true` matches the Atlaskit compact field styling, generally used for search purposes.
+     * Called every time the search command is given in the editor with the current query value and respective Jast object.
+     * If not passed, hides the search button/other search related functionality, allowing this to be usable as a form field.
      */
-    isCompact?: boolean;
+    onSearch?: (query: string, jast: Jast) => void;
     /**
-     * Ref callback to force the focus event
+     * Called when the syntax help button is clicked. Consumers can return `true` to signify that this event has been
+     * handled which will prevent default behaviour of the help button, i.e. `e.preventDefault()`.
      */
-    inputRef?: Ref<{
-        focus: () => void;
-    }>;
+    onSyntaxHelp?: (e: MouseEvent<HTMLElement>) => boolean;
     /**
-     * Custom components to take over the rendering of certain parts of JQL editor
+     * Called every time the editor is updated with the current query value and respective Jast object.
      */
-    customComponents?: CustomComponents;
+    onUpdate?: (query: string, jast: Jast) => void;
+    /**
+     * The query to render in the editor.
+     */
+    query: string;
 };

package/dist/types/ui/jql-editor-controls-content/base-expand-toggle/index.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 type Props = {
-    expanded: boolean;
     editorId: string;
+    expanded: boolean;
     isDisabled?: boolean;
     label: string;
     onClick: () => void;

package/dist/types/ui/jql-editor-layout/index.d.ts

@@ -1,25 +1,25 @@
 import React, { type FocusEvent, type ReactNode } from 'react';
 type Props = {
-    /**
-     * React node to render within the footer.
-     */
-    EditorFooterContent: ReactNode;
     /**
      * React node to render within the editor controls group.
      */
     EditorControlsContent: ReactNode;
     /**
-     * Flag to determine whether the editor view (or autocomplete dropdown) currently has focus.
+     * React node to render within the footer.
      */
-    editorViewHasFocus: boolean;
+    EditorFooterContent: ReactNode;
     /**
-     * Flag to determine whether line numbers should be shown in the editor.
+     * Flag to determine whether the editor view (or autocomplete dropdown) currently has focus.
      */
-    lineNumbersVisible: boolean;
+    editorViewHasFocus: boolean;
     /**
      * Flag to determine if there were any JQL parse errors in the last submitted query.
      */
     editorViewIsInvalid: boolean;
+    /**
+     * Flag to determine whether line numbers should be shown in the editor.
+     */
+    lineNumbersVisible: boolean;
     /**
      * ID to assign to the main wrapper of the editor.
      */
@@ -28,6 +28,10 @@ type Props = {
      * Ref callback to the main wrapper of the editor.
      */
     onEditorMainRef?: (editorMain: HTMLElement | null) => void;
+    /**
+     * Callback when the editor view is blurred.
+     */
+    onEditorViewBlur?: () => void;
     /**
      * Ref callback to the editor view container element.
      */
@@ -36,18 +40,14 @@ type Props = {
      * Callback when the editor view is scrolled.
      */
     onEditorViewContainerScroll?: (event: React.UIEvent<HTMLElement>) => void;
-    /**
-     * Ref callback to the editor view element which the Prosemirror editor will be bound to.
-     */
-    onEditorViewRef?: (editorView: HTMLElement | null) => void;
-    /**
-     * Callback when the editor view is blurred.
-     */
-    onEditorViewBlur?: () => void;
     /**
      * Callback when the editor view is focused.
      */
     onEditorViewFocus?: (event: FocusEvent<HTMLElement>) => void;
+    /**
+     * Ref callback to the editor view element which the Prosemirror editor will be bound to.
+     */
+    onEditorViewRef?: (editorView: HTMLElement | null) => void;
     /**
      * Callback when the editor view receives a CSS transition end event.
      */
@@ -58,7 +58,7 @@ type ReadOnlyProps = {
     query: string;
 };
 export declare const JQLEditorReadOnly: ({ isSearch, isCompact, ...props }: ReadOnlyProps & {
-    isSearch?: boolean;
     isCompact?: boolean;
+    isSearch?: boolean;
 }) => React.JSX.Element;
 export default JQLEditorLayout;

package/dist/types/ui/jql-editor-layout/styled.d.ts

@@ -35,8 +35,8 @@ export declare const EditorView: import("@emotion/styled").StyledComponent<{
 } & {
     defaultMaxRows: number;
     expandedRows: number;
-    lineNumbersVisible: boolean;
     isCompact: boolean;
+    lineNumbersVisible: boolean;
 }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
 export declare const ReadOnlyEditorView: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme;
@@ -44,8 +44,8 @@ export declare const ReadOnlyEditorView: import("@emotion/styled").StyledCompone
 } & {
     defaultMaxRows: number;
     expandedRows: number;
-    lineNumbersVisible: boolean;
     isCompact: boolean;
+    lineNumbersVisible: boolean;
 } & import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & {
     theme?: import("@emotion/react").Theme;
 }, {}, {}>;
@@ -53,8 +53,8 @@ export declare const EditorControls: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme;
     as?: React.ElementType;
 } & {
-    isSearch: boolean;
     isCompact: boolean;
+    isSearch: boolean;
     isVisualRefresh?: boolean;
 }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
 export {};

package/dist/types/ui/jql-editor-portal-provider/types.d.ts

@@ -9,30 +9,30 @@ export type PortalActions = {
 export type PortalState = {
     components: {
         [key: string]: {
-            portalComponent: ReactNode;
             container: Container;
+            portalComponent: ReactNode;
         };
     };
     containers: PluginContainers;
 };
 type CreatePortalAction = {
-    type: 'createPortal';
     payload: {
+        container: Container;
         key: string;
         portalComponent: ReactNode;
-        container: Container;
     };
+    type: 'createPortal';
 };
 type DestroyPortalAction = {
-    type: 'destroyPortal';
     payload: string;
+    type: 'destroyPortal';
 };
 type RegisterPluginContainerAction = {
-    type: 'registerPluginContainer';
     payload: {
         containerKey: PluginContainerKey;
         element: HTMLElement | null;
     };
+    type: 'registerPluginContainer';
 };
 export type PortalAction = CreatePortalAction | DestroyPortalAction | RegisterPluginContainerAction;
 export {};

package/dist/types-ts4.5/analytics/listener/types.d.ts

@@ -1,7 +1,7 @@
 import { type GasPurePayload, type GasPureScreenEventPayload } from '@atlaskit/analytics-gas-types';
 export type AnalyticsWebClient = {
-    sendUIEvent: (event: GasPurePayload) => void;
     sendOperationalEvent: (event: GasPurePayload) => void;
-    sendTrackEvent: (event: GasPurePayload) => void;
     sendScreenEvent: (event: GasPureScreenEventPayload) => void;
+    sendTrackEvent: (event: GasPurePayload) => void;
+    sendUIEvent: (event: GasPurePayload) => void;
 };

package/dist/types-ts4.5/hooks/use-editor-theme/index.d.ts

@@ -12,26 +12,26 @@ export type EditorTheme = {
      */
     expandedRows: number;
     /**
-     * Toggle the editor view expanded state.
+     * `false` matches AK's default field styling
+     * `true` matches AK's compact field styling, generally used for search purposes.
      */
-    toggleExpanded: () => void;
+    isCompact: boolean;
     /**
      * `true` shows search button, other search related elements
      * `false` to act as a text field
      */
     isSearch: boolean;
     /**
-     * `false` matches AK's default field styling
-     * `true` matches AK's compact field styling, generally used for search purposes.
+     * Toggle the editor view expanded state.
      */
-    isCompact: boolean;
+    toggleExpanded: () => void;
 };
 export declare const EditorThemeContext: import("react").Context<EditorTheme>;
 /**
  * Hook to manage the theming state of the editor.
  */
 export declare const useEditorTheme: ({ isSearch, isCompact, }: {
-    isSearch?: boolean;
     isCompact?: boolean;
+    isSearch?: boolean;
 }) => EditorTheme;
 export declare const useEditorThemeContext: () => EditorTheme;

package/dist/types-ts4.5/plugins/autocomplete/components/autocomplete-dropdown/index.d.ts

@@ -2,10 +2,10 @@ import React from 'react';
 import { type PluginKeymap } from '../../../common/plugin-keymap';
 import { type AutocompleteAnalyticsAttributes, type SelectableAutocompleteOption } from '../types';
 type Props = {
-    options: SelectableAutocompleteOption[];
-    loading: boolean;
     keymap: PluginKeymap;
+    loading: boolean;
     onClick: (option: SelectableAutocompleteOption, analyticsAttributes: AutocompleteAnalyticsAttributes) => void;
+    options: SelectableAutocompleteOption[];
 };
 declare const AutocompleteDropdown: ({ options, loading, keymap, onClick }: Props) => React.JSX.Element | null;
 export default AutocompleteDropdown;

package/dist/types-ts4.5/plugins/autocomplete/components/autocomplete-option/index.d.ts

@@ -2,9 +2,9 @@ import React from 'react';
 import { type SelectableAutocompleteOption } from '../types';
 type Props = {
     isSelected: boolean;
-    option: SelectableAutocompleteOption;
     onClick: () => void;
     onMouseMove: () => void;
+    option: SelectableAutocompleteOption;
 };
 declare const AutocompleteOption: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLLIElement>>;
 export default AutocompleteOption;

package/dist/types-ts4.5/plugins/autocomplete/components/autocomplete-option/styled.d.ts

@@ -6,8 +6,8 @@ export declare const OptionListItem: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme;
     as?: React.ElementType;
 } & {
-    isSelected: boolean;
     isDeprecated: boolean;
+    isSelected: boolean;
 }, import("react").DetailedHTMLProps<import("react").LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, {}>;
 export declare const OptionName: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme;

package/dist/types-ts4.5/plugins/autocomplete/components/types.d.ts

@@ -4,9 +4,9 @@ import { type PluginKeymap } from '../../common/plugin-keymap';
 export type { AutocompleteProvider, AutocompleteOptions, AutocompleteOption, AutocompleteValueType, } from '@atlaskit/jql-editor-common';
 export type AutocompleteOptionType = 'field' | 'operator' | 'value' | 'function' | 'keyword';
 export type AutocompleteOptionExtra = {
-    replacePosition: Position;
     context: JQLRuleContext | null;
     matchedText: string;
+    replacePosition: Position;
     type: AutocompleteOptionType;
 };
 export type SelectableAutocompleteOption = AutocompleteOption & AutocompleteOptionExtra & {
@@ -14,15 +14,15 @@ export type SelectableAutocompleteOption = AutocompleteOption & AutocompleteOpti
 };
 export type SelectableAutocompleteOptions = SelectableAutocompleteOption[];
 export type AutocompleteOptionGroup = {
-    tokens: SelectableAutocompleteOptions;
     fields: SelectableAutocompleteOptions;
+    functions: SelectableAutocompleteOptions;
     operators: SelectableAutocompleteOptions;
+    tokens: SelectableAutocompleteOptions;
     values: SelectableAutocompleteOptions;
-    functions: SelectableAutocompleteOptions;
 };
 export type AutocompletePosition = {
-    top: number;
     left: number;
+    top: number;
 };
 export type AutocompleteProps = {
     keymap: PluginKeymap;
@@ -30,9 +30,9 @@ export type AutocompleteProps = {
 };
 export type AutocompleteAnalyticsAttributes = {
     keyboard: boolean;
+    nodeType: string;
     numberOfOptions: number;
     optionIndex: number;
     optionType: AutocompleteOptionType;
     queryLength: number;
-    nodeType: string;
 };

package/dist/types-ts4.5/plugins/rich-inline-nodes/nodes/types.d.ts

@@ -2,8 +2,8 @@ import { type FunctionComponent } from 'react';
 import { type AttributeSpec } from '@atlaskit/editor-prosemirror/model';
 import { type NodeViewProps } from '../util/react-node-view';
 export type JQLNodeSpec<Props> = {
-    component: FunctionComponent<NodeViewProps<Props>>;
     attrs: {
         [name: string]: AttributeSpec;
     };
+    component: FunctionComponent<NodeViewProps<Props>>;
 };

package/dist/types-ts4.5/plugins/rich-inline-nodes/nodes/user/index.d.ts

@@ -1,7 +1,7 @@
 import { type JQLNodeSpec } from '../types';
 export type Props = {
+    fieldName: string;
     id: string;
     name: string;
-    fieldName: string;
 };
 export declare const user: JQLNodeSpec<Props>;

package/dist/types-ts4.5/plugins/rich-inline-nodes/nodes/user/styled.d.ts

@@ -2,8 +2,8 @@ export declare const UserContainer: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme;
     as?: React.ElementType;
 } & {
-    selected: boolean;
     error: boolean;
+    selected: boolean;
 }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, {}>;
 export declare const NameContainer: import("@emotion/styled").StyledComponent<{
     theme?: import("@emotion/react").Theme;

package/dist/types-ts4.5/plugins/rich-inline-nodes/util/react-node-view.d.ts

@@ -3,8 +3,8 @@ import { type Node } from '@atlaskit/editor-prosemirror/model';
 import { type Decoration, type NodeView } from '@atlaskit/editor-prosemirror/view';
 import { type PortalActions } from '../../../ui/jql-editor-portal-provider/types';
 export type NodeViewProps<Props> = Props & {
-    selected: boolean;
     error: boolean;
+    selected: boolean;
 };
 export declare class ReactNodeView<Props> implements NodeView {
     private readonly component;

package/dist/types-ts4.5/plugins/types.d.ts

@@ -1,16 +1,16 @@
 export type { AutocompleteProvider, AutocompleteOptions, AutocompleteOption, AutocompleteValueType, } from './autocomplete/types';
 export type PluginContainers = {
     /**
-     * Container for plugin components which should be appended to the top level container element.
+     * Container for plugin components which should be appended at the end of the editor input.
      */
-    main?: HTMLElement;
+    editor_controls?: HTMLElement;
     /**
      * Container for plugin components which should be appended to the footer underneath the editor input.
      */
     footer?: HTMLElement;
     /**
-     * Container for plugin components which should be appended at the end of the editor input.
+     * Container for plugin components which should be appended to the top level container element.
      */
-    editor_controls?: HTMLElement;
+    main?: HTMLElement;
 };
 export type PluginContainerKey = keyof PluginContainers;

package/dist/types-ts4.5/plugins/validation-tooltip/view.d.ts

@@ -2,10 +2,10 @@ import { type EditorState } from '@atlaskit/editor-prosemirror/state';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 import { JQLSyntaxError } from '@atlaskit/jql-ast';
 type Coords = {
+    bottom: number;
     left: number;
     right: number;
     top: number;
-    bottom: number;
 };
 export declare class ValidationTooltipPluginView {
     tooltip: HTMLElement;