mirror of
https://github.com/Such-Software/wownerogue.git
synced 2026-11-14 11:03:53 +01:00
jwinterm
fad2a695bd
A browser-based roguelike synchronized with crypto block timing. A run is a race against the next block: reach the exit before the block lands, or the house wins. The same codebase runs the solo dungeon, the social Tavern, and operator-selected PvP and race rulesets, with separate free and paid leaderboards. Self-hostable under the MIT License. See README.md to run it, docs/ARCHITECTURE.md for the design, and docs/DEPLOY.md to operate an instance.
56 lines
2.1 KiB
JavaScript
56 lines
2.1 KiB
JavaScript
/**
|
|
* ChatProvider: abstraction over chat message delivery and history.
|
|
*
|
|
* The seam that lets the chat backend be swapped (e.g. for a Nostr channel) without changing
|
|
* callers. Application concerns (commands, moderation, rate limiting, XSS escaping) stay in
|
|
* the caller (ChatHandler / TavernManager); a provider only delivers and (optionally) stores.
|
|
*
|
|
* Scopes:
|
|
* 'global' → the whole server (the main lobby chat).
|
|
* 'tavern:<id>' → a single Socket.IO room (tavern chat), ephemeral by default.
|
|
*/
|
|
class ChatProvider {
|
|
// eslint-disable-next-line no-empty-function
|
|
async initialize() {}
|
|
|
|
/**
|
|
* Deliver (and optionally persist) a chat message.
|
|
* @param {object} msg
|
|
* @param {string} msg.scope 'global' or a room channel.
|
|
* @param {string} msg.username Display name / short id.
|
|
* @param {string} msg.text Message text (caller has already sanitized/escaped it).
|
|
* @param {number} [msg.ts] Timestamp (ms).
|
|
* @param {string} [msg.socketId]
|
|
* @param {number|null} [msg.userId]
|
|
*/
|
|
async publish(msg) { // eslint-disable-line no-unused-vars
|
|
throw new Error('ChatProvider.publish not implemented');
|
|
}
|
|
|
|
/**
|
|
* Recent messages for a scope, oldest → newest.
|
|
* @param {object} opts
|
|
* @param {string} [opts.scope]
|
|
* @param {number} [opts.limit]
|
|
* @returns {Promise<Array>}
|
|
*/
|
|
async getHistory({ scope = 'global', limit = 50 } = {}) { // eslint-disable-line no-unused-vars
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Deliver a message whose nostr event was signed by the CLIENT (per-player identity, Phase 2).
|
|
* The base/local provider has no relay, so it just delivers the message in-game: the signed
|
|
* `event` is ignored. NostrChatProvider overrides this to ALSO publish the pre-signed event.
|
|
* @param {object} req { event, scope, username, text, ts, socketId, userId }
|
|
*/
|
|
async relaySignedEvent({ event, ...msg } = {}) { // eslint-disable-line no-unused-vars
|
|
return this.publish({ scope: 'global', ...msg });
|
|
}
|
|
|
|
// eslint-disable-next-line no-empty-function
|
|
async shutdown() {}
|
|
}
|
|
|
|
module.exports = ChatProvider;
|