@orbcharts/core 3.0.0-alpha.62 → 3.0.0-alpha.64

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orbcharts/core",
-  "version": "3.0.0-alpha.62",
+  "version": "3.0.0-alpha.64",
   "description": "OrbCharts is an open source chart library based on d3.js and rx.js",
   "author": "Blue Planet Inc.",
   "license": "Apache-2.0",
@@ -35,7 +35,7 @@
     "vite-plugin-dts": "^3.7.3"
   },
   "dependencies": {
-    "@orbcharts/core-types": "^3.0.0-alpha.2",
+    "@orbcharts/core-types": "^3.0.0-alpha.3",
     "d3": "^7.8.5",
     "rxjs": "^7.8.1"
   }

package/src/grid/dataFormatterValidator.ts

@@ -1,9 +1,102 @@
 import type { DataFormatterValidator, DataFormatterTypeMap } from '../../lib/core-types'
+import { validateColumns } from '../utils/validator'
 
 export const dataFormatterValidator: DataFormatterValidator<'grid'> = (dataFormatter: DataFormatterTypeMap<'grid'>) => {
-
-  return {
-    status: 'success',
-    message: ''
+  const result = validateColumns(dataFormatter, {
+    visibleFilter: {
+      toBeTypes: ['Function']
+    },
+    grid: {
+      toBeTypes: ['object']
+    },
+    container: {
+      toBeTypes: ['object']
+    }
+  })
+  if (dataFormatter.grid) {
+    const visibleFilterResult = validateColumns(dataFormatter.grid, {
+      seriesDirection: {
+        toBe: '"row" | "column"',
+        test: (value) => value === 'row' || value === 'column'
+      },
+      rowLabels: {
+        toBeTypes: ['string[]']
+      },
+      columnLabels: {
+        toBeTypes: ['string[]']
+      },
+      valueAxis: {
+        toBeTypes: ['object']
+      },
+      groupAxis: {
+        toBeTypes: ['object']
+      },
+      separateSeries: {
+        toBeTypes: ['boolean']
+      }
+    })
+    if (visibleFilterResult.status === 'error') {
+      return visibleFilterResult
+    }
+    if (dataFormatter.grid.valueAxis) {
+      const valueAxisResult = validateColumns(dataFormatter.grid.valueAxis, {
+        position: {
+          toBe: '"left" | "right"',
+          test: (value) => value === 'left' || value === 'right'
+        },
+        scaleDomain: {
+          toBe: '[number | "min" | "auto", number | "max" | "auto"]',
+          test: (value) => Array.isArray(value) && value.length === 2 && (typeof value[0] === 'number' || value[0] === 'min' || value[0] === 'auto') && (typeof value[1] === 'number' || value[1] === 'max' || value[1] === 'auto')
+        },
+        scaleRange: {
+          toBe: '[number, number]',
+          test: (value) => Array.isArray(value) && value.length === 2 && typeof value[0] === 'number' && typeof value[1] === 'number'
+        },
+        label: {
+          toBeTypes: ['string']
+        }
+      })
+      if (valueAxisResult.status === 'error') {
+        return valueAxisResult
+      }
+    }
+    if (dataFormatter.grid.groupAxis) {
+      const groupAxisResult = validateColumns(dataFormatter.grid.groupAxis, {
+        position: {
+          toBe: '"top" | "bottom"',
+          test: (value) => value === 'top' || value === 'bottom'
+        },
+        scaleDomain: {
+          toBe: '[number, number | "max"]',
+          test: (value) => Array.isArray(value) && value.length === 2 && typeof value[0] === 'number' && (typeof value[1] === 'number' || value[1] === 'max')
+        },
+        scalePadding: {
+          toBeTypes: ['number']
+        },
+        label: {
+          toBeTypes: ['string']
+        }
+      })
+      if (groupAxisResult.status === 'error') {
+        return groupAxisResult
+      }
+    }
+  }
+  if (dataFormatter.container) {
+    const containerResult = validateColumns(dataFormatter.container, {
+      gap: {
+        toBeTypes: ['number']
+      },
+      rowAmount: {
+        toBeTypes: ['number']
+      },
+      columnAmount: {
+        toBeTypes: ['number']
+      }
+    })
+    if (containerResult.status === 'error') {
+      return containerResult
+    }
   }
+  return result
 }

package/src/grid/dataValidator.ts

@@ -1,9 +1,13 @@
 import type { DataValidator, DataTypeMap } from '../../lib/core-types'
+import { validateColumns } from '../utils/validator'
 
 export const dataValidator: DataValidator<'grid'> = (data: DataTypeMap<'grid'>) => {
-
-  return {
-    status: 'success',
-    message: ''
-  }
+  const result = validateColumns({ data }, {
+    data: {
+      toBe: '(DataGridDatum | DataGridValue)[][]',
+      // 畢免資料量過大檢查不完，不深度檢查
+      test: (value) => Array.isArray(value)
+    }
+  })
+  return result
 }

package/src/multiGrid/dataFormatterValidator.ts

@@ -1,9 +1,116 @@
-import type { DataFormatterValidator, DataFormatterTypeMap } from '../../lib/core-types'
+import type { DataFormatterValidator, DataFormatterTypeMap, ValidatorResult } from '../../lib/core-types'
+import { validateColumns } from '../utils/validator'
 
 export const dataFormatterValidator: DataFormatterValidator<'multiGrid'> = (dataFormatter: DataFormatterTypeMap<'multiGrid'>) => {
-  
-  return {
-    status: 'success',
-    message: ''
+  const result = validateColumns(dataFormatter, {
+    visibleFilter: {
+      toBeTypes: ['Function']
+    },
+    gridList: {
+      toBeTypes: ['object[]']
+    },
+    container: {
+      toBeTypes: ['object']
+    },
+    separateGrid: {
+      toBeTypes: ['boolean']
+    }
+  })
+  if (dataFormatter.gridList) {
+    const gridListResultArr = dataFormatter.gridList.map((grid, index) => {
+      const gridResult = validateColumns(grid, {
+        seriesDirection: {
+          toBe: '"row" | "column"',
+          test: (value) => value === 'row' || value === 'column'
+        },
+        rowLabels: {
+          toBeTypes: ['string[]']
+        },
+        columnLabels: {
+          toBeTypes: ['string[]']
+        },
+        valueAxis: {
+          toBeTypes: ['object']
+        },
+        groupAxis: {
+          toBeTypes: ['object']
+        },
+        separateSeries: {
+          toBeTypes: ['boolean']
+        }
+      })
+      if (gridResult.status === 'error') {
+        return gridResult
+      } else {
+        if (grid.valueAxis) {
+          const valueAxisResult = validateColumns(grid.valueAxis, {
+            position: {
+              toBe: '"top" | "bottom" | "left" | "right"',
+              test: (value) => value === 'top' || value === 'bottom' || value === 'left' || value === 'right'
+            },
+            scaleDomain: {
+              toBe: '[number | "min" | "auto", number | "max" | "auto"]',
+              test: (value) => Array.isArray(value) && value.length === 2 && (typeof value[0] === 'number' || value[0] === 'min' || value[0] === 'auto') && (typeof value[1] === 'number' || value[1] === 'max' || value[1] === 'auto')
+            },
+            scaleRange: {
+              toBe: '[number, number]',
+              test: (value) => Array.isArray(value) && value.length === 2 && typeof value[0] === 'number' && typeof value[1] === 'number'
+            },
+            label: {
+              toBeTypes: ['string']
+            }
+          })
+          if (valueAxisResult.status === 'error') {
+            return valueAxisResult
+          }
+        } else if (grid.groupAxis) {
+          const groupAxisResult = validateColumns(grid.groupAxis, {
+            position: {
+              toBe: '"top" | "bottom" | "left" | "right"',
+              test: (value) => value === 'top' || value === 'bottom' || value === 'left' || value === 'right'
+            },
+            scaleDomain: {
+              toBe: '[number, number | "max"]',
+              test: (value) => Array.isArray(value) && value.length === 2 && typeof value[0] === 'number' && (typeof value[1] === 'number' || value[1] === 'max')
+            },
+            scalePadding: {
+              toBeTypes: ['number']
+            },
+            label: {
+              toBeTypes: ['string']
+            }
+          })
+          if (groupAxisResult.status === 'error') {
+            return groupAxisResult
+          }
+        }
+        return <ValidatorResult>{
+          status: 'success',
+          columnName: '',
+          expectToBe: ''
+        }
+      }
+    })
+    const gridListResult = gridListResultArr.find((gridResult) => gridResult.status === 'error')
+    if (gridListResult.status === 'error') {
+      return gridListResult
+    }
   }
+  if (dataFormatter.container) {
+    const containerResult = validateColumns(dataFormatter.container, {
+      gap: {
+        toBeTypes: ['number']
+      },
+      rowAmount: {
+        toBeTypes: ['number']
+      },
+      columnAmount: {
+        toBeTypes: ['number']
+      }
+    })
+    if (containerResult.status === 'error') {
+      return containerResult
+    }
+  }
+  return result
 }

package/src/multiGrid/dataValidator.ts

@@ -1,9 +1,13 @@
 import type { DataValidator, DataTypeMap } from '../../lib/core-types'
+import { validateColumns } from '../utils/validator'
 
 export const dataValidator: DataValidator<'multiGrid'> = (data: DataTypeMap<'multiGrid'>) => {
-
-  return {
-    status: 'success',
-    message: ''
-  }
+  const result = validateColumns({ data }, {
+    data: {
+      toBe: 'DataGrid[]',
+      // 畢免資料量過大檢查不完，不深度檢查
+      test: (value) => Array.isArray(value)
+    }
+  })
+  return result
 }

package/src/multiValue/dataFormatterValidator.ts

@@ -4,6 +4,7 @@ export const dataFormatterValidator: DataFormatterValidator<'multiValue'> = (dat
   
   return {
     status: 'success',
-    message: ''
+    columnName: '',
+    expectToBe: ''
   }
 }

package/src/multiValue/dataValidator.ts

@@ -4,6 +4,7 @@ export const dataValidator: DataValidator<'multiValue'> = (data: DataTypeMap<'mu
 
   return {
     status: 'success',
-    message: ''
+    columnName: '',
+    expectToBe: ''
   }
 }

package/src/relationship/dataFormatterValidator.ts

@@ -4,6 +4,7 @@ export const dataFormatterValidator: DataFormatterValidator<'relationship'> = (d
   
   return {
     status: 'success',
-    message: ''
+    columnName: '',
+    expectToBe: ''
   }
 }

package/src/relationship/dataValidator.ts

@@ -4,6 +4,7 @@ export const dataValidator: DataValidator<'relationship'> = (data: DataTypeMap<'
 
   return {
     status: 'success',
-    message: ''
+    columnName: '',
+    expectToBe: ''
   }
 }

package/src/series/dataFormatterValidator.ts

@@ -1,9 +1,42 @@
 import type { DataFormatterValidator, DataFormatterTypeMap } from '../../lib/core-types'
+import { validateColumns } from '../utils/validator'
 
 export const dataFormatterValidator: DataFormatterValidator<'series'> = (dataFormatter: DataFormatterTypeMap<'series'>) => {
-  
-  return {
-    status: 'success',
-    message: ''
+  const result = validateColumns(dataFormatter, {
+    visibleFilter: {
+      toBeTypes: ['Function']
+    },
+    sort: {
+      toBeTypes: ['Function', 'null']
+    },
+    seriesLabels: {
+      toBeTypes: ['string[]']
+    },
+    container: {
+      toBeTypes: ['object']
+    },
+    separateSeries: {
+      toBeTypes: ['boolean']
+    },
+    sumSeries: {
+      toBeTypes: ['boolean']
+    }
+  })
+  if (dataFormatter.container) {
+    const containerResult = validateColumns(dataFormatter.container, {
+      gap: {
+        toBeTypes: ['number']
+      },
+      rowAmount: {
+        toBeTypes: ['number']
+      },
+      columnAmount: {
+        toBeTypes: ['number']
+      }
+    })
+    if (containerResult.status === 'error') {
+      return containerResult
+    }
   }
+  return result
 }

package/src/series/dataValidator.ts

@@ -1,9 +1,13 @@
 import type { DataValidator, DataTypeMap } from '../../lib/core-types'
+import { validateColumns } from '../utils/validator'
 
 export const dataValidator: DataValidator<'series'> = (data: DataTypeMap<'series'>) => {
-
-  return {
-    status: 'success',
-    message: ''
-  }
+  const result = validateColumns({ data }, {
+    data: {
+      toBe: '(DataSeriesDatum | DataSeriesValue)[][] | (DataSeriesDatum | DataSeriesValue)[]',
+      // 畢免資料量過大檢查不完，不深度檢查
+      test: (value) => Array.isArray(value)
+    }
+  })
+  return result
 }

package/src/tree/dataFormatterValidator.ts

@@ -1,9 +1,14 @@
 import type { DataFormatterValidator, DataFormatterTypeMap } from '../../lib/core-types'
+import { validateColumns } from '../utils/validator'
 
 export const dataFormatterValidator: DataFormatterValidator<'tree'> = (dataFormatter: DataFormatterTypeMap<'tree'>) => {
-  
-  return {
-    status: 'success',
-    message: ''
-  }
+  const result = validateColumns(dataFormatter, {
+    visibleFilter: {
+      toBeTypes: ['Function']
+    },
+    categoryLabels: {
+      toBeTypes: ['string[]']
+    }
+  })
+  return result
 }

package/src/tree/dataValidator.ts

@@ -1,9 +1,14 @@
 import type { DataValidator, DataTypeMap } from '../../lib/core-types'
+import { validateColumns } from '../utils/validator'
+import { isPlainObject } from '../utils'
 
 export const dataValidator: DataValidator<'tree'> = (data: DataTypeMap<'tree'>) => {
-
-  return {
-    status: 'success',
-    message: ''
-  }
+  const result = validateColumns({ data }, {
+    data: {
+      toBe: 'DataTreeObj | DataTreeDatum[]',
+      // 畢免資料量過大檢查不完，不深度檢查
+      test: (value) => isPlainObject(value) && value.id !== undefined
+    }
+  })
+  return result
 }

package/src/utils/observables.ts

@@ -12,6 +12,7 @@ import {
 import type {
   ChartType,
   ChartParams,
+  ComputedDatumBase,
   ComputedDataTypeMap,
   ComputedDatumTypeMap,
   DataFormatterTypeMap,
@@ -74,12 +75,12 @@ export const highlightObservable = <T extends ChartType, D>({ datumList$, fullCh
     filter(d => d.eventName === 'mouseover'),
     // distinctUntilChanged((prev, current) => prev.eventName === current.eventName)
     map(d => {
-      return d.datum
+      return (d as any).datum
         ? {
-          id: (d.datum as any).id,
-          seriesLabel: (d.datum as any).seriesLabel,
-          groupLabel: (d.datum as any).groupLabel,
-          categoryLabel: (d.datum as any).categoryLabel,
+          id: ((d as any).datum as any).id,
+          seriesLabel: ((d as any).datum as any).seriesLabel,
+          groupLabel: ((d as any).datum as any).groupLabel,
+          categoryLabel: ((d as any).datum as any).categoryLabel,
           highlightDefault: null
         }
         : {
@@ -102,7 +103,7 @@ export const highlightObservable = <T extends ChartType, D>({ datumList$, fullCh
   )
 
   function getDatumIds (datumList: ComputedDatumTypeMap<T>[], id: string | null) {
-    const datum = datumList.find(d => d.id === id)
+    const datum = datumList.find(d => (d as ComputedDatumBase).id === id)
     return datum ? [datum] : []
   }