Merge pull request #30 from vizzuhq/csv-parser-types

Csv parser types export

Author: dovicsin

plugins/csv-parser/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+## [0.1.3]
+
+-   Add root module type export
+
 ## [0.1.2]
 
 ### Fixed

plugins/csv-parser/build/build.js

@@ -1,5 +1,6 @@
 import * as esbuild from 'esbuild'
 import { polyfillNode } from 'esbuild-plugin-polyfill-node'
+import { copy } from 'esbuild-plugin-copy'
 
 await esbuild.build({
 	entryPoints: ['src/index.ts'],
@@ -14,6 +15,14 @@ await esbuild.build({
 				process: true,
 				Buffer: true
 			}
+		}),
+		copy({
+			resolveFrom: 'cwd',
+			assets: {
+				from: ['./src/*.d.ts'],
+				to: ['./dist/types']
+			},
+			watch: true
 		})
 	],
 	outfile: 'dist/mjs/index.js'

plugins/csv-parser/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@vizzu/csv-parser",
 	"description": "Vizzu plugin for CSV parsing",
-	"version": "0.1.2",
+	"version": "0.1.3",
 	"type": "module",
 	"exports": {
 		".": {
@@ -19,10 +19,9 @@
 	"module": "dist/mjs/index.js",
 	"types": "dist/types/index.d.ts",
 	"scripts": {
-		"build": "run clear && node build/build.js && run types",
+		"build": "run clear && node build/build.js",
 		"clear": "node build/clear.js",
-		"test": "vitest",
-		"types": "npx -p typescript tsc src/*.ts --declaration --allowJs --emitDeclarationOnly --outDir dist/types"
+		"test": "vitest"
 	},
 	"repository": {
 		"type": "git",

plugins/csv-parser/src/dataParser.d.ts

@@ -0,0 +1,99 @@
+/// <reference types="node" />
+import { Options } from 'csv-parse/sync'
+import { Anim, Data, Config, Styles } from 'vizzu'
+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 {
+	delimiter?: string
+	encoding?: BufferEncoding
+	headers?: boolean
+	autoheader?: boolean
+	emptyColumnPrefix?: string
+	hasHeader?: boolean | null
+}
+export interface detectedTypes {
+	delimiter: string
+	probability: number
+	headers: string[]
+	hasHeader: boolean
+}
+export interface csvTypes {
+	url?: string
+	content?: string
+	options?: optionsTypes
+}
+export interface csvTarget {
+	target: {
+		data: {
+			csv: csvTypes
+		}
+	}
+}
+export interface csvDataType extends Data.Filter {
+	csv: csvTypes
+}
+export interface Target {
+	data?: Data.Set | csvDataType
+	config?: Config.Chart
+	style?: Styles.Chart | null
+}
+export interface Keyframe {
+	target: Target | CC.Snapshot
+	options?: Options
+}
+export type Keyframes = Keyframe[]
+export type AnimTarget = Keyframes | CA.CAnimation
+declare module 'vizzu' {
+	interface Vizzu {
+		animate(target: AnimTarget, options?: Anim.ControlOptions): AnimCompleting
+	}
+}
+export interface dataSeries {
+	name: string
+	values: number[] | string[]
+}
+export interface dataType {
+	series: dataSeries[]
+}
+export interface ConstructorParams {
+	options?: optionsTypes
+}
+export declare class DataParser implements Plugin {
+	private _data
+	private _headers
+	private _autoheader
+	private _hasHeader
+	private _emptyColumnPrefix
+	private _probabilityVariable
+	private _debug
+	detected: detectedTypes
+	parserOptions: Options
+	meta: {
+		name: string
+		version: string
+		depends: string[]
+	}
+	constructor(params?: ConstructorParams)
+	get hasHeader(): boolean | null
+	get data(): dataType | null
+	get delimiter(): string
+	get detectedDelimiter(): string
+	get api(): {
+		hasHeader: boolean
+		detectedDelimiter: string
+		delimiter: string
+		data: dataType
+	}
+	get hooks(): PluginHooks
+	private _setOptions
+	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
+	private _buildData
+	private _getHeader
+	private _log
+}

plugins/csv-parser/src/delimiterDetect.d.ts

@@ -0,0 +1 @@
+export declare const delimiterDetect: (data: string) => string

plugins/csv-parser/src/headerDetect.d.ts

@@ -0,0 +1 @@
+export declare const headerDetect: (data: string, delimiter?: string) => number

plugins/csv-parser/src/index.d.ts

@@ -0,0 +1,8 @@
+import { DataParser } from './dataParser'
+
+export * from './dataParser'
+export * from './delimiterDetect'
+export * from './headerDetect'
+
+export declare class CSVParser extends DataParser {}
+export default CSVParser

plugins/csv-parser/src/node.d.ts

@@ -0,0 +1,13 @@
+import { DataParser } from './dataParser'
+import { Options } from 'csv-parse/.'
+interface dataType {
+	series: {
+		name: string
+		values: string[] | number[]
+	}[]
+}
+export declare class CSVParser extends DataParser {
+	parse(input: string, options?: Options): Promise<dataType | null>
+	readCSVFile(fileName: string): string
+}
+export default CSVParser