Node dist vis (#758)

* initial setup of library + wc in apps

* create services for nodes and edges

* refactor node data service

* update peer dependencies

* create deck gl visualization component

* update peer deps

* improve doc coverage

* refactor: Node dist vis data format update (WIP)

* refactor: lint fix

* refactor(node-dist-vis): Remove export

* feat(lib:common): Create library 'common'

* refactor(lib:common): Move file loaders into 'common/fs'

* refactor(node-dist-vis): Implement data loading

* chore: Lint fix

* refactor(node-dist-vis): ⚰️ Remove unused data services

* refactor(node-dist-vis): Add mode logic (WIP), improve filters (WIP), & tweaks

* refactor(node-dist-vis): Implement improved node filtering & minor fixes

* fix(node-dist-vis): Fix edge filtering bug

* test(node-dist-vis): Remove test files until jest + deck.gl is figured out

* test(cde-visualization): Fix a couple of imports

* refactor(node-dist-vis): Cleanup & code smell fixes

* refactor(node-dist-vis): 📝 Add documentation & minor type and error handling tweaks

* refactor(node-dist-vis): Remove test data

---------

Co-authored-by: Daniel Bolin <axbolin@iu.edu>

.eslintrc.json

@@ -63,6 +63,10 @@
               {
                 "sourceTag": "project:design-system",
                 "onlyDependOnLibsWithTags": ["*"]
+              },
+              {
+                "sourceTag": "project:node-dist-vis",
+                "onlyDependOnLibsWithTags": ["*"]
               }
             ]
           }

.vscode/settings.json

@@ -13,6 +13,8 @@
     "ccf-organ-info",
     "design-system",
     "body-ui",
-    "eui"
+    "eui",
+    "node-dist-vis",
+    "lib:common"
   ]
 }

apps/cde-ui/src/app/components/file-upload/file-upload.component.ts

@@ -1,7 +1,7 @@
 import { CommonModule } from '@angular/common';
 import { ChangeDetectionStrategy, Component, inject, Injector, input, output, Type } from '@angular/core';
 import { MatIconModule } from '@angular/material/icon';
-import { FileLoader, FileLoaderEvent } from '@hra-ui/cde-visualization';
+import { FileLoader, FileLoaderEvent } from '@hra-ui/common/fs';
 import { ButtonModule } from '@hra-ui/design-system/button';
 import { reduce, Subscription } from 'rxjs';
 

apps/cde-ui/src/app/pages/create-visualization-page/create-visualization-page.component.ts

@@ -12,8 +12,6 @@ import { Router, RouterModule } from '@angular/router';
 import {
   ColorMapEntry,
   ColorMapFileLoaderService,
-  CsvFileLoaderOptions,
-  CsvFileLoaderService,
   DEFAULT_COLOR_MAP_KEY,
   DEFAULT_COLOR_MAP_VALUE_KEY,
   DEFAULT_NODE_TARGET_KEY,
@@ -32,6 +30,7 @@ import { StepIndicatorComponent } from '@hra-ui/design-system/step-indicator';
 import { TooltipCardComponent, TooltipContent } from '@hra-ui/design-system/tooltip-card';
 import { ParseError } from 'papaparse';
 
+import { CsvFileLoaderOptions, CsvFileLoaderService } from '@hra-ui/common/fs';
 import { MarkEmptyFormControlDirective } from '../../components/empty-form-control/empty-form-control.directive';
 import { FileLoadError, FileUploadComponent } from '../../components/file-upload/file-upload.component';
 import { VisualizationDataService } from '../../services/visualization-data-service/visualization-data.service';

apps/node-dist-vis-wc-e2e/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["plugin:cypress/recommended", "../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/node-dist-vis-wc-e2e/cypress.config.ts

@@ -0,0 +1,7 @@
+import { nxE2EPreset } from '@nx/cypress/plugins/cypress-preset';
+
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+  e2e: { ...nxE2EPreset(__filename, { cypressDir: 'src' }), baseUrl: 'http://localhost:4200' },
+});

apps/node-dist-vis-wc-e2e/project.json

@@ -0,0 +1,29 @@
+{
+  "name": "node-dist-vis-wc-e2e",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "application",
+  "sourceRoot": "apps/node-dist-vis-wc-e2e/src",
+  "tags": [],
+  "implicitDependencies": ["node-dist-vis-wc"],
+  "targets": {
+    "e2e": {
+      "executor": "@nx/cypress:cypress",
+      "options": {
+        "cypressConfig": "apps/node-dist-vis-wc-e2e/cypress.config.ts",
+        "testingType": "e2e",
+        "devServerTarget": "node-dist-vis-wc:serve:development"
+      },
+      "configurations": {
+        "production": {
+          "devServerTarget": "node-dist-vis-wc:serve:production"
+        },
+        "ci": {
+          "devServerTarget": "node-dist-vis-wc:serve-static"
+        }
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    }
+  }
+}

apps/node-dist-vis-wc-e2e/src/e2e/app.cy.ts

@@ -0,0 +1,13 @@
+import { getGreeting } from '../support/app.po';
+
+describe('node-dist-vis-wc-e2e', () => {
+  beforeEach(() => cy.visit('/'));
+
+  it('should display welcome message', () => {
+    // Custom command example, see `../support/commands.ts` file
+    cy.login('my-email@something.com', 'myPassword');
+
+    // Function helper example, see `../support/app.po.ts` file
+    getGreeting().contains(/Welcome/);
+  });
+});

apps/node-dist-vis-wc-e2e/src/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

apps/node-dist-vis-wc-e2e/src/support/app.po.ts

@@ -0,0 +1 @@
+export const getGreeting = () => cy.get('h1');

apps/node-dist-vis-wc-e2e/src/support/commands.ts

@@ -0,0 +1,35 @@
+/// <reference types="cypress" />
+
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+
+// eslint-disable-next-line @typescript-eslint/no-namespace
+declare namespace Cypress {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  interface Chainable<Subject> {
+    login(email: string, password: string): void;
+  }
+}
+
+// -- This is a parent command --
+Cypress.Commands.add('login', (email, password) => {
+  console.log('Custom command example: Login', email, password);
+});
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

apps/node-dist-vis-wc-e2e/src/support/e2e.ts

@@ -0,0 +1,17 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.ts using ES2015 syntax:
+import './commands';

apps/node-dist-vis-wc-e2e/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "allowJs": true,
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["cypress", "node"],
+    "sourceMap": false,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["**/*.ts", "**/*.js", "cypress.config.ts", "**/*.cy.ts", "**/*.cy.js", "**/*.d.ts"]
+}

apps/node-dist-vis-wc/.eslintrc.json

@@ -0,0 +1,33 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "extends": ["plugin:@nx/angular", "plugin:@angular-eslint/template/process-inline-templates"],
+      "rules": {
+        "@angular-eslint/directive-selector": [
+          "error",
+          {
+            "type": "attribute",
+            "prefix": "hra",
+            "style": "camelCase"
+          }
+        ],
+        "@angular-eslint/component-selector": [
+          "error",
+          {
+            "type": "element",
+            "prefix": "hra",
+            "style": "kebab-case"
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.html"],
+      "extends": ["plugin:@nx/angular-template"],
+      "rules": {}
+    }
+  ]
+}

apps/node-dist-vis-wc/jest.config.ts

@@ -0,0 +1,22 @@
+/* eslint-disable */
+export default {
+  displayName: 'node-dist-vis-wc',
+  preset: '../../jest.preset.js',
+  setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
+  coverageDirectory: '../../coverage/apps/node-dist-vis-wc',
+  transform: {
+    '^.+\\.(ts|mjs|js|html)$': [
+      'jest-preset-angular',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json',
+        stringifyContentPathRegex: '\\.(html|svg)$',
+      },
+    ],
+  },
+  transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
+  snapshotSerializers: [
+    'jest-preset-angular/build/serializers/no-ng-attributes',
+    'jest-preset-angular/build/serializers/ng-snapshot',
+    'jest-preset-angular/build/serializers/html-comment',
+  ],
+};

apps/node-dist-vis-wc/project.json

@@ -0,0 +1,90 @@
+{
+  "name": "node-dist-vis-wc",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "application",
+  "prefix": "hra",
+  "sourceRoot": "apps/node-dist-vis-wc/src",
+  "tags": ["type:app", "project:node-dist-vis"],
+  "targets": {
+    "build": {
+      "executor": "@angular-devkit/build-angular:application",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/apps/node-dist-vis-wc",
+        "index": "apps/node-dist-vis-wc/src/index.html",
+        "browser": "apps/node-dist-vis-wc/src/main.ts",
+        "polyfills": ["zone.js"],
+        "tsConfig": "apps/node-dist-vis-wc/tsconfig.app.json",
+        "inlineStyleLanguage": "scss",
+        "assets": [
+          {
+            "glob": "**/*",
+            "input": "apps/node-dist-vis-wc/public"
+          }
+        ],
+        "styles": ["apps/node-dist-vis-wc/src/styles.scss"],
+        "scripts": [],
+        "outputHashing": "none"
+      },
+      "configurations": {
+        "production": {
+          "budgets": [
+            {
+              "type": "initial",
+              "maximumWarning": "1mb",
+              "maximumError": "2mb"
+            },
+            {
+              "type": "anyComponentStyle",
+              "maximumWarning": "2kb",
+              "maximumError": "4kb"
+            }
+          ]
+        },
+        "development": {
+          "optimization": false,
+          "extractLicenses": false,
+          "sourceMap": true
+        }
+      },
+      "defaultConfiguration": "production"
+    },
+    "serve": {
+      "executor": "@angular-devkit/build-angular:dev-server",
+      "configurations": {
+        "production": {
+          "buildTarget": "node-dist-vis-wc:build:production"
+        },
+        "development": {
+          "buildTarget": "node-dist-vis-wc:build:development"
+        }
+      },
+      "defaultConfiguration": "development"
+    },
+    "extract-i18n": {
+      "executor": "@angular-devkit/build-angular:extract-i18n",
+      "options": {
+        "buildTarget": "node-dist-vis-wc:build"
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "apps/node-dist-vis-wc/jest.config.ts"
+      }
+    },
+    "serve-static": {
+      "executor": "@nx/web:file-server",
+      "options": {
+        "buildTarget": "node-dist-vis-wc:build",
+        "port": 4200,
+        "staticFilePath": "dist/apps/node-dist-vis-wc/browser",
+        "spa": true
+      }
+    }
+  }
+}

apps/node-dist-vis-wc/src/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>node-dist-vis-wc</title>
+    <base href="/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link rel="icon" type="image/x-icon" href="favicon.ico" />
+  </head>
+  <body>
+    <hra-node-dist-vis></hra-node-dist-vis>
+  </body>
+</html>

apps/node-dist-vis-wc/src/main.ts

@@ -0,0 +1 @@
+import '@hra-ui/node-dist-vis';

apps/node-dist-vis-wc/src/styles.scss

@@ -0,0 +1,5 @@
+/* You can add global styles to this file, and also import other style files */
+
+body {
+  margin: 0;
+}

apps/node-dist-vis-wc/src/test-setup.ts

@@ -0,0 +1,8 @@
+// @ts-expect-error https://thymikee.github.io/jest-preset-angular/docs/getting-started/test-environment
+globalThis.ngJest = {
+  testEnvironmentOptions: {
+    errorOnUnknownElements: true,
+    errorOnUnknownProperties: true,
+  },
+};
+import 'jest-preset-angular/setup-jest';

apps/node-dist-vis-wc/tsconfig.app.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "types": []
+  },
+  "files": ["src/main.ts"],
+  "include": ["src/**/*.d.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts"]
+}

apps/node-dist-vis-wc/tsconfig.editor.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*.ts"],
+  "compilerOptions": {},
+  "exclude": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts"]
+}