Events reference

This page lists what Events adds to your server: hooks, routes, tables and translations. It is for app developers and module authors. Set up the module first: Overview.

Hooks

Your app answers these Nitro hooks from a server plugin (server/plugins/*.ts).

type PurchaseBeforeContext = { event: H3Event, userId: number, eventId: string, ticketTypeId: string, addonIds: string[] }
type TicketHookContext = { ticket: TicketDto }
type MembershipCheckContext = { userId: number, requirement: 'any' | string[], satisfied: boolean }
type MembershipOptionsContext = { available: boolean, options: Array<{ value: string, label: string }> }

A membership rule (requiresMembership, excludesMembership) is null for nobody, 'any' for any active membership, or a list of membership keys.

Routes

Routes the module registers, and who may call them. Public and self-service routes are under /api/events, and staff routes under /api/admin/events. Build the paths with eventsApi from @frigear-nu/events/api, for example eventsApi.admin.event(id).

• Permissions. A row names the permission the route checks with authorize. A token also needs a scope that covers it, as Access control explains.
• Staff means the caller holds events:manage through a role. See Let staff manage events.
• Errors carry a snake_case data.code, such as not_found or conflict. Validation failures are h3's 400.

GET /api/admin/events takes page, pageSize (at most 100), q (the name in any language, or the slug), status, sort (startsAt, createdAt, slug or status) and order. It answers { items, total, page, pageSize }.

GET /api/admin/events/:id/tickets takes q (the holder's name or email), status and sort (createdAt, status, checkedInAt, name or email).

POST /api/admin/events/tickets/:id/refund moves money, so events:refund is a session-only permission. A token gets 403 session_required. Only a paid ticket with a payment can be refunded.

Deletes answer 404 not_found when the row does not exist. Static segments such as me, upcoming and check-in win over :slug and :id.

Database

Tables the module adds. Generate and commit a migration after installing. Payments, Users and Subscriptions need theirs too.

Translated texts are a string or a { da, en } map.

Translations

Override any string in your app's i18n/locales/<code>.json. The module registers da and en files under events.*. See overriding module strings. Without @nuxtjs/i18n, the pages use en.

{ "events": { "upcoming": { "title": "What's on" } } }

Key groups: upcoming.*, ongoing.*, past.*, detail.* (with the purchase flow), tickets.* (with tickets.status.*), cart.*, menu.* and admin.* (with admin.tabs.* and admin.statuses.*). Top-level keys include title, empty, loading, ticketReady, paymentReceived and purchaseFailed.

Next steps

• Server API – the purchase checks behind these routes.
• Send an email – send the ticket confirmation from events:ticket:paid.
• Payments – the payments:* hooks and refunds behind a ticket's status.