Plan

Observations

I've analyzed a Discord-like chat server implementation with comprehensive user management, guild templates, bot creation, and a sophisticated rights system. The codebase already has guild templates that serialize guild configurations for reuse, bot user creation via createAppBotUser(), and a robust rights system with flags like MANAGE_USERS and CREATE_REGISTRATION_TOKENS. The request is for "User templates" to create user accounts for bots and controlled users more easily, which would complement the existing guild template system.

Approach

I'll implement a User Template system that mirrors the existing Guild Template pattern. This will include a new UserTemplate entity to store serialized user configurations, API routes for creating and using templates, configuration options, and integration with the existing user creation flow. The system will require admin rights (MANAGE_USERS) and will extend the current User.register() method to accept template data. This approach reuses proven patterns while adding the requested functionality for easier bot and controlled user creation.

Reasoning

I explored the codebase structure and found it's a comprehensive Discord-like server with multiple services (API, CDN, Gateway, WebRTC). I examined the existing guild template system, user registration process, bot creation functionality, and rights management system. I also looked at the configuration framework, database migration system, and existing admin routes to understand the patterns used for privileged operations.

Proposed File Changes

📄 src/util/entities/UserTemplate.ts ^(NEW) 🔗

References

📄 src/util/entities/Template.ts

📄 src/util/entities/BaseClass.ts

📄 src/util/entities/User.ts

Create a new UserTemplate entity following the same pattern as the existing Template entity in /tmp/github/issues/5833034_537382467_1755800828615/src/util/entities/Template.ts. Include fields for code (unique identifier), name, description, usage_count, creator_id (relation to User), created_at, updated_at, and serialized_user (JSON field containing the user template data). Use TypeORM decorators and extend BaseClass similar to the Template entity.

📄 src/util/config/types/UserTemplateConfiguration.ts ^(NEW) 🔗

References

📄 src/util/config/types/TemplateConfiguration.ts

Create a new configuration class for user templates, similar to TemplateConfiguration in /tmp/github/issues/5833034_537382467_1755800828615/src/util/config/types/TemplateConfiguration.ts. Include boolean flags for enabled, allowTemplateCreation, allowDiscordTemplates (for future compatibility), and allowRaws (for importing raw user data). Set appropriate defaults (enabled: true, allowTemplateCreation: true, etc.).

📄 src/util/config/types/index.ts ^(MODIFY) 🔗

References

📄 src/util/config/types/UserTemplateConfiguration.ts ^(NEW)

Add export for the new UserTemplateConfiguration class to make it available for import in other parts of the system.

📄 src/util/config/Config.ts ^(MODIFY) 🔗

References

📄 src/util/config/types/UserTemplateConfiguration.ts ^(NEW)

📄 src/util/config/types/TemplateConfiguration.ts

Add a userTemplates property of type UserTemplateConfiguration to the main Config class, following the same pattern as the existing templates property. This will make user template configuration accessible via Config.get().userTemplates.

📄 src/util/entities/index.ts ^(MODIFY) 🔗

References

📄 src/util/entities/UserTemplate.ts ^(NEW)

Add export for the new UserTemplate entity to make it available for import throughout the application.

📄 src/util/schemas/UserTemplateCreateSchema.ts ^(NEW) 🔗

References

📄 src/util/schemas/TemplateCreateSchema.ts

Create a schema for user template creation requests, similar to TemplateCreateSchema in /tmp/github/issues/5833034_537382467_1755800828615/src/util/schemas/TemplateCreateSchema.ts. Include required name field and optional description field. This will be used for API validation when creating new user templates.

📄 src/util/schemas/UserTemplateModifySchema.ts ^(NEW) 🔗

References

📄 src/util/schemas/TemplateModifySchema.ts

Create a schema for user template modification requests, similar to TemplateModifySchema in /tmp/github/issues/5833034_537382467_1755800828615/src/util/schemas/TemplateModifySchema.ts. Include name and optional description fields for updating existing user templates.

📄 src/util/schemas/UserFromTemplateCreateSchema.ts ^(NEW) 🔗

References

📄 src/util/schemas/RegisterSchema.ts

📄 src/util/entities/User.ts

Create a schema for creating users from templates. Include optional fields like username (to override template username), email, and other user properties that can be customized when instantiating a user from a template. This allows flexibility when creating users from templates while maintaining the template's base configuration.

📄 src/util/schemas/index.ts ^(MODIFY) 🔗

References

📄 src/util/schemas/UserTemplateCreateSchema.ts ^(NEW)

📄 src/util/schemas/UserTemplateModifySchema.ts ^(NEW)

📄 src/util/schemas/UserFromTemplateCreateSchema.ts ^(NEW)

Add exports for the new user template schemas (UserTemplateCreateSchema, UserTemplateModifySchema, UserFromTemplateCreateSchema) to make them available for import in API routes and validation.

📄 src/util/util/UserTemplate.ts ^(NEW) 🔗

References

📄 src/util/util/Application.ts ^(MODIFY)

📄 src/util/entities/User.ts

📄 src/util/entities/UserTemplate.ts ^(NEW)

Create utility functions for user template operations. Include serializeUser(user: User) to convert a User entity to template JSON, createUserFromTemplate(template: UserTemplate, overrides: Partial<User>, req?: Request) to instantiate users from templates, and validation functions. This file will contain the core logic for template serialization and user creation, similar to how Application.ts contains createAppBotUser().

📄 src/util/util/index.ts ^(MODIFY) 🔗

References

📄 src/util/util/UserTemplate.ts ^(NEW)

Add exports for the new UserTemplate utility functions to make them available throughout the application.

📁 src/api/routes/users/templates ^(NEW) 🔗

Create a new directory for user template API routes, following the same structure as the existing guild templates in /tmp/github/issues/5833034_537382467_1755800828615/src/api/routes/guilds/templates/.

📄 src/api/routes/users/templates/index.ts ^(NEW) 🔗

References

📄 src/api/routes/guilds/templates/index.ts

📄 src/util/util/UserTemplate.ts ^(NEW)

📄 src/util/entities/UserTemplate.ts ^(NEW)

Create the main user templates API route handler, similar to /tmp/github/issues/5833034_537382467_1755800828615/src/api/routes/guilds/templates/index.ts. Implement GET /:code to retrieve a user template and POST /:code to create a user from a template. Include proper rights checking (MANAGE_USERS), configuration validation (check if user templates are enabled), and error handling. The POST route should use the createUserFromTemplate utility function and return the created user or a token.

📁 src/api/routes/users/#id/templates ^(NEW) 🔗

Create a directory for user-specific template operations, allowing creation of templates from existing users.

📄 src/api/routes/users/#id/templates/index.ts ^(NEW) 🔗

References

📄 src/util/util/UserTemplate.ts ^(NEW)

📄 src/util/schemas/UserTemplateCreateSchema.ts ^(NEW)

📄 src/util/entities/UserTemplate.ts ^(NEW)

Create API route for creating user templates from existing users. Implement POST route that takes a UserTemplateCreateSchema (name, description) and creates a new UserTemplate by serializing the specified user. Require MANAGE_USERS rights and validate that user templates are enabled in configuration. Use the serializeUser utility function to convert the user to template format.

📁 src/api/routes/users/templates/manage ^(NEW) 🔗

Create a directory for user template management operations (list, modify, delete templates).

📄 src/api/routes/users/templates/manage/index.ts ^(NEW) 🔗

References

📄 src/util/entities/UserTemplate.ts ^(NEW)

📄 src/util/schemas/UserTemplateCreateSchema.ts ^(NEW)

📄 src/util/schemas/UserTemplateModifySchema.ts ^(NEW)

Create API routes for managing user templates. Implement GET route to list all user templates (with pagination), POST route to create a new template from scratch, PUT /:code to modify existing templates, and DELETE /:code to remove templates. All routes require MANAGE_USERS rights and should check if user templates are enabled. Include proper error handling and validation using the UserTemplate schemas.

📄 src/util/migration/postgres/1755800828615-userTemplates.ts ^(NEW) 🔗

References

📄 src/util/migration/postgres/1673609867556-templateDeleteCascade.ts

📄 src/util/entities/UserTemplate.ts ^(NEW)

Create a database migration for PostgreSQL to add the user_templates table. Include columns for id, code (unique), name, description, usage_count, creator_id (foreign key to users), created_at, updated_at, and serialized_user (JSON). Follow the same pattern as existing migrations in the postgres directory and ensure proper indexing on the code field for performance.

📄 src/util/migration/mysql/1755800828615-userTemplates.ts ^(NEW) 🔗

References

📄 src/util/migration/mysql/1673609465036-templateDeleteCascade.ts

📄 src/util/entities/UserTemplate.ts ^(NEW)

Create a database migration for MySQL to add the user_templates table, identical to the PostgreSQL version but with MySQL-specific syntax. Follow the pattern of existing MySQL migrations in the mysql directory.

📄 src/util/migration/mariadb/1755800828615-userTemplates.ts ^(NEW) 🔗

References

📄 src/util/migration/mariadb/1673609465036-templateDeleteCascade.ts

📄 src/util/entities/UserTemplate.ts ^(NEW)

Create a database migration for MariaDB to add the user_templates table, identical to the MySQL version. Follow the pattern of existing MariaDB migrations in the mariadb directory.

📄 src/util/util/Application.ts ^(MODIFY) 🔗

References

📄 src/util/util/UserTemplate.ts ^(NEW)

📄 src/util/entities/UserTemplate.ts ^(NEW)

Modify the createAppBotUser function to accept an optional templateCode parameter. If provided, use the specified user template to create the bot user instead of the default hardcoded values. This allows applications to use predefined bot templates while maintaining backward compatibility. Import the createUserFromTemplate function and UserTemplate entity to implement this functionality.

📄 src/api/routes/applications/index.ts ^(MODIFY) 🔗

References

📄 src/util/util/Application.ts ^(MODIFY)

📄 src/util/schemas/ApplicationCreateSchema.ts

Modify the application creation route to accept an optional botTemplateCode parameter in the ApplicationCreateSchema. Pass this parameter to the createAppBotUser function when creating bot users for applications. This allows developers to specify which user template to use for their application's bot user.

Diagram

sequenceDiagram
    participant Admin as Admin User
    participant API as API Server
    participant DB as Database
    participant UserSvc as User Service

    Note over Admin, UserSvc: Creating User Template
    Admin->>API: POST /users/{id}/templates<br/>{name, description}
    API->>API: Check MANAGE_USERS rights
    API->>DB: Fetch existing user
    API->>UserSvc: serializeUser(user)
    UserSvc->>DB: Create UserTemplate record
    DB->>API: Return template
    API->>Admin: Return created template

    Note over Admin, UserSvc: Using User Template
    Admin->>API: POST /users/templates/{code}<br/>{username?, email?}
    API->>API: Check MANAGE_USERS rights
    API->>DB: Fetch UserTemplate by code
    API->>UserSvc: createUserFromTemplate(template, overrides)
    UserSvc->>UserSvc: Merge template data with overrides
    UserSvc->>UserSvc: Call User.register() with merged data
    UserSvc->>DB: Create new User
    DB->>API: Return created user
    API->>Admin: Return user/token

    Note over Admin, UserSvc: Bot Creation with Template
    Admin->>API: POST /applications<br/>{name, botTemplateCode?}
    API->>UserSvc: createAppBotUser(app, req, templateCode)
    UserSvc->>DB: Fetch UserTemplate (if specified)
    UserSvc->>UserSvc: Apply template or use defaults
    UserSvc->>DB: Create bot user
    DB->>API: Return application with bot
    API->>Admin: Return application

Import In IDE

🤖 Prompt for AI Agents

I have created the following plan after thorough exploration and analysis of the codebase. Follow the below plan verbatim. Trust the files and references. Do not re-verify what's written in the plan. Explore only when absolutely necessary. First implement all the proposed file changes and then I'll review all the changes together at the end.

### Observations

I've analyzed a Discord-like chat server implementation with comprehensive user management, guild templates, bot creation, and a sophisticated rights system. The codebase already has guild templates that serialize guild configurations for reuse, bot user creation via `createAppBotUser()`, and a robust rights system with flags like `MANAGE_USERS` and `CREATE_REGISTRATION_TOKENS`. The request is for "User templates" to create user accounts for bots and controlled users more easily, which would complement the existing guild template system.

### Approach

I'll implement a User Template system that mirrors the existing Guild Template pattern. This will include a new `UserTemplate` entity to store serialized user configurations, API routes for creating and using templates, configuration options, and integration with the existing user creation flow. The system will require admin rights (`MANAGE_USERS`) and will extend the current `User.register()` method to accept template data. This approach reuses proven patterns while adding the requested functionality for easier bot and controlled user creation.

### Reasoning

I explored the codebase structure and found it's a comprehensive Discord-like server with multiple services (API, CDN, Gateway, WebRTC). I examined the existing guild template system, user registration process, bot creation functionality, and rights management system. I also looked at the configuration framework, database migration system, and existing admin routes to understand the patterns used for privileged operations.

## Mermaid Diagram

sequenceDiagram
    participant Admin as Admin User
    participant API as API Server
    participant DB as Database
    participant UserSvc as User Service

    Note over Admin, UserSvc: Creating User Template
    Admin->>API: POST /users/{id}/templates<br/>{name, description}
    API->>API: Check MANAGE_USERS rights
    API->>DB: Fetch existing user
    API->>UserSvc: serializeUser(user)
    UserSvc->>DB: Create UserTemplate record
    DB->>API: Return template
    API->>Admin: Return created template

    Note over Admin, UserSvc: Using User Template
    Admin->>API: POST /users/templates/{code}<br/>{username?, email?}
    API->>API: Check MANAGE_USERS rights
    API->>DB: Fetch UserTemplate by code
    API->>UserSvc: createUserFromTemplate(template, overrides)
    UserSvc->>UserSvc: Merge template data with overrides
    UserSvc->>UserSvc: Call User.register() with merged data
    UserSvc->>DB: Create new User
    DB->>API: Return created user
    API->>Admin: Return user/token

    Note over Admin, UserSvc: Bot Creation with Template
    Admin->>API: POST /applications<br/>{name, botTemplateCode?}
    API->>UserSvc: createAppBotUser(app, req, templateCode)
    UserSvc->>DB: Fetch UserTemplate (if specified)
    UserSvc->>UserSvc: Apply template or use defaults
    UserSvc->>DB: Create bot user
    DB->>API: Return application with bot
    API->>Admin: Return application

## Proposed File Changes

### src/util/entities/UserTemplate.ts(NEW)

References: 

- src/util/entities/Template.ts
- src/util/entities/BaseClass.ts
- src/util/entities/User.ts

Create a new UserTemplate entity following the same pattern as the existing `Template` entity in `/tmp/github/issues/5833034_537382467_1755800828615/src/util/entities/Template.ts`. Include fields for `code` (unique identifier), `name`, `description`, `usage_count`, `creator_id` (relation to User), `created_at`, `updated_at`, and `serialized_user` (JSON field containing the user template data). Use TypeORM decorators and extend BaseClass similar to the Template entity.

### src/util/config/types/UserTemplateConfiguration.ts(NEW)

References: 

- src/util/config/types/TemplateConfiguration.ts

Create a new configuration class for user templates, similar to `TemplateConfiguration` in `/tmp/github/issues/5833034_537382467_1755800828615/src/util/config/types/TemplateConfiguration.ts`. Include boolean flags for `enabled`, `allowTemplateCreation`, `allowDiscordTemplates` (for future compatibility), and `allowRaws` (for importing raw user data). Set appropriate defaults (enabled: true, allowTemplateCreation: true, etc.).

### src/util/config/types/index.ts(MODIFY)

References: 

- src/util/config/types/UserTemplateConfiguration.ts(NEW)

Add export for the new UserTemplateConfiguration class to make it available for import in other parts of the system.

### src/util/config/Config.ts(MODIFY)

References: 

- src/util/config/types/UserTemplateConfiguration.ts(NEW)
- src/util/config/types/TemplateConfiguration.ts

Add a `userTemplates` property of type UserTemplateConfiguration to the main Config class, following the same pattern as the existing `templates` property. This will make user template configuration accessible via `Config.get().userTemplates`.

### src/util/entities/index.ts(MODIFY)

References: 

- src/util/entities/UserTemplate.ts(NEW)

Add export for the new UserTemplate entity to make it available for import throughout the application.

### src/util/schemas/UserTemplateCreateSchema.ts(NEW)

References: 

- src/util/schemas/TemplateCreateSchema.ts

Create a schema for user template creation requests, similar to `TemplateCreateSchema` in `/tmp/github/issues/5833034_537382467_1755800828615/src/util/schemas/TemplateCreateSchema.ts`. Include required `name` field and optional `description` field. This will be used for API validation when creating new user templates.

### src/util/schemas/UserTemplateModifySchema.ts(NEW)

References: 

- src/util/schemas/TemplateModifySchema.ts

Create a schema for user template modification requests, similar to `TemplateModifySchema` in `/tmp/github/issues/5833034_537382467_1755800828615/src/util/schemas/TemplateModifySchema.ts`. Include `name` and optional `description` fields for updating existing user templates.

### src/util/schemas/UserFromTemplateCreateSchema.ts(NEW)

References: 

- src/util/schemas/RegisterSchema.ts
- src/util/entities/User.ts

Create a schema for creating users from templates. Include optional fields like `username` (to override template username), `email`, and other user properties that can be customized when instantiating a user from a template. This allows flexibility when creating users from templates while maintaining the template's base configuration.

### src/util/schemas/index.ts(MODIFY)

References: 

- src/util/schemas/UserTemplateCreateSchema.ts(NEW)
- src/util/schemas/UserTemplateModifySchema.ts(NEW)
- src/util/schemas/UserFromTemplateCreateSchema.ts(NEW)

Add exports for the new user template schemas (UserTemplateCreateSchema, UserTemplateModifySchema, UserFromTemplateCreateSchema) to make them available for import in API routes and validation.

### src/util/util/UserTemplate.ts(NEW)

References: 

- src/util/util/Application.ts(MODIFY)
- src/util/entities/User.ts
- src/util/entities/UserTemplate.ts(NEW)

Create utility functions for user template operations. Include `serializeUser(user: User)` to convert a User entity to template JSON, `createUserFromTemplate(template: UserTemplate, overrides: Partial<User>, req?: Request)` to instantiate users from templates, and validation functions. This file will contain the core logic for template serialization and user creation, similar to how `Application.ts` contains `createAppBotUser()`.

### src/util/util/index.ts(MODIFY)

References: 

- src/util/util/UserTemplate.ts(NEW)

Add exports for the new UserTemplate utility functions to make them available throughout the application.

### src/api/routes/users/templates(NEW)

Create a new directory for user template API routes, following the same structure as the existing guild templates in `/tmp/github/issues/5833034_537382467_1755800828615/src/api/routes/guilds/templates/`.

### src/api/routes/users/templates/index.ts(NEW)

References: 

- src/api/routes/guilds/templates/index.ts
- src/util/util/UserTemplate.ts(NEW)
- src/util/entities/UserTemplate.ts(NEW)

Create the main user templates API route handler, similar to `/tmp/github/issues/5833034_537382467_1755800828615/src/api/routes/guilds/templates/index.ts`. Implement GET `/:code` to retrieve a user template and POST `/:code` to create a user from a template. Include proper rights checking (`MANAGE_USERS`), configuration validation (check if user templates are enabled), and error handling. The POST route should use the `createUserFromTemplate` utility function and return the created user or a token.

### src/api/routes/users/#id/templates(NEW)

Create a directory for user-specific template operations, allowing creation of templates from existing users.

### src/api/routes/users/#id/templates/index.ts(NEW)

References: 

- src/util/util/UserTemplate.ts(NEW)
- src/util/schemas/UserTemplateCreateSchema.ts(NEW)
- src/util/entities/UserTemplate.ts(NEW)

Create API route for creating user templates from existing users. Implement POST route that takes a UserTemplateCreateSchema (name, description) and creates a new UserTemplate by serializing the specified user. Require `MANAGE_USERS` rights and validate that user templates are enabled in configuration. Use the `serializeUser` utility function to convert the user to template format.

### src/api/routes/users/templates/manage(NEW)

Create a directory for user template management operations (list, modify, delete templates).

### src/api/routes/users/templates/manage/index.ts(NEW)

References: 

- src/util/entities/UserTemplate.ts(NEW)
- src/util/schemas/UserTemplateCreateSchema.ts(NEW)
- src/util/schemas/UserTemplateModifySchema.ts(NEW)

Create API routes for managing user templates. Implement GET route to list all user templates (with pagination), POST route to create a new template from scratch, PUT `/:code` to modify existing templates, and DELETE `/:code` to remove templates. All routes require `MANAGE_USERS` rights and should check if user templates are enabled. Include proper error handling and validation using the UserTemplate schemas.

### src/util/migration/postgres/1755800828615-userTemplates.ts(NEW)

References: 

- src/util/migration/postgres/1673609867556-templateDeleteCascade.ts
- src/util/entities/UserTemplate.ts(NEW)

Create a database migration for PostgreSQL to add the user_templates table. Include columns for id, code (unique), name, description, usage_count, creator_id (foreign key to users), created_at, updated_at, and serialized_user (JSON). Follow the same pattern as existing migrations in the postgres directory and ensure proper indexing on the code field for performance.

### src/util/migration/mysql/1755800828615-userTemplates.ts(NEW)

References: 

- src/util/migration/mysql/1673609465036-templateDeleteCascade.ts
- src/util/entities/UserTemplate.ts(NEW)

Create a database migration for MySQL to add the user_templates table, identical to the PostgreSQL version but with MySQL-specific syntax. Follow the pattern of existing MySQL migrations in the mysql directory.

### src/util/migration/mariadb/1755800828615-userTemplates.ts(NEW)

References: 

- src/util/migration/mariadb/1673609465036-templateDeleteCascade.ts
- src/util/entities/UserTemplate.ts(NEW)

Create a database migration for MariaDB to add the user_templates table, identical to the MySQL version. Follow the pattern of existing MariaDB migrations in the mariadb directory.

### src/util/util/Application.ts(MODIFY)

References: 

- src/util/util/UserTemplate.ts(NEW)
- src/util/entities/UserTemplate.ts(NEW)

Modify the `createAppBotUser` function to accept an optional `templateCode` parameter. If provided, use the specified user template to create the bot user instead of the default hardcoded values. This allows applications to use predefined bot templates while maintaining backward compatibility. Import the `createUserFromTemplate` function and UserTemplate entity to implement this functionality.

### src/api/routes/applications/index.ts(MODIFY)

References: 

- src/util/util/Application.ts(MODIFY)
- src/util/schemas/ApplicationCreateSchema.ts

Modify the application creation route to accept an optional `botTemplateCode` parameter in the ApplicationCreateSchema. Pass this parameter to the `createAppBotUser` function when creating bot users for applications. This allows developers to specify which user template to use for their application's bot user.

Developer Humor

Why did the user template go to therapy?
Because it had too many identity issues! 🎭
It kept copying other users' personalities
And couldn't figure out who it really was...
But now it helps bots find themselves! 🤖✨
Template.serialize(happiness)

Execution Information

Branch: master
Commit: e031e72

💡 Tips

Supported Commands (Inside Comments)

Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

User templates #30

Description

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions