Repository Public
1// Author: Simon-Pierre Boucher — contact@spboucher.ai2// File: Packages/LocalChatCore/Sources/Domain.swift3// Description: Shared records for agents, knowledge collections, remote nodes, benchmarks and preferences (one format on Mac, iPhone and iPad).4import Foundation56// MARK: Agents78public enum ToolRisk: String, Codable, Sendable, Comparable, CaseIterable {9 case safe // pure computation, no access to user data10 case read // reads user-granted data11 case write // changes files the user granted12 case execute // runs commands (macOS only)13 private var rank: Int { switch self { case .safe: 0; case .read: 1; case .write: 2; case .execute: 3 } }14 public static func < (a: ToolRisk, b: ToolRisk) -> Bool { a.rank < b.rank }15 public var label: String { switch self { case .safe: "Safe"; case .read: "Reads data"; case .write: "Writes files"; case .execute: "Runs commands" } }16}1718public enum ApprovalMode: String, Codable, Sendable, CaseIterable, Identifiable {19 case always // ask before every tool call20 case risky // ask before write / execute21 case never // never ask (still limited to granted tools and folders)22 public var id: String { rawValue }23 public var title: String { switch self { case .always: "Ask every time"; case .risky: "Ask for risky actions"; case .never: "Never ask" } }24}2526public struct AgentConfiguration: Codable, Sendable, Hashable, Identifiable {27 public var id: UUID28 public var name: String29 public var symbol: String30 public var instructions: String31 public var modelID: String?32 public var enabledTools: [String]33 public var approval: ApprovalMode34 public var maxSteps: Int35 public var maxToolCalls: Int36 public var timeLimitSeconds: Int37 public var collectionIDs: [UUID]38 public var settings: GenerationSettings39 public var updatedAt: Date40 public var deletedAt: Date?41 public init(id: UUID = UUID(), name: String, symbol: String = "sparkle", instructions: String = "", modelID: String? = nil,42 enabledTools: [String] = [], approval: ApprovalMode = .risky, maxSteps: Int = 8, maxToolCalls: Int = 16,43 timeLimitSeconds: Int = 300, collectionIDs: [UUID] = [], settings: GenerationSettings = .default,44 updatedAt: Date = Date(), deletedAt: Date? = nil) {45 self.id = id; self.name = name; self.symbol = symbol; self.instructions = instructions; self.modelID = modelID46 self.enabledTools = enabledTools; self.approval = approval; self.maxSteps = maxSteps; self.maxToolCalls = maxToolCalls47 self.timeLimitSeconds = timeLimitSeconds; self.collectionIDs = collectionIDs; self.settings = settings48 self.updatedAt = updatedAt; self.deletedAt = deletedAt49 }50}5152// MARK: Knowledge5354public struct KnowledgeCollection: Codable, Sendable, Hashable, Identifiable {55 public var id: UUID56 public var name: String57 public var symbol: String58 public var embedderID: String // which embedding model indexed it (vectors are not comparable across models)59 public var dimension: Int60 public var chunkSize: Int // characters61 public var chunkOverlap: Int62 public var createdAt: Date63 public var updatedAt: Date64 public var deletedAt: Date?65 public init(id: UUID = UUID(), name: String, symbol: String = "books.vertical", embedderID: String, dimension: Int, chunkSize: Int = 1200,66 chunkOverlap: Int = 200, createdAt: Date = Date(), updatedAt: Date = Date(), deletedAt: Date? = nil) {67 self.id = id; self.name = name; self.symbol = symbol; self.embedderID = embedderID; self.dimension = dimension68 self.chunkSize = chunkSize; self.chunkOverlap = chunkOverlap; self.createdAt = createdAt; self.updatedAt = updatedAt; self.deletedAt = deletedAt69 }70}7172public struct KnowledgeDocument: Codable, Sendable, Hashable, Identifiable {73 public enum Status: String, Codable, Sendable { case pending, indexing, ready, failed }74 public var id: UUID75 public var collectionID: UUID76 public var name: String77 public var kind: String // pdf, md, txt, docx, csv, code78 public var byteCount: Int79 public var characterCount: Int80 public var chunkCount: Int81 public var contentHash: String // SHA-256 of the source bytes82 public var status: Status83 public var errorText: String?84 public var addedAt: Date85 public init(id: UUID = UUID(), collectionID: UUID, name: String, kind: String, byteCount: Int, characterCount: Int = 0, chunkCount: Int = 0,86 contentHash: String, status: Status = .pending, errorText: String? = nil, addedAt: Date = Date()) {87 self.id = id; self.collectionID = collectionID; self.name = name; self.kind = kind; self.byteCount = byteCount88 self.characterCount = characterCount; self.chunkCount = chunkCount; self.contentHash = contentHash; self.status = status89 self.errorText = errorText; self.addedAt = addedAt90 }91}9293public struct KnowledgeHit: Sendable, Hashable, Identifiable {94 public var id: UUID95 public var document: KnowledgeDocument96 public var chunkIndex: Int97 public var page: Int?98 public var text: String99 public var score: Double // cosine similarity (or fused rank score in hybrid mode)100 public init(id: UUID = UUID(), document: KnowledgeDocument, chunkIndex: Int, page: Int?, text: String, score: Double) {101 self.id = id; self.document = document; self.chunkIndex = chunkIndex; self.page = page; self.text = text; self.score = score102 }103 public var reference: SourceReference {104 SourceReference(documentID: document.id, documentName: document.name, chunkIndex: chunkIndex, page: page,105 excerpt: String(text.prefix(400)), score: score)106 }107}108109/// What chat and agents need from the Knowledge Studio.110public protocol KnowledgeSearching: Sendable {111 func search(_ query: String, collections: [UUID], limit: Int) async throws -> [KnowledgeHit]112}113114// MARK: Remote nodes115116public struct RemoteNode: Codable, Sendable, Hashable, Identifiable {117 public enum Kind: String, Codable, Sendable { case localChat, openAICompatible }118 public var id: UUID119 public var name: String120 public var baseURL: String // e.g. http://studio.local:8765/v1121 public var kind: Kind122 public var isEnabled: Bool123 public var allowInsecureHTTP: Bool // plain HTTP is only accepted for private / link-local hosts unless the user opts in124 public var addedAt: Date125 public init(id: UUID = UUID(), name: String, baseURL: String, kind: Kind = .localChat, isEnabled: Bool = true,126 allowInsecureHTTP: Bool = false, addedAt: Date = Date()) {127 self.id = id; self.name = name; self.baseURL = baseURL; self.kind = kind; self.isEnabled = isEnabled128 self.allowInsecureHTTP = allowInsecureHTTP; self.addedAt = addedAt129 }130 /// The API key lives in the Keychain under this account name, never in the synchronized record.131 public var keychainAccount: String { "node.\(id.uuidString)" }132}133134public struct NodeHealth: Sendable, Hashable {135 public enum State: String, Sendable { case unknown, online, unauthorized, offline }136 public var state: State137 public var latency: TimeInterval? // measured round trip of the models request138 public var models: [String]139 public var detail: String?140 public var checkedAt: Date141 public init(state: State, latency: TimeInterval? = nil, models: [String] = [], detail: String? = nil, checkedAt: Date = Date()) {142 self.state = state; self.latency = latency; self.models = models; self.detail = detail; self.checkedAt = checkedAt143 }144}145146// MARK: Benchmarks147148public struct BenchmarkRecord: Codable, Sendable, Hashable, Identifiable {149 public var id: UUID150 public var modelID: String151 public var modelName: String152 public var backend: BackendKind153 public var quantization: String?154 public var device: String // machine identifier the run was measured on155 public var kind: String // "chat", "arena", "benchmark"156 public var promptLabel: String?157 public var metrics: GenerationMetrics158 public var loadTime: TimeInterval?159 public var contextLength: Int?160 public var createdAt: Date161 public init(id: UUID = UUID(), modelID: String, modelName: String, backend: BackendKind, quantization: String? = nil, device: String,162 kind: String, promptLabel: String? = nil, metrics: GenerationMetrics, loadTime: TimeInterval? = nil, contextLength: Int? = nil,163 createdAt: Date = Date()) {164 self.id = id; self.modelID = modelID; self.modelName = modelName; self.backend = backend; self.quantization = quantization165 self.device = device; self.kind = kind; self.promptLabel = promptLabel; self.metrics = metrics; self.loadTime = loadTime166 self.contextLength = contextLength; self.createdAt = createdAt167 }168}169170// MARK: Paths171172public struct AppPaths: Sendable {173 public var root: URL174 public init(root: URL) { self.root = root }175 public static func standard(appFolder: String = "LocalChat") -> AppPaths {176 let base = FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask).first ?? URL(fileURLWithPath: NSTemporaryDirectory())177 return AppPaths(root: base.appendingPathComponent(appFolder, isDirectory: true))178 }179 public var models: URL { dir("Models") }180 public var downloads: URL { dir("Downloads") }181 public var attachments: URL { dir("Attachments") }182 public var database: URL { dir("Data").appendingPathComponent("localchat.sqlite") }183 public var knowledgeDatabase: URL { dir("Data").appendingPathComponent("knowledge.sqlite") }184 public var metricsDatabase: URL { dir("Data").appendingPathComponent("metrics.sqlite") }185 public var promptCaches: URL { dir("PromptCaches") }186 private func dir(_ name: String) -> URL {187 let url = root.appendingPathComponent(name, isDirectory: true)188 try? FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)189 return url190 }191 /// Model weights are large and re-downloadable: keep them out of device backups.192 public func excludeModelsFromBackup() {193 var url = models; var values = URLResourceValues(); values.isExcludedFromBackup = true194 try? url.setResourceValues(values)195 var d = downloads; try? d.setResourceValues(values)196 }197}198