# RapidKit Users Profiles Module

Profile management services and HTTP adapters for RapidKit users

This README follows the shared RapidKit module format:

1. **Overview & capabilities**
1. **Installation commands**
1. **Directory layout**
1. **Generation workflow**
1. **Runtime customisation hooks**
1. **Testing & release checklist**
1. **Reference links**

Use the same headings when documenting other modules so maintainers know what to expect.

As a RapidKit module, this module also follows the shared metadata/documentation standard:

- `module.yaml` is the canonical source of truth (including the `documentation:` map).
- Module docs live under `docs/` and should match the keys referenced from `module.yaml`.
- The module changelog is maintained in `docs/changelog.md` and referenced both from `module.yaml`
  and this README.

______________________________________________________________________

## Module Capabilities

- **Profile domain** – Pydantic models describe biographies, social links, time zones, and
  visibility controls associated with a user account.
- **Service facade** – `UserProfileService` coordinates repository persistence, validation, and
  optional user-existence checks with async-friendly APIs.
- **Repository protocol** – Plug in your own persistence by implementing the
  `UserProfileRepositoryProtocol`; an in-memory repository is bundled for tests and demos.
- **Framework adapters** – FastAPI dependency providers and routers plus a NestJS service mirror the
  same contract for polyglot teams.
- **Health telemetry** – `/api/health/module/users_profiles` surfaces configuration state and
  repository reachability for monitoring stacks.

______________________________________________________________________

## Install Commands

```bash
rapidkit add module users_profiles
```

Re-run `rapidkit modules lock --overwrite` after adding or upgrading the module so downstream
projects capture the new snapshot.

### Quickstart

Follow the end-to-end walkthrough in `docs/usage.md`.

______________________________________________________________________

## Directory Layout

| Path               | Responsibility                                                              |
| ------------------ | --------------------------------------------------------------------------- |
| `module.yaml`      | Canonical metadata (version, compatibility, documentation map)              |
| `config/base.yaml` | Declarative spec that drives prompts and dependency resolution              |
| `generate.py`      | CLI/automation entry point for rendering vendor and project variants        |
| `frameworks/`      | Framework plugin implementations registered via `modules.shared.frameworks` |
| `overrides.py`     | Runtime opt-in hooks applied via environment variables                      |
| `docs/`            | Module docs referenced from `module.yaml` (usage/overview/changelog)        |
| `templates/`       | Base templates plus per-framework variants                                  |

______________________________________________________________________

## Generation Workflow

1. `generate.py` loads `module.yaml` and checks version drift with
   `modules.shared.versioning.ensure_version_consistency`.
1. Vendor artefacts are rendered from templates into `.rapidkit/vendor/...` for reproducible
   installs.
1. The requested framework plugin maps templates into project-relative paths.
1. Optional lifecycle hooks (`pre_generation_hook`, `post_generation_hook`) handle final
   adjustments.

______________________________________________________________________

## Runtime Customisation

| Environment Variable                             | Effect                                              |
| ------------------------------------------------ | --------------------------------------------------- |
| `RAPIDKIT_USERS_PROFILES_DEFAULT_TIMEZONE`       | Default time zone applied when profiles omit one.   |
| `RAPIDKIT_USERS_PROFILES_MAX_BIO_LENGTH`         | Upper bound (characters) enforced for biographies.  |
| `RAPIDKIT_USERS_PROFILES_AVATAR_MAX_BYTES`       | Maximum avatar payload size expected by uploads.    |
| `RAPIDKIT_USERS_PROFILES_ALLOW_MARKETING_OPT_IN` | Toggle marketing opt-in support in templates.       |
| `RAPIDKIT_USERS_PROFILES_SOCIAL_LINKS_LIMIT`     | Limit the number of social URLs stored per profile. |
| `RAPIDKIT_USERS_PROFILES_DEFAULT_VISIBILITY`     | Global fallback for profile visibility state.       |

Override values can also be supplied through your project settings by exposing attributes that map
onto the same names used in `UserProfileSettings`.

______________________________________________________________________

## Security & Audit

This module ships as part of the RapidKit module ecosystem and is intended to be **audited** as a
unit:

- Use `scripts/modules_doctor.py` (or `rapidkit modules vet`) to validate structure and generator
  invariants.
- Use `rapidkit modules verify-all` to verify recorded hashes/signatures when running in release
  mode.

If you extend this module, keep the documentation updated with the security assumptions and any
threat model relevant to your deployment.

______________________________________________________________________

## Testing Checklist

```bash
poetry run pytest tests/modules/free/users/users_profiles -q

poetry run python scripts/check_module_integrity.py --module free/users/users_profiles
```

______________________________________________________________________

## Release Checklist

1. Update templates and/or `module.yaml`.
1. Regenerate vendor snapshots and project variants for every supported framework.
1. Inspect rendered files (`.rapidkit/vendor` and sample project outputs) for accuracy.
1. Execute the testing checklist above; ensure versioning is bumped when content hashes change.
1. Commit regenerated assets alongside the updated metadata.

______________________________________________________________________

## Reference Documentation

- Overview: `docs/overview.md`
- Usage guide: `docs/usage.md`
- Advanced scenarios: `docs/advanced.md`
- Monitoring: `docs/monitoring.md`
- Changelog: `docs/changelog.md`
- Migration playbook: `docs/migration.md`
- Troubleshooting: `docs/troubleshooting.md`
- API reference: `docs/api-reference.md`
- Override contracts: `overrides.py`

For additional help, open an issue at <https://github.com/getrapidkit/rapidkit-core/issues> or
consult the full product documentation at <https://docs.rapidkit.top>.
