data-primals-engine 1.3.4 → 1.4.1

package/README.md

@@ -18,10 +18,11 @@
 
 ## 🚀 Key Features
 
-- **Dynamic Data Modeling**: Define and update schemas using JSON, no migrations required.
+- **Visual Data Modeling**: Define and update schemas using a powerful UI Model Creator, or directly with JSON. No migrations required.
 - **Custom API Endpoints**: Create server-side logic and new API endpoints directly from the UI in a secure, sandboxed environment.
 - **Automation Workflows**: Trigger complex actions based on data events (create, update, delete) or schedules (cron).
-- **Advanced Querying & Aggregation**: Go beyond simple filters with deep relation expansion, complex lookups, and dynamic calculated fields.
+- **Advanced Querying & Aggregation**: Go beyond simple filters with a visual Condition Builder, deep relation expansion, complex lookups, and dynamic calculated fields.
+- **Rich UI Data Views**: Ready-to-use React components to display your data, including a powerful and configurable Data Table, a Kanban board, and a Calendar view.
 - **Integrated Backup & Restore**: Secure, encrypted user data backups with rotation policies, supporting both local and AWS S3 storage.
 - **Automatic Data Auditing**: Automatically tracks all changes (create, update, delete) for every record, providing a complete version history for auditing and traceability.
 - **Event-Driven & Extensible**: A core event system allows for deep customization and the easy creation of new modules or plugins.
@@ -32,6 +33,14 @@
 - **📦 Starter Packs**: Quickly bootstrap applications with pre-built data packs for CRM, e-commerce, and more.
 - **📄Auto-Generated API Documentation**: Interactive API documentation available via the interface or at `/api-docs`.
 
+## ⚛️ Frontend Integration (React)
+
+This engine is designed to work seamlessly with its dedicated client library, **`data-primals-engine/client`**. This library provides a complete set of React hooks and UI components to build a rich, data-centric user interface on top of the backend.
+
+While this README focuses on the backend engine and its API, you can find detailed instructions on how to integrate the client part in your React application here:
+
+➡️ **[View the Frontend Integration Guide](https://github.com/anonympins/data-primals-engine/tree/develop/client)**
+
 
 ## 🌟 Why Choose data-primals-engine?
 
@@ -116,6 +125,12 @@ By default, the app runs on port **7633** : http://localhost:7633
 
 ## 🧠 Concepts
 
+### Authentication & Authorization
+
+The engine includes a pluggable system for user management. For development and testing, it uses a `DefaultUserProvider` which creates a volatile **`demo`** user. This is perfect for getting started quickly without setting up a user database.
+
+For production environments, you should extend the base `UserProvider` class to connect to your actual user database (e.g., another MongoDB collection, a SQL database, or an external authentication service). This allows you to implement your own logic for finding users and validating passwords.
+
 ### Models
 Define schemas using JSON:
 ```json
@@ -554,6 +569,7 @@ const result = await installPack("61d1f1a9e3f1a9e3f1a9e3f1", user, "en");
 
 > You can also open the pack gallery to see the JSON structure of each pack, before installing them.
 
+
 ---
 ### Data Auditing & History 
 data-primals-engine includes a built-in, automatic auditing system that creates a complete history for every record in your database. 
@@ -702,6 +718,60 @@ Expected response :
 
 ```
 
+### Pluggable SSO Authentication (Google, SAML, Azure AD)
+
+`data-primals-engine` features a powerful and modular Single Sign-On (SSO) system built on Passport.js. This allows you to easily integrate with various enterprise and social identity providers. The core engine remains lightweight, and you only enable the providers you need.
+
+#### How It Works
+
+The engine provides a central `Sso` component that manages authentication logic. Each provider (Google, SAML, etc.) is an independent module that "plugs into" this central component.
+
+To enable an SSO provider, follow these three steps:
+
+#### Example: Enabling Google Sign-In
+
+**1. Install the Provider's Library**
+
+The required Passport strategy is a `peerDependency`. You must install it in your project:
+```bash
+npm install passport-google-oauth20
+```
+
+**2. Enable the Module**
+
+To enable the module in your next engine initilization, just add it to the `modules` array:
+```javascript
+Config.Set("modules", ["auth-google", "..."]);
+```
+
+**3. Set Environment Variables**
+
+Create or update your `.env` file with the credentials obtained from the Google Cloud Console:
+```env
+GOOGLE_CLIENT_ID=your-google-client-id
+GOOGLE_CLIENT_SECRET=your-google-client-secret
+```
+
+The login flow will now be available at `/api/auth/google`.
+
+#### Other Providers
+
+The process is identical for other supported providers:
+
+-   **SAML**:
+    1.  `npm install passport-saml-encrypted`
+    2.  Enable the `auth-saml` module.
+    3.  Set `SAML_ENTRY_POINT`, `SAML_ISSUER`, `SAML_CERT`, and `SAML_DECRYPTION_KEY` environment variables.
+
+-   **Microsoft Azure AD**:
+    1.  `npm install passport-azure-ad`
+    2.  Enable the `auth-microsoft` module.
+    3.  Set `MICROSOFT_CLIENT_ID`, `MICROSOFT_CLIENT_SECRET`, and `MICROSOFT_TENANT_ID` environment variables.
+
+This modular approach makes it simple to extend the engine with any Passport-compatible strategy to meet your authentication needs.
+
+See implementations in the `modules` directory.
+
 ---
 ## Extensibility
 

package/client/README.md

@@ -9,6 +9,26 @@ Your React application must have the following dependencies installed:
 - react-router-dom
 - react-cookie
 
+## What is `data-primals-engine`?
+
+The `data-primals-engine` is more than just a set of utilities; it's a comprehensive toolkit for building data-centric applications. Once integrated, it provides a full suite of UI components and hooks to manage your data lifecycle.
+
+### Core Features
+
+*   **AI-Powered Model Creator**: A complete UI for visually creating your data models, with support for dozens of field types (relations, translated text, numbers, files...) and advanced properties (history, validation, conditional display...).
+*   **Dynamic Data Views**: Ready-to-use components to display your data, including:
+    *   A powerful and configurable **Data Table**.
+    *   A **Kanban View** with drag-and-drop.
+    *   A **Calendar View**.
+*   **Dashboards & KPIs**: Build custom dashboards to monitor your activity with charts and Key Performance Indicators.
+*   **Data Management Tools**:
+    *   A flexible **Data Importer** (CSV, Excel, JSON).
+    *   A powerful **Data Exporter**.
+    *   A **Visual Condition Builder** for creating complex queries.
+*   **Built-in Systems**: The library also includes systems for **user tutorials**, **data versioning/history**, **backups**, and much more.
+
+This guide focuses on the technical integration. Once set up, you will be able to use the components and hooks provided by the library to leverage these features.
+
 ## Installation
 Install the library:
 ```shell