Merge pull request #42 from vizzuhq/csv-parser-type-typo

Csv parser type typo
vizzuhq · Mar 27, 2024 · 61b308f · 61b308f
2 parents 4b5a27c + 52f6480
commit 61b308f
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 45 deletions.
diff --git a/plugins/csv-parser/CHANGELOG.md b/plugins/csv-parser/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+## [0.2.3]
+
+-   Update ts types names
+
 ## [0.2.2]
 
 -   Fixed: The empty series list type is dimension

diff --git a/plugins/csv-parser/package.json b/plugins/csv-parser/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vizzu/csv-parser",
 	"description": "Vizzu plugin for CSV parsing",
-	"version": "0.2.2",
+	"version": "0.2.3",
 	"type": "module",
 	"exports": {
 		".": {

diff --git a/plugins/csv-parser/src/dataParser.d.ts b/plugins/csv-parser/src/dataParser.d.ts
@@ -5,37 +5,37 @@ import * as CA from 'vizzu/dist/module/canimctrl.js'
 import * as CC from 'vizzu/dist/module/cchart'
 import { Plugin, PluginHooks } from 'vizzu/dist/plugins.js'
 import { AnimCompleting } from 'vizzu/dist/animcompleting'
-export interface optionsTypes {
+export interface OptionsTypes {
 	delimiter?: string
 	encoding?: BufferEncoding
 	headers?: boolean
 	autoheader?: boolean
 	emptyColumnPrefix?: string
 	hasHeader?: boolean | null
 }
-export interface detectedTypes {
+export interface DetectedTypes {
 	delimiter: string
 	probability: number
 	headers: string[]
 	hasHeader: boolean
 }
-export interface csvTypes {
+export interface CSVTypes {
 	url?: string
 	content?: string
-	options?: optionsTypes
+	options?: OptionsTypes
 }
-export interface csvTarget {
+export interface CSVTarget {
 	target: {
 		data: {
-			csv: csvTypes
+			csv: CSVTypes
 		}
 	}
 }
-export interface csvDataType extends Data.Filter {
-	csv: csvTypes
+export interface CSVDataType extends Data.Filter {
+	csv: CSVTypes
 }
 export interface Target {
-	data?: Data.Set | csvDataType
+	data?: Data.Set | CSVDataType
 	config?: Config.Chart
 	style?: Styles.Chart | null
 }
@@ -50,15 +50,15 @@ declare module 'vizzu' {
 		animate(target: AnimTarget, options?: Anim.ControlOptions): AnimCompleting
 	}
 }
-export interface dataSeries {
+export interface DataSeries {
 	name: string
 	values: number[] | string[]
 }
-export interface dataType {
-	series: dataSeries[]
+export interface DataType {
+	series: DataSeries[]
 }
 export interface ConstructorParams {
-	options?: optionsTypes
+	options?: OptionsTypes
 }
 export declare class DataParser implements Plugin {
 	private _data
@@ -68,7 +68,7 @@ export declare class DataParser implements Plugin {
 	private _emptyColumnPrefix
 	private _probabilityVariable
 	private _debug
-	detected: detectedTypes
+	detected: DetectedTypes
 	parserOptions: Options
 	meta: {
 		name: string
@@ -77,19 +77,19 @@ export declare class DataParser implements Plugin {
 	}
 	constructor(params?: ConstructorParams)
 	get hasHeader(): boolean | null
-	get data(): dataType | null
+	get data(): DataType | null
 	get delimiter(): string
 	get detectedDelimiter(): string
 	get api(): {
 		hasHeader: boolean
 		detectedDelimiter: string
 		delimiter: string
-		data: dataType
+		data: DataType
 	}
 	get hooks(): PluginHooks
 	private _setOptions
-	convertNumbers(data: dataType): dataType
-	parse(input: string, options?: optionsTypes, convert?: boolean): Promise<dataType | null>
+	convertNumbers(data: DataType): DataType
+	parse(input: string, options?: OptionsTypes, convert?: boolean): Promise<DataType | null>
 	setSource(source: string): Promise<void>
 	fetchData(url: string): Promise<string>
 	getDelimiter(data: string): string

diff --git a/plugins/csv-parser/src/dataParser.ts b/plugins/csv-parser/src/dataParser.ts
@@ -8,7 +8,7 @@ import * as CC from 'vizzu/dist/module/cchart'
 import { Plugin, PluginHooks, PrepareAnimationContext } from 'vizzu/dist/plugins.js'
 import { AnimCompleting } from 'vizzu/dist/animcompleting'
 
-export interface optionsTypes {
+export interface OptionsTypes {
 	delimiter?: string
 	encoding?: BufferEncoding
 	headers?: boolean
@@ -17,32 +17,32 @@ export interface optionsTypes {
 	hasHeader?: boolean | null
 }
 
-export interface detectedTypes {
+export interface DetectedTypes {
 	delimiter: string
 	probability: number
 	headers: string[]
 	hasHeader: boolean
 }
-export interface csvTypes {
+export interface CSVTypes {
 	url?: string
 	content?: string
-	options?: optionsTypes
+	options?: OptionsTypes
 }
 
-export interface csvTarget {
+export interface CSVTarget {
 	target: {
 		data: {
-			csv: csvTypes
+			csv: CSVTypes
 		}
 	}
 }
 
-export interface csvDataType extends Data.Filter {
-	csv: csvTypes
+export interface CSVDataType extends Data.Filter {
+	csv: CSVTypes
 }
 
 export interface Target {
-	data?: Data.Set | csvDataType
+	data?: Data.Set | CSVDataType
 	config?: Config.Chart
 	style?: Styles.Chart | null
 }
@@ -58,16 +58,16 @@ declare module 'vizzu' {
 		animate(target: AnimTarget, options?: Anim.ControlOptions): AnimCompleting
 	}
 }
-export interface dataSeries {
+export interface DataSeries {
 	name: string
 	values: (number | null | string)[]
 }
-export interface dataType {
-	series: dataSeries[]
+export interface DataType {
+	series: DataSeries[]
 }
 
 export interface ConstructorParams {
-	options?: optionsTypes
+	options?: OptionsTypes
 }
 
 const LOG_PREFIX = [
@@ -77,15 +77,15 @@ const LOG_PREFIX = [
 ]
 
 export class DataParser implements Plugin {
-	private _data: dataType | null = null
+	private _data: DataType | null = null
 	private _headers: string[] | null = null
 	private _autoheader = true
 	private _hasHeader: boolean | null = null
 	private _emptyColumnPrefix = 'Column'
 	private _probabilityVariable = 0.5
 	private _debug = false
 
-	public detected: detectedTypes = {
+	public detected: DetectedTypes = {
 		delimiter: ',',
 		probability: 1,
 		headers: [],
@@ -112,7 +112,7 @@ export class DataParser implements Plugin {
 		return this._hasHeader === null ? this.detected.hasHeader : this._hasHeader
 	}
 
-	get data(): dataType | null {
+	get data(): DataType | null {
 		return this._data
 	}
 
@@ -155,7 +155,7 @@ export class DataParser implements Plugin {
 
 						if (!('csv' in target.data) || !target.data.csv) continue
 
-						const csvOptions: csvTypes = target.data.csv
+						const csvOptions: CSVTypes = target.data.csv
 						if (!('url' in csvOptions) && !('content' in csvOptions)) continue
 
 						if ('options' in csvOptions && csvOptions.options) {
@@ -187,7 +187,7 @@ export class DataParser implements Plugin {
 		}
 	}
 
-	private _setOptions(options: optionsTypes) {
+	private _setOptions(options: OptionsTypes) {
 		if ('delimiter' in options && options.delimiter) {
 			this.parserOptions.delimiter = options.delimiter
 		}
@@ -216,7 +216,7 @@ export class DataParser implements Plugin {
 		}
 	}
 
-	public convertNumbers(data: dataType): dataType {
+	public convertNumbers(data: DataType): DataType {
 		if (!data || !('series' in data) || !data.series) return data
 
 		data.series = data.series.map(
@@ -242,9 +242,9 @@ export class DataParser implements Plugin {
 
 	public async parse(
 		input: string,
-		options: optionsTypes = {},
+		options: OptionsTypes = {},
 		convert = true
-	): Promise<dataType | null> {
+	): Promise<DataType | null> {
 		if (!input) return null
 
 		if (options) {
@@ -309,7 +309,7 @@ export class DataParser implements Plugin {
 		return this.parserOptions.delimiter?.toString() || this.detected.delimiter
 	}
 
-	private _buildData(records: string[][]): dataType | null {
+	private _buildData(records: string[][]): DataType | null {
 		if (records.length === 0) {
 			return null
 		}

diff --git a/plugins/csv-parser/src/node.d.ts b/plugins/csv-parser/src/node.d.ts
@@ -1,13 +1,13 @@
 import { DataParser } from './dataParser'
 import { Options } from 'csv-parse/.'
-interface dataType {
+interface DataType {
 	series: {
 		name: string
 		values: string[] | number[]
 	}[]
 }
 export declare class CSVParser extends DataParser {
-	parse(input: string, options?: Options): Promise<dataType | null>
+	parse(input: string, options?: Options): Promise<DataType | null>
 	readCSVFile(fileName: string): string
 }
 export default CSVParser
diff --git a/plugins/csv-parser/src/node.ts b/plugins/csv-parser/src/node.ts
@@ -2,15 +2,15 @@ import * as fs from 'fs'
 import { DataParser } from './dataParser'
 import { Options } from 'csv-parse/.'
 
-interface dataType {
+interface DataType {
 	series: {
 		name: string
 		values: string[] | number[]
 	}[]
 }
 
 export class CSVParser extends DataParser {
-	public async parse(input: string, options: Options = {}): Promise<dataType | null> {
+	public async parse(input: string, options: Options = {}): Promise<DataType | null> {
 		if (!input) return null
 
 		if (options) {