genosdb 0.0.1 → 0.2.4

package/LICENSE

@@ -0,0 +1,55 @@
+Copyright (c) 2025 Esteban Fuster Pozzi
+
+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.
+
+---
+
+Copyright (c) 2025 Esteban Fuster Pozzi
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgement in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.
+
+---
+
+Copyright 2025 Esteban Fuster Pozzi
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,210 @@
+# GenosDB (GDB) – Decentralized P2P Graph Database
+
+A lightweight, decentralized graph database designed for modern web applications, offering real-time peer-to-peer synchronization, WebAuthn-based authentication, role-based access control (RBAC), and efficient local storage utilizing OPFS.
+
+![GenosDB](https://i.imgur.com/7Xqrht1.png)
+
+---
+
+[![NPM Version](https://img.shields.io/npm/v/genosdb.svg?style=for-the-badge)](https://www.npmjs.org/package/genosdb)
+[![NPM License](https://img.shields.io/npm/l/genosdb.svg?style=for-the-badge)](https://github.com/estebanrfp/gdb/blob/main/LICENSE)
+
+
+![Downloads on NPM](https://img.shields.io/npm/dw/genosdb)
+[![](https://data.jsdelivr.com/v1/package/npm/genosdb/badge)](https://www.jsdelivr.com/package/npm/genosdb)
+
+![Project Status](https://img.shields.io/badge/state-development-green)
+
+<!-- [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/estebanrfp/gdb&build=dist) -->
+
+![NPM Unpacked Size (with version)](https://img.shields.io/npm/unpacked-size/genosdb/latest)
+
+![npm package minimized gzipped size](https://img.shields.io/bundlejs/size/genosdb)
+
+[![Liberapay receiving](https://img.shields.io/liberapay/receives/estebanrfp.svg?logo=liberapay)](https://liberapay.com/estebanrfp/donate)
+
+<!-- ### Nostr.band Followers
+
+![Nostr.band Followers](https://img.shields.io/nostr-band/followers/npub18c556t7n8xa3df2q82rwxejfglw5przds7sqvefylzjh8tjne28qld0we7) -->
+
+<!-- ![GitHub Sponsors](https://img.shields.io/github/sponsors/estebanrfp) -->
+
+## Main Features
+
+### ✅ **GenosDB Core**
+
+- Efficient storage in OPFS.
+- Real-time synchronization between tabs and devices.
+- CRUD operations for nodes and relationships.
+- Efficient serialization using MessagePack and compression with Pako.
+- Enabling reverse or Radix Tree indexing through external modules.
+- GenosDB supports external modules that extend its capabilities.
+
+## Warning
+
+This project is under active development. Do not use it in production environments until it reaches the beta or stable phase. Check the [Project Status](#project-status) section for more details.
+
+## Project Status
+
+- **Phase**: Beta
+- **Completed Features**:
+  - Basic queries.
+  - Advanced queries.
+  - Modules for AI queries.
+  - Distributed storage.
+  - Conflict resolution module (LWW).
+  - Performance optimization.
+
+- **Pending Features**:
+  - Improve incremental Synchronization:
+    Currently, when a change is detected in an element, the entire graph is updated in nodes that do not have the latest version. In future versions, incremental synchronization will be implemented to propagate only the specific changes, improving efficiency and reducing latency in distributed graph updates.
+
+> ⚠️ The API is under active development and may change without notice. Use fixed versions and check the [changelog](https://github.com/estebanrfp/gdb/wiki/CHANGELOG.md) before upgrading.
+
+### ✅ **Role Based Access Control (RBAC)**
+
+- Customizable role hierarchy (`superadmin`, `admin`, etc)
+- Biometric Registration and Authentication with WebAuthn
+- Granular permissions (`read`/`write`/`delete`/`publish`)
+- Role assignment with automatic expiration
+- Cryptographic transaction verification
+
+### ✅ **Security**
+
+- Digital signature of critical operations
+- Real-time permission validation
+- Secure storage of roles in internal graph
+- [Security Implementation](https://github.com/estebanrfp/gdb/wiki/RBAC-Security)
+
+> **Important Notice**: This project has progressed from its active development phase and is now in the beta stage. While it is functional and stable in controlled environments, it is recommended to evaluate its suitability for production based on the specific needs of your environment. For more details, please refer to the [Project Status](#project-status)
+
+## ⚠️ Reliability Notice
+
+This is a distributed database (P2P + CRDT); therefore:  
+• In extreme conditions (network failures, partial synchronization, or unconventional usage), unexpected behavior may occur.  
+• Any reported issues will be prioritized and resolved in upcoming patch versions.
+
+The project has achieved the expected stability goals (such as conflict resolution, synchronization, and distributed storage), without intending to ignore the limitations inherent to distributed technologies (P2P + CRDT).
+
+gdb‑p2p has been rigorously tested with our common usage examples in such environments, demonstrating greater stability than many other well-known distributed databases.
+
+---
+
+## Installation
+
+### 1. Via NPM
+
+```bash
+npm install genosdb
+```
+
+```javascript
+import { GDB } from "genosdb"
+```
+
+### 2. Direct use in browser from a CDN
+
+```html
+<script type="module">
+  import { GDB } from "https://cdn.jsdelivr.net/npm/genosdb/+esm"
+</script>
+```
+
+## Documentation
+
+For detailed documentation, visit our [GitHub Wiki](https://github.com/estebanrfp/gdb/wiki).
+
+For interactive, AI-assisted GenosDB documentation, visit our [Devin Wiki](https://deepwiki.com/estebanrfp/gdb).
+
+## Examples
+
+We’ve created a collection of interactive examples to help you understand how GDB works in real-world scenarios. These examples cover everything from basic setup to advanced features like RBAC and P2P synchronization.
+
+👉 [Explore Examples](https://github.com/estebanrfp/gdb/wiki/EXAMPLES.md)
+
+### **Internal Dependencies**
+
+Below is a list of internal dependencies and their purposes within the project:
+
+| Dependency         | Usage                                                                                   |
+| ------------------ | ---------------------------------------------------------------------------------------|
+| `@msgpack/msgpack` | Data serialization/deserialization in MessagePack format.                              |
+| `pako`             | Data compression/decompression using gzip.                                            |
+| `trystero`         | P2P synchronization for sharing changes in real-time between tabs/devices.            |
+| `BroadcastChannel` | Communication between browser tabs to notify local changes.                           |
+
+#### Additional Information
+
+- **`@msgpack/msgpack`**:  
+  This library is used to efficiently serialize and deserialize data, reducing payload sizes for storage and transmission.
+
+- **`pako`**:  
+  Provides gzip compression to optimize data storage and network communication.
+
+- **`trystero`**:  
+  Enables peer-to-peer synchronization, ensuring real-time updates across multiple instances of the application.  
+  > **Note**: Among the available networks supported by Trystero, this project specifically uses the **Nostr** protocol for decentralized communication.  
+  >
+  > **What is Nostr?**  
+  > Nostr (Notes and Other Stuff Transmitted by Relays) is a decentralized protocol designed for censorship-resistant global communication. It operates without relying on centralized servers, instead using a network of relays to transmit signed messages between peers. Nostr is particularly well-suited for applications requiring secure, private, and scalable peer-to-peer interactions, such as social networks, messaging systems, or collaborative tools.
+
+- **`BroadcastChannel`**:  
+  Facilitates lightweight communication between browser tabs, allowing seamless updates without relying on external servers.
+
+> **General Note**: These dependencies are integral to the project's performance and functionality, ensuring efficient data handling and real-time synchronization while leveraging decentralized technologies like Nostr.
+
+## Repository Diagram
+
+The project includes an interactive visualization of the repository’s history and structure, which you can explore by clicking the following link: gdb repository diagram.
+
+The project includes an interactive visualization of the repository's history and structure, which you can explore here:  
+
+[gdb repository diagram](https://gitdiagram.com/estebanrfp/gdb)  
+
+This graphical view is especially useful for new contributors or anyone looking to gain deeper insight into the project’s evolution and structure, providing a clear and visual understanding of the workflow.
+
+## Contributing
+
+We welcome contributions to improve this project! Please read our [Contribution Guidelines](https://github.com/estebanrfp/gdb/wiki/Contributing) for details on how to get started.
+
+
+## Community
+
+We value community contributions and discussions! Here's how you can get involved:
+
+- **Ask questions or share ideas**: Join our [GitHub Discussions](https://github.com/estebanrfp/gdb/discussions).
+- **Real-time chat**: For quick conversations, join us on [Gitter](https://app.gitter.im/#/room/#GDB:gitter.im).
+
+  Here’s how you can participate in the Gitter room:
+  
+  - `[DEV]`: Discussions about project development, new features, and technical improvements.
+  - `[ANNOUNCEMENT]`: Official updates, new releases, and important news about GDB.
+  - `[HELP]`: Technical support and troubleshooting for GDB-related questions.
+
+Feel free to ask questions, share ideas, or just say hello! 👋
+
+For more details on contributing, check out our [Contributing Guidelines](https://github.com/estebanrfp/gdb/wiki/Contributing).
+
+## Licenses
+
+This project includes third-party dependencies with their respective licenses. For detailed information, see the [Licenses page](https://github.com/estebanrfp/gdb/wiki/Licenses/) in the Wiki.
+
+The source code of this project is licensed under the [MIT License](https://opensource.org/licenses/MIT). For more information, see the [LICENSE](LICENSE) file.
+
+## Maintenance
+
+This repository provides minified builds of GenosDB (GDB), a decentralized P2P graph database designed for modern web applications. These builds are freely available for anyone to use and integrate into their projects. Please note that the source code is not publicly available at this time; only the minified versions are provided. The project is actively maintained by Esteban Fuster Pozzi ([@estebanrfp](https://github.com/estebanrfp))
+
+## Author
+
+[Esteban Fuster Pozzi (@estebanrfp)](https://estebanrfp.com) — Full Stack JavaScript Developer and creator of [GenosDB (GDB)](https://www.npmjs.com/package/genosdb), an open-source real-time graph database built entirely with modern vanilla JavaScript.
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Festebanrfp%2Fgdb.svg?type=shield&issueType=security)](https://app.fossa.com/projects/git%2Bgithub.com%2Festebanrfp%2Fgdb?ref=badge_shield&issueType=security)
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Festebanrfp%2Fgdb.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Festebanrfp%2Fgdb?ref=badge_large&issueType=license)
+
+## 💖 Support This Project
+
+If you find this project useful and would like to support its development, please consider making a donation:
+
+[![Donate using Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/estebanrfp/donate)

package/dist/AIModule.min.js

@@ -0,0 +1,13 @@
+function w(c){const S=c.map;return c.map=async function(...E){const N=await S.call(this,...E),b=E.find((h)=>h&&typeof h==="object")||{},{prompt:f}=b;if(f)N.results=await k(N.results,f);return N},c}async function k(c,S){const E=c.map((f)=>f.value),N=`
+${S}
+
+Reglas estrictas:
+- Devuelve un array JSON con la MISMA estructura de entrada.
+- Cada elemento del array debe ser una modificaci\xF3n del objeto correspondiente en la entrada.
+- S\xF3lo se deben modificar campos DENTRO del objeto \`value\`.
+- NO a\xF1adas, elimines ni reestructures nodos externos como \`id\`, \`edges\`, o \`timestamp\`.
+- NO agregues explicaciones ni texto adicional. Devuelve SOLO el array JSON con los objetos \`value\` modificados.
+
+Ejemplo de entrada:
+${JSON.stringify(E)}
+`,b=await v(N);return console.log(b),c.map((f,h)=>{const j=Array.isArray(b)?b[h]:b;return{...f,value:{...f.value,...j||{}}}})}async function v(c){try{const E=await fetch("https://text.pollinations.ai/",{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({messages:[{role:"system",content:"You are an AI assistant specialized in processing structured data objects."},{role:"user",content:c}],model:"openai",seed:Math.floor(Math.random()*1000),jsonMode:!0})});if(!E.ok)throw new Error(`Error calling the Pollinations API: ${E.statusText}`);const N=await E.json();return N.data||N}catch(S){throw console.error("Error processing the prompt with the Pollinations API:",S.message),S}}export{w as withAI};

package/dist/AIQuery.min.js

@@ -0,0 +1,15 @@
+function v(y){const C=y.map;return y.map=async function(...f){let h={},U=null;if(f.forEach((j)=>{if(typeof j==="object")h={...h,...j};if(typeof j==="function")U=j}),h.prompt)try{const j=await $(h.prompt);console.log("Consulta generada desde IA:",j),h={...h,...j},delete h.prompt}catch(j){console.error("Error generando consulta desde IA:",j.message),h.query={}}return C.call(this,h,U)},y}async function $(y){const C=`
+      Convierte la siguiente instrucci\xF3n en lenguaje natural a un objeto de consulta estructurado:
+      "${y}"
+  
+      Reglas:
+      - Devuelve un JSON con campos "query", "order" y "field"
+      - Usa operadores MongoDB como "$between", "$gt", "$lt"
+      - Para rangos usa "$between": [min, max]
+      - Para ordenamiento usa "order": "asc" o "desc" y especifica "field"
+      - Ejemplo: 
+        Entrada: "Busca personas de 10-20 a\xF1os y ord\xE9nalas por edad descendente"
+        Salida: {"query": {"age": {"$between": [10, 20]}}, "order": "desc", "field": "age"}
+      
+      Responde SOLO con el JSON, sin texto adicional.
+    `;try{const f=await q(C);if(f&&typeof f==="object"&&f.query)return{query:f.query,order:f.order||"asc",field:f.field||Object.keys(f.query)[0]};throw new Error("Formato de respuesta de IA inv\xE1lido")}catch(f){return console.warn("Usando consulta vac\xEDa debido a error de IA:",f.message),{query:{}}}}async function q(y){try{const f=await fetch("https://text.pollinations.ai/",{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({messages:[{role:"system",content:"Eres un asistente especializado en convertir lenguaje natural a consultas estructuradas."},{role:"user",content:y}],model:"openai",seed:Math.floor(Math.random()*1000),jsonMode:!0})});if(!f.ok)throw new Error(`Error en la API de Pollinations: ${f.statusText}`);const h=await f.json();try{return typeof h==="string"?JSON.parse(h):h}catch{return h}}catch(C){throw console.error("Error procesando el prompt con la API:",C.message),C}}export{v as withAI};

package/dist/GeolocationOperators.min.js

@@ -0,0 +1 @@
+function I(z){const C={$near:(c,j)=>{console.log("Ejecutando operador $near");const{latitude:f,longitude:k,radius:h}=j;if(typeof f!=="number"||typeof k!=="number"||typeof h!=="number")return console.error("Consulta inv\xE1lida para $near:",j),!1;const w=c?.latitude||c?.location?.latitude,b=c?.longitude||c?.location?.longitude;if(typeof w!=="number"||typeof b!=="number")return!1;return E(w,b,f,k)<=h},$bbox:(c,j)=>{console.log("Ejecutando operador $bbox");const{minLat:f,maxLat:k,minLng:h,maxLng:w}=j;if(typeof f!=="number"||typeof k!=="number"||typeof h!=="number"||typeof w!=="number")return console.error("Consulta inv\xE1lida para $bbox:",j),!1;const b=c?.latitude||c?.location?.latitude,p=c?.longitude||c?.location?.longitude;if(typeof b!=="number"||typeof p!=="number")return!1;return b>=f&&b<=k&&p>=h&&p<=w}};function E(c,j,f,k){const h=(F)=>F*Math.PI/180,b=h(f-c),p=h(k-j),A=Math.sin(b/2)*Math.sin(b/2)+Math.cos(h(c))*Math.cos(h(f))*Math.sin(p/2)*Math.sin(p/2);return 6371*(2*Math.atan2(Math.sqrt(A),Math.sqrt(1-A)))}return z.operators={...z.operators,...C},z}export{I as withGeolocationOperators};