refactor: Add TypeScript support (#1985)

Author: dblythy

.github/workflows/ci.yml

@@ -16,6 +16,15 @@ jobs:
         uses: mansona/npm-lockfile-version@v1
         with:
           version: 2
+  check-types:
+    name: Check types
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: npm ci
+      - name: Check types
+        run: npm run test:types
   build:
     runs-on: ubuntu-latest
     timeout-minutes: 30

babel-jest.js

@@ -1,7 +1,7 @@
 const babelJest = require('babel-jest');
 
 module.exports = babelJest.createTransformer({
-  presets: [["@babel/preset-env", {
+  presets: ["@babel/preset-typescript", ["@babel/preset-env", {
     "targets": {
       "node": "14"
     },

gulpfile.js

@@ -20,16 +20,16 @@ const transformRuntime = ["@babel/plugin-transform-runtime", {
 }];
 
 const PRESETS = {
-  'browser': [["@babel/preset-env", {
+  'browser': ["@babel/preset-typescript", ["@babel/preset-env", {
     "targets": "> 0.25%, not dead"
   }]],
-  'weapp': [["@babel/preset-env", {
+  'weapp': ["@babel/preset-typescript", ["@babel/preset-env", {
     "targets": "> 0.25%, not dead"
   }], '@babel/react'],
-  'node': [["@babel/preset-env", {
+  'node': ["@babel/preset-typescript", ["@babel/preset-env", {
     "targets": { "node": "14" }
   }]],
-  'react-native': ['module:metro-react-native-babel-preset'],
+  'react-native': ["@babel/preset-typescript", 'module:metro-react-native-babel-preset'],
 };
 const PLUGINS = {
   'browser': [transformRuntime, '@babel/plugin-transform-flow-comments', '@babel/plugin-proposal-class-properties', 'inline-package-json',
@@ -79,7 +79,7 @@ function compileTask(stream) {
 }
 
 gulp.task('compile', function() {
-  return compileTask(gulp.src('src/*.js'));
+  return compileTask(gulp.src('src/*.*(js|ts)'));
 });
 
 gulp.task('browserify', function(cb) {
@@ -137,7 +137,7 @@ gulp.task('minify-weapp', function() {
 
 gulp.task('watch', function() {
   if (BUILD === 'browser') {
-    const watcher = gulp.watch('src/*.js', { ignoreInitial: false }, gulp.series('compile', 'browserify', 'minify'));
+    const watcher = gulp.watch('src/*.*(js|ts)', { ignoreInitial: false }, gulp.series('compile', 'browserify', 'minify'));
     watcher.on('add', function(path) {
       console.log(`File ${path} was added`);
     });
@@ -146,5 +146,5 @@ gulp.task('watch', function() {
     });
     return watcher;
   }
-  return compileTask(watch('src/*.js', { ignoreInitial: false, verbose: true }));
+  return compileTask(watch('src/*.*(js|ts)', { ignoreInitial: false, verbose: true }));
 });

package-lock.json

@@ -45,6 +45,8 @@
     "@babel/plugin-transform-runtime": "7.21.4",
     "@babel/preset-env": "7.21.5",
     "@babel/preset-react": "7.22.5",
+    "@babel/preset-typescript": "7.22.5",
+    "@definitelytyped/dtslint": "0.0.163",
     "@parse/minami": "1.0.0",
     "@saithodev/semantic-release-backmerge": "2.1.3",
     "@semantic-release/changelog": "6.0.3",
@@ -95,10 +97,12 @@
   },
   "scripts": {
     "build": "node build_releases.js",
+    "build:types": "tsc",
     "release": "node build_releases.js && npm publish",
     "test": "cross-env PARSE_BUILD=node jest",
     "test:mongodb": "npm run test:mongodb:runnerstart && npm run integration",
     "test:mongodb:runnerstart": "mongodb-runner start -- --port 27017",
+    "test:types": "dtslint --expectOnly types",
     "posttest:mongodb": "mongodb-runner stop --all",
     "lint": "eslint --cache src/ integration/",
     "lint:fix": "eslint --fix --cache src/ integration/",

package.json

@@ -204,7 +204,7 @@ function requireMethods(name: string, methods: Array<string>, controller: any) {
   });
 }
 
-module.exports = {
+const CoreManager = {
   get: function (key: string): any {
     if (config.hasOwnProperty(key)) {
       return config[key];
@@ -468,3 +468,6 @@ module.exports = {
     return config['HooksController'];
   },
 };
+
+module.exports = CoreManager;
+export default CoreManager;

src/CoreManager.js

@@ -373,3 +373,4 @@ const EventuallyQueue = {
 };
 
 module.exports = EventuallyQueue;
+export default EventuallyQueue;

src/EventuallyQueue.js

@@ -392,6 +392,7 @@ const LocalDatastore = {
 };
 
 module.exports = LocalDatastore;
+export default LocalDatastore;
 
 if (process.env.PARSE_BUILD === 'react-native') {
   CoreManager.setLocalDatastoreController(require('./LocalDatastoreController.react-native'));