feat(csv-parse): alig info interfaces with js api

Author: wdavidw

packages/csv-parse/lib/index.d.ts

@@ -7,7 +7,7 @@ import * as stream from "stream";
 export type Callback<T = string[]> = (
   err: CsvError | undefined,
   records: T[],
-  info?: Info,
+  info?: InfoCallback,
 ) => void;
 
 export class Parser extends stream.Transform {
@@ -25,59 +25,66 @@ export class Parser extends stream.Transform {
 
 export interface Info {
   /**
-   * Count the number of lines being fully commented.
+   * The number of processed bytes.
+   */
+  readonly bytes: number;
+  /**
+   * The number of processed bytes until the last successfully parsed and emitted records.
+   */
+  readonly bytes_records: number;
+  /**
+   * The number of lines being fully commented.
    */
   readonly comment_lines: number;
   /**
-   * Count the number of processed empty lines.
+   * The number of processed empty lines.
    */
   readonly empty_lines: number;
+  /**
+   * The number of non uniform records when `relax_column_count` is true.
+   */
+  readonly invalid_field_length: number;
   /**
    * The number of lines encountered in the source dataset, start at 1 for the first line.
    */
   readonly lines: number;
   /**
-   * Count the number of processed records.
+   * The number of processed records.
    */
   readonly records: number;
-  /**
-   * Count of the number of processed bytes.
-   */
-  readonly bytes: number;
-  /**
-   * Number of non uniform records when `relax_column_count` is true.
-   */
-  readonly invalid_field_length: number;
+}
+
+export interface InfoCallback extends Info {
   /**
    * Normalized verion of `options.columns` when `options.columns` is true, boolean otherwise.
    */
   readonly columns: boolean | { name: string }[] | { disabled: true }[];
 }
 
-export interface CastingContext {
+export interface InfoDataSet extends Info {
   readonly column: number | string;
-  readonly bytes: number;
-  readonly bytes_records: number;
-  readonly empty_lines: number;
+}
+
+export interface InfoRecord extends InfoDataSet {
   readonly error: CsvError;
   readonly header: boolean;
   readonly index: number;
-  readonly quoting: boolean;
-  readonly lines: number;
   readonly raw: string | undefined;
-  readonly records: number;
-  readonly invalid_field_length: number;
 }
 
-export type CastingFunction = (
-  value: string,
-  context: CastingContext,
-) => unknown;
+export interface InfoField extends InfoRecord {
+  readonly quoting: boolean;
+}
+
+/**
+ * @deprecated Use the InfoField interface instead, the interface will disappear in future versions.
+ */
+// eslint-disable-next-line
+export interface CastingContext extends InfoField {}
+
+export type CastingFunction = (value: string, context: InfoField) => unknown;
 
-export type CastingDateFunction = (
-  value: string,
-  context: CastingContext,
-) => Date;
+export type CastingDateFunction = (value: string, context: InfoField) => Date;
 
 export type ColumnOption<K = string> =
   | K
@@ -183,7 +190,7 @@ export interface OptionsNormalized<T = string[]> {
   /**
    * Alter and filter records by executing a user defined function.
    */
-  on_record?: (record: T, context: CastingContext) => T | undefined;
+  on_record?: (record: T, context: InfoRecord) => T | undefined;
   /**
    * Optional character surrounding a field, one character only, defaults to double quotes.
    */
@@ -359,8 +366,8 @@ export interface Options<T = string[]> {
   /**
    * Alter and filter records by executing a user defined function.
    */
-  on_record?: (record: T, context: CastingContext) => T | null | undefined;
-  onRecord?: (record: T, context: CastingContext) => T | null | undefined;
+  on_record?: (record: T, context: InfoRecord) => T | null | undefined;
+  onRecord?: (record: T, context: InfoRecord) => T | null | undefined;
   /**
    * Function called when an error occured if the `skip_records_with_error`
    * option is activated.

packages/csv-parse/lib/stream.d.ts

@@ -5,13 +5,17 @@ declare function parse(options?: Options): TransformStream;
 export { parse };
 
 export {
-  CastingContext,
+  CastingContext, // Deprecated
   CastingFunction,
   CastingDateFunction,
   ColumnOption,
   Options,
   OptionsNormalized,
   Info,
+  InfoCallback,
+  InfoDataSet,
+  InfoRecord,
+  InfoField,
   CsvErrorCode,
   CsvError,
 } from "./index.js";

packages/csv-parse/lib/sync.d.ts

@@ -18,13 +18,17 @@ declare function parse(input: Buffer | string | Uint8Array): string[][];
 export { parse };
 
 export {
-  CastingContext,
+  CastingContext, // Deprecated
   CastingFunction,
   CastingDateFunction,
   ColumnOption,
   Options,
   OptionsNormalized,
   Info,
+  InfoCallback,
+  InfoDataSet,
+  InfoRecord,
+  InfoField,
   CsvErrorCode,
   CsvError,
 } from "./index.js";

packages/csv-parse/test/api.types.sync.ts

@@ -89,7 +89,8 @@ describe("API Types", function () {
   it("Info", function () {
     const info: Info = {
       bytes: 1,
-      columns: true,
+      bytes_records: 0,
+      // columns: true,
       comment_lines: 1,
       empty_lines: 1,
       invalid_field_length: 1,

packages/csv-parse/test/api.types.ts

@@ -104,6 +104,7 @@ describe("API Types", function () {
   describe("Info", function () {
     const fakeinfo = {
       bytes: 1,
+      bytes_records: 0,
       columns: true,
       comment_lines: 1,
       empty_lines: 1,
@@ -152,7 +153,8 @@ describe("API Types", function () {
       // Boolean
       const infoBoolean: Info = {
         bytes: 1,
-        columns: true,
+        bytes_records: 0,
+        // columns: true,
         comment_lines: 1,
         empty_lines: 1,
         invalid_field_length: 1,
@@ -163,7 +165,8 @@ describe("API Types", function () {
       // Array with name = <string>
       const infoName: Info = {
         bytes: 1,
-        columns: [{ name: "a column" }],
+        bytes_records: 0,
+        // columns: [{ name: "a column" }],
         comment_lines: 1,
         empty_lines: 1,
         invalid_field_length: 1,
@@ -174,7 +177,8 @@ describe("API Types", function () {
       // Array with disabled = true
       const infoDisabled: Info = {
         bytes: 1,
-        columns: [{ disabled: true }],
+        bytes_records: 0,
+        // columns: [{ disabled: true }],
         comment_lines: 1,
         empty_lines: 1,
         invalid_field_length: 1,

packages/csv-parse/test/option.on_record.ts

@@ -1,5 +1,5 @@
 import should from "should";
-import { parse, CastingContext } from "../lib/index.js";
+import { parse, InfoRecord } from "../lib/index.js";
 
 describe("Option `on_record`", function () {
   describe("usage", function () {
@@ -161,7 +161,7 @@ describe("Option `on_record`", function () {
     });
 
     it("values", function (next) {
-      parse<CastingContext>(
+      parse<InfoRecord>(
         "a,b\n1,2\n3,4",
         {
           on_record: (record, context) => {