Merge pull request #93 from ansopedia/82-maintain-changelog

docs(changelog): create initial CHANGELOG.md for v1.0.0

.vscode/settings.json

@@ -5,5 +5,8 @@
     "source.fixAll": "always",
     "source.organizeImports": "always"
   },
-  "typescript.tsdk": "node_modules\\typescript\\lib"
+  "typescript.tsdk": "node_modules\\typescript\\lib",
+  "cSpell.language": "en-GB",
+  "cSpell.dictionaries": ["en-GB"],
+  "cSpell.allowCompoundWords": true
 }

CHANGELOG.md

@@ -0,0 +1,74 @@
+# Changelog
+
+All notable changes to the User Service will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2024-03-19
+
+### Added
+
+- Integrated Socket.IO for real-time interactions (#86)
+- Enhanced Google Sign-In API with redirect support (#77)
+- Implemented pagination for Get Users endpoint (#68)
+- Added Profile Management APIs:
+  - Create Profile API (#60)
+  - Get Profile Data API (#61)
+  - Update Profile Data API (#62)
+- Implemented decentralized JWT token validation across microservices (#55)
+- Integrated Notification Service API (#32)
+- Implemented OTP verification for user registration (#23)
+- Implemented secure master OTP for development/staging environments (#24)
+- Implemented basic CRUD operations for user management (#1)
+- Set up database connection and test server (#2)
+- Implemented sendResponse function (#4)
+- Implemented error handler middleware and error constants (#6)
+- Implemented scalable role and permission schema for RBAC (#12)
+- Implemented user authentication (Login, Register, Forgot Password) (#14)
+- Logging system using Pino
+- Test coverage with Jest
+- ESLint and Prettier configuration
+- Husky pre-commit hooks
+- Docker support
+- TypeScript configuration and type safety
+- MongoDB integration with Mongoose
+- API versioning (v1)
+- Express.js server setup with middleware
+- Environment configuration management
+- Response standardisation utilities
+
+### Changed
+
+- Updated API response structure to namespace payload under data (#83)
+- Optimized function names to use "Upsert" instead of "UpdateOrCreate" (#47)
+- Enhanced login API to support both email and username authentication (#41)
+- Updated dependencies (#25)
+
+### Security
+
+- Configured global rate limiting (#71)
+- Created scalable and dynamic schema for storing tokens (#53)
+- Added route protection using validateAccessToken and checkPermission middleware (#51)
+- Implemented strong password policy (#40, #48)
+- Encrypted JWT tokens (#37)
+- Implemented Role-Based Access Control (RBAC) with default roles and permissions (#28, #36)
+- Implemented middleware for access token validation and refresh (#21)
+- Integrated Helmet and CORS middleware (#16)
+- Implemented bcrypt for password hashing (#10)
+- Added JWT-based authentication
+- Configured CORS protection
+
+### Fixed
+
+- Fixed weak password acceptance during sign-up (#48)
+
+### Developer Experience
+
+- Added TypeScript support with strict type-checking
+- Configured ESLint and Prettier for code quality
+- Set up Jest for testing
+- Added Husky for pre-commit hooks
+- Configured Docker for containerization
+- Added comprehensive README with setup instructions
+- Added VSCode settings

package.json

@@ -1,6 +1,6 @@
 {
   "name": "user",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "user service for ansopedia",
   "main": "index.js",
   "scripts": {