Add optional types entry point (visgl#6946)

forestofrain · May 26, 2022 · bc30a77 · bc30a77
1 parent d42c4e0
commit bc30a77
Show file tree

Hide file tree

Showing 37 changed files with 103 additions and 24 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,5 +1,6 @@
 dist/
 dist-es6/
+modules/*/typed
 node_modules/
 workers/
 dist.js

diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 build/
 dist/
+modules/*/typed
 **/*.min.js
 node_modules/
 coverage/

diff --git a/.prettierignore b/.prettierignore
@@ -1,6 +1,7 @@
 workers/
 **/dist*/**/*
 dist.js
+modules/*/typed
 *.min.js
 **/mapbox-gl-dev.js
 **/mapbox-gl.js

diff --git a/modules/aggregation-layers/package.json b/modules/aggregation-layers/package.json
@@ -21,6 +21,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/aggregation-layers/tsconfig.json b/modules/aggregation-layers/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"},

diff --git a/modules/arcgis/package.json b/modules/arcgis/package.json
@@ -21,6 +21,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/arcgis/tsconfig.json b/modules/arcgis/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"}

diff --git a/modules/carto/package.json b/modules/carto/package.json
@@ -23,6 +23,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/carto/tsconfig.json b/modules/carto/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"},

diff --git a/modules/core/package.json b/modules/core/package.json
@@ -21,6 +21,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "debug.min.js",
     "dist.min.js"
   ],

diff --git a/modules/core/tsconfig.json b/modules/core/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
   ]

diff --git a/modules/extensions/package.json b/modules/extensions/package.json
@@ -21,6 +21,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/extensions/tsconfig.json b/modules/extensions/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"}

diff --git a/modules/geo-layers/package.json b/modules/geo-layers/package.json
@@ -21,6 +21,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/geo-layers/tsconfig.json b/modules/geo-layers/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"},

diff --git a/modules/google-maps/package.json b/modules/google-maps/package.json
@@ -21,6 +21,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/google-maps/tsconfig.json b/modules/google-maps/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"}

diff --git a/modules/json/package.json b/modules/json/package.json
@@ -21,6 +21,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/json/tsconfig.json b/modules/json/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"}

diff --git a/modules/jupyter-widget/tsconfig.json b/modules/jupyter-widget/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../aggregation-layers"},

diff --git a/modules/layers/package.json b/modules/layers/package.json
@@ -20,6 +20,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/layers/src/polygon-layer/polygon-layer.ts b/modules/layers/src/polygon-layer/polygon-layer.ts
@@ -267,7 +267,6 @@ export default class PolygonLayer<DataT = any, ExtraProps = {}> extends Composit
         (changeFlags.updateTriggersChanged.all || changeFlags.updateTriggersChanged.getPolygon));
 
     if (geometryChanged && Array.isArray(changeFlags.dataChanged)) {
-      // @ts-expect-error state is always initialized on instantiated layer
       const paths = this.state.paths.slice();
       const pathsDiff = changeFlags.dataChanged.map(dataRange =>
         replaceInRange({
@@ -357,7 +356,6 @@ export default class PolygonLayer<DataT = any, ExtraProps = {}> extends Composit
       material
     } = this.props;
 
-    // @ts-expect-error state is always initialized on instantiated layer
     const {paths, pathsDiff} = this.state;
 
     const FillLayer = this.getSubLayerClass('fill', SolidPolygonLayer);

diff --git a/modules/layers/src/scatterplot-layer/scatterplot-layer.ts b/modules/layers/src/scatterplot-layer/scatterplot-layer.ts
@@ -134,7 +134,7 @@ export default class ScatterplotLayer<DataT = any, ExtraPropsT = {}> extends Lay
     });
   }
 
-  updateState(params: UpdateParameters<ScatterplotLayer<DataT, ExtraPropsT>>) {
+  updateState(params: UpdateParameters<this>) {
     super.updateState(params);
 
     if (params.changeFlags.extensionsChanged) {

diff --git a/modules/layers/tsconfig.json b/modules/layers/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"}

diff --git a/modules/main/package.json b/modules/main/package.json
@@ -18,6 +18,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/main/tsconfig.json b/modules/main/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../aggregation-layers"},

diff --git a/modules/mapbox/package.json b/modules/mapbox/package.json
@@ -21,6 +21,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/mapbox/tsconfig.json b/modules/mapbox/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"}

diff --git a/modules/mesh-layers/package.json b/modules/mesh-layers/package.json
@@ -21,6 +21,7 @@
   "files": [
     "dist",
     "src",
+    "typed",
     "dist.min.js"
   ],
   "sideEffects": false,

diff --git a/modules/mesh-layers/tsconfig.json b/modules/mesh-layers/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"}

diff --git a/modules/react/package.json b/modules/react/package.json
@@ -20,7 +20,8 @@
   "module": "dist/esm/index.js",
   "files": [
     "dist",
-    "src"
+    "src",
+    "typed"
   ],
   "sideEffects": false,
   "scripts": {},

diff --git a/modules/react/tsconfig.json b/modules/react/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"}

diff --git a/modules/test-utils/package.json b/modules/test-utils/package.json
@@ -20,7 +20,8 @@
   "module": "dist/esm/index.js",
   "files": [
     "dist",
-    "src"
+    "src",
+    "typed"
   ],
   "peerDependencies": {
     "@deck.gl/core": "^8.0.0",

diff --git a/modules/test-utils/tsconfig.json b/modules/test-utils/tsconfig.json
@@ -5,7 +5,7 @@
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",
-    "outDir": "dist/typed"
+    "outDir": "typed"
   },
   "references": [
     {"path": "../core"}

diff --git a/package.json b/package.json
@@ -38,7 +38,7 @@
     "test-node": "ocular-test node",
     "test-browser": "ocular-test browser",
     "tsclean": "find . -name tsconfig.tsbuildinfo -exec rm {} \\;",
-    "tsbuild": "tsc -b tsconfig.build.json",
+    "tsbuild": "tsc -b tsconfig.build.json && node scripts/typed-entry.js",
     "bench": "ocular-test bench",
     "bench-browser": "ocular-test bench-browser",
     "metrics": "ocular-metrics",

diff --git a/scripts/typed-entry.js b/scripts/typed-entry.js
@@ -0,0 +1,64 @@
+/**
+ * This script enables a temporary, opt-in only entry point in each module while TypeScript is being developed.
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+const MODULES_DIR = path.resolve(__dirname, '../modules');
+const IMPORT_PATTERN = /\bfrom ('|")(@deck.gl\/[\w\-]+)('|")/g;
+
+for (const moduleName of fs.readdirSync(MODULES_DIR)) {
+  if (!isDirectory(`${MODULES_DIR}/${moduleName}`)) {
+    continue;
+  }
+
+  const distDir = `${MODULES_DIR}/${moduleName}/typed`;
+  if (isDirectory(distDir)) {
+    // Create package.json
+    const entryPoint = {
+      internal: true,
+      main: "../dist/es5/index.js",
+      module: "../dist/esm/index.js",
+      types: "index.d.ts"
+    };
+
+    fs.writeFileSync(`${distDir}/package.json`, JSON.stringify(entryPoint, null, 2), 'utf8');
+
+    // Update all internal imports
+    const stats = updateImports(distDir);
+    console.log(`${stats.fileCount} files updated in module ${moduleName}`)
+
+  } else {
+    console.log(`No types found for module ${moduleName}`);
+  }
+}
+
+function isDirectory(path) {
+  try {
+    const stats = fs.lstatSync(path);
+    return stats.isDirectory();
+  } catch {
+    // Does not exist
+    return false;
+  }
+}
+
+// Replace all internal imports (@deck.gl/*) with '@deck.gl/*/typed'
+function updateImports(path, stats = {fileCount: 0}) {
+  for (const item of fs.readdirSync(path)) {
+    const subPath = `${path}/${item}`;
+    if (item.endsWith('.d.ts')) {
+      // find imports
+      let fileContent = fs.readFileSync(subPath, 'utf8');
+      if (IMPORT_PATTERN.test(fileContent)) {
+        fileContent = fileContent.replace(IMPORT_PATTERN, (_, $1, $2) => `from '${$2}/typed'`);
+        stats.fileCount++;
+        fs.writeFileSync(subPath, fileContent, 'utf8');
+      }
+    } else if (isDirectory(subPath)) {
+      updateImports(subPath, stats);
+    }
+  }
+  return stats;
+}
diff --git a/tsconfig.build.json b/tsconfig.build.json
@@ -10,16 +10,16 @@
     // {"path": "modules/arcgis"},
     // {"path": "modules/carto"},
     {"path": "modules/core"},
-    // {"path": "modules/extensions"},
+    {"path": "modules/extensions"},
     // {"path": "modules/geo-layers"},
     // {"path": "modules/google-maps"},
     // {"path": "modules/json"},
     // {"path": "modules/jupyter-widget"},
-    // {"path": "modules/layers"},
+    {"path": "modules/layers"},
     // {"path": "modules/main"},
     // {"path": "modules/mapbox"},
     // {"path": "modules/mesh-layers"},
-    // {"path": "modules/react"},
+    {"path": "modules/react"},
     // {"path": "modules/test-utils"}
   ],
   "include": [