Padreug
5541d2bc7a
## Why
The module was named `activities` originally to avoid colliding with Nostr's `Event` type. In practice that defense added friction without preventing confusion — the backend extension is named `events`, NIP-52 calls them "Calendar Events", and the UI already displayed "Events". The collision with `nostr-tools` `Event` is handled cleanly by the existing `import { Event as NostrEvent }` alias pattern (already in 5 files inside the module). Renaming collapses the 4-way mismatch into one consistent term.
Separately, deployments needed per-instance app names. `VITE_APP_NAME` was already plumbed per-standalone via NixOS `services.webapp-standalones.<app>.displayName` (e.g. cfaun shipped `"Sortir"`, now rebranded to `"Bouge"`), but nothing in the standalone consumed it — PWA manifest, HTML title, and runtime branding were all hardcoded. This PR wires the env through every app-name display point so any deploy can flip `displayName = "Bouge"` (or anything) and pick up the brand end-to-end.
## What
Nine commits on the branch:
1. **`refactor(events): rename activities module to events`** — 70-file rename. `src/modules/activities/` → `src/modules/events/`, `src/activities-app/` → `src/events-app/`, types/services/composables/views/components/store renamed (`Activity`→`Event`, `Activities`→`Events`). Routes `/activities/*` → `/events/*`; the legacy `/events` (ticketing management) moves to `/my-events` so `/events` belongs to the canonical feed. DI tokens `ACTIVITIES_*` → `EVENTS_*`. i18n namespace renamed; English domain strings updated, French/Spanish title key realigned. npm scripts `:activities` → `:events`. Build output `dist-activities/` → `dist-events/`.
2. **`feat(events): wire VITE_APP_NAME through PWA manifest, HTML, runtime`** — PWA manifest `name`/`short_name` template from `process.env.VITE_APP_NAME` with fallback `'Events'`. `events.html` uses Vite's `%VITE_APP_NAME%` substitution. `src/events-app/app.ts` + `main.ts` runtime brand string drives console logs, offline notification, and `acceptTokenFromUrl()`. `events.title` route meta sources from VITE_APP_NAME. `.env.example` updated with per-standalone scoping notes.
3. **`docs(events): update activities→events references`** — `docs/nostr-patterns/*.md` "Canonical: src/modules/activities/composables/useRSVP.ts" anchors point at renamed paths. CLAUDE.md Payment Rails Pattern section updated.
4. **`fix(events): drop lowercase from PWA description brand name`** — minor casing fix caught during verification.
5. **`fix(events): use domain noun in description, not brand name`** — manifest + HTML description switched from `"Discover ${BRAND} near you"` to static `"Discover events near you"`. Description is about *what* the app does, not the brand.
6. **`chore(events): scrub leftover sortir/activities references`** — nginx.conf.example, package.json (concurrently process label + `build:demo` BASE_PATH), router-helpers comment, useMarket comment, and vite.events.config.ts doc-comment.
7. **`refactor(events): conditional brand in console label, tighten docs`** — adds `APP_LABEL` next to `APP_NAME` in `events-app/app.ts`. Reads as `Events` on unbranded builds and `Events (Bouge)` (etc.) when `VITE_APP_NAME` is set to anything other than "Events" (case-insensitive). Used by all four console messages; `acceptTokenFromUrl` keeps the raw `APP_NAME` (it's a token-namespace identifier, not display copy). Also collapses the redundant "cfaun sets X; future deployments can override (e.g. X)" doc-comment.
8. **`i18n(events): finish activité/actividad → événement/evento sweep`** — completes the i18n rename in fr.ts and es.ts (search placeholders, favorites prompts, settings prompt) and fixes five gender-agreement errors that came along with the masculine `événement`/`evento` switch (French: `Aucune ... trouvée`→`Aucun ... trouvé`, `préférées`→`préférés`, `d'une ... la sauvegarder`→`d'un ... le sauvegarder`; Spanish: `favoritas`→`favoritos`, `guardarla`→`guardarlo`).
9. **`chore(events): finish sortir → bouge sweep in .env.example`** — four remaining doc-comment refs in `.env.example` (cfaun branding, ticket-scanner comment, section header, subdomain-mode URL example).
## Cross-repo coordination
This PR has matching changes already pushed to two other repos. They have to land in a coordinated bump because the names are tightly coupled.
- **`aiolabs/webapp-module` main** — commit `9d82016`. Renames `hubActivitiesUrl` → `hubEventsUrl` and `VITE_HUB_ACTIVITIES_URL` → `VITE_HUB_EVENTS_URL`. No backwards-compat shim.
- **`aiolabs/server-deploy` main** — commits `f15e1eb`, `bf4698b`, `d46a520`:
- `standalones.nix` `apps.events` uses `build:events` / `dist-events` / `events.html`; `hubUrlOption` maps `events → "hubEventsUrl"`; comment + cfaun-as-example doc switched from sortir/Sortir to bouge/Bouge.
- `hosts/cfaun/default.nix` rebranded: `subdomain = "bouge"` + `displayName = "Bouge"`. (Native-French feedback retired the "Sortir" branding as awkward.)
- `hosts/atio/default.nix` stale "activities app" comment dropped (atio's `displayName = "Eventos"` config is unchanged).
server-deploy's `flake.lock` still pins the OLD webapp + OLD webapp-module, so nix builds from server-deploy main will fail until the bumps. Suggested order after this PR merges to `dev`: one server-deploy commit that does `nix flake lock --update-input webapp-module` + `--update-input webapp-demo` together. DNS for `bouge.ariege.io` needs to point at the cfaun host before the deploy lands.
## Verification
- `pnpm typecheck` — clean ✓
- `pnpm build:events` (default) — `dist-events/manifest.webmanifest` has `name: "Events"`, description "Discover events near you" ✓
- `VITE_APP_NAME=Bouge pnpm build:events` — `name: "Bouge"`, HTML title "Bouge", console label resolves to `Events (Bouge)` ✓
- Cross-repo grep sweep: no `Sortir`/`sortir`/`activities`/`Activities` references in events-module scope. (Domain false positives — "Market Activity" in market dashboard, "time-based activities" in nostr-feed content filters, "Activity Lifecycle Kills" in CLAUDE.md mobile-browser docs — are unrelated and intentionally left alone.)
Not verified in-browser (no GUI in this session) — needs a manual smoke at `app.ariege.io/bouge/` once the coordinated flake bump lands on cfaun. Watch for: feed loads, `/events/calendar`, `/events/map`, `/events/favorites`, `/events/:id` routes work; "My Events" appears in the user dropdown and `/my-events` shows the management page; PWA install prompt shows "Bouge".
## Out of scope (deferred)
- Backend extension rename — `aiolabs/events` is already named correctly.
- Nix standalone attribute name — `services.webapp-standalones.events` is already correct.
- Overriding domain-noun strings ("Your event was created", RSVP labels) — those stay locale-driven; `VITE_APP_NAME` covers app-name only.
- Backwards-compat redirects from `/activities/*` to `/events/*` — pre-launch, public URL was `/sortir/` (path-mode) or `sortir.ariege.io` (subdomain-mode), never `/activities/`. No external bookmarks to preserve. (`sortir.ariege.io` → `bouge.ariege.io` is a separate decision; up to the deploy operator whether to keep a 301 for word-of-mouth referrers.)
Reviewed-on: #94
66 lines
3.1 KiB
Markdown
66 lines
3.1 KiB
Markdown
# Nostr patterns
|
|
|
|
Living reference for reusable Nostr patterns that show up across modules
|
|
(events, forum, market, chat, tasks, base, nostr-feed).
|
|
|
|
**Read before writing any new Nostr code in this repo.** **Update whenever you
|
|
introduce, refine, or correct a pattern.** Each section has a "Canonical
|
|
implementation" line — that's the file the pattern was harvested from. If a
|
|
caller deviates, document why or align with the canonical version.
|
|
|
|
The single biggest reason this directory exists: Nostr's edge cases (relay
|
|
dedup, replaceable events, reactivity-of-nested-Map, EOSE timing) are subtle
|
|
enough that re-deriving them per module produces different bugs each time.
|
|
Consolidating the *resolution* prevents that.
|
|
|
|
## Index
|
|
|
|
- [**Subscriptions & lifecycle**](./subscriptions.md) — RelayHub usage, EOSE,
|
|
unsubscribe on unmount, visibility-aware reconnect.
|
|
- [**Replaceable events**](./replaceable-events.md) — NIP-01 §13 semantics,
|
|
monotonic `created_at`, per-pubkey latest-wins state, replaceable bookmark
|
|
lists.
|
|
- [**Publishing & confirmation**](./publishing.md) — `RelayHub.publishEvent`
|
|
result checks, optimistic updates, signing with `nostr-tools`, pending-coord
|
|
debounce.
|
|
- [**Reactions, deletions & dedup**](./reactions-and-deletions.md) — NIP-25
|
|
toggle, NIP-09 deletion handling, per-event-id dedup.
|
|
- [**Profiles & batch fetch**](./profiles.md) — kind-0 caching, request dedup.
|
|
- [**Services, DI & reactivity**](./services-and-di.md) — `BaseService`,
|
|
`tryInjectService`, exposing service state via computed, Vue 3 nested
|
|
ref-Map reactivity gotchas.
|
|
|
|
Patterns specific to a single NIP that doesn't repeat across modules
|
|
(currently: NIP-59 gift-wrapped market orders) are not listed here yet — only
|
|
the cross-cutting patterns. When a second consumer adopts an NIP-specific
|
|
pattern, promote it.
|
|
|
|
## Conventions
|
|
|
|
- **Canonical implementation** is a single file path with line numbers. If a
|
|
pattern lives in multiple modules, list one canonical and the rest as
|
|
"alternates" with a short note on what differs.
|
|
- **Why** sections explain the failure mode the pattern prevents — not just
|
|
what it does. If the why is obvious from the code, omit it.
|
|
- **Cross-link** by file when patterns compose (e.g. replaceable events almost
|
|
always pair with the pending-coord debounce).
|
|
- Don't duplicate code into the docs. Reference file:line and quote at most
|
|
the 5-line core. Drift between code and docs is the failure mode.
|
|
|
|
## Updating
|
|
|
|
When you implement a new pattern (or fix a subtle bug in an existing one):
|
|
|
|
1. Add or amend the relevant topic file — leave a brief "added 2026-MM-DD,
|
|
from <module>" note if it helps trace provenance.
|
|
2. If it's a brand-new topic, add a section to this README's index and create
|
|
a new topic file.
|
|
3. If the pattern obsoletes an alternate implementation listed here, either
|
|
align that implementation or note explicitly why it diverges.
|
|
|
|
## Improving
|
|
|
|
We periodically deep-dive into well-known open-source Nostr apps (Coracle,
|
|
Snort, Damus, NoStrudel, Habla, Highlighter, Flotilla, Zap.cooking) to mine
|
|
patterns we haven't reinvented yet. Tracked as a recurring issue on Forgejo
|
|
(`aiolabs/webapp`). Findings land here.
|