chore!: convert library to typescript

.eslintrc.js

@@ -1,9 +1,19 @@
-/* @flow */
-
 module.exports = {
-  extends: "./node_modules/@krakenjs/eslint-config-grumbler",
+  extends:
+    "./node_modules/@krakenjs/eslint-config-grumbler/eslintrc-typescript",
+
+  rules: {
+    "keyword-spacing": "off",
+    "@typescript-eslint/keyword-spacing": "off",
 
-  globals: {
-    __TEST__: true,
+    // off for initial ts conversion
+    //  Implicit any in catch clause
+    "@typescript-eslint/no-implicit-any-catch": "off",
+    // Prefer using an optional chain expression instead, as it's more concise and easier to read
+    "@typescript-eslint/prefer-optional-chain": "off",
+    // Prefer using nullish coalescing operator (`??`) instead of a logical or (`||`), as it is a safer operator
+    "@typescript-eslint/prefer-nullish-coalescing": "off",
+    // Generic Object Injection Sink
+    "security/detect-object-injection": "off",
   },
 };

.github/workflows/main.yml

@@ -27,9 +27,6 @@ jobs:
       - name: 👕 Lint commit messages
         uses: wagoid/commitlint-github-action@v4
 
-      - name: ▶️ Run flow-typed script
-        run: npm run flow-typed
-
       - name: ▶️ Run build script
         run: npm run build
 

README.md

@@ -207,17 +207,7 @@ Returns true if the specified domain matches the pattern. The pattern can be one
 
 All of the tasks are listed in the package.json file under the scripts section
 
-| Command       |               Description                |
-| ------------- | :--------------------------------------: |
-| npm run build |          Builds the dist files           |
-| npm test      | Runs the test suite. Lint + Type + Karma |
-
-# Debugging
-
-Run the debug task and pass the next tasks as argument.
-
-```
-npm run debug -- npm run build
-npm run debug -- npm test
-npm run debug -- npm run karma -- --browsers=Chrome
-```
+| Command       |      Description      |
+| ------------- | :-------------------: |
+| npm run build | Builds the dist files |
+| npm test      | Runs full test suite. |

babel.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  extends: "@krakenjs/babel-config-grumbler/babelrc-browser",
+  presets: ["@krakenjs/babel-config-grumbler/flow-ts-babel-preset"],
+};

package.json

@@ -3,25 +3,29 @@
   "version": "3.0.2",
   "description": "Utilities for dealing with cross-domain windows.",
   "main": "dist/cross-domain-utils.js",
-  "module": "dist/module/index.js",
+  "module": "dist/index.js",
+  "types": "dist/esm/index.d.ts",
+  "sideEffects": false,
   "scripts": {
-    "build": "npm run test && npm run babel && npm run webpack",
+    "build": "npm run test && npm run babel && npm run webpack && npm run build:types",
+    "build:flow": "find ./dist -type f -not -path './node_modules/*' -name '*.d.ts' -exec sh -c 'flowgen --add-flow-header $1 -o ${1%.*.*}.js.flow' _ '{}' \\;",
+    "build:tsc": "tsc src/* --outDir ./dist/esm --declaration --emitDeclarationOnly --strict",
+    "build:types": "npm run build:tsc && npm run build:flow",
     "webpack": "cross-env NODE_ENV=production babel-node --plugins=transform-es2015-modules-commonjs ./node_modules/.bin/webpack --progress --output-path dist",
-    "babel": "cross-env NODE_ENV=production babel src/ --out-dir dist/module",
-    "karma": "cross-env NODE_ENV=test babel-node --plugins=transform-es2015-modules-commonjs ./node_modules/.bin/karma start",
+    "babel": "cross-env NODE_ENV=production babel src/ --out-dir ./dist/esm/ --extensions .ts,.tsx",
+    "tsc": "tsc",
     "format": "prettier --write --ignore-unknown .",
     "format:check": "prettier --check .",
-    "test": "npm run format:check && npm run lint && npm run flow-typed && npm run flow && npm run karma",
-    "lint": "eslint src/ test/",
-    "flow": "flow",
-    "flow-typed": "rm -rf ./flow-typed && flow-typed install",
+    "test": "npm run format:check && npm run lint && npm run tsc --no-emit && npm run vitest",
+    "lint": "eslint --ext ts,tsx,js,jsx src/ test/",
     "clean": "rimraf dist coverage",
-    "reinstall": "rimraf flow-typed && rimraf node_modules && npm install && flow-typed install",
     "prerelease": "npm run clean && npm run build && git add dist && git commit -m 'ci: check in dist folder' || echo 'Nothing to distribute'",
     "release": "standard-version",
     "postrelease": "git push && git push --follow-tags && npm publish",
     "debug": "cross-env NODE_ENV=debug",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "vitest": "vitest run --dom --coverage",
+    "vitest:watch": "vitest watch --dom --coverage --ui"
   },
   "repository": {
     "type": "git",
@@ -72,23 +76,30 @@
   ],
   "license": "Apache-2.0",
   "files": [
-    "src/",
     "dist/"
   ],
   "readmeFilename": "README.md",
   "devDependencies": {
-    "@commitlint/cli": "^16.2.1",
-    "@commitlint/config-conventional": "^16.2.1",
-    "@krakenjs/grumbler-scripts": "^8.0.5",
-    "chai": "^4.2.0",
+    "@commitlint/cli": "^17.3.0",
+    "@commitlint/config-conventional": "^17.3.0",
+    "@krakenjs/babel-config-grumbler": "^8.0.7",
+    "@krakenjs/eslint-config-grumbler": "^8.0.7",
+    "@krakenjs/typescript-config-grumbler": "^8.0.7",
+    "@krakenjs/webpack-config-grumbler": "^8.1.0-alpha.1",
+    "@vitest/coverage-c8": "^0.25.3",
+    "@vitest/ui": "^0.25.3",
+    "chai": "^4.3.7",
     "cross-env": "^7.0.3",
-    "flow-bin": "0.155.0",
-    "flow-typed": "^3.8.0",
-    "husky": "^7.0.4",
+    "flowgen": "^1.20.1",
+    "happy-dom": "^7.7.0",
+    "husky": "^8.0.2",
     "lint-staged": "^13.0.3",
-    "mocha": "^4",
     "prettier": "2.7.1",
-    "standard-version": "^9.3.2"
+    "standard-version": "^9.5.0",
+    "ts-node": "^10.9.1",
+    "typescript": "4.9.3",
+    "vite": "^3.2.4",
+    "vitest": "0.25.3"
   },
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"

src/constants.ts

@@ -0,0 +1,12 @@
+export const PROTOCOL = {
+  MOCK: "mock:" as const,
+  FILE: "file:" as const,
+  ABOUT: "about:" as const,
+};
+
+export const WILDCARD = "*";
+
+export const WINDOW_TYPE = {
+  IFRAME: "iframe" as const,
+  POPUP: "popup" as const,
+};

src/index.js → src/index.ts

@@ -1,5 +1,3 @@
-/* @flow */
-
 export * from "./utils";
 export * from "./types";
 export * from "./constants";

src/types.ts

@@ -0,0 +1,12 @@
+export type CrossDomainWindowType = Window;
+
+export type SameDomainWindowType = Omit<
+  Window,
+  "frames" | "parent" | "focus" | "top" | "opener" | "postMessage"
+>;
+
+export type DomainMatcher =
+  | string
+  | readonly string[]
+  | readonly string[]
+  | RegExp;

src/util.ts

@@ -0,0 +1,8 @@
+export function isRegex(item: unknown): boolean {
+  return Object.prototype.toString.call(item) === "[object RegExp]";
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function noop(...args: readonly unknown[]): void {
+  // pass
+}