Skip to content

Latest commit

 

History

History
240 lines (176 loc) · 7.97 KB

files.md

File metadata and controls

240 lines (176 loc) · 7.97 KB

Modules

app

Here is the main logic. We define routes, cors, session and error handling through out the app

server

Here is the initialization of the server. We define ports, certificates and error handling

routes/api

Handle all of the https://{domain}/api/ routes

routes/index

Handle all of the public front end routes

models/sense-bot

Handle all of models for route sense-bot

routes/api/sense-bot

Handle all of the https://{domain}/api/sense-bot/ routes

models/utilities/DB

main wrapper for connecting and quering the MySql Database

models/utilities/Enigma

Main wrapper for Enigma.js

models/utilities/Logger

Winston Logger Utility. Saves the server logs based on the date.

models/sense-bot/Db

Wrapper of the main DB class with the config file

models/sense-bot/Skype

The main Model for all of the Microsoft Channels. Stores and retrieves users from the database

models/sense-bot/Telegram

The main Model for all of the Microsoft Channels. Stores and retrieves users from the database

routes/api/sense-bot/telegram

Handle all of the https://{domain}/api/sense-bot/telegram/ routes

app

Here is the main logic. We define routes, cors, session and error handling through out the app

Author: [email protected]

app~api

Define all of the paths

Kind: inner constant of app

app~whitelist

Define CORS for all pages.

Kind: inner constant of app

server

Here is the initialization of the server. We define ports, certificates and error handling

Author: [email protected]

server~certFolder

Create HTTP/HTTPS server.

Kind: inner property of server

server~httpsServer

Create the server

Kind: inner constant of server

server~normalizePort()

Normalize a port into a number, string, or false.

Kind: inner method of server

server~onError()

Event listener for HTTP/HTTPS server "error" event.

Kind: inner method of server

routes/api

Handle all of the https://{domain}/api/ routes

Author: [email protected]

routes/index

Handle all of the public front end routes

Author: [email protected]

models/sense-bot

Handle all of models for route sense-bot

Author: [email protected]

routes/api/sense-bot

Handle all of the https://{domain}/api/sense-bot/ routes

Author: [email protected]

models/utilities/DB

main wrapper for connecting and quering the MySql Database

Author: [email protected]

Param Type Description
config object The configuration for host, database name, username and password

models/utilities/Enigma

Main wrapper for Enigma.js

Author: [email protected]

Param Type Description
host string Qlik Sense DNS
appId string QVF ID
expr string Sense Expression to create the Kpi via a Hypercube
userDirectory string The UserDirectory for AutoTicketing
userId string The UserId for AutoTicketing

models/utilities/Logger

Winston Logger Utility. Saves the server logs based on the date.

Author: [email protected]

Param Type Description
host string Qlik Sense DNS
appId string QVF ID
expr string Sense Expression to create the Kpi via a Hypercube
userDirectory string The UserDirectory for AutoTicketing
userId string The UserId for AutoTicketing

models/sense-bot/Db

Wrapper of the main DB class with the config file

Author: [email protected]
Todo

  • remove the wrapper and have classes communicate directly with models/utilities/DB.js
Param Type Description
config object The configuration for host, database name, username and password

models/sense-bot/Skype

The main Model for all of the Microsoft Channels. Stores and retrieves users from the database

Author: [email protected]

Param Type Description
all boolean return all of the users in the Database
count integer Return a total of all the users from the sql query
userId integer get specific user
userUid string get specific user
limit integer limit results
username string Find user
channelId integer Specific channel
userData object The message specific data for mass Instant Messaging

models/sense-bot/Telegram

The main Model for all of the Microsoft Channels. Stores and retrieves users from the database

Author: [email protected]

Param Type Description
all boolean return all of the users in the Database
count integer Return a total of all the users from the sql query
userId integer get specific user
userUid string get specific user
limit integer limit results
username string Find user
channelId integer Specific channel
userData object The message specific data for mass Instant Messaging

routes/api/sense-bot/telegram

Handle all of the https://{domain}/api/sense-bot/telegram/ routes

Author: [email protected]
Todo

  • move the qvfs into a config file

routes/api/sense-bot/telegram~qvf

Connection parameters for the QVFs

Kind: inner property of routes/api/sense-bot/telegram
Todo

  • move the qvfs into a config file