Publish 2.1.0

neo4j-contrib · May 17, 2023 · 134f8d6 · 134f8d6
1 parent cef0aa1
commit 134f8d6
Show file tree

Hide file tree

Showing 43 changed files with 368 additions and 209 deletions.
diff --git a/dist/main.map3b1a796034f11ac32d28 b/dist/main.map3b1a796034f11ac32d28
diff --git a/dist/main.mapee859397c970b34f7589 → dist/main.map591dd2c8384464a705c7 b/dist/main.mapee859397c970b34f7589 → dist/main.map591dd2c8384464a705c7
diff --git a/dist/main.map60ef0e3e7494c6dd3a6d b/dist/main.map60ef0e3e7494c6dd3a6d
diff --git a/dist/neovis-without-dependencies.js b/dist/neovis-without-dependencies.js
diff --git a/dist/neovis.d.ts b/dist/neovis.d.ts
@@ -1,7 +1,7 @@
 import * as Neo4jTypes from 'neo4j-driver';
 import { EventFunctionTypes, NeoVisEvents } from './events';
 import type * as VisNetwork from 'vis-network';
-import { Cypher, Edge, NEOVIS_DEFAULT_CONFIG, NeovisConfig, Node, NonFlatNeovisConfig, NumberOrInteger } from './types';
+import { Cypher, DataFunctionType, Edge, NEOVIS_DEFAULT_CONFIG, NeovisConfig, Node, NonFlatNeovisConfig, NumberOrInteger } from './types';
 export * from './events';
 export * from './types';
 /**
@@ -50,7 +50,7 @@ export declare class NeoVis {
     /**
      * Renders the network
      */
-    render(query?: Cypher, parameters?: unknown): void;
+    render(query_or_function?: Cypher | DataFunctionType, parameters?: unknown): void;
     /**
      * Clear the data for the visualization
      */
@@ -65,26 +65,40 @@ export declare class NeoVis {
      * Reset the config object and reload data
      * @param config
      */
-    reinit(config: NeovisConfig | NonFlatNeovisConfig): void;
+    reinit(config: NeovisConfig | NonFlatNeovisConfig, parameter?: unknown): void;
     /**
      * Clear the network and fetch live data form the server and reload the visualization
      */
-    reload(): void;
+    reload(parameter?: unknown): void;
     /**
      * Stabilize the visualization
      */
     stabilize(): void;
     /**
      * Execute an arbitrary Cypher query and re-render the visualization
      * @param query
+     * @param parameters - parameters to send to the cypher
      */
-    renderWithCypher(query: Cypher): void;
+    renderWithCypher(query: Cypher, parameters?: unknown): void;
+    /**
+     * Execute an arbitrary function and re-render the visualization
+     * @param func
+     * @param parameters - parameters to send to the function
+     */
+    renderWithFunction(func: DataFunctionType, parameters?: unknown): void;
     /**
      * Execute an arbitrary Cypher query and update the current visualization, retaning current nodes
      * This function will not change the original query given by renderWithCypher or the inital cypher.
-     * @param query
+     * @param parameters - parameters to send to the cypher
+     *
+     */
+    updateWithCypher(query: Cypher, parameters?: unknown): void;
+    /**
+     * Execute an arbitrary function and update the visualization
+     * @param func
+     * @param parameters - parameters to send to the function
      */
-    updateWithCypher(query: Cypher): void;
+    updateWithFunction(func: DataFunctionType, parameters?: unknown): void;
 }
 /**
  * @deprecated for migration only

diff --git a/dist/neovis.js b/dist/neovis.js
diff --git a/dist/types.d.ts b/dist/types.d.ts
@@ -4,6 +4,7 @@ export declare const NEOVIS_DEFAULT_CONFIG: unique symbol;
 export declare const NEOVIS_ADVANCED_CONFIG: unique symbol;
 export type NumberOrInteger = number | Neo4jTypes.Integer;
 export type RecursiveMapToDist<T, New> = T extends object ? RecursiveMapTo<T, New> : New;
+export type DataFunctionType = (any?: unknown) => AsyncIterable<Neo4jTypes.Record> | Promise<Iterable<Neo4jTypes.Record>> | Iterable<Neo4jTypes.Record>;
 /**
  * Maps a type recursively and replace each non object type with the new type
  * @param <T> type to map
@@ -102,10 +103,13 @@ export interface BaseNeovisConfig {
      */
     visConfig?: VisNetwork.Options;
     /**
-     * function to get the data instead of neo4j driver
-     * @returns list of neo4j data
+     * function to get fetch data instead of neo4j driver
+     *
+     * it needs to return a list of records
+     *
+     * example in examples/simple-dataFunction-example.html
      */
-    dataFunction?: (any?: unknown) => AsyncIterable<Neo4jTypes.Record> | Promise<Iterable<Neo4jTypes.Record>> | Iterable<Neo4jTypes.Record>;
+    dataFunction?: DataFunctionType;
     /**
      * The Cypher query that will get the data
      */

diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/EventController.html b/docs/classes/EventController.html
@@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">EventController</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/neo4j-contrib/neovis.js/blob/28524f3/src/events.ts#L17">src/events.ts:17</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/neo4j-contrib/neovis.js/blob/cef0aa1/src/events.ts#L17">src/events.ts:17</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -44,7 +44,7 @@ <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <a href="EventController.html" class="tsd-signature-type tsd-kind-class">EventController</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/neo4j-contrib/neovis.js/blob/28524f3/src/events.ts#L20">src/events.ts:20</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/neo4j-contrib/neovis.js/blob/cef0aa1/src/events.ts#L20">src/events.ts:20</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member"><a id="generateEvent" class="tsd-anchor"></a>
@@ -70,7 +70,7 @@ <h5><span class="tsd-kind-parameter">values</span>: <span class="tsd-signature-t
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/neo4j-contrib/neovis.js/blob/28524f3/src/events.ts#L47">src/events.ts:47</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/neo4j-contrib/neovis.js/blob/cef0aa1/src/events.ts#L47">src/events.ts:47</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="register" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>register</span><a href="#register" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -94,7 +94,7 @@ <h5><span class="tsd-kind-parameter">handler</span>: <a href="../interfaces/Even
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/neo4j-contrib/neovis.js/blob/28524f3/src/events.ts#L34">src/events.ts:34</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/neo4j-contrib/neovis.js/blob/cef0aa1/src/events.ts#L34">src/events.ts:34</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -138,6 +138,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
 <li><a href="../interfaces/OldRelationshipConfig.html" class="deprecated"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Old<wbr/>Relationship<wbr/>Config</span></a></li>
 <li><a href="../interfaces/RelationshipConfig.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Relationship<wbr/>Config</span></a></li>
 <li><a href="../types/Cypher.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg><span>Cypher</span></a></li>
+<li><a href="../types/DataFunctionType.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Data<wbr/>Function<wbr/>Type</span></a></li>
 <li><a href="../types/NeovisDataConfig.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Neovis<wbr/>Data<wbr/>Config</span></a></li>
 <li><a href="../types/NonFlatLabelConfig.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Non<wbr/>Flat<wbr/>Label<wbr/>Config</span></a></li>
 <li><a href="../types/NonFlatRelationsipConfig.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Non<wbr/>Flat<wbr/>Relationsip<wbr/>Config</span></a></li>