// ── Push-notification self-service under /auth/me ────────────────────────── // // Device registration + per-user stream subscriptions for the app's opt-in push // (docs/android/PLAN.md §11). Mounted at /me by auth/index.js alongside // me.routes.js, behind requireAuth ONLY (role-agnostic — every authenticated // role manages its own devices/subscriptions), and noindex. The app calls these // and never touches /admin. const express = require('express') const { body, param } = require('express-validator') const notif = require('./notifications.controller') const { requireAuth } = require('../../../auth/session.middleware') const noindex = require('../../../middleware/noindex') const validate = require('../../../middleware/validate') const notifRouter = express.Router() notifRouter.use(noindex, requireAuth) // ── Devices ──────────────────────────────────────────────────────────────── notifRouter.post( '/devices', // #swagger.tags = ['Auth · Me'] // #swagger.summary = 'Register a push device (endpoint) for the current user' // #swagger.description = 'Registers a UnifiedPush/ntfy endpoint (or an FCM token) so the backend can deliver opt-in push tickles. The endpoint must be an allowed HTTPS relay URL — private/loopback hosts and non-allowed origins are rejected 400. Idempotent per (user, endpoint).' // #swagger.security = [{ "cookieAuth": [] }, { "bearerAuth": [] }] /* #swagger.requestBody = { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/RegisterDeviceRequest" } } } } */ /* #swagger.responses[201] = { description: 'Device registered', content: { "application/json": { schema: { $ref: "#/components/schemas/PushDevice" } } } } */ /* #swagger.responses[400] = { description: 'Validation error or disallowed endpoint', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */ /* #swagger.responses[401] = { description: 'Not authenticated', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */ body('endpoint').isString().trim().isURL({ protocols: ['https'], require_protocol: true }).isLength({ max: 512 }), body('transport').optional().isIn(['unifiedpush', 'fcm']), body('platform').optional({ values: 'falsy' }).isString().isLength({ max: 40 }), validate, notif.registerDevice, ) notifRouter.get( '/devices', // #swagger.tags = ['Auth · Me'] // #swagger.summary = 'List the current user’s registered push devices' // #swagger.security = [{ "cookieAuth": [] }, { "bearerAuth": [] }] /* #swagger.responses[200] = { description: 'Registered devices', content: { "application/json": { schema: { type: "array", items: { $ref: "#/components/schemas/PushDevice" } } } } } */ /* #swagger.responses[401] = { description: 'Not authenticated', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */ notif.listDevices, ) notifRouter.delete( '/devices/:id', // #swagger.tags = ['Auth · Me'] // #swagger.summary = 'Unregister a push device' // #swagger.security = [{ "cookieAuth": [] }, { "bearerAuth": [] }] // #swagger.parameters['id'] = { in: 'path', required: true, schema: { type: 'integer' }, description: 'Device id (must belong to the caller).' } /* #swagger.responses[200] = { description: 'Unregistered', content: { "application/json": { schema: { $ref: "#/components/schemas/OkFlag" } } } } */ /* #swagger.responses[404] = { description: 'No such device for this user', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */ param('id').isInt({ min: 1 }), validate, notif.removeDevice, ) // ── Streams catalog + subscriptions ───────────────────────────────────────── notifRouter.get( '/notifications/streams', // #swagger.tags = ['Auth · Me'] // #swagger.summary = 'List subscribable notification streams (catalog)' // #swagger.description = 'The catalog of push streams. `personal`/`requiresLinkedAccount` streams are delivered only to the owning user and need a linked game account.' // #swagger.security = [{ "cookieAuth": [] }, { "bearerAuth": [] }] /* #swagger.responses[200] = { description: 'Stream catalog', content: { "application/json": { schema: { $ref: "#/components/schemas/NotificationStreams" } } } } */ /* #swagger.responses[401] = { description: 'Not authenticated', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */ notif.getStreams, ) notifRouter.get( '/notifications/subscriptions', // #swagger.tags = ['Auth · Me'] // #swagger.summary = 'Get the current user’s notification subscriptions' // #swagger.security = [{ "cookieAuth": [] }, { "bearerAuth": [] }] /* #swagger.responses[200] = { description: 'Subscribed stream ids', content: { "application/json": { schema: { $ref: "#/components/schemas/NotificationSubscriptions" } } } } */ /* #swagger.responses[401] = { description: 'Not authenticated', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */ notif.getSubscriptions, ) notifRouter.put( '/notifications/subscriptions', // #swagger.tags = ['Auth · Me'] // #swagger.summary = 'Replace the current user’s notification subscriptions' // #swagger.description = 'Sets the full opted-in stream set (applied to all the user’s devices). Unknown stream ids are ignored; the stored set is echoed back.' // #swagger.security = [{ "cookieAuth": [] }, { "bearerAuth": [] }] /* #swagger.requestBody = { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/NotificationSubscriptions" } } } } */ /* #swagger.responses[200] = { description: 'Updated subscriptions', content: { "application/json": { schema: { $ref: "#/components/schemas/NotificationSubscriptions" } } } } */ /* #swagger.responses[400] = { description: 'Validation error', content: { "application/json": { schema: { $ref: "#/components/schemas/ValidationError" } } } } */ /* #swagger.responses[401] = { description: 'Not authenticated', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */ body('streams').isArray(), body('streams.*').isString().isLength({ max: 64 }), validate, notif.putSubscriptions, ) module.exports = notifRouter