@lightworkai.official/debug-capture 0.12.7 → 0.12.8

package/dist/server.d.ts

@@ -1,10 +1,36 @@
+/**
+ * One fact about a person's WORK, as the host knows it — their unit, their
+ * position — with the host's own label for it. The support desk shows these
+ * beside the person's name and records them with what the person does (an
+ * event registration takes them as its own), so nobody types their unit into
+ * a form the host could have filled.
+ *
+ * `key` is stable across people (it names a column in an export); `label` is
+ * what a person reads, in the host's language. Order matters: the first is
+ * the one drawn under a name.
+ */
+export interface SupportProfileFact {
+    key: string;
+    label: string;
+    value: string;
+}
 /** Whoever the host has authenticated. Email is the account key. */
 export interface SupportUser {
     /** The host's own id for this person, recorded so a changed email still matches. */
     id?: string | null;
     email: string;
     name?: string | null;
+    /** What the host knows about their work — most important first. Optional; bounded on the way in. */
+    profile?: SupportProfileFact[] | null;
 }
+/** How much of a profile rides in a token. It travels in a URL, so it is small on purpose. */
+export declare const PROFILE_MAX_FACTS = 10;
+/**
+ * A profile made safe to sign: known shape, stable keys, trimmed, bounded.
+ * A fact with no value is left out (an empty unit is not a unit). Null when
+ * there is nothing to say — the support side then keeps what it had.
+ */
+export declare function cleanProfile(profile: SupportProfileFact[] | null | undefined): SupportProfileFact[] | null;
 /**
  * Two minutes.
  *
@@ -31,6 +57,28 @@ export declare function createSupportToken(options: {
     token: string;
     expiresIn: number;
 };
+/**
+ * The address that signs a person into the support desk and lands them on a
+ * page of it — for a host that sends people there by LINK rather than from
+ * its own button (a notice on a portal, a "sign in" door the desk bounces a
+ * signed-out reader to). The token is minted here, on the server, at the
+ * moment of the redirect; it lives two minutes and is spent on arrival.
+ *
+ *   redirect(supportSignInUrl({ host, realmKey, secret, user, returnPath: "/e/อบรม-a4f2" }))
+ *
+ * `returnPath` must be a path on the support desk; the desk decides again
+ * where it may land (its own reporter pages, or an event).
+ */
+export declare function supportSignInUrl(options: {
+    /** The support desk's origin, e.g. https://support.example.com */
+    host: string;
+    /** The realm's public key. */
+    realmKey: string;
+    secret: string;
+    user: SupportUser;
+    returnPath?: string | null;
+    ttlSeconds?: number;
+}): string;
 /**
  * A ready-made route handler, for the common case.
  *

package/dist/server.mjs

@@ -1,5 +1,25 @@
 // src/server.ts
 import { createHmac, randomUUID } from "node:crypto";
+var PROFILE_MAX_FACTS = 10;
+var PROFILE_KEY = /^[a-z][a-z0-9_]{0,31}$/;
+function cleanProfile(profile) {
+  if (!Array.isArray(profile))
+    return null;
+  const out = [];
+  const seen = new Set;
+  for (const f of profile) {
+    const key = typeof f?.key === "string" ? f.key.trim() : "";
+    const value = typeof f?.value === "string" ? f.value.trim() : "";
+    if (!PROFILE_KEY.test(key) || !value || seen.has(key))
+      continue;
+    seen.add(key);
+    const label = typeof f.label === "string" && f.label.trim() ? f.label.trim().slice(0, 40) : key;
+    out.push({ key, label, value: value.slice(0, 120) });
+    if (out.length >= PROFILE_MAX_FACTS)
+      break;
+  }
+  return out.length ? out : null;
+}
 var DEFAULT_TTL_SECONDS = 120;
 var b64 = (value) => Buffer.from(JSON.stringify(value), "utf8").toString("base64url");
 function createSupportToken(options) {
@@ -15,12 +35,23 @@ function createSupportToken(options) {
     sub: options.user.id?.trim() || email,
     email,
     name: options.user.name?.trim() || null,
+    ...cleanProfile(options.user.profile) ? { profile: cleanProfile(options.user.profile) } : {},
     jti: randomUUID(),
     iat: now,
     exp: now + expiresIn
   })}`;
   return { token: `${body}.${createHmac("sha256", options.secret).update(body).digest("base64url")}`, expiresIn };
 }
+function supportSignInUrl(options) {
+  const { token } = createSupportToken({ secret: options.secret, user: options.user, ttlSeconds: options.ttlSeconds });
+  const url = new URL("/sso", options.host.replace(/\/+$/, ""));
+  url.searchParams.set("realm", options.realmKey);
+  url.searchParams.set("token", token);
+  const back = options.returnPath?.trim();
+  if (back && back.startsWith("/") && !back.startsWith("//"))
+    url.searchParams.set("return", back);
+  return url.toString();
+}
 function supportTokenHandler(options) {
   return async () => {
     const secret = options.secret ?? process.env.SUPPORT_REPORTER_SECRET;
@@ -49,6 +80,9 @@ function json(body, status) {
 }
 export {
   supportTokenHandler,
+  supportSignInUrl,
   createSupportToken,
+  cleanProfile,
+  PROFILE_MAX_FACTS,
   DEFAULT_TTL_SECONDS
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightworkai.official/debug-capture",
-  "version": "0.12.7",
+  "version": "0.12.8",
   "description": "Report-a-problem widget: rolling network/console/action capture, optional rrweb session replay, annotated screenshot, and submission to a Lightwork Support host",
   "type": "module",
   "module": "./dist/index.mjs",

package/src/server.ts

@@ -17,12 +17,56 @@
  */
 import { createHmac, randomUUID } from "node:crypto";
 
+/**
+ * One fact about a person's WORK, as the host knows it — their unit, their
+ * position — with the host's own label for it. The support desk shows these
+ * beside the person's name and records them with what the person does (an
+ * event registration takes them as its own), so nobody types their unit into
+ * a form the host could have filled.
+ *
+ * `key` is stable across people (it names a column in an export); `label` is
+ * what a person reads, in the host's language. Order matters: the first is
+ * the one drawn under a name.
+ */
+export interface SupportProfileFact {
+  key: string;
+  label: string;
+  value: string;
+}
+
 /** Whoever the host has authenticated. Email is the account key. */
 export interface SupportUser {
   /** The host's own id for this person, recorded so a changed email still matches. */
   id?: string | null;
   email: string;
   name?: string | null;
+  /** What the host knows about their work — most important first. Optional; bounded on the way in. */
+  profile?: SupportProfileFact[] | null;
+}
+
+/** How much of a profile rides in a token. It travels in a URL, so it is small on purpose. */
+export const PROFILE_MAX_FACTS = 10;
+const PROFILE_KEY = /^[a-z][a-z0-9_]{0,31}$/;
+
+/**
+ * A profile made safe to sign: known shape, stable keys, trimmed, bounded.
+ * A fact with no value is left out (an empty unit is not a unit). Null when
+ * there is nothing to say — the support side then keeps what it had.
+ */
+export function cleanProfile(profile: SupportProfileFact[] | null | undefined): SupportProfileFact[] | null {
+  if (!Array.isArray(profile)) return null;
+  const out: SupportProfileFact[] = [];
+  const seen = new Set<string>();
+  for (const f of profile) {
+    const key = typeof f?.key === "string" ? f.key.trim() : "";
+    const value = typeof f?.value === "string" ? f.value.trim() : "";
+    if (!PROFILE_KEY.test(key) || !value || seen.has(key)) continue;
+    seen.add(key);
+    const label = typeof f.label === "string" && f.label.trim() ? f.label.trim().slice(0, 40) : key;
+    out.push({ key, label, value: value.slice(0, 120) });
+    if (out.length >= PROFILE_MAX_FACTS) break;
+  }
+  return out.length ? out : null;
 }
 
 /**
@@ -65,6 +109,8 @@ export function createSupportToken(options: {
     sub: options.user.id?.trim() || email,
     email,
     name: options.user.name?.trim() || null,
+    // Only when there is one: an older support desk ignores the claim, a newer one records it.
+    ...(cleanProfile(options.user.profile) ? { profile: cleanProfile(options.user.profile) } : {}),
     // Spent once on arrival; without it the freshness window is a replay window.
     jti: randomUUID(),
     iat: now,
@@ -74,6 +120,38 @@ export function createSupportToken(options: {
   return { token: `${body}.${createHmac("sha256", options.secret).update(body).digest("base64url")}`, expiresIn };
 }
 
+/**
+ * The address that signs a person into the support desk and lands them on a
+ * page of it — for a host that sends people there by LINK rather than from
+ * its own button (a notice on a portal, a "sign in" door the desk bounces a
+ * signed-out reader to). The token is minted here, on the server, at the
+ * moment of the redirect; it lives two minutes and is spent on arrival.
+ *
+ *   redirect(supportSignInUrl({ host, realmKey, secret, user, returnPath: "/e/อบรม-a4f2" }))
+ *
+ * `returnPath` must be a path on the support desk; the desk decides again
+ * where it may land (its own reporter pages, or an event).
+ */
+export function supportSignInUrl(options: {
+  /** The support desk's origin, e.g. https://support.example.com */
+  host: string;
+  /** The realm's public key. */
+  realmKey: string;
+  secret: string;
+  user: SupportUser;
+  returnPath?: string | null;
+  ttlSeconds?: number;
+}): string {
+  const { token } = createSupportToken({ secret: options.secret, user: options.user, ttlSeconds: options.ttlSeconds });
+  const url = new URL("/sso", options.host.replace(/\/+$/, ""));
+  url.searchParams.set("realm", options.realmKey);
+  url.searchParams.set("token", token);
+  const back = options.returnPath?.trim();
+  // A path, never an address: the desk would refuse anything else anyway, so say so here first.
+  if (back && back.startsWith("/") && !back.startsWith("//")) url.searchParams.set("return", back);
+  return url.toString();
+}
+
 /**
  * A ready-made route handler, for the common case.
  *