Add typedoc generated docs

examples/react/package.json

@@ -22,7 +22,6 @@
         "@types/react": "^16.8.6",
         "@types/react-dom": "^16.9.4",
         "source-map-loader": "^0.2.4",
-        "ts-loader": "^6.2.1",
-        "typescript": "^3.7.4"
+        "ts-loader": "^6.2.1"
     }
 }

examples/react/src/index.css

@@ -6,12 +6,14 @@
  * the Apache License 2.0.  The full license can be found in the LICENSE file.
  *
  */
+
+ @import "~@finos/perspective-viewer/dist/umd/material-dense.css";
 
- perspective-viewer { 
+perspective-viewer { 
     position: absolute; 
     top: 0; 
     left: 0; 
     right: 0; 
     bottom: 0; 
-   }
+}
 

examples/react/src/index.tsx

@@ -16,7 +16,6 @@ import "@finos/perspective-viewer-datagrid";
 import "@finos/perspective-viewer-d3fc";
 import {PerspectiveViewerConfig, PerspectiveViewerElement} from "@finos/perspective-viewer";
 
-import "@finos/perspective-viewer/dist/umd/material-dense.css";
 import "./index.css";
 
 const worker = perspective.default.shared_worker();
@@ -44,7 +43,6 @@ const App = (): React.ReactElement => {
         });
     }, []);
 
-    // You can also the use the stringified config values as attributes
     return <perspective-viewer ref={viewer}></perspective-viewer>;
 };
 

package.json

@@ -73,11 +73,7 @@
         "npm-pack-here": "^1.2.0",
         "npm-run-all": "^4.1.3",
         "postcss": "^8.2.6",
-        "postcss-copy-assets": "^0.3.1",
-        "postcss-easy-import": "^3.0.0",
-        "postcss-font-grabber": "^3.0.2",
         "postcss-loader": "^4.1.0",
-        "postcss-url": "^10.1.3",
         "pre-commit": "^1.2.2",
         "prettier": "^1.19.1",
         "puppeteer": "^10.2.0",
@@ -92,7 +88,10 @@
         "term-img": "^4.1.0",
         "ts-jest": "^25.1.0",
         "ts-loader": "^6.2.0",
-        "typescript": "^3.7.4",
+        "typedoc": "^0.21.9",
+        "typedoc-plugin-markdown": "^3.10.4",
+        "typedoc-plugin-no-inherit": "^1.3.0",
+        "typescript": "4.3.3",
         "webfontloader": "^1.6.28",
         "webpack": "^5.14.0",
         "webpack-cli": "^4.3.1",

packages/perspective-jupyterlab/package.json

@@ -53,8 +53,7 @@
         "isomorphic-fetch": "^2.2.1",
         "jest-transform-css": "^2.0.0",
         "source-map-support": "^0.5.9",
-        "ts-jest": "^25.1.0",
-        "typescript": "^3.7.4"
+        "ts-jest": "^25.1.0"
     },
     "jupyterlab": {
         "extension": true

packages/perspective/index.d.ts

@@ -33,7 +33,7 @@ declare module "@finos/perspective" {
     export type FilterOp = "<" | ">" | "<=" | ">=" | "==" | "!=" | "is null" | "is not null" | "in" | "not in" | "begins with" | "contains";
 
     export type Schema = {
-        [key: ColumnName]: Type;
+        [key: string]: Type;
     };
 
     export interface SerializeConfig {