Skip to content

docs: add document schema privacy compliance #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Destinea merged 1 commit into from
Jul 18, 2026
Merged

docs: add document schema privacy compliance #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ docker compose -f docker-compose.timescale.yml -f docker-compose.valkey.yml up -
```

See [`database/README.md`](database/README.md) and
[`docs/database-workflows.md`](docs/database-workflows.md).
[`docs/database-workflows.md`](docs/database-workflows.md). Privacy and retention
requirements for personal-data schemas live in
[`database/timescale/privacy_compliance.md`](database/timescale/privacy_compliance.md).

### Design tokens

Expand Down
24 changes: 24 additions & 0 deletions database/timescale/privacy_compliance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Timescale Privacy Compliance Notes

The DevKit Timescale schemas define personal-data stores used by the ClashKing mobile app, dashboard, tracking service, bot, and admin panel. Schema changes must preserve privacy controls across every client.

## Personal-data tables and fields

- `auth_users`, `auth_discord_tokens`, `auth_refresh_tokens`, `one_time_login_tokens`, `auth_password_reset_tokens`, and `api_tokens` contain account, authentication, and token metadata.
- `player_links`, `user_settings`, `user_bookmarks`, `user_recent_searches`, `search_groups`, rosters, reminders, tickets, and moderation records can link Discord users to Clash of Clans player tags and server workflows.
- `mobile_push_devices`, `mobile_notification_preferences`, `mobile_notification_subscriptions`, and `mobile_live_activities` contain device identifiers, encrypted push tokens, account filters, and notification preferences.
- `admin_users`, `admin_sessions`, and `admin_audit_events` contain administrator identity, session, IP address, user-agent, action, and resource data.

## Required schema practices

- Store raw push tokens only encrypted (`*_ciphertext`) and use hashes (`*_hash`) for lookup and dedupe.
- Add expiry indexes or retention policies to session, one-time-login, password-reset, recent-search, telemetry, and process-stat tables.
- Prefer cascading deletes from authenticated user tables for tokens and device rows.
- Keep audit tables append-only for accountability, but mask/minimize IP and user-agent values in exports.
- Do not add advertising IDs, contact-list data, precise location, health, biometric, or other sensitive categories without a dedicated legal/design review.

## Request handling

Verified access/export requests should include account, token metadata without secrets, preferences, bookmarks, recent searches, player links, device registrations without raw tokens, notification settings, and relevant dashboard/bot records.

Verified erasure requests should delete or anonymize user-owned rows while preserving records needed for security, abuse prevention, tax/accounting, or legal obligations. Public Clash of Clans history may remain only after account links are removed.
Loading