feat(typescript): support types

core/datart.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Datart
+ *
+ * Copyright 2021
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface IChartLifecycle {
+  /**
+   * Mount event with params `option` and `context`
+   *
+   * @abstract
+   * @param {*} options
+   * @param {*} [context]
+   * @memberof DatartChartBase
+   */
+  onMount(options, context?): void;
+
+  /**
+   * Update event with params `option` and `context`
+   *
+   * @abstract
+   * @param {*} options
+   * @param {*} [context]
+   * @memberof DatartChartBase
+   */
+  onUpdated(options, context?): void;
+
+  /**
+   * UnMount event with params `option` and `context`
+   *
+   * @abstract
+   * @param {*} options
+   * @param {*} [context]
+   * @memberof DatartChartBase
+   */
+  onUnMount(options, context?): void;
+
+  /**
+   * Resize event with params `option` and `context`
+   *
+   * @abstract
+   * @param {*} options
+   * @param {*} [context]
+   * @memberof DatartChartBase
+   */
+  onResize(options, context?): void;
+}
+
+export interface IChart extends IChartLifecycle {
+  meta: any;
+  config?: any;
+  dataset?: any;
+  dependency: string[];
+  isISOContainer: boolean | string;
+  useIFrame?: boolean;
+
+  set state(state: any);
+  get state();
+
+  getDependencies(): string[];
+
+  init(config: any);
+  registerMouseEvents(events: Array<any>);
+  isMatchRequirement(targetConfig?: any): boolean;
+}

index.d.ts

@@ -0,0 +1,4 @@
+declare module "*.svg" {
+  const content: any;
+  export default content;
+}

package.json

@@ -4,12 +4,15 @@
   },
   "devDependencies": {
     "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-typescript": "^8.3.0",
     "commitizen": "^4.2.4",
     "cz-conventional-changelog": "3.3.0",
     "rollup": "^2.60.2",
     "rollup-plugin-progress": "^1.1.2",
     "rollup-plugin-svg": "^2.0.0",
-    "rollup-plugin-terser": "^7.0.2"
+    "rollup-plugin-terser": "^7.0.2",
+    "tslib": "^2.3.1",
+    "typescript": "^4.2.2"
   },
   "config": {
     "commitizen": {

plugins/datart-amap/experiment-amap-chart.js → plugins/datart-amap/experiment-amap-chart.ts

@@ -20,14 +20,15 @@ import geoChinaCity from "./geo-china-city-map.json";
 import geoChina from "./geo-china-map.json";
 import config from "./config";
 import icon from "./gaode-map-logo.svg";
+import { IChart } from "../../core/datart";
 
 /**
  * @summary
  * Integrate with amap echart extions, more detail please check https://github.com/plainheart/echarts-extension-amap/blob/master/README.zh-CN.md
  * @param {*} { dHelper }, Datart Helper Utils
  * @return {*} void
  */
-export function GaodeMapChart({ dHelper }) {
+export function GaodeMapChart({ dHelper }): IChart & any {
   return {
     isISOContainer: "gaodemap-chart",
     chart: null,
@@ -144,7 +145,7 @@ export function GaodeMapChart({ dHelper }) {
     },
 
     loadMapTools(context) {
-      var amapComponent = this.chart.getModel().getComponent("amap");
+      var amapComponent = this.chart?.getModel()?.getComponent("amap");
       var amap = amapComponent.getAMap();
       amap.addControl(new context.window.AMap.Scale());
       amap.addControl(new context.window.AMap.ToolBar());

rollup.config.js

@@ -2,6 +2,8 @@ import json from "@rollup/plugin-json";
 import { terser } from "rollup-plugin-terser";
 import svg from "rollup-plugin-svg";
 import progress from "rollup-plugin-progress";
+import typescript from "@rollup/plugin-typescript";
+
 const fs = require("fs");
 
 const pluginFolders = () => {
@@ -18,7 +20,7 @@ export default pluginFolders().map((name) => {
     },
     plugins: [
       progress({
-        clearLine: false, // default: true
+        clearLine: false,
       }),
       json(),
       svg({ base64: false }),
@@ -27,6 +29,7 @@ export default pluginFolders().map((name) => {
           defaults: false,
         },
       }),
+      typescript(),
     ],
   };
 });

tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "noImplicitAny": false,
+    "target": "es5",
+    "lib": ["es5", "es6", "dom"],
+    "module": "esnext",
+    "removeComments": true,
+    "preserveConstEnums": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "isolatedModules": true,
+    "noEmit": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true
+  },
+  "include": ["plugins/**/*", "index.d.ts"],
+  "exclude": ["node_modules", "**/*.spec.ts"]
+}