feat: update type definition

Author: TtTRz

dist/index.js

@@ -34,6 +34,7 @@
     "@swc/core": "^1.2.80",
     "@types/jest": "^27.0.1",
     "@types/rfdc": "^1.1.0",
+    "@types/wechat-miniprogram": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^2.23.0",
     "@typescript-eslint/parser": "^2.23.0",
     "codecov": "^3.7.0",
@@ -57,11 +58,10 @@
     "miniprogram-exparser": "^2.11.2",
     "miniprogram-simulate": "^1.2.9",
     "prettier": "^2.0.1",
+    "proxy-polyfill": "^0.3.2",
     "ts-jest": "^27.0.5",
     "ts-node": "^10.2.1",
-    "typescript": "^4.0.3",
-    "proxy-polyfill": "^0.3.2",
-    "@types/wechat-miniprogram": "^3.0.0"
+    "typescript": "^4.5.4"
   },
   "dependencies": {
     "fast-deep-equal": "^2.0.1",

package.json

@@ -1,11 +1,12 @@
-/* eslint-disable @typescript-eslint/ban-types */
 import rfdc from 'rfdc'
 import deepEqual from 'fast-deep-equal'
 import * as dataPath from './data-path'
 import * as dataTracer from './data-tracer'
+import type { IRelatedPathValue } from './data-tracer'
 
 const deepClone = rfdc({ proto: true })
 
+
 interface BehaviorExtend {
   // original
   data: Record<string, any>;
@@ -19,8 +20,8 @@ interface ObserversItem {
 }
 
 interface ComputedWatchInfo {
-  computedUpdaters: Array<any>;
-  computedRelatedPathValues: Record<string, any>;
+  computedUpdaters: Array<(...args: unknown[]) => boolean>;
+  computedRelatedPathValues: Record<string, Array<IRelatedPathValue>>;
   watchCurVal: Record<string, any>;
   _triggerFromComputedAttached: Record<string, boolean>;
 }

src/behavior.ts

@@ -1,6 +1,11 @@
 const WHITE_SPACE_CHAR_REGEXP = /^\s/
 
-const throwParsingError = function (path, index) {
+interface IParserState { 
+  index: number;
+  length: number;
+}
+
+const throwParsingError = (path: string, index: number) => {
   throw new Error(
     'Parsing data path "' +
       path +
@@ -12,7 +17,7 @@ const throwParsingError = function (path, index) {
   )
 }
 
-const parseArrIndex = function (path, state) {
+const parseArrIndex = (path: string, state: IParserState) => {
   const startIndex = state.index
   while (state.index < state.length) {
     const ch = path[state.index]
@@ -28,7 +33,7 @@ const parseArrIndex = function (path, state) {
   return parseInt(path.slice(startIndex, state.index), 10)
 }
 
-const parseIdent = function (path, state) {
+const parseIdent = (path: string, state: IParserState) => {
   const startIndex = state.index
   const ch = path[startIndex]
   if (/^[_a-zA-Z$]/.test(ch)) {
@@ -47,7 +52,7 @@ const parseIdent = function (path, state) {
   return path.slice(startIndex, state.index)
 }
 
-const parseSinglePath = function (path, state) {
+const parseSinglePath = (path: string, state: IParserState) => {
   const paths = [parseIdent(path, state)]
   const options = {
     deepCmp: false,
@@ -56,7 +61,7 @@ const parseSinglePath = function (path, state) {
     const ch = path[state.index]
     if (ch === '[') {
       state.index++
-      paths.push(parseArrIndex(path, state))
+      paths.push(`${parseArrIndex(path, state)}`)
       const nextCh = path[state.index]
       if (nextCh !== ']') throwParsingError(path, state.index)
       state.index++
@@ -81,7 +86,7 @@ const parseSinglePath = function (path, state) {
   return { path: paths, options }
 }
 
-const parseMultiPaths = function (path, state) {
+const parseMultiPaths = (path: string, state: IParserState) => {
   while (WHITE_SPACE_CHAR_REGEXP.test(path[state.index])) {
     state.index++
   }
@@ -104,11 +109,11 @@ const parseMultiPaths = function (path, state) {
   return ret
 }
 
-const parseEOF = function (path, state) {
+const parseEOF = (path: string, state: IParserState) => {
   if (state.index < state.length) throwParsingError(path, state.index)
 }
 
-export function parseMultiDataPaths(path: string) {
+export const parseMultiDataPaths = (path: string) => {
   const state = {
     length: path.length,
     index: 0,
@@ -118,7 +123,7 @@ export function parseMultiDataPaths(path: string) {
   return ret
 }
 
-export const getDataOnPath = function (data, path) {
+export const getDataOnPath = (data: unknown, path: Array<string>) => {
   let ret = data
   path.forEach((s) => {
     if (typeof ret !== 'object' || ret === null) ret = undefined

src/data-path.ts

@@ -1,10 +1,19 @@
 import ProxyPolyfillBuilder from 'proxy-polyfill/src/proxy'
 const ProxyPolyfill = ProxyPolyfillBuilder()
 
-const wrapData = (data, relatedPathValues, basePath) => {
+interface IWrappedData { 
+  __rawObject__: unknown;
+}
+
+export interface IRelatedPathValue {
+  path: Array<string>;
+  value: unknown;
+}
+
+const wrapData = (data: unknown, relatedPathValues: Array<IRelatedPathValue>, basePath: Array<string>) => {
   if (typeof data !== 'object' || data === null) return data
   const handler = {
-    get(obj, key) {
+    get(obj: unknown, key: string) {
       if (key === '__rawObject__') return obj
       let keyWrapper = null
       const keyPath = basePath.concat(key)
@@ -26,11 +35,11 @@ const wrapData = (data, relatedPathValues, basePath) => {
   return propDef
 }
 
-export function create(data, relatedPathValues) {
+export function create(data: unknown, relatedPathValues: Array<IRelatedPathValue>) {
   return wrapData(data, relatedPathValues, [])
 }
 
-export function unwrap(wrapped) {
+export function unwrap(wrapped: IWrappedData) {
   // #70
   if (typeof wrapped.__rawObject__ !== 'object' && typeof wrapped === 'object' && wrapped !== null) {
     if (Array.isArray(wrapped)) {

src/data-tracer.ts

@@ -1,7 +1,7 @@
-export declare function parseMultiDataPaths(path: string): {
-    path: any[];
+export declare const parseMultiDataPaths: (path: string) => {
+    path: string[];
     options: {
         deepCmp: boolean;
     };
 }[];
-export declare const getDataOnPath: (data: any, path: any) => any;
+export declare const getDataOnPath: (data: unknown, path: Array<string>) => unknown;

types/data-path.d.ts

@@ -1,2 +1,10 @@
-export declare function create(data: any, relatedPathValues: any): any;
-export declare function unwrap(wrapped: any): any;
+interface IWrappedData {
+    __rawObject__: unknown;
+}
+export interface IRelatedPathValue {
+    path: Array<string>;
+    value: unknown;
+}
+export declare function create(data: unknown, relatedPathValues: Array<IRelatedPathValue>): any;
+export declare function unwrap(wrapped: IWrappedData): any;
+export {};