@neo4j-cypher/react-codemirror 2.0.0-next.4 → 2.0.0-next.40

package/CHANGELOG.md

@@ -1,5 +1,355 @@
 # @neo4j-cypher/react-codemirror
 
+## 2.0.0-next.40
+
+### Minor Changes
+
+- 0ddd727: wrap placeholder around editor actions
+- 9266800: normalize CRLF line endings
+
+### Patch Changes
+
+- ce3820b: Update grammar and semantic analysis to 2026.08
+- Updated dependencies [ce3820b]
+- Updated dependencies [6c863cd]
+  - @neo4j-cypher/language-support@2.0.0-next.37
+  - @neo4j-cypher/lint-worker@1.10.1-next.14
+
+## 2.0.0-next.39
+
+### Patch Changes
+
+- Updated dependencies [50f061e]
+  - @neo4j-cypher/language-support@2.0.0-next.36
+  - @neo4j-cypher/lint-worker@1.10.1-next.13
+
+## 2.0.0-next.38
+
+### Patch Changes
+
+- 6866132: Update grammar and semantic analysis to 2026.07
+- 9c65003: Declares `react-dom` as a peer dependency, since `CypherEditor` now imports `createPortal` from it to render the editor action buttons overlay
+- Updated dependencies [6866132]
+  - @neo4j-cypher/language-support@2.0.0-next.35
+  - @neo4j-cypher/lint-worker@1.10.1-next.12
+
+## 2.0.0-next.37
+
+### Patch Changes
+
+- b616748: Add diff view to the Cypher editor using @codemirror/merge
+- Updated dependencies [2f8b52d]
+  - @neo4j-cypher/language-support@2.0.0-next.34
+  - @neo4j-cypher/lint-worker@1.10.1-next.11
+
+## 2.0.0-next.36
+
+### Patch Changes
+
+- 2d5fa77: Add `inlinePanel` prop to `CypherEditor` for rendering a host-controlled panel as a block widget inside the editor.
+- 02df611: Hide parameter errors when disconnected
+- Updated dependencies [02df611]
+- Updated dependencies [e69ee30]
+  - @neo4j-cypher/language-support@2.0.0-next.33
+  - @neo4j-cypher/lint-worker@1.10.1-next.10
+
+## 2.0.0-next.35
+
+### Patch Changes
+
+- cd4ab49: Update grammar and semantic analysis to 2026.05
+- Updated dependencies [cd4ab49]
+- Updated dependencies [0b2d441]
+  - @neo4j-cypher/language-support@2.0.0-next.32
+  - @neo4j-cypher/lint-worker@1.10.1-next.9
+
+## 2.0.0-next.34
+
+### Patch Changes
+
+- 3b2faf5: Rewrite global parserWrapper to instantiated languageService and add symbol fetching to react-codemirror
+- Updated dependencies [08f94af]
+- Updated dependencies [0763d97]
+- Updated dependencies [3b2faf5]
+- Updated dependencies [ca1bba6]
+  - @neo4j-cypher/language-support@2.0.0-next.31
+  - @neo4j-cypher/lint-worker@1.10.1-next.8
+
+## 2.0.0-next.33
+
+### Patch Changes
+
+- Updated dependencies [0e457d6]
+- Updated dependencies [b0170f9]
+- Updated dependencies [25fad16]
+  - @neo4j-cypher/language-support@2.0.0-next.30
+  - @neo4j-cypher/lint-worker@1.10.1-next.7
+
+## 2.0.0-next.32
+
+### Patch Changes
+
+- Updated dependencies [bfdc70e]
+  - @neo4j-cypher/language-support@2.0.0-next.29
+  - @neo4j-cypher/lint-worker@1.10.1-next.6
+
+## 2.0.0-next.31
+
+### Patch Changes
+
+- Updated dependencies [5df1435]
+  - @neo4j-cypher/language-support@2.0.0-next.28
+  - @neo4j-cypher/lint-worker@1.10.1-next.5
+
+## 2.0.0-next.30
+
+### Patch Changes
+
+- Updated dependencies [6a2a408]
+- Updated dependencies [20b31b6]
+- Updated dependencies [68d92a8]
+  - @neo4j-cypher/lint-worker@1.10.1-next.4
+  - @neo4j-cypher/language-support@2.0.0-next.27
+
+## 2.0.0-next.29
+
+### Patch Changes
+
+- Updated dependencies [8e8d7f1]
+- Updated dependencies [808aa73]
+  - @neo4j-cypher/language-support@2.0.0-next.26
+  - @neo4j-cypher/lint-worker@1.10.1-next.3
+
+## 2.0.0-next.28
+
+### Patch Changes
+
+- Updated dependencies [b1e686e]
+  - @neo4j-cypher/language-support@2.0.0-next.25
+  - @neo4j-cypher/lint-worker@1.10.1-next.2
+
+## 2.0.0-next.27
+
+### Patch Changes
+
+- 86f5c55: adding rich clipboard copier to codemirror
+- 5fdc6dd: Fixes faulty worker termination on big queries
+- Updated dependencies [246d60c]
+- Updated dependencies [8eacddd]
+- Updated dependencies [3a29711]
+- Updated dependencies [b9c0e9d]
+- Updated dependencies [d77e8a1]
+- Updated dependencies [5fdc6dd]
+- Updated dependencies [7183c63]
+  - @neo4j-cypher/lint-worker@1.10.1-next.1
+  - @neo4j-cypher/language-support@2.0.0-next.24
+
+## 2.0.0-next.26
+
+### Patch Changes
+
+- Updated dependencies [c065d85]
+  - @neo4j-cypher/language-support@2.0.0-next.23
+  - @neo4j-cypher/lint-worker@1.10.1-next.0
+
+## 2.0.0-next.25
+
+### Patch Changes
+
+- d99368c: Ensures CRLF newlines are handled when setting editor value
+- Updated dependencies [ed65ef3]
+- Updated dependencies [7538cfd]
+- Updated dependencies [c1fa91f]
+- Updated dependencies [039d1c5]
+- Updated dependencies [1ef063e]
+- Updated dependencies [a38255f]
+- Updated dependencies [c4f27c9]
+  - @neo4j-cypher/language-support@2.0.0-next.22
+  - @neo4j-cypher/lint-worker@0.1.0-next.0
+
+## 2.0.0-next.24
+
+### Patch Changes
+
+- 8b03317: resetting z index for cm panels
+- Updated dependencies [4b0ee37]
+  - @neo4j-cypher/language-support@2.0.0-next.21
+  - @neo4j-cypher/lint-worker@2025.4.1-next.0
+
+## 2.0.0-next.23
+
+### Patch Changes
+
+- Updated dependencies [013e4ff]
+  - @neo4j-cypher/language-support@2.0.0-next.20
+
+## 2.0.0-next.22
+
+### Patch Changes
+
+- 5bfdac2: restructure packages as part of move to pnpm
+- Updated dependencies [88e4930]
+- Updated dependencies [5bfdac2]
+  - @neo4j-cypher/language-support@2.0.0-next.19
+
+## 2.0.0-next.21
+
+### Patch Changes
+
+- Updated dependencies [1b971aa]
+- Updated dependencies [07ac90f]
+  - @neo4j-cypher/language-support@2.0.0-next.18
+
+## 2.0.0-next.20
+
+### Patch Changes
+
+- Updated dependencies [bffbb19]
+- Updated dependencies [826d922]
+- Updated dependencies [1caab0c]
+  - @neo4j-cypher/language-support@2.0.0-next.17
+
+## 2.0.0-next.19
+
+### Patch Changes
+
+- a3e3e50: updating themes to use needle colors
+- Updated dependencies [68f55d4]
+- Updated dependencies [6d00433]
+- Updated dependencies [c01b32a]
+  - @neo4j-cypher/language-support@2.0.0-next.16
+
+## 2.0.0-next.18
+
+### Patch Changes
+
+- Updated dependencies [50cc73e]
+- Updated dependencies [5ef538d]
+- Updated dependencies [b988d3b]
+  - @neo4j-cypher/language-support@2.0.0-next.15
+
+## 2.0.0-next.17
+
+### Patch Changes
+
+- 245fb6a: Automatically opens autocompletions after "YIELD "
+- Updated dependencies [8ec797d]
+- Updated dependencies [7aa9c3a]
+- Updated dependencies [2be5469]
+- Updated dependencies [245fb6a]
+- Updated dependencies [c587b81]
+- Updated dependencies [3f8b64f]
+- Updated dependencies [043d766]
+- Updated dependencies [704d1c5]
+  - @neo4j-cypher/language-support@2.0.0-next.14
+
+## 2.0.0-next.16
+
+### Patch Changes
+
+- Updated dependencies [84a12fc]
+- Updated dependencies [d329252]
+- Updated dependencies [b0e419e]
+  - @neo4j-cypher/language-support@2.0.0-next.13
+
+## 2.0.0-next.15
+
+### Patch Changes
+
+- adc5b64: using custom light color theme for the cypher editor
+- Updated dependencies [88fbe63]
+- Updated dependencies [22081b0]
+- Updated dependencies [62ac442]
+  - @neo4j-cypher/language-support@2.0.0-next.12
+
+## 2.0.0-next.14
+
+### Patch Changes
+
+- d85c1e0: Fixes bug with auto-completions
+- Updated dependencies [bccf518]
+  - @neo4j-cypher/language-support@2.0.0-next.11
+
+## 2.0.0-next.13
+
+### Patch Changes
+
+- Updated dependencies [8760c02]
+  - @neo4j-cypher/language-support@2.0.0-next.10
+
+## 2.0.0-next.12
+
+### Patch Changes
+
+- dcbe67d: Expose moveFocusOnTab property on the CypherEditor component to conditionally disable tab keymappings
+- e9621c8: Re-export language support from react codemirror
+- Updated dependencies [2e72ac8]
+  - @neo4j-cypher/language-support@2.0.0-next.9
+
+## 2.0.0-next.11
+
+### Patch Changes
+
+- Updated dependencies [05663bd]
+  - @neo4j-cypher/language-support@2.0.0-next.8
+
+## 2.0.0-next.10
+
+### Patch Changes
+
+- bb7e9d3: Simplify detection and handling of value prop updates
+
+## 2.0.0-next.9
+
+### Patch Changes
+
+- fbd5f7e: allow signature help panel to render below editor when there's not enough space above it
+- 09dfae2: Add an ariaLabel prop to CypherEditor
+- 7154e94: Fix bug causing debouncing to override value
+- 62c152f: execute single line query on enter by default
+- cbfc75e: Fix a bug causing debounced value updates to get cancelled erroneously
+- 04ae35e: Set initial latestDispatchedValue and flush debounced changes onExecute
+  Add tests for debounce behaviour
+- Updated dependencies [3661e9d]
+- Updated dependencies [b76af58]
+- Updated dependencies [21699b7]
+- Updated dependencies [6afc0e3]
+- Updated dependencies [39b924d]
+  - @neo4j-cypher/language-support@2.0.0-next.7
+
+## 2.0.0-next.8
+
+### Patch Changes
+
+- 6cc9022: Adds more props to the CypherEditor component
+- Updated dependencies [e92d8c7]
+  - @neo4j-cypher/language-support@2.0.0-next.6
+
+## 2.0.0-next.7
+
+### Patch Changes
+
+- Updated dependencies [1f790d0]
+  - @neo4j-cypher/language-support@2.0.0-next.5
+
+## 2.0.0-next.6
+
+### Patch Changes
+
+- Updated dependencies
+  - @neo4j-cypher/language-support@2.0.0-next.4
+
+## 2.0.0-next.5
+
+### Patch Changes
+
+- 8cc77c6: Add support for console commands
+- 1e210cb: Moves semantic analysis to a separate worker file
+- Updated dependencies [8cc77c6]
+- Updated dependencies [1e210cb]
+- Updated dependencies [f6d20b2]
+  - @neo4j-cypher/language-support@2.0.0-next.3
+
 ## 2.0.0-next.4
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # React Codemirror
 
-This package can be built with `npm run build` and then published to npm with `npm publish`.
+This package can be built with `pnpm build` and then published to npm with `pnpm publish`.
 
 ## Usage
 
@@ -27,7 +27,8 @@ For a full example, see the [react-codemirror-playground](https://github.com/neo
 Currently we only support using the codemirror editor via the react wrapper, but we plan to release the codemirror extensions separately as well.
 
 ## Learning codemirror
-It can take a little time to get into the CodeMirror6 ways of thinking, Trevor Harmon has a [great blog post](https://thetrevorharmon.com/blog/learning-codemirror/) explaining the cm6 "primitives". He also has a demo on how to integrate ANTLR4 with codemirror over [here](https://github.com/thetrevorharmon/zephyr-demo). 
+
+It can take a little time to get into the CodeMirror6 ways of thinking, Trevor Harmon has a [great blog post](https://thetrevorharmon.com/blog/learning-codemirror/) explaining the cm6 "primitives". He also has a demo on how to integrate ANTLR4 with codemirror over [here](https://github.com/thetrevorharmon/zephyr-demo).
 
 ### Completion Icons
 

package/dist/src/CypherEditor.d.ts

@@ -0,0 +1,243 @@
+import { EditorState, Extension } from '@codemirror/state';
+import { EditorView, KeyBinding, ViewUpdate } from '@codemirror/view';
+import { type InlinePanelCallbacks } from './inlinePanel';
+import { type DiffProps } from './diffView';
+import { CypherLanguageService, type DbSchema } from '@neo4j-cypher/language-support';
+import { Component, type ReactNode } from 'react';
+type DomEventHandlers = Parameters<typeof EditorView.domEventHandlers>[0];
+export interface CypherEditorProps {
+    /**
+     * The prompt to show on single line editors
+     */
+    prompt?: string;
+    /**
+     * Custom keybindings to add to the editor.
+     * See https://codemirror.net/6/docs/ref/#keymap.of
+     */
+    extraKeybindings?: KeyBinding[];
+    /**
+     * Callback on query execution, triggered via ctrl/cmd + Enter.
+     * If provided, will enable "repl-mode", which turns on navigating editor history
+     *
+     * @param cmd - the editor value when ctrl/cmd + enter was pressed
+     * @returns void
+     */
+    onExecute?: (cmd: string) => void;
+    /**
+     * If true, pressing enter will add a new line to the editor and cmd/ctrl + enter will execute the query.
+     * Otherwise pressing enter on a single line will execute the query.
+     *
+     * @default false
+     */
+    newLineOnEnter?: boolean;
+    /**
+     * The editor history navigable via up/down arrow keys. Order newest to oldest.
+     * Add to this list with the `onExecute` callback for REPL style history.
+     */
+    history?: string[];
+    /**
+     * When set to `true` the editor will use the background color of the parent element.
+     *
+     * @default false
+     */
+    overrideThemeBackgroundColor?: boolean;
+    /**
+     * Whether the editor should take focus on mount.
+     * Will move the cursor to the end of the query when provided with an initial value.
+     *
+     * @default false
+     */
+    autofocus?: boolean;
+    /**
+     * Where to place the cursor in the query. Cannot be enabled at the same time than autofocus
+     */
+    offset?: number;
+    /**
+     * Whether the editor should wrap lines.
+     *
+     * @default false
+     */
+    lineWrap?: boolean;
+    /**
+     * Whether the editor should perform syntax validation.
+     *
+     * @default true
+     */
+    lint?: boolean;
+    /**
+     * Whether the signature help tooltip should be shown below the text.
+     * If false, it will be shown above.
+     *
+     * @default true
+     */
+    showSignatureTooltipBelow?: boolean;
+    /**
+     * Internal feature flags for the editor. Don't use in production
+     *
+     */
+    featureFlags?: {
+        consoleCommands?: boolean;
+    };
+    /**
+     * The schema to use for autocompletion and linting.
+     *
+     * @type {DbSchema}
+     */
+    schema?: DbSchema;
+    /**
+     * The current value of the editor.
+     */
+    value?: string;
+    /**
+     * Extra css classnames to add to the editor container.
+     */
+    className?: string;
+    /**
+     * Set the built in theme or provide a custom theme.
+     *
+     * `light` / `dark` / `Extension`
+     *  @default light
+     */
+    theme?: 'light' | 'dark' | Extension;
+    /**
+     * Callback when the editor value changes.
+     * @param {string} value - the current editor value
+     * @param {ViewUpdate} viewUpdate - the view update from codemirror
+     */
+    onChange?(value: string, viewUpdate: ViewUpdate): void;
+    /**
+     * Map of event handlers to add to the editor.
+     *
+     * Note that the props are compared by reference, meaning object defined inline
+     * will cause the editor to re-render (much like the style prop does in this example:
+     * <div style={{}} />
+     *
+     * Memoize the object if you want/need to avoid this.
+     *
+     * @example
+     * // listen to blur events
+     * <CypherEditor domEventHandlers={{blur: () => console.log("blur event fired")}} />
+     */
+    domEventHandlers?: DomEventHandlers;
+    /**
+     * Placeholder text to display when the editor is empty.
+     */
+    placeholder?: string;
+    /**
+     * Whether the editor should show line numbers.
+     *
+     * @default true
+     */
+    lineNumbers?: boolean;
+    /**
+     * Whether the editor is read-only.
+     *
+     * @default false
+     */
+    readonly?: boolean;
+    /**
+     * String value to assign to the aria-label attribute of the editor.
+     */
+    ariaLabel?: string;
+    /**
+     * Whether keybindings for inserting indents with the Tab key should be disabled.
+     *
+     * true will not create keybindings for inserting indents.
+     * false will create keybindings for inserting indents.
+     *
+     * @default false
+     */
+    moveFocusOnTab?: boolean;
+    /**
+     * Render a panel as a block widget inside the editor.
+     * The widget DOM is only rebuilt when `pos` or `placement` change
+     */
+    inlinePanel?: InlinePanelProps | null;
+    /**
+     * Render a unified diff of the current document against `diff.original`.
+     * Deleted lines are shown as uneditable widgets.
+     */
+    diff?: DiffProps | null;
+    /**
+     * React content rendered as a cluster of action buttons (e.g. a context menu
+     * + Run) pinned to the top-right corner of the editor. Omit (or `null`) to
+     * hide it.
+     */
+    editorActions?: ReactNode;
+}
+export type InlinePanelProps = {
+    /**
+     * Position the panel anchors to.
+     */
+    pos: number;
+    /**
+     * Whether to render above or below the line
+     *
+     * @default 'above'
+     */
+    placement?: 'above' | 'below';
+} & InlinePanelCallbacks;
+type CypherEditorState = {
+    editorActionsContainer: HTMLElement | null;
+};
+declare class CodemirrorSymbolFetcher {
+    constructor(languageService: CypherLanguageService);
+    private languageService;
+    private processing;
+    private nextJob;
+    private symbolTablePool;
+    queueSymbolJob(query: string, schema: DbSchema): void;
+    terminate(): void;
+    private processJobQueue;
+}
+export declare class CypherEditor extends Component<CypherEditorProps, CypherEditorState> {
+    /**
+     * The symbol fetcher object used to fetch the current symbol table on document changes
+     */
+    symbolFetcher: CodemirrorSymbolFetcher;
+    /**
+     * The codemirror editor container.
+     */
+    editorContainer: React.RefObject<HTMLDivElement>;
+    /**
+     * The codemirror editor state.
+     */
+    editorState: React.MutableRefObject<EditorState>;
+    /**
+     * The codemirror editor view.
+     */
+    editorView: React.MutableRefObject<EditorView>;
+    private schemaRef;
+    private inlinePanelController;
+    private editorActionsController;
+    state: CypherEditorState;
+    private editorActionsCallbacks;
+    /**
+     * Format Cypher query
+     */
+    format(): void;
+    /**
+     * Focus the editor
+     */
+    focus(): void;
+    /**
+     * Move the cursor to the supplied position.
+     * For example, to move the cursor to the end of the editor, use `value.length`
+     */
+    updateCursorPosition(position: number): void;
+    /**
+     * Externally set the editor value and focus the editor.
+     */
+    setValueAndFocus(value?: string): void;
+    static defaultProps: CypherEditorProps;
+    private debouncedOnChange;
+    componentDidMount(): void;
+    private setEditorActions;
+    private openInlinePanel;
+    private updateInlinePanel;
+    private closeInlinePanel;
+    componentDidUpdate(prevProps: CypherEditorProps): void;
+    componentWillUnmount(): void;
+    render(): React.ReactNode;
+}
+export {};