@atlaskit/jql-editor 4.0.0

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

@@ -0,0 +1,64 @@
+import React, { FocusEvent, 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.
+     */
+    editorViewHasFocus: boolean;
+    /**
+     * Flag to determine whether line numbers should be shown in the editor.
+     */
+    lineNumbersVisible: boolean;
+    /**
+     * Flag to determine if there were any JQL parse errors in the last submitted query.
+     */
+    editorViewIsInvalid: boolean;
+    /**
+     * ID to assign to the main wrapper of the editor.
+     */
+    mainId: string;
+    /**
+     * Ref callback to the main wrapper of the editor.
+     */
+    onEditorMainRef?: (editorMain: HTMLElement | null) => void;
+    /**
+     * Ref callback to the editor view container element.
+     */
+    onEditorViewContainerRef?: (editorViewContainer: HTMLElement | null) => void;
+    /**
+     * 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;
+    /**
+     * Callback when the editor view receives a CSS transition end event.
+     */
+    onEditorViewTransitionEnd?: () => void;
+};
+declare const JQLEditorLayout: (props: Props) => JSX.Element;
+type ReadOnlyProps = {
+    query: string;
+};
+export declare const JQLEditorReadOnly: ({ isSearch, isCompact, ...props }: ReadOnlyProps & {
+    isSearch?: boolean | undefined;
+    isCompact?: boolean | undefined;
+}) => JSX.Element;
+export default JQLEditorLayout;

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

@@ -0,0 +1,65 @@
+/// <reference types="react" />
+export declare const EditorMain: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
+export declare const EditorFooter: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
+type EditorViewContainerProps = {
+    editorViewHasFocus?: boolean;
+    editorViewIsInvalid?: boolean;
+};
+export declare const EditorViewContainer: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, EditorViewContainerProps, object>;
+export declare const ReadOnlyEditorViewContainer: import("@emotion/styled-base").StyledComponent<Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & Pick<EditorViewContainerProps, keyof EditorViewContainerProps> & {
+    theme?: object | undefined;
+} & {
+    children?: import("react").ReactNode;
+}, "key" | keyof import("react").HTMLAttributes<HTMLDivElement> | "theme" | keyof EditorViewContainerProps> & {
+    ref?: ((instance: HTMLDivElement | null) => void) | import("react").RefObject<HTMLDivElement> | null | undefined;
+}, Pick<Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & Pick<EditorViewContainerProps, keyof EditorViewContainerProps> & {
+    theme?: object | undefined;
+} & {
+    children?: import("react").ReactNode;
+}, "key" | keyof import("react").HTMLAttributes<HTMLDivElement> | "theme" | keyof EditorViewContainerProps> & {
+    ref?: ((instance: HTMLDivElement | null) => void) | import("react").RefObject<HTMLDivElement> | null | undefined;
+}, keyof import("react").HTMLAttributes<HTMLDivElement> | "theme" | keyof EditorViewContainerProps>, object>;
+export declare const LineNumberToolbar: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
+    lineNumbersVisible: boolean;
+}, object>;
+/**
+ * The main div which the Prosemirror editor will be rendered into.
+ */
+export declare const EditorView: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
+    defaultMaxRows: number;
+    expandedRows: number;
+    lineNumbersVisible: boolean;
+    isCompact: boolean;
+}, object>;
+export declare const ReadOnlyEditorView: import("@emotion/styled-base").StyledComponent<Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & Pick<{
+    defaultMaxRows: number;
+    expandedRows: number;
+    lineNumbersVisible: boolean;
+    isCompact: boolean;
+}, "isCompact" | "lineNumbersVisible" | "defaultMaxRows" | "expandedRows"> & {
+    theme?: object | undefined;
+} & {
+    children?: import("react").ReactNode;
+}, "isCompact" | "key" | keyof import("react").HTMLAttributes<HTMLDivElement> | "theme" | "lineNumbersVisible" | "defaultMaxRows" | "expandedRows"> & {
+    ref?: ((instance: HTMLDivElement | null) => void) | import("react").RefObject<HTMLDivElement> | null | undefined;
+}, Pick<Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & Pick<{
+    defaultMaxRows: number;
+    expandedRows: number;
+    lineNumbersVisible: boolean;
+    isCompact: boolean;
+}, "isCompact" | "lineNumbersVisible" | "defaultMaxRows" | "expandedRows"> & {
+    theme?: object | undefined;
+} & {
+    children?: import("react").ReactNode;
+}, "isCompact" | "key" | keyof import("react").HTMLAttributes<HTMLDivElement> | "theme" | "lineNumbersVisible" | "defaultMaxRows" | "expandedRows"> & {
+    ref?: ((instance: HTMLDivElement | null) => void) | import("react").RefObject<HTMLDivElement> | null | undefined;
+}, "isCompact" | keyof import("react").HTMLAttributes<HTMLDivElement> | "theme" | "lineNumbersVisible" | "defaultMaxRows" | "expandedRows"> & {
+    theme: object;
+} & {
+    theme: object;
+}, object>;
+export declare const EditorControls: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
+    isSearch: boolean;
+    isCompact: boolean;
+}, object>;
+export {};

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

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { PortalActions } from './types';
+export declare const PortalActionsContext: import("react").Context<PortalActions>;
+export declare const usePortalActionsContext: () => PortalActions;

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

@@ -0,0 +1,7 @@
+import { ReactNode } from 'react';
+/**
+ * Provides actions to manage portals via context and renders portalled components into the React tree.
+ */
+export declare const JQLEditorPortalRenderer: ({ children, }: {
+    children: ReactNode;
+}) => JSX.Element;

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

@@ -0,0 +1,38 @@
+import { ReactNode } from 'react';
+import { PluginContainerKey, PluginContainers } from '../../plugins/types';
+export type Container = PluginContainerKey | Element;
+export type PortalActions = {
+    onCreatePortal: (key: string, portalComponent: ReactNode, container: Container) => void;
+    onDestroyPortal: (key: string) => void;
+    onRegisterPluginContainer: (containerKey: PluginContainerKey, element: HTMLElement | null) => void;
+};
+export type PortalState = {
+    components: {
+        [key: string]: {
+            portalComponent: ReactNode;
+            container: Container;
+        };
+    };
+    containers: PluginContainers;
+};
+type CreatePortalAction = {
+    type: 'createPortal';
+    payload: {
+        key: string;
+        portalComponent: ReactNode;
+        container: Container;
+    };
+};
+type DestroyPortalAction = {
+    type: 'destroyPortal';
+    payload: string;
+};
+type RegisterPluginContainerAction = {
+    type: 'registerPluginContainer';
+    payload: {
+        containerKey: PluginContainerKey;
+        element: HTMLElement | null;
+    };
+};
+export type PortalAction = CreatePortalAction | DestroyPortalAction | RegisterPluginContainerAction;
+export {};

package/dist/types-ts4.5/ui/jql-editor-view/index.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+/**
+ * This wraps ProseMirror's EditorView as a React component.
+ */
+declare const JQLEditorView: ({ inputRef, }: {
+    inputRef?: React.Ref<{
+        focus: () => void;
+    }> | undefined;
+}) => JSX.Element;
+export default JQLEditorView;

package/dist/types-ts4.5/ui/messages.d.ts

@@ -0,0 +1,7 @@
+export declare const messages: {
+    inputLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.5/ui/tooltip-tag/index.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const TooltipTag: React.ForwardRefExoticComponent<React.RefAttributes<HTMLElement>>;

package/dist/types-ts4.5/ui/tooltip-tag/styled.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const StyledTooltipTag: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;

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

@@ -0,0 +1,9 @@
+import { JQLEditorUIProps } from './jql-editor/types';
+export type { JQLEditorUIProps, HydratedValue, HydratedValues, HydratedUser, } from './jql-editor/types';
+export type JQLEditorProps = JQLEditorUIProps & {
+    /**
+     * React-intl locale. This should be set to "en" if alternate message sets are not being loaded higher in the React
+     * tree.
+     */
+    locale?: string;
+};

package/dist/types-ts4.5/utils/document-text/index.d.ts

@@ -0,0 +1,9 @@
+import { Fragment, Node } from '@atlaskit/editor-prosemirror/model';
+/**
+ * Get all text between positions `from` and `to` with a newline char between block nodes.
+ */
+export declare const getNodeText: (node: Node, from: number, to: number) => string;
+/**
+ * Get all text between positions `from` and `to` with a newline char between block nodes.
+ */
+export declare const getFragmentText: (fragment: Fragment, from: number, to: number) => string;

package/dist/types-ts4.5/utils/split-text-by-new-line/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Splits the provided text by new line characters.
+ */
+export declare const splitTextByNewLine: (text: string) => string[];

package/i18n/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/jql-editor/i18n",
+  "main": "../dist/cjs/i18n/index.js",
+  "module": "../dist/esm/i18n/index.js",
+  "module:es2019": "../dist/es2019/i18n/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/i18n/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "../dist/types-ts4.5/i18n/index.d.ts"
+      ]
+    }
+  }
+}

package/package.json

@@ -0,0 +1,127 @@
+{
+  "name": "@atlaskit/jql-editor",
+  "version": "4.0.0",
+  "description": "This package allows consumers to render an advanced JQL editor component to enable autocomplete-assisted authoring and validation of JQL queries.",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Jira Platform: Search Experience / Empanada",
+    "inPublicMirror": true,
+    "releaseModel": "continuous",
+    "website": {
+      "name": "JQL Editor",
+      "category": "JQL"
+    }
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "main": "dist/cjs/index.js",
+  "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"
+      ]
+    }
+  },
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts",
+    "./i18n": "./src/i18n/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/analytics-gas-types": "^5.1.0",
+    "@atlaskit/analytics-next": "^9.1.0",
+    "@atlaskit/avatar": "^21.4.0",
+    "@atlaskit/button": "^17.2.0",
+    "@atlaskit/editor-prosemirror": "1.1.0",
+    "@atlaskit/form": "^9.0.3",
+    "@atlaskit/icon": "^22.0.0",
+    "@atlaskit/jql-ast": "^3.0.0",
+    "@atlaskit/jql-autocomplete": "^2.0.0",
+    "@atlaskit/jql-editor-common": "^2.0.0",
+    "@atlaskit/jql-parser": "^2.0.0",
+    "@atlaskit/spinner": "^16.0.0",
+    "@atlaskit/theme": "^12.6.0",
+    "@atlaskit/tokens": "^1.33.0",
+    "@atlaskit/tooltip": "^18.1.0",
+    "@babel/runtime": "^7.0.0",
+    "@emotion/react": "^11.7.1",
+    "@emotion/styled": "^10.0.7",
+    "@react-loosely-lazy/manifest": "^1.0.0",
+    "antlr4ts": "0.5.0-alpha.4",
+    "assert": "^2.0.0",
+    "lodash": "^4.17.21",
+    "react-intl-next": "npm:react-intl@^5.18.1",
+    "react-loosely-lazy": "^1.0.0",
+    "react-magnetic-di": "^2.2.6",
+    "react-sweet-state": "^2.6.5",
+    "rxjs": "^5.5.0",
+    "util": "^0.12.4",
+    "uuid": "^3.1.0"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0",
+    "react-dom": "^16.8.0"
+  },
+  "devDependencies": {
+    "@af/integration-testing": "*",
+    "@atlaskit/docs": "*",
+    "@atlaskit/jql-editor-autocomplete-rest": "^2.0.0",
+    "@atlaskit/visual-regression": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@storybook/addon-actions": "^5.2.5",
+    "@storybook/addon-knobs": "^5.3.18",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^12.1.5",
+    "@testing-library/react-hooks": "^8.0.1",
+    "typescript": "~4.9.5",
+    "wait-for-expect": "^1.2.0"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "import-structure": [
+        "atlassian-conventions"
+      ],
+      "circular-dependencies": [
+        "file-and-folder-level"
+      ]
+    },
+    "@repo/internal": {
+      "analytics": [
+        "analytics-next"
+      ],
+      "design-tokens": [
+        "color",
+        "spacing"
+      ],
+      "theming": [
+        "react-context"
+      ],
+      "ui-components": [
+        "lite-mode"
+      ],
+      "deprecation": [
+        "no-deprecated-imports"
+      ],
+      "imports": [
+        "import-no-extraneous-disable-for-examples-and-docs"
+      ]
+    }
+  },
+  "stricter": {
+    "no-unused-dependencies": {
+      "exclude": [
+        "assert",
+        "util"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}