mirror of
https://github.com/backnotprop/plannotator.git
synced 2026-09-14 14:17:26 +08:00
Aviad Shiber
14f8bdba62
Adds ?cb=<encoded_url>&ct=<token> URL params for bot-initiated plan review callbacks. When a bot posts a Plannotator share link with these params, Approve/Feedback buttons appear and POST the user's decision (with annotated plan URL) back to the bot. Changes: - callback.ts: parse callback config from URL search/hash params, execute POST - ToolbarButtons.tsx: extract shared FeedbackButton/ApproveButton components (6 instances → 2 components) - sharing.ts: strip ?cb=&ct= from hash before decompressing share payload - App.tsx: callback buttons gated on isSharedSession + shareUrl readiness - 19 tests covering config parsing, URL validation, presigned URL preservation, and POST execution Co-authored-by: aviadshiber <aviadshiber@users.noreply.github.com> For provenance purposes, this commit was AI assisted.
100 lines
3.2 KiB
TypeScript
100 lines
3.2 KiB
TypeScript
/**
|
|
* Bot callback integration for Plannotator share URLs.
|
|
*
|
|
* When the bot posts a plan URL with ?cb=<encoded_url>&ct=<token>,
|
|
* these utilities parse the config and POST the user's decision back.
|
|
*/
|
|
|
|
/** Actions the user can trigger via the in-Plannotator callback buttons. */
|
|
export enum CallbackAction {
|
|
Approve = "approve",
|
|
Feedback = "feedback",
|
|
}
|
|
|
|
/** Callback config parsed from ?cb=<encoded_url>&ct=<token> in the URL. */
|
|
export interface CallbackConfig {
|
|
callbackUrl: string;
|
|
token: string;
|
|
}
|
|
|
|
export interface ToastSuccess { readonly type: 'success'; readonly message: string }
|
|
export interface ToastError { readonly type: 'error'; readonly message: string }
|
|
export type ToastPayload = ToastSuccess | ToastError | null;
|
|
|
|
/**
|
|
* Parse callback configuration from URL search params.
|
|
* Checks both the standard query string (before #) and query-style params
|
|
* embedded in the hash (e.g. `#<hash>?cb=...&ct=...`).
|
|
*
|
|
* The decoded `cb` value must use http: or https: — other schemes (file://, javascript://, etc.)
|
|
* are rejected to prevent protocol-based attacks.
|
|
*
|
|
* @param loc - Location object to parse (defaults to window.location; injectable for tests)
|
|
* @returns CallbackConfig if both cb and ct are present and valid, null otherwise
|
|
*/
|
|
export function getCallbackConfig(
|
|
loc: { readonly search: string; readonly hash: string } = window.location,
|
|
): CallbackConfig | null {
|
|
const searchParams = new URLSearchParams(loc.search);
|
|
let cb = searchParams.get("cb");
|
|
let ct = searchParams.get("ct");
|
|
|
|
if (!cb || !ct) {
|
|
const qIdx = loc.hash.indexOf("?");
|
|
if (qIdx !== -1) {
|
|
const hashParams = new URLSearchParams(loc.hash.slice(qIdx + 1));
|
|
cb = cb ?? hashParams.get("cb");
|
|
ct = ct ?? hashParams.get("ct");
|
|
}
|
|
}
|
|
|
|
if (!cb || !ct) return null;
|
|
|
|
try {
|
|
const { protocol } = new URL(cb);
|
|
if (protocol !== "https:" && protocol !== "http:") return null;
|
|
} catch {
|
|
return null; // malformed URL
|
|
}
|
|
|
|
return { callbackUrl: cb, token: ct };
|
|
}
|
|
|
|
/**
|
|
* Execute a bot callback POST request.
|
|
*
|
|
* Pure function (no React deps) — testable without a DOM.
|
|
*
|
|
* @param action - The action to send
|
|
* @param config - Callback URL and single-use token from `getCallbackConfig()`
|
|
* @param annotatedUrl - Current share URL (with annotations encoded); sent to the bot
|
|
* @returns Toast payload to display
|
|
*/
|
|
export async function executeCallback(
|
|
action: CallbackAction,
|
|
config: CallbackConfig,
|
|
annotatedUrl: string,
|
|
): Promise<ToastPayload> {
|
|
const successMsg = action === CallbackAction.Approve
|
|
? "Plan approved! The bot will proceed to implementation."
|
|
: "Feedback sent! The bot will re-plan with your annotations.";
|
|
try {
|
|
const res = await fetch(config.callbackUrl, {
|
|
method: "POST",
|
|
headers: { "Content-Type": "application/json" },
|
|
body: JSON.stringify({ action, token: config.token, annotated_url: annotatedUrl }),
|
|
});
|
|
if (!res.ok) {
|
|
return {
|
|
type: "error",
|
|
message: res.status === 401
|
|
? "Plan link expired — request a new one from the bot."
|
|
: "Callback failed.",
|
|
};
|
|
}
|
|
return { type: "success", message: successMsg };
|
|
} catch {
|
|
return { type: "error", message: "Callback failed." };
|
|
}
|
|
}
|