generator-nokode 1.0.0

package/README.md

@@ -0,0 +1,214 @@
+# generator-nokode
+
+[![npm version](https://badge.fury.io/js/generator-nokode.svg)](https://badge.fury.io/js/generator-nokode)
+[![Build Status](https://travis-ci.org/thepanther-io/nokode-yo-generator.svg?branch=master)](https://travis-ci.org/thepanther-io/nokode-yo-generator)
+
+A Yeoman generator for creating Spring Boot applications with the Nokode framework. This generator scaffolds a complete Spring Boot application with authentication, user management, role-based access control, and MongoDB integration.
+
+## Features
+
+- 🚀 **Spring Boot 3.5.5** with Java 17
+- 🔐 **Authentication & Authorization** with role-based access control
+- 👥 **User Management** with CRUD operations
+- 🗄️ **MongoDB Integration** with Spring Data
+- 📝 **OpenAPI Documentation** with Swagger UI
+- 🛠️ **MapStruct** for object mapping
+- 🔒 **Security** with interceptors and CORS configuration
+- 📊 **Auditing** and logging capabilities
+- 🧪 **Testing** setup with JUnit
+
+## Prerequisites
+
+- Node.js (>= 14.0.0)
+- Java 17
+- Gradle
+- MongoDB
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-nokode using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-nokode
+```
+
+## Usage
+
+### Interactive Mode
+
+Run the generator in interactive mode:
+
+```bash
+yo nokode
+```
+
+The generator will prompt you for:
+
+- Application name
+- Group ID (e.g., com.example)
+- Java package name (e.g., com.example.myapp)
+- System email address
+
+### Command Line Mode
+
+You can also provide all parameters via command line:
+
+```bash
+yo nokode --appName="MyApp" --groupId="com.example" --packageName="com.example.myapp" --systemEmailAddress="admin@example.com"
+```
+
+## Generated Project Structure
+
+```
+my-app/
+├── src/
+│   ├── main/
+│   │   ├── java/
+│   │   │   └── com/example/myapp/
+│   │   │       ├── MyAppApplication.java
+│   │   │       ├── config/
+│   │   │       │   ├── AuthConfig.java
+│   │   │       │   ├── MongoConfig.java
+│   │   │       │   ├── WebConfig.java
+│   │   │       │   └── ...
+│   │   │       ├── user/
+│   │   │       │   ├── domain/
+│   │   │       │   ├── dto/
+│   │   │       │   ├── mapper/
+│   │   │       │   ├── repository/
+│   │   │       │   └── service/
+│   │   │       └── role/
+│   │   │           ├── domain/
+│   │   │           ├── dto/
+│   │   │           ├── mapper/
+│   │   │           ├── repository/
+│   │   │           └── service/
+│   │   └── resources/
+│   │       └── application.properties
+│   └── test/
+│       └── java/
+│           └── com/example/myapp/
+│               └── MyAppApplicationTests.java
+├── build.gradle
+├── settings.gradle
+└── gradlew
+```
+
+## Configuration
+
+After generation, update the `application.properties` file with your specific configuration:
+
+```properties
+# Database Configuration
+spring.data.mongodb.uri=mongodb://localhost:27017/myapp
+
+# Server Configuration
+server.port=8080
+
+# Security Configuration
+app.security.jwt.secret=your-jwt-secret-key
+app.security.jwt.expiration=86400000
+
+# Email Configuration
+app.email.host=smtp.gmail.com
+app.email.port=587
+app.email.username=your-email@gmail.com
+app.email.password=your-app-password
+```
+
+## Running the Application
+
+1. Start MongoDB:
+
+```bash
+mongod
+```
+
+2. Run the application:
+
+```bash
+./gradlew bootRun
+```
+
+3. Access the application:
+
+- API: http://localhost:8080
+- Swagger UI: http://localhost:8080/swagger-ui.html
+
+## API Endpoints
+
+The generated application includes the following endpoints:
+
+### User Management
+
+- `POST /api/users` - Create user
+- `GET /api/users` - Get all users
+- `GET /api/users/{id}` - Get user by ID
+- `PUT /api/users/{id}` - Update user
+- `DELETE /api/users/{id}` - Delete user
+
+### Role Management
+
+- `POST /api/roles` - Create role
+- `GET /api/roles` - Get all roles
+- `GET /api/roles/{id}` - Get role by ID
+- `PUT /api/roles/{id}` - Update role
+- `DELETE /api/roles/{id}` - Delete role
+
+### Authentication
+
+- `POST /api/auth/login` - User login
+- `POST /api/auth/signup` - User signup
+- `POST /api/auth/reset-password` - Reset password
+
+## Development
+
+### Running Tests
+
+```bash
+./gradlew test
+```
+
+### Building the Application
+
+```bash
+./gradlew build
+```
+
+### Running with Docker
+
+```bash
+docker-compose up
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+If you have any questions or need help, please:
+
+1. Check the [Issues](https://github.com/thepanther-io/nokode-yo-generator/issues) page
+2. Create a new issue if your problem isn't already reported
+3. Contact the maintainers at info@thepanther.io
+
+## Changelog
+
+### 1.0.0
+
+- Initial release
+- Spring Boot 3.5.5 support
+- User and Role management
+- MongoDB integration
+- Authentication and authorization
+- OpenAPI documentation

package/generators/app/index.js

@@ -0,0 +1,116 @@
+import BaseGenerator from '../base-generator.js';
+
+export default class NokodeGenerator extends BaseGenerator {
+  constructor(args, opts) {
+    super(args, opts);
+  }
+
+  writing() {
+    this._writeGradleFiles();
+    this._writeJavaSrcFiles();
+    this._writeConfigFiles();
+    this._writeMainResourceFiles();
+    this._writeJavaTestFiles();
+  }
+
+  _writeGradleFiles() {
+    this._writeDir('./gradle');
+    this._writeFile('build.sh');
+    this._writeFile('build.gradle');
+    this._writeFile('.gitignore');
+    this._writeFile('gradlew');
+    this._writeFile('gradlew.bat');
+    this._writeFile('settings.gradle');
+  }
+
+  _writeConfigFiles() {
+    const files = [
+      'WebConfig.java',
+      'NotificationConfig.java',
+      'MongoConfig.java',
+      'AuthConfig.java',
+      'CloudStorageConfig.java',
+      'ShedlockConfig.java',
+      'openapi/OpenAPIConfig.java',
+      'interceptors/AuthInterceptor.java',
+      'interceptors/LocaleInterceptor.java',
+      'interceptors/RequestContextInterceptor.java',
+      'interceptors/CorsFilterConfig.java',
+      'init/ApplicationInit.java',
+      'init/DataBuilderService.java',
+      'init/ApplicationInit.java',
+      'init/UserAndRoleInitService.java',
+      'annotations/AppAuth.java',
+      'audit/UserAuditing.java',
+      'converters/BsonDocumentToJsonNodeConverter.java',
+      'converters/JsonNodeToBsonDocumentConverter.java',
+      'converters/ModuleDefinitionDeserializer.java',
+      'converters/ModulePermissionDefinitionModule.java',
+      'converters/PermissionDefinitionDeserializer.java',
+      'converters/StringToModuleDefinitionConverter.java',
+      'converters/StringToPermissionDefinitionConverter.java',
+      'exception/RestExceptionHandlerService.java',
+    ];
+
+    const relPath = 'config';
+    this._writeJavaMainFiles(files, relPath);
+
+    const configPrefix = `01-code/${relPath}`;
+    const destPath = `src/main/java/${this.configData['packageName'].split('.').join('/')}/${relPath}`;
+
+    this._writeFileWithPaths(`${configPrefix}/PantherCrudBeans.java`, `${destPath}/${this.configData['appNameTitleCase']}Beans.java`);
+    this._writeFileWithPaths(
+      `${configPrefix}/constants/PantherCrudConstants.java`,
+      `${destPath}/constants/${this.configData['appNameTitleCase']}Constants.java`
+    );
+  }
+
+  _writeJavaSrcFiles() {
+    const files = [
+      'role/domain/Role.java',
+      'role/dto/RoleCreateDto.java',
+      'role/dto/RoleDetailDto.java',
+      'role/dto/RoleSearchDto.java',
+      'role/enums/ModuleEnum.java',
+      'role/enums/PermissionEnum.java',
+      'role/mapper/RoleCreateDtoMapper.java',
+      'role/mapper/RoleDetailDtoMapper.java',
+      'role/mapper/RoleSearchDtoMapper.java',
+      'role/repository/RoleRepository.java',
+      'role/service/RoleCrudService.java',
+
+      'user/domain/User.java',
+      'user/dto/UserCreateDto.java',
+      'user/dto/UserDetailDto.java',
+      'user/dto/UserSignupDto.java',
+      'user/dto/EmailLoginDto.java',
+      'user/dto/ResetEmailPasswordDto.java',
+      'user/mapper/UserCreateDtoMapper.java',
+      'user/mapper/UserDetailDtoMapper.java',
+      'user/mapper/UserSignupDtoMapper.java',
+      'user/repository/UserRepository.java',
+      'user/service/UserCrudService.java',
+    ];
+    this._writeJavaMainFiles(files, '');
+    const src = `01-code`;
+    const dest = `src/main/java/${this.configData['packageName'].split('.').join('/')}`;
+    this._writeFileWithPaths(`${src}/NokodeSampleApplication.java`, `${dest}/${this.configData['appNameTitleCase']}Application.java`);
+  }
+
+  _writeJavaTestFiles() {
+    const srcPath = `02-test-code`;
+    const destPath = `src/test/java/${this.configData['packageName'].split('.').join('/')}`;
+    this._writeFileWithPaths(
+      `${srcPath}/NokodeSampleApplicationTests.java`,
+      `${destPath}/${this.configData['appNameTitleCase']}ApplicationTests.java`
+    );
+  }
+
+  _writeMainResourceFiles() {
+    const srcPath = `03-main-resources`;
+    const destPath = `src/main/resources`;
+    ['application.properties', 'META-INF/additional-spring-configuration-metadata.json'].forEach((fileName) =>
+      this._writeFileWithPaths(`${srcPath}/${fileName}`, `${destPath}/${fileName}`)
+    );
+  }
+}

package/generators/app/templates/.gradle/buildOutputCleanup/cache.properties

@@ -0,0 +1,2 @@
+#Wed Sep 03 18:47:56 IST 2025
+gradle.version=9.0.0

package/generators/app/templates/01-code/NokodeSampleApplication.java

@@ -0,0 +1,13 @@
+package <%= packageName %>;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class <%= appNameTitleCase %>Application {
+
+  public static void main(String[] args) {
+    SpringApplication.run(<%= appNameTitleCase %>Application.class, args);
+  }
+
+}

package/generators/app/templates/01-code/config/AuthConfig.java

@@ -0,0 +1,10 @@
+package <%= packageName %>.config;
+
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@ComponentScan(basePackages = "com.sixsprints.auth")
+public class AuthConfig {
+
+}

package/generators/app/templates/01-code/config/CloudStorageConfig.java

@@ -0,0 +1,30 @@
+package <%= packageName %>.config;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import com.sixsprints.cloudservice.dto.Credentials;
+import com.sixsprints.cloudservice.service.CloudStorage;
+import com.sixsprints.cloudservice.service.impl.S3CloudStorage;
+import software.amazon.awssdk.regions.Region;
+
+@Configuration
+public class CloudStorageConfig {
+
+  @Value(value = "${aws.s3.access.key:xxxxxxxxxxxxxxxx}")
+  private String accessKey;
+
+  @Value(value = "${aws.s3.secret.key:xxxxxxxxxxxxxxxx}")
+  private String secretKey;
+
+  @Value(value = "${aws.s3.region:ap-south-1}")
+  private String region;
+
+  @Bean
+  CloudStorage cloudStorage() {
+    Credentials cred = Credentials.builder().accessId(accessKey).secretKey(secretKey)
+        .region(Region.of(region)).build();
+    return new S3CloudStorage(cred);
+  }
+
+}

package/generators/app/templates/01-code/config/MongoConfig.java

@@ -0,0 +1,43 @@
+package <%= packageName %>.config;
+
+import java.util.List;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.convert.converter.Converter;
+import org.springframework.data.mongodb.config.EnableMongoAuditing;
+import org.springframework.data.mongodb.repository.config.EnableMongoRepositories;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.sixsprints.core.config.ParentMongoConfig;
+
+import <%= packageName %>.config.converters.BsonDocumentToJsonNodeConverter;
+import <%= packageName %>.config.converters.JsonNodeToBsonDocumentConverter;
+import <%= packageName %>.config.converters.StringToModuleDefinitionConverter;
+import <%= packageName %>.config.converters.StringToPermissionDefinitionConverter;
+import lombok.RequiredArgsConstructor;
+
+@Configuration
+@EnableMongoRepositories(basePackages = { "com.sixsprints.core", "com.sixsprints.auth", "<%= packageName %>" })
+@EnableMongoAuditing
+@RequiredArgsConstructor
+public class MongoConfig extends ParentMongoConfig {
+
+  private final ObjectMapper objectMapper;
+
+  @Override
+  protected List<Converter<?, ?>> converters() {
+    List<Converter<?, ?>> converters = super.converters();
+    converters.add(new StringToModuleDefinitionConverter());
+    converters.add(new StringToPermissionDefinitionConverter());
+
+    converters.add(new BsonDocumentToJsonNodeConverter(objectMapper));
+    converters.add(new JsonNodeToBsonDocumentConverter(objectMapper));
+    return converters;
+  }
+
+  @Override
+  protected boolean autoIndexCreation() {
+    return true;
+  }
+
+}

package/generators/app/templates/01-code/config/NotificationConfig.java

@@ -0,0 +1,47 @@
+package <%= packageName %>.config;
+
+import com.sixsprints.notification.dto.MessageAuthDto;
+import com.sixsprints.notification.service.NotificationService;
+import com.sixsprints.notification.service.impl.EmailServiceSmtp;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class NotificationConfig {
+
+  @Value(value = "${email.from}")
+  private String from;
+
+  @Value(value = "${email.from.address}")
+  private String fromEmail;
+
+  @Value(value = "${email.hostname}")
+  private String hostName;
+
+  @Value(value = "${email.username}")
+  private String username;
+
+  @Value(value = "${email.password}")
+  private String password;
+
+  @Value(value = "${email.ssl.enabled}")
+  private boolean sslEnabled;
+
+  MessageAuthDto emailAuth() {
+    return MessageAuthDto.builder()
+      .from(from)
+      .fromEmail(fromEmail)
+      .hostName(hostName)
+      .username(username)
+      .password(password)
+      .sslEnabled(sslEnabled)
+      .build();
+  }
+
+  @Bean("emailNotificationService")
+  NotificationService emailService() {
+    return new EmailServiceSmtp(emailAuth());
+  }
+
+}

package/generators/app/templates/01-code/config/PantherCrudBeans.java

@@ -0,0 +1,33 @@
+package <%= packageName %>.config;
+
+import org.springframework.context.annotation.Configuration;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import com.sixsprints.core.config.ParentBeans;
+
+import <%= packageName %>.config.constants.<%= appNameTitleCase %>Constants;
+import <%= packageName %>.config.converters.ModulePermissionDefinitionModule;
+
+@Configuration
+public class <%= appNameTitleCase %>Beans extends ParentBeans {
+
+  @Override
+  protected String defaultShortDateFormat() {
+    return <%= appNameTitleCase %>Constants.DEFAULT_DATE_FORMAT;
+  }
+
+  @Override
+  protected String defaultDateFormat() {
+    return <%= appNameTitleCase %>Constants.DEFAULT_DATE_TIME_FORMAT;
+  }
+
+  @Override
+  protected ObjectMapper mapper() {
+    ObjectMapper mapper = super.mapper();
+    mapper.registerModule(new JavaTimeModule());
+    mapper.registerModule(new ModulePermissionDefinitionModule());
+    return mapper;
+  }
+
+}

package/generators/app/templates/01-code/config/ShedlockConfig.java

@@ -0,0 +1,24 @@
+package <%= packageName %>.config;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.annotation.EnableScheduling;
+import com.mongodb.client.MongoClient;
+import net.javacrumbs.shedlock.core.LockProvider;
+import net.javacrumbs.shedlock.provider.mongo.MongoLockProvider;
+import net.javacrumbs.shedlock.spring.annotation.EnableSchedulerLock;
+
+@Configuration
+@EnableScheduling
+@EnableSchedulerLock(defaultLockAtMostFor = "10m")
+public class ShedlockConfig {
+
+  @Value(value = "${spring.data.mongodb.database}")
+  private String databaseName;
+
+  @Bean
+  LockProvider lockProvider(MongoClient mongo) {
+    return new MongoLockProvider(mongo.getDatabase(databaseName));
+  }
+}

package/generators/app/templates/01-code/config/WebConfig.java

@@ -0,0 +1,38 @@
+package <%= packageName %>.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+import com.sixsprints.core.interceptor.ClearAllContextInterceptor;
+
+import <%= packageName %>.config.interceptors.AuthInterceptor;
+import <%= packageName %>.config.interceptors.LocaleInterceptor;
+import <%= packageName %>.config.interceptors.RequestContextInterceptor;
+import lombok.RequiredArgsConstructor;
+
+@Configuration
+@RequiredArgsConstructor
+public class WebConfig implements WebMvcConfigurer {
+
+  private final AuthInterceptor authInterceptor;
+
+  private final RequestContextInterceptor requestContextInterceptor;
+
+  private final LocaleInterceptor localeInterceptor;
+
+  @Bean
+  ClearAllContextInterceptor clearAllContextInterceptor() {
+    return new ClearAllContextInterceptor();
+  }
+
+  @Override
+  public void addInterceptors(InterceptorRegistry registry) {
+    registry.addInterceptor(clearAllContextInterceptor());
+    registry.addInterceptor(localeInterceptor);
+    registry.addInterceptor(requestContextInterceptor);
+    registry.addInterceptor(authInterceptor);
+  }
+
+}

package/generators/app/templates/01-code/config/annotations/AppAuth.java

@@ -0,0 +1,24 @@
+package <%= packageName %>.config.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import com.sixsprints.core.auth.Authenticated;
+
+import <%= packageName %>.role.enums.ModuleEnum;
+import <%= packageName %>.role.enums.PermissionEnum;
+
+@Authenticated
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD, ElementType.TYPE })
+public @interface AppAuth {
+
+  boolean required() default true;
+
+  ModuleEnum module() default ModuleEnum.ANY;
+
+  PermissionEnum permission() default PermissionEnum.ANY;
+
+}

package/generators/app/templates/01-code/config/audit/UserAuditing.java

@@ -0,0 +1,29 @@
+package <%= packageName %>.config.audit;
+
+import java.util.Optional;
+import org.springframework.data.domain.AuditorAware;
+import org.springframework.stereotype.Component;
+import <%= packageName %>.config.constants.<%= appNameTitleCase %>Constants;
+import <%= packageName %>.user.domain.User;
+import com.sixsprints.core.utils.ApplicationContext;
+
+@Component
+public class UserAuditing implements AuditorAware<String> {
+
+  public static User getCurrentUser() {
+    User user = ApplicationContext.getCurrentUser();
+    return user == null ? <%= appNameTitleCase %>Constants.SYSTEM_USER : user;
+  }
+
+  public static String getCurrentUserId() {
+    User user = getCurrentUser();
+    return user.authId();
+  }
+
+  @Override
+  public Optional<String> getCurrentAuditor() {
+    String id = getCurrentUserId();
+    return Optional.of(id);
+  }
+
+}

package/generators/app/templates/01-code/config/constants/PantherCrudConstants.java

@@ -0,0 +1,24 @@
+package <%= packageName %>.config.constants;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import <%= packageName %>.role.domain.Role;
+import <%= packageName %>.user.domain.User;
+
+public interface <%= appNameTitleCase %>Constants {
+
+  String AUTH_TOKEN = "X-AUTH-TOKEN";
+  String API_PREFIX = "/api/v1";
+
+  String DEFAULT_DATE_FORMAT = "yyyy/MM/dd";
+  String DEFAULT_DATE_TIME_FORMAT = "yyyy/MM/dd HH:mm:ss";
+  String DEFAULT_TIMEZONE = "UTC";
+
+  String ADMIN_ROLE = "admin";
+  String USER_ROLE = "user";
+
+  Map<String, Role> ROLES = new HashMap<>();
+  User SYSTEM_USER = User.builder().email("<%= systemEmailAddress %>").build();
+
+}