@kottera/tera-web 0.1.0-rc.2 → 0.1.0-rc.4

package/dist/stepup.js

@@ -0,0 +1,66 @@
+/** The request header that carries a confirmed step-up's id to the plugin's route. */
+export const STEP_UP_HEADER = "Tera-Step-Up";
+/** The code of a refusal that needs the person's confirmation. */
+export const STEP_UP_REQUIRED = "step_up_required";
+/**
+ * The query parameter the navigation fallback adds to its `return_to`, naming
+ * the step-up the person went to confirm, so the page that loads again
+ * resumes it rather than beginning another.
+ */
+export const STEP_UP_RESUME_PARAM = "tera_step_up";
+/** How often the step-up's state is read while the person confirms it, by default. */
+export const STEP_UP_POLL_MS = 1000;
+/** A step-up the person did not confirm: the request it was for was not sent again. */
+export class StepUpError extends Error {
+    /** The step-up's id. */
+    stepUpId;
+    /** How it ended. */
+    end;
+    constructor(stepUpId, end, message) {
+        super(message);
+        this.name = "StepUpError";
+        this.stepUpId = stepUpId;
+        this.end = end;
+    }
+}
+/**
+ * The step-up a refusal needs confirmed, when it is one this client can have
+ * confirmed: code `step_up_required` with a page to open. A refusal naming an
+ * ended step-up carries no page, and is not one.
+ */
+export function stepUpChallengeOf(code, stepUp) {
+    if (code !== STEP_UP_REQUIRED || typeof stepUp !== "object" || stepUp === null)
+        return null;
+    const c = stepUp;
+    if (typeof c.id !== "string" || c.id === "" || typeof c.url !== "string" || c.url === "")
+        return null;
+    return c;
+}
+/**
+ * The step-up page's URL with `return_to` set to `returnTo`, itself carrying
+ * {@link STEP_UP_RESUME_PARAM}. tera follows it back only when it is on the
+ * plugin's own origin.
+ */
+export function stepUpPageURL(pageURL, stepUpId, returnTo) {
+    const back = new URL(returnTo);
+    back.searchParams.set(STEP_UP_RESUME_PARAM, stepUpId);
+    const page = new URL(pageURL);
+    page.searchParams.set("return_to", back.toString());
+    return page.toString();
+}
+/** The step-up id a page loaded through the navigation fallback carries back, or null. */
+export function resumedStepUp(pageURL) {
+    try {
+        const id = new URL(pageURL).searchParams.get(STEP_UP_RESUME_PARAM);
+        return id === null || id === "" ? null : id;
+    }
+    catch {
+        return null;
+    }
+}
+export function defaultOpenWindow(url) {
+    return globalThis.open?.(url, "_blank") ?? null;
+}
+export function defaultSleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kottera/tera-web",
-  "version": "0.1.0-rc.2",
+  "version": "0.1.0-rc.4",
   "description": "The browser half of a UI over tera: a framework-free client for the /tera/v1/ routes a plugin's webui kit serves (ADR-162 D4).",
   "license": "Apache-2.0",
   "repository": {