grafio-mongo 1.0.1 → 1.2.0

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to grafio-mongo
+
+Thank you for your interest in contributing to grafio-mongo! This document provides guidelines and instructions for contributing to the MongoDB storage backend for [grafio](https://github.com/witspry/grafio).
+
+## Contributor License Agreement (CLA)
+
+By submitting contributions to grafio, you grant **Satya Jugran** (the project owner) a perpetual, irrevocable, worldwide, non-exclusive, royalty-free license to use, reproduce, modify, distribute, and display your contributions for any purpose, including commercial use, under the terms of the GNU General Public License v3.0 (GPL-3.0).
+
+As the copyright owner and project maintainer, I retain full commercial rights to all code in this repository. Contributors acknowledge that their contributions will be licensed under GPL-3.0 and agree that such licensing benefits the project while preserving my rights as the copyright holder.
+
+This CLA ensures that contributions are submitted under GPL-3.0 licensing terms and grants me explicit rights to use contributed code in commercial projects without requiring additional approval from contributors.
+
+## Getting Started
+
+1. **Fork the repository** on GitHub
+2. **Clone your fork** locally:
+   ```bash
+   git clone https://github.com/satya-jugran/grafio-mongo.git
+   cd grafio-mongo
+   ```
+3. **Install dependencies**:
+   ```bash
+   npm install
+   ```
+
+## Development Workflow
+
+### Prerequisites
+
+- Node.js >= 18
+- npm >= 9
+
+### Building
+
+```bash
+npm run build
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Run tests with coverage
+npm run test:coverage
+
+# Run performance benchmarks
+npm run perf
+```
+
+### Code Style
+
+- Use TypeScript for all new code
+- Follow the existing code style (2-space indentation)
+- Run `npm run build` before committing to ensure TypeScript compiles without errors
+
+## Project Structure
+
+```
+grafio-mongo/
+├── src/                        # Source code
+│   ├── index.ts                # Main exports
+│   ├── MongoGraphFactory.ts    # Factory for creating Graph instances with MongoDB backend
+│   └── MongoStorageProvider.ts # MongoDB storage provider implementing IStorageProvider
+├── tests/                      # Test files
+│   ├── graph/                  # Graph operation tests with MongoDB backend
+│   ├── storage/                # Storage provider tests
+│   ├── perf/                   # Performance benchmarks
+│   └── *.test.ts               # Integration tests
+├── CHANGELOG.md                # Version history
+└── CODE_OF_CONDUCT.md          # Community guidelines
+```
+
+## Making Changes
+
+1. **Create a branch** for your changes:
+   ```bash
+   git checkout -b feature/your-feature-name
+   # or
+   git checkout -b fix/your-bug-fix
+   ```
+
+2. **Make your changes** following the code style guidelines
+
+3. **Add tests** for new functionality (see [`tests/`](tests/))
+
+4. **Ensure all tests pass**:
+   ```bash
+   npm test
+   ```
+
+5. **Commit your changes** with a clear message:
+   ```bash
+   git commit -m "feat: add new feature description"
+   ```
+
+## Commit Message Format
+
+Use conventional commit format:
+- `feat:` for new features
+- `fix:` for bug fixes
+- `docs:` for documentation changes
+- `test:` for test additions/changes
+- `refactor:` for code refactoring
+- `perf:` for performance improvements
+
+## Pull Request Process
+
+1. Update documentation if needed
+2. Add tests for any new functionality
+3. Ensure all tests pass
+4. Update the [CHANGELOG.md](CHANGELOG.md) if applicable
+5. Submit a pull request with a clear description of the changes
+
+## Code of Conduct
+
+Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) before contributing to help keep our community welcoming and inclusive.
+
+## Questions?
+
+Feel free to open an issue on GitHub for questions about contributing.

package/README.md

@@ -157,7 +157,7 @@ try {
 
 ## Graph Operations
 
-All graph operations from grafio are available when using MongoDB storage. See the [grafio documentation](https://github.com/witspry/grafio) for the complete API reference.
+All graph operations from grafio are available when using MongoDB storage. See the [grafio documentation](https://github.com/satyajugran/grafio) for the complete API reference.
 
 ### Example Operations
 

package/dist/MongoGraphFactory.d.ts

@@ -9,5 +9,6 @@ export declare class MongoGraphFactory implements IGraphFactory {
     ensureIndexes(): Promise<void>;
     forGraph(graphId?: string): Graph;
     fromGraphData(data: GraphData, graphId?: string): Promise<Graph>;
+    private _wrapWithCacheIfEnabled;
 }
 export {};

package/dist/MongoGraphFactory.js

@@ -15,19 +15,36 @@ class MongoGraphFactory {
         await probe.ensureIndexes();
     }
     forGraph(graphId = 'default') {
-        const provider = new MongoStorageProvider_1.MongoStorageProvider(this._db, { ...this._opts, graphId });
+        const mongoProvider = new MongoStorageProvider_1.MongoStorageProvider(this._db, { ...this._opts, graphId });
+        const provider = this._wrapWithCacheIfEnabled(mongoProvider, graphId);
         return new grafio_1.Graph(provider);
     }
     async fromGraphData(data, graphId = 'default') {
-        const provider = new MongoStorageProvider_1.MongoStorageProvider(this._db, { ...this._opts, graphId });
-        const graph = new grafio_1.Graph(provider);
+        const mongoProvider = new MongoStorageProvider_1.MongoStorageProvider(this._db, { ...this._opts, graphId });
+        const provider = this._wrapWithCacheIfEnabled(mongoProvider, graphId);
         const filteredData = {
             graphId,
             nodes: data.graphId === undefined || data.graphId === graphId ? data.nodes : [],
             edges: data.graphId === undefined || data.graphId === graphId ? data.edges : [],
         };
+        const graph = new grafio_1.Graph(provider);
         await grafio_1.Graph.importJSON(filteredData, provider);
         return graph;
     }
+    _wrapWithCacheIfEnabled(mongoProvider, graphId) {
+        if (!grafio_1.GraphManager.isInitialized()) {
+            return mongoProvider;
+        }
+        const manager = grafio_1.GraphManager.getInstance();
+        const cacheManager = manager.getCacheManager();
+        if (!cacheManager) {
+            return mongoProvider;
+        }
+        const cacheConfig = manager.getConfig()?.cache;
+        if (!cacheConfig) {
+            return mongoProvider;
+        }
+        return new grafio_1.CachedStorageProvider(mongoProvider, graphId, cacheManager, cacheConfig);
+    }
 }
 exports.MongoGraphFactory = MongoGraphFactory;

package/dist/MongoStorageProvider.d.ts

@@ -1,5 +1,5 @@
 import type { Db } from 'mongodb';
-import { IStorageProvider, NodeData, ITransactionHandle, EdgeData, GraphData } from 'grafio';
+import { IStorageProvider, IOrderBy, NodeData, ITransactionHandle, EdgeData, GraphData } from 'grafio';
 export interface MongoStorageProviderOptions {
     graphId?: string;
     nodesCollection?: string;
@@ -19,15 +19,17 @@ export declare class MongoStorageProvider implements IStorageProvider {
     deleteNode(id: string, transaction?: ITransactionHandle): Promise<void>;
     hasNode(id: string, transaction?: ITransactionHandle): Promise<boolean>;
     getNode(id: string, transaction?: ITransactionHandle): Promise<NodeData | undefined>;
-    getAllNodes(limit?: number, transaction?: ITransactionHandle): Promise<NodeData[]>;
+    getAllNodes(limit?: number, orderBy?: IOrderBy, transaction?: ITransactionHandle): Promise<NodeData[]>;
     getNodesByType(type: string, transaction?: ITransactionHandle): Promise<NodeData[]>;
     getNodesByProperty(key: string, value: unknown, nodeType?: string, transaction?: ITransactionHandle): Promise<NodeData[]>;
+    getTotalNodeCount(transaction?: ITransactionHandle): Promise<number>;
     getEdgesByProperty(key: string, value: unknown, edgeType?: string, transaction?: ITransactionHandle): Promise<EdgeData[]>;
+    getTotalEdgeCount(transaction?: ITransactionHandle): Promise<number>;
     insertEdge(edge: EdgeData, transaction?: ITransactionHandle): Promise<void>;
     deleteEdge(id: string, transaction?: ITransactionHandle): Promise<void>;
     hasEdge(id: string, transaction?: ITransactionHandle): Promise<boolean>;
     getEdge(id: string, transaction?: ITransactionHandle): Promise<EdgeData | undefined>;
-    getAllEdges(transaction?: ITransactionHandle): Promise<EdgeData[]>;
+    getAllEdges(limit?: number, orderBy?: IOrderBy, transaction?: ITransactionHandle): Promise<EdgeData[]>;
     getEdgesByType(type: string, transaction?: ITransactionHandle): Promise<EdgeData[]>;
     getEdgesBySource(nodeId: string, type?: string, transaction?: ITransactionHandle): Promise<EdgeData[]>;
     getEdgesByTarget(nodeId: string, type?: string, transaction?: ITransactionHandle): Promise<EdgeData[]>;

package/dist/MongoStorageProvider.js

@@ -29,6 +29,8 @@ class MongoStorageProvider {
         await this._nodes.createIndex({ graphId: 1, type: 1 }, { name: 'node_graph_type' });
         await this._edges.createIndex({ graphId: 1, id: 1 }, { unique: true, name: 'edge_graph_id_unique' });
         await this._edges.createIndex({ graphId: 1, type: 1 }, { name: 'edge_graph_type' });
+        await this._edges.createIndex({ graphId: 1, sourceId: 1 }, { name: 'edge_graph_source' });
+        await this._edges.createIndex({ graphId: 1, targetId: 1 }, { name: 'edge_graph_target' });
         await this._edges.createIndex({ graphId: 1, sourceId: 1, type: 1 }, { name: 'edge_graph_source_type' });
         await this._edges.createIndex({ graphId: 1, targetId: 1, type: 1 }, { name: 'edge_graph_target_type' });
     }
@@ -39,12 +41,21 @@ class MongoStorageProvider {
         ]);
     }
     async insertNode(node, transaction) {
+        const now = Date.now();
+        if (node.createdOn === undefined) {
+            node.createdOn = now;
+        }
+        if (node.updatedOn === undefined) {
+            node.updatedOn = now;
+        }
         const session = transaction?.context;
         try {
             await this._nodes.insertOne({
                 id: node.id,
                 graphId: this._graphId,
                 type: node.type,
+                createdOn: node.createdOn,
+                updatedOn: node.updatedOn,
                 properties: node.properties,
             }, { session });
         }
@@ -68,10 +79,12 @@ class MongoStorageProvider {
         const doc = await this._nodes.findOne({ graphId: this._graphId, id }, { session });
         return doc ? this._docToNode(doc) : undefined;
     }
-    async getAllNodes(limit, transaction) {
+    async getAllNodes(limit, orderBy, transaction) {
         const session = transaction?.context;
         const nodes = [];
         const cursor = this._nodes.find({ graphId: this._graphId }, { session }).batchSize(this._batchSize);
+        if (orderBy)
+            cursor.sort(orderBy.field, orderBy.direction);
         if (limit)
             cursor.limit(limit);
         for await (const doc of cursor) {
@@ -96,6 +109,10 @@ class MongoStorageProvider {
         const docs = await this._nodes.find(filter, { session }).toArray();
         return docs.map(d => this._docToNode(d));
     }
+    async getTotalNodeCount(transaction) {
+        const session = transaction?.context;
+        return this._nodes.countDocuments({ graphId: this._graphId }, { session });
+    }
     async getEdgesByProperty(key, value, edgeType, transaction) {
         const session = transaction?.context;
         const filter = {
@@ -108,7 +125,18 @@ class MongoStorageProvider {
         const docs = await this._edges.find(filter, { session }).toArray();
         return docs.map(d => this._docToEdge(d));
     }
+    async getTotalEdgeCount(transaction) {
+        const session = transaction?.context;
+        return this._edges.countDocuments({ graphId: this._graphId }, { session });
+    }
     async insertEdge(edge, transaction) {
+        const now = Date.now();
+        if (edge.createdOn === undefined) {
+            edge.createdOn = now;
+        }
+        if (edge.updatedOn === undefined) {
+            edge.updatedOn = now;
+        }
         const session = transaction?.context;
         try {
             await this._edges.insertOne({
@@ -117,6 +145,8 @@ class MongoStorageProvider {
                 sourceId: edge.sourceId,
                 targetId: edge.targetId,
                 type: edge.type,
+                createdOn: edge.createdOn,
+                updatedOn: edge.updatedOn,
                 properties: edge.properties,
             }, { session });
         }
@@ -140,10 +170,14 @@ class MongoStorageProvider {
         const doc = await this._edges.findOne({ graphId: this._graphId, id }, { session });
         return doc ? this._docToEdge(doc) : undefined;
     }
-    async getAllEdges(transaction) {
+    async getAllEdges(limit, orderBy, transaction) {
         const session = transaction?.context;
         const edges = [];
         const cursor = this._edges.find({ graphId: this._graphId }, { session }).batchSize(this._batchSize);
+        if (orderBy)
+            cursor.sort(orderBy.field, orderBy.direction);
+        if (limit)
+            cursor.limit(limit);
         for await (const doc of cursor) {
             edges.push(this._docToEdge(doc));
         }
@@ -236,6 +270,8 @@ class MongoStorageProvider {
                 id: n.id,
                 graphId: this._graphId,
                 type: n.type,
+                createdOn: n.createdOn ?? Date.now(),
+                updatedOn: n.updatedOn ?? Date.now(),
                 properties: n.properties,
             }));
             for (let i = 0; i < nodeDocs.length; i += this._batchSize) {
@@ -249,6 +285,8 @@ class MongoStorageProvider {
                 sourceId: e.sourceId,
                 targetId: e.targetId,
                 type: e.type,
+                createdOn: e.createdOn ?? Date.now(),
+                updatedOn: e.updatedOn ?? Date.now(),
                 properties: e.properties,
             }));
             for (let i = 0; i < edgeDocs.length; i += this._batchSize) {
@@ -296,7 +334,7 @@ class MongoStorageProvider {
         }
         const session = transaction?.context;
         const collection = target === 'node' ? this._nodes : this._edges;
-        const result = await collection.updateOne({ graphId: this._graphId, id, [`properties.${key}`]: { $exists: false } }, { $set: { [`properties.${key}`]: value } }, { session });
+        const result = await collection.updateOne({ graphId: this._graphId, id, [`properties.${key}`]: { $exists: false } }, { $set: { [`properties.${key}`]: value, updatedOn: Date.now() } }, { session });
         if (result.matchedCount === 0) {
             const record = target === 'node' ? await this.getNode(id, transaction) : await this.getEdge(id, transaction);
             if (!record) {
@@ -311,7 +349,7 @@ class MongoStorageProvider {
         }
         const session = transaction?.context;
         const collection = target === 'node' ? this._nodes : this._edges;
-        const result = await collection.updateOne({ graphId: this._graphId, id, [`properties.${key}`]: { $exists: true } }, { $set: { [`properties.${key}`]: value } }, { session });
+        const result = await collection.updateOne({ graphId: this._graphId, id, [`properties.${key}`]: { $exists: true } }, { $set: { [`properties.${key}`]: value, updatedOn: Date.now() } }, { session });
         if (result.matchedCount === 0) {
             const record = target === 'node' ? await this.getNode(id, transaction) : await this.getEdge(id, transaction);
             if (!record) {
@@ -332,7 +370,7 @@ class MongoStorageProvider {
                 throw new errors_1.EdgeNotFoundError(id);
             }
         }
-        await collection.updateOne({ graphId: this._graphId, id }, { $unset: { [`properties.${key}`]: '' } }, { session });
+        await collection.updateOne({ graphId: this._graphId, id }, { $unset: { [`properties.${key}`]: '' }, $set: { updatedOn: Date.now() } }, { session });
     }
     async clearProperties(target, id, transaction) {
         const session = transaction?.context;
@@ -398,6 +436,8 @@ class MongoStorageProvider {
         return {
             id: doc.id,
             type: doc.type,
+            createdOn: doc.createdOn,
+            updatedOn: doc.updatedOn,
             properties: doc.properties,
         };
     }
@@ -407,6 +447,8 @@ class MongoStorageProvider {
             sourceId: doc.sourceId,
             targetId: doc.targetId,
             type: doc.type,
+            createdOn: doc.createdOn,
+            updatedOn: doc.updatedOn,
             properties: doc.properties,
         };
     }

package/dist/index.d.ts

@@ -1,3 +1,9 @@
 export { MongoStorageProvider } from './MongoStorageProvider';
 export type { MongoStorageProviderOptions } from './MongoStorageProvider';
 export { MongoGraphFactory } from './MongoGraphFactory';
+export { GraphManager } from 'grafio';
+export type { GraphManagerConfig, CacheConfig, CacheStats } from 'grafio';
+export { CachedStorageProvider, CacheManager } from 'grafio';
+export type { EvictionStrategy, PreloadStrategy, CacheStoreType } from 'grafio';
+export { InMemoryCache } from 'grafio';
+export type { ICacheProvider } from 'grafio';

package/dist/index.js

@@ -1,7 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MongoGraphFactory = exports.MongoStorageProvider = void 0;
+exports.InMemoryCache = exports.CacheManager = exports.CachedStorageProvider = exports.GraphManager = exports.MongoGraphFactory = exports.MongoStorageProvider = void 0;
 var MongoStorageProvider_1 = require("./MongoStorageProvider");
 Object.defineProperty(exports, "MongoStorageProvider", { enumerable: true, get: function () { return MongoStorageProvider_1.MongoStorageProvider; } });
 var MongoGraphFactory_1 = require("./MongoGraphFactory");
 Object.defineProperty(exports, "MongoGraphFactory", { enumerable: true, get: function () { return MongoGraphFactory_1.MongoGraphFactory; } });
+var grafio_1 = require("grafio");
+Object.defineProperty(exports, "GraphManager", { enumerable: true, get: function () { return grafio_1.GraphManager; } });
+var grafio_2 = require("grafio");
+Object.defineProperty(exports, "CachedStorageProvider", { enumerable: true, get: function () { return grafio_2.CachedStorageProvider; } });
+Object.defineProperty(exports, "CacheManager", { enumerable: true, get: function () { return grafio_2.CacheManager; } });
+var grafio_3 = require("grafio");
+Object.defineProperty(exports, "InMemoryCache", { enumerable: true, get: function () { return grafio_3.InMemoryCache; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grafio-mongo",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "MongoDB storage backend for grafio",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,13 +15,13 @@
   
   },
   "peerDependencies": {
-    "grafio": ">=6.0.6",
+    "grafio": ">=6.2.0",
     "mongodb": ">=5.0.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.0",
     "@types/node": "^25.6.0",
-    "grafio": "^6.0.6",
+    "grafio": "^6.2.0",
     "cross-env": "^10.1.0",
     "jest": "^29.5.0",
     "rimraf": "^5.0.0",
@@ -39,9 +39,10 @@
     }
   },
   "author": "Satya Jugran",
-  "license": "MIT",
+  "license": "GPL-3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/satya-jugran/grafio-mongo"
-  }
+  },
+  "funding": "https://ko-fi.com/satyajugran"
 }