@nshiab/simple-data-analysis-core 0.0.12

package/esm/methods/trimQuery.d.ts

@@ -0,0 +1,5 @@
+export default function trimQuery(table: string, columns: string[], options: {
+    character?: string;
+    method?: "leftTrim" | "rightTrim" | "trim";
+}): string;
+//# sourceMappingURL=trimQuery.d.ts.map

package/esm/methods/trimQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trimQuery.d.ts","sourceRoot":"","sources":["../../src/methods/trimQuery.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,SAAS,CAC/B,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE;IAAE,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,MAAM,CAAA;CAAE,UA8B5E"}

package/esm/methods/trimQuery.js

@@ -0,0 +1,29 @@
+export default function trimQuery(table, columns, options) {
+    let query = ``;
+    const method = options.method ?? "trim";
+    const specialCharacter = typeof options.character === "string"
+        ? `, '${options.character}'`
+        : "";
+    if (method === "trim") {
+        for (const column of columns) {
+            query +=
+                `\nUPDATE "${table}" SET "${column}" = TRIM("${column}"${specialCharacter});`;
+        }
+    }
+    else if (method === "leftTrim") {
+        for (const column of columns) {
+            query +=
+                `\nUPDATE "${table}" SET "${column}" = LTRIM("${column}"${specialCharacter});`;
+        }
+    }
+    else if (method === "rightTrim") {
+        for (const column of columns) {
+            query +=
+                `\nUPDATE "${table}" SET "${column}" = RTRIM("${column}"${specialCharacter});`;
+        }
+    }
+    else {
+        throw new Error(`Unknown method ${options.method}`);
+    }
+    return query;
+}

package/esm/methods/truncateQuery.d.ts

@@ -0,0 +1,2 @@
+export default function truncateQuery(table: string, column: string, length: number): string;
+//# sourceMappingURL=truncateQuery.d.ts.map

package/esm/methods/truncateQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"truncateQuery.d.ts","sourceRoot":"","sources":["../../src/methods/truncateQuery.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,UAGf"}

package/esm/methods/truncateQuery.js

@@ -0,0 +1,3 @@
+export default function truncateQuery(table, column, length) {
+    return `UPDATE "${table}" SET "${column}" = LEFT("${column}", ${length});`;
+}

package/esm/methods/upperQuery.d.ts

@@ -0,0 +1,2 @@
+export default function upperQuery(table: string, columns: string[]): string;
+//# sourceMappingURL=upperQuery.d.ts.map

package/esm/methods/upperQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upperQuery.d.ts","sourceRoot":"","sources":["../../src/methods/upperQuery.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAQlE"}

package/esm/methods/upperQuery.js

@@ -0,0 +1,7 @@
+export default function upperQuery(table, columns) {
+    let query = "";
+    for (const column of columns) {
+        query += `\nUPDATE "${table}" SET "${column}" = UPPER("${column}");`;
+    }
+    return query;
+}

package/esm/methods/writeDataQuery.d.ts

@@ -0,0 +1,5 @@
+export default function writeDataQuery(table: string, file: string, fileExtension: string, options: {
+    compression?: boolean;
+    formatDates?: boolean;
+}): string;
+//# sourceMappingURL=writeDataQuery.d.ts.map

package/esm/methods/writeDataQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeDataQuery.d.ts","sourceRoot":"","sources":["../../src/methods/writeDataQuery.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE;IAAE,WAAW,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE,UAgD1D"}

package/esm/methods/writeDataQuery.js

@@ -0,0 +1,44 @@
+import { existsSync, rmSync } from "node:fs";
+import cleanPath from "../helpers/cleanPath.js";
+export default function writeDataQuery(table, file, fileExtension, options) {
+    const cleanedFile = cleanPath(file);
+    if (fileExtension === "csv") {
+        return `COPY "${table}" TO '${options.compression ? cleanedFile + ".gz" : cleanedFile}' (DELIMITER ',', HEADER TRUE${options.compression ? ", COMPRESSION GZIP" : ""}${options.formatDates
+            ? ", DATEFORMAT '%xT%X.%gZ', TIMESTAMPFORMAT '%xT%X.%gZ'"
+            : ""});`;
+    }
+    else if (fileExtension === "json") {
+        return `COPY "${table}" TO '${options.compression ? cleanedFile + ".gz" : cleanedFile}' (FORMAT JSON, ARRAY TRUE${options.compression ? ", COMPRESSION GZIP" : ""}${options.formatDates
+            ? ", DATEFORMAT '%xT%X.%gZ', TIMESTAMPFORMAT '%xT%X.%gZ'"
+            : ""});`;
+    }
+    else if (fileExtension === "parquet") {
+        if (options.compression) {
+            return `COPY "${table}" TO '${cleanedFile}' (FORMAT PARQUET, COMPRESSION ZSTD);`;
+        }
+        else {
+            return `COPY "${table}" TO '${cleanedFile}' (FORMAT PARQUET);`;
+        }
+    }
+    else if (fileExtension === "db") {
+        if (existsSync(file)) {
+            rmSync(file);
+        }
+        return `ATTACH '${cleanedFile}' AS "my_database";
+COPY FROM DATABASE memory TO "my_database";
+CREATE OR REPLACE TABLE "my_database"."${table}" AS SELECT * FROM "${table}";
+DETACH "my_database";`;
+    }
+    else if (fileExtension === "sqlite") {
+        if (existsSync(file)) {
+            rmSync(file);
+        }
+        return `INSTALL sqlite; LOAD sqlite;
+    ATTACH '${cleanedFile}' AS "my_sqlite_db" (TYPE SQLITE);
+    CREATE TABLE "my_sqlite_db"."${table}" AS SELECT * FROM "${table}";
+    DETACH "my_sqlite_db";`;
+    }
+    else {
+        throw new Error(`Unknown extension ${fileExtension}`);
+    }
+}

package/esm/methods/writeGeoDataQuery.d.ts

@@ -0,0 +1,4 @@
+export default function writeGeoDataQuery(table: string, file: string, fileExtension: string, options?: {
+    precision?: number;
+}): string;
+//# sourceMappingURL=writeGeoDataQuery.d.ts.map

package/esm/methods/writeGeoDataQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeGeoDataQuery.d.ts","sourceRoot":"","sources":["../../src/methods/writeGeoDataQuery.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAO,UAqBrC"}

package/esm/methods/writeGeoDataQuery.js

@@ -0,0 +1,16 @@
+import cleanPath from "../helpers/cleanPath.js";
+export default function writeGeoDataQuery(table, file, fileExtension, options = {}) {
+    if (fileExtension === "geojson" || fileExtension === "json") {
+        const layerOptions = [];
+        if (typeof options.precision === "number") {
+            layerOptions.push(`COORDINATE_PRECISION=${options.precision}`);
+        }
+        layerOptions.push(`RFC7946=YES`);
+        return `COPY "${table}" to '${cleanPath(file)}' WITH (FORMAT GDAL, DRIVER 'GeoJSON'${layerOptions.length > 0
+            ? `, LAYER_CREATION_OPTIONS ('WRITE_NAME=NO', ${layerOptions.map((d) => `'${d}'`).join(", ")})`
+            : ""})`;
+    }
+    else {
+        throw new Error(`Unknown extension ${fileExtension}`);
+    }
+}

package/esm/methods/zScoreQuery.d.ts

@@ -0,0 +1,5 @@
+export default function zScoreQuery(table: string, column: string, newColumn: string, options?: {
+    categories?: string | string[];
+    decimals?: number;
+}): string;
+//# sourceMappingURL=zScoreQuery.d.ts.map

package/esm/methods/zScoreQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zScoreQuery.d.ts","sourceRoot":"","sources":["../../src/methods/zScoreQuery.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,UAAU,WAAW,CACjC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE;IACP,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACd,UA0BP"}

package/esm/methods/zScoreQuery.js

@@ -0,0 +1,23 @@
+import stringToArray from "../helpers/stringToArray.js";
+export default function zScoreQuery(table, column, newColumn, options = {}) {
+    const categories = options.categories
+        ? stringToArray(options.categories)
+        : [];
+    const partition = categories.length > 0
+        ? `PARTITION BY ${categories.map((d) => `"${d}"`).join(", ")}`
+        : "";
+    const tempQuery = `("${column}"-AVG("${column}") OVER(${partition}))
+            /
+            STDDEV_POP("${column}") OVER(${partition})`;
+    const query = `
+    CREATE OR REPLACE TABLE "${table}" AS
+    SELECT *, (
+        ${typeof options.decimals === "number"
+        ? `ROUND(${tempQuery}, ${options.decimals})`
+        : tempQuery}
+        
+        ) AS ${newColumn},
+    FROM "${table}"
+    `;
+    return query;
+}

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@nshiab/simple-data-analysis-core",
+  "version": "0.0.12",
+  "repository": {
+    "type": "git"
+  },
+  "main": "./script/index.js",
+  "module": "./esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./script/index.js"
+    },
+    "./helpers": {
+      "import": "./esm/helpers/index.js",
+      "require": "./script/helpers/index.js"
+    }
+  },
+  "scripts": {},
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@duckdb/node-api": "1.4.4-r.1"
+  },
+  "_generatedBy": "dnt@dev"
+}

package/script/class/Simple.d.ts

@@ -0,0 +1,66 @@
+import type { DuckDBConnection, DuckDBInstance } from "@duckdb/node-api";
+/**
+ * An abstract base class providing common properties for SimpleDB and SimpleTable. This class is not intended for direct instantiation.
+ */
+export default class Simple {
+    /**
+     * A flag indicating whether to log debugging information.
+     *
+     * @defaultValue `false`
+     */
+    debug: boolean;
+    /**
+     * The number of rows to display when logging a table.
+     *
+     * @defaultValue `10`
+     */
+    nbRowsToLog: number;
+    /**
+     * A flag indicating whether to include data types when logging a table.
+     *
+     * @defaultValue `false`
+     */
+    types: boolean;
+    /**
+     * The maximum number of characters to display for text-based cells. If undefined, the entire text is shown.
+     *
+     * @defaultValue `undefined`
+     */
+    nbCharactersToLog: number | undefined;
+    /**
+     * A DuckDB database instance.
+     */
+    db: DuckDBInstance;
+    /**
+     * A connection to a DuckDB database.
+     */
+    connection: DuckDBConnection;
+    /**
+     * A flag indicating if the table name was assigned by default.
+     *
+     * @defaultValue `false`
+     */
+    defaultTableName: boolean;
+    /**
+     * A function for running SQL queries. This is for internal use only. To run a custom SQL query, use the SimpleDB.customQuery method.
+     */
+    runQuery: (query: string, connection: DuckDBConnection, returnDataFromQuery: boolean, options: {
+        debug: boolean;
+        method: string | null;
+        parameters: {
+            [key: string]: unknown;
+        } | null;
+        types?: {
+            [key: string]: string;
+        };
+    }) => Promise<{
+        [key: string]: number | string | Date | boolean | null;
+    }[] | null>;
+    constructor(options?: {
+        debug?: boolean;
+        nbRowsToLog?: number;
+        nbCharactersToLog?: number;
+        types?: boolean;
+    });
+}
+//# sourceMappingURL=Simple.d.ts.map

package/script/class/Simple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Simple.d.ts","sourceRoot":"","sources":["../../src/class/Simple.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEzE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB;;;;OAIG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,EAAE,EAAG,cAAc,CAAC;IACpB;;OAEG;IACH,UAAU,EAAG,gBAAgB,CAAC;IAC9B;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAG,CACT,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,gBAAgB,EAC5B,mBAAmB,EAAE,OAAO,EAC5B,OAAO,EAAE;QACP,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,UAAU,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAC9C,KAAK,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KACnC,KACE,OAAO,CACR;QACA,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,IAAI,CAAC;KACxD,EAAE,GACD,IAAI,CACP,CAAC;gBAGA,OAAO,GAAE;QACP,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;KACZ;CAQT"}

package/script/class/Simple.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * An abstract base class providing common properties for SimpleDB and SimpleTable. This class is not intended for direct instantiation.
+ */
+class Simple {
+    constructor(options = {}) {
+        /**
+         * A flag indicating whether to log debugging information.
+         *
+         * @defaultValue `false`
+         */
+        Object.defineProperty(this, "debug", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * The number of rows to display when logging a table.
+         *
+         * @defaultValue `10`
+         */
+        Object.defineProperty(this, "nbRowsToLog", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * A flag indicating whether to include data types when logging a table.
+         *
+         * @defaultValue `false`
+         */
+        Object.defineProperty(this, "types", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * The maximum number of characters to display for text-based cells. If undefined, the entire text is shown.
+         *
+         * @defaultValue `undefined`
+         */
+        Object.defineProperty(this, "nbCharactersToLog", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * A DuckDB database instance.
+         */
+        Object.defineProperty(this, "db", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * A connection to a DuckDB database.
+         */
+        Object.defineProperty(this, "connection", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * A flag indicating if the table name was assigned by default.
+         *
+         * @defaultValue `false`
+         */
+        Object.defineProperty(this, "defaultTableName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * A function for running SQL queries. This is for internal use only. To run a custom SQL query, use the SimpleDB.customQuery method.
+         */
+        Object.defineProperty(this, "runQuery", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.nbRowsToLog = options.nbRowsToLog ?? 10;
+        this.nbCharactersToLog = options.nbCharactersToLog;
+        this.types = options.types ?? false;
+        this.debug = options.debug ?? false;
+        this.defaultTableName = false;
+    }
+}
+exports.default = Simple;