sorla-db 1.0.0 → 1.2.0

package/index.d.ts

@@ -0,0 +1,89 @@
+// Type declarations for sorla-db
+
+export type Document = Record<string, unknown> & { _id?: unknown };
+
+export type ComparisonOperators = {
+    $eq?: unknown;
+    $ne?: unknown;
+    $gt?: unknown;
+    $gte?: unknown;
+    $lt?: unknown;
+    $lte?: unknown;
+    $in?: unknown[];
+    $nin?: unknown[];
+    $not?: ComparisonOperators;
+};
+
+/** A query: field conditions (value or operators, "a.b" paths allowed) and nested $and / $or / $nor. */
+export type Query = {
+    $and?: Query[];
+    $or?: Query[];
+    $nor?: Query[];
+    [field: string]: unknown;
+};
+
+export type Projection = Record<string, 0>;
+export type SortSpec = Record<string, 1 | -1>;
+
+export interface SortOptions {
+    /** Intl.Collator options plus the locale, e.g. { locale: 'pt-BR', sensitivity: 'base', numeric: true } */
+    collation?: Intl.CollatorOptions & { locale?: string };
+}
+
+export interface StoredDocument {
+    readonly _data: Document;
+    readonly [field: string]: unknown;
+}
+
+export declare class Cursor {
+    readonly length: number;
+    currIndex: number;
+    hasNext(): boolean;
+    next(): StoredDocument;
+    reset(): void;
+    /** Data of the first document, null when empty. */
+    first(): Document | null;
+    /** Data of the last document, null when empty. */
+    last(): Document | null;
+    /** Plain copies of the documents. */
+    toArray(): Document[];
+    sort(spec: SortSpec, options?: SortOptions): this;
+    projection(projection: Projection): void;
+    push(element: object): void;
+}
+
+export declare class Collection {
+    readonly first: Document;
+    readonly last: Document;
+    readonly all: StoredDocument[];
+    count(): number;
+    /** Inserts a copy of the document and returns its _id. */
+    insertOne(document: Document, callback?: (id: unknown) => void): unknown;
+    /** Validates every document first, then inserts them and returns their ids. */
+    insertMany(documents: Document[], callback?: (ids: unknown[]) => void): unknown[];
+    find(query: Query, projection?: Projection | null): Cursor;
+    /** Data of the first matching document, null when nothing matches. */
+    findOne(query: Query, projection?: Projection | null): Document | null;
+}
+
+export declare class Database {
+    readonly name: string;
+    createCollection(name: string, validationSchema?: unknown): void;
+    countCollections(): number;
+    [collection: string]: unknown;
+}
+
+declare class sorla {
+    constructor();
+    /** The selected database. Collections are properties of it: sorla.db.people */
+    readonly db: Database & Record<string, Collection>;
+    dbExists(name: string): boolean;
+    /** Position of the new database, or false when the name exists. */
+    createDb(name: string): number | false;
+    /** Selects a database, creating it when needed. */
+    useDb(name: string): void;
+    countDb(): number;
+}
+
+export { sorla };
+export default sorla;

package/index.mjs

@@ -0,0 +1,5 @@
+// ES module entry: import sorla from 'sorla-db'
+import sorla from './src/sorla.js';
+
+export { sorla };
+export default sorla;

package/package.json

@@ -1,42 +1,66 @@
-{
-  "name": "sorla-db",
-  "version": "1.0.0",
-  "description": "A simple and temporary database focused to use in browser environment that will bring capabilities for other tools that will be launched as soon as possible.",
-  "main": "dist/sorla.min.js",
-  "scripts": {
-    "mini": "node index.js",
-    "build": "webpack",
-    "test": "jest"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sysborg/sorla-db.git"
-  },
-  "keywords": [
-    "nosql",
-    "browser",
-    "database",
-    "sorla",
-    "sysborg",
-    "anderson",
-    "arruda",
-    "andmarruda"
-  ],
-  "author": "Anderson Arruda < andmarruda@gmail.com >",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/sysborg/sorla-db/issues"
-  },
-  "homepage": "https://github.com/sysborg/sorla-db#readme",
-  "devDependencies": {
-    "browserify": "^17.0.0",
-    "chai": "^4.3.8",
-    "faker": "^5.5.3",
-    "fs-extra": "^11.2.0",
-    "jest": "^29.6.4",
-    "jsdom": "^22.1.0",
-    "jsdom-global": "^3.0.2",
-    "mocha": "^10.2.0",
-    "terser": "^5.27.0"
-  }
-}
+{
+  "name": "sorla-db",
+  "version": "1.2.0",
+  "description": "A simple and temporary database focused to use in browser environment that will bring capabilities for other tools that will be launched as soon as possible.",
+  "main": "src/sorla.js",
+  "module": "index.mjs",
+  "types": "index.d.ts",
+  "unpkg": "dist/sorla.min.js",
+  "jsdelivr": "dist/sorla.min.js",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.mjs",
+      "require": "./src/sorla.js"
+    },
+    "./dist/sorla.min.js": "./dist/sorla.min.js",
+    "./src/*": "./src/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "!src/helper.js",
+    "dist",
+    "index.mjs",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "build": "node index.js",
+    "mini": "node index.js",
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sysborg/sorla-db.git"
+  },
+  "keywords": [
+    "nosql",
+    "browser",
+    "database",
+    "sorla",
+    "sysborg",
+    "anderson",
+    "arruda",
+    "andmarruda"
+  ],
+  "author": "Anderson Arruda < andmarruda@gmail.com >",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sysborg/sorla-db/issues"
+  },
+  "homepage": "https://github.com/sysborg/sorla-db#readme",
+  "devDependencies": {
+    "browserify": "^17.0.0",
+    "chai": "^4.3.8",
+    "faker": "^5.5.3",
+    "fs-extra": "^11.2.0",
+    "jest": "^29.6.4",
+    "jsdom": "^22.1.0",
+    "jsdom-global": "^3.0.2",
+    "mocha": "^10.2.0",
+    "terser": "^5.27.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/collections/collection.js

@@ -1,47 +1,47 @@
-const query = require('../query_language/query.js');
-
-class collection extends query
-{
-    /**
-     * Constructs class Collection to manage documents
-     * @author Anderson Arruda < anderson@sysborg.com.br >
-     * @version 1.0.0
-     * @param object validationSchema - in construction
-     * @return void
-    **/
-    constructor(validationSchema)
-    {
-        super(validationSchema);
-        this._documents = [];
-        this._indexes = [];
-    }
-
-    /**
-     * Returns the first document of the collection
-     * @return object
-     */
-    get first()
-    {
-        return structuredClone(this._documents[0]._data);
-    }
-
-    /**
-     * Returns the last document of the collection
-     * @return object
-     */
-    get last()
-    {
-        return structuredClone(this._documents[this._documents.length - 1]._data);
-    }
-
-    /**
-     * Return all the documents of the collection
-     * @return array
-     */
-    get all()
-    {
-        return this._documents;
-    }
-}
-
+const query = require('../query_language/query.js');
+
+class collection extends query
+{
+    /**
+     * Constructs class Collection to manage documents
+     * @author Anderson Arruda < anderson@sysborg.com.br >
+     * @version 1.0.0
+     * @param object validationSchema - in construction
+     * @return void
+    **/
+    constructor(validationSchema)
+    {
+        super(validationSchema);
+        this._documents = [];
+        this._indexes = [];
+    }
+
+    /**
+     * Returns the first document of the collection
+     * @return object
+     */
+    get first()
+    {
+        return structuredClone(this._documents[0]._data);
+    }
+
+    /**
+     * Returns the last document of the collection
+     * @return object
+     */
+    get last()
+    {
+        return structuredClone(this._documents[this._documents.length - 1]._data);
+    }
+
+    /**
+     * Return all the documents of the collection
+     * @return array
+     */
+    get all()
+    {
+        return this._documents;
+    }
+}
+
 module.exports =  collection;

package/src/dbs/database.js

@@ -1,72 +1,72 @@
-const collection = require('../collections/collection.js');
-
-class database
-{
-    /**
-     * Constructs class Database to manage collections
-     * @author Anderson Arruda < anderson@sysborg.com.br >
-     * @version 1.0.0
-     * @param  string name
-     * @return void
-    **/
-    constructor(name)
-    {
-        this._collections = {};
-        this._name = name;
-        this._collectionCount = 0;
-
-        return new Proxy(this, {
-            get: (target, prop, receiver) => {
-                if(prop in target._collections)
-                {
-                    return target._collections[prop];
-                }
-
-                return target[prop];
-            }
-        });
-    }
-
-    /**
-     * Returns the database name
-     * @author Anderson Arruda < anderson@sysborg.com.br >
-     * @version 1.0.0
-     * @param 
-     * @return string
-    **/
-    get name()
-    {
-        return this._name;
-    }
-
-    /**
-     * Sets a new collection in the database
-     * @param string name
-     * @param object validationSchema - in construction
-     * @return void
-     */
-    createCollection(name, validationSchema)
-    {
-        if(this._collections.hasOwnProperty(name) || typeof this[name] !== 'undefined')
-        {
-            throw new Error('Collection already exists');
-        }
-
-        this._collections[name] = new collection(validationSchema);
-        this._collectionCount++;
-
-        //creates _id as a index unique
-    }
-
-    /**
-     * Returns the number of collections in the database
-     * @param
-     * @return int
-     */
-    countCollections()
-    {
-        return this._collectionCount;
-    }
-}
-
+const collection = require('../collections/collection.js');
+
+class database
+{
+    /**
+     * Constructs class Database to manage collections
+     * @author Anderson Arruda < anderson@sysborg.com.br >
+     * @version 1.0.0
+     * @param  string name
+     * @return void
+    **/
+    constructor(name)
+    {
+        this._collections = {};
+        this._name = name;
+        this._collectionCount = 0;
+
+        return new Proxy(this, {
+            get: (target, prop, receiver) => {
+                if(prop in target._collections)
+                {
+                    return target._collections[prop];
+                }
+
+                return target[prop];
+            }
+        });
+    }
+
+    /**
+     * Returns the database name
+     * @author Anderson Arruda < anderson@sysborg.com.br >
+     * @version 1.0.0
+     * @param 
+     * @return string
+    **/
+    get name()
+    {
+        return this._name;
+    }
+
+    /**
+     * Sets a new collection in the database
+     * @param string name
+     * @param object validationSchema - in construction
+     * @return void
+     */
+    createCollection(name, validationSchema)
+    {
+        if(this._collections.hasOwnProperty(name) || typeof this[name] !== 'undefined')
+        {
+            throw new Error('Collection already exists');
+        }
+
+        this._collections[name] = new collection(validationSchema);
+        this._collectionCount++;
+
+        //creates _id as a index unique
+    }
+
+    /**
+     * Returns the number of collections in the database
+     * @param
+     * @return int
+     */
+    countCollections()
+    {
+        return this._collectionCount;
+    }
+}
+
 module.exports = database;