csv-sql-engine 0.0.2 → 0.2.0

package/dist/csv/csv-text.js

@@ -1,6 +1,5 @@
-import { wrapString } from '@augment-vir/common';
+import { trimLines, wrapString } from '@augment-vir/common';
 import { csvParseRows } from 'd3-dsv';
-import { trimLines } from '../augments/trim-lines.js';
 /**
  * Converts multiple rows of values into a CSV file string.
  *

package/dist/engine/define-ast-handler.d.ts

@@ -1,11 +1,14 @@
 import { type MaybePromise } from '@augment-vir/common';
 import { type AstHandlerParams } from './params.js';
+import { type SortValuesOutput } from './sort-values.js';
 /**
  * Output from a handler that handled a SQL query.
  *
  * @category Internal
  */
-export type AstHandlerResult = string[][];
+export type AstHandlerResult = SortValuesOutput & {
+    numberOfRowsAffected: number;
+};
 /**
  * An AST / SQL handler.
  *
@@ -17,7 +20,7 @@ export type AstHandler = {
      * Return `undefined` to mark this AST as not-handled. That means that other handlers should be
      * used instead.
      */
-    handler: (params: Readonly<AstHandlerParams>) => MaybePromise<AstHandlerResult | undefined>;
+    handler: (params: Readonly<AstHandlerParams>) => MaybePromise<AstHandlerResult[] | undefined>;
 };
 /**
  * Used to define new handlers.

package/dist/engine/engine.d.ts

@@ -13,4 +13,4 @@ export declare const allAstHandlers: ReadonlyArray<Readonly<AstHandler>>;
  *
  * @category Main
  */
-export declare function executeSql(sqlInput: Sql | string, params: Readonly<ExecuteSqlParams>): Promise<AstHandlerResult[]>;
+export declare function executeSql(sqlInput: Sql | string, params: Readonly<ExecuteSqlParams>): Promise<AstHandlerResult[][]>;

package/dist/engine/handlers/row-delete.handler.js

@@ -15,7 +15,7 @@ export const rowDeleteHandler = defineAstHandler({
     async handler({ ast, csvDirPath, sql }) {
         if (ast.type === AstType.Delete) {
             const tableNames = ast.table.map((table) => table.table);
-            const returning = await awaitedBlockingMap(tableNames, async (tableName) => {
+            const results = await awaitedBlockingMap(tableNames, async (tableName) => {
                 const { tableFilePath, sanitizedTableName } = nameCsvTableFile({
                     csvDirPath,
                     tableName,
@@ -27,25 +27,29 @@ export const rowDeleteHandler = defineAstHandler({
                 });
                 const rowIndexesToDelete = findWhereMatches(ast.where, csvContents, tableFilePath);
                 const returningRequirement = ast.returning;
-                const returning = returningRequirement
-                    ? csvContents
-                        .filter((row, index) => rowIndexesToDelete.includes(index))
-                        .map((row) => sortValues({
+                const result = returningRequirement
+                    ? sortValues({
                         csvFileHeaderOrder: csvHeaders,
                         sqlQueryHeaderOrder: returningRequirement.columns.map((column) => column.expr.column),
                         from: {
-                            csvFile: row,
+                            csvFile: csvContents.filter((row, index) => rowIndexesToDelete.includes(index)),
                         },
                         unconsumedInterpolationValues: sql.unconsumedValues,
-                    }))
-                    : undefined;
+                    })
+                    : {
+                        columnNames: [],
+                        values: [],
+                    };
                 rowIndexesToDelete.forEach((rowIndexToDelete) => {
                     csvContents.splice(rowIndexToDelete, 1);
                 });
                 await writeCsvFile(tableFilePath, csvContents);
-                return returning;
+                return {
+                    ...result,
+                    numberOfRowsAffected: rowIndexesToDelete.length,
+                };
             });
-            return returning.flat().filter(check.isTruthy);
+            return results.flat().filter(check.isTruthy);
         }
         return undefined;
     },

package/dist/engine/handlers/row-insert.handler.js

@@ -1,4 +1,4 @@
-import { check } from '@augment-vir/assert';
+import { assertWrap, check } from '@augment-vir/assert';
 import { awaitedBlockingMap } from '@augment-vir/common';
 import { appendCsvRow, nameCsvTableFile, readCsvHeaders } from '../../csv/csv-file.js';
 import { AstType } from '../../sql/ast.js';
@@ -14,7 +14,7 @@ export const rowInsertHandler = defineAstHandler({
     async handler({ ast, csvDirPath, sql }) {
         if (ast.type === AstType.Insert) {
             const tableNames = ast.table.map((table) => table.table);
-            const returning = await awaitedBlockingMap(tableNames, async (tableName) => {
+            const results = await awaitedBlockingMap(tableNames, async (tableName) => {
                 const { tableFilePath, sanitizedTableName } = nameCsvTableFile({
                     csvDirPath,
                     tableName,
@@ -24,30 +24,34 @@ export const rowInsertHandler = defineAstHandler({
                     csvFilePath: tableFilePath,
                     sanitizedTableName,
                 });
-                const newRow = sortValues({
+                const newRow = assertWrap.isDefined(sortValues({
                     csvFileHeaderOrder,
                     sqlQueryHeaderOrder: ast.columns || csvFileHeaderOrder,
                     from: {
-                        sqlQuery: rawValues,
+                        sqlQuery: [rawValues],
                     },
                     unconsumedInterpolationValues: sql.unconsumedValues,
-                });
+                }).values[0], 'No sorted row retrieved.');
                 await appendCsvRow(newRow, tableFilePath);
-                if (ast.returning) {
-                    return sortValues({
+                const readResult = ast.returning
+                    ? sortValues({
                         csvFileHeaderOrder,
                         sqlQueryHeaderOrder: ast.returning.columns.map((column) => column.expr.column),
                         from: {
-                            csvFile: newRow,
+                            csvFile: [newRow],
                         },
                         unconsumedInterpolationValues: undefined,
-                    });
-                }
-                else {
-                    return undefined;
-                }
+                    })
+                    : {
+                        columnNames: [],
+                        values: [],
+                    };
+                return {
+                    ...readResult,
+                    numberOfRowsAffected: 1,
+                };
             });
-            return returning.filter(check.isTruthy);
+            return results.filter(check.isTruthy);
         }
         return undefined;
     },

package/dist/engine/handlers/row-select.handler.js

@@ -1,6 +1,6 @@
 import { check } from '@augment-vir/assert';
 import { awaitedBlockingMap } from '@augment-vir/common';
-import { nameCsvTableFile, readCsvFile, readCsvHeaders, writeCsvFile } from '../../csv/csv-file.js';
+import { nameCsvTableFile, readCsvFile, readCsvHeaders } from '../../csv/csv-file.js';
 import { AstType } from '../../sql/ast.js';
 import { defineAstHandler } from '../define-ast-handler.js';
 import { sortValues } from '../sort-values.js';
@@ -27,18 +27,17 @@ export const rowSelectHandler = defineAstHandler({
                 });
                 const rowIndexesToSelect = findWhereMatches(ast.where, csvContents, tableFilePath);
                 const columnNames = ast.columns.map((column) => column.expr.column);
-                const selection = csvContents
-                    .filter((row, index) => rowIndexesToSelect.includes(index))
-                    .map((row) => sortValues({
-                    csvFileHeaderOrder: csvHeaders,
-                    sqlQueryHeaderOrder: columnNames,
-                    from: {
-                        csvFile: row,
-                    },
-                    unconsumedInterpolationValues: sql.unconsumedValues,
-                }));
-                await writeCsvFile(tableFilePath, csvContents);
-                return selection;
+                return {
+                    ...sortValues({
+                        csvFileHeaderOrder: csvHeaders,
+                        sqlQueryHeaderOrder: columnNames,
+                        from: {
+                            csvFile: csvContents.filter((row, index) => rowIndexesToSelect.includes(index)),
+                        },
+                        unconsumedInterpolationValues: sql.unconsumedValues,
+                    }),
+                    numberOfRowsAffected: 0,
+                };
             });
             return allSelections.flat().filter(check.isTruthy);
         }

package/dist/engine/handlers/row-update.handler.js

@@ -16,7 +16,7 @@ export const rowUpdateHandler = defineAstHandler({
     async handler({ ast, csvDirPath, sql }) {
         if (ast.type === AstType.Update) {
             const tableNames = ast.table.map((table) => table.table);
-            const returning = await awaitedBlockingMap(tableNames, async (tableName) => {
+            const results = await awaitedBlockingMap(tableNames, async (tableName) => {
                 const { tableFilePath, sanitizedTableName } = nameCsvTableFile({
                     csvDirPath,
                     tableName,
@@ -40,22 +40,27 @@ export const rowUpdateHandler = defineAstHandler({
                         row[headerIndex] = set.value.value;
                     });
                 });
-                const updatedRow = returningRequirement
-                    ? csvContents
-                        .filter((row, index) => rowIndexesToUpdate.includes(index))
-                        .map((row) => sortValues({
+                const sqlHeaders = returningRequirement?.columns.map((column) => column.expr.column) || [];
+                const result = returningRequirement
+                    ? sortValues({
                         csvFileHeaderOrder: csvHeaders,
-                        sqlQueryHeaderOrder: returningRequirement.columns.map((column) => column.expr.column),
+                        sqlQueryHeaderOrder: sqlHeaders,
                         from: {
-                            csvFile: row,
+                            csvFile: csvContents.filter((row, index) => rowIndexesToUpdate.includes(index)),
                         },
                         unconsumedInterpolationValues: sql.unconsumedValues,
-                    }))
-                    : undefined;
+                    })
+                    : {
+                        columnNames: [],
+                        values: [],
+                    };
                 await writeCsvFile(tableFilePath, csvContents);
-                return updatedRow;
+                return {
+                    ...result,
+                    numberOfRowsAffected: rowIndexesToUpdate.length,
+                };
             });
-            return returning.flat().filter(check.isTruthy);
+            return results.flat().filter(check.isTruthy);
         }
         return undefined;
     },

package/dist/engine/sort-values.d.ts

@@ -1,5 +1,14 @@
 import { type RequireExactlyOne } from 'type-fest';
 import { type ConsumableValue } from '../sql/sql.js';
+/**
+ * Output from {@link sortValues}.
+ *
+ * @category Internal
+ */
+export type SortValuesOutput = {
+    values: string[][];
+    columnNames: string[];
+};
 /**
  * Sorts values for CSV insertion or reading and handle interpolated values.
  *
@@ -10,9 +19,9 @@ export declare function sortValues({ csvFileHeaderOrder, sqlQueryHeaderOrder, fr
     sqlQueryHeaderOrder: ReadonlyArray<string>;
     from: RequireExactlyOne<{
         /** When a CSV value array is provided, they are sorted to the SQL header order. */
-        csvFile: ReadonlyArray<string>;
+        csvFile: ReadonlyArray<ReadonlyArray<string>>;
         /** When a SQL value array is provided, they are sorted to the CSV header order. */
-        sqlQuery: ReadonlyArray<string>;
+        sqlQuery: ReadonlyArray<ReadonlyArray<string>>;
     }>;
     unconsumedInterpolationValues: undefined | ConsumableValue[];
-}>): string[];
+}>): SortValuesOutput;

package/dist/engine/sort-values.js

@@ -13,26 +13,32 @@ export function sortValues({ csvFileHeaderOrder, sqlQueryHeaderOrder, from, unco
             return header;
         }
     });
-    const values = (from.csvFile || from.sqlQuery).map((value) => {
-        if (value === '?') {
-            if (unconsumedInterpolationValues) {
-                if (unconsumedInterpolationValues.length) {
-                    return unconsumedInterpolationValues.shift() || '';
+    const values = (from.csvFile || from.sqlQuery).map((valueRow) => {
+        const mappedValueRow = valueRow.map((value) => {
+            if (value === '?') {
+                if (unconsumedInterpolationValues) {
+                    if (unconsumedInterpolationValues.length) {
+                        return unconsumedInterpolationValues.shift() || '';
+                    }
+                    else {
+                        throw new Error('Encountered ? but all interpolation values have already been used.');
+                    }
                 }
                 else {
-                    throw new Error('Encountered ? but all interpolation values have already been used.');
+                    throw new Error('Encountered ? but received no interpolation values.');
                 }
             }
             else {
-                throw new Error('Encountered ? but received no interpolation values.');
+                return value;
             }
-        }
-        else {
-            return value;
-        }
-    });
-    return toOrder.map((header) => {
-        const sourceIndex = fromOrder.indexOf(header);
-        return values[sourceIndex] ?? '';
+        });
+        return toOrder.map((header) => {
+            const sourceIndex = fromOrder.indexOf(header);
+            return mappedValueRow[sourceIndex] ?? '';
+        });
     });
+    return {
+        columnNames: toOrder,
+        values,
+    };
 }

package/dist/errors/sql.error.js

@@ -1,5 +1,4 @@
-import { addSuffix, extractErrorMessage, indent } from '@augment-vir/common';
-import { trimLines } from '../augments/trim-lines.js';
+import { addSuffix, extractErrorMessage, indent, trimLines } from '@augment-vir/common';
 import { CsvSqlEngineError } from './csv-sql-engine.error.js';
 /**
  * Generic SQL related error thrown by the csv-sql-engine package. All SQL related errors from this

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-export * from './augments/trim-lines.js';
 export * from './csv/csv-file.js';
 export * from './csv/csv-text.js';
 export * from './engine/define-ast-handler.js';

package/dist/index.js

@@ -1,4 +1,3 @@
-export * from './augments/trim-lines.js';
 export * from './csv/csv-file.js';
 export * from './csv/csv-text.js';
 export * from './engine/define-ast-handler.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "csv-sql-engine",
-    "version": "0.0.2",
+    "version": "0.2.0",
     "description": "API for executing SQL statements on CSV files.",
     "keywords": [
         "CSV",
@@ -43,9 +43,9 @@
         "test:update": "npm run test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.55.0",
-        "@augment-vir/common": "^31.55.0",
-        "@augment-vir/node": "^31.55.0",
+        "@augment-vir/assert": "^31.56.0",
+        "@augment-vir/common": "^31.56.0",
+        "@augment-vir/node": "^31.56.0",
         "@sinclair/typebox": "^0.34.45",
         "d3-dsv": "^3.0.1",
         "node-sql-parser": "^5.3.13",
@@ -53,7 +53,7 @@
         "sql-template-tag": "^5.2.1"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.55.0",
+        "@augment-vir/test": "^31.56.0",
         "@eslint/eslintrc": "^3.3.3",
         "@eslint/js": "^9.39.2",
         "@stylistic/eslint-plugin": "^5.6.1",
@@ -93,7 +93,7 @@
         "typedoc": "^0.28.15",
         "typescript": "^5.9.3",
         "typescript-eslint": "^8.50.1",
-        "virmator": "^14.3.5"
+        "virmator": "^14.4.0"
     },
     "engines": {
         "node": ">=22"

package/dist/augments/trim-lines.d.ts

@@ -1,6 +0,0 @@
-/**
- * Trims every line in the given string.
- *
- * @category Internal
- */
-export declare function trimLines(value: string): string;

package/dist/augments/trim-lines.js

@@ -1,12 +0,0 @@
-import { check } from '@augment-vir/assert';
-import { filterMap } from '@augment-vir/common';
-/**
- * Trims every line in the given string.
- *
- * @category Internal
- */
-export function trimLines(value) {
-    return filterMap(value.trim().split('\n'), (line) => line.trim(), check.isTruthy)
-        .join('\n')
-        .trim();
-}