@neo4j-cypher/react-codemirror 2.0.0-next.41 → 2.0.0-next.42

package/dist/src/lang-cypher/hover/hoverRender.test.js

@@ -0,0 +1,123 @@
+// @vitest-environment jsdom
+import { CypherLanguageService, testData, } from '@neo4j-cypher/language-support';
+import { describe, expect, test } from 'vitest';
+import { renderHoverInfo } from './hoverRender';
+function methodHover(query) {
+    const languageService = new CypherLanguageService();
+    return languageService.hoverInfo(query, {
+        caretPosition: query.indexOf('(') - 1,
+        dbSchema: testData.mockSchema,
+    });
+}
+function renderMethodHover(query) {
+    return renderHoverInfo(methodHover(query));
+}
+describe('hover info html rendering', () => {
+    function highlightedFragments(info) {
+        const seen = [];
+        renderHoverInfo(info, (code, kind, target) => {
+            seen.push([code, kind]);
+            target.textContent = code;
+        });
+        return seen;
+    }
+    test('passes the fragment kind of each cypher block to the highlighter', () => {
+        expect(highlightedFragments({
+            kind: 'variable',
+            variable: 'n',
+            types: ['Node'],
+            labelExpression: '(Person | Pet)',
+        })).toEqual([['(Person | Pet)', 'labelExpression']]);
+        expect(highlightedFragments(methodHover('RETURN abs(1)'))).toEqual([
+            ['abs(input :: INTEGER | FLOAT) :: INTEGER | FLOAT', 'function'],
+        ]);
+        expect(highlightedFragments(methodHover('CALL db.labels()'))).toEqual([
+            ['db.labels() :: (label :: STRING)', 'procedure'],
+        ]);
+    });
+    test('renders a variable hover', () => {
+        expect(renderHoverInfo({
+            kind: 'variable',
+            variable: 'n',
+            types: ['Node'],
+            labelExpression: '(Person | Pet)',
+        }).innerHTML).toBe('<p><code>n: Node</code></p><pre><code>(Person | Pet)</code></pre>');
+        expect(renderHoverInfo({ kind: 'variable', variable: 'x', types: ['Integer'] })
+            .innerHTML).toBe('<p><code>x: Integer</code></p>');
+    });
+    test('renders a function hover', () => {
+        expect(renderMethodHover('RETURN toFloat(1)').innerHTML).toBe([
+            '<pre><code>toFloat(input :: STRING | INTEGER | FLOAT) :: FLOAT</code></pre>',
+            '<p>Converts a <code>STRING</code>, <code>INTEGER</code> or <code>FLOAT</code> value to a <code>FLOAT</code> value.</p>',
+            '<p><strong>Parameters</strong></p>',
+            '<ul><li><code>input</code> - A value to be converted into a float.</li></ul>',
+            '<p><strong>Returns:</strong> <code>FLOAT</code></p>',
+        ].join(''));
+    });
+    test('renders a procedure hover', () => {
+        expect(renderMethodHover('CALL db.labels()').innerHTML).toBe([
+            '<pre><code>db.labels() :: (label :: STRING)</code></pre>',
+            "<p>List all labels attached to nodes within a database according to the user's access rights. The procedure returns empty results if the user is not authorized to view those labels.</p>",
+            '<p><strong>Returns</strong></p>',
+            '<ul><li><code>label</code> - A label within the database.</li></ul>',
+        ].join(''));
+    });
+    test('italicises the deprecation marker of a deprecated method', () => {
+        expect(renderMethodHover('CYPHER 5 RETURN apoc.create.uuid()').innerHTML).toContain('<p>(<em>deprecated</em>) Returns a UUID.</p>');
+    });
+    // The wildcards of dbms.queryJmx' descriptions are shown as written, both
+    // in prose and inside a code span
+    test('renders the wildcards of a procedure description', () => {
+        const html = renderMethodHover('CALL dbms.queryJmx()').innerHTML;
+        expect(html).toContain('<p>Query JMX management data by domain and name. For instance, use <code>*:*</code> to find all JMX beans.</p>');
+        expect(html).toContain("<li><code>query</code> - A query for MBeans on this MBeanServer (e.g. '*:*,name=*neo4j*' for all metrics in neo4j database).</li>");
+    });
+    test('renders the paragraphs, bullet list and italics of a procedure description', () => {
+        const html = renderMethodHover('CALL db.index.fulltext.queryNodes()').innerHTML;
+        expect(html).toContain('Valid <em>key: value</em> pairs');
+        expect(html).toContain([
+            '<ul>',
+            "<li>'skip' -- to skip the top N results.</li>",
+            "<li>'limit' -- to limit the number of results returned.</li>",
+            "<li>'analyzer' -- to use the specified analyzer as a search analyzer for this query.</li>",
+            '</ul>',
+            '<p>The <code>options</code> map and any of the keys are optional.',
+        ].join(''));
+    });
+    test('renders a parameter that carries its own layout as a code block', () => {
+        expect(renderMethodHover('CALL apoc.export.csv.all()').innerHTML).toContain([
+            '<ul><li><code>file</code> - The name of the file to which the data will be exported.</li>',
+            '<li><code>config</code> -<pre><code>{\n',
+            '        stream = false :: BOOLEAN,\n',
+        ].join(''));
+    });
+    // Schema descriptions list values such as 'AS_PATH_LIST', which must not
+    // turn into emphasis
+    test('leaves the underscores inside words alone', () => {
+        const description = "JSON path options: ('ALWAYS_RETURN_LIST', 'AS_PATH_LIST', 'DEFAULT_PATH_LEAF_TO_NULL').";
+        const dom = renderHoverInfo({
+            kind: 'function',
+            signature: 'f(pathOptions :: LIST<STRING>) :: ANY',
+            description: '',
+            isDeprecated: false,
+            parameters: [{ name: 'pathOptions', description }],
+            returnType: 'ANY',
+        });
+        expect(dom.querySelector('em')).toBeNull();
+        expect(dom.querySelector('li').textContent).toBe(`pathOptions - ${description}`);
+    });
+    test('never renders descriptions as html', () => {
+        const dom = renderHoverInfo({
+            kind: 'procedure',
+            signature: 'p()',
+            description: '<img src=x onerror=alert(1)>',
+            isDeprecated: false,
+            parameters: [],
+            returnValues: [{ name: 'r', description: '<b>bold</b>' }],
+        });
+        expect(dom.querySelector('img')).toBeNull();
+        expect(dom.querySelector('b')).toBeNull();
+        expect(dom.textContent).toContain('<img src=x onerror=alert(1)>');
+    });
+});
+//# sourceMappingURL=hoverRender.test.js.map

package/dist/src/lang-cypher/hover/hoverRender.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hoverRender.test.js","sourceRoot":"","sources":["../../../../src/lang-cypher/hover/hoverRender.test.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAG5B,OAAO,EACL,qBAAqB,EACrB,QAAQ,GACT,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEhD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,SAAS,WAAW,CAAC,KAAa;IAChC,MAAM,eAAe,GAAG,IAAI,qBAAqB,EAAE,CAAC;IACpD,OAAO,eAAe,CAAC,SAAS,CAAC,KAAK,EAAE;QACtC,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;QACrC,QAAQ,EAAE,QAAQ,CAAC,UAAU;KAC9B,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,OAAO,eAAe,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACzC,SAAS,oBAAoB,CAC3B,IAAe;QAEf,MAAM,IAAI,GAAmC,EAAE,CAAC;QAChD,eAAe,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;YAC3C,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YACxB,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC5E,MAAM,CACJ,oBAAoB,CAAC;YACnB,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,GAAG;YACb,KAAK,EAAE,CAAC,MAAM,CAAC;YACf,eAAe,EAAE,gBAAgB;SAClC,CAAC,CACH,CAAC,OAAO,CAAC,CAAC,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAEnD,MAAM,CAAC,oBAAoB,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACjE,CAAC,kDAAkD,EAAE,UAAU,CAAC;SACjE,CAAC,CAAC;QAEH,MAAM,CAAC,oBAAoB,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACpE,CAAC,kCAAkC,EAAE,WAAW,CAAC;SAClD,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACpC,MAAM,CACJ,eAAe,CAAC;YACd,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,GAAG;YACb,KAAK,EAAE,CAAC,MAAM,CAAC;YACf,eAAe,EAAE,gBAAgB;SAClC,CAAC,CAAC,SAAS,CACb,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;QAE5E,MAAM,CACJ,eAAe,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;aACrE,SAAS,CACb,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACpC,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAC3D;YACE,6EAA6E;YAC7E,wHAAwH;YACxH,oCAAoC;YACpC,8EAA8E;YAC9E,qDAAqD;SACtD,CAAC,IAAI,CAAC,EAAE,CAAC,CACX,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACrC,MAAM,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAC1D;YACE,0DAA0D;YAC1D,2LAA2L;YAC3L,iCAAiC;YACjC,qEAAqE;SACtE,CAAC,IAAI,CAAC,EAAE,CAAC,CACX,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0DAA0D,EAAE,GAAG,EAAE;QACpE,MAAM,CACJ,iBAAiB,CAAC,oCAAoC,CAAC,CAAC,SAAS,CAClE,CAAC,SAAS,CAAC,8CAA8C,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,0EAA0E;IAC1E,kCAAkC;IAClC,IAAI,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC5D,MAAM,IAAI,GAAG,iBAAiB,CAAC,sBAAsB,CAAC,CAAC,SAAS,CAAC;QAEjE,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CACpB,gHAAgH,CACjH,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CACpB,mIAAmI,CACpI,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4EAA4E,EAAE,GAAG,EAAE;QACtF,MAAM,IAAI,GAAG,iBAAiB,CAC5B,qCAAqC,CACtC,CAAC,SAAS,CAAC;QAEZ,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,iCAAiC,CAAC,CAAC;QAC1D,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CACpB;YACE,MAAM;YACN,+CAA+C;YAC/C,8DAA8D;YAC9D,2FAA2F;YAC3F,OAAO;YACP,mEAAmE;SACpE,CAAC,IAAI,CAAC,EAAE,CAAC,CACX,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QAC3E,MAAM,CAAC,iBAAiB,CAAC,4BAA4B,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,CACzE;YACE,2FAA2F;YAC3F,yCAAyC;YACzC,sCAAsC;SACvC,CAAC,IAAI,CAAC,EAAE,CAAC,CACX,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,yEAAyE;IACzE,qBAAqB;IACrB,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACrD,MAAM,WAAW,GACf,yFAAyF,CAAC;QAE5F,MAAM,GAAG,GAAG,eAAe,CAAC;YAC1B,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,uCAAuC;YAClD,WAAW,EAAE,EAAE;YACf,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC;YAClD,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;QAEH,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC3C,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,CAC9C,iBAAiB,WAAW,EAAE,CAC/B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC9C,MAAM,GAAG,GAAG,eAAe,CAAC;YAC1B,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,KAAK;YAChB,WAAW,EAAE,8BAA8B;YAC3C,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,EAAE;YACd,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;SAC1D,CAAC,CAAC;QAEH,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC5C,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC1C,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/lang-cypher/langCypher.js

@@ -4,6 +4,8 @@ import { completionStyles, cypherAutocomplete } from './autocomplete';
 import { ParserAdapter } from './parser-adapter';
 import { signatureHelpTooltip } from './signatureHelp';
 import { cypherLinter } from './syntaxValidation';
+import { hoverTooltip } from '@codemirror/view';
+import { getHoverSource } from './hover/hover.js';
 const facet = defineLanguageFacet({
     commentTokens: { block: { open: '/*', close: '*/' }, line: '//' },
     closeBrackets: { brackets: ['(', '[', '{', "'", '"', '`'] },
@@ -18,6 +20,7 @@ export function cypher(config) {
         }),
         cypherLinter(config),
         signatureHelpTooltip(config),
+        hoverTooltip(getHoverSource(config)),
     ]);
 }
 //# sourceMappingURL=langCypher.js.map

package/dist/src/lang-cypher/langCypher.js.map

@@ -1 +1 @@
-{"version":3,"file":"langCypher.js","sourceRoot":"","sources":["../../../src/lang-cypher/langCypher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EACL,mBAAmB,EACnB,QAAQ,EACR,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,KAAK,GAAG,mBAAmB,CAAC;IAChC,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;IACjE,aAAa,EAAE,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE;CAC5D,CAAC,CAAC;AAcH,MAAM,UAAU,MAAM,CAAC,MAAoB;IACzC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAEvD,MAAM,cAAc,GAAG,IAAI,QAAQ,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAExE,OAAO,IAAI,eAAe,CAAC,cAAc,EAAE;QACzC,cAAc,CAAC;YACb,QAAQ,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YACtC,WAAW,EAAE,gBAAgB;SAC9B,CAAC;QACF,YAAY,CAAC,MAAM,CAAC;QACpB,oBAAoB,CAAC,MAAM,CAAC;KAC7B,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"langCypher.js","sourceRoot":"","sources":["../../../src/lang-cypher/langCypher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EACL,mBAAmB,EACnB,QAAQ,EACR,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,KAAK,GAAG,mBAAmB,CAAC;IAChC,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;IACjE,aAAa,EAAE,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE;CAC5D,CAAC,CAAC;AAcH,MAAM,UAAU,MAAM,CAAC,MAAoB;IACzC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAEvD,MAAM,cAAc,GAAG,IAAI,QAAQ,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAExE,OAAO,IAAI,eAAe,CAAC,cAAc,EAAE;QACzC,cAAc,CAAC;YACb,QAAQ,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YACtC,WAAW,EAAE,gBAAgB;SAC9B,CAAC;QACF,YAAY,CAAC,MAAM,CAAC;QACpB,oBAAoB,CAAC,MAAM,CAAC;QAC5B,YAAY,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;KACrC,CAAC,CAAC;AACL,CAAC"}