@flamingo-stack/openframe-frontend-core 0.0.508 → 0.0.509

package/dist/chat-protocol/index.js

@@ -0,0 +1,490 @@
+// src/chat-protocol/frames.ts
+var FRAME_TERMINATOR = "\0";
+var END_OF_LEADING = "";
+var TRAILER_SENTINEL = "";
+
+// src/chat-protocol/events.ts
+var CHAT_OWNER_ADMIN = "ADMIN";
+
+// src/chat-protocol/encode.ts
+var encoder = new TextEncoder();
+var SENTINEL_BYTES_RE = /[\u0000\u001E\u001F]/g;
+function stripSentinelBytes(text) {
+  return text.replace(SENTINEL_BYTES_RE, "");
+}
+function encodeLeadingFrame(frame) {
+  return encoder.encode(JSON.stringify(frame) + FRAME_TERMINATOR);
+}
+function encodeEndOfLeading() {
+  return encoder.encode(END_OF_LEADING);
+}
+function encodeTextDelta(text) {
+  return encoder.encode(stripSentinelBytes(text));
+}
+function encodeTrailingUsageFrame(frame) {
+  return encoder.encode(TRAILER_SENTINEL + JSON.stringify(frame));
+}
+
+// src/chat-protocol/decode.ts
+function escapeThinkingTags(text) {
+  return text.replace(/</g, "&lt;");
+}
+function mapLeadingFrame(meta, out) {
+  if (meta.status === "thinking") {
+    out.push({ type: "status", phase: "thinking" });
+  } else if (meta.kind === "thinking-delta" && typeof meta.text === "string") {
+    out.push({ type: "thinking-delta", text: meta.text });
+  } else if (meta.kind === "usage" && meta.stage === "start") {
+    out.push({
+      type: "usage",
+      stage: "start",
+      input_tokens: meta.input_tokens,
+      cache_read_input_tokens: meta.cache_read_input_tokens,
+      cache_creation_input_tokens: meta.cache_creation_input_tokens
+    });
+  } else if (meta.kind === "decision_resolved" && typeof meta.action === "string") {
+    const status = meta.action === "rejected" ? "rejected" : "approved";
+    const toolName = typeof meta.tool_name === "string" ? meta.tool_name : void 0;
+    const result = meta.result ?? null;
+    const card = meta.card ?? null;
+    out.push({
+      type: "approval-resolved",
+      status,
+      ok: meta.ok === true,
+      willAutoContinue: meta.willAutoContinue === true,
+      ...toolName ? { toolName } : {},
+      ...result ? { result } : {},
+      ...card?.marker ? { marker: card.marker } : {},
+      ...card?.ref ? { cardRef: card.ref } : {},
+      ...card?.type ? { cardType: card.type } : {},
+      ...typeof meta.receiptText === "string" ? { receiptText: meta.receiptText } : {},
+      requestId: typeof meta.proposalId === "string" ? meta.proposalId : void 0
+    });
+  } else if (meta.kind === "approval_request" && meta.proposalId) {
+    const proposalId = String(meta.proposalId);
+    const toolName = String(meta.toolName ?? "tool");
+    const headline = typeof meta.title === "string" && meta.title.length > 0 ? meta.title : toolName;
+    const rawFields = Array.isArray(meta.fields) ? meta.fields : [];
+    const fields = [];
+    for (const f of rawFields) {
+      if (!f || !f.label || !f.value) continue;
+      fields.push({ label: f.label, value: f.value });
+    }
+    out.push({
+      type: "approval-request",
+      requestId: proposalId,
+      approvalType: toolName,
+      command: headline,
+      fields,
+      status: "pending"
+    });
+  } else if (meta.kind === "text-leading" && typeof meta.text === "string") {
+    out.push({ type: "text-delta", text: meta.text, leading: true });
+  } else if (meta.kind === "tool_error") {
+    const msg = typeof meta.message === "string" && meta.message.length > 0 ? meta.message : "Could not complete the requested action right now.";
+    out.push({ type: "error", title: msg });
+  } else if (meta.kind === "routing") {
+    if (typeof meta.routedComplexity === "string") {
+      out.push({
+        type: "metadata",
+        routing: {
+          routedComplexity: meta.routedComplexity,
+          ...typeof meta.routedModel === "string" ? { routedModel: meta.routedModel } : {},
+          routedThinkingBudget: typeof meta.routedThinkingBudget === "number" ? meta.routedThinkingBudget : null
+        }
+      });
+    }
+  } else {
+    out.push({
+      type: "metadata",
+      sources: meta.sources,
+      refs: meta.refs,
+      provider: meta.provider,
+      modelLabel: meta.modelLabel,
+      modelName: meta.model,
+      contextWindowMaxTokens: meta.contextWindowMaxTokens,
+      scrollAnchor: meta.scrollAnchor,
+      conversationId: meta.conversationId
+    });
+  }
+}
+function createSseFrameDecoder() {
+  const textDecoder = new TextDecoder();
+  let buffer = "";
+  let inText = false;
+  let inTrailer = false;
+  let trailerBuffer = "";
+  let ended = false;
+  function push(bytes) {
+    const out = [];
+    const chunk = textDecoder.decode(bytes, { stream: true });
+    if (!inText) {
+      buffer += chunk;
+      while (!inText) {
+        const recIdx = buffer.indexOf(END_OF_LEADING);
+        const nullIdx = buffer.indexOf(FRAME_TERMINATOR);
+        if (recIdx !== -1 && (nullIdx === -1 || recIdx < nullIdx)) {
+          inText = true;
+          out.push({ type: "turn-start" });
+          const after = buffer.slice(recIdx + 1);
+          buffer = "";
+          if (after) {
+            const unitIdx = after.indexOf(TRAILER_SENTINEL);
+            if (unitIdx === -1) {
+              out.push({ type: "text-delta", text: after });
+            } else {
+              const textBefore = after.slice(0, unitIdx);
+              const trailerAfter = after.slice(unitIdx + 1);
+              if (textBefore) {
+                out.push({ type: "text-delta", text: textBefore });
+              }
+              inTrailer = true;
+              trailerBuffer = trailerAfter;
+            }
+          }
+          break;
+        }
+        if (nullIdx === -1) break;
+        const metaStr = buffer.slice(0, nullIdx);
+        const remaining = buffer.slice(nullIdx + 1);
+        let meta;
+        try {
+          meta = JSON.parse(metaStr);
+        } catch {
+          inText = true;
+          out.push({ type: "turn-start", implicit: true });
+          if (buffer.length > 0) {
+            out.push({ type: "text-delta", text: buffer });
+            buffer = "";
+          }
+          break;
+        }
+        mapLeadingFrame(meta, out);
+        buffer = remaining;
+      }
+    } else if (inTrailer) {
+      trailerBuffer += chunk;
+    } else {
+      const sepIdx = chunk.indexOf(TRAILER_SENTINEL);
+      if (sepIdx === -1) {
+        out.push({ type: "text-delta", text: chunk });
+      } else {
+        const before = chunk.slice(0, sepIdx);
+        const after = chunk.slice(sepIdx + 1);
+        if (before) out.push({ type: "text-delta", text: before });
+        inTrailer = true;
+        trailerBuffer = after;
+      }
+    }
+    return out;
+  }
+  function end() {
+    if (ended) return [];
+    ended = true;
+    const out = [];
+    if (trailerBuffer.length > 0) {
+      const raw = trailerBuffer;
+      trailerBuffer = "";
+      try {
+        const meta = JSON.parse(raw);
+        if (meta.kind === "usage" && (meta.stage === "end" || meta.stage === "display")) {
+          out.push({
+            type: "usage",
+            stage: "end",
+            input_tokens: meta.input_tokens,
+            output_tokens: meta.output_tokens,
+            cache_read_input_tokens: meta.cache_read_input_tokens,
+            cache_creation_input_tokens: meta.cache_creation_input_tokens,
+            hit_rate_pct: meta.hit_rate_pct,
+            telemetry: meta.telemetry,
+            breakdown: meta.breakdown,
+            debug: meta.debug
+          });
+        }
+      } catch {
+      }
+    }
+    return out;
+  }
+  return { push, end };
+}
+
+// src/components/chat/types/message.types.ts
+var MESSAGE_TYPE = {
+  TEXT: "TEXT",
+  THINKING: "THINKING",
+  GUIDE: "GUIDE",
+  EXECUTING_TOOL: "EXECUTING_TOOL",
+  EXECUTED_TOOL: "EXECUTED_TOOL",
+  APPROVAL_REQUEST: "APPROVAL_REQUEST",
+  APPROVAL_RESULT: "APPROVAL_RESULT",
+  ERROR: "ERROR",
+  MESSAGE_START: "MESSAGE_START",
+  MESSAGE_END: "MESSAGE_END",
+  MESSAGE_REQUEST: "MESSAGE_REQUEST",
+  AI_METADATA: "AI_METADATA",
+  TOKEN_USAGE: "TOKEN_USAGE",
+  CONTEXT_COMPACTION_START: "CONTEXT_COMPACTION_START",
+  CONTEXT_COMPACTION_END: "CONTEXT_COMPACTION_END",
+  DIRECT_MESSAGE: "DIRECT_MESSAGE",
+  SYSTEM: "SYSTEM",
+  DIALOG_CLOSED: "DIALOG_CLOSED"
+};
+
+// src/chat-protocol/nats-decoder.ts
+function normalizeToolCalls(raw) {
+  if (!Array.isArray(raw)) return [];
+  return raw.filter((item) => !!item && typeof item === "object").map((item) => ({
+    toolExecutionRequestId: String(item.toolExecutionRequestId ?? ""),
+    toolName: String(item.toolName ?? ""),
+    toolTitle: typeof item.toolTitle === "string" ? item.toolTitle : void 0,
+    toolExplanation: typeof item.toolExplanation === "string" ? item.toolExplanation : void 0,
+    toolType: typeof item.toolType === "string" ? item.toolType : void 0,
+    requiresApproval: item.requiresApproval === true,
+    approvalType: typeof item.approvalType === "string" ? item.approvalType : null,
+    toolCallArguments: item.toolCallArguments && typeof item.toolCallArguments === "object" ? item.toolCallArguments : null
+  }));
+}
+function decodeNatsChunk(chunk) {
+  if (!chunk || typeof chunk !== "object") return null;
+  const data = chunk;
+  const type = String(data.type || "");
+  const seq = typeof data.streamSeq === "number" ? { seq: data.streamSeq } : {};
+  switch (type) {
+    case MESSAGE_TYPE.MESSAGE_START:
+      return { type: "turn-start", ...seq };
+    case MESSAGE_TYPE.MESSAGE_END:
+      return { type: "turn-end", ...seq };
+    case MESSAGE_TYPE.AI_METADATA: {
+      const providerName = data.providerName || data.provider;
+      if (typeof data.modelName === "string" && typeof providerName === "string") {
+        return {
+          type: "metadata",
+          modelLabel: data.modelDisplayName,
+          modelName: data.modelName,
+          provider: providerName,
+          contextWindowMaxTokens: typeof data.contextWindow === "number" ? data.contextWindow : 0,
+          ...seq
+        };
+      }
+      return null;
+    }
+    case MESSAGE_TYPE.TEXT:
+      if (typeof data.text === "string") {
+        return { type: "text-delta", text: data.text, ...seq };
+      }
+      return null;
+    case MESSAGE_TYPE.THINKING:
+      if (typeof data.text === "string") {
+        return { type: "thinking-delta", text: data.text, ...seq };
+      }
+      return null;
+    case MESSAGE_TYPE.GUIDE:
+      if (typeof data.text === "string") {
+        return { type: "guide-delta", text: data.text, ...seq };
+      }
+      return null;
+    case MESSAGE_TYPE.EXECUTING_TOOL:
+      return {
+        type: "tool-execution",
+        data: {
+          type: "EXECUTING_TOOL",
+          integratedToolType: data.integratedToolType || "",
+          toolFunction: data.toolFunction || "",
+          toolTitle: typeof data.title === "string" ? data.title : void 0,
+          // The human-readable "why this tool is running" line rendered inside
+          // the tool card. It rides ONLY the EXECUTING chunk — the EXECUTED one
+          // never carries it, and the accumulator's merge preserves whatever
+          // the EXECUTING segment held. Dropping it here therefore blanks the
+          // card for the whole lifetime of the run.
+          toolExplanation: typeof data.toolExplanation === "string" ? data.toolExplanation : void 0,
+          parameters: data.parameters,
+          toolExecutionRequestId: typeof data.toolExecutionRequestId === "string" ? data.toolExecutionRequestId : void 0
+        },
+        ...seq
+      };
+    case MESSAGE_TYPE.EXECUTED_TOOL:
+      return {
+        type: "tool-execution",
+        data: {
+          type: "EXECUTED_TOOL",
+          integratedToolType: data.integratedToolType || "",
+          toolFunction: data.toolFunction || "",
+          toolTitle: typeof data.title === "string" ? data.title : void 0,
+          parameters: data.parameters,
+          result: data.result,
+          success: data.success,
+          toolExecutionRequestId: typeof data.toolExecutionRequestId === "string" ? data.toolExecutionRequestId : void 0
+        },
+        ...seq
+      };
+    case MESSAGE_TYPE.APPROVAL_REQUEST: {
+      const requestId = data.approvalRequestId || data.approval_request_id || "";
+      const approvalType = data.approvalType || "USER";
+      const toolCalls = normalizeToolCalls(data.toolCalls);
+      if (toolCalls.length > 0) {
+        return { type: "approval-request", requestId, approvalType, toolCalls, ...seq };
+      }
+      return {
+        type: "approval-request",
+        requestId,
+        approvalType,
+        command: data.command || "",
+        explanation: data.explanation,
+        ...seq
+      };
+    }
+    case MESSAGE_TYPE.APPROVAL_RESULT: {
+      const resolvedByName = typeof data.resolvedByName === "string" ? data.resolvedByName : typeof data.displayName === "string" ? data.displayName : void 0;
+      return {
+        type: "approval-resolved",
+        requestId: data.approvalRequestId || data.approval_request_id || "",
+        status: data.approved === true ? "approved" : "rejected",
+        approvalType: data.approvalType || "CLIENT",
+        resolvedByName,
+        ...seq
+      };
+    }
+    case MESSAGE_TYPE.ERROR:
+      return {
+        type: "error",
+        title: data.error || "An error occurred",
+        details: data.details,
+        ...seq
+      };
+    case MESSAGE_TYPE.MESSAGE_REQUEST:
+      return {
+        type: "participant",
+        kind: "message-request",
+        text: String(data.text || ""),
+        ownerType: typeof data.ownerType === "string" ? data.ownerType : void 0,
+        displayName: typeof data.displayName === "string" ? data.displayName : void 0,
+        userId: typeof data.userId === "string" ? data.userId : void 0,
+        // Wire shape carries no label; fall back to the id (parity with
+        // the history path in `process-historical-messages.ts`).
+        contextItems: Array.isArray(data.contextItems) ? data.contextItems.filter((it) => typeof it?.type === "string" && typeof it?.id === "string").map((it) => ({
+          type: it.type,
+          id: it.id,
+          label: it.id
+        })) : void 0,
+        ...seq
+      };
+    case MESSAGE_TYPE.TOKEN_USAGE:
+      return {
+        type: "token-usage",
+        inputTokensSize: data.inputTokensSize ?? 0,
+        outputTokensSize: data.outputTokensSize ?? 0,
+        totalTokensSize: data.totalTokensSize ?? 0,
+        contextSize: data.contextSize ?? 0,
+        ...seq
+      };
+    case MESSAGE_TYPE.CONTEXT_COMPACTION_START:
+      return { type: "compaction", phase: "start", ...seq };
+    case MESSAGE_TYPE.CONTEXT_COMPACTION_END:
+      return {
+        type: "compaction",
+        phase: "end",
+        summary: typeof data.text === "string" ? data.text : void 0,
+        ...seq
+      };
+    case MESSAGE_TYPE.SYSTEM:
+      if (typeof data.text === "string") {
+        return { type: "participant", kind: "system", text: data.text, ...seq };
+      }
+      return null;
+    case MESSAGE_TYPE.DIRECT_MESSAGE:
+      if (typeof data.text === "string") {
+        return {
+          type: "participant",
+          kind: "direct-message",
+          text: data.text,
+          ownerType: typeof data.ownerType === "string" ? data.ownerType : void 0,
+          displayName: typeof data.displayName === "string" ? data.displayName : void 0,
+          userId: typeof data.userId === "string" ? data.userId : void 0,
+          ...seq
+        };
+      }
+      return null;
+    case MESSAGE_TYPE.DIALOG_CLOSED:
+      return { type: "dialog-closed", ...seq };
+    default:
+      return null;
+  }
+}
+
+// src/chat-protocol/ip-normalize.ts
+var IP_BUCKET_KEY_MAX_LENGTH = 64;
+function isIpv4(value) {
+  const parts = value.split(".");
+  if (parts.length !== 4) return false;
+  for (const part of parts) {
+    if (!/^\d{1,3}$/.test(part)) return false;
+    if (part.length > 1 && part.startsWith("0")) return false;
+    if (Number(part) > 255) return false;
+  }
+  return true;
+}
+function isIpv6(value) {
+  if (!value.includes(":")) return false;
+  if (!/^[0-9a-f:.]+$/.test(value)) return false;
+  if (value.includes(":::")) return false;
+  if (value.endsWith(":") && !value.endsWith("::")) return false;
+  if (value.startsWith(":") && !value.startsWith("::")) return false;
+  const compressions = value.split("::").length - 1;
+  if (compressions > 1) return false;
+  const groups = value.split(":");
+  if (groups.length > 8) return false;
+  for (let i = 0; i < groups.length; i += 1) {
+    const group = groups[i];
+    if (group === "") continue;
+    if (group.includes(".")) {
+      if (i !== groups.length - 1) return false;
+      if (!isIpv4(group)) return false;
+      continue;
+    }
+    if (!/^[0-9a-f]{1,4}$/.test(group)) return false;
+  }
+  if (compressions === 0) {
+    const embedsIpv4 = groups[groups.length - 1]?.includes(".") ?? false;
+    if (groups.length !== (embedsIpv4 ? 7 : 8)) return false;
+  }
+  return true;
+}
+function normalizeIpForBucketKey(value) {
+  if (typeof value !== "string") return null;
+  let candidate = value.trim();
+  if (candidate === "" || candidate.length > IP_BUCKET_KEY_MAX_LENGTH) return null;
+  if (candidate.startsWith("[")) {
+    const close = candidate.indexOf("]");
+    if (close === -1) return null;
+    const trailer = candidate.slice(close + 1);
+    if (trailer !== "" && !/^:\d{1,5}$/.test(trailer)) return null;
+    candidate = candidate.slice(1, close);
+  }
+  const zone = candidate.indexOf("%");
+  if (zone !== -1) candidate = candidate.slice(0, zone);
+  if (candidate === "") return null;
+  const portSplit = candidate.lastIndexOf(":");
+  if (portSplit > 0 && /^\d{1,5}$/.test(candidate.slice(portSplit + 1))) {
+    const head = candidate.slice(0, portSplit);
+    if (isIpv4(head)) candidate = head;
+  }
+  if (isIpv4(candidate)) return candidate;
+  const lowered = candidate.toLowerCase();
+  const mapped = /^(?:(?:0{1,4}:){5}|::)ffff:(\d{1,3}(?:\.\d{1,3}){3})$/.exec(lowered);
+  if (mapped) return isIpv4(mapped[1]) ? mapped[1] : null;
+  if (isIpv6(lowered)) return lowered;
+  return null;
+}
+
+// src/chat-protocol/env-flag.ts
+function envFlagEnabled(name) {
+  const raw = process.env[name];
+  if (!raw) return false;
+  const v = raw.trim().toLowerCase();
+  return v !== "" && v !== "0" && v !== "false" && v !== "off";
+}
+
+export { CHAT_OWNER_ADMIN, END_OF_LEADING, FRAME_TERMINATOR, IP_BUCKET_KEY_MAX_LENGTH, TRAILER_SENTINEL, createSseFrameDecoder, decodeNatsChunk, encodeEndOfLeading, encodeLeadingFrame, encodeTextDelta, encodeTrailingUsageFrame, envFlagEnabled, escapeThinkingTags, normalizeIpForBucketKey, stripSentinelBytes };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map