json-object-editor 0.10.312 → 0.10.400

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-object-editor",
-  "version": "0.10.312",
+  "version": "0.10.400",
   "description": "JOE the Json Object Editor | Platform Edition",
   "main": "app.js",
   "scripts": {

package/server/modules/Storage.js

@@ -177,4 +177,61 @@ function Storage(specs){
     };
     return self;
 }
-module.exports = new Storage();
+module.exports = new Storage();
+
+/**
+ * Save data to the specified collection.
+ *
+ * This function handles saving data to a MongoDB collection or a file-based storage system.
+ * It supports history tracking, event triggering, and user attribution for the saved data.
+ *
+ * @param {Object} data - The data object to be saved. Must include at least the `itemtype` property.
+ * @param {String} collection - The name of the collection where the data will be saved.
+ * @param {Function} [callback] - Optional callback function to handle the result of the save operation.
+ *                                The callback receives two arguments: `err` (error) and `data` (saved data).
+ * @param {Object} [specs] - Additional specifications for the save operation.
+ *                           - `history` (Boolean): Whether to track history for the saved data (default: true).
+ *                           - `user` (Object): The user performing the save operation. Should include `_id` and `name`.
+ *
+ * ### Features:
+ * - **MongoDB Integration**: Saves data to MongoDB if connected.
+ * - **File-Based Fallback**: If MongoDB is not connected, it falls back to file-based storage.
+ * - **History Tracking**: Tracks changes to the data and saves historical records.
+ * - **Event Triggering**: Triggers events for `create`, `save`, `status`, and `delete` actions.
+ * - **User Attribution**: Associates the save operation with a user for auditing purposes.
+ *
+ * ### Example Usage:
+ *
+ * ```javascript
+ * const data = {
+ *     _id: "12345",
+ *     itemtype: "campaign",
+ *     name: "New Campaign",
+ *     status: "active"
+ * };
+ *
+ * const collection = "campaigns";
+ *
+ * const callback = function(err, savedData) {
+ *     if (err) {
+ *         console.error("Error saving data:", err);
+ *     } else {
+ *         console.log("Data saved successfully:", savedData);
+ *     }
+ * };
+ *
+ * const specs = {
+ *     history: true,
+ *     user: { _id: "67890", name: "John Doe" }
+ * };
+ *
+ * JOE.Storage.save(data, collection, callback, specs);
+ * ```
+ *
+ * ### Error Handling:
+ * - If an error occurs during the save operation, it is logged to the console and passed to the callback.
+ *
+ * ### Notes:
+ * - The `itemtype` property in the `data` object is required for proper event handling.
+ * - If `history` is disabled in `specs`, historical tracking and event triggering are skipped.
+ */

package/server/schemas/status.js

@@ -51,7 +51,9 @@ var schema = {
         'info',
         'description',
         'color:color',
-        'index:number',
+        { name: "index", type: "number", display: "Ordering Index", comment: "Optional manual ordering index for lists and workflows. Lower values appear first.", width:'50%' },
+
+        { name: "code", type: "text", display: "System Code", comment: "Machine-usable, human-readable identifier for database/API use. Use lowercase with underscores.", width:'50%' },
         {section_start:'categorization',collapsed:true},
         {label:'workflow'},
         {name:'default',type:'boolean',display:'default',label:'default status for new items', width:'50%'},