Add type definition #1116

heshan0131 · 2020-05-14T08:14:34Z

Part 1 of the work: Added typedef to

reducers
actions
processers
schemas
and partially utils

Signed-off-by: Shan He heshan0131@gmail.com

ibgreen

Was this built on my internal branch adding types to actions, or is this an independent effort? If not I might want to review that branch and see if it contains something additional.

ibgreen · 2020-05-14T14:27:24Z

package.json

@@ -49,7 +49,8 @@
    "docs": "babel-node ./scripts/documentation.js",
    "example-version": "babel-node ./scripts/edit-version.js",
    "prettier-all": "prettier --write '{src,examples,test}/**/*.js'",
-    "lint": "eslint src test webpack examples/*.js examples/**/src website/*.js website/src --fix",
+    "lint": "yarn typescript && eslint src test webpack examples/*.js examples/**/src website/*.js website/src --fix",
+    "typescript": "tsc",


To be clear we can write tsc --noEmit - though we do have the noEmit setting in the tsconfig, I still think it is worth having it here to emphasize that we are just type checking.

Signed-off-by: Shan He <heshan0131@gmail.com> add vis-state-updater Signed-off-by: Shan He <heshan0131@gmail.com> fix module resolve Signed-off-by: Shan He <heshan0131@gmail.com> wip type checking vis-state actions Signed-off-by: Shan He <heshan0131@gmail.com> filter-utiles type Signed-off-by: Shan He <heshan0131@gmail.com> vis-state-updater tpes Signed-off-by: Shan He <heshan0131@gmail.com> add merger schema Signed-off-by: Shan He <heshan0131@gmail.com>

Signed-off-by: Shan He <heshan0131@gmail.com>

akre54

Nice! Looking forward to this

akre54 · 2020-05-24T05:33:12Z

src/layers/layer-factory.js

@@ -28,14 +28,15 @@ export const PROPERTY_GROUPS = keyMirror({
  stroke: null,
  radius: null,
  height: null,
-
+  angel: null,


typo: angle

akre54 · 2020-05-24T05:36:58Z

src/layers/layer-factory.d.ts

+  defaultValue: boolean;
+};
+
+export type VisConfigSelection = VisConfig<string> & {


Is VisConfig a generic? If so, why is there VisConfig<string> but not VisConfig<boolean>? If not, shouldn't this line error?

I don't think VisConfig is a generic, this may be a typo

it's a typo, good catch

Signed-off-by: Shan He <heshan0131@gmail.com>

macrigiuseppe · 2020-05-27T18:53:05Z

src/actions/actions.d.ts

+/**
+ * Input dataest parsed to addDataToMap
+ */
+export type ProtoDataset = {


why protodataset and not simply Dataset?

this is the input data that user passed to addDAtaToMap, it then gets converted to dataset

macrigiuseppe · 2020-05-27T18:56:34Z

src/actions/actions.js

- * @param {string} payload.mapboxApiUrl - mapboxApiUrl to be saved to mapStyle reducer.
- * @param {Boolean} payload.mapStylesReplaceDefault - mapStylesReplaceDefault to be saved to mapStyle reducer
+ * @param {object} payload
+ * @param payload.mapboxApiAccessToken - mapboxApiAccessToken to be saved to mapStyle reducer


why did you remove types here?

never mind i see the @type

macrigiuseppe · 2020-05-27T18:58:10Z

src/actions/identity-actions.d.ts

+
+import ActionTypes from 'constants/action-types';
+
+export function registerEntry(entry: {


can you create a a type for the entry inptu?

type RegistryEntity { id:... mint:... ... }

macrigiuseppe · 2020-05-27T19:17:11Z

src/actions/actions.d.ts

+
+export type AddDataToMaoPayload = {
+  datasets: ProtoDataset[];
+  options?: AddDaataToMapOptions;


type in AddDaataToMapOptions

macrigiuseppe · 2020-05-27T19:19:17Z

src/actions/actions.d.ts

+
+export function addDataToMap(
+  data: AddDataToMaoPayload
+): {type: ActionTypes.ADD_DATA_TO_MAP; payload: AddDataToMaoPayload};


typo AddDataToMaoPayload

macrigiuseppe · 2020-05-27T19:22:12Z

src/actions/map-style-actions.d.ts

+/** REQUEST_MAP_STYLES */
+export type RequestMapStylesUpdaterAction = {
+  payload: {
+    [key: string]: {


can you use MapStyles?

export type MapStyles = { [key: string]: BaseMapStyle; };

this is the request payload, BaseMapStyle is the merged result of this request.

macrigiuseppe · 2020-05-27T19:26:15Z

src/actions/provider-actions.d.ts

+  provider: Provider;
+  options?: ExportFileOptions;
+  onSuccess?: any;
+  closeModal?: booleam;


typo in booleam

macrigiuseppe · 2020-05-27T19:44:32Z

src/actions/map-style-actions.d.ts

+/** LOAD_MAP_STYLES */
+export type LoadMapStylesUpdaterAction = {
+  payload: {
+    [id: string]: BaseMapStyle;


macrigiuseppe · 2020-05-27T19:47:25Z

src/actions/provider-actions.d.ts

+  error: any;
+  provider: Provider;
+  options?: Options;
+  onError?: any;


(error: object) => void

maybe it would be better to create a type ErrorCallback since you are using it in few places

macrigiuseppe · 2020-05-27T19:48:25Z

src/actions/provider-actions.d.ts

+export type LoadCloudMapPayload = {
+  loadParams: any;
+  provider: string;
+  onSuccess?: any;


same for this one

macrigiuseppe · 2020-05-27T19:48:35Z

src/actions/provider-actions.d.ts

+  loadParams: any;
+  provider: string;
+  onSuccess?: any;
+  onError?: any;


ErrorCallback

macrigiuseppe · 2020-05-27T19:48:43Z

src/actions/provider-actions.d.ts

+  response: any;
+  loadParams: any;
+  provider: string;
+  onSuccess?: any;


macrigiuseppe · 2020-05-27T19:48:49Z

src/actions/provider-actions.d.ts

+export type LoadCloudMapErrorPayload = {
+  error: any;
+  provider: stirng;
+  onError?: any;


macrigiuseppe · 2020-05-27T19:55:52Z

src/actions/vis-state-actions.d.ts

+
+export type LayerConfigChangeUpdaterAction = {
+  oldLayer: Layer;
+  newConfig: Partiel<LayerConfig>;


is this a typo? should it be Partial? I am not sure

macrigiuseppe · 2020-05-27T20:11:17Z

src/constants/action-types.js

@@ -51,130 +50,120 @@ import {ACTION_PREFIX} from './default-settings';
 *
 * export default createStore(reducers, {}, applyMiddleware(taskMiddleware))
 */
-const ActionTypes = keyMirror({
+const ActionTypes = {


this could be achieved by creating a helper that takes the map object and add the prefix to each and every property

Object.keys(types).reduce((acc, key) => ({ [key]: `${ACTION_PREFIX}${types[key]}` }), {})

I mean you. already did the work so it is not a big deal but something to consider

macrigiuseppe · 2020-05-27T20:28:51Z

src/reducers/vis-state-merger.d.ts

+export function mergeLayers(state: VisState, layers: ParsedConfig['visState']['layers']): VisState;
+export function mergeSplitMaps(state: VisState, splitMaps: ParsedConfig['visState']['splitMaps']): VisState;
+
+export function mergeInteractionTooltipConfig(state: VisState)


empty line is missing in this file

macrigiuseppe · 2020-05-27T20:29:38Z

src/schemas/index.d.ts

+} from './schema-manager';
+
+export const KeplerGlSchema: KeplerGLSchema;
+export default KeplerGlSchema


macrigiuseppe

Great Work!

just few comments

Signed-off-by: Shan He <heshan0131@gmail.com>

Part 1: Added typedef to reducers, actions, processers, schemas, partially utils Signed-off-by: Shan He <heshan0131@gmail.com> Signed-off-by: Wesam Manassra <wesam.manassra@gmail.com>

heshan0131 requested review from macrigiuseppe and ibgreen May 14, 2020 08:14

ibgreen approved these changes May 14, 2020

View reviewed changes

heshan0131 force-pushed the typescript-def branch from df878eb to f53431e Compare May 18, 2020 00:22

heshan0131 added 2 commits May 22, 2020 13:47

fix tests

764a702

Signed-off-by: Shan He <heshan0131@gmail.com>

heshan0131 force-pushed the typescript-def branch from de78e01 to 764a702 Compare May 22, 2020 22:26

akre54 reviewed May 24, 2020

View reviewed changes

heshan0131 added 5 commits May 25, 2020 01:39

add type dev to schemas and processors

2d81aa7

Signed-off-by: Shan He <heshan0131@gmail.com>

add d.ts

fdccf6d

Signed-off-by: Shan He <heshan0131@gmail.com>

fix browser test

e48ec69

Signed-off-by: Shan He <heshan0131@gmail.com>

fix tsc errors

97d7b9e

Signed-off-by: Shan He <heshan0131@gmail.com>

fix typo

026340e

Signed-off-by: Shan He <heshan0131@gmail.com>

heshan0131 changed the title ~~[WIP] add type definition~~ Add type definition May 25, 2020

heshan0131 added 4 commits May 25, 2020 09:23

add type checking to lint

71017db

Signed-off-by: Shan He <heshan0131@gmail.com>

add noEmit

1653b21

Signed-off-by: Shan He <heshan0131@gmail.com>

add type def for mapstyles

ec3f4d3

Signed-off-by: Shan He <heshan0131@gmail.com>

ignore typedoc for now

2cadf16

Signed-off-by: Shan He <heshan0131@gmail.com>

macrigiuseppe reviewed May 27, 2020

View reviewed changes

src/actions/provider-actions.d.ts Outdated

response: any;

loadParams: any;

provider: string;

onSuccess?: any;

Copy link

Collaborator

macrigiuseppe May 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here

macrigiuseppe reviewed May 27, 2020

View reviewed changes

macrigiuseppe approved these changes May 27, 2020

View reviewed changes

heshan0131 added 4 commits May 27, 2020 15:47

address comments

da0cfc3

Signed-off-by: Shan He <heshan0131@gmail.com>

revert changes to docs

d31db54

Signed-off-by: Shan He <heshan0131@gmail.com>

lint

627c7f3

Signed-off-by: Shan He <heshan0131@gmail.com>

fix test

526866d

Signed-off-by: Shan He <heshan0131@gmail.com>

heshan0131 merged commit 25c6d2e into master May 28, 2020

delete-merged-branch bot deleted the typescript-def branch May 28, 2020 05:49

ChrisJamesC mentioned this pull request Jul 18, 2020

[Dev Feature] Add TypeScript Support #727

Open

epan mentioned this pull request Apr 8, 2021

Support Typescript? #473

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add type definition #1116

Add type definition #1116

heshan0131 commented May 14, 2020 •

edited

Loading

ibgreen left a comment

ibgreen May 14, 2020

akre54 left a comment

akre54 May 24, 2020

akre54 May 24, 2020

macrigiuseppe May 27, 2020

heshan0131 May 27, 2020

macrigiuseppe May 27, 2020

heshan0131 May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020 •

edited

Loading

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020 •

edited

Loading

heshan0131 May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe May 27, 2020

macrigiuseppe left a comment


		import ActionTypes from 'constants/action-types';

		export function registerEntry(entry: {

Add type definition #1116

Add type definition #1116

Conversation

heshan0131 commented May 14, 2020 • edited Loading

ibgreen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akre54 left a 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

macrigiuseppe May 27, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

macrigiuseppe May 27, 2020 • 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

macrigiuseppe left a comment

Choose a reason for hiding this comment

heshan0131 commented May 14, 2020 •

edited

Loading

macrigiuseppe May 27, 2020 •

edited

Loading

macrigiuseppe May 27, 2020 •

edited

Loading