@linkurious/ogma-linkurious-parser 4.0.4 → 4.0.6

package/README.md

@@ -1,7 +1,7 @@
-# Ogma-Linkurious Parser 
+# Ogma-Linkurious-Parser 
 
 ## Description
-Ogma-Linkurious Parser is an official library maintained by the Linkurious team that allows you to quickly parse and load a Linkurious visualization in Ogma with one line of code and apply different Linkurious Enterprise styles, filters, captions and more.
+Ogma-Linkurious-Parser is an official library maintained by the Linkurious team that allows you to quickly parse and load a Linkurious Enterprise visualization in Ogma with one line of code and apply different Linkurious Enterprise styles, filters, captions and more.
 
 ### Prerequisites
 - Linkurious Enterprise 2.10.x or above
@@ -16,46 +16,52 @@ Ogma-Linkurious Parser is an official library maintained by the Linkurious team
 
 In order to create an Ogma visualization with your Linkurious styles:
 
-1. Get your visualization using [Linkurios REST API](https://doc.linkurio.us/server-sdk/latest/apidoc/#api-Visualization-getVisualization).
+1. Get your visualization using [Linkurious Enterprise REST API](https://doc.linkurious.com/server-sdk/latest/apidoc/#api-Visualization-getVisualization).
 
+2. Get Linkurious Enterprise configuration using [Linkurious Enterprise REST API](https://doc.linkurious.com/server-sdk/latest/apidoc/#api-Config-getConfiguration).
 
-2. Get the Linkurious configuration using [Linkurios REST API](https://doc.linkurio.us/server-sdk/latest/apidoc/#api-Config-getConfiguration).
+3. If you need to reproduce the same caption styles, get graph schema using [Linkurious Enterprise REST API](https://doc.linkurious.com/server-sdk/latest/apidoc/#api-Schema-getTypes).
 
+4. Initialize `LKOgma` and call `initVisualization` with the configuration and the visualization data from the previous steps.
 
-3. Initialize `LKOgma` and call `initVisualization` with the configuration and the visualization data from the previous steps.
 
-
-A full working example using the [Linkurious REST Client](https://github.com/Linkurious/linkurious-rest-client/) library:
+A full working example using the [Linkurious Enterprise REST API](https://github.com/Linkurious/linkurious-rest-client/) library:
 
 ```js
 const {RestClient} = require('@linkurious/rest-client');
 const {LKOgma} = require('@linkurious/ogma-linkurious-parser');
 
 async function main() {
+  
   // Initialize the rest client
   const rc = new RestClient({baseUrl: 'http://localhost:3000'});
-  
   // Log in
   await rc.auth.login({
     usernameOrEmail: 'your-username',
     password: 'your-password'
   });
-
   // Get linkurious configuration response
   const linkuriousConfigurationResponse = await rc.config.getConfiguration();
-
   // Get the visualisation configuration response
   const visualizationResponse = await rc
       .visualization.getVisualization({
           sourceKey: 'e7900d9b',
           id: 3
       });
-
-  if (linkuriousConfigurationResponse.isSuccess() && visualizationResponse.isSuccess()) {
+  const nodeTypesResponse = await this.rc.graphSchema.getTypesWithAccess({
+    entityType: 'node'
+  });
+  const edgeTypesResponse = await this.rc.graphSchema.getTypesWithAccess({
+    entityType: 'edge'
+  });
+  
+  if (linkuriousConfigurationResponse.isSuccess() && visualizationResponse.isSuccess() && nodeTypesResponse.isSuccess() && edgeTypesResponse.isSuccess) {
       const ogmaConfiguration = linkuriousConfigurationResponse.body.ogma;
-
+      const graphSchema = {
+        node: nodeTypesResponse.body.node.results,
+        edge: edgeTypesResponse.body.edge.results
+      }
       const visualizationConfiguration = visualizationResponse.body;
-
        // Initialize ogma object
        const ogma = new LKOgma({
           ...ogmaConfiguration,
@@ -64,10 +70,10 @@ async function main() {
             backgroundColor: 'rgba(240, 240, 240)'
           }
       });
-
       // Set HTML container where Ogma will be rendered
       ogma.setContainer('graph-container');
-
+      // Set graphSchema that will be used in defining caption styles
+      ogma.LKCaptions.graphSchema = graphSchema;
       // Initialize the visualization content & styles
       await ogma.initVisualization(visualizationConfiguration);
   }
@@ -77,12 +83,12 @@ main();
 ```
 <!--
 # TODO uncomment when plugins are officially documented
-> If you are writing a Linkurious plugin, the Linkurious Rest-Client library will be already initialized.
+> If you are writing a Linkurious Enterprise plugin, the Linkurious Enterprise Rest-Client library will be already initialized.
 -->
 
 You can use any other Ogma feature you would like to apply to the visualization.
   
-> To learn more about Ogma check our [official documentation](https://doc.linkurio.us/ogma/latest/).
+> To learn more about Ogma check our [official documentation](https://doc.linkurious.com/ogma/latest/).
   
 ## Licensing
-The Ogma-Linkurious parser is licensed under the Apache License, Version 2.0. See [LICENSE](/LICENSE) for the full license text.
+The Ogma-Linkurious-parser is licensed under the Apache License, Version 2.0. See [LICENSE](/LICENSE) for the full license text.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkurious/ogma-linkurious-parser",
-  "version": "4.0.4",
+  "version": "4.0.6",
   "author": "Linkurious SAS",
   "description": "Parse and load a Linkurious visualization in Ogma with one line of code ",
   "files": [
@@ -53,7 +53,7 @@
   },
   "devDependencies": {
     "@linkurious/ogma": "4.4.4",
-    "@linkurious/rest-client": "4.0.4",
+    "@linkurious/rest-client": "4.0.6",
     "@rollup/plugin-buble": "0.21.3",
     "@rollup/plugin-commonjs": "17.0.0",
     "@rollup/plugin-json": "4.1.0",