@bircleai/widget-protocol 0.4.3

package/dist/index.js

@@ -0,0 +1,244 @@
+// src/index.ts
+var MEDIA_CONTENT_TYPES = [
+  "image",
+  "audio",
+  "video",
+  "document"
+];
+function isMediaContentType(v) {
+  return typeof v === "string" && MEDIA_CONTENT_TYPES.includes(v);
+}
+var ALLOWED_UPLOAD_CONTENT_TYPES = {
+  "image/png": "image",
+  "image/jpeg": "image",
+  "image/webp": "image",
+  "image/gif": "image",
+  "audio/webm": "audio",
+  "audio/mp4": "audio",
+  "audio/mpeg": "audio",
+  "audio/ogg": "audio",
+  "video/mp4": "video",
+  "video/webm": "video",
+  "application/pdf": "document"
+};
+var MAX_UPLOAD_SIZE_BYTES = 10 * 1024 * 1024;
+function isAllowedUploadContentType(contentType) {
+  return Object.prototype.hasOwnProperty.call(ALLOWED_UPLOAD_CONTENT_TYPES, contentType);
+}
+function mediaKindForContentType(contentType) {
+  return ALLOWED_UPLOAD_CONTENT_TYPES[contentType] ?? null;
+}
+var SERVER_PROVIDED_THEME_FIELDS = [
+  "primaryColor",
+  "accentColor",
+  "launcherIcon",
+  "launcherLabel",
+  "position",
+  "headerLogo",
+  "assistantName",
+  "assistantTagline",
+  "assistantAvatar",
+  "fontFamily",
+  "colorScheme",
+  "poweredBy",
+  "locale",
+  "texts"
+];
+var MAX_THEME_LABEL = 40;
+var MAX_THEME_TAGLINE = 80;
+var MAX_THEME_FONT_FAMILY = 120;
+var MAX_THEME_TEXT_KEYS = 40;
+var MAX_THEME_TEXT_KEY = 60;
+var MAX_THEME_TEXT_VALUE = 200;
+function safeThemeColor(value) {
+  if (typeof value !== "string") return null;
+  const v = value.trim();
+  return /^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/.test(v) ? v : null;
+}
+function safeThemeUrl(value) {
+  if (typeof value !== "string" || value.trim() === "") return null;
+  try {
+    const u = new URL(value.trim());
+    return u.protocol === "https:" ? u.toString() : null;
+  } catch {
+    return null;
+  }
+}
+function safeThemeText(value, max) {
+  if (typeof value !== "string") return null;
+  const v = value.trim();
+  return v !== "" && v.length <= max ? v : null;
+}
+function sanitizeThemeTexts(raw) {
+  if (typeof raw !== "object" || raw === null || Array.isArray(raw)) return null;
+  const out = {};
+  let n = 0;
+  for (const [k, v] of Object.entries(raw)) {
+    if (n >= MAX_THEME_TEXT_KEYS) break;
+    if (k === "" || k.length > MAX_THEME_TEXT_KEY) continue;
+    if (typeof v !== "string" || v === "" || v.length > MAX_THEME_TEXT_VALUE) continue;
+    out[k] = v;
+    n += 1;
+  }
+  return n > 0 ? out : null;
+}
+function sanitizeServerTheme(raw) {
+  if (typeof raw !== "object" || raw === null) return {};
+  const o = raw;
+  const out = {};
+  const primaryColor = safeThemeColor(o.primaryColor);
+  if (primaryColor !== null) out.primaryColor = primaryColor;
+  const accentColor = safeThemeColor(o.accentColor);
+  if (accentColor !== null) out.accentColor = accentColor;
+  const launcherIcon = safeThemeUrl(o.launcherIcon);
+  if (launcherIcon !== null) out.launcherIcon = launcherIcon;
+  const headerLogo = safeThemeUrl(o.headerLogo);
+  if (headerLogo !== null) out.headerLogo = headerLogo;
+  const assistantAvatar = safeThemeUrl(o.assistantAvatar);
+  if (assistantAvatar !== null) out.assistantAvatar = assistantAvatar;
+  const launcherLabel = safeThemeText(o.launcherLabel, MAX_THEME_LABEL);
+  if (launcherLabel !== null) out.launcherLabel = launcherLabel;
+  const assistantName = safeThemeText(o.assistantName, MAX_THEME_LABEL);
+  if (assistantName !== null) out.assistantName = assistantName;
+  const assistantTagline = safeThemeText(o.assistantTagline, MAX_THEME_TAGLINE);
+  if (assistantTagline !== null) out.assistantTagline = assistantTagline;
+  const fontFamily = safeThemeText(o.fontFamily, MAX_THEME_FONT_FAMILY);
+  if (fontFamily !== null) out.fontFamily = fontFamily;
+  if (o.position === "bottom-right" || o.position === "bottom-left") out.position = o.position;
+  if (o.colorScheme === "light" || o.colorScheme === "dark") out.colorScheme = o.colorScheme;
+  if (typeof o.poweredBy === "boolean") out.poweredBy = o.poweredBy;
+  const locale = safeThemeLocale(o.locale);
+  if (locale !== null) out.locale = locale;
+  const texts = sanitizeThemeTexts(o.texts);
+  if (texts !== null) out.texts = texts;
+  return out;
+}
+function safeThemeLocale(value) {
+  if (typeof value !== "string") return null;
+  const v = value.trim();
+  return v.length >= 2 && v.length <= 5 && /^[a-zA-Z-]+$/.test(v) ? v : null;
+}
+var MAX_QUICK_REPLIES = 6;
+var MAX_QUICK_REPLY_LABEL = 40;
+function sanitizeQuickReplies(raw) {
+  if (!Array.isArray(raw)) return [];
+  const out = [];
+  for (const item of raw) {
+    if (out.length >= MAX_QUICK_REPLIES) break;
+    if (typeof item !== "object" || item === null) continue;
+    const o = item;
+    const label = typeof o.label === "string" ? o.label.trim() : "";
+    if (label === "" || label.length > MAX_QUICK_REPLY_LABEL) continue;
+    const value = typeof o.value === "string" && o.value.trim() !== "" ? o.value.trim() : void 0;
+    out.push(value !== void 0 ? { label, value } : { label });
+  }
+  return out;
+}
+var MAX_AGENT_NAME = 40;
+function sanitizeAssistantIdentity(raw, kind = "human") {
+  if (typeof raw !== "object" || raw === null) return null;
+  const o = raw;
+  const rawName = typeof o.name === "string" ? o.name.trim() : "";
+  const name = rawName !== "" && rawName.length <= MAX_AGENT_NAME ? rawName : void 0;
+  let avatar;
+  if (typeof o.avatar === "string" && o.avatar.trim() !== "") {
+    try {
+      const u = new URL(o.avatar.trim());
+      if (u.protocol === "https:") avatar = u.toString();
+    } catch {
+    }
+  }
+  if (name === void 0 && avatar === void 0) return null;
+  return {
+    kind,
+    ...name !== void 0 ? { name } : {},
+    ...avatar !== void 0 ? { avatar } : {}
+  };
+}
+function isRawAssistantMessageEvent(v) {
+  if (typeof v !== "object" || v === null) return false;
+  const o = v;
+  if (o.type !== "assistant_message") return false;
+  if (typeof o.conversation_id !== "string") return false;
+  if (typeof o.content !== "string") return false;
+  if (!Array.isArray(o.turn_ids)) return false;
+  if (o.ts !== void 0 && o.ts !== null && typeof o.ts !== "number") return false;
+  if (o.content_type !== void 0 && o.content_type !== null && typeof o.content_type !== "string")
+    return false;
+  if (o.caption !== void 0 && o.caption !== null && typeof o.caption !== "string") return false;
+  return true;
+}
+function isAssistantMessageEvent(v) {
+  if (!isRawAssistantMessageEvent(v)) return false;
+  if (typeof v.ts !== "number") return false;
+  if (v.caption !== void 0 && typeof v.caption !== "string") return false;
+  if (v.content_type !== void 0 && v.content_type !== "text" && !isMediaContentType(v.content_type))
+    return false;
+  return v.turn_ids.every((t) => typeof t === "string");
+}
+function normalizeAssistantMessageEvent(raw, now = Date.now) {
+  const turnIds = raw.turn_ids.filter((t) => typeof t === "string");
+  return {
+    type: "assistant_message",
+    conversation_id: raw.conversation_id,
+    content: raw.content,
+    turn_ids: turnIds,
+    ts: typeof raw.ts === "number" && Number.isFinite(raw.ts) && raw.ts > 0 ? raw.ts : now(),
+    ...raw.content_type != null ? {
+      content_type: isMediaContentType(raw.content_type) ? raw.content_type : "text"
+    } : {},
+    ...raw.caption != null ? { caption: raw.caption } : {},
+    ...(() => {
+      const qr = sanitizeQuickReplies(raw.quick_replies);
+      return qr.length > 0 ? { quick_replies: qr } : {};
+    })(),
+    // Cualquier valor que no sea exactamente "human" cuenta como bot: es el
+    // default seguro — decirle al usuario que lo atiende una persona cuando no
+    // es cierto es peor que lo contrario.
+    ...raw.author === "human" ? { author: "human" } : {},
+    // La identidad SÓLO se propaga junto a `author: "human"`. Un `agent` en un
+    // mensaje del bot le pondría cara y nombre de persona a algo que escribió
+    // una máquina, que es exactamente la confusión que el handover evita.
+    ...(() => {
+      if (raw.author !== "human") return {};
+      const id = sanitizeAssistantIdentity(raw.agent);
+      return id !== null ? { agent: id } : {};
+    })()
+  };
+}
+function parseWidgetEvent(raw, now = Date.now) {
+  let v;
+  try {
+    v = JSON.parse(raw);
+  } catch {
+    return null;
+  }
+  return isRawAssistantMessageEvent(v) ? normalizeAssistantMessageEvent(v, now) : null;
+}
+export {
+  ALLOWED_UPLOAD_CONTENT_TYPES,
+  MAX_AGENT_NAME,
+  MAX_QUICK_REPLIES,
+  MAX_QUICK_REPLY_LABEL,
+  MAX_THEME_FONT_FAMILY,
+  MAX_THEME_LABEL,
+  MAX_THEME_TAGLINE,
+  MAX_THEME_TEXT_KEY,
+  MAX_THEME_TEXT_KEYS,
+  MAX_THEME_TEXT_VALUE,
+  MAX_UPLOAD_SIZE_BYTES,
+  MEDIA_CONTENT_TYPES,
+  SERVER_PROVIDED_THEME_FIELDS,
+  isAllowedUploadContentType,
+  isAssistantMessageEvent,
+  isMediaContentType,
+  isRawAssistantMessageEvent,
+  mediaKindForContentType,
+  normalizeAssistantMessageEvent,
+  parseWidgetEvent,
+  safeThemeColor,
+  safeThemeUrl,
+  sanitizeAssistantIdentity,
+  sanitizeQuickReplies,
+  sanitizeServerTheme
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@bircleai/widget-protocol",
+  "version": "0.4.3",
+  "description": "Contrato compartido del Chat Gateway de BircleAI (tipos + helpers de parseo).",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "build:debug": "tsup src/index.ts --format esm,cjs --dts --clean --sourcemap",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BircleAI/bircle-chat-widget.git"
+  },
+  "keywords": [
+    "bircle",
+    "chat",
+    "protocol",
+    "types",
+    "typescript"
+  ],
+  "homepage": "https://bircle.ai",
+  "bugs": {
+    "email": "soporte@bircle.ai"
+  },
+  "author": "Bircle AI",
+  "engines": {
+    "node": ">=18"
+  }
+}