@superblocksteam/library-shared 2.0.160-next.0 → 2.0.161-next.0

package/dist/types/persisted-chat-message.js

@@ -0,0 +1,752 @@
+import { normalizeLegacyChatRole, TEXT_ATTACHMENT_MIME_TYPES, } from "./ai.js";
+const SUPPORTED_CHAT_ROLES = ["user", "assistant", "system"];
+function isNonNullObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function parsePersistedKnowledgeFacts(facts) {
+    if (!isNonNullObject(facts)) {
+        return null;
+    }
+    if (!Array.isArray(facts.org) || !Array.isArray(facts.user)) {
+        return null;
+    }
+    const integrations = {};
+    if (facts.integrations != null) {
+        if (!isNonNullObject(facts.integrations)) {
+            return null;
+        }
+        for (const [key, value] of Object.entries(facts.integrations)) {
+            if (!Array.isArray(value)) {
+                return null;
+            }
+            integrations[key] = value;
+        }
+    }
+    return {
+        org: facts.org,
+        user: facts.user,
+        integrations,
+    };
+}
+/**
+ * Required-field contract for a persisted row. Callers own their own logging;
+ * `reason` says which field failed.
+ */
+export function parsePersistedChatMessageFields(payload) {
+    if (!payload || typeof payload !== "object") {
+        return { valid: false, reason: "payload" };
+    }
+    const message = payload;
+    if (typeof message.role !== "string") {
+        return { valid: false, reason: "role" };
+    }
+    const role = normalizeLegacyChatRole(message.role);
+    if (!SUPPORTED_CHAT_ROLES.includes(role)) {
+        return { valid: false, reason: "normalizedRole" };
+    }
+    if (typeof message.content !== "string") {
+        return { valid: false, reason: "content" };
+    }
+    if (typeof message.type !== "string") {
+        return { valid: false, reason: "type" };
+    }
+    return {
+        valid: true,
+        fields: { role, content: message.content, type: message.type },
+    };
+}
+const TEXT_LIKE_EXTENSIONS = [
+    ".txt",
+    ".text",
+    ".log",
+    ".md",
+    ".markdown",
+    ".csv",
+    ".tsv",
+    ".json",
+    ".jsonl",
+    ".ndjson",
+    ".xml",
+    ".yaml",
+    ".yml",
+    ".toml",
+    ".ini",
+    ".cfg",
+    ".conf",
+    ".env",
+    ".sh",
+    ".bash",
+    ".zsh",
+    ".js",
+    ".jsx",
+    ".ts",
+    ".tsx",
+    ".mts",
+    ".cts",
+    ".py",
+    ".go",
+    ".java",
+    ".rb",
+    ".php",
+    ".sql",
+    ".css",
+    ".scss",
+    ".html",
+    ".htm",
+];
+export function inferTextAttachmentType(params) {
+    const attachmentType = typeof params.attachmentType === "string"
+        ? params.attachmentType.toLowerCase()
+        : "";
+    const mimeType = typeof params.mimeType === "string" ? params.mimeType.toLowerCase() : "";
+    const lowerFileName = (params.fileName ?? "").toLowerCase();
+    if (attachmentType === "csv" || mimeType === "text/csv") {
+        return "csv";
+    }
+    if (attachmentType === "json" || mimeType === "application/json") {
+        return "json";
+    }
+    if (attachmentType === "yaml" ||
+        mimeType === "text/yaml" ||
+        mimeType === "application/yaml" ||
+        mimeType === "application/x-yaml") {
+        return "yaml";
+    }
+    if (attachmentType === "css" || mimeType === "text/css") {
+        return "css";
+    }
+    if (attachmentType === "txt") {
+        return "txt";
+    }
+    if (lowerFileName.endsWith(".csv")) {
+        return "csv";
+    }
+    if (lowerFileName.endsWith(".json")) {
+        return "json";
+    }
+    if (lowerFileName.endsWith(".yaml") || lowerFileName.endsWith(".yml")) {
+        return "yaml";
+    }
+    if (lowerFileName.endsWith(".css")) {
+        return "css";
+    }
+    if (mimeType.startsWith("text/") ||
+        mimeType.includes("json") ||
+        mimeType.includes("xml") ||
+        mimeType.includes("yaml") ||
+        mimeType.includes("toml") ||
+        mimeType.includes("javascript") ||
+        mimeType.includes("typescript") ||
+        mimeType.includes("ecmascript") ||
+        mimeType.includes("markdown") ||
+        mimeType.includes("shellscript") ||
+        mimeType.includes("python") ||
+        mimeType.includes("ruby") ||
+        mimeType.includes("php") ||
+        mimeType.includes("sql") ||
+        TEXT_LIKE_EXTENSIONS.some((extension) => lowerFileName.endsWith(extension))) {
+        return "txt";
+    }
+    return null;
+}
+/***
+ * Validates and sanitizes the attachments array
+ * @param attachments - The attachments array to validate
+ * @returns A tuple containing:
+ *   - a boolean indicating if the attachments are valid
+ *   - the sanitized attachments array
+ */
+function validateAttachments(attachments) {
+    if (!attachments) {
+        return [true, undefined];
+    }
+    if (typeof attachments !== "object" || !Array.isArray(attachments)) {
+        return [false, undefined];
+    }
+    const validAttachments = attachments
+        .map((attachment) => {
+        if (typeof attachment !== "object" || !("type" in attachment)) {
+            return undefined;
+        }
+        // Validate image attachment
+        if (attachment.type === "image") {
+            if (typeof attachment.image !== "string") {
+                return undefined;
+            }
+            return {
+                type: attachment.type,
+                image: attachment.image,
+                fileName: typeof attachment.fileName === "string"
+                    ? attachment.fileName
+                    : undefined,
+            };
+        }
+        // Validate PDF attachment
+        if (attachment.type === "pdf") {
+            if (typeof attachment.data !== "string") {
+                return undefined;
+            }
+            return {
+                type: attachment.type,
+                data: attachment.data,
+                fileName: typeof attachment.fileName === "string"
+                    ? attachment.fileName
+                    : undefined,
+                size: attachment.size,
+            };
+        }
+        // Validate archive attachment (zip, tgz, gz)
+        if (attachment.type === "archive") {
+            if (typeof attachment.data !== "string") {
+                return undefined;
+            }
+            return {
+                type: attachment.type,
+                data: attachment.data,
+                fileName: typeof attachment.fileName === "string"
+                    ? attachment.fileName
+                    : undefined,
+                size: attachment.size,
+            };
+        }
+        const normalizedTextAttachmentType = typeof attachment.content === "string"
+            ? inferTextAttachmentType({
+                attachmentType: attachment.type,
+                mimeType: attachment.mimeType,
+                fileName: typeof attachment.fileName === "string"
+                    ? attachment.fileName
+                    : "",
+            })
+            : null;
+        // Validate text attachments and normalize any text-like subtype to the
+        // stable server-side text attachment shape.
+        if (normalizedTextAttachmentType) {
+            if (typeof attachment.content !== "string") {
+                return undefined;
+            }
+            return {
+                type: normalizedTextAttachmentType,
+                content: attachment.content,
+                fileName: typeof attachment.fileName === "string"
+                    ? attachment.fileName
+                    : undefined,
+                mimeType: typeof attachment.mimeType === "string"
+                    ? attachment.mimeType
+                    : TEXT_ATTACHMENT_MIME_TYPES[normalizedTextAttachmentType],
+                size: attachment.size,
+            };
+        }
+        if (attachment.type === "uploaded") {
+            if (typeof attachment.url !== "string" ||
+                typeof attachment.mediaType !== "string") {
+                return undefined;
+            }
+            return {
+                type: "uploaded",
+                url: attachment.url,
+                signedUrl: typeof attachment.signedUrl === "string"
+                    ? attachment.signedUrl
+                    : undefined,
+                mediaType: attachment.mediaType,
+                fileName: typeof attachment.fileName === "string"
+                    ? attachment.fileName
+                    : undefined,
+                label: typeof attachment.label === "string" ? attachment.label : undefined,
+                insight: typeof attachment.insight === "string"
+                    ? attachment.insight
+                    : undefined,
+                storageKey: typeof attachment.storageKey === "string"
+                    ? attachment.storageKey
+                    : undefined,
+                signedUrlExpiresAt: typeof attachment.signedUrlExpiresAt === "string"
+                    ? attachment.signedUrlExpiresAt
+                    : undefined,
+                scopeType: attachment.scopeType === "app" || attachment.scopeType === "org"
+                    ? attachment.scopeType
+                    : undefined,
+                applicationId: typeof attachment.applicationId === "string"
+                    ? attachment.applicationId
+                    : undefined,
+            };
+        }
+        return undefined;
+    })
+        .filter(Boolean);
+    return [validAttachments.length === attachments.length, validAttachments];
+}
+export function parsePersistedChatMessage(payload, options) {
+    const { fallbackTimestamp, onInvalid, onError } = options;
+    try {
+        if (!payload || typeof payload !== "object") {
+            return null;
+        }
+        const msg = payload;
+        // Required fields come from the shared contract, so the editor's durable
+        // reader of the same rows cannot drift into rendering what this drops.
+        // Legacy roles "server" and "ai" (written by older server paths such as
+        // setApplicationHash for `draftCommitted` messages, and recognized as
+        // assistant-like in commitMessage.ts) are coerced to "assistant" there,
+        // so existing chat history keeps rendering and a client that dedupes
+        // id-less rows on a composite key keys them the same way we do.
+        const requiredFields = parsePersistedChatMessageFields(payload);
+        if (!requiredFields.valid) {
+            switch (requiredFields.reason) {
+                case "role":
+                    onInvalid?.(`Invalid message role: ${msg.role}`);
+                    break;
+                case "normalizedRole":
+                    onInvalid?.(`Invalid message role after normalize: ${msg.role}`);
+                    break;
+                case "content":
+                    onInvalid?.(`Invalid message content (type=${typeof msg.content})`);
+                    break;
+                case "type":
+                    onInvalid?.(`Invalid message type: ${msg.type}`);
+                    break;
+                case "payload":
+                    break;
+            }
+            return null;
+        }
+        const { role, content } = requiredFields.fields;
+        // Validate optional fields with defaults
+        const timestamp = Number.isFinite(msg.timestamp)
+            ? msg.timestamp
+            : fallbackTimestamp;
+        const group = typeof msg.group === "string" ? msg.group : undefined;
+        const status = typeof msg.status === "string" ? msg.status : undefined;
+        const action = typeof msg.action === "string" ? msg.action : undefined;
+        const title = typeof msg.title === "string" ? msg.title : undefined;
+        const streaming = typeof msg.streaming === "boolean" ? msg.streaming : undefined;
+        const integrations = Array.isArray(msg.integrations)
+            ? msg.integrations
+            : undefined;
+        const entities = Array.isArray(msg.entities)
+            ? msg.entities
+            : undefined;
+        const [isAttachmentsValid, attachments] = validateAttachments(msg.attachments);
+        if (!isAttachmentsValid) {
+            onInvalid?.(`Invalid attachments`);
+            return null;
+        }
+        if (msg.type === "tool") {
+            return {
+                role,
+                content,
+                type: "tool",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                status: status,
+                action: action,
+                args: msg.args,
+                tool: msg.tool,
+                toolCallId: typeof msg.toolCallId === "string" ? msg.toolCallId : undefined,
+                title,
+            };
+        }
+        else if (msg.type === "tool-result") {
+            if (typeof msg.toolCallId !== "string" ||
+                typeof msg.toolName !== "string") {
+                onInvalid?.(`Invalid tool-result message: missing required fields`);
+                return null;
+            }
+            return {
+                role,
+                content: content || "",
+                type: "tool-result",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                status: status,
+                toolCallId: msg.toolCallId,
+                toolName: msg.toolName,
+                output: msg.output,
+                title,
+            };
+        }
+        else if (msg.type === "tool-error") {
+            if (typeof msg.toolCallId !== "string" ||
+                typeof msg.toolName !== "string") {
+                onInvalid?.(`Invalid tool-error message: missing required fields`);
+                return null;
+            }
+            return {
+                role,
+                content: content || "",
+                type: "tool-error",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                status: status,
+                toolCallId: msg.toolCallId,
+                toolName: msg.toolName,
+                error: msg.error instanceof Error
+                    ? msg.error.message
+                    : typeof msg.error === "string"
+                        ? msg.error
+                        : (JSON.stringify(msg.error, null, 2) ?? "Unknown error"),
+                title,
+                errorCode: msg.errorCode,
+                errorSummary: typeof msg.errorSummary === "string"
+                    ? msg.errorSummary
+                    : undefined,
+            };
+        }
+        else if (msg.group === "checklist") {
+            // typeof null === "object" and arrays are objects; processChecklistMessage
+            // reads checklistData.type and payload unguarded, so reject those here.
+            if (!isNonNullObject(msg.checklistData) ||
+                typeof msg.checklistData.type !== "string" ||
+                !isNonNullObject(msg.checklistData.payload)) {
+                onInvalid?.(`Invalid checklist data`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "tool",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                group,
+                status,
+                action,
+                checklistData: msg.checklistData,
+                title,
+            };
+        }
+        else if (msg.type === "multi_choice") {
+            if (!Array.isArray(msg.choices) || msg.choices.length === 0) {
+                onInvalid?.(`Invalid choices for multi_choice message`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "multi_choice",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                choices: msg.choices,
+                selectionType: typeof msg.selectionType === "string"
+                    ? msg.selectionType
+                    : "single",
+                title,
+                questionType: typeof msg.questionType === "string"
+                    ? msg.questionType
+                    : undefined,
+                subtitle: typeof msg.subtitle === "string" ? msg.subtitle : undefined,
+                details: typeof msg.details === "string" ? msg.details : undefined,
+                knowledgeCandidates: Array.isArray(msg.knowledgeCandidates)
+                    ? msg.knowledgeCandidates
+                    : undefined,
+            };
+        }
+        else if (msg.type === "remember_knowledge_draft") {
+            if (!Array.isArray(msg.candidates) || msg.candidates.length === 0) {
+                onInvalid?.(`Invalid candidates for remember_knowledge_draft message`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "remember_knowledge_draft",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                candidates: msg.candidates,
+                title,
+            };
+        }
+        else if (msg.type === "multi_choice_response") {
+            if (typeof msg.responseToMessageId !== "string") {
+                onInvalid?.(`Invalid responseToMessageId for multi_choice_response`);
+                return null;
+            }
+            if (!Array.isArray(msg.selectedChoiceIndices)) {
+                onInvalid?.(`Invalid selectedChoiceIndices for multi_choice_response`);
+                return null;
+            }
+            const response = {
+                role,
+                content,
+                type: "multi_choice_response",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                responseToMessageId: msg.responseToMessageId,
+                selectedChoiceIndices: msg.selectedChoiceIndices,
+                selectedScopes: Array.isArray(msg.selectedScopes)
+                    ? msg.selectedScopes
+                    : undefined,
+                savedFacts: Array.isArray(msg.savedFacts)
+                    ? msg.savedFacts
+                    : undefined,
+                title,
+            };
+            return response;
+        }
+        else if (msg.type === "remember_knowledge_draft_response") {
+            if (typeof msg.responseToMessageId !== "string") {
+                onInvalid?.(`Invalid responseToMessageId for remember_knowledge_draft_response`);
+                return null;
+            }
+            if (!Array.isArray(msg.selectedCandidateIndices)) {
+                onInvalid?.(`Invalid selectedCandidateIndices for remember_knowledge_draft_response`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "remember_knowledge_draft_response",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                responseToMessageId: msg.responseToMessageId,
+                selectedCandidateIndices: msg.selectedCandidateIndices,
+                selectedScopes: Array.isArray(msg.selectedScopes)
+                    ? msg.selectedScopes
+                    : undefined,
+                savedFacts: Array.isArray(msg.savedFacts)
+                    ? msg.savedFacts
+                    : undefined,
+                title,
+            };
+        }
+        else if (msg.type === "confirm") {
+            return {
+                role,
+                content,
+                type: "confirm",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                knowledgeEntry: typeof msg.knowledgeEntry === "object" && msg.knowledgeEntry !== null
+                    ? msg.knowledgeEntry
+                    : undefined,
+                title,
+            };
+        }
+        else if (msg.type === "searchable_dropdown") {
+            if (!Array.isArray(msg.options) || msg.options.length === 0) {
+                onInvalid?.(`Invalid options for searchable_dropdown message`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "searchable_dropdown",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                options: msg.options,
+                placeholder: typeof msg.placeholder === "string" ? msg.placeholder : undefined,
+                title,
+            };
+        }
+        else if (msg.type === "searchable_dropdown_response") {
+            if (typeof msg.responseToMessageId !== "string") {
+                onInvalid?.(`Invalid responseToMessageId for searchable_dropdown_response`);
+                return null;
+            }
+            if (typeof msg.selectedValue !== "string") {
+                onInvalid?.(`Invalid selectedValue for searchable_dropdown_response`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "searchable_dropdown_response",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                responseToMessageId: msg.responseToMessageId,
+                selectedValue: msg.selectedValue,
+                selectedLabel: typeof msg.selectedLabel === "string"
+                    ? msg.selectedLabel
+                    : msg.selectedValue,
+                title,
+            };
+        }
+        else if (msg.type === "confirm_response") {
+            if (typeof msg.responseToMessageId !== "string") {
+                onInvalid?.(`Invalid responseToMessageId for confirm_response`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "confirm_response",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                responseToMessageId: msg.responseToMessageId,
+                approved: Boolean(msg.approved),
+                selectedScopes: Array.isArray(msg.selectedScopes)
+                    ? msg.selectedScopes
+                    : undefined,
+                savedFacts: Array.isArray(msg.savedFacts)
+                    ? msg.savedFacts
+                    : undefined,
+                title,
+            };
+        }
+        else if (msg.type === "plan_response") {
+            if (typeof msg.responseToMessageId !== "string") {
+                onInvalid?.(`Invalid responseToMessageId for plan_response`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "plan_response",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                responseToMessageId: msg.responseToMessageId,
+                title,
+                approved: typeof msg.approved === "boolean" ? msg.approved : undefined,
+                enableTesting: typeof msg.enableTesting === "boolean"
+                    ? msg.enableTesting
+                    : undefined,
+            };
+        }
+        else if (msg.type === "test_run_start") {
+            if (typeof msg.testRunId !== "string") {
+                onInvalid?.(`Invalid test_run_start message: missing testRunId`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "test_run_start",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                testRunId: msg.testRunId,
+                header: typeof msg.header === "string" ? msg.header : "End-to-end Testing",
+                testCases: Array.isArray(msg.testCases) ? msg.testCases : undefined,
+            };
+        }
+        else if (msg.type === "test_case_update") {
+            if (typeof msg.testRunId !== "string") {
+                onInvalid?.(`Invalid test_case_update message: missing testRunId`);
+                return null;
+            }
+            if (typeof msg.testCaseId !== "string") {
+                onInvalid?.(`Invalid test_case_update message: missing testCaseId`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "test_case_update",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                testRunId: msg.testRunId,
+                testCaseId: msg.testCaseId,
+                testCaseStatus: msg.testCaseStatus,
+            };
+        }
+        else if (msg.type === "test_run_end") {
+            if (typeof msg.testRunId !== "string") {
+                onInvalid?.(`Invalid test_run_end message: missing testRunId`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "test_run_end",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                testRunId: msg.testRunId,
+                testStatus: typeof msg.testStatus === "string"
+                    ? msg.testStatus
+                    : "completed",
+                summary: typeof msg.summary === "string" ? msg.summary : undefined,
+            };
+        }
+        else if (msg.type === "retry_notification") {
+            return {
+                role,
+                content,
+                type: "retry_notification",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                retryType: msg.retryType,
+                attempt: typeof msg.attempt === "number" ? msg.attempt : undefined,
+                delaySeconds: typeof msg.delaySeconds === "number" ? msg.delaySeconds : undefined,
+                fromProvider: typeof msg.fromProvider === "string" ? msg.fromProvider : undefined,
+                toProvider: typeof msg.toProvider === "string" ? msg.toProvider : undefined,
+                reason: typeof msg.reason === "string" ? msg.reason : undefined,
+            };
+        }
+        else if (msg.type === "knowledge") {
+            const facts = parsePersistedKnowledgeFacts(msg.facts);
+            if (!facts) {
+                onInvalid?.(`Invalid knowledge facts`);
+                return null;
+            }
+            return {
+                role,
+                content,
+                type: "knowledge",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                status,
+                facts,
+            };
+        }
+        else if (msg.type === "app_knowledge_saved") {
+            return {
+                role,
+                content,
+                type: "app_knowledge_saved",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                knowledgeCount: typeof msg.knowledgeCount === "number" ? msg.knowledgeCount : 0,
+                responseToMessageId: typeof msg.responseToMessageId === "string"
+                    ? msg.responseToMessageId
+                    : undefined,
+                savedFacts: Array.isArray(msg.savedFacts) ? msg.savedFacts : undefined,
+            };
+        }
+        else if (msg.type === "next_steps") {
+            return {
+                role,
+                content,
+                type: "next_steps",
+                id: typeof msg.id === "string" ? msg.id : undefined,
+                timestamp,
+                nextSteps: Array.isArray(msg.nextSteps) ? msg.nextSteps : [],
+            };
+        }
+        const baseMessage = {
+            role: role,
+            content,
+            type: msg.type,
+            id: typeof msg.id === "string" ? msg.id : undefined,
+            timestamp,
+            group,
+            status: status,
+            action: action,
+            attachments,
+            title,
+        };
+        if (msg.type === "plan") {
+            if (streaming !== undefined) {
+                baseMessage.streaming = streaming;
+            }
+            if (integrations) {
+                baseMessage.integrations = integrations;
+            }
+            if (entities) {
+                baseMessage.entities = entities;
+            }
+            if (msg.includesFreshDatabase === true) {
+                baseMessage.includesFreshDatabase = true;
+            }
+        }
+        // Preserve commitId for commitRestored, commitRestoring, and draftCommitted messages
+        if ((msg.type === "commitRestored" ||
+            msg.type === "commitRestoring" ||
+            msg.type === "draftCommitted") &&
+            typeof msg.commitId === "string") {
+            baseMessage.commitId =
+                msg.commitId;
+        }
+        return baseMessage;
+    }
+    catch (error) {
+        onError?.(error);
+        return null;
+    }
+}
+//# sourceMappingURL=persisted-chat-message.js.map