chore!: convert library to typescript #37

westeezy · 2022-06-29T03:28:34Z

Codebase is migrated to TypeScript by using https://github.com/Khan/flow-to-ts
Dist folder now outputs esm folder
Package.json update for types & modules
Flowgen is used to generate flow types from dist/*.d.ts

package.json

gregjopa

💯 🥇 👍

westeezy · 2022-11-22T21:27:59Z

Published alpha @krakenjs/[email protected]

dist
├── cross-domain-utils.js
├── cross-domain-utils.js.map
├── cross-domain-utils.min.js
├── cross-domain-utils.min.js.map
├── esm
│   ├── constants.d.ts
│   ├── constants.js
│   ├── constants.js.flow
│   ├── index.d.ts
│   ├── index.js
│   ├── index.js.flow
│   ├── types.d.ts
│   ├── types.js
│   ├── types.js.flow
│   ├── util.d.ts
│   ├── util.js
│   ├── util.js.flow
│   ├── utils.d.ts
│   ├── utils.js
│   └── utils.js.flow

dtjones404 · 2022-11-28T15:38:33Z

src/utils.ts

      // pass
    }
  }
 }

-export function getUserAgent(win: ?SameDomainWindowType): string {
+export function getUserAgent(
+  win: SameDomainWindowType | undefined | undefined


Does undefined | undefined serve some purpose, or is this just a weird artifact from the flow-to-ts tool? Looks like it's present in a few places in src/utils.

Good catch @dtjones404! I assume we should only have one undefined

- Codebase is migrated to TypeScript by using https://github.com/Khan/flow-to-ts - Dist folder now outputs esm folder - Package.json update for types & modules - Flowgen is used to generate flow types from dist/*.d.ts

gregjopa · 2023-03-07T18:58:49Z

src/utils.ts

-  CrossDomainWindowType,
-  SameDomainWindowType,
-  DomainMatcher,
+import {


Nit: should we use this syntax instead since they are all types?

import type { CrossDomainWindowType, SameDomainWindowType, DomainMatcher } from "./types";

I slightly prefer the syntax Greg is suggesting. If we wanted to, I think we could enforce this with an eslint rule:

https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/consistent-type-imports.md#fixstyle

gregjopa · 2023-03-07T19:02:28Z

src/utils.ts

-  win?: CrossDomainWindowType = window
-): ?CrossDomainWindowType {
+  win: CrossDomainWindowType = window
+): CrossDomainWindowType | undefined | undefined {


Suggested change

): CrossDomainWindowType | undefined | undefined {

): CrossDomainWindowType | undefined {

gregjopa · 2023-03-07T19:02:46Z

src/utils.ts

-  win?: CrossDomainWindowType = window
-): ?CrossDomainWindowType {
+  win: CrossDomainWindowType = window
+): CrossDomainWindowType | undefined | undefined {


Suggested change

): CrossDomainWindowType | undefined | undefined {

): CrossDomainWindowType | undefined {

gregjopa · 2023-03-07T19:07:08Z

src/utils.ts

-  win?: CrossDomainWindowType = window
-): ?CrossDomainWindowType {
+  win: CrossDomainWindowType = window
+): CrossDomainWindowType | undefined | undefined {


Suggested change

): CrossDomainWindowType | undefined | undefined {

): CrossDomainWindowType | undefined {

gregjopa · 2023-03-07T19:07:19Z

src/utils.ts

-  win?: CrossDomainWindowType = window
-): ?CrossDomainWindowType {
+  win: CrossDomainWindowType = window
+): CrossDomainWindowType | undefined | undefined {


Suggested change

): CrossDomainWindowType | undefined | undefined {

): CrossDomainWindowType | undefined {

gregjopa · 2023-03-07T19:08:24Z

src/utils.ts

      // pass
    }
  }
 }

-export function getUserAgent(win: ?SameDomainWindowType): string {
+export function getUserAgent(
+  win: SameDomainWindowType | undefined | undefined


Suggested change

win: SameDomainWindowType | undefined | undefined

win: SameDomainWindowType | undefined

gregjopa · 2023-03-07T19:08:32Z

src/utils.ts

 }

 export function getFrameByName(
  win: CrossDomainWindowType,
  name: string
-): ?CrossDomainWindowType {
+): CrossDomainWindowType | undefined | undefined {


Suggested change

): CrossDomainWindowType | undefined | undefined {

): CrossDomainWindowType | undefined {

gregjopa · 2023-03-07T19:09:02Z

src/utils.ts

    // pass
  }
 }

 export function findChildFrameByName(
  win: CrossDomainWindowType,
  name: string
-): ?CrossDomainWindowType {
+): CrossDomainWindowType | undefined | undefined {


Suggested change

): CrossDomainWindowType | undefined | undefined {

): CrossDomainWindowType | undefined {

gregjopa · 2023-03-07T19:09:10Z

src/utils.ts

@@ -673,15 +678,14 @@ export function findChildFrameByName(
 export function findFrameByName(
  win: CrossDomainWindowType,
  name: string
-): ?CrossDomainWindowType {
+): CrossDomainWindowType | undefined | undefined {


Suggested change

): CrossDomainWindowType | undefined | undefined {

): CrossDomainWindowType | undefined {

gregjopa · 2023-03-07T19:09:18Z

src/utils.ts

-  win?: CrossDomainWindowType = window
-): ?CrossDomainWindowType {
+  win: CrossDomainWindowType = window
+): CrossDomainWindowType | undefined | undefined {


Suggested change

): CrossDomainWindowType | undefined | undefined {

): CrossDomainWindowType | undefined {

gregjopa · 2023-03-07T19:09:42Z

src/utils.ts

-  n: number = 1
-): ?CrossDomainWindowType {
+  n = 1
+): CrossDomainWindowType | undefined | undefined {


Suggested change

): CrossDomainWindowType | undefined | undefined {

): CrossDomainWindowType | undefined {

gregjopa · 2023-03-07T19:09:50Z

src/utils.ts

-  n: number = 1
-): ?CrossDomainWindowType {
+  n = 1
+): CrossDomainWindowType | undefined | undefined {


Suggested change

): CrossDomainWindowType | undefined | undefined {

): CrossDomainWindowType | undefined {

gregjopa · 2023-03-07T19:10:25Z

src/types.ts

+export type DomainMatcher =
+  | string
+  | readonly string[]
+  | readonly string[]


Suggested change

| readonly string[]

gregjopa · 2023-03-07T19:10:58Z

src/constants.ts

@@ -0,0 +1,12 @@
+export const PROTOCOL = {


This is super minor, but is this syntax the same?

export const PROTOCOL = { MOCK: "mock:", FILE: "file:" , ABOUT: "about:", } as const

dtjones404 · 2023-03-07T20:00:43Z

package.json

-    "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",


Do we want to follow the convention of having a typecheck script here, like we have in other repositories?

westeezy requested review from gregjopa and wsbrunson June 29, 2022 03:28

wsbrunson reviewed Jun 29, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

package.json Show resolved Hide resolved

westeezy marked this pull request as ready for review June 29, 2022 15:44

westeezy requested a review from a team as a code owner June 29, 2022 15:44

wsbrunson approved these changes Jun 29, 2022

View reviewed changes

westeezy mentioned this pull request Jun 30, 2022

chore!: move to typescript and vitest krakenjs/cross-domain-safe-weakmap#11

Open

gregjopa approved these changes Jun 30, 2022

View reviewed changes

westeezy force-pushed the typescript2 branch from d752c9d to 47cae30 Compare June 30, 2022 22:24

westeezy force-pushed the typescript2 branch 4 times, most recently from 74e861f to 72e0c04 Compare November 22, 2022 21:27

westeezy force-pushed the typescript2 branch from 72e0c04 to e2907e8 Compare November 22, 2022 21:28

westeezy requested a review from dtjones404 November 22, 2022 21:29

dtjones404 reviewed Nov 28, 2022

View reviewed changes

westeezy added 4 commits March 7, 2023 12:08

chore!: convert library to typescript

0e55370

- Codebase is migrated to TypeScript by using https://github.com/Khan/flow-to-ts - Dist folder now outputs esm folder - Package.json update for types & modules - Flowgen is used to generate flow types from dist/*.d.ts

fix: lintable

ce89521

fix: tsc runs and oddly passes

2e6ace7

fix: tests pass

b25893c

westeezy force-pushed the typescript2 branch from e2907e8 to b25893c Compare March 7, 2023 18:11

gregjopa reviewed Mar 7, 2023

View reviewed changes

dtjones404 reviewed Mar 7, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore!: convert library to typescript #37

chore!: convert library to typescript #37

westeezy commented Jun 29, 2022

gregjopa left a comment

westeezy commented Nov 22, 2022

dtjones404 Nov 28, 2022 •

edited

Loading

gregjopa Nov 28, 2022

gregjopa Mar 7, 2023

dtjones404 Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

gregjopa Mar 7, 2023

dtjones404 Mar 7, 2023

	): CrossDomainWindowType \| undefined \| undefined {
	): CrossDomainWindowType \| undefined {

	win: SameDomainWindowType \| undefined \| undefined
	win: SameDomainWindowType \| undefined

chore!: convert library to typescript #37

Are you sure you want to change the base?

chore!: convert library to typescript #37

Conversation

westeezy commented Jun 29, 2022

gregjopa left a comment

Choose a reason for hiding this comment

westeezy commented Nov 22, 2022

dtjones404 Nov 28, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dtjones404 Nov 28, 2022 •

edited

Loading