Generate TypeScript types declaration (#656)

* Generate bundled types declaration

* Use named exports

* Simplify building types

* Fix enum export

* Fix Webpack export type

* Remove useless test

.eslintrc.js

@@ -43,6 +43,7 @@ module.exports = {
     // Let eslint manage semicolons
     '@typescript-eslint/no-extra-semi': 0,
     'import/no-unresolved': 'error',
+    'import/prefer-default-export': 0,
     'import/extensions': [
       'error',
       'ignorePackages',

package.json

@@ -20,9 +20,10 @@
   "author": "Gladly Team",
   "license": "MIT",
   "scripts": {
-    "build": "npm-run-all -s build:clean build:src",
+    "build": "npm-run-all -s build:clean build:src build:types-declaration",
     "build:clean": "rm -rf ./build",
     "build:src": "NODE_ENV=production webpack",
+    "build:types-declaration": "dts-bundle-generator ./src/index.server.ts --out-file ./build/index.d.ts",
     "lint": "tsc --noEmit && eslint ./",
     "bundlesize": "npm-run-all -s build bundlesize:no-build",
     "bundlesize:no-build": "bundlesize",
@@ -58,6 +59,7 @@
     "copy-webpack-plugin": "^11.0.0",
     "core-js": "^3.23.5",
     "datwd": "^0.2.0",
+    "dts-bundle-generator": "^8.0.1",
     "eslint": "^8.20.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-prettier": "^8.5.0",

src/AuthAction.ts

@@ -1,12 +1,10 @@
 // Different behaviors when the user's auth status is pending
 // or mismatches the page requirements.
 
-enum AuthAction {
+export enum AuthAction {
   RENDER = 'render',
   SHOW_LOADER = 'showLoader',
   RETURN_NULL = 'returnNull',
   REDIRECT_TO_LOGIN = 'redirectToLogin',
   REDIRECT_TO_APP = 'redirectToApp',
 }
-
-export default AuthAction

src/__tests__/index.server.moduleLoad.test.ts

@@ -1,4 +1,4 @@
-// Tests for index.server.js that require resetting all
+// Tests for index.server.ts that require resetting all
 // modules between tests. Most tests should reside in
 // index.server.test.js.
 // eslint-disable-next-line jest/no-export
@@ -10,7 +10,7 @@ afterEach(() => {
   jest.resetModules()
 })
 
-describe('index.server.js (resetting modules)', () => {
+describe('index.server.ts (resetting modules)', () => {
   it('imports without error when missing optional dependencies', () => {
     expect.assertions(0)
 
@@ -44,7 +44,7 @@ describe('index.server.js (resetting modules)', () => {
     })
 
     // eslint-disable-next-line no-unused-expressions
-    require('src/index.server').default
+    require('src/index.server')
   })
 
   it('throws an error when calling useAuthUser without react installed', () => {
@@ -59,7 +59,7 @@ describe('index.server.js (resetting modules)', () => {
         moduleName: 'react',
       })
     })
-    const { useAuthUser } = require('src/index.server').default
+    const { useAuthUser } = require('src/index.server')
     expect(() => {
       useAuthUser()
     }).toThrow(expectedErr)