@simplito/privmx-webendpoint 2.6.5 → 2.7.1

package/CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing to PrivMX
+
+## Welcome Contributors! 🎉
+
+Thank you for your interest in contributing to our project. This document provides guidelines and instructions for contributing.
+
+## Legal Notice
+
+If you want to contribute to the project, you can clone the repository, make changes, and then submit a Pull Request (follow the guidelines below).
+Submitting Pull Requests to SIMPLITO's repositories is the only way of publishing modifications made to our code allowed by our License.
+**All the code contributed to the project is under full commercial ownership of SIMPLITO.**
+
+- [Licensing information](https://privmx.dev/licensing)
+- [Contact us](https://privmx.com/en/contact-us) in case of further questions.
+
+## How Can You Contribute?
+
+### Reporting Bugs 🐛
+
+1. **Check Existing Issues**, before submitting a bug report.
+2. **Provide Detailed Information**, according to the bug report template in each project.
+
+### Feature Requests 💡
+
+1. **Check Existing Suggestions**: Verify that your feature hasn't been suggested before.
+2. **Open a Clear Issue**, describing it according to the feature request template in each project.
+3. (Optional) **Open a discussion**, if you want to discuss or make sure that the feature is actually necessary.
+
+### Coding Guidelines 💻
+
+- Follow the project's coding style and conventions
+- Write clear, concise, and well-documented code
+- Include comments for complex logic
+
+### Commit Message Conventions
+
+- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+- Reference issue numbers when applicable
+
+### Pull Request Process
+
+1. **Prepare Your Changes**
+
+   - Ensure code follows project guidelines
+   - Add/update tests as needed
+   - Update documentation in code
+
+2. **Submit Pull Request**
+
+   - Title should be clear and descriptive
+   - Include a detailed description of changes
+   - Link any related issues
+
+3. **Code Review**
+   - Maintainers will review your PR
+   - Be open to feedback and suggested changes
+   - Discussions and iterations are part of the process
+
+## Semantic Versioning Rules (A.B.C-rcX)
+
+- **New Features**: Increment `A` (major) for major changes or incompatible features, `B` (minor) for minor changes (mostly compatible with previous versions).
+- **Consistency**: Main library and wrappers use the same `A` and `B` versioning.
+- **Updates**: `C` changes are fixes and updates without new features; `C` doesn't need to be synchronized between library and wrappers.
+- **Release Candidate (rc)**: `X` represents consecutive release candidates for a given version.
+- **Before Official Release**: Release as `A.B.C-rcX` before final release; changes to new API are possible and update `X`.
+- **Finalizing a Version**: Release stable version when library and wrappers are fully compatible.
+- **Minor Changes (B)**: Increment `B` for small features, replace older functionality, and mark deprecated functions.
+- **Major Changes (A)**: Increment `A` for introducing major changes or features.
+
+Read more about versioning in PrivMX in [our docs](https://docs.privmx.dev/docs/latest/start/versioning).
+
+## Additional Resources
+
+- [PrivMX Documentation](https://docs.privmx.dev/)
+- [API Reference](https://docs.privmx.dev/docs/latest/start/api-reference)
+
+## Questions?
+
+If you have any questions, please:
+
+- Check the documentation
+- Open an issue or a discussion in the appropriate repository
+
+---
+
+**Thank you for contributing!** 🚀

package/README.md

@@ -1,13 +1,103 @@
 # PrivMX Web Endpoint
-PrivMX Web Endpoint is a JavaScript library designed to work in browser environment. It is used by applications and devices which are the ends of PrivMX secure communication channels. It encrypts and decrypts data, manages network connections and provides a functional API on the top of the WebAssembly build made of the native PrivMX Endpoint library written in C++. This allows applications to build their E2EE communication channels based on a few universal, client-side encrypted tools: Threads, Stores, and Inboxes.
 
-For more details, visit the [PrivMX Platform](https://privmx.dev) website and the [PrivMX Web Endpoint](https://github.com/simplito/privmx-webendpoint) repository on GitHub.
+**PrivMX Web Endpoint** is a robust JavaScript library designed for the browser environment. It serves as the client-side gateway to PrivMX Bridge secure communication channels, enabling applications to encrypt, decrypt, and manage data securely.
 
+Under the hood, it wraps the native **PrivMX Endpoint** library (written in C++) using **WebAssembly (Wasm)**. This architecture ensures high-performance cryptography while providing a developer-friendly JavaScript API.
 
----
-Copyright © 2024 Simplito sp. z o.o.
+## Key Features
 
-This software is the part of the [PrivMX Platform](https://privmx.dev).
-This software is Licensed under the PrivMX Free License.
+* **End-to-End Encryption (E2EE):** Client-side encryption for all data transfers.
+* **Universal Tools:** Build complex communication logic using simple primitives:
+* **Threads:** For contextual messaging and collaboration.
+* **Stores:** For secure file and data storage.
+* **Inboxes:** For secure, one-way communication with external or anonymous users (e.g., public forms)
+* **Kvdbs:** For encrypted key-value database storage
+* **Events queue:** For real-time updates and system event handling.
 
-See the License for the specific language governing permissions and limitations under the License.
+* **Performance:** Powered by a C++ core compiled to WebAssembly.
+* **Type-Safe:** Fully typed with TypeScript definitions included.
+
+## Installation
+
+Install the package via npm:
+
+```bash
+npm install @simplito/privmx-webendpoint
+
+```
+
+### Documentation & Examples
+
+* **Getting Started Guide:** [Introduction to PrivMX JS](https://docs.privmx.dev/docs/latest/js/introduction)
+* **API Reference:** [Full API Documentation](https://docs.privmx.dev/docs/latest/reference/webendpoint/api-reference/connection)
+
+## Building
+
+If you want to build the library from source, follow these steps.
+
+### Prerequisites
+
+* Node.js
+* CMake: Required to build the Wasm core (npm run build:wasm).
+* Clang-format (v18): Required for formatting and linting of C++ code
+
+### Build Scripts
+
+The project uses a combined pipeline to compile the C++ core to Wasm and bundle the TypeScript code.
+
+| Command | Description |
+| --- | --- |
+| `npm run build` | Runs the full pipeline: Clean -> Build Wasm -> Compile TS -> Bundle Webpack. |
+| `npm run build:wasm` | Compiles the C++ source code to WebAssembly using `scripts/pipeline.sh`. |
+| `npm run build:js` | Compiles TypeScript (`tsc`) and bundles assets (`webpack`). |
+| `npm run watch:types` | Watches for TypeScript changes. |
+
+## Testing
+
+The project employs a dual testing strategy: **Jest** for unit logic and **Playwright** for End-to-End (E2E) integration testing.
+
+### Unit Tests
+
+Run standard unit tests using Jest:
+
+```bash
+npm test
+
+```
+
+### End-to-End (E2E) Tests
+
+E2E tests require a running Docker backend (PrivMX Bridge). The tests use **Playwright** to spin up browser instances and execute scenarios against the local backend.
+
+```bash
+# Run all E2E tests
+npm run test:e2e
+
+```
+
+*Note: Ensure Docker is running before executing E2E tests.*
+
+## Linting & Formatting
+
+Maintain code quality using ESLint and Prettier:
+
+```bash
+# Check for linting errors
+
+# Typescript
+npm run lint
+# C++
+npm run lint:clang-format
+
+# Auto-format code
+
+# Typescript
+npm run format
+# C++
+npm run format:clang
+```
+
+## License
+
+This software is licensed under the **PrivMX Free License**.
+Copyright © Simplito. All rights reserved.