@presspage/common-js
v1.5.0
Published
A common library of javascript functions including node logging
Downloads
19
Maintainers
tbearliveReadme
Installation
To install,
npm i @presspage/common-jsGetting Started
Tested for use with Electron. Create a preload.js and in your electron window definition add the following webPreferences,
mainWindow = new BrowserWindow({
width: 1072,
height: 910,
webPreferences: {
nodeIntegration: false,
contextIsolation: true, // protect against prototype pollution
enableRemoteModule: false, // turn off remote
preload: path.join(__dirname, 'preload.js')
}
})Inside the preload.js,
const {contextBridge} = require("electron");
const {$, id, listener, show, hide, showParent, hideParent, showAlert, editable, http_post, wp_ajax, webdevencrypt, loadScript, getRSS, replaceText, setValue, replaceHTML, appendHTML, todayAsISO8601, Export2Doc} = require("@presspage/common-js");
contextBridge.exposeInMainWorld(
"common", {$: $,
id: id,
listener: listener,
show: show,
hide: hide,
showParent: showParent,
hideParent: hideParent,
showAlert: showAlert,
editable: editable,
http_post: http_post,
wp_ajax: wp_ajax,
webdevencrypt: webdevencrypt,
loadScript: loadScript,
getRSS: getRSS,
replaceText: replaceText,
setValue: setValue,
replaceHTML: replaceHTML,
appendHTML: appendHTML,
todayAsISO8601: todayAsISO8301,
Export2Doc: Export2Doc
}
);Then inside your views/index.html, just invoke the javascript functions on the window object,
window.common.listener("element_id","click",function(){ alert("It works!"); });Common JavaScript Library Functions
$ - a jQuery-like representation for the object
id
Obtain the object reference of an element by the ID,
var button = id("button_id");
button.setAttribute("disabled","disabled");listener
Use to add an action handler to an element,
listener('element_id','click',function(e){
// event handling logic
});show
Makes an element visible,
show('element_id');hide
Makes an element invisible,
hide('element_id');showParent
Make the parent of an element visible
showParent('element_id');where element_id is the child of the parent to show
hideParent
Make the parent of an element invisible
hideParent('element_id');where element_id is the child of the parent to be hidden
showAlert
Shows an modal div (see w3schools.com about W3.CSS Modal Dialogs)
showAlert(page, title, message);editable
Makes an element editable,
editabled('element_id',edit_flag);when edit_flag is true, the element specified by the element_id is made editable, otherwise it is made read only.
http_post
Invokes a HTTP POST request,
http_post(url, params, function(results){
// handling results returned?
});wp_ajax
Invokes an WordPress AJAX request without using jQuery,
wp_ajax(url, action, params, function(results){
// handle return data, if any?
});webdevencrypt
JavaScript encryption and decryption,
setEncrypt(plaintext, passcode);
setDecrypt(encrypted, passcode);loadScript
Loads additional JavaScript files dynamically,
loadScript('`<full url of the javascript file>`');getRSS
Retrieves an RSS feed and displays in a list element,
getRSS('`<url of rss feed>`','element_id of the list element');replaceText
Replaces text in a specified element,
replaceText(selector, "text");setValue
Set the value of a specified element,
setValue(selector, "new value");replaceHTML
Replaces the element HTML content,
replaceHTML(selector, "`<html>`");appendHTML
Appends additional HTML to an element HTML content,
appendHTML(selector, "`<html>`");todayAsISO8601
Retrieves current date as ISO 8601 aka YYYY-MM-DD formant,
var today = todayAsISO8601();Export2Doc
Saves a HTML div contents as a DOCX file,
Export2Doc('div element containing HTML content','filename.docx');Logging
Logging is important and creating persistent logs is mandatory for debugging and including line numbers in the log file makes the debugging process easier. Logging is accomplished by invoking one of three methods: info, warn or error. Logging should be used for logging Node actions and NOT browser actions.
setLogPath
Sets the LOG_PATH and LOG_BASENAME (without the .log extension), with the default as the Operating System TMP directory and BASENAME as combined
setLogPath("/var/log", "program_log")getLogPath
Gets the current full log path name
getLogPath()returns the full pathname of the LOG file)
/var/log/progrsam_log.logtoggleDebug
Toggles DEBUG flag to turn on/off sonsole.error messages
toggleDebug()returns the current state of the DEBUG flag
listLogFiles
Lists all .log files in the LOG_PATH
listLogFiles()returns an array of log files found
[
"combined.log"
]deleteLogFile
Deletes the specified log file, if exists?
deleteLogFile("combined_1726044879567.log")returns a status object whether the log file wa deleted successfully or not found,
{
"success": true|false,
"message": "deleted log file name combined_1726044879567.log successfully."||"combined_1726044879567.log does not exist?"
}getLineNumber
In C/C++, has a preprocessor element known as __ LINE __, which displays the current line number. Node has no such function. Instead an Error execption is thrown which obtains the line number from the staxk trace.
getLineNumber())backup
Backups the current log file to LOG_BASENAME_{timestamp}.log
backup()returns the BACKUP file name
combined_1726044879567.loginfo
For logging informational messages and places an [INFO] tag on the logging line.
info(`${path.basename(__filename)}[${getLineNumber()}]: An informational message is logged`)in the log file
2024-09-11T22:42:10.167Z [INFO] index.js[1]: An informational message is loggedto log an object or an array, stringify the object/array using JSON.stringify(...)
warn
For logging warning messages and places an [WARN] tag on the logging line.
warn(`${path.basename(__filename)}[${getLineNumber()}]: A warning message is logged`)in the log file
2024-09-11T22:42:10.167Z [WARN] index.js[1]: A warning message is loggedto log an object or an array, stringify the object/array using JSON.stringify(...)
error
For logging critical messages and places an [ERROR] tag on the logging line.
error(`${path.basename(__filename)}[${getLineNumber()}]: A critical error occurred`)in the log file
2024-09-11T22:42:10.167Z [ERROR] index.js[1]: A critical error occurredto log an object or an array, stringify the object/array using JSON.stringify(...)
Contact Us
The best contact method is via email at [email protected]
License
Creative Commons Attribution 4.0