@bluealba-public/pae-core
v2.2.0
Published
Core package for the PAE project
Downloads
809
Readme
PAE CORE Library
This library is a collection of common utilities and services that are used across all PAE services.
Services
Authorization Service
The Authorization Service provides methods for managing user roles and operations.
Methods
createOperation(data: CreateOperationDTO): Promise<Operation>
Creates a new operation.
References
getOperations(): Promise<Operation[]>
createRole(data: CreateRoleDTO): Promise<Role>
Creates a new role.
References
Application Service
The Application Service provides methods for managing PAE applications.
Methods
createApplication(data: CreateApplicationDTO): Promise<Application>
Creates a new application.
References
getApplications(): Promise<Application[]>
Retrieves all applications.
References
Domain Models
Application
The Application domain model represents a PAE application.
Properties
id
(number): The unique identifier of the application.name
(string): The name of the application.description
(string): The description of the application.isGlobal
(boolean): A flag indicating whether the application is global or not.createdAt
(Date): The date and time when the application was created.updatedAt
(Date): The date and time when the application was last updated.createdBy
(string): The user who created the application.updatedBy
(string): The user who last updated the application.
Operation
The Operation domain model represents an operation that can be performed by a user.
Properties
id
(number): The unique identifier of the operation.name
(string): The name of the operation.description
(string): The description of the operation.createdAt
(Date): The date and time when the operation was created.updatedAt
(Date): The date and time when the operation was last updated.createdBy
(string): The user who created the operation.updatedBy
(string): The user who last updated the operation.
Role
The Role domain model represents a role that can be assigned to a user.
Properties
id
(number): The unique identifier of the role.name
(string): The name of the role.description
(string): The description of the role.createdAt
(Date): The date and time when the role was created.updatedAt
(Date): The date and time when the role was last updated.createdBy
(string): The user who created the role.updatedBy
(string): The user who last updated the role.
Data Transfer Objects
CreateApplicationDTO
The CreateApplicationDTO model represents the data required to create a new application.