verse.db - npm Package Compare versions

Comparing version 0.0.2 to 0.1.0

package.json

 {
   "name": "verse.db",
-  "version": "0.0.2",
-  "description": "Database coming soon",
+  "version": "0.1.0",
+  "description": "verse.db isn't just a database, it's your universal data bridge. Designed for unmatched flexibility, security, and performance, verse.db empowers you to manage your data with ease.",
   "license": "MIT",
-  "author": "marco5dev",
-  "main": "./README.md",
+  "author": "marco5dev (Mark Maher)",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "bugs": {
@@ -17,6 +19,9 @@ "url": "https://github.com/Marco5dev/verse.db/issues"
   "files": [
+    "dist",
     ".gitignore",
+    "CHANGELOG.md",
+    "SECURITY.md",
     "LICENSE",
-    "README.md",
-    "SECURITY.md"
+    "package.json",
+    "README.md"
   ],
@@ -31,6 +36,8 @@ "scripts": {
     "@types/node": "^20.11.25",
+    "@types/wellknown": "^0.5.8",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.2",
     "tsup": "^8.0.2",
-    "typescript": "^5.4.2"
+    "typescript": "^5.4.2",
+    "ts-node": "^10.9.2"
   },
@@ -41,3 +48,285 @@ "dependencies": {
     "yaml": "^2.4.1"
-  }
+  },
+  "keywords": [
+    "database",
+    "dbms",
+    "relational database",
+    "non-relational database",
+    "sql",
+    "nosql",
+    "data schema",
+    "data model",
+    "data type",
+    "primary key",
+    "foreign key",
+    "index",
+    "transactions",
+    "concurrency control",
+    "data integrity",
+    "query optimization",
+    "database performance",
+    "data replication",
+    "database security",
+    "cloud database",
+    "database clustering",
+    "database backup",
+    "database cluster",
+    "database sharding",
+    "database partitioning",
+    "database federation",
+    "cross-database operations",
+    "multi-database management",
+    "distributed database",
+    "data consistency",
+    "data synchronization",
+    "database high availability",
+    "database failover",
+    "database replication",
+    "database connection pool",
+    "multi-database environment",
+    "multi-database architecture",
+    "cross-database query",
+    "multi-tenant database",
+    "database virtualization",
+    "database resource management",
+    "database resource allocation",
+    "data definition language",
+    "data manipulation language",
+    "data control language",
+    "query optimizer",
+    "trigger",
+    "stored procedure",
+    "view",
+    "indexing",
+    "aggregation",
+    "data normalization",
+    "entity-relationship model",
+    "data warehouse",
+    "online analytical processing",
+    "online transaction processing",
+    "database schema design",
+    "database indexing",
+    "database normalization",
+    "database denormalization",
+    "database optimization",
+    "database query tuning",
+    "database partitioning",
+    "database sharding",
+    "database clustering",
+    "database virtualization",
+    "database cluster management",
+    "database backup and restore",
+    "database disaster recovery",
+    "database replication technologies",
+    "database security architectures",
+    "database encryption",
+    "database access control",
+    "database authentication",
+    "database authorization",
+    "database auditing and monitoring",
+    "multiple databases",
+    "postgresql",
+    "mysql",
+    "database management",
+    "database administrator",
+    "database software",
+    "database systems",
+    "database operations",
+    "json",
+    "sqlite",
+    "oracle",
+    "db2",
+    "sql server",
+    "database design",
+    "database performance optimization",
+    "database maintenance",
+    "database tuning",
+    "database query performance",
+    "database backup strategies",
+    "database recovery",
+    "database clustering solutions",
+    "database security practices",
+    "database encryption techniques",
+    "database access control methods",
+    "database auditing tools",
+    "database monitoring tools",
+    "multi-database management solutions",
+    "database partitioning techniques",
+    "database sharding strategies",
+    "database virtualization solutions",
+    "database cluster management solutions",
+    "database performance optimization techniques",
+    "database query optimization techniques",
+    "database backup and recovery strategies",
+    "database replication strategies",
+    "database security architectures and practices",
+    "database management system best practices",
+    "database resource management techniques",
+    "database resource allocation methods",
+    "database administrator tools",
+    "database software development",
+    "database design patterns",
+    "database-as-a-service",
+    "database migration",
+    "database integration",
+    "database connectors",
+    "database drivers",
+    "database client libraries",
+    "database ORM",
+    "database utilities",
+    "database tools",
+    "database reverse engineering",
+    "database documentation",
+    "database testing",
+    "database development",
+    "database deployment",
+    "database configuration",
+    "database documentation generation",
+    "database testing frameworks",
+    "database deployment tools",
+    "database configuration management",
+    "database performance benchmarks",
+    "database software comparisons",
+    "database standards",
+    "database management system standards",
+    "database management system interoperability",
+    "database management system architecture",
+    "database management system features",
+    "database management system scalability",
+    "database management system reliability",
+    "database management system security",
+    "database management system performance",
+    "database management system availability",
+    "database management system flexibility",
+    "database management system efficiency",
+    "database management system recoverability",
+    "database management system maintainability",
+    "database management system usability",
+    "database management system functionality",
+    "database management system versatility",
+    "database management system extensibility",
+    "database management system compatibility",
+    "database management system integratability",
+    "database management system portability",
+    "databasemanagement system manageability",
+    "database management system customizability",
+    "database management system cost-effectiveness",
+    "database management system innovation",
+    "database management system research",
+    "database management system trends",
+    "database management system market",
+    "database management system vendors",
+    "database management system open-source",
+    "database management system proprietary",
+    "database management system software",
+    "database management system hardware",
+    "database management system appliances",
+    "database management system cloud",
+    "database management system saas",
+    "database management system paas",
+    "database management system iaas",
+    "database management system virtualization",
+    "database management system containers",
+    "database management system microservices",
+    "database management system serverless",
+    "database management system distributed systems",
+    "database management system peer-to-peer",
+    "database management system grid",
+    "database management system cluster",
+    "database management system hierarchical",
+    "database management system network",
+    "database management system relational",
+    "database management system object-oriented",
+    "database management system document-oriented",
+    "database management system graph",
+    "database management system column-oriented",
+    "database management system key-value",
+    "database management system temporal",
+    "database management system spatial",
+    "database management system text",
+    "database management system XML",
+    "database management system JSON",
+    "database management system BSON",
+    "database management system AVRO",
+    "database management system Protocol Buffers",
+    "database management system Thrift",
+    "database management system MessagePack",
+    "database management system CSV",
+    "database management system TSV",
+    "database management system Excel",
+    "database management system Access",
+    "database management system SQLite",
+    "database management system MySQL",
+    "database management system PostgreSQL",
+    "database management system Oracle",
+    "database management system SQL Server",
+    "database management system DB2",
+    "database management system Sybase",
+    "database management system Informix",
+    "database management system Teradata",
+    "database management system Greenplum",
+    "database management system Aster Data",
+    "database management system Vertica",
+    "database management system Hadoop",
+    "database management system HBase",
+    "database management system Cassandra",
+    "database management system MongoDB",
+    "database management system Couchbase",
+    "database management system Riak",
+    "database management system OrientDB",
+    "database management system ArangoDB",
+    "database management system MarkLogic",
+    "database management system Neo4j",
+    "database management system FlockDB",
+    "database management system HyperGraphDB",
+    "database management system InfiniteGraph",
+    "database management system Objectivity/DB",
+    "database management system GemFire",
+    "database management system eXtremeDB",
+    "database management system TimesTen",
+    "database management system VoltDB",
+    "database management system H2",
+    "database management system Derby",
+    "database management system SQLite",
+    "database management system Firebird",
+    "database management system InterBase",
+    "database management system Ingres",
+    "database management system PostgreSQL",
+    "database management system Redis",
+    "database management system Memcached",
+    "database management system Hazelcast",
+    "database management system Tarantool",
+    "database management system Aerospike",
+    "database management system RiakTS",
+    "database management system ScyllaDB",
+    "database management system Amazon DynamoDB",
+    "database management system Google Cloud Spanner",
+    "database management system Microsoft Azure Cosmos DB",
+    "database management system IBM Db2",
+    "database management system SAP HANA",
+    "database management system SAP IQ",
+    "database management system Oracle NoSQL",
+    "database management system Apache Cassandra",
+    "database management system Apache HBase",
+    "database management system Apache Accumulo",
+    "database management system Apache Flink",
+    "database management system Apache Beam",
+    "database management system Apache Storm",
+    "database management system Apache Spark",
+    "database management system Apache Kafka",
+    "database management system Apache NiFi",
+    "database management system Apache Flume",
+    "database management system Apache Trafodion",
+    "database management system Apache Ignite",
+    "database management system Apache Geode",
+    "database management system Apache Druid",
+    "database management system Apache Pinot",
+    "database management system Apache Drill",
+    "database management system Apache Kylin",
+    "database management system Apache Superset",
+    "database management system Apache Atlas",
+    "database management system Apache Ranger",
+    "database management system Apache Knox",
+    "database management system Apache Metron"
+  ]
 }

README.md

@@ -1,4 +0,170 @@
-# coming so soon wait us on
+# verse.db
 
-`#` - GITHUB: https://github.com/marco5dev/verse.db
-`#` - DOCS: https://versedb.jedi-studios.com
+verse.db isn't just a database, it's your universal data bridge. Designed for unmatched flexibility, security, and performance, verse.db empowers you to manage your data with ease.
+
+[![Periodic testing of the Verse.db](https://github.com/Marco5dev/verse.db/actions/workflows/code-test.yml/badge.svg)](https://github.com/Marco5dev/verse.db/actions/workflows/code-test.yml)
+[![Build](https://github.com/Marco5dev/verse.db/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/Marco5dev/verse.db/actions/workflows/npm-publish.yml)
+[![NPM Version](https://img.shields.io/npm/v/verse.db.svg)](https://www.npmjs.com/package/verse.db)
+[![NPM Downloads](https://img.shields.io/npm/dt/verse.db.svg)](https://www.npmjs.com/package/verse.db)
+[![Github Repo Size](https://img.shields.io/github/repo-size/Marco5dev/verse.db.svg)](https://github.com/Marco5dev/verse.db)
+[![LICENSE](https://img.shields.io/npm/l/verse.db.svg)](https://github.com/Marco5dev/verse.db/blob/master/LICENSE)
+[![Contributors](https://img.shields.io/github/contributors/Marco5dev/verse.db.svg)](https://github.com/Marco5dev/verse.db/graphs/contributors)
+[![Commit](https://img.shields.io/github/last-commit/Marco5dev/verse.db.svg)](https://github.com/Marco5dev/verse.db/commits/master)
+
+## Introduction
+
+The verse.db package is a powerful utility designed to simplify the management of data files within a designated folder. It offers methods for adding, editing, deleting, and retrieving data from JSON, YAML, SQL & more files. This wiki provides detailed examples and usage scenarios to help you effectively implement the verse.db package in your projects.
+
+## Installation
+
+To begin using the verse.db package, you'll need to install it via npm. Open your terminal and run the following command:
+
+```bash
+npm install verse.db
+yarn add verse.db
+```
+
+## Usage
+
+### Import and Initialization
+
+to get started setup the database connection uding .connect method
+
+```javascript
+const versedb = require("verse.db");
+// or
+import versedb from "verse.db";
+
+const adapterOptions = {
+  adapter: "json" | "yaml" | "sql", // the type of the adapter json, yaml or sql
+  dataPath: "./Data", // the path of the data folder
+  devLogs: { enable: true, path: "./Logs" }, // the path to the logs folder
+  encryption: { enable: false, secret: "" }, // Under Development: Encryption option
+  backup: { enable: false, path: "", retention: 0 }, // Under Development: Backing up
+};
+
+const db = new versedb.connect(adapterOptions); // use the connect method to connect a database
+```
+
+Note\*: that you can make a multiple databases in the same time with/without the same extention
+
+### Load a data file
+
+You can load any data file using .load method
+
+```javascript
+const dataname = "data"; // the name of the datafile without the extention
+const result = await db.load(dataname);
+
+console.log(result);
+```
+
+### Add Data
+
+To add data, use the .add method, for example:
+
+```javascript
+// Arrange
+const data = [
+  { _id: "1234", name: "John" },
+  { _id: "5678", name: "Jane" },
+];
+const dataname = "dataFileName";
+
+// Act
+const result = await db.add(dataname, data);
+```
+
+result:
+
+```json
+{
+  "acknowledged": true,
+  "message": "Data added successfully.",
+  "results": [
+    { "_id": "1234", "name": "John" },
+    { "_id": "5678", "name": "Jane" }
+  ]
+}
+```
+
+### find data
+
+Find the data you want with the query you want using .find method:
+
+```javascript
+// Arrange
+const data = [
+  { _id: "1234", name: "John" },
+  { _id: "5678", name: "Jane" },
+];
+const query = { name: "John" };
+const dataname = "dataFileName";
+
+// Act
+const result = await db.find(dataname, query);
+
+// Assert
+expect(result).toEqual({
+  acknowledged: true,
+  message: "Found data matching your query.",
+  results: { _id: "1234", name: "John" },
+});
+```
+
+### Remove data
+
+Remove the data you want with the query you want using .remove method:
+
+```javascript
+// Arrange
+const data = [
+  { _id: "1234", name: "John" },
+  { _id: "5678", name: "Jane" },
+];
+const query = { _id: "1234" };
+const dataname = "remove";
+
+// Act
+const result = await db.remove(dataname, query);
+
+// Assert
+expect(result).toEqual({
+  acknowledged: true,
+  message: "1 document(s) removed successfully.",
+  results: null,
+});
+```
+
+### Update
+
+Update the data you want with the query you want using .update method:
+
+```javascript
+// Arrange
+const data = [
+  { _id: "1234", name: "John" },
+  { _id: "5678", name: "Jane" },
+];
+const updateQuery = { $set: { name: "Mike" } };
+const dataname = "update";
+
+// Act
+const result = await db.update(dataname, { name: "John" }, updateQuery);
+
+// Assert
+expect(result).toEqual({
+  acknowledged: true,
+  message: "1 document(s) updated successfully.",
+  results: {
+    _id: "1234",
+    name: "Mike",
+  },
+});
+```
+
+###
+
+## Conclusion
+
+The verse.db package simplifies the management of JSON data files within a specified folder. With the provided examples and usage instructions, you'll be able to efficiently integrate the verse.db package into your projects to streamline data operations.

SECURITY.md

@@ -25,3 +25,3 @@ # Security Policy
 ```bash
-npm update jsonverse
+npm update verse.db
 ```
@@ -28,0 +28,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22087

increased by552.5%

Number of package files

6

increased by20%

Number of lines in readme file

171

increased by4175%

Worsened metrics

Dev dependency count

9

increased by28.57%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes