typed-csv 1.0.0

package/dist/csv-loader/loader.d.mts

@@ -0,0 +1,154 @@
+type SchemaType = "string" | "number" | "int" | "float" | "boolean";
+interface PrimitiveSchema {
+    type: SchemaType;
+}
+interface NamedSchema {
+    name?: string;
+    schema: Schema;
+}
+interface TupleSchema {
+    type: "tuple";
+    elements: NamedSchema[];
+}
+interface ArraySchema {
+    type: "array";
+    element: Schema;
+}
+interface ReferenceSchema {
+    type: "reference";
+    /** Referenced table name (e.g., 'parts' from '@parts[]') */
+    tableName: string;
+    /** Whether it's an array reference */
+    isArray: boolean;
+    /** Whether it's optional (allows empty input resolving to null) */
+    isOptional?: boolean;
+}
+interface ReverseReferenceSchema {
+    type: "reverseReference";
+    /** Referenced table name (e.g., 'orders' from '~orders(user)') */
+    tableName: string;
+    /** The foreign key field name in the referenced table (e.g., 'user' from '~orders(user)') */
+    foreignKey: string;
+    /** Whether it's optional (null if no matches, instead of empty array) */
+    isOptional?: boolean;
+}
+interface StringLiteralSchema {
+    type: "stringLiteral";
+    value: string;
+}
+interface UnionSchema {
+    type: "union";
+    members: Schema[];
+}
+type Schema = PrimitiveSchema | TupleSchema | ArraySchema | ReferenceSchema | ReverseReferenceSchema | StringLiteralSchema | UnionSchema;
+
+interface CsvLoaderOptions {
+    delimiter?: string;
+    quote?: string;
+    escape?: string;
+    bom?: boolean;
+    comment?: string | false;
+    trim?: boolean;
+    /** Generate TypeScript declaration file (.d.ts) */
+    emitTypes?: boolean;
+    /** Output directory for generated type files (relative to output path) */
+    typesOutputDir?: string;
+    /** Write .d.ts files to disk (useful for dev server) */
+    writeToDisk?: boolean;
+    /** Base directory for resolving referenced CSV files (default: directory of current file) */
+    refBaseDir?: string;
+    /** Primary key field name for referenced tables (default: 'id') */
+    defaultPrimaryKey?: string;
+    /** Current file path (used to resolve relative references) */
+    currentFilePath?: string;
+    /**
+     * When false, reference fields store parsed IDs instead of resolved objects.
+     * Used by csvToModule to emit accessor-based code with lazy resolution.
+     * Default: true (resolves references eagerly by loading referenced CSV files).
+     */
+    resolveReferences?: boolean;
+}
+interface ReferenceFieldInfo {
+    /** Column name in the CSV */
+    name: string;
+    /** Referenced table name */
+    tableName: string;
+    /** Whether it's an array reference */
+    isArray: boolean;
+    /** The schema of this field (for nested references) */
+    schema: Schema;
+    /** For reverse references: the foreign key field name in the referenced table */
+    foreignKey?: string;
+}
+interface CsvParseResult {
+    /** Parsed CSV data as array of objects */
+    data: Record<string, unknown>[];
+    /** Generated TypeScript type definition string (if emitTypes is true) */
+    typeDefinition?: string;
+    /** Property configurations for the CSV columns */
+    propertyConfigs: PropertyConfig[];
+    /** Referenced table names */
+    references: Set<string>;
+    /** Reference field metadata (populated when resolveReferences is false) */
+    referenceFields: ReferenceFieldInfo[];
+    /** Reverse reference declarations parsed from comment lines */
+    reverseReferences: ReverseReferenceDeclaration[];
+    /** Type declarations parsed from comment lines */
+    typeDeclarations: TypeDeclaration[];
+}
+interface PropertyConfig {
+    name: string;
+    schema: any;
+    validator: (value: unknown) => boolean;
+    parser: (valueString: string) => unknown;
+    /** Whether this property is a reference to another table */
+    isReference?: boolean;
+    /** Referenced table name (if isReference is true) */
+    referenceTableName?: string;
+    /** Whether it's an array reference */
+    referenceIsArray?: boolean;
+    /** Whether this is a reverse reference (one-to-many) */
+    isReverseReference?: boolean;
+    /** Foreign key field name for reverse references */
+    reverseReferenceForeignKey?: string;
+    /** When a column uses a declared type name, this stores that name */
+    declaredTypeName?: string;
+    /** The original schema string for the column (preserves type name references for output) */
+    schemaString?: string;
+}
+/** Parsed reverse reference declaration from a comment line */
+interface ReverseReferenceDeclaration {
+    /** Field name in the current table */
+    fieldName: string;
+    /** Referenced table name */
+    tableName: string;
+    /** Foreign key field name in the referenced table */
+    foreignKey: string;
+    /** Whether it's optional */
+    isOptional: boolean;
+    /** The parsed schema */
+    schema: ReverseReferenceSchema;
+}
+/** Parsed type declaration from a comment line */
+interface TypeDeclaration {
+    /** Name of the type being defined */
+    name: string;
+    /** The original schema string (preserves type name references for output) */
+    schemaString: string;
+    /** The parsed schema for this type */
+    schema: Schema;
+}
+
+/**
+ * Parse CSV content string into structured data with schema validation.
+ * This is a standalone function that doesn't depend on webpack/rspack LoaderContext.
+ *
+ * @param content - CSV content string (must have at least headers + schema row + 1 data row)
+ * @param options - Parsing options
+ * @returns CsvParseResult containing parsed data and optional type definitions
+ */
+declare function parseCsv(content: string, options?: CsvLoaderOptions & {
+    resourceName?: string;
+}): CsvParseResult;
+
+export { parseCsv };

package/dist/csv-loader/loader.d.ts

@@ -0,0 +1,154 @@
+type SchemaType = "string" | "number" | "int" | "float" | "boolean";
+interface PrimitiveSchema {
+    type: SchemaType;
+}
+interface NamedSchema {
+    name?: string;
+    schema: Schema;
+}
+interface TupleSchema {
+    type: "tuple";
+    elements: NamedSchema[];
+}
+interface ArraySchema {
+    type: "array";
+    element: Schema;
+}
+interface ReferenceSchema {
+    type: "reference";
+    /** Referenced table name (e.g., 'parts' from '@parts[]') */
+    tableName: string;
+    /** Whether it's an array reference */
+    isArray: boolean;
+    /** Whether it's optional (allows empty input resolving to null) */
+    isOptional?: boolean;
+}
+interface ReverseReferenceSchema {
+    type: "reverseReference";
+    /** Referenced table name (e.g., 'orders' from '~orders(user)') */
+    tableName: string;
+    /** The foreign key field name in the referenced table (e.g., 'user' from '~orders(user)') */
+    foreignKey: string;
+    /** Whether it's optional (null if no matches, instead of empty array) */
+    isOptional?: boolean;
+}
+interface StringLiteralSchema {
+    type: "stringLiteral";
+    value: string;
+}
+interface UnionSchema {
+    type: "union";
+    members: Schema[];
+}
+type Schema = PrimitiveSchema | TupleSchema | ArraySchema | ReferenceSchema | ReverseReferenceSchema | StringLiteralSchema | UnionSchema;
+
+interface CsvLoaderOptions {
+    delimiter?: string;
+    quote?: string;
+    escape?: string;
+    bom?: boolean;
+    comment?: string | false;
+    trim?: boolean;
+    /** Generate TypeScript declaration file (.d.ts) */
+    emitTypes?: boolean;
+    /** Output directory for generated type files (relative to output path) */
+    typesOutputDir?: string;
+    /** Write .d.ts files to disk (useful for dev server) */
+    writeToDisk?: boolean;
+    /** Base directory for resolving referenced CSV files (default: directory of current file) */
+    refBaseDir?: string;
+    /** Primary key field name for referenced tables (default: 'id') */
+    defaultPrimaryKey?: string;
+    /** Current file path (used to resolve relative references) */
+    currentFilePath?: string;
+    /**
+     * When false, reference fields store parsed IDs instead of resolved objects.
+     * Used by csvToModule to emit accessor-based code with lazy resolution.
+     * Default: true (resolves references eagerly by loading referenced CSV files).
+     */
+    resolveReferences?: boolean;
+}
+interface ReferenceFieldInfo {
+    /** Column name in the CSV */
+    name: string;
+    /** Referenced table name */
+    tableName: string;
+    /** Whether it's an array reference */
+    isArray: boolean;
+    /** The schema of this field (for nested references) */
+    schema: Schema;
+    /** For reverse references: the foreign key field name in the referenced table */
+    foreignKey?: string;
+}
+interface CsvParseResult {
+    /** Parsed CSV data as array of objects */
+    data: Record<string, unknown>[];
+    /** Generated TypeScript type definition string (if emitTypes is true) */
+    typeDefinition?: string;
+    /** Property configurations for the CSV columns */
+    propertyConfigs: PropertyConfig[];
+    /** Referenced table names */
+    references: Set<string>;
+    /** Reference field metadata (populated when resolveReferences is false) */
+    referenceFields: ReferenceFieldInfo[];
+    /** Reverse reference declarations parsed from comment lines */
+    reverseReferences: ReverseReferenceDeclaration[];
+    /** Type declarations parsed from comment lines */
+    typeDeclarations: TypeDeclaration[];
+}
+interface PropertyConfig {
+    name: string;
+    schema: any;
+    validator: (value: unknown) => boolean;
+    parser: (valueString: string) => unknown;
+    /** Whether this property is a reference to another table */
+    isReference?: boolean;
+    /** Referenced table name (if isReference is true) */
+    referenceTableName?: string;
+    /** Whether it's an array reference */
+    referenceIsArray?: boolean;
+    /** Whether this is a reverse reference (one-to-many) */
+    isReverseReference?: boolean;
+    /** Foreign key field name for reverse references */
+    reverseReferenceForeignKey?: string;
+    /** When a column uses a declared type name, this stores that name */
+    declaredTypeName?: string;
+    /** The original schema string for the column (preserves type name references for output) */
+    schemaString?: string;
+}
+/** Parsed reverse reference declaration from a comment line */
+interface ReverseReferenceDeclaration {
+    /** Field name in the current table */
+    fieldName: string;
+    /** Referenced table name */
+    tableName: string;
+    /** Foreign key field name in the referenced table */
+    foreignKey: string;
+    /** Whether it's optional */
+    isOptional: boolean;
+    /** The parsed schema */
+    schema: ReverseReferenceSchema;
+}
+/** Parsed type declaration from a comment line */
+interface TypeDeclaration {
+    /** Name of the type being defined */
+    name: string;
+    /** The original schema string (preserves type name references for output) */
+    schemaString: string;
+    /** The parsed schema for this type */
+    schema: Schema;
+}
+
+/**
+ * Parse CSV content string into structured data with schema validation.
+ * This is a standalone function that doesn't depend on webpack/rspack LoaderContext.
+ *
+ * @param content - CSV content string (must have at least headers + schema row + 1 data row)
+ * @param options - Parsing options
+ * @returns CsvParseResult containing parsed data and optional type definitions
+ */
+declare function parseCsv(content: string, options?: CsvLoaderOptions & {
+    resourceName?: string;
+}): CsvParseResult;
+
+export { parseCsv };