jqgrid_utils 1.20.0 → 1.22.0

package/README.md

@@ -27,6 +27,8 @@ A module for Jqgrid_utils
 
 
 * [Jqgrid_utils](#module_Jqgrid_utils)
+    * [module.exports#update_row_to_api(col_model, api, _ids)](#exp_module_Jqgrid_utils--module.exports+update_row_to_api) ⏏
+    * [module.exports#delete_row_to_api(col_model, api, ids)](#exp_module_Jqgrid_utils--module.exports+delete_row_to_api) ⏏
     * [module.exports#append_seperator_link_column(col_model, url, field_value, base, attr, keys)](#exp_module_Jqgrid_utils--module.exports+append_seperator_link_column) ⏏
     * [module.exports#add_edit(col_model)](#exp_module_Jqgrid_utils--module.exports+add_edit) ⏏
     * [module.exports#add_textarea(col_model, edit_field)](#exp_module_Jqgrid_utils--module.exports+add_textarea) ⏏
@@ -55,6 +57,7 @@ A module for Jqgrid_utils
     * [module.exports#put_json(url, data)](#exp_module_Jqgrid_utils--module.exports+put_json) ⇒ <code>object</code> ⏏
     * [module.exports#s_hide_del_icon()](#exp_module_Jqgrid_utils--module.exports+s_hide_del_icon) ⏏
     * [module.exports#hide_del_icon()](#exp_module_Jqgrid_utils--module.exports+hide_del_icon) ⏏
+    * [module.exports#add_link_details_csv(col_model, url, edit_field, attr, keys, format, seperator)](#exp_module_Jqgrid_utils--module.exports+add_link_details_csv) ⏏
     * [module.exports#add_link_details(col_model, url, edit_field, attr, keys)](#exp_module_Jqgrid_utils--module.exports+add_link_details) ⏏
     * [module.exports#add_link_details_separator(col_model, url, edit_field, attr, keys)](#exp_module_Jqgrid_utils--module.exports+add_link_details_separator) ⏏
     * [module.exports#add_link_separator(col_model, url, edit_field, fields)](#exp_module_Jqgrid_utils--module.exports+add_link_separator) ⏏
@@ -64,6 +67,66 @@ A module for Jqgrid_utils
     * [module.exports#set_filter(grid, data, fx, append_to)](#exp_module_Jqgrid_utils--module.exports+set_filter) ⏏
     * [module.exports#_filter()](#exp_module_Jqgrid_utils--module.exports+_filter) ⏏
 
+<a name="exp_module_Jqgrid_utils--module.exports+update_row_to_api"></a>
+
+### module.exports#update\_row\_to\_api(col_model, api, _ids) ⏏
+Takes the updated columns data and send it to your API post server
+
+**Kind**: Exported function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| col_model | <code>string</code> | API URL like https://foo.com (required) |
+| api | <code>array</code> | id list, ids from the column header (required) |
+| _ids | <code>object</code> | settings - extra key:value to send to your server |
+
+**Example**  
+```js
+},
+      afterSetRow: async function(row)
+      {
+        const _api = await get_api_url('sapir');
+        const api = _api + '/column2';
+        let info = {"msg":"failed"};
+        var jqu = new Jqgrid_utils();
+        info = await jqu.update_row_to_api(col_model,api,['id'],row,{server : '232',db : 'sl_h',table : 'kpi',});
+        log.info(JSON.parse(info).msg);
+      },
+
+     afterInsertRow: function( rowid, rowdata, rowelem ) {
+     let tr = $("#"+rowid);
+     $(tr).data("jqgrid.record_data", rowelem);
+     },
+```
+<a name="exp_module_Jqgrid_utils--module.exports+delete_row_to_api"></a>
+
+### module.exports#delete\_row\_to\_api(col_model, api, ids) ⏏
+Take your row id value and send it to your delete post API server
+
+**Kind**: Exported function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| col_model | <code>string</code> | API URL like https://foo.com |
+| api | <code>array</code> | id list, ids from the column header (required) |
+| ids | <code>object</code> | settings - extra key:value to send to your server |
+
+**Example**  
+```js
+afterDelRow: async function(rowid){
+  const _api = await get_api_url('sapir');
+  const api = _api + '/column2';
+  let info = {"msg":"failed"};
+  var jqu = new Jqgrid_utils(); 
+  info = await jqu.delete_row_to_api(col_model,api,[rowid],{
+  server : '232',
+  db : 'sl_h',
+  table : 'kpi',
+  operator: 'delete',
+  });
+   log.info(JSON.parse(info).msg); 	
+  },
+```
 <a name="exp_module_Jqgrid_utils--module.exports+append_seperator_link_column"></a>
 
 ### module.exports#append\_seperator\_link\_column(col_model, url, field_value, base, attr, keys) ⏏
@@ -585,6 +648,28 @@ Hide the del iconf rom the grid
 var jqu = new Jqgrid_utils();
 await jqu.hide_del_icon();
 ```
+<a name="exp_module_Jqgrid_utils--module.exports+add_link_details_csv"></a>
+
+### module.exports#add\_link\_details\_csv(col_model, url, edit_field, attr, keys, format, seperator) ⏏
+Convert a cell into a link/url with data from another cell and spit the value by comma - CSV
+
+**Kind**: Exported function  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| col_model | <code>object</code> |  | col_model of the grid |
+| url | <code>string</code> |  | URL string |
+| edit_field | <code>string</code> |  | Column/Cell to use |
+| attr | <code>string</code> |  | URL Attributes |
+| keys | <code>object</code> |  | keys and fields value to use |
+| format | <code>object</code> |  | format info |
+| seperator | <code>string</code> | <code>&quot;,&quot;</code> | seperator of the cell value to split (default is comma) |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+col_model = await jqu.add_link_details_csv(col_model, host + '/html/report.html' , 'tags','target="_blank"',{"tags":"tags"},',');
+```
 <a name="exp_module_Jqgrid_utils--module.exports+add_link_details"></a>
 
 ### module.exports#add\_link\_details(col_model, url, edit_field, attr, keys) ⏏

package/dist/jqgrid_utils.js

@@ -22,6 +22,155 @@ module.exports = class Vanilla_website_utils
 
   }
 
+/**
+* Takes the updated columns data and send it to your API post server
+@alias module:Jqgrid_utils
+@param {string} - API URL like https://foo.com (required)
+@param {array}  - id list, ids from the column header (required)
+@param {object} - settings - extra key:value to send to your server 
+
+@example 
+     },
+      afterSetRow: async function(row)
+      {
+        const _api = await get_api_url('sapir');
+        const api = _api + '/column2';
+        let info = {"msg":"failed"};
+        var jqu = new Jqgrid_utils();
+        info = await jqu.update_row_to_api(col_model,api,['id'],row,{server : '232',db : 'sl_h',table : 'kpi',});
+        log.info(JSON.parse(info).msg);
+      },
+
+     afterInsertRow: function( rowid, rowdata, rowelem ) {
+     let tr = $("#"+rowid);
+     $(tr).data("jqgrid.record_data", rowelem);
+     },
+
+
+*/
+
+    
+    async update_row_to_api(col_model, api='',_ids=['id'],row={}, data)
+    {
+        let self  = this;
+        let infos = [];        
+        if(api != '' && Object.keys(row).length > 0 )
+        {
+          let ids    =  {};
+          let values = {};          
+          if(row.inputData.oper == 'edit')
+          {
+            let changed = {};              
+            const tr = $("#"+row.rowid);
+            const rd = $(tr).data("jqgrid.record_data");              
+
+            if(row.inputData.oper == 'edit')
+            {
+              for(let i in _ids)
+              {
+                ids[_ids[i]] =  row.inputData[_ids[i]];
+              }
+            }
+            else
+            {
+              ids['id']= '0';
+            }
+
+
+            if(rd)
+            {
+              for(let i in row.inputData)
+              {
+                if(row.inputData.hasOwnProperty(i) && rd.hasOwnProperty(i))
+                {
+                  if(row.inputData[i] != rd[i])
+                  {
+                    changed[i] = row.inputData[i];
+                  } 
+                }
+              }
+            }
+            else
+            {
+              changed =row.inputData;
+            }    
+
+            for(let i in changed)
+            {
+              if( Object.keys(ids).indexOf(i) < 0  && i!= 'oper')      
+              {
+                const col_name = i;
+                let col_value = {};
+                col_value[col_name] = changed[i];
+                data['ids'] = ids;
+                data['values'] = col_value;
+                data['operator'] = 'edit';
+                const info = await self.post_json(api ,JSON.stringify(data));
+                infos.push(info);
+              }
+	    }
+          
+          }
+            else if(row.inputData.oper == 'add')
+           {
+              for(let i in row.inputData)
+              {
+                if(row.inputData[i] && i != 'id' && i != 'oper')
+                {
+                 values[i] = row.inputData[i];
+                }
+              }
+              data['ids'] = ids;
+              data['values'] = values;
+              data['operator'] = 'add';
+              let info = await self.post_json(api ,JSON.stringify(data));
+              infos.push(info);               
+            }  
+        }
+
+        return infos;
+}
+
+
+/**
+* Take your row id value and send it to your delete post API server 
+@alias module:Jqgrid_utils
+@param {string} - API URL like https://foo.com
+@param {array}  - id list, ids from the column header (required)
+@param {object} - settings - extra key:value to send to your server
+@example 
+afterDelRow: async function(rowid){
+  const _api = await get_api_url('sapir');
+  const api = _api + '/column2';
+  let info = {"msg":"failed"};
+  var jqu = new Jqgrid_utils(); 
+  info = await jqu.delete_row_to_api(col_model,api,[rowid],{
+  server : '232',
+  db : 'sl_h',
+  table : 'kpi',
+  operator: 'delete',
+  });
+   log.info(JSON.parse(info).msg); 	
+  },
+*/
+
+async delete_row_to_api(col_model,api='', ids=[], data={})
+{
+   let info = {"msg":"failed"};
+   let self = this;
+    if(api != '')
+    {
+        data['values'] = ids;
+        if(! data.hasOwnProperty("id"))
+        {
+          data['id'] = 'id';
+        }
+        info = await self.adelete_api(api,JSON.stringify(data));
+    }
+    return info;        
+}
+    
+
     
 
 /**
@@ -786,7 +935,13 @@ afterDelRow: async function(row)
 
 async adelete_api(url, json = false)
 {
-  const ctype = json ? "application/json;charset=UTF-8" : "application/x-www-form-urlencoded";
+  let ctype = "application/x-www-form-urlencoded";
+  let body = null;
+   if(json)
+   {
+     ctype = "application/json;charset=UTF-8" ;
+     body = json;
+   }    
   return new Promise((resolve, reject) =>
   {
     let xhr = new XMLHttpRequest();
@@ -794,12 +949,11 @@ async adelete_api(url, json = false)
     xhr.setRequestHeader("Content-type", ctype);
     xhr.onload = () => resolve(xhr.responseText);
     xhr.onerror = () => reject(xhr.statusText);
-    xhr.send(null);
+    xhr.send(body);
   });
 }
 
 
-
 /**
 * Async Post request used by the update_row function
 @alias module:Jqgrid_utils
@@ -872,6 +1026,99 @@ async hide_del_icon()
 }
 
 
+/**
+* Convert a cell into a link/url with data from another cell and spit the value by comma - CSV
+@alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - URL string 
+@param {string} - Column/Cell to use
+@param {string} - URL Attributes
+@param {object} - keys and fields value to use 
+@param {object} - format info
+@param {string} - seperator of the cell value to split (default is comma)
+@example 
+var jqu = new Jqgrid_utils();
+col_model = await jqu.add_link_details_csv(col_model, host + '/html/report.html' , 'tags','target="_blank"',{"tags":"tags"},',');
+
+*/
+    async add_link_details_csv(col_model, url, edit_field, attr = '', keys, format, seperator=',')
+{
+  let self = this;
+  if (url.indexOf('?') > -1)
+  {
+    url = url + '&';
+  }
+  else
+  {
+    url = url + '?';
+  }
+
+  for (let i = 0; i < col_model.length; i++)
+  {
+    if (col_model[i]['name'] === edit_field)
+    {
+      col_model[i]['formatter'] = function(cell_val, obj)
+      {
+        let key_val = cell_val;
+        const _cell_val = self.__cell_format(cell_val, format);
+        const a = _cell_val.split(seperator);
+        let cell_value = '';
+        for(let x in a)
+        {
+          const x_value = a[x].trim();
+          if(x_value)
+          {
+            if (typeof keys === 'object')
+            {
+              let pref = '';
+              for (let ii in keys)
+              {
+                let key = ii;
+                let v = keys[ii];
+                key_val = obj.rowData[v];
+                if (key_val)
+                {
+                  if (key.indexOf('=') !== -1)
+                  {
+                    pref = pref + '' + key + '' + encodeURIComponent(x_value) + '&';
+                  }
+                  else
+                  {
+                    pref = pref + '' + key + '=' + encodeURIComponent(x_value) + '&';
+                  }
+                }
+              }
+              if (pref.slice(-1) === '&')
+              {
+                pref = pref.slice(0, -1);
+              }
+                cell_value += '<a ' + attr + 'href="' + url + pref + '"> ' + x_value + '</a>' + seperator + ' ';
+              }
+            }
+	    cell_val = cell_value.trim();
+            if(cell_val.slice(-1) === seperator) //remove last seperator
+            {
+               cell_val = cell_val.slice(0, -1);
+            }
+	    
+          }
+
+        if(cell_val)
+        {
+          return cell_val;
+        }
+        else
+        {
+          return _cell_val;
+        }
+      };
+    }
+
+  }
+
+  return col_model;
+}
+
 
 /**
 * Convert a cell into a link/url with data from another cell

package/jqgrid_utils.js

@@ -21,6 +21,155 @@ module.exports = class Vanilla_website_utils
 
   }
 
+/**
+* Takes the updated columns data and send it to your API post server
+@alias module:Jqgrid_utils
+@param {string} - API URL like https://foo.com (required)
+@param {array}  - id list, ids from the column header (required)
+@param {object} - settings - extra key:value to send to your server 
+
+@example 
+     },
+      afterSetRow: async function(row)
+      {
+        const _api = await get_api_url('sapir');
+        const api = _api + '/column2';
+        let info = {"msg":"failed"};
+        var jqu = new Jqgrid_utils();
+        info = await jqu.update_row_to_api(col_model,api,['id'],row,{server : '232',db : 'sl_h',table : 'kpi',});
+        log.info(JSON.parse(info).msg);
+      },
+
+     afterInsertRow: function( rowid, rowdata, rowelem ) {
+     let tr = $("#"+rowid);
+     $(tr).data("jqgrid.record_data", rowelem);
+     },
+
+
+*/
+
+    
+    async update_row_to_api(col_model, api='',_ids=['id'],row={}, data)
+    {
+        let self  = this;
+        let infos = [];        
+        if(api != '' && Object.keys(row).length > 0 )
+        {
+          let ids    =  {};
+          let values = {};          
+          if(row.inputData.oper == 'edit')
+          {
+            let changed = {};              
+            const tr = $("#"+row.rowid);
+            const rd = $(tr).data("jqgrid.record_data");              
+
+            if(row.inputData.oper == 'edit')
+            {
+              for(let i in _ids)
+              {
+                ids[_ids[i]] =  row.inputData[_ids[i]];
+              }
+            }
+            else
+            {
+              ids['id']= '0';
+            }
+
+
+            if(rd)
+            {
+              for(let i in row.inputData)
+              {
+                if(row.inputData.hasOwnProperty(i) && rd.hasOwnProperty(i))
+                {
+                  if(row.inputData[i] != rd[i])
+                  {
+                    changed[i] = row.inputData[i];
+                  } 
+                }
+              }
+            }
+            else
+            {
+              changed =row.inputData;
+            }    
+
+            for(let i in changed)
+            {
+              if( Object.keys(ids).indexOf(i) < 0  && i!= 'oper')      
+              {
+                const col_name = i;
+                let col_value = {};
+                col_value[col_name] = changed[i];
+                data['ids'] = ids;
+                data['values'] = col_value;
+                data['operator'] = 'edit';
+                const info = await self.post_json(api ,JSON.stringify(data));
+                infos.push(info);
+              }
+	    }
+          
+          }
+            else if(row.inputData.oper == 'add')
+           {
+              for(let i in row.inputData)
+              {
+                if(row.inputData[i] && i != 'id' && i != 'oper')
+                {
+                 values[i] = row.inputData[i];
+                }
+              }
+              data['ids'] = ids;
+              data['values'] = values;
+              data['operator'] = 'add';
+              let info = await self.post_json(api ,JSON.stringify(data));
+              infos.push(info);               
+            }  
+        }
+
+        return infos;
+}
+
+
+/**
+* Take your row id value and send it to your delete post API server 
+@alias module:Jqgrid_utils
+@param {string} - API URL like https://foo.com
+@param {array}  - id list, ids from the column header (required)
+@param {object} - settings - extra key:value to send to your server
+@example 
+afterDelRow: async function(rowid){
+  const _api = await get_api_url('sapir');
+  const api = _api + '/column2';
+  let info = {"msg":"failed"};
+  var jqu = new Jqgrid_utils(); 
+  info = await jqu.delete_row_to_api(col_model,api,[rowid],{
+  server : '232',
+  db : 'sl_h',
+  table : 'kpi',
+  operator: 'delete',
+  });
+   log.info(JSON.parse(info).msg); 	
+  },
+*/
+
+async delete_row_to_api(col_model,api='', ids=[], data={})
+{
+   let info = {"msg":"failed"};
+   let self = this;
+    if(api != '')
+    {
+        data['values'] = ids;
+        if(! data.hasOwnProperty("id"))
+        {
+          data['id'] = 'id';
+        }
+        info = await self.adelete_api(api,JSON.stringify(data));
+    }
+    return info;        
+}
+    
+
     
 
 /**
@@ -785,7 +934,13 @@ afterDelRow: async function(row)
 
 async adelete_api(url, json = false)
 {
-  const ctype = json ? "application/json;charset=UTF-8" : "application/x-www-form-urlencoded";
+  let ctype = "application/x-www-form-urlencoded";
+  let body = null;
+   if(json)
+   {
+     ctype = "application/json;charset=UTF-8" ;
+     body = json;
+   }    
   return new Promise((resolve, reject) =>
   {
     let xhr = new XMLHttpRequest();
@@ -793,12 +948,11 @@ async adelete_api(url, json = false)
     xhr.setRequestHeader("Content-type", ctype);
     xhr.onload = () => resolve(xhr.responseText);
     xhr.onerror = () => reject(xhr.statusText);
-    xhr.send(null);
+    xhr.send(body);
   });
 }
 
 
-
 /**
 * Async Post request used by the update_row function
 @alias module:Jqgrid_utils
@@ -871,6 +1025,99 @@ async hide_del_icon()
 }
 
 
+/**
+* Convert a cell into a link/url with data from another cell and spit the value by comma - CSV
+@alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - URL string 
+@param {string} - Column/Cell to use
+@param {string} - URL Attributes
+@param {object} - keys and fields value to use 
+@param {object} - format info
+@param {string} - seperator of the cell value to split (default is comma)
+@example 
+var jqu = new Jqgrid_utils();
+col_model = await jqu.add_link_details_csv(col_model, host + '/html/report.html' , 'tags','target="_blank"',{"tags":"tags"},',');
+
+*/
+    async add_link_details_csv(col_model, url, edit_field, attr = '', keys, format, seperator=',')
+{
+  let self = this;
+  if (url.indexOf('?') > -1)
+  {
+    url = url + '&';
+  }
+  else
+  {
+    url = url + '?';
+  }
+
+  for (let i = 0; i < col_model.length; i++)
+  {
+    if (col_model[i]['name'] === edit_field)
+    {
+      col_model[i]['formatter'] = function(cell_val, obj)
+      {
+        let key_val = cell_val;
+        const _cell_val = self.__cell_format(cell_val, format);
+        const a = _cell_val.split(seperator);
+        let cell_value = '';
+        for(let x in a)
+        {
+          const x_value = a[x].trim();
+          if(x_value)
+          {
+            if (typeof keys === 'object')
+            {
+              let pref = '';
+              for (let ii in keys)
+              {
+                let key = ii;
+                let v = keys[ii];
+                key_val = obj.rowData[v];
+                if (key_val)
+                {
+                  if (key.indexOf('=') !== -1)
+                  {
+                    pref = pref + '' + key + '' + encodeURIComponent(x_value) + '&';
+                  }
+                  else
+                  {
+                    pref = pref + '' + key + '=' + encodeURIComponent(x_value) + '&';
+                  }
+                }
+              }
+              if (pref.slice(-1) === '&')
+              {
+                pref = pref.slice(0, -1);
+              }
+                cell_value += '<a ' + attr + 'href="' + url + pref + '"> ' + x_value + '</a>' + seperator + ' ';
+              }
+            }
+	    cell_val = cell_value.trim();
+            if(cell_val.slice(-1) === seperator) //remove last seperator
+            {
+               cell_val = cell_val.slice(0, -1);
+            }
+	    
+          }
+
+        if(cell_val)
+        {
+          return cell_val;
+        }
+        else
+        {
+          return _cell_val;
+        }
+      };
+    }
+
+  }
+
+  return col_model;
+}
+
 
 /**
 * Convert a cell into a link/url with data from another cell

package/package.json

@@ -29,5 +29,5 @@
   {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "1.20.0"
+  "version": "1.22.0"
 }