@wxn0brp/db-core 0.0.1 → 0.0.2

package/README.md

@@ -1,5 +1,17 @@
-# ValtheraDB Core
+# @wxn0brp/db-core
 
-This is the core library for [ValtheraDB](https://github.com/wxn0brp/ValtheraDB)
+Core library for [ValtheraDB](https://github.com/wxn0brp/ValtheraDB).
 
-It is `not recommended` to install this module separately unless you plan to create your own ValtheraDB adapter
+## ⚠️ Disclaimer
+
+It is **not recommended** to install this module separately unless you plan to create your own ValtheraDB adapter.
+
+## Installation
+
+```bash
+npm install @wxn0brp/db-core
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/dist/version.js

@@ -1 +1 @@
-export const version = "0.0.1";
+export const version = "0.0.2";

package/package.json

@@ -1,16 +1,25 @@
 {
   "name": "@wxn0brp/db-core",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "author": "wxn0brP",
   "license": "MIT",
   "type": "module",
+  "description": "ValtheraDB Core",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wxn0brP/ValtheraDB-core.git"
+  },
+  "homepage": "https://github.com/wxn0brP/ValtheraDB",
   "devDependencies": {
     "@types/node": "^22.12.0",
     "tsc-alias": "^1.8.10",
     "typescript": "^5.7.3"
   },
+  "files": [
+    "dist"
+  ],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",

package/.github/workflows/build-relase.yml

@@ -1,25 +0,0 @@
-name: Release
-
-on:
-  push:
-    tags:
-      - '*'
-  workflow_dispatch:
-
-concurrency:
-  group: build-release
-  cancel-in-progress: true
-
-jobs:
-  build:
-    uses: wxn0brP/workflow-dist/.github/workflows/build-ts.yml@main
-    with:
-      files: "dist package.json README.md LICENSE"
-      publishToNpm: true
-      scriptsHandling: "remove-all"
-      customCommands: |
-        v=$(jq -r .version package.json)
-        echo "export const version = \"$v\";" > dist/version.js
-        
-    secrets:
-      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/build.yml

@@ -1,20 +0,0 @@
-name: Nightly
-
-on:
-  push:
-    branches:
-      - master
-  workflow_dispatch:
-
-concurrency:
-  group: build-master
-  cancel-in-progress: true
-
-jobs:
-  build:
-    uses: wxn0brP/workflow-dist/.github/workflows/build-ts.yml@main
-    with:
-      scriptsHandling: 'remove-all'
-      customCommands: |
-        v=$(jq -r .version package.json)
-        echo "export const version = \"$v\";" > dist/version.js

package/.github/workflows/types.yml

@@ -1,89 +0,0 @@
-name: Types
-
-on:
-  push:
-    branches:
-      - master
-    tags:
-      - '*'
-
-  pull_request:
-    branches:
-      - master
-  workflow_dispatch:
-
-concurrency:
-  group: build-types
-  cancel-in-progress: true
-
-jobs:
-  deploy-types:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-
-    steps:
-      - name: Checkout Repo
-        uses: actions/checkout@v3
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 22
-
-      - name: Install Dependencies
-        run: |
-          npm i
-          npm install -g tsc-alias
-
-      - name: Build Declarations Only
-        run: |
-          npx tsc --emitDeclarationOnly --declaration --removeComments --outDir dist --project tsconfig.json
-          tsc-alias
-
-      - name: Prepare Clean package.json
-        run: |
-          jq 'del(
-            .scripts,
-            .dependencies,
-            .devDependencies,
-            .peerDependencies,
-            .optionalDependencies,
-            .bundledDependencies
-          )' package.json > dist/package.json
-          rm package.json
-          mv dist/package.json package.json
-
-      - name: Push to `types` Branch
-        run: |
-          git config --global user.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.github.com"
-
-          git checkout --orphan types
-          git reset -q HEAD --
-
-          git add -f -A dist LICENSE package.json
-          git commit -m "Deploy type definitions only"
-          git push origin types --force
-
-      - name: Push to `types-only` Branch
-        run: |
-          git config --global user.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.github.com"
-
-          git checkout --orphan types-only
-          git reset -q HEAD --
-
-          cat << EOF > dist/index.d.ts
-          import { ValtheraTypes } from "./types/export";
-          import { RelationTypes } from "./types/relation";
-          import { ValtheraCompatible } from "./types/valthera";
-          export type { RelationTypes, ValtheraCompatible, ValtheraTypes };
-          export type Id = import("./types/Id").Id;
-          EOF
-
-          echo "export {}" > dist/index.js
-
-          git add -f -A dist/types dist/index.d.ts dist/index.js LICENSE package.json
-          git commit -m "Deploy type definitions only"
-          git push origin types-only --force

package/CHANGELOG.md

@@ -1,9 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-### 0.0.1 (2025-07-12)
-
-### [0.0.1](https://github.com/wxn0brP/ValtheraDB-core/compare/v0.0.2...v0.0.1) (2025-07-12)
-
-### 0.0.2 (2025-07-12)

package/src/base/actions.ts

@@ -1,71 +0,0 @@
-import { setDataUsingUpdateOneOrAdd } from "../helpers/updateOneOrAdd";
-import Data from "../types/data";
-import { VQuery } from "../types/query";
-
-class dbActionBase {
-    async getCollections() {
-        throw new Error("Not implemented");
-        return [] as string[];
-    }
-
-    async checkCollection(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async issetCollection(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async add(config: VQuery) {
-        throw new Error("Not implemented");
-        return {} as Data;
-    }
-
-    async find(config: VQuery) {
-        throw new Error("Not implemented");
-        return [] as Data[];
-    }
-
-    async findOne(config: VQuery): Promise<Data | null> {
-        throw new Error("Not implemented");
-        return {} as Data;
-    }
-
-    async update(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async updateOne(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async remove(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async removeOne(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async removeCollection(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async updateOneOrAdd(config: VQuery) {
-        const res = await this.updateOne(config);
-        if (!res) {
-            setDataUsingUpdateOneOrAdd(config);
-            await this.add(config);
-        }
-        return res as boolean;
-    }
-}
-
-export default dbActionBase;

package/src/base/db.ts

@@ -1,75 +0,0 @@
-import CollectionManager from "../helpers/CollectionManager";
-import Data from "../types/data";
-import { VQuery } from "../types/query";
-import { ValtheraCompatibleInternal } from "../types/valthera";
-import { version } from "../version";
-
-class ValtheraBase implements ValtheraCompatibleInternal {
-    version = version;
-    
-    c(config: VQuery): CollectionManager {
-        throw new Error("Not implemented");
-    }
-
-    async getCollections() {
-        throw new Error("Not implemented");
-        return [];
-    }
-
-    async checkCollection(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async issetCollection(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async add<T = Data>(config: VQuery) {
-        throw new Error("Not implemented");
-        return {} as T;
-    }
-
-    async find<T = Data>(config: VQuery) {
-        throw new Error("Not implemented");
-        return [] as T[];
-    }
-
-    async findOne<T = Data>(config: VQuery) {
-        throw new Error("Not implemented");
-        return {} as T;
-    }
-
-    async remove(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async removeCollection(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async removeOne(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async update(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async updateOne(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-
-    async updateOneOrAdd(config: VQuery) {
-        throw new Error("Not implemented");
-        return false;
-    }
-}
-
-export default ValtheraBase;

package/src/customFileCpu.ts

@@ -1,100 +0,0 @@
-import { Search, Updater } from "./types/arg";
-import Data from "./types/data";
-import FileCpu from "./types/fileCpu";
-import { FindOpts } from "./types/options";
-import { VContext } from "./types/types";
-import hasFieldsAdvanced from "./utils/hasFieldsAdvanced";
-import updateFindObject from "./utils/updateFindObject";
-
-export type WriteFile = (file: string, data: any[]) => Promise<void>
-export type ReadFile = (file: string) => Promise<any[]>
-
-
-export function pathRepair(path: string) {
-    return path.replaceAll("//", "/");
-}
-
-class CustomFileCpu implements FileCpu {
-    _readFile: ReadFile;
-    _writeFile: WriteFile;
-
-    constructor(readFile: ReadFile, writeFile: WriteFile) {
-        this._readFile = readFile;
-        this._writeFile = writeFile;
-    }
-
-    async add(file: string, data: Data): Promise<void> {
-        file = pathRepair(file);
-        let entries = await this._readFile(file);
-        entries.push(data);
-        await this._writeFile(file, entries);
-    }
-
-    async find(file: string, arg: Search, context: VContext = {}, findOpts: FindOpts = {}): Promise<any[] | false> {
-        file = pathRepair(file);
-        const entries = await this._readFile(file);
-        const results = entries.filter(entry =>
-            typeof arg === "function" ? arg(entry, context) : hasFieldsAdvanced(entry, arg)
-        );
-        return results.length ? results.map(res => updateFindObject(res, findOpts)) : [];
-    }
-
-    async findOne(file: string, arg: Search, context: VContext = {}, findOpts: FindOpts = {}): Promise<any | false> {
-        file = pathRepair(file);
-        const entries = await this._readFile(file);
-        const result = entries.find(entry =>
-            typeof arg === "function" ? arg(entry, context) : hasFieldsAdvanced(entry, arg)
-        );
-        return result ? updateFindObject(result, findOpts) : false;
-    }
-
-    async remove(file: string, one: boolean, arg: Search, context: VContext = {}): Promise<boolean> {
-        file = pathRepair(file);
-        let entries = await this._readFile(file);
-        let removed = false;
-
-        entries = entries.filter(entry => {
-            if (removed && one) return true;
-
-            let match = typeof arg === "function" ? arg(entry, context) : hasFieldsAdvanced(entry, arg);
-
-            if (match) {
-                removed = true;
-                return false;
-            }
-
-            return true;
-        });
-
-        if (!removed) return false;
-
-        await this._writeFile(file, entries);
-        return true;
-    }
-
-    async update(file: string, one: boolean, arg: Search, updater: Updater, context: VContext = {}): Promise<boolean> {
-        file = pathRepair(file);
-        let entries = await this._readFile(file);
-        let updated = false;
-
-        entries = entries.map(entry => {
-            if (updated && one) return entry;
-
-            let match = typeof arg === "function" ? arg(entry, context) : hasFieldsAdvanced(entry, arg);
-
-            if (match) {
-                updated = true;
-                return typeof updater === "function" ? updater(entry, context) : { ...entry, ...updater };
-            }
-
-            return entry;
-        });
-
-        if (!updated) return false;
-
-        await this._writeFile(file, entries);
-        return true;
-    }
-}
-
-export default CustomFileCpu;

package/src/db/memory.ts

@@ -1,177 +0,0 @@
-
-import ValtheraClass from "./valthera";
-import CustomFileCpu from "../customFileCpu";
-import genId from "../helpers/gen";
-import dbActionBase from "../base/actions";
-import Data from "../types/data";
-import FileCpu from "../types/fileCpu";
-import { DbOpts } from "../types/options";
-import { VQuery } from "../types/query";
-import { compareSafe } from "../utils/sort";
-
-export class MemoryAction extends dbActionBase {
-    folder: string;
-    options: DbOpts;
-    fileCpu: FileCpu;
-    memory: Map<string, any[]>;
-
-    /**
-     * Creates a new instance of dbActionC.
-     * @constructor
-     * @param folder - The folder where database files are stored.
-     * @param options - The options object.
-     */
-    constructor() {
-        super();
-        this.memory = new Map();
-        this.fileCpu = new CustomFileCpu(this._readMemory.bind(this), this._writeMemory.bind(this));
-    }
-
-    _readMemory(key: string) {
-        if (!this.memory.has(key)) return [];
-        return this.memory.get(key);
-    }
-
-    _writeMemory(key: string, data: any[]) {
-        this.memory.set(key, data);
-    }
-
-    _getCollectionPath(collection: string) {
-        return this.folder + "/" + collection + "/";
-    }
-
-    /**
-     * Get a list of available databases in the specified folder.
-     */
-    async getCollections() {
-        const collections = Array.from(this.memory.keys());
-        return collections;
-    }
-
-    /**
-     * Check and create the specified collection if it doesn't exist.
-     */
-    async checkCollection({ collection }: VQuery) {
-        if (this.issetCollection(collection)) return;
-        this.memory.set(collection, []);
-        return true;
-    }
-    /**
-     * Check if a collection exists.
-     */
-    async issetCollection({ collection }: VQuery) {
-        return this.memory.has(collection);
-    }
-
-    /**
-     * Add a new entry to the specified database.
-     */
-    async add({ collection, data, id_gen = true }: VQuery) {
-        await this.checkCollection(arguments[0]);
-
-        if (id_gen) data._id = data._id || genId();
-        await this.fileCpu.add(collection, data);
-        return data;
-    }
-
-    /**
-     * Find entries in the specified database based on search criteria.
-     */
-    async find({ collection, search, context = {}, dbFindOpts = {}, findOpts = {} }: VQuery) {
-        const {
-            reverse = false,
-            max = -1,
-            offset = 0,
-            sortBy,
-            sortAsc = true
-        } = dbFindOpts;
-
-        await this.checkCollection(arguments[0]);
-
-        let data = await this.fileCpu.find(collection, search, context, findOpts) as Data[];
-
-        if (reverse) data.reverse();
-
-        if (sortBy) {
-            const dir = sortAsc ? 1 : -1;
-            data.sort((a, b) => compareSafe(a[sortBy], b[sortBy]) * dir);
-        }
-
-        if (offset > 0) {
-            if (data.length <= offset) return [];
-            data = data.slice(offset);
-        }
-
-        if (max !== -1 && data.length > max) {
-            data = data.slice(0, max);
-        }
-
-        return data;
-    }
-
-    /**
-     * Find the first matching entry in the specified database based on search criteria.
-     */
-    async findOne({ collection, search, context = {}, findOpts = {} }: VQuery) {
-        await this.checkCollection(arguments[0]);
-        let data = await this.fileCpu.findOne(collection, search, context, findOpts) as Data;
-        return data || null;
-    }
-
-    /**
-     * Update entries in the specified database based on search criteria and an updater function or object.
-     */
-    async update({ collection, search, updater, context = {} }: VQuery) {
-        await this.checkCollection(arguments[0]);
-        return await this.fileCpu.update(collection, false, search, updater, context);
-    }
-
-    /**
-     * Update the first matching entry in the specified database based on search criteria and an updater function or object.
-     */
-    async updateOne({ collection, search, updater, context = {} }: VQuery) {
-        await this.checkCollection(arguments[0]);
-        return await this.fileCpu.update(collection, true, search, updater, context);
-    }
-
-    /**
-     * Remove entries from the specified database based on search criteria.
-     */
-    async remove({ collection, search, context = {} }: VQuery) {
-        await this.checkCollection(arguments[0]);
-        return await this.fileCpu.remove(collection, false, search, context);
-    }
-
-    /**
-     * Remove the first matching entry from the specified database based on search criteria.
-     */
-    async removeOne({ collection, search, context = {} }: VQuery) {
-        await this.checkCollection(arguments[0]);
-        return await this.fileCpu.remove(collection, true, search, context);
-    }
-
-    /**
-     * Removes a database collection from the file system.
-     */
-    async removeCollection({ collection }: VQuery) {
-        this.memory.delete(collection);
-        return true;
-    }
-}
-
-export default class ValtheraMemory extends ValtheraClass {
-    constructor(...args: any[]) {
-        super({ dbAction: new MemoryAction() });
-    }
-}
-
-export function createMemoryValthera<T = { [key: string]: Data[] }>(data?: T) {
-    const db = new ValtheraMemory();
-    if (!data) return db;
-
-    for (const collection of Object.keys(data)) {
-        (db.dbAction as MemoryAction).memory.set(collection, data[collection]);
-    }
-
-    return db;
-}