sgapps-server
Advanced tools
A network solution for web applications.
Since this application is fully compatible with nodejs-mvc, I decided to replace nodejs-mvc with this new approach. SGApps Server is completely new solution, that will be improved continuously thats why I will work on this project instead of nodejs-mvc
by Sergiu Gordienco < sergiu.gordienco@sgapps.io >
the license is Apache-2.0, so one of the requirements is to include reference to this project
const { SGAppsServer } = require('sgapps-server');
const app = new SGAppsServer();
app.get('/', function (request, response) {
response.send('hello world')
});
app.server().listen(8080, () => {
app.logger.log('Server is running on port 8080');
});
// ========================================
// Start your 🚀 Web-Server app Extended
// ========================================
const { SGAppsServer } = require('sgapps-server');
const app = new SGAppsServer();
app.get('/', function (request, response) {
response.send('hello world session#' + request.session.id);
})
app.whenReady.then(() => {
app.SessionManager.cookie = 'ssid';
app.SessionManager.SESSION_LIFE = 120; // seconds
app.server().listen(8080, () => {
app.logger.log('Server is running on port 8080');
});
}, app.logger.error);
const { SGAppsServer } = require('sgapps-server');
const app = new SGAppsServer({
decorators: [
require('sgapps-server/decorators/access-logger')
]
});
app.AccessLoggerPaths['default'] = {
isEnabled: true,
path: configuration.database.filesystem.logs + 'default/{year}/{month}/data-{worker-id}.log'
};
app.whenReady.then(() => {
app.server().listen(8080, () => {
app.logger.log('Server is running on port 8080');
});
}, app.logger.error);
const { SGAppsServer } = require('sgapps-server');
const app = new SGAppsServer({
decorators: [
require('sgapps-server/decorators/access-logger')
]
});
app.AccessLoggerPaths['default'] = {
isEnabled: true,
// modify the row
waitAllHandlers: true,
path: configuration.database.filesystem.logs + 'default/{year}/{month}/data-{worker-id}.log',
handle: function (data) {
// used for updating of filtering data
console.info("LOGGER Data", data);
return data.match(/\.txt\"/) ? null : data;
}
};
app.get(/^\/api\//, function () {
// log all request from api path into separate file
request.AccessLoggerPaths['api'] = {
isEnabled: true,
path: 'api/access.log'
}
})
app.whenReady.then(() => {
app.server().listen(8080, () => {
app.logger.log('Server is running on port 8080');
});
}, app.logger.error);
Type: function (request, options)
request SGAppsServerRequestoptions SGAppsSessionManagerOptionsType: number
Type: string
Session was received from previously saved cookie
Type: boolean
Type: string
Type: SGAppsSessionManagerOptions
Type: object
Type: function ()
Type: function (options)
Type: object
_fs FSLibraryType: TemplateManagerViewer
Type: function (templateName): boolean
templateName stringType: function (templateName)
templateName stringType: function (templateName, filePath)
Type: function (templates)
Type: function (templateName): TemplateManagerTemplate
templateName stringType: function (response, templateName, vars)
response SGAppsServerResponsetemplateName stringvars Object<string, any>?Type: function (request, server)
request IncomingMessageserver SGAppsServerType: IncomingMessage
post data buffer cache
Type: Buffer
Type: function (url): MountUpdatedURL
url stringType: object
original stringorigin stringdomain string full domain of urldomain_short string domain without "www."pathname string url's pathnamereqQuery string url's query from '?'protocol string url.split('://')[0]url stringurl_p stringisIp string domain or IpType: object
Type: string
Type: object
Type: Array<SGAppsServerRequestPostDataItem>
Type: SGAppsServerRequestCookie
Type: number
Examples:
// changing max post size to 4Mb
request.MAX_POST_SIZE = 4 * 1024 * 1024;
// reset max post size to global value
request.MAX_POST_SIZE = -1;
Type: Object<string, Array<SGAppsServerRequestFile>>
Type: Array<SGAppsServerRequestFile>
Array of functions to be called on response end
Array of functions to be called on response end
Type: SGAppsServerRequest.RequestParams
Array of functions to be called on response end
Type: object
complete boolean The message.complete property will be true if a complete HTTP message has been received and successfully parsed.aborted boolean The message.aborted property will be true if the request has been aborted.closed boolean Indicates that the underlying connection was closed._DEBUG_MAX_HANDLER_EXECUTION_TIME number? define a bigger request timeoutAutomatically used procedure for parsing formData field name if option server._options._REQUEST_FORM_PARAMS_DEEP_PARSE = true. it's by default enabled but can be disabled when needed
Type: function (container, fieldName, fieldData, options)
container objectfieldName stringfieldData anyoptions object?
options.transform2ArrayOnDuplicate boolean (optional, default false)Examples:
paramsContainer = {};
request._parseDeepFieldName(paramsContainer, 'test[arr][data]', 2);
request._parseDeepFieldName(paramsContainer, 'test[arr][]', new Date());
request._parseDeepFieldName(paramsContainer, 'test[arr][]', 2);
request._parseDeepFieldName(paramsContainer, 'test[data]', 2);
// if _debug enabled warns will be emitted
// [Warn] [Request._parseDeepFieldName] Writing Array field "test[arr][]" into a object
// [Warn] [Request._parseDeepFieldName] Overwriting field "test[data]" value
console.log(paramsContainer)
{
"test": {
"arr": {
"1": "2021-02-12T21:23:01.913Z",
"2": 2,
"data": 2
},
"data": 2
}
}
paramsContainer = {};
request._parseDeepFieldName(paramsContainer, 'test[arr][]', new Date());
request._parseDeepFieldName(paramsContainer, 'test[arr][]', 2);
request._parseDeepFieldName(paramsContainer, 'test[arr][data]', 2);
request._parseDeepFieldName(paramsContainer, 'test[data]', 2);
// if _debug enabled warns will be emitted
// [Warn] [Request._parseDeepFieldName] Converting array to object due incorrect field "test[arr][data]" name
console.log(paramsContainer)
{
"test": {
"arr": {
"0": "2021-02-12T21:34:47.359Z",
"1": 2,
"data": 2
},
"data": 2
}
}
paramsContainer = {};
request._parseDeepFieldName(paramsContainer, 'test[arr][]', new Date());
request._parseDeepFieldName(paramsContainer, 'test[arr][]', 2);
request._parseDeepFieldName(paramsContainer, 'test[data]', 2);
console.log(paramsContainer)
{
"test": {
"arr": [
"2021-02-12T21:26:43.766Z",
2
],
"data": 2
}
}
Type: SGAppsServerRequestSession
request's post received data
Type: (Object<(string | number), string> | Array<string>)
Type: function (route, url, strictRouting, _cache)
route RequestPathStructureurl stringstrictRouting boolean_cache objectType: function (response, server)
response ServerResponseserver SGAppsServerType: ServerResponse
Type: function (filePath, callback)
filePath stringcallback SGAppsServerErrorOnlyCallback represents a Function(Error)Type: function (data, options)
Type: function (error, options)
Array of functions to be called on response end
if it returns false than the action was not possible
Type: function (url, options)
Array of functions to be called on response end
Type: object
finished boolean will be true if response.end() has been called.sent boolean Is true if all data has been flushed to the underlying system, immediately before the 'finish' event is emitted.closed boolean Indicates that the the response is completed, or its underlying connection was terminated prematurely (before the response completion).Type: Function
error ErrorType: function (filePath, fileName, callback, options)
filePath stringfileName stringcallback SGAppsServerResponse.pipeFileStaticCallbackoptions object?
Type: function (statusCode)
statusCode numberType: object
Type: function (options)
Type: FaceboxTemplate
Type: boolean
Type: function (code, vars, virtualFilePath, callback)
Type: function (response, view, vars)
response SGAppsServerResponseview TemplateManagerTemplatevars Object<string, any>Type: object
Type: function (config)
config SGAppsServerEmail.Config optional configuration objectExample:
Example:
var Email = require('path/to/email').Email
var myMsg = new Email(
{ from: 'me@example.com'
, to: 'you@example.com'
, subject: 'Knock knock...'
, body: "Who's there?"
})
myMsg.send(function(err){
...
})
Send email
Type: function (callback)
callback SGAppsServerEmail.Callbackget message options
Type: object
timeout numbergetter generate encoded body
Type: string
getter generate all email structure
Type: string
check if email is valid
Type: function (callback)
callback SGAppsServerEmail.CallbackEmail : Sends email using the sendmail command.
Note: sendmail must be installed: see http://www.sendmail.org/
Type: object
to (Array<string> | string) Email address(es) to which this msg will be sentdebug boolean?from string? Email address from which this msg is sent. If not set defaults to the exports.from global setting.replyTo string? Email address to which replies will be sent. If not
set defaults to fromcc (string | Array<string>)? Email address(es) who receive a copybcc (string | Array<string>)? Email address(es) who receive a blind copysubject string The subject of the emailbody string The message of the emailbodyType string? Content type of body. Only valid option is
'html' (for now). Defaults to text/plain.altText string? If bodyType is set to 'html', this will be sent
as the alternative text.timeout number? Duration in milliseconds to wait before killing the
process. If not set, defaults to exports.timeout global setting.path string? Optional path to the sendmail executable.Email address from which messages are sent. Used
when from was not set on a message.
Type: function (email): string
email stringType: function (email): boolean
email stringDuration in milliseconds to wait before
killing the process. Defaults to 3000. Used when timeout is not set
on a message.
Type: function (milliseconds): number
milliseconds numberType: Function
err ErrorType: object
Type: object
Type: string
Type: function (options)
Type: boolean
Type: number
Type: function (text, vars, env)
Type: function (filePath, vars, callback)
Type: function (code, vars, callback, virtualFilePath)
Type: function ()
Type: function (name, options): string
Type: function (name, value, options, skipErrors): string
name stringvalue stringoptions object?
options.secure boolean (optional, default false)options.secureProxy boolean?options.signed boolean?options.path string (optional, default "/")options.expires Date?options.domain string?options.httpOnly boolean (optional, default true)options.sameSite boolean (optional, default false)options.secure boolean (optional, default false)options.overwrite boolean (optional, default false)skipErrors boolean (optional, default false)Type: function ()
Type: Function
err Errorrequest SGAppsServerRequestresponse SGAppsServerResponseserver SGAppsServerType: Function
err ErrorType: function ()
Type: function ()
Type: object
Type: object
Type: Function
request SGAppsServerRequestresponse SGAppsServerResponseserver SGAppsServercallback functionHTTP Server for high performance results
Type: function (options)
options object?
options.server Server?options.strictRouting boolean (optional, default true)options.debug boolean (optional, default true)options._DEBUG_MAX_HANDLER_EXECUTION_TIME object console shows an warn if handler is executed more than ( works in debug mode ) (optional, default 500)options._DEBUG_REQUEST_HANDLERS_STATS object console shows an warn if handler is executed more than ( works in debug mode ) (optional, default false)options._REQUEST_FORM_PARAMS_DEEP_PARSE boolean parse formData field names to create deep object request.body (optional, default true)options.decorators Array<SGAppsServerDecorator>?Examples:
// ================================
// Start your 🚀 Web-Server app
// ================================
const { SGAppsServer } = require('@sgapps.io/server');
const app = new SGAppsServer();
app.get('/', function (req, res) {
res.send('hello world')
})
app.server().listen(8080, () => {
app.logger.log('Server is running on port 8080');
})
// ========================================
// Start your 🚀 Web-Server app Extended
// ========================================
const { SGAppsServer } = require('@sgapps.io/server');
const app = new SGAppsServer();
app.get('/', function (req, res) {
res.send('hello world')
})
app.whenReady.then(() => {
app.SessionManager.cookie = 'ssid';
app.SessionManager.SESSION_LIFE = 120; // seconds
app.server().listen(8080, () => {
app.logger.log('Server is running on port 8080');
})
}, app.logger.error);
Type: object
COOKIES_KEY string_enabled boolean? if is changed to false server will not decorate requests with cookie managerhandle function (SGAppsServerRequest, SGAppsServerResponse): objectType: Server
Type: Array<SGAppsServerDecorator>
Type: TemplateManager
Type: SGAppsServerOptions
Type: SGAppsServerShared
Type: LoggerBuilder
Type: function (config): SGAppsServerEmail
config SGAppsServerEmail.ConfigType: string
Type: SGAppsSessionManager
Type: object
Type: object
Type: ResourcesExtensions
Type: Object<string, SGAppsServerDictionary>
default value is 16 Kb » 16 * 1024
Type: number
Type: Promise<SGAppsServer>
Type: function (request, response, callback)
request SGAppsServerRequestresponse SGAppsServerResponsecallback SGAppsServerDictionaryRunCallBackType: function (request, response, err)
request SGAppsServerRequestresponse SGAppsServerResponseerr Error?Type: function (request, response, path, callback, options)
request SGAppsServerRequestresponse SGAppsServerResponsepath stringcallback SGAppsServerErrorCallBackoptions object? (optional, default {timeout:0,autoIndex:[]})
Type: function (request, response, callback)
request IncomingMessageresponse ServerResponsecallback SGAppsServerDictionaryRunCallBack?Type: function (): Server
Type: function (path, handlers): SGAppsServer
path (string | RequestHandler)handlers ...RequestHandler?The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server.
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandlerThe GET method requests a representation of the specified resource. Requests using GET should only retrieve data.
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandlerThe HEAD method asks for a response identical to that of a GET request, but without the response body.
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandlerThe PUT method replaces all current representations of the target resource with the request payload.
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandlerThe TRACE method performs a message loop-back test along the path to the target resource.
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandlerThe DELETE method deletes the specified resource.
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandlerThe OPTIONS method is used to describe the communication options for the target resource.
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandlerThe CONNECT method establishes a tunnel to the server identified by the target resource.
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandlerThe PATCH method is used to apply partial modifications to a resource.
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandleradd handler to all methods
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandleradd final handler to all methods, last added is first
Type: function (path, handlers): SGAppsServer
path RequestPathStructurehandlers ...RequestHandlerType: function (options): SGAppsServerHandlerPostData
options object?
Pretty CLI Logger, with possibility to replace default nodejs' console logger
Type: function ()
Examples:
// =============================
// Use Logger as 💻 instance
// =============================
const { LoggerBuilder } = require('@sgapps.io/server');
const logger = new LoggerBuilder();
logger.log("Hello world");
// replace default console
const { LoggerBuilder } = require('@sgapps.io/server');
const logger = new LoggerBuilder();
logger.decorateGlobalLogger();
console.log("Console Messages are decorated now");
this parameter may be changed if you decide to change decoration schema
Type: string
Example:
// Insert an message in VT100 format
logger._format = "\x1b[7m {{timestamp}} [{{TYPE}}] <{{title}}> {{file}}:{{line}} ({{method}}){{stack}}\x1b[7m";
Type: boolean
Type: Array<headerFormatter>
Type: function (ref, indent, separator)
Type: function (messages)
messages ...anyType: function (messages)
messages ...anyType: function (messages)
messages ...anyType: function (messages)
messages ...anyType: function (callback, message)
callback LoggerBuilderPromptmessage (string | Buffer)Example:
logger.prompt("rerun tests? [y/n]: ", function (err, buffer) {
// trim spaces from response
var response = buffer.toString().replace(/^\s*(.*?)\s*$/, '$1');
if (response === 'y') {
// write your code
}
});
Type: function ()
Type: object
Type: Function
info headerFormatterInfoType: object
key stringpath RequestPathStructurehandlers Array<RequestHandler>a dictionary for storing
Type: function (options)
options object?
Type: Array<RequestPathStructureMap>
Type: Object<string, Array<RequestHandler>>
Type: function (path): string
path RequestPathStructureType: function (path, handlers)
path RequestPathStructurehandlers Array<RequestHandler>Example:
server.get('/', (req, res) => {
res.send('root');
})
// will match "test" "best", everything with est
server.get(/.*est/, (req, res) => {
res.send('root');
})
server.get('/:name/:surname', (req, res) => {
const { name, surname } = req.params;
res.send(`Hi ${name} ${surname}`);
})
// apply rules with regexp emulation, they are marked with "^" in the start
server.get('^/:name([a-z]+)/:age(\d+)', (req, res, next) => {
const { name, age } = req.params;
if (age < 18) {
res.send(`Hi ${name}, you are not allowed`);
} else {
next()
}
})
// apply rules with regexp emulation, they are marked with "^" in the start
server.get('^/([a-z]+)/', (req, res, next) => {
const { name, age } = req.params;
if (age < 18) {
res.send(`Hi ${name}, you are not allowed`);
} else {
next()
}
})
// add regular expression with group names
server.get('^/(?<test>[a-z]+)/', (req, res, next) => {
const { test } = req.params;
res.send(`param: ${test}`);
})
server.get('/', (req, res) => {
res.send('root');
})
Type: function (request, response, server, callback)
request SGAppsServerRequestresponse SGAppsServerResponseserver SGAppsServercallback SGAppsServerDictionaryRunCallBackType: Function
request SGAppsServerRequestresponse SGAppsServerResponsenext functionType: object
server Server?strictRouting boolean?_DEBUG_MAX_HANDLER_EXECUTION_TIME number?_DEBUG_REQUEST_HANDLERS_STATS boolean?_REQUEST_FORM_PARAMS_DEEP_PARSE boolean? parse formData field names to create deep object request.bodyType: function (server, options)
server SGAppsServeroptions SGAppsSessionManagerOptions?Type: SGAppsSessionManagerOptions
Type: boolean
Type: Object<string, SGAppsServerRequestSessionCache>
Type: function ()
Type: function (request)
request SGAppsServerRequestType: function (request, response, server, callback)
request SGAppsServerRequestresponse SGAppsServerResponseserver SGAppsServercallback functionType: Function
request SGAppsServerRequestresponse SGAppsServerResponseserver SGAppsServerType: function (request, response)
request IncomingMessageresponse ServerResponseType: function (request, socket, data)
request IncomingMessagesocket Duplexdata BufferType: Function
message BufferType: Function
request SGAppsServerRequestresponse SGAppsServerResponsenext functionFAQs
SGApps Network Server
The npm package sgapps-server receives a total of 23 weekly downloads. As such, sgapps-server popularity was classified as not popular.
We found that sgapps-server demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.