Waters ChurchandClaude Fable 5.1
459d8b9c38
The first cut guessed a write route on Overflow's public API, which documents
only reads for Tap. With the helper app's bundle in hand (Overflow ProPresenter
Integration 1.2.3, read 2026-10-11) the module now makes exactly the calls the
helper makes, against the Dashboard's own backend:
POST /nonprofit-dashboard/authentication/login/jwt a Dashboard sign-in → JWT
GET /nonprofit-dashboard/propresenter/nonprofits/{id}/keywords
the Keyword Mappings
POST …/nonprofits/{id}/keywords?syncNonprofit=true { keywords } = the switch
So the keyword → destination → Tap groups mapping stays where Overflow keeps
it (Dashboard › Integrations › ProPresenter › Keyword Mappings) and is read
from there: on start, every five minutes, on the tile's refresh button, and
from every trigger's answer. Admin config shrinks to the ProPresenter endpoint,
the Overflow Dashboard login (plus a Nonprofit ID only for an @overflow.co
staff login) and the alert switch; the API-key, Tap-groups, keyword-text and
match-mode fields are gone.
Behaviour follows the helper: both the presentation layer (/v1/status/slide)
and the announcement layer (/v1/announcement/slide_index + /active) are
watched; when a layer's set of matched keywords changes to a non-empty set it
is sent; matching is per word, case-insensitive, punctuation around the word
ignored. The session token is cached across re-inits for the same login so an
admin saving config repeatedly cannot trip Overflow's "too many attempts";
a 401 signs in again once; a refused sign-in is not retried within 20 s.
tools/overflow-tap-mock.js now plays the Dashboard API (any email/password
signs in; --fail-switch, --expire=<s>, --login=<email>:<password>) and gives
the mock ProPresenter an announcement layer (--no-announcements for an older
one). Verified against it: sign-in, keyword load, triggers on both layers,
token expiry → re-login, 500 → NOT SWITCHED + alert + retries, wrong login →
the reason on the tile and in the health line, and recovery. keywords.selftest.js
pins the matching rule (8 cases).
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
67 lines
2.3 KiB
JavaScript
67 lines
2.3 KiB
JavaScript
'use strict';
|
||
|
||
/**
|
||
* Keyword matching — which of Overflow's keywords a slide's notes carry.
|
||
*
|
||
* Pure functions, no I/O, so keywords.selftest.js can pin every rule down:
|
||
*
|
||
* cleanNotes(raw) → the notes with ProPresenter's invisible padding removed
|
||
* keywordMatches(notes, keyword) → boolean
|
||
* matchKeywords(notes, keywords) → every keyword (in the order given) the notes carry
|
||
* sameSet(a, b) → the two keyword lists hold the same keywords
|
||
*
|
||
* The rule is Overflow's own helper's: the notes are split into whitespace-
|
||
* separated words, each stripped of surrounding punctuation and lower-cased,
|
||
* and a keyword fires when it is one of those words. So `give` fires on
|
||
* "give", "Give!", "#give" and "(give)", and not on "forgiveness", "giveaway"
|
||
* or "give_now". Phrases work too, bounded the same way on both ends —
|
||
* something the helper cannot do, but nothing it would have matched is lost.
|
||
*/
|
||
|
||
const ZERO_WIDTH = /[-]/g;
|
||
|
||
function cleanNotes(raw) {
|
||
return String(raw ?? '').replace(ZERO_WIDTH, '').replace(/\r\n?/g, '\n');
|
||
}
|
||
|
||
function norm(s) {
|
||
return String(s ?? '').trim().toLowerCase().replace(/\s+/g, ' ');
|
||
}
|
||
|
||
function escapeRe(s) {
|
||
return s.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
|
||
}
|
||
|
||
function keywordMatches(notes, keyword) {
|
||
const n = cleanNotes(notes);
|
||
const k = norm(keyword);
|
||
if (!k || !n.trim()) return false;
|
||
const flat = n.toLowerCase().replace(/\s+/g, ' ');
|
||
const re = new RegExp(`(?:^|[^\\p{L}\\p{N}_])${escapeRe(k)}(?=$|[^\\p{L}\\p{N}_])`, 'u');
|
||
return re.test(flat);
|
||
}
|
||
|
||
/** Every keyword the notes carry, in the order the list gives them, each once. Entries may be strings or objects with a `keyword`. */
|
||
function matchKeywords(notes, keywords) {
|
||
const out = [];
|
||
const seen = new Set();
|
||
for (const raw of keywords || []) {
|
||
const k = typeof raw === 'string' ? raw : raw && raw.keyword;
|
||
const key = norm(k);
|
||
if (!key || seen.has(key)) continue;
|
||
if (keywordMatches(notes, k)) {
|
||
seen.add(key);
|
||
out.push(String(k).trim());
|
||
}
|
||
}
|
||
return out;
|
||
}
|
||
|
||
function sameSet(a, b) {
|
||
const x = [...(a || [])].map(norm).sort();
|
||
const y = [...(b || [])].map(norm).sort();
|
||
return x.length === y.length && x.every((v, i) => v === y[i]);
|
||
}
|
||
|
||
module.exports = { cleanNotes, norm, keywordMatches, matchKeywords, sameSet };
|