web-csv-toolbox 0.8.0 → 0.10.0

package/dist/types/common/types.d.ts

@@ -1,4 +1,46 @@
 import type { Field, FieldDelimiter, RecordDelimiter } from "./constants.ts";
+/**
+ * Position object.
+ */
+export interface Position {
+    /**
+     * Line number.
+     * Starts from 1.
+     */
+    line: number;
+    /**
+     * Column number.
+     * Starts from 1.
+     */
+    column: number;
+    /**
+     * Character offset.
+     * Starts from 0.
+     */
+    offset: number;
+}
+/**
+ * Token location object.
+ */
+export interface TokenLocation {
+    /**
+     * Start location.
+     */
+    start: Position;
+    /**
+     * End location.
+     */
+    end: Position;
+    /**
+     * Row number.
+     * Starts from 1.
+     *
+     * @remarks
+     * This represents the logical row number in the CSV,
+     * counting from 1 for the first row, whether it is a header or not.
+     */
+    rowNumber: number;
+}
 /**
  * Field token type.
  * @category Types
@@ -6,13 +48,32 @@ import type { Field, FieldDelimiter, RecordDelimiter } from "./constants.ts";
 export interface FieldToken {
     type: typeof Field;
     value: string;
+    location: TokenLocation;
+}
+/**
+ * Field delimiter token type.
+ * @category Types
+ */
+export interface FieldDelimiterToken {
+    type: typeof FieldDelimiter;
+    value: string;
+    location: TokenLocation;
+}
+/**
+ * Record delimiter token type.
+ * @category Types
+ */
+export interface RecordDelimiterToken {
+    type: typeof RecordDelimiter;
+    value: string;
+    location: TokenLocation;
 }
 /**
  * Token is a atomic unit of a CSV file.
  * It can be a field, field delimiter, or record delimiter.
  * @category Types
  */
-export type Token = FieldToken | typeof FieldDelimiter | typeof RecordDelimiter;
+export type Token = FieldToken | FieldDelimiterToken | RecordDelimiterToken;
 /**
  * CSV Common Options.
  * @category Types

package/dist/types/commonParseErrorHandling.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Common error handling for parsing CSV data.
+ *
+ * @param error - The error to handle.
+ * @throws {ParseError} When an error occurs while parsing the CSV data.
+ * @throws {InvalidOptionError} When an invalid option is provided.
+ */
+export declare function commonParseErrorHandling(error: unknown): never;

package/dist/types/getOptionsFromResponse.d.ts

@@ -1,2 +1,10 @@
 import type { ParseBinaryOptions } from "./common/types.ts";
+/**
+ * Extracts the options from the response object.
+ *
+ * @param response - The response object from which to extract the options.
+ * @param options - The options to merge with the extracted options.
+ * @returns The options extracted from the response.
+ * @throws {RangeError} - The content type is not supported.
+ */
 export declare function getOptionsFromResponse<Header extends ReadonlyArray<string>>(response: Response, options?: ParseBinaryOptions<Header>): ParseBinaryOptions<Header>;

package/dist/types/parseBinaryToArraySync.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/parseBinaryToIterableIterator.d.ts

@@ -1,2 +1,10 @@
 import type { CSVRecord, ParseBinaryOptions } from "./common/types.ts";
+/**
+ * Parses the given binary data into an iterable iterator of CSV records.
+ *
+ * @param binary - The binary data to parse.
+ * @param options - The parse options.
+ * @returns An iterable iterator of CSV records.
+ * @throws {ParseError} When an error occurs while parsing the CSV data.
+ */
 export declare function parseBinaryToIterableIterator<Header extends ReadonlyArray<string>>(binary: Uint8Array | ArrayBuffer, options?: ParseBinaryOptions<Header>): IterableIterator<CSVRecord<Header>>;

package/dist/types/utils/convertBinaryToString.d.ts

@@ -0,0 +1,11 @@
+import type { BinaryOptions } from "../common/types.ts";
+/**
+ * Converts a binary string to a string.
+ *
+ * @param binary - The binary string to convert.
+ * @param options - The options for parsing the binary string.
+ * @returns The converted string.
+ * @throws {RangeError} The given charset is not supported.
+ * @throws {TypeError} The encoded data was not valid.
+ */
+export declare function convertBinaryToString(binary: Uint8Array | ArrayBuffer, options: BinaryOptions): string;

package/dist/types/web-csv-toolbox.d.ts

@@ -1,12 +1,12 @@
 export * from "./common/constants.ts";
 export * from "./common/types.ts";
 export * from "./LexerTransformer.ts";
-export * from "./RecordAssemblerTransformer.ts";
-export * from "./parseString.ts";
+export * from "./loadWASM.ts";
+export * from "./parse.ts";
 export * from "./parseBinary.ts";
-export * from "./parseUint8ArrayStream.ts";
-export * from "./parseStringStream.ts";
 export * from "./parseResponse.ts";
-export * from "./parse.ts";
-export * from "./loadWASM.ts";
+export * from "./parseString.ts";
+export * from "./parseStringStream.ts";
 export * from "./parseStringToArraySyncWASM.ts";
+export * from "./parseUint8ArrayStream.ts";
+export * from "./RecordAssemblerTransformer.ts";