@wxn0brp/db-storage-csv 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 wxn0brP
+
+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,37 @@
+# @wxn0brp/db-storage-csv
+
+A CSV storage adapter for the `@wxn0brp/db-core` library. This package allows you to use CSV files as a simple database backend.
+
+## Usage
+
+### Basic Setup
+
+```typescript
+import { createCsvValthera } from "@wxn0brp/db-storage-csv";
+
+// Initialize the CSV ValtheraDB
+const csvStorageDB = createCsvValthera({
+  dir: './data' // Directory where CSV files will be stored
+});
+
+// Or, for a single file
+const singleFileDB = createCsvValthera({
+  file: './data.csv' // Path to a single CSV file
+});
+// Note: all collections redirect to the same file, supporting single collection
+```
+
+### Options
+
+- `dir`: Path to a directory where CSV files for each collection will be stored.
+- `file`: Path to a single CSV file to be used for storage (mutually exclusive with `dir`).
+
+## How it works
+
+- When a collection is accessed, the adapter reads the corresponding CSV file.
+- Data is parsed into JavaScript objects using the `csv` library.
+- Writes stringify the data back into CSV format.
+
+## License
+
+MIT

package/dist/action.d.ts

@@ -0,0 +1,16 @@
+import { CustomActionsBase } from "@wxn0brp/db-core/base/custom";
+import { VQuery } from "@wxn0brp/db-core/types/query";
+export interface Opts {
+    file?: string;
+    dir?: string;
+}
+export declare class DbStorageCsv extends CustomActionsBase {
+    opts: Opts;
+    constructor(opts: Opts);
+    _getPath(config: VQuery): string;
+    read(file: string): Promise<unknown[]>;
+    write(file: string, data: any): Promise<void>;
+    ensureCollection(config: VQuery): Promise<boolean>;
+    issetCollection(config: VQuery): Promise<boolean>;
+    getCollections(): Promise<string[]>;
+}

package/dist/action.js

@@ -0,0 +1,73 @@
+import { CustomFileCpu } from "@wxn0brp/db-core";
+import { CustomActionsBase } from "@wxn0brp/db-core/base/custom";
+import { access, mkdir, readdir } from "fs/promises";
+import { parse, stringify } from "csv/sync";
+import { readFile, writeFile } from "fs/promises";
+export class DbStorageCsv extends CustomActionsBase {
+    opts;
+    constructor(opts) {
+        super();
+        this.opts = opts;
+        this.fileCpu = new CustomFileCpu(this.read.bind(this), this.write.bind(this));
+    }
+    _getPath(config) {
+        if (this.opts.file) {
+            return this.opts.file;
+        }
+        else if (this.opts.dir) {
+            return this.opts.dir + "/" + config.collection + ".csv";
+        }
+    }
+    async read(file) {
+        const path = this._getPath({ collection: file });
+        const data = await readFile(path, "utf-8");
+        return parse(data, { columns: true });
+    }
+    async write(file, data) {
+        const string = stringify(data, { header: true });
+        const path = this._getPath({ collection: file });
+        await writeFile(path, string);
+    }
+    async ensureCollection(config) {
+        const path = this._getPath(config);
+        if (this.opts.file) {
+            try {
+                await access(path);
+            }
+            catch (error) {
+                await writeFile(path, "");
+            }
+        }
+        else if (this.opts.dir) {
+            try {
+                await access(path);
+            }
+            catch (error) {
+                await mkdir(path.split("/").slice(0, -1).join("/"), { recursive: true });
+                await writeFile(path, "");
+            }
+        }
+        return true;
+    }
+    async issetCollection(config) {
+        const path = this._getPath(config);
+        try {
+            await access(path);
+            return true;
+        }
+        catch (error) {
+            return false;
+        }
+    }
+    async getCollections() {
+        if (this.opts.file) {
+            return [this.opts.file];
+        }
+        else if (this.opts.dir) {
+            return await readdir(this.opts.dir, { recursive: true });
+        }
+        else {
+            return [];
+        }
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { ValtheraClass } from "@wxn0brp/db-core";
+import { Opts } from "./action.js";
+export declare function createCsvValthera(opts: Opts): ValtheraClass;

package/dist/index.js

@@ -0,0 +1,8 @@
+import { ValtheraClass } from "@wxn0brp/db-core";
+import { DbStorageCsv } from "./action.js";
+export function createCsvValthera(opts) {
+    const csvStorage = new DbStorageCsv(opts);
+    return new ValtheraClass({
+        dbAction: csvStorage
+    });
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+    "name": "@wxn0brp/db-storage-csv",
+    "version": "0.0.1",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "description": "ValtheraDB Storage CSV",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/wxn0brp/ValtheraDB-storage-csv.git"
+    },
+    "homepage": "https://github.com/wxn0brp/ValtheraDB-storage-csv",
+    "author": "wxn0brP",
+    "license": "MIT",
+    "type": "module",
+    "scripts": {
+        "build": "tsc && tsc-alias",
+        "bun": "bun run src/test.ts"
+    },
+    "peerDependencies": {
+        "@wxn0brp/db-core": ">=0.3.0"
+    },
+    "dependencies": {
+        "csv": "^6.4.1"
+    },
+    "devDependencies": {
+        "@types/node": "*",
+        "@wxn0brp/db-core": "^0.3.0",
+        "tsc-alias": "*",
+        "typescript": "*"
+    },
+    "files": [
+        "dist"
+    ],
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "default": "./dist/index.js"
+        },
+        "./*": {
+            "types": "./dist/*.d.ts",
+            "import": "./dist/*.js",
+            "default": "./dist/*.js"
+        }
+    }
+}