README.md

Smart Office Facility

Overview

This project is an Smart Office Facility that allows users to manage room bookings, configure office settings, and monitor room statuses. The system uses several design patterns, including Singleton, Command, and Observer patterns, to ensure a scalable and maintainable architecture.

Design Patterns

Singleton Pattern

The Singleton pattern is used to ensure that certain classes have only one instance throughout the application. This is particularly useful for managing shared resources or configurations.

• OfficeConfiguration: Manages office settings and configurations.
• UserSession: Manages user session information.

Command Pattern

The Command pattern is used to encapsulate all the information needed to perform an action or trigger an event. This pattern is useful for implementing undo/redo functionality, logging changes, and more.

Available commands:

• AddOccupantCommand: Adds an occupant to a room.
• BlockRoomCommand: Blocks a room.
• CancelRoomCommand: Cancels a room booking.
• ConfigRoomCommand: Configures room settings.
• ConfigRoomMaxCapacityCommand: Configures the maximum capacity of a room.
• OfficeStatisticsCommand: Retrieves office statistics.
• RoomStatusCommand: Checks the status of a room.
• UserAuthenticationCommand: Authenticates a user.

Observer Pattern

The Observer pattern is used to notify multiple objects about changes in the state of another object. This pattern is useful for implementing distributed event handling systems.

• RoomObserver: Observes changes in room status and updates accordingly.
• ACController: Controls the air conditioning based on room status.
• LightController: Controls the lighting based on room status.

Features

User Authentication

User authentication is handled by the UserAuthenticationCommand. This command verifies user credentials and manages user sessions.

Email Notifications

Email notifications are sent using the Email class. Notifications are triggered for various events, such as booking cancellations due to inactivity.

Automatic Cancellations

The system automatically cancels room bookings if the room is unoccupied for a specified period. This is handled by the Booking class, which checks the room status and notifies users of cancellations.

Command Parsing

Commands are parsed and executed using the CommandParser class. This class imports all available commands and provides a mechanism to execute them based on user input.

Edge Cases

• Concurrent Bookings: The system handles concurrent booking requests by checking room availability before confirming a booking.
• User Role Verification: Only users with the appropriate roles can perform certain actions, such as configuring rooms or blocking them.
• Notification Failures: The system logs any failures in sending email notifications and retries if necessary.

Getting Started

Prerequisites

• Node.js
• npm

Installation

1. Clone the repository:

   git clone https://github.com/visveshkhanna/ei-campusdrive

2. Navigate to the project directory:

   cd 'Mini Project (Smart Office Facility)'

3. Install dependencies:

   npm install

Running the Application

Building the Application To build the application, run:

npm run build

To start the application, run:

npm start

Inputs

The application accepts the following inputs:

Login

To login, enter the following command:

Login <username>

Replace <username> with the desired username.

Logout

To logout, enter the following command:

Logout

Me

To retrieve the current user's role, enter the following command:

Me

Configure Rooms

To configure the number of rooms, enter the following command:

Config room count <count>

Replace <count> with the desired number of rooms.

Configure Room Max Capacity

To configure the maximum capacity of a room, enter the following command:

Config room max capacity <room_id> <capacity>

Replace <room_id> with the desired room ID and <capacity> with the desired maximum capacity.

Add Occupants

To add occupants to a room, enter the following command:

Add occupant <room_id> <count>

Replace <room_id> with the desired room ID and <count> with the desired number of occupants.

Block Room

To block a room, enter the following command:

Block room <room_id> <time> <duration>

Replace <room_id> with the desired room ID, <time> with the desired start time in the format HH:MM:SS and <duration> with the desired duration in minutes.

Cancel Room

To cancel a room booking, enter the following command:

Cancel room <room_id> <booking_id>

Replace <room_id> with the desired room ID and <booking_id> with the desired booking ID.

Status Room

To check the status of a room, enter the following command:

Status room <room_id>

Replace <room_id> with the desired room ID.

Statistics

To retrieve office statistics, enter the following command:

Statistics

Outputs

The application provides the following outputs:

• Login: Displays a message indicating that the user has logged in successfully.
• Configure Rooms: Displays a message indicating that the number of rooms has been configured successfully.
• Configure Room Max Capacity: Displays a message indicating that the maximum capacity of a room has been configured successfully.
• Add Occupants: Displays a message indicating that the occupants have been added successfully.
• Block Room: Displays a message indicating that the room has been blocked successfully.
• Cancel Room: Displays a message indicating that the room booking has been cancelled successfully.
• Status Room: Displays the status of a room.
• Statistics: Displays the office statistics.

Error Handling

The application handles the following errors:

• Invalid room count: Displays an error message indicating that the room count is invalid.
• Invalid room capacity: Displays an error message indicating that the room capacity is invalid.
• Invalid time: Displays an error message indicating that the time is invalid.
• Invalid duration: Displays an error message indicating that the duration is invalid.
• Invalid room id: Displays an error message indicating that the room ID is invalid.
• Invalid booking id: Displays an error message indicating that the booking ID is invalid.
• Invalid command: Displays an error message indicating that the command is invalid.
• Invalid command format: Displays an error message indicating that the command format is invalid.
• Invalid role: Displays an error message indicating that the role is invalid.
• Invalid username: Displays an error message indicating that the username is invalid.

Conclusion

This project demonstrates the implementation of a Smart Office Facility using TypeScript and the design patterns. The system allows users to configure rooms, add occupants, block rooms, and cancel bookings. It also provides notifications for booking cancellations due to inactivity and automatically cancels bookings if the room is unoccupied for a specified period. The system handles concurrent booking requests and logs any failures in sending email notifications. The application is built using the TypeScript programming language and the design patterns, including the Singleton, Command, and Observer patterns.