Core Service Library

Core Service library.

Version: 1.0.32

Installing Library

Then via terminal:

npm install core-service-library

yarn add core-service-library

Services used

List of services included in the library:

User Management Service
SSO Authentication Service
Email Service
Roles Service
Files Service
Core Service
JWTMiddleware

Imports:

UserManagementService
SSOService
EmailService
RoleService
RoleAction
JWTMiddleware
FileService
ApplicationCoreService
SpacerConfigService

Functions that are provided by Core Service Library:

- Messaging Service

sendEmail(emailObject) - send email to Messaging Service and save it to your current collection of messages log.

Email Object :

{
    from: string,
    to: string,
    subject: string,
    body: string
}

Where:

from - from email address
to - to email address
subject - email subject
body - email body/message
attachments - email attachments

- User Management Service

create - Create new users.
findById - Get user by primary key.
getAll - Returns all users.
update - Update user by id.
remove - Delete user by primary key.
authentication - Authenticate user.
invitations - Send invitations to new clients.
recoverPassword - Recover password by id.
verifyToken - Verify token.
changePassword - Change password by id.

The object necessary for user creation:

{
    first_name: string,
    last_name: string,
    username: string,
    email: string,
    password: string
}

create - Create new invitation.

- SSO Authentication Service

login - Authenticate user.
logout - Remove token from cookie.
refreshToken - Refresh authentication jwt token.
csrfToken - CSRF token.
verifyToken - Verify token.
remove - Delete user by id.

The object necessary for authenticate :

{
    email: string,
    password: string
}

- Role Service

import { RoleService } from 'core-service-library';


create - Create new role.
getAll - Returns all roles.
update - Update role by id.
remove - Delete role by id.
createRoleAction - Create actions for role .
getRoleActions - Get role actions.

import { RoleAction } from 'core-service-library';


update - Update role's action by id.
remove - Delete role's action by id.

import { UserRole } from 'core-service-library';


getUserRoles - Get user's role.
addUserRole - Add role for user.
removeUserRole - Delete user's role by id.

import { EventsService } from 'core-service-library';


create - Create an event.

Keys that need to be added and completed in ENV:

USERS_MANAGEMENT_API:  /* Users management service URL *\
SSO_AUTHENTICATION_API: /* SSO service URL *\
EMAIL_SERVICE_API: /* Email service URL *\
APP_ROLES_API: /* Role service URL *\