data-primals-engine 1.1.8 → 1.2.0

package/README.md

@@ -23,18 +23,37 @@
 - **🌐 i18n support**: Multilingual interfaces, translated validations.
 - **📄 Auto Documentation**: Swagger available at `/api-docs`.
 
+
+## 🌟 Why Choose data-primals-engine?
+
+- **Zero Boilerplate**: Focus on your business logic, not infrastructure
+- **Scalability**: Architecture designed for rapidly growing applications
+- **Modularity**: Enable/disable features as needed
+- **Batteries Included**: Everything you need to get started quickly
+- **Proven Performance**: Handles 50k+ documents efficiently
+- **AI Ready**: Built-in LangChain integration for OpenAI/Gemini
+
 ---
 
 ## ⚙️ Requirements
 
-- Node.js ≥ 18
-- MongoDB (local or remote)
+- Node.js ≥ 20
+- MongoDB (local or remote), see [installation guide](https://www.mongodb.com/docs/manual/installation/)
 - NPM or Yarn
 
 ---
 
 ## ⚡ Quick Start
 
+### check
+```bash
+# Verify required versions
+node -v # Must show ≥ v18
+mongod --version # Must be installed
+```
+
+### install
+
 ```bash
 npm i data-primals-engine
 ```
@@ -44,6 +63,8 @@ git clone https://github.com/anonympins/data-primals-engine.git
 cd data-primals-engine
 npm install
 ```
+
+### configure 
 Possibly create a `.env` file:
 ```env
 MONGO_DB_URL=mongodb://127.0.0.1:27017
@@ -68,7 +89,7 @@ MONGO_DB_URL=mongodb://127.0.0.1:27017
 | CA_CERT               | 	Path to CA cert file.                                                  | 	certs/cert.pem                          |
 | CERT_KEY              | Path to the key file for your certificate.                              | 	certs/key.pem                           |
 
-Start the server:
+### Start the server
 ```bash
 # Development mode
 npm run devserver
@@ -77,7 +98,8 @@ npm run devserver
 npm run server
 ```
 
-By default, the app runs on port **7633**.
+By default, the app runs on port **7633** : http://localhost:7633
+
 
 ---
 
@@ -93,10 +115,22 @@ Define schemas using JSON:
     { "name": "name", "type": "string", "required": true },
     { "name": "price", "type": "number", "required": true },
     { "name": "stock", "type": "number", "default": 0 },
-    { "name": "category", "type": "relation", "relation": "taxonomy" }
+    { "name": "category", "type": "relation", "relation": "taxonomy",
+       "relationFilter": { "$eq": ["$type", "category"] }
+    },
+    { "name": "tags", "type": "relation", "relation": "taxonomy", "multiple": true,
+       "relationFilter": { "$eq": ["$type", "keyword"] }
+    }
   ]
 }
 ```
+### Smart Relations
+- Handles up to 2,000 direct relations
+- For larger datasets, use intermediate collections
+- Automatic indexing on key fields
+- Custom indexing on fields
+- Custom fields :
+
 | Type        | Description                                                                         | 	Properties/Notes                                                         | 
 |:------------|:------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|
 | string	     | Character string.                                                                   | 	minLength, maxLength                                                     |
@@ -124,10 +158,22 @@ Define schemas using JSON:
 Activatable features:
 - `mongodb`, `data`, `user`, `workflow`, `file`, `assistant`, `swagger`
 
-### Starter Packs
-- **E-commerce**: Products, orders, KPIs
-- **CRM**: Contacts, leads, interactions
-- **Website/blog**: Pages, posts, i18n
+## 🏗️ Use Case Examples
+
+### 🛒 E-Commerce Backoffice
+- Install ecommerce-starter pack
+- Add products via API/UI
+- Customize order workflows
+
+### 🎫 Support Ticket System
+- Create ticket model with [open, pending, resolved] statuses
+- Configure notification workflows
+- Add custom endpoints for analytics
+
+### 🤖 AI Chatbot 
+- Define your model
+- Set up workflow: "When new entry → generate AI content"
+- Connect to frontend chat interface
 
 ---
 
@@ -297,7 +343,7 @@ await patchData(
 );
 ```
 
-### deleteData(modelName, ids, filter, user)
+### deleteData(modelName, filter, user)
 
 >Deletes data with cascading relation cleanup.
 
@@ -305,13 +351,13 @@ Examples:
 
 ```javascript
 // Delete by IDs
-await deleteData("comments", ["61d1f1a9e3f1a9e3f1a9e3f1"], null, user);
+await deleteData("comments", ["61d1f1a9e3f1a9e3f1a9e3f1"], user);
 
 // Delete by filter
-await deleteData("logs", null, { createdAt: { $lt: "2023-01-01" } }, user);
+await deleteData("logs", { createdAt: { $lt: "2023-01-01" } }, user);
 ```
 
-### searchData({user, query})
+### searchData(query, user)
 
 Powerful search with relation expansion and filtering.
 
@@ -326,15 +372,12 @@ Query Options:
 Example:
 ```javascript
 const results = await searchData({
-    user: currentUser,
-    query: {
-        model: "blogPost",
-        filter: { status: "published" },
-        depth: 2, // Expand author and comments
-        limit: 10,
-        sort: "createdAt:DESC"
-    }
-});
+     model: "blogPost",
+     filter: { status: "published" },
+     depth: 2, // Expand author and comments
+     limit: 10,
+     sort: "createdAt:DESC"
+}, user);
 ```
 
 ## Import/Export

package/client/src/AssistantChat.scss

@@ -39,7 +39,6 @@ $input-height: 50px;
   bottom: 20px;
   right: 20px;
   width: 100%;
-  left: 2px;
   max-width: 720px;
   min-height: 400px;
   height: 60vh;

package/client/src/ChartConfigModal.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/ChartConfigModal.jsx
 import React, { useState, useEffect } from 'react';
 import { useTranslation } from 'react-i18next';
 import { useModelContext } from './contexts/ModelContext.jsx';

package/client/src/ConditionBuilder.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/ConditionBuilder.jsx
 
 import React, {useState, useEffect, useRef} from 'react';
 import {
@@ -567,7 +566,6 @@ const ConditionBuilder = ({ initialValue = null, onChange, models, model = null,
         setRoot(p);
         onChange(p);
     };
-// C:/Dev/hackersonline-engine/client/src/ConditionBuilder.jsx
     useEffect(() => {
         let parsedValue = {}; // Valeur par défaut si tout échoue
 

package/client/src/ContentView.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/pages/ContentView.jsx
 import React, {useEffect, useMemo, useRef, useState} from 'react';
 import {useParams, Link, useLocation } from 'react-router-dom'; // NavLink supprimé car non utilisé
 import { useQuery } from 'react-query';

package/client/src/CronBuilder.scss

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/CronBuilder.scss
 
 // J'utilise ici des variables pour les couleurs et espacements.
 // Si votre projet a déjà un fichier de variables SCSS, il serait bon de les utiliser

package/client/src/CronPartBuilder.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/CronPartBuilder.jsx
 
 import React, { useMemo } from 'react';
 import { SelectField, TextField, NumberField } from './Field.jsx';

package/client/src/Dashboard.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/Dashboard.jsx
 import React, {useState, useMemo, useEffect} from 'react';
 import { Trans, useTranslation } from 'react-i18next';
 import {FaPlus, FaSpinner} from "react-icons/fa"; // Ajout FaTrash

package/client/src/Dashboard.scss

@@ -231,7 +231,6 @@
           }
       }
 }
-// C:/Dev/hackersonline-engine/client/src/Dashboard.scss
 // ... (autres styles existants) ...
 
 // Styles pour les badges de données dans FlexView

package/client/src/DashboardChart.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/DashboardChart.jsx
 import React, {useEffect, useMemo, useState} from 'react';
 import { fr } from 'date-fns/locale'
 import {

package/client/src/DashboardView.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/DashboardView.jsx
 import React, {useEffect, useState, useMemo, useRef, useCallback} from 'react';
 import { Trans, useTranslation } from 'react-i18next';
 import KPIWidget from "./KPIWidget.jsx";

package/client/src/DataEditor.jsx

@@ -52,10 +52,6 @@ const getInputType = (fieldType) => {
     }
 };
 
-// C:/Dev/hackersonline-engine/client/src/DataEditor.jsx
-// C:/Dev/hackersonline-engine/client/src/DataEditor.jsx
-
-
 /**
  * Evaluates a single condition against form data.
  * @param {object} currentModelDef - The definition of the current model.

package/client/src/DisplayFlexNodeRenderer.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/DisplayFlexNodeRenderer.jsx
 import {useTranslation} from "react-i18next";
 import {cssProps} from "../../src/core.js";
 import FlexDataRenderer from "./FlexDataRenderer.jsx";

package/client/src/DocumentationPageLayout.jsx

@@ -1,8 +1,6 @@
-// C:/Dev/hackersonline-engine/client/src/DocumentationPageLayout.jsx
 import React from 'react';
 import { Outlet } from 'react-router-dom';
 import './DocumentationPageLayout.scss'; // Nous créerons ce fichier SCSS ensuite
-// C:/Dev/hackersonline-engine/client/src/DocumentationMenu.jsx
 import { NavLink } from 'react-router-dom';
 import { useTranslation } from 'react-i18next';
 import { FaChevronDown, FaChevronRight } from 'react-icons/fa';

package/client/src/DocumentationPageLayout.scss

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/DocumentationPageLayout.scss
 @import "_variables";
 
 .documentation-layout {

package/client/src/FlexNode.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/FlexNode.jsx
 import React, {useEffect, useRef, useState} from 'react';
 import PropTypes from 'prop-types';
 import {

package/client/src/KanbanView.scss

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/KanbanView.scss
 
 // --- Variables pour une personnalisation facile ---
 $board-bg: #f4f5f7;       // Fond gris clair pour le tableau

package/client/src/RestoreDialog.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/RestoreDialog.jsx
 
 import React, { useState, useEffect } from 'react';
 import { useSearchParams, useNavigate } from 'react-router-dom';

package/client/src/TourSpotlight.jsx

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/TourSpotlight.jsx
 
 import React, { useState, useEffect, useRef, useCallback } from 'react';
 import './TourSpotlight.scss';

package/client/src/hooks/useDragAndDrop.js

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/client/src/hooks/useDragAndDrop.js
 import { useState, useRef, useCallback } from 'react';
 
 const useDragAndDrop = () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "data-primals-engine",
-  "version": "1.1.8",
+  "version": "1.2.0",
   "description": "data-primals-engine is the package responsible from handling large amount of data in a practical and performant way. It can handle large amount of data in a practical and performant way. It can also get workflow models working (for automation), and fully supports internationalisation.",
   "main": "src/engine.js",
   "type": "module",

package/src/constants.js

@@ -6,6 +6,12 @@ import {event_trigger} from "./core.js";
  */
 export const install = true;
 
+/**
+ * Maximum reflective steps to be used by the AI (looping over own research)
+ * @type {number}
+ */
+export const maxAIReflectiveSteps = 4;
+
 /**
  * Database name
  * @type {string}

package/src/data.js

@@ -50,7 +50,6 @@ export function getUserId(user) {
 export const getUserName = (user) => {
     return isLocalUser(user) ? user._id + '_'+user._user : user.username;
 }
-// C:/Dev/hackersonline-engine/src/data.js
 
 /**
  * Crée une fonction de génération de nombres pseudo-aléatoires basée sur une graine (seed).
@@ -255,7 +254,6 @@ function buildNestedFindStructure(pathSegments, finalPayload) {
         }
     };
 }
-// C:/Dev/hackersonline-engine/src/data.js
 // ... (imports and other functions) ...
 
 /**

package/src/migrate.js

@@ -1,4 +1,3 @@
-// C:/Dev/hackersonline-engine/server/src/migrate.js
 
 import process from "node:process";
 import fs from "node:fs/promises";