@nshiab/simple-data-analysis-core 0.0.12

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 Nael Shiab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# Simple data analysis core (SDA-core)
+
+This repository contains the core functionalities of the
+[simple-data-analysis library](https://github.com/nshiab/simple-data-analysis),
+an easy-to-use and high-performance TypeScript library for data analysis that
+you can use with tabular, geospatial and vector data.
+
+You'll find here a stripped-out version with only one dependency (DuckDB) that
+is aimed to be light-weight and to be used in constrained environment.
+
+The library is available on
+[JSR](https://jsr.io/@nshiab/simple-data-analysis-core) with its
+[documentation](https://jsr.io/@nshiab/simple-data-analysis-core/doc).
+
+The documentation is also available as the markdown file
+[llm.md](https://github.com/nshiab/simple-data-analysis-core/blob/main/llm.md),
+which can be passed as context to improve the use of the library by AI coding
+assistants or agents.
+
+The library is maintained by [Nael Shiab](http://naelshiab.com/), computational
+journalist and senior data producer for [CBC News](https://www.cbc.ca/news).
+
+For the full-fledged library (with AI, dataviz, google sheet methods and more),
+check the
+[simple-data-analysis repository](https://github.com/nshiab/simple-data-analysis).
+
+> [!TIP]
+> To learn how to use SDA, check out
+> [Code Like a Journalist](https://www.code-like-a-journalist.com/), a free and
+> open-source data analysis and data visualization course in TypeScript.
+
+## Installation
+
+```bash
+# Deno >= 2.2.x
+deno add jsr:@nshiab/simple-data-analysis-core
+
+# Node.js
+npx jsr add @nshiab/simple-data-analysis-core
+
+# Bun
+bunx jsr add @nshiab/simple-data-analysis-core
+```

package/esm/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/esm/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/esm/class/Simple.js

@@ -0,0 +1,94 @@
+/**
+ * An abstract base class providing common properties for SimpleDB and SimpleTable. This class is not intended for direct instantiation.
+ */
+export default 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;
+    }
+}