1.0.9 • Published 7 years ago

mobiweb-nodejs-modules v1.0.9

Weekly downloads
3
License
ISC
Repository
github
Last release
7 years ago

Mobiweb Node.Js Modules

npm.io

Mobiweb basic modules utilities for node.js

Installation

npm

npm install mobiweb-nodejs-modules

git

git clone https://github.com/soravmobi/mobiweb-nodejs-modules.git

npmjs

https://www.npmjs.com/package/mobiweb-nodejs-modules

Usage

Basic modules like user signup, verify account, login, social login, frogot password, reset password & other modules also.

  • First Import SQL file, into your MySQL database.
var mobiweb = require('mobiweb-nodejs-modules');

config -> constant.js

  • Here we are managing all constants like database table name, defualt messages, notifiction details, site limitations etc.

custom (helpers) -> custom.js

  • Here we are managing all custom functions like user authorization, create image thumbnail, unlink file, get user profile, also having other functions also.

model (DB queries) -> model.js

  • Here we are managing all database queries, no need to write whole query only need to put table name, where conditions, order by, order fields other functionality also.

For Signup

app.post('/user/signup', function (req,res) {
    mobiweb.userSignup(req,res);
});


#### Required Parameters

* userFirstName   - [FIRST NAME]
* userLastName    - [LAST NAME]
* userEmail       - [UNIQUE EMAIL ID]
* userPassword    - [MD5 - ALPHA NUMERIC & 1 SPECIAL CHARACTER LIKE - Mobiweb@123]
* userGender      - [MALE,FEMALE,OTHER]
* userDOB         - [Y-M-D Format]
* userDeviceToken - [USER DEVICE TOKEN]
* userDeviceType  - [ANDROID,IOS]
* userDeviceId    - [UNIQUE DEVICE ID]

#### Note:- A temporary verification code will send on registered email id.

For Login

app.post('/user/login', function (req,res) {
    mobiweb.userLogin(req,res);
});


#### Required Parameters

* userEmail       - [UNIQUE EMAIL ID]
* userPassword    - [MD5 - ALPHA NUMERIC & 1 SPECIAL CHARACTER LIKE - Mobiweb@123]
* userDeviceToken - [USER DEVICE TOKEN]
* userDeviceType  - [ANDROID,IOS]
* userDeviceId    - [UNIQUE DEVICE ID]

To Verify Account

app.post('/user/verify-account', function (req,res) {
    mobiweb.verifyAccount(req,res);
});


#### Required Parameters

* userTempCode        - [6 digit temporary code]
* userLoginSessionKey - [User loggedin sesssion key]

To re-send account verification code

app.post('/user/resend-account-verification-code', function (req,res) {
    mobiweb.resendAccountVerificationCode(req,res);
});


#### Required Parameters

* userLoginSessionKey - [User loggedin sesssion key]

To forgot password

app.post('/user/forgot-password', function (req,res) {
    mobiweb.forgotPassword(req,res);
});


#### Required Parameters

* userEmail - [UNIQUE EMAIL ID]

To verify user forgot password code

app.post('/user/verify-forgot-password-code', function (req,res) {
    mobiweb.verifyForgotPasswordCode(req,res);
});


#### Required Parameters

* userTempCode        - [6 digit temporary code]
* userLoginSessionKey - [User loggedin sesssion key]

To re-send forgot password code

app.post('/user/resend-forgot-password-code', function (req,res) {
    mobiweb.resendForgotPasswordCode(req,res);
});


#### Required Parameters

* userLoginSessionKey - [User loggedin sesssion key]

To reset user password

app.post('/user/reset-password', function (req,res) {
    mobiweb.resetPassword(req,res);
});


#### Required Parameters

* userLoginSessionKey,newPassword,confirmPassword

To user contact us

app.post('/user/contact-us', function (req,res) {
    mobiweb.contactUs(req,res);
});


#### Required Parameters

* contactName,contactPhone,contactEmail,contactMessage

To get user profile details

app.post('/user/view-profile', function (req,res) {
    mobiweb.viewProfile(req,res);
});


#### Required Parameters

* userLoginSessionKey

To update user profile

app.post('/user/update-profile', function (req,res) {
    mobiweb.updateProfile(req,res);
});


#### Required Parameters

* userLoginSessionKey,userFirstName,userLastName,userGender,userDOB,userCountry,userCity,userAddress,userLatitude,userLongitude

To upload user profile & cover images

app.post('/user/upload-user-image', function (req,res) {
    mobiweb.uploadUserImage(req,res);
});


#### Required Parameters

* userLoginSessionKey,userFile,fileUploadType (PROFILE_IMG,PROFILE_IMG)

#### Note:- Will also generate image thumbnail.

To change user password

app.post('/user/change-password', function (req,res) {
    mobiweb.changePassword(req,res);
});


#### Required Parameters

* userLoginSessionKey,oldPassword,newPassword,confirmPassword

lib -> notification.js

  • Here we are managing Android & IOS mobile app push notification.

To Send Push Notification

var appRoot  = require('app-root-path');
var notification = require(appRoot + '/lib/notification.js');

#### For Android (FCM) :-

notification.sendAndroidNotification(userDeviceToken,userMessage,extraParams);

#### For IOS (APNS) :-

notification.sendIOSNotification(userDeviceToken,userMessage,userBadges,extraParams);

#### For Both Android & IOS (FCM + APNS) :-

notification.sendPushNotifications(userMessage,userId,extraParams);

Note:- sendPushNotifications() method is used to send notification on multiple devices, for example if same user logged in on Android & IOS device then notification will fire on all logged in devices.

Last Activity Management (Session - For Security)

Now we are saving user last activity date time in database, if last activity date time is 6 or more then 6 hours old, then session will expired & automatically login session key will changed, a new login session key will allocate for that user. We can also change this session limit from constant file using "session_limit" constant.