docs(ts): allow vtk classes discovery

Sources/vtk.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 
+ * @param obj 
+ * @return  
+ */
+declare function vtk(obj: object): any;
+
+/**
+ * Nest register method under the vtk function
+ * @param vtkClassName 
+ * @param constructor 
+ */
+declare function register(vtkClassName: string, constructor: any): void;
+
+export default vtk;

Utilities/rollup/plugin-generate-references.js

@@ -0,0 +1,36 @@
+import * as fs from 'fs';
+import path from 'path';
+
+export function generateDtsReferences(pluginOptions) {
+
+  const rootDts = 'index.d.ts';
+  const dtsReferences = [
+    '/// <reference path="./types.d.ts" />',
+    '/// <reference path="./interfaces.d.ts" />',
+  ];
+
+  return {
+    name: 'generate-references',
+    generateBundle(outputOptions, bundle, isWrite) {
+      const files = Object.keys(bundle);
+
+      for (let i = 0; i < files.length; i++) {
+        const file = files[i];
+        let filename = file.replace('.js', '.d.ts');
+
+        const dts = path.join(pluginOptions['dest'], filename);
+
+        if (fs.existsSync(dts) && filename !== rootDts) {
+          filename = filename.replace(/\\/g, '/');
+          dtsReferences.push(`/// <reference path="./${filename}" />`);
+        }
+      }
+
+      this.emitFile({
+        type: 'asset',
+        fileName: rootDts,
+        source: dtsReferences.join("\r\n")
+      });
+    }
+  };
+}

rollup.config.js

@@ -20,6 +20,7 @@ import copy from 'rollup-plugin-copy';
 import pkg from './package.json';
 
 import { rewriteFilenames } from './Utilities/rollup/plugin-rewrite-filenames';
+import { generateDtsReferences } from './Utilities/rollup/plugin-generate-references';
 
 const absolutifyImports = require('./Utilities/build/absolutify-imports.js');
 
@@ -169,7 +170,10 @@ export default {
           dest: outputDir,
           rename(name, ext, fullPath) {
             const filename = `${name}.${ext}`;
-            if (filename === 'index.d.ts') {
+            if (
+              filename === 'index.d.ts' &&
+              path.dirname(fullPath) !== 'Sources'
+            ) {
               const moduleName = path.basename(path.dirname(fullPath));
               return `../${moduleName}.d.ts`;
             }
@@ -193,6 +197,9 @@ export default {
         },
       ],
     }),
+    generateDtsReferences({
+      dest: outputDir,
+    }),
     copy({
       flatten: true,
       targets: [
@@ -204,6 +211,7 @@ export default {
         { src: 'Utilities/build/macro-shim.js', dest: outputDir, rename: 'macro.js' },
         { src: '*.txt', dest: outputDir },
         { src: '*.md', dest: outputDir },
+        { src: 'tsconfig.json', dest: outputDir },
         { src: '.npmignore', dest: outputDir },
         { src: 'LICENSE', dest: outputDir },
         {
@@ -214,6 +222,7 @@ export default {
             pkg.name = '@kitware/vtk.js';
             pkg.main = './index.js';
             pkg.module = './index.js';
+            pkg.types = './index.d.ts';
             return JSON.stringify(pkg, null, 2);
           },
         },