Compare commits
82
Commits
@@ -0,0 +1,18 @@
|
|||||||
|
import Foundation
|
||||||
|
import SwiftData
|
||||||
|
|
||||||
|
/// Generic key/value row backing `OfflineCacheStore` — one table for every
|
||||||
|
/// cached response shape instead of a `@Model` per Outline type, so adding a
|
||||||
|
/// new cached endpoint never needs a schema migration.
|
||||||
|
@Model
|
||||||
|
public final class CachedPayload {
|
||||||
|
@Attribute(.unique) public var key: String
|
||||||
|
public var payload: Data
|
||||||
|
public var cachedAt: Date
|
||||||
|
|
||||||
|
public init(key: String, payload: Data, cachedAt: Date) {
|
||||||
|
self.key = key
|
||||||
|
self.payload = payload
|
||||||
|
self.cachedAt = cachedAt
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,721 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// Decorates `LiveOutlineAPIClient` (or any `OutlineAPIClient`) with offline
|
||||||
|
/// support at the existing protocol boundary, so no view model needs to know
|
||||||
|
/// the network exists:
|
||||||
|
///
|
||||||
|
/// - **Reads** (`documentInfo`, `listDocuments`, `documentsList`,
|
||||||
|
/// `listViewedDocuments`, `listCollections`, `collectionInfo`): read-through
|
||||||
|
/// cache. Always tries live first — never pre-checks reachability, since
|
||||||
|
/// "did this specific request just fail" is a more honest signal than a
|
||||||
|
/// reachability monitor, and the two can disagree (captive portals,
|
||||||
|
/// flaky Wi-Fi). Falls back to the cache only on failure; a live success
|
||||||
|
/// always overwrites the cache, so staleness is bounded by "last time this
|
||||||
|
/// endpoint actually worked."
|
||||||
|
/// - **A small set of writes** (`updateDocument`, `updateCollection`,
|
||||||
|
/// pin/star/subscribe create+delete): applied optimistically against the
|
||||||
|
/// cache and queued in `OfflineCacheStore`'s `PendingOperation` table on
|
||||||
|
/// failure, then replayed in order by `flushPendingOperations()` once back
|
||||||
|
/// online. Deliberately doesn't include anything that creates new tree
|
||||||
|
/// structure (`createDocument`, `moveDocument`, `archiveDocument`,
|
||||||
|
/// `deleteDocument`, `deleteCollection`, `duplicateDocument`) — those need
|
||||||
|
/// real server-assigned ids to stay consistent with the rest of the tree,
|
||||||
|
/// and reconciling a locally-invented id with the one the server hands
|
||||||
|
/// back on sync is a much bigger problem than this pass takes on. Sharing,
|
||||||
|
/// permissions, search, and export also stay live-only — read the request,
|
||||||
|
/// they need someone else's server session, not just a network.
|
||||||
|
/// - **Manual offline mode** (`offlineModeDefaultsKey`): when set, skips
|
||||||
|
/// attempting `live` entirely — same fallback/queue paths as a real
|
||||||
|
/// failure, just chosen on purpose instead of discovered.
|
||||||
|
public actor CachingOutlineAPIClient: OutlineAPIClient {
|
||||||
|
public static let offlineModeDefaultsKey = "outpost.offlineModeEnabled"
|
||||||
|
|
||||||
|
private let live: OutlineAPIClient
|
||||||
|
private let cache: OfflineCacheStore
|
||||||
|
private let defaults: UserDefaults
|
||||||
|
private let encoder: JSONEncoder
|
||||||
|
private let decoder: JSONDecoder
|
||||||
|
private let keyEncoder: JSONEncoder
|
||||||
|
|
||||||
|
public init(live: OutlineAPIClient, cache: OfflineCacheStore, defaults: UserDefaults = .standard) {
|
||||||
|
self.live = live
|
||||||
|
self.cache = cache
|
||||||
|
self.defaults = defaults
|
||||||
|
|
||||||
|
let encoder = JSONEncoder()
|
||||||
|
encoder.dateEncodingStrategy = .iso8601
|
||||||
|
self.encoder = encoder
|
||||||
|
|
||||||
|
let decoder = JSONDecoder()
|
||||||
|
decoder.dateDecodingStrategy = .iso8601
|
||||||
|
self.decoder = decoder
|
||||||
|
|
||||||
|
let keyEncoder = JSONEncoder()
|
||||||
|
keyEncoder.outputFormatting = .sortedKeys
|
||||||
|
self.keyEncoder = keyEncoder
|
||||||
|
}
|
||||||
|
|
||||||
|
private var isManualOfflineModeEnabled: Bool {
|
||||||
|
defaults.bool(forKey: Self.offlineModeDefaultsKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Cached reads
|
||||||
|
|
||||||
|
public func documentInfo(id: String) async throws -> OutlineDocument {
|
||||||
|
try await cachedFetch(key: "document:\(id)") { try await self.live.documentInfo(id: id) }
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listDocuments(
|
||||||
|
collectionId: String?,
|
||||||
|
parentDocumentId: String?,
|
||||||
|
offset: Int,
|
||||||
|
limit: Int
|
||||||
|
) async throws -> [OutlineDocument] {
|
||||||
|
let key = "documents:\(collectionId ?? "-"):\(parentDocumentId ?? "-"):\(offset):\(limit)"
|
||||||
|
return try await cachedFetch(key: key) {
|
||||||
|
try await self.live.listDocuments(
|
||||||
|
collectionId: collectionId,
|
||||||
|
parentDocumentId: parentDocumentId,
|
||||||
|
offset: offset,
|
||||||
|
limit: limit
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public func documentsList(_ request: DocumentsListRequest) async throws -> [OutlineDocument] {
|
||||||
|
try await cachedFetch(key: requestKey("documentsList", request)) { try await self.live.documentsList(request) }
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listViewedDocuments(offset: Int, limit: Int) async throws -> [OutlineDocument] {
|
||||||
|
try await cachedFetch(key: "documentsViewed:\(offset):\(limit)") {
|
||||||
|
try await self.live.listViewedDocuments(offset: offset, limit: limit)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listCollections(offset: Int, limit: Int) async throws -> [OutlineCollection] {
|
||||||
|
try await cachedFetch(key: "collections:\(offset):\(limit)") {
|
||||||
|
try await self.live.listCollections(offset: offset, limit: limit)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public func collectionInfo(id: String) async throws -> OutlineCollection {
|
||||||
|
try await cachedFetch(key: "collection:\(id)") { try await self.live.collectionInfo(id: id) }
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Queueable writes
|
||||||
|
|
||||||
|
/// The one exception to "no new tree structure while offline" —
|
||||||
|
/// synthesizes a document under a `pending-<uuid>` id (same scheme as
|
||||||
|
/// pin/star/subscribe), caches it so it's immediately readable/editable,
|
||||||
|
/// and queues the real create. On sync, the server-assigned id replaces
|
||||||
|
/// the placeholder in the cache; anything still referencing the old id
|
||||||
|
/// directly (a currently-open reader, most likely) won't follow that
|
||||||
|
/// rename automatically — a known, narrow limitation, not something this
|
||||||
|
/// pass tries to solve generally.
|
||||||
|
public func createDocument(_ request: CreateDocumentRequest) async throws -> OutlineDocument {
|
||||||
|
if !isManualOfflineModeEnabled {
|
||||||
|
do {
|
||||||
|
let result = try await live.createDocument(request)
|
||||||
|
await cacheDocument(result)
|
||||||
|
return result
|
||||||
|
} catch {
|
||||||
|
return await queueDocumentCreate(request)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return await queueDocumentCreate(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateDocument(_ request: UpdateDocumentRequest) async throws -> OutlineDocument {
|
||||||
|
if !isManualOfflineModeEnabled {
|
||||||
|
do {
|
||||||
|
let result = try await live.updateDocument(request)
|
||||||
|
await cacheDocument(result)
|
||||||
|
return result
|
||||||
|
} catch {
|
||||||
|
return try await queueDocumentUpdate(request, dueTo: error)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return try await queueDocumentUpdate(request, dueTo: nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateCollection(_ request: UpdateCollectionRequest) async throws -> OutlineCollection {
|
||||||
|
if !isManualOfflineModeEnabled {
|
||||||
|
do {
|
||||||
|
let result = try await live.updateCollection(request)
|
||||||
|
await cacheCollection(result)
|
||||||
|
return result
|
||||||
|
} catch {
|
||||||
|
return try await queueCollectionUpdate(request, dueTo: error)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return try await queueCollectionUpdate(request, dueTo: nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func createPin(_ request: CreatePinRequest) async throws -> OutlinePin {
|
||||||
|
if !isManualOfflineModeEnabled {
|
||||||
|
do { return try await live.createPin(request) } catch { return await queuePinCreate(request) }
|
||||||
|
}
|
||||||
|
return await queuePinCreate(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deletePin(id: String) async throws {
|
||||||
|
if await cancelIfNeverSynced(id: id) { return }
|
||||||
|
if !isManualOfflineModeEnabled {
|
||||||
|
do {
|
||||||
|
try await live.deletePin(id: id)
|
||||||
|
return
|
||||||
|
} catch {
|
||||||
|
await enqueue(.deletePin, payload: IDPayload(id: id), id: "delete-pin-\(id)")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
await enqueue(.deletePin, payload: IDPayload(id: id), id: "delete-pin-\(id)")
|
||||||
|
}
|
||||||
|
|
||||||
|
public func createSubscription(_ request: CreateSubscriptionRequest) async throws -> OutlineSubscription {
|
||||||
|
if !isManualOfflineModeEnabled {
|
||||||
|
do { return try await live.createSubscription(request) } catch { return await queueSubscriptionCreate(request) }
|
||||||
|
}
|
||||||
|
return await queueSubscriptionCreate(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deleteSubscription(id: String) async throws {
|
||||||
|
if await cancelIfNeverSynced(id: id) { return }
|
||||||
|
if !isManualOfflineModeEnabled {
|
||||||
|
do {
|
||||||
|
try await live.deleteSubscription(id: id)
|
||||||
|
return
|
||||||
|
} catch {
|
||||||
|
await enqueue(.deleteSubscription, payload: IDPayload(id: id), id: "delete-subscription-\(id)")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
await enqueue(.deleteSubscription, payload: IDPayload(id: id), id: "delete-subscription-\(id)")
|
||||||
|
}
|
||||||
|
|
||||||
|
public func starDocument(_ request: StarDocumentRequest) async throws -> OutlineStar {
|
||||||
|
if !isManualOfflineModeEnabled {
|
||||||
|
do { return try await live.starDocument(request) } catch { return await queueStarDocumentCreate(request) }
|
||||||
|
}
|
||||||
|
return await queueStarDocumentCreate(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func starCollection(_ request: StarCollectionRequest) async throws -> OutlineStar {
|
||||||
|
if !isManualOfflineModeEnabled {
|
||||||
|
do { return try await live.starCollection(request) } catch { return await queueStarCollectionCreate(request) }
|
||||||
|
}
|
||||||
|
return await queueStarCollectionCreate(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deleteStar(id: String) async throws {
|
||||||
|
if await cancelIfNeverSynced(id: id) { return }
|
||||||
|
if !isManualOfflineModeEnabled {
|
||||||
|
do {
|
||||||
|
try await live.deleteStar(id: id)
|
||||||
|
return
|
||||||
|
} catch {
|
||||||
|
await enqueue(.deleteStar, payload: IDPayload(id: id), id: "delete-star-\(id)")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
await enqueue(.deleteStar, payload: IDPayload(id: id), id: "delete-star-\(id)")
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Pass-through
|
||||||
|
|
||||||
|
public func authInfo() async throws -> OutlineAuthInfo {
|
||||||
|
try await live.authInfo()
|
||||||
|
}
|
||||||
|
|
||||||
|
public func searchDocuments(_ request: DocumentSearchRequest) async throws -> [OutlineDocumentSearchResult] {
|
||||||
|
try await live.searchDocuments(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func searchDocumentTitles(_ request: DocumentSearchTitlesRequest) async throws -> [OutlineDocument] {
|
||||||
|
try await live.searchDocumentTitles(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func templatizeDocument(_ request: TemplatizeDocumentRequest) async throws -> OutlineTemplate {
|
||||||
|
try await live.templatizeDocument(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func duplicateDocument(_ request: DuplicateDocumentRequest) async throws -> [OutlineDocument] {
|
||||||
|
try await live.duplicateDocument(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func unpublishDocument(_ request: UnpublishDocumentRequest) async throws -> OutlineDocument {
|
||||||
|
try await live.unpublishDocument(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func archiveDocument(id: String) async throws -> OutlineDocument {
|
||||||
|
try await live.archiveDocument(id: id)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func moveDocument(_ request: MoveDocumentRequest) async throws {
|
||||||
|
try await live.moveDocument(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deleteDocument(_ request: DeleteDocumentRequest) async throws {
|
||||||
|
try await live.deleteDocument(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func documentInsights(_ request: DocumentInsightsRequest) async throws -> [OutlineDocumentInsight] {
|
||||||
|
try await live.documentInsights(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listRevisions(_ request: ListRevisionsRequest) async throws -> [OutlineRevision] {
|
||||||
|
try await live.listRevisions(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func exportDocument(id: String) async throws -> String {
|
||||||
|
try await live.exportDocument(id: id)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func createShare(_ request: CreateShareRequest) async throws -> OutlineShare {
|
||||||
|
try await live.createShare(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func shareInfo(documentId: String) async throws -> OutlineShare? {
|
||||||
|
try await live.shareInfo(documentId: documentId)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateShare(_ request: UpdateShareRequest) async throws -> OutlineShare {
|
||||||
|
try await live.updateShare(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listShares(_ request: ListSharesRequest) async throws -> [OutlineShare] {
|
||||||
|
try await live.listShares(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func revokeShare(id: String) async throws {
|
||||||
|
try await live.revokeShare(id: id)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listPins(_ request: ListPinsRequest) async throws -> [OutlinePin] {
|
||||||
|
try await live.listPins(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listSubscriptions(_ request: ListSubscriptionsRequest) async throws -> [OutlineSubscription] {
|
||||||
|
try await live.listSubscriptions(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listViews(_ request: ListViewsRequest) async throws -> [OutlineView] {
|
||||||
|
try await live.listViews(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func addDocumentUser(_ request: AddDocumentUserRequest) async throws -> OutlineMembership {
|
||||||
|
try await live.addDocumentUser(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func removeDocumentUser(_ request: RemoveDocumentUserRequest) async throws {
|
||||||
|
try await live.removeDocumentUser(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func documentUsers(_ request: ListDocumentUsersRequest) async throws -> [OutlineDocumentMember] {
|
||||||
|
try await live.documentUsers(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listUsers(_ request: ListUsersRequest) async throws -> [OutlineUser] {
|
||||||
|
try await live.listUsers(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deleteCollection(id: String) async throws {
|
||||||
|
try await live.deleteCollection(id: id)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func exportCollection(_ request: ExportCollectionRequest) async throws -> OutlineFileOperation {
|
||||||
|
try await live.exportCollection(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listStars(_ request: ListStarsRequest) async throws -> [OutlineStar] {
|
||||||
|
try await live.listStars(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func currentUser() async throws -> OutlineUser {
|
||||||
|
try await live.currentUser()
|
||||||
|
}
|
||||||
|
|
||||||
|
public func createAttachment(_ request: CreateAttachmentRequest) async throws -> CreateAttachmentResult {
|
||||||
|
try await live.createAttachment(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func uploadAttachmentFile(_ result: CreateAttachmentResult, fileData: Data) async throws {
|
||||||
|
try await live.uploadAttachmentFile(result, fileData: fileData)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deleteAttachment(id: String) async throws {
|
||||||
|
try await live.deleteAttachment(id: id)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateUserAvatar(_ request: UpdateUserAvatarRequest) async throws -> OutlineUser {
|
||||||
|
try await live.updateUserAvatar(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateUserName(_ request: UpdateUserNameRequest) async throws -> OutlineUser {
|
||||||
|
try await live.updateUserName(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateUserLanguage(_ request: UpdateUserLanguageRequest) async throws -> OutlineUser {
|
||||||
|
try await live.updateUserLanguage(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateUserPreferences(_ request: UpdateUserPreferencesRequest) async throws -> OutlineUser {
|
||||||
|
try await live.updateUserPreferences(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deleteAccount() async throws {
|
||||||
|
try await live.deleteAccount()
|
||||||
|
}
|
||||||
|
|
||||||
|
public func subscribeToNotifications(eventType: NotificationEventType?) async throws -> OutlineUser {
|
||||||
|
try await live.subscribeToNotifications(eventType: eventType)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func unsubscribeFromNotifications(eventType: NotificationEventType?) async throws -> OutlineUser {
|
||||||
|
try await live.unsubscribeFromNotifications(eventType: eventType)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listApiKeys(_ request: ListApiKeysRequest) async throws -> [OutlineAPIKey] {
|
||||||
|
try await live.listApiKeys(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func createApiKey(_ request: CreateApiKeyRequest) async throws -> OutlineAPIKey {
|
||||||
|
try await live.createApiKey(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deleteApiKey(id: String) async throws {
|
||||||
|
try await live.deleteApiKey(id: id)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func installationInfo() async throws -> OutlineInstallationInfo {
|
||||||
|
try await live.installationInfo()
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Sync management (Settings surface)
|
||||||
|
|
||||||
|
public func pendingOperations() async -> [PendingOperationSummary] {
|
||||||
|
await cache.pendingOperations().map {
|
||||||
|
PendingOperationSummary(id: $0.id, kind: $0.kind, createdAt: $0.createdAt, attemptCount: $0.attemptCount, lastError: $0.lastError)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public func cacheStorageSummary() async -> CacheStorageSummary {
|
||||||
|
CacheStorageSummary(itemCount: await cache.itemCount(), totalBytes: await cache.totalBytes())
|
||||||
|
}
|
||||||
|
|
||||||
|
public func clearCache() async {
|
||||||
|
await cache.clearAll()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Replays every queued operation against `live`, in the order they were
|
||||||
|
/// queued. Each is independent — one failing doesn't block the rest.
|
||||||
|
public func flushPendingOperations() async -> SyncFlushSummary {
|
||||||
|
let operations = await cache.pendingOperations()
|
||||||
|
var succeeded = 0
|
||||||
|
var failed = 0
|
||||||
|
for operation in operations {
|
||||||
|
do {
|
||||||
|
try await replay(operation)
|
||||||
|
await cache.removeOperation(id: operation.id)
|
||||||
|
succeeded += 1
|
||||||
|
} catch {
|
||||||
|
await cache.recordFailure(id: operation.id, error: errorDescription(error))
|
||||||
|
failed += 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return SyncFlushSummary(succeeded: succeeded, failed: failed)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// "Full Local Sync": eagerly walks every collection and caches every
|
||||||
|
/// document's full content (not just whatever's been opened), so
|
||||||
|
/// browsing offline works for the whole workspace, not only what was
|
||||||
|
/// already viewed. Goes through `self`, not `live`, directly — the
|
||||||
|
/// existing cached-read methods already do the caching as a side effect,
|
||||||
|
/// this just has to drive the walk and separately cache each document by
|
||||||
|
/// id (`listDocuments`'s cache key is the list, not the individual doc).
|
||||||
|
public func performFullSync() async -> FullSyncSummary {
|
||||||
|
var documentsCount = 0
|
||||||
|
var errors: [String] = []
|
||||||
|
var collections: [OutlineCollection] = []
|
||||||
|
var collectionsOffset = 0
|
||||||
|
let collectionsLimit = 100
|
||||||
|
// Outline rejects any `limit` over 100 outright — page in increments
|
||||||
|
// of that instead of guessing a total up front (the protocol doesn't
|
||||||
|
// expose `pagination`'s total count, only the page itself); a page
|
||||||
|
// shorter than the limit is what signals "that was the last one".
|
||||||
|
while true {
|
||||||
|
let page: [OutlineCollection]
|
||||||
|
do {
|
||||||
|
page = try await listCollections(offset: collectionsOffset, limit: collectionsLimit)
|
||||||
|
} catch {
|
||||||
|
errors.append(errorDescription(error))
|
||||||
|
break
|
||||||
|
}
|
||||||
|
collections.append(contentsOf: page)
|
||||||
|
guard page.count == collectionsLimit else { break }
|
||||||
|
collectionsOffset += collectionsLimit
|
||||||
|
}
|
||||||
|
|
||||||
|
for collection in collections {
|
||||||
|
var offset = 0
|
||||||
|
let limit = 100
|
||||||
|
while true {
|
||||||
|
let documents: [OutlineDocument]
|
||||||
|
do {
|
||||||
|
documents = try await listDocuments(collectionId: collection.id, parentDocumentId: nil, offset: offset, limit: limit)
|
||||||
|
} catch {
|
||||||
|
errors.append("\(collection.name): \(errorDescription(error))")
|
||||||
|
break
|
||||||
|
}
|
||||||
|
for document in documents {
|
||||||
|
await cacheDocument(document)
|
||||||
|
}
|
||||||
|
documentsCount += documents.count
|
||||||
|
guard documents.count == limit else { break }
|
||||||
|
offset += limit
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return FullSyncSummary(collectionsCount: collections.count, documentsCount: documentsCount, errors: errors, finishedAt: Date())
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Helpers
|
||||||
|
|
||||||
|
private func cachedFetch<T: Codable>(key: String, fetch: () async throws -> T) async throws -> T {
|
||||||
|
// Manual offline mode means "skip the network entirely," not just
|
||||||
|
// "prefer it" — without this check, a read would still hit `live`
|
||||||
|
// (and succeed, showing content beyond whatever's cached) any time
|
||||||
|
// the device actually had a connection, defeating the point of
|
||||||
|
// deliberately testing/working as if offline.
|
||||||
|
if isManualOfflineModeEnabled {
|
||||||
|
if let data = await cache.load(forKey: key), let cached = try? decoder.decode(T.self, from: data) {
|
||||||
|
return cached
|
||||||
|
}
|
||||||
|
throw OutlineAPIError.transport(URLError(.notConnectedToInternet))
|
||||||
|
}
|
||||||
|
do {
|
||||||
|
let result = try await fetch()
|
||||||
|
if let data = try? encoder.encode(result) {
|
||||||
|
await cache.save(data, forKey: key)
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
} catch {
|
||||||
|
if let data = await cache.load(forKey: key), let cached = try? decoder.decode(T.self, from: data) {
|
||||||
|
return cached
|
||||||
|
}
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private func requestKey(_ prefix: String, _ request: some Encodable) -> String {
|
||||||
|
guard let data = try? keyEncoder.encode(request), let json = String(data: data, encoding: .utf8) else {
|
||||||
|
return prefix
|
||||||
|
}
|
||||||
|
return "\(prefix):\(json)"
|
||||||
|
}
|
||||||
|
|
||||||
|
private func cacheDocument(_ document: OutlineDocument) async {
|
||||||
|
if let data = try? encoder.encode(document) {
|
||||||
|
await cache.save(data, forKey: "document:\(document.id)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private func cacheCollection(_ collection: OutlineCollection) async {
|
||||||
|
if let data = try? encoder.encode(collection) {
|
||||||
|
await cache.save(data, forKey: "collection:\(collection.id)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private func enqueue(_ kind: PendingOperationKind, payload: some Encodable, id: String) async {
|
||||||
|
guard let data = try? encoder.encode(payload) else { return }
|
||||||
|
await cache.enqueueOperation(id: id, kind: kind.rawValue, payload: data)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A delete targeting a `pending-*` id can only mean "cancel the create
|
||||||
|
/// still sitting in the queue" — the server has never heard of that id,
|
||||||
|
/// so queuing the delete would just fail once synced. Returns whether it
|
||||||
|
/// found (and removed) a matching create, meaning the caller is done.
|
||||||
|
private func cancelIfNeverSynced(id: String) async -> Bool {
|
||||||
|
guard id.hasPrefix("pending-") else { return false }
|
||||||
|
return await cache.removeOperation(id: id)
|
||||||
|
}
|
||||||
|
|
||||||
|
private func queueDocumentCreate(_ request: CreateDocumentRequest) async -> OutlineDocument {
|
||||||
|
let pendingId = "pending-\(UUID().uuidString)"
|
||||||
|
let now = Date()
|
||||||
|
let synthesized = OutlineDocument(
|
||||||
|
id: pendingId,
|
||||||
|
title: request.title,
|
||||||
|
text: request.text,
|
||||||
|
emoji: nil,
|
||||||
|
collectionId: request.collectionId,
|
||||||
|
parentDocumentId: request.parentDocumentId,
|
||||||
|
url: "/doc/\(pendingId)",
|
||||||
|
revision: nil,
|
||||||
|
fullWidth: nil,
|
||||||
|
createdAt: now,
|
||||||
|
updatedAt: now,
|
||||||
|
publishedAt: request.publish ? now : nil,
|
||||||
|
archivedAt: nil,
|
||||||
|
deletedAt: nil
|
||||||
|
)
|
||||||
|
await cacheDocument(synthesized)
|
||||||
|
await enqueue(.createDocument, payload: request, id: pendingId)
|
||||||
|
return synthesized
|
||||||
|
}
|
||||||
|
|
||||||
|
private func queueDocumentUpdate(_ request: UpdateDocumentRequest, dueTo error: Error?) async throws -> OutlineDocument {
|
||||||
|
guard let baseData = await cache.load(forKey: "document:\(request.id)"),
|
||||||
|
let base = try? decoder.decode(OutlineDocument.self, from: baseData) else {
|
||||||
|
throw error ?? OutlineAPIError.transport(URLError(.notConnectedToInternet))
|
||||||
|
}
|
||||||
|
let mergedText = request.append == true ? base.text + (request.text ?? "") : (request.text ?? base.text)
|
||||||
|
let merged = OutlineDocument(
|
||||||
|
id: base.id,
|
||||||
|
title: request.title ?? base.title,
|
||||||
|
text: mergedText,
|
||||||
|
emoji: base.emoji,
|
||||||
|
collectionId: base.collectionId,
|
||||||
|
parentDocumentId: base.parentDocumentId,
|
||||||
|
url: base.url,
|
||||||
|
revision: base.revision,
|
||||||
|
fullWidth: request.fullWidth ?? base.fullWidth,
|
||||||
|
createdAt: base.createdAt,
|
||||||
|
updatedAt: Date(),
|
||||||
|
publishedAt: base.publishedAt,
|
||||||
|
archivedAt: base.archivedAt,
|
||||||
|
deletedAt: base.deletedAt
|
||||||
|
)
|
||||||
|
await cacheDocument(merged)
|
||||||
|
|
||||||
|
// Still-unsynced create for this exact document — fold the edit into
|
||||||
|
// the pending create's payload instead of queuing a separate update.
|
||||||
|
// A separate update would target `merged.id`, which is still the
|
||||||
|
// `pending-*` placeholder at replay time; the server has never heard
|
||||||
|
// of it and the update would just fail every retry.
|
||||||
|
if merged.id.hasPrefix("pending-"),
|
||||||
|
let createOp = await cache.pendingOperations().first(where: { $0.id == merged.id && $0.kind == PendingOperationKind.createDocument.rawValue }),
|
||||||
|
let createRequest = try? decoder.decode(CreateDocumentRequest.self, from: createOp.payload) {
|
||||||
|
let resolvedCreate = CreateDocumentRequest(
|
||||||
|
title: merged.title,
|
||||||
|
text: merged.text,
|
||||||
|
collectionId: createRequest.collectionId,
|
||||||
|
parentDocumentId: createRequest.parentDocumentId,
|
||||||
|
publish: createRequest.publish
|
||||||
|
)
|
||||||
|
await enqueue(.createDocument, payload: resolvedCreate, id: merged.id)
|
||||||
|
return merged
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fully resolved (not the original partial request) so replaying just
|
||||||
|
// this one queued operation reproduces `merged` exactly — that's what
|
||||||
|
// makes coalescing a second edit onto the same queued id safe.
|
||||||
|
let resolved = UpdateDocumentRequest(id: merged.id, title: merged.title, text: merged.text, fullWidth: merged.fullWidth)
|
||||||
|
await enqueue(.updateDocument, payload: resolved, id: "update-document-\(merged.id)")
|
||||||
|
return merged
|
||||||
|
}
|
||||||
|
|
||||||
|
private func queueCollectionUpdate(_ request: UpdateCollectionRequest, dueTo error: Error?) async throws -> OutlineCollection {
|
||||||
|
guard let baseData = await cache.load(forKey: "collection:\(request.id)"),
|
||||||
|
let base = try? decoder.decode(OutlineCollection.self, from: baseData) else {
|
||||||
|
throw error ?? OutlineAPIError.transport(URLError(.notConnectedToInternet))
|
||||||
|
}
|
||||||
|
let merged = OutlineCollection(
|
||||||
|
id: base.id,
|
||||||
|
name: request.name ?? base.name,
|
||||||
|
description: request.description ?? base.description,
|
||||||
|
color: base.color,
|
||||||
|
icon: base.icon,
|
||||||
|
createdAt: base.createdAt,
|
||||||
|
updatedAt: Date()
|
||||||
|
)
|
||||||
|
await cacheCollection(merged)
|
||||||
|
let resolved = UpdateCollectionRequest(id: merged.id, name: merged.name, description: merged.description)
|
||||||
|
await enqueue(.updateCollection, payload: resolved, id: "update-collection-\(merged.id)")
|
||||||
|
return merged
|
||||||
|
}
|
||||||
|
|
||||||
|
private func queuePinCreate(_ request: CreatePinRequest) async -> OutlinePin {
|
||||||
|
let pendingId = "pending-\(UUID().uuidString)"
|
||||||
|
await enqueue(.createPin, payload: request, id: pendingId)
|
||||||
|
return OutlinePin(id: pendingId, documentId: request.documentId, collectionId: request.collectionId, index: nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
private func queueSubscriptionCreate(_ request: CreateSubscriptionRequest) async -> OutlineSubscription {
|
||||||
|
let pendingId = "pending-\(UUID().uuidString)"
|
||||||
|
await enqueue(.createSubscription, payload: request, id: pendingId)
|
||||||
|
return OutlineSubscription(id: pendingId, documentId: request.documentId, collectionId: nil, event: request.event)
|
||||||
|
}
|
||||||
|
|
||||||
|
private func queueStarDocumentCreate(_ request: StarDocumentRequest) async -> OutlineStar {
|
||||||
|
let pendingId = "pending-\(UUID().uuidString)"
|
||||||
|
await enqueue(.starDocument, payload: request, id: pendingId)
|
||||||
|
return OutlineStar(id: pendingId, index: nil, documentId: request.documentId, collectionId: nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
private func queueStarCollectionCreate(_ request: StarCollectionRequest) async -> OutlineStar {
|
||||||
|
let pendingId = "pending-\(UUID().uuidString)"
|
||||||
|
await enqueue(.starCollection, payload: request, id: pendingId)
|
||||||
|
return OutlineStar(id: pendingId, index: nil, documentId: nil, collectionId: request.collectionId)
|
||||||
|
}
|
||||||
|
|
||||||
|
private func replay(_ operation: PendingOperation) async throws {
|
||||||
|
guard let kind = PendingOperationKind(rawValue: operation.kind) else {
|
||||||
|
throw OutlineAPIError.decoding(DecodingError.dataCorrupted(
|
||||||
|
DecodingError.Context(codingPath: [], debugDescription: "Unknown pending operation kind: \(operation.kind)")
|
||||||
|
))
|
||||||
|
}
|
||||||
|
switch kind {
|
||||||
|
case .createDocument:
|
||||||
|
let request = try decoder.decode(CreateDocumentRequest.self, from: operation.payload)
|
||||||
|
let result = try await live.createDocument(request)
|
||||||
|
await cacheDocument(result)
|
||||||
|
// The placeholder id (== operation.id) is now a dead orphan —
|
||||||
|
// nothing server-side will ever answer to it again.
|
||||||
|
await cache.removeCacheEntry(forKey: "document:\(operation.id)")
|
||||||
|
case .updateDocument:
|
||||||
|
let request = try decoder.decode(UpdateDocumentRequest.self, from: operation.payload)
|
||||||
|
let result = try await live.updateDocument(request)
|
||||||
|
await cacheDocument(result)
|
||||||
|
case .updateCollection:
|
||||||
|
let request = try decoder.decode(UpdateCollectionRequest.self, from: operation.payload)
|
||||||
|
let result = try await live.updateCollection(request)
|
||||||
|
await cacheCollection(result)
|
||||||
|
case .createPin:
|
||||||
|
let request = try decoder.decode(CreatePinRequest.self, from: operation.payload)
|
||||||
|
_ = try await live.createPin(request)
|
||||||
|
case .deletePin:
|
||||||
|
let request = try decoder.decode(IDPayload.self, from: operation.payload)
|
||||||
|
try await live.deletePin(id: request.id)
|
||||||
|
case .createSubscription:
|
||||||
|
let request = try decoder.decode(CreateSubscriptionRequest.self, from: operation.payload)
|
||||||
|
_ = try await live.createSubscription(request)
|
||||||
|
case .deleteSubscription:
|
||||||
|
let request = try decoder.decode(IDPayload.self, from: operation.payload)
|
||||||
|
try await live.deleteSubscription(id: request.id)
|
||||||
|
case .starDocument:
|
||||||
|
let request = try decoder.decode(StarDocumentRequest.self, from: operation.payload)
|
||||||
|
_ = try await live.starDocument(request)
|
||||||
|
case .deleteStar:
|
||||||
|
let request = try decoder.decode(IDPayload.self, from: operation.payload)
|
||||||
|
try await live.deleteStar(id: request.id)
|
||||||
|
case .starCollection:
|
||||||
|
let request = try decoder.decode(StarCollectionRequest.self, from: operation.payload)
|
||||||
|
_ = try await live.starCollection(request)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private func errorDescription(_ error: Error) -> String {
|
||||||
|
if let apiError = error as? OutlineAPIError {
|
||||||
|
switch apiError {
|
||||||
|
case .unauthorized: return "Sign-in expired."
|
||||||
|
case .notFound: return "Not found on the server."
|
||||||
|
case .server(let status, let message): return message ?? "Server error (\(status))."
|
||||||
|
case .decoding: return "Unexpected response shape."
|
||||||
|
case .transport: return "Couldn't reach the server."
|
||||||
|
case .tokenUnavailable: return "Couldn't access the saved sign-in."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return String(describing: error)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,104 @@
|
|||||||
|
import Foundation
|
||||||
|
import SwiftData
|
||||||
|
|
||||||
|
/// Read-through cache backing `CachingOutlineAPIClient` — stores whatever it
|
||||||
|
/// last fetched successfully, keyed by request shape, so browsing keeps
|
||||||
|
/// working (stale) once the network stops. Also owns the offline write
|
||||||
|
/// queue (`PendingOperation`) — same store, same actor, since both need
|
||||||
|
/// synchronized access to the same on-disk SwiftData container.
|
||||||
|
@ModelActor
|
||||||
|
public actor OfflineCacheStore {
|
||||||
|
public static func makeContainer(inMemory: Bool = false) throws -> ModelContainer {
|
||||||
|
let configuration = ModelConfiguration(isStoredInMemoryOnly: inMemory)
|
||||||
|
return try ModelContainer(for: CachedPayload.self, PendingOperation.self, configurations: configuration)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Read-through cache
|
||||||
|
|
||||||
|
public func save(_ data: Data, forKey key: String) {
|
||||||
|
let descriptor = FetchDescriptor<CachedPayload>(predicate: #Predicate { $0.key == key })
|
||||||
|
if let existing = try? modelContext.fetch(descriptor).first {
|
||||||
|
existing.payload = data
|
||||||
|
existing.cachedAt = Date()
|
||||||
|
} else {
|
||||||
|
modelContext.insert(CachedPayload(key: key, payload: data, cachedAt: Date()))
|
||||||
|
}
|
||||||
|
try? modelContext.save()
|
||||||
|
}
|
||||||
|
|
||||||
|
public func load(forKey key: String) -> Data? {
|
||||||
|
let descriptor = FetchDescriptor<CachedPayload>(predicate: #Predicate { $0.key == key })
|
||||||
|
return try? modelContext.fetch(descriptor).first?.payload
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Used to drop a temporary `pending-*` document's cache entry once a
|
||||||
|
/// queued create syncs and the server hands back the real id — the
|
||||||
|
/// placeholder key would otherwise sit around as a dead orphan forever.
|
||||||
|
public func removeCacheEntry(forKey key: String) {
|
||||||
|
let descriptor = FetchDescriptor<CachedPayload>(predicate: #Predicate { $0.key == key })
|
||||||
|
guard let existing = try? modelContext.fetch(descriptor).first else { return }
|
||||||
|
modelContext.delete(existing)
|
||||||
|
try? modelContext.save()
|
||||||
|
}
|
||||||
|
|
||||||
|
public func itemCount() -> Int {
|
||||||
|
(try? modelContext.fetchCount(FetchDescriptor<CachedPayload>())) ?? 0
|
||||||
|
}
|
||||||
|
|
||||||
|
public func totalBytes() -> Int {
|
||||||
|
let descriptor = FetchDescriptor<CachedPayload>()
|
||||||
|
let rows = (try? modelContext.fetch(descriptor)) ?? []
|
||||||
|
return rows.reduce(0) { $0 + $1.payload.count }
|
||||||
|
}
|
||||||
|
|
||||||
|
public func clearAll() {
|
||||||
|
let descriptor = FetchDescriptor<CachedPayload>()
|
||||||
|
guard let rows = try? modelContext.fetch(descriptor) else { return }
|
||||||
|
rows.forEach { modelContext.delete($0) }
|
||||||
|
try? modelContext.save()
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Offline write queue
|
||||||
|
|
||||||
|
/// Upserts by `id` — a second call with the same id (an edit coalescing
|
||||||
|
/// onto a still-unsynced edit, or a create being cancelled by its own
|
||||||
|
/// synthesized id) replaces the row in place rather than piling up.
|
||||||
|
public func enqueueOperation(id: String, kind: String, payload: Data) {
|
||||||
|
let descriptor = FetchDescriptor<PendingOperation>(predicate: #Predicate { $0.id == id })
|
||||||
|
if let existing = try? modelContext.fetch(descriptor).first {
|
||||||
|
existing.kind = kind
|
||||||
|
existing.payload = payload
|
||||||
|
existing.lastError = nil
|
||||||
|
existing.attemptCount = 0
|
||||||
|
} else {
|
||||||
|
modelContext.insert(PendingOperation(id: id, kind: kind, payload: payload, createdAt: Date()))
|
||||||
|
}
|
||||||
|
try? modelContext.save()
|
||||||
|
}
|
||||||
|
|
||||||
|
public func pendingOperations() -> [PendingOperation] {
|
||||||
|
let descriptor = FetchDescriptor<PendingOperation>(sortBy: [SortDescriptor(\.createdAt)])
|
||||||
|
return (try? modelContext.fetch(descriptor)) ?? []
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns whether a matching operation was actually found and removed —
|
||||||
|
/// callers use this to detect "this targeted something that never made
|
||||||
|
/// it to the server in the first place" and skip queuing a delete.
|
||||||
|
@discardableResult
|
||||||
|
public func removeOperation(id: String) -> Bool {
|
||||||
|
let descriptor = FetchDescriptor<PendingOperation>(predicate: #Predicate { $0.id == id })
|
||||||
|
guard let existing = try? modelContext.fetch(descriptor).first else { return false }
|
||||||
|
modelContext.delete(existing)
|
||||||
|
try? modelContext.save()
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
public func recordFailure(id: String, error: String) {
|
||||||
|
let descriptor = FetchDescriptor<PendingOperation>(predicate: #Predicate { $0.id == id })
|
||||||
|
guard let existing = try? modelContext.fetch(descriptor).first else { return }
|
||||||
|
existing.lastAttemptAt = Date()
|
||||||
|
existing.lastError = error
|
||||||
|
existing.attemptCount += 1
|
||||||
|
try? modelContext.save()
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
import Foundation
|
||||||
|
import SwiftData
|
||||||
|
|
||||||
|
/// A queued mutation made while offline, waiting to replay against the live
|
||||||
|
/// server. `id` is deliberately overloaded: for actions that create a new
|
||||||
|
/// server-side record (pin, star, subscription), it's also the synthesized
|
||||||
|
/// placeholder id handed back to the caller immediately — so a matching
|
||||||
|
/// delete queued before that create ever syncs can cancel both out by id
|
||||||
|
/// instead of hitting a server that's never heard of the placeholder. For
|
||||||
|
/// actions that edit an existing record (document/collection updates), it's
|
||||||
|
/// deterministic per target id, so a second edit before the first syncs
|
||||||
|
/// coalesces into one queued operation instead of piling up.
|
||||||
|
@Model
|
||||||
|
public final class PendingOperation {
|
||||||
|
@Attribute(.unique) public var id: String
|
||||||
|
public var kind: String
|
||||||
|
public var payload: Data
|
||||||
|
public var createdAt: Date
|
||||||
|
public var lastAttemptAt: Date?
|
||||||
|
public var lastError: String?
|
||||||
|
public var attemptCount: Int
|
||||||
|
|
||||||
|
public init(
|
||||||
|
id: String,
|
||||||
|
kind: String,
|
||||||
|
payload: Data,
|
||||||
|
createdAt: Date,
|
||||||
|
lastAttemptAt: Date? = nil,
|
||||||
|
lastError: String? = nil,
|
||||||
|
attemptCount: Int = 0
|
||||||
|
) {
|
||||||
|
self.id = id
|
||||||
|
self.kind = kind
|
||||||
|
self.payload = payload
|
||||||
|
self.createdAt = createdAt
|
||||||
|
self.lastAttemptAt = lastAttemptAt
|
||||||
|
self.lastError = lastError
|
||||||
|
self.attemptCount = attemptCount
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// UI-facing snapshot of a queued offline mutation — deliberately not the
|
||||||
|
/// `@Model` type itself, so Settings can display it without holding a
|
||||||
|
/// reference into the SwiftData store.
|
||||||
|
public struct PendingOperationSummary: Identifiable, Sendable {
|
||||||
|
public let id: String
|
||||||
|
public let kind: String
|
||||||
|
public let createdAt: Date
|
||||||
|
public let attemptCount: Int
|
||||||
|
public let lastError: String?
|
||||||
|
}
|
||||||
|
|
||||||
|
public struct CacheStorageSummary: Sendable {
|
||||||
|
public let itemCount: Int
|
||||||
|
public let totalBytes: Int
|
||||||
|
}
|
||||||
|
|
||||||
|
public struct SyncFlushSummary: Sendable {
|
||||||
|
public let succeeded: Int
|
||||||
|
public let failed: Int
|
||||||
|
}
|
||||||
|
|
||||||
|
public struct FullSyncSummary: Sendable {
|
||||||
|
public let collectionsCount: Int
|
||||||
|
public let documentsCount: Int
|
||||||
|
public let errors: [String]
|
||||||
|
public let finishedAt: Date
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Every mutation `CachingOutlineAPIClient` knows how to queue offline and
|
||||||
|
/// replay later. Deliberately a small, explicit set — see its doc comment
|
||||||
|
/// for what's excluded and why.
|
||||||
|
enum PendingOperationKind: String, Codable, Sendable {
|
||||||
|
case createDocument
|
||||||
|
case updateDocument
|
||||||
|
case updateCollection
|
||||||
|
case createPin
|
||||||
|
case deletePin
|
||||||
|
case createSubscription
|
||||||
|
case deleteSubscription
|
||||||
|
case starDocument
|
||||||
|
case deleteStar
|
||||||
|
case starCollection
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Shared payload shape for the delete-by-id queueable operations.
|
||||||
|
struct IDPayload: Codable, Sendable {
|
||||||
|
let id: String
|
||||||
|
}
|
||||||
@@ -69,4 +69,40 @@ public protocol OutlineAPIClient: Sendable {
|
|||||||
func deleteStar(id: String) async throws
|
func deleteStar(id: String) async throws
|
||||||
|
|
||||||
func currentUser() async throws -> OutlineUser
|
func currentUser() async throws -> OutlineUser
|
||||||
|
|
||||||
|
/// Two-step presigned upload: this requests where/how to upload,
|
||||||
|
/// `uploadAttachmentFile` performs the actual multipart POST to that
|
||||||
|
/// target. See `OutlineAttachment`/`CreateAttachmentResult`.
|
||||||
|
func createAttachment(_ request: CreateAttachmentRequest) async throws -> CreateAttachmentResult
|
||||||
|
func uploadAttachmentFile(_ result: CreateAttachmentResult, fileData: Data) async throws
|
||||||
|
/// Best-effort — matches the shape every other simple `id`-only delete
|
||||||
|
/// in this API uses (`pins.delete`, `stars.delete`, …), not confirmed
|
||||||
|
/// against a live server specifically for attachments yet.
|
||||||
|
func deleteAttachment(id: String) async throws
|
||||||
|
/// `users.update`, avatar only. See `UpdateUserAvatarRequest`.
|
||||||
|
func updateUserAvatar(_ request: UpdateUserAvatarRequest) async throws -> OutlineUser
|
||||||
|
/// `users.update`, name only. See `UpdateUserNameRequest`.
|
||||||
|
func updateUserName(_ request: UpdateUserNameRequest) async throws -> OutlineUser
|
||||||
|
/// `users.update`, language only. See `UpdateUserLanguageRequest`.
|
||||||
|
func updateUserLanguage(_ request: UpdateUserLanguageRequest) async throws -> OutlineUser
|
||||||
|
/// `users.update`, preferences only. See `UpdateUserPreferencesRequest`.
|
||||||
|
func updateUserPreferences(_ request: UpdateUserPreferencesRequest) async throws -> OutlineUser
|
||||||
|
/// Backed by `users.delete` — self-service account deletion, no
|
||||||
|
/// confirmation code param confirmed live, matches every other simple
|
||||||
|
/// no-body delete in this API.
|
||||||
|
func deleteAccount() async throws
|
||||||
|
/// `nil` targets every notification event. See `NotificationEventType`.
|
||||||
|
func subscribeToNotifications(eventType: NotificationEventType?) async throws -> OutlineUser
|
||||||
|
func unsubscribeFromNotifications(eventType: NotificationEventType?) async throws -> OutlineUser
|
||||||
|
|
||||||
|
/// Settings → API & Access.
|
||||||
|
func listApiKeys(_ request: ListApiKeysRequest) async throws -> [OutlineAPIKey]
|
||||||
|
/// The returned `OutlineAPIKey.value` is the only time the full
|
||||||
|
/// plaintext key is ever available — the caller is responsible for
|
||||||
|
/// displaying it once and then discarding it.
|
||||||
|
func createApiKey(_ request: CreateApiKeyRequest) async throws -> OutlineAPIKey
|
||||||
|
func deleteApiKey(id: String) async throws
|
||||||
|
|
||||||
|
/// Settings → Installation. Self-hosted server version info.
|
||||||
|
func installationInfo() async throws -> OutlineInstallationInfo
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -229,6 +229,103 @@ public actor LiveOutlineAPIClient: OutlineAPIClient {
|
|||||||
try await post("users.info", body: EmptyParams())
|
try await post("users.info", body: EmptyParams())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public func createAttachment(_ request: CreateAttachmentRequest) async throws -> CreateAttachmentResult {
|
||||||
|
try await post("attachments.create", body: request)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// No Bearer/CSRF header attached here, deliberately — the presigned
|
||||||
|
/// `form.sig` field (short-lived, scoped to this exact upload key) is
|
||||||
|
/// what authorizes this specific request, the same way an S3 presigned
|
||||||
|
/// POST works. Best-effort against a live server: if it turns out the
|
||||||
|
/// self-hosted local-storage backend also wants a bearer token here,
|
||||||
|
/// that's a one-line addition once confirmed, not a design change.
|
||||||
|
public func uploadAttachmentFile(_ result: CreateAttachmentResult, fileData: Data) async throws {
|
||||||
|
let (body, contentType) = MultipartFormDataBuilder.build(
|
||||||
|
fields: result.form,
|
||||||
|
fileFieldName: "file",
|
||||||
|
fileName: result.attachment.name ?? "avatar",
|
||||||
|
fileData: fileData,
|
||||||
|
fileContentType: result.form["Content-Type"] ?? "application/octet-stream"
|
||||||
|
)
|
||||||
|
|
||||||
|
// `uploadUrl` is a host-relative path (e.g. "/api/files.create") on
|
||||||
|
// a self-hosted local-storage backend, not an absolute S3 URL —
|
||||||
|
// resolving against `baseURL` handles both: `URL(string:relativeTo:)`
|
||||||
|
// replaces the whole path for a leading-slash relative string per
|
||||||
|
// RFC 3986, same resolution already used for user/team avatar URLs.
|
||||||
|
guard let uploadURL = URL(string: result.uploadUrl, relativeTo: baseURL)?.absoluteURL else {
|
||||||
|
throw OutlineAPIError.transport(URLError(.badURL))
|
||||||
|
}
|
||||||
|
|
||||||
|
var request = URLRequest(url: uploadURL)
|
||||||
|
request.httpMethod = "POST"
|
||||||
|
request.setValue(contentType, forHTTPHeaderField: "Content-Type")
|
||||||
|
request.httpBody = body
|
||||||
|
|
||||||
|
let data: Data
|
||||||
|
let response: HTTPURLResponse
|
||||||
|
do {
|
||||||
|
(data, response) = try await httpClient.send(request)
|
||||||
|
} catch let error as OutlineAPIError {
|
||||||
|
throw error
|
||||||
|
} catch {
|
||||||
|
throw OutlineAPIError.transport(error)
|
||||||
|
}
|
||||||
|
|
||||||
|
guard (200...299).contains(response.statusCode) else {
|
||||||
|
let errorEnvelope = try? decoder.decode(OutlineErrorEnvelope.self, from: data)
|
||||||
|
throw OutlineAPIError.server(status: response.statusCode, message: errorEnvelope?.message ?? errorEnvelope?.error)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deleteAttachment(id: String) async throws {
|
||||||
|
try await postForSuccess("attachments.delete", body: StarIDParams(id: id))
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateUserAvatar(_ request: UpdateUserAvatarRequest) async throws -> OutlineUser {
|
||||||
|
try await post("users.update", body: request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateUserName(_ request: UpdateUserNameRequest) async throws -> OutlineUser {
|
||||||
|
try await post("users.update", body: request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateUserLanguage(_ request: UpdateUserLanguageRequest) async throws -> OutlineUser {
|
||||||
|
try await post("users.update", body: request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func updateUserPreferences(_ request: UpdateUserPreferencesRequest) async throws -> OutlineUser {
|
||||||
|
try await post("users.update", body: request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deleteAccount() async throws {
|
||||||
|
try await postForSuccess("users.delete", body: EmptyParams())
|
||||||
|
}
|
||||||
|
|
||||||
|
public func subscribeToNotifications(eventType: NotificationEventType?) async throws -> OutlineUser {
|
||||||
|
try await post("users.notificationsSubscribe", body: NotificationSubscriptionRequest(eventType: eventType?.rawValue))
|
||||||
|
}
|
||||||
|
|
||||||
|
public func unsubscribeFromNotifications(eventType: NotificationEventType?) async throws -> OutlineUser {
|
||||||
|
try await post("users.notificationsUnsubscribe", body: NotificationSubscriptionRequest(eventType: eventType?.rawValue))
|
||||||
|
}
|
||||||
|
|
||||||
|
public func listApiKeys(_ request: ListApiKeysRequest) async throws -> [OutlineAPIKey] {
|
||||||
|
try await post("apiKeys.list", body: request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func createApiKey(_ request: CreateApiKeyRequest) async throws -> OutlineAPIKey {
|
||||||
|
try await post("apiKeys.create", body: request)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func deleteApiKey(id: String) async throws {
|
||||||
|
try await postForSuccess("apiKeys.delete", body: StarIDParams(id: id))
|
||||||
|
}
|
||||||
|
|
||||||
|
public func installationInfo() async throws -> OutlineInstallationInfo {
|
||||||
|
try await post("installation.info", body: EmptyParams())
|
||||||
|
}
|
||||||
|
|
||||||
private func post<Body: Encodable, Response: Decodable>(_ path: String, body: Body) async throws -> Response {
|
private func post<Body: Encodable, Response: Decodable>(_ path: String, body: Body) async throws -> Response {
|
||||||
guard let token = try? tokenStore.token() else {
|
guard let token = try? tokenStore.token() else {
|
||||||
throw OutlineAPIError.tokenUnavailable
|
throw OutlineAPIError.tokenUnavailable
|
||||||
|
|||||||
@@ -0,0 +1,28 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// The subset of Outline's notification event types this app exposes a
|
||||||
|
/// toggle for. Wire values confirmed live (captured `users.update`
|
||||||
|
/// responses showing the full `notificationSettings` dictionary after
|
||||||
|
/// toggling each one in Outline's own web app). The server tracks more
|
||||||
|
/// event types than this app has UI for (`revisions.create`,
|
||||||
|
/// `emails.onboarding`, `emails.features` were also seen live) — those are
|
||||||
|
/// left alone since `users.notificationsSubscribe`/`Unsubscribe` are
|
||||||
|
/// per-event, not a whole-object replace like `preferences`, so there's no
|
||||||
|
/// clobbering risk in only covering a subset.
|
||||||
|
public enum NotificationEventType: String, CaseIterable, Sendable {
|
||||||
|
case documentPublish = "documents.publish"
|
||||||
|
case documentUpdate = "documents.update"
|
||||||
|
case commentCreate = "comments.create"
|
||||||
|
case commentMentioned = "comments.mentioned"
|
||||||
|
case documentMentioned = "documents.mentioned"
|
||||||
|
case commentGroupMentioned = "comments.group_mentioned"
|
||||||
|
case documentGroupMentioned = "documents.group_mentioned"
|
||||||
|
case commentResolve = "comments.resolve"
|
||||||
|
case reactionCreate = "reactions.create"
|
||||||
|
case collectionCreate = "collections.create"
|
||||||
|
case emailsInviteAccepted = "emails.invite_accepted"
|
||||||
|
case documentAddUser = "documents.add_user"
|
||||||
|
case collectionAddUser = "collections.add_user"
|
||||||
|
case emailsExportCompleted = "emails.export_completed"
|
||||||
|
case accessRequestCreate = "access_requests.create"
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// A personal API key (Settings → API & Access). Only the last 4 characters
|
||||||
|
/// of the actual token are ever returned by the server — there's no way to
|
||||||
|
/// see a full key again after creation, matching every other API-key UI
|
||||||
|
/// convention.
|
||||||
|
public struct OutlineAPIKey: Codable, Identifiable, Hashable, Sendable {
|
||||||
|
public let id: String
|
||||||
|
public let name: String
|
||||||
|
public let last4: String?
|
||||||
|
public let scope: [String]?
|
||||||
|
public let createdAt: Date
|
||||||
|
public let expiresAt: Date?
|
||||||
|
public let lastActiveAt: Date?
|
||||||
|
/// The full plaintext key — present *only* in `apiKeys.create`'s
|
||||||
|
/// response, confirmed live: `apiKeys.list` never includes it, matching
|
||||||
|
/// "shown once at creation" being enforced server-side, not just a
|
||||||
|
/// client-side UI convention this app has to uphold on its own.
|
||||||
|
public let value: String?
|
||||||
|
|
||||||
|
public init(
|
||||||
|
id: String,
|
||||||
|
name: String,
|
||||||
|
last4: String? = nil,
|
||||||
|
scope: [String]? = nil,
|
||||||
|
createdAt: Date,
|
||||||
|
expiresAt: Date? = nil,
|
||||||
|
lastActiveAt: Date? = nil,
|
||||||
|
value: String? = nil
|
||||||
|
) {
|
||||||
|
self.id = id
|
||||||
|
self.name = name
|
||||||
|
self.last4 = last4
|
||||||
|
self.scope = scope
|
||||||
|
self.createdAt = createdAt
|
||||||
|
self.expiresAt = expiresAt
|
||||||
|
self.lastActiveAt = lastActiveAt
|
||||||
|
self.value = value
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// One uploaded file — created via a two-step presigned upload
|
||||||
|
/// (`attachments.create` for the upload target, then a direct POST to
|
||||||
|
/// `uploadUrl`/`form`). Confirmed live against a self-hosted instance's
|
||||||
|
/// local-storage backend; `size` comes back as a string there, not a
|
||||||
|
/// number — same "don't trust the vendored spec's implied types" lesson as
|
||||||
|
/// everywhere else this codebase has hit it.
|
||||||
|
public struct OutlineAttachment: Decodable, Identifiable, Sendable {
|
||||||
|
public let id: String
|
||||||
|
public let documentId: String?
|
||||||
|
public let contentType: String?
|
||||||
|
public let name: String?
|
||||||
|
public let url: String?
|
||||||
|
public let size: String?
|
||||||
|
}
|
||||||
|
|
||||||
|
/// `attachments.create`'s response — everything needed to perform the
|
||||||
|
/// actual upload. `form` fields (Content-Type, key, acl, sig, `_csrf`, …)
|
||||||
|
/// must all be included as their own multipart parts, in the same request
|
||||||
|
/// as the file itself, POSTed to `uploadUrl`.
|
||||||
|
public struct CreateAttachmentResult: Decodable, Sendable {
|
||||||
|
public let attachment: OutlineAttachment
|
||||||
|
public let uploadUrl: String
|
||||||
|
public let form: [String: String]
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// `installation.info` — the self-hosted server's own version, confirmed
|
||||||
|
/// live. `policies` (a separate top-level array alongside `data` in the raw
|
||||||
|
/// response) isn't modeled here — not used by this app's Installation
|
||||||
|
/// settings page.
|
||||||
|
public struct OutlineInstallationInfo: Decodable, Sendable {
|
||||||
|
public let version: String
|
||||||
|
public let latestVersion: String
|
||||||
|
public let versionsBehind: Int
|
||||||
|
}
|
||||||
@@ -6,18 +6,30 @@ public struct OutlineUser: Codable, Identifiable, Hashable, Sendable {
|
|||||||
public let email: String?
|
public let email: String?
|
||||||
public let avatarUrl: String?
|
public let avatarUrl: String?
|
||||||
public let role: String?
|
public let role: String?
|
||||||
|
public let language: String?
|
||||||
|
public let preferences: OutlineUserPreferences?
|
||||||
|
/// Keyed by `NotificationEventType`'s raw values, plus event types this
|
||||||
|
/// app has no UI for — kept as a flexible dictionary rather than a
|
||||||
|
/// fixed struct for that reason. `true` means subscribed.
|
||||||
|
public let notificationSettings: [String: Bool]?
|
||||||
|
|
||||||
public init(
|
public init(
|
||||||
id: String,
|
id: String,
|
||||||
name: String,
|
name: String,
|
||||||
email: String? = nil,
|
email: String? = nil,
|
||||||
avatarUrl: String? = nil,
|
avatarUrl: String? = nil,
|
||||||
role: String? = nil
|
role: String? = nil,
|
||||||
|
language: String? = nil,
|
||||||
|
preferences: OutlineUserPreferences? = nil,
|
||||||
|
notificationSettings: [String: Bool]? = nil
|
||||||
) {
|
) {
|
||||||
self.id = id
|
self.id = id
|
||||||
self.name = name
|
self.name = name
|
||||||
self.email = email
|
self.email = email
|
||||||
self.avatarUrl = avatarUrl
|
self.avatarUrl = avatarUrl
|
||||||
self.role = role
|
self.role = role
|
||||||
|
self.language = language
|
||||||
|
self.preferences = preferences
|
||||||
|
self.notificationSettings = notificationSettings
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,109 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// `User.preferences` — a free-form JSON blob on Outline's own `User` row,
|
||||||
|
/// not a fixed-shape API resource. Wire key names below are confirmed
|
||||||
|
/// against a live server's own web app traffic (captured toggling every
|
||||||
|
/// Preferences setting one at a time), not guessed — see the `CodingKeys`
|
||||||
|
/// mapping for the two that don't match this struct's own property names.
|
||||||
|
///
|
||||||
|
/// The server also validates `preferences` against a known key allowlist
|
||||||
|
/// and rejects the whole `users.update` call (not just the bad field) if
|
||||||
|
/// any key it doesn't recognize is present — confirmed live via a
|
||||||
|
/// `"notificationBadge: Invalid Input"` error when an earlier, wrong value
|
||||||
|
/// was sent. That's also why `fullWidthDocuments` is kept here even though
|
||||||
|
/// this app has no UI for it yet: this app always sends the *whole*
|
||||||
|
/// preferences object back on every save (see
|
||||||
|
/// `UpdateUserPreferencesRequest`), so silently dropping an unknown key
|
||||||
|
/// during decode would permanently clear it the next time any other
|
||||||
|
/// preference here gets saved.
|
||||||
|
public struct OutlineUserPreferences: Codable, Hashable, Sendable {
|
||||||
|
public var rememberLastPath: Bool?
|
||||||
|
/// App-facing polarity: `true` means "separate editing mode is on" —
|
||||||
|
/// the opposite of the wire's own `seamlessEdit` (seamless editing and
|
||||||
|
/// separate editing modes are each other's negation), inverted in
|
||||||
|
/// `init(from:)`/`encode(to:)` so nothing outside this file has to
|
||||||
|
/// remember that.
|
||||||
|
public var separateEditing: Bool?
|
||||||
|
public var useCursorPointer: Bool?
|
||||||
|
public var codeBlockLineNumbers: Bool?
|
||||||
|
public var showCommentMarker: Bool?
|
||||||
|
public var smartText: Bool?
|
||||||
|
/// One of `NotificationBadgeStyle`'s raw values.
|
||||||
|
public var notificationBadge: String?
|
||||||
|
/// No UI in this app yet — preserved purely so saving any other
|
||||||
|
/// preference here doesn't clobber it. See the type doc comment.
|
||||||
|
public var fullWidthDocuments: Bool?
|
||||||
|
|
||||||
|
public init(
|
||||||
|
rememberLastPath: Bool? = nil,
|
||||||
|
separateEditing: Bool? = nil,
|
||||||
|
useCursorPointer: Bool? = nil,
|
||||||
|
codeBlockLineNumbers: Bool? = nil,
|
||||||
|
showCommentMarker: Bool? = nil,
|
||||||
|
smartText: Bool? = nil,
|
||||||
|
notificationBadge: String? = nil,
|
||||||
|
fullWidthDocuments: Bool? = nil
|
||||||
|
) {
|
||||||
|
self.rememberLastPath = rememberLastPath
|
||||||
|
self.separateEditing = separateEditing
|
||||||
|
self.useCursorPointer = useCursorPointer
|
||||||
|
self.codeBlockLineNumbers = codeBlockLineNumbers
|
||||||
|
self.showCommentMarker = showCommentMarker
|
||||||
|
self.smartText = smartText
|
||||||
|
self.notificationBadge = notificationBadge
|
||||||
|
self.fullWidthDocuments = fullWidthDocuments
|
||||||
|
}
|
||||||
|
|
||||||
|
private enum CodingKeys: String, CodingKey {
|
||||||
|
case rememberLastPath
|
||||||
|
case seamlessEdit
|
||||||
|
case useCursorPointer
|
||||||
|
case codeBlockLineNumbers
|
||||||
|
case commentsInGutter
|
||||||
|
case enableSmartText
|
||||||
|
case notificationBadge
|
||||||
|
case fullWidthDocuments
|
||||||
|
}
|
||||||
|
|
||||||
|
public init(from decoder: Decoder) throws {
|
||||||
|
let container = try decoder.container(keyedBy: CodingKeys.self)
|
||||||
|
rememberLastPath = try container.decodeIfPresent(Bool.self, forKey: .rememberLastPath)
|
||||||
|
separateEditing = try container.decodeIfPresent(Bool.self, forKey: .seamlessEdit).map { !$0 }
|
||||||
|
useCursorPointer = try container.decodeIfPresent(Bool.self, forKey: .useCursorPointer)
|
||||||
|
codeBlockLineNumbers = try container.decodeIfPresent(Bool.self, forKey: .codeBlockLineNumbers)
|
||||||
|
showCommentMarker = try container.decodeIfPresent(Bool.self, forKey: .commentsInGutter)
|
||||||
|
smartText = try container.decodeIfPresent(Bool.self, forKey: .enableSmartText)
|
||||||
|
notificationBadge = try container.decodeIfPresent(String.self, forKey: .notificationBadge)
|
||||||
|
fullWidthDocuments = try container.decodeIfPresent(Bool.self, forKey: .fullWidthDocuments)
|
||||||
|
}
|
||||||
|
|
||||||
|
public func encode(to encoder: Encoder) throws {
|
||||||
|
var container = encoder.container(keyedBy: CodingKeys.self)
|
||||||
|
try container.encodeIfPresent(rememberLastPath, forKey: .rememberLastPath)
|
||||||
|
try container.encodeIfPresent(separateEditing.map { !$0 }, forKey: .seamlessEdit)
|
||||||
|
try container.encodeIfPresent(useCursorPointer, forKey: .useCursorPointer)
|
||||||
|
try container.encodeIfPresent(codeBlockLineNumbers, forKey: .codeBlockLineNumbers)
|
||||||
|
try container.encodeIfPresent(showCommentMarker, forKey: .commentsInGutter)
|
||||||
|
try container.encodeIfPresent(smartText, forKey: .enableSmartText)
|
||||||
|
try container.encodeIfPresent(notificationBadge, forKey: .notificationBadge)
|
||||||
|
try container.encodeIfPresent(fullWidthDocuments, forKey: .fullWidthDocuments)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// App-icon unread indicator style. Wire values confirmed live (captured
|
||||||
|
/// setting all three from Outline's own web app).
|
||||||
|
public enum NotificationBadgeStyle: String, CaseIterable, Identifiable, Sendable {
|
||||||
|
case none = "disabled"
|
||||||
|
case unreadIndicator = "indicator"
|
||||||
|
case unreadCount = "count"
|
||||||
|
|
||||||
|
public var id: String { rawValue }
|
||||||
|
|
||||||
|
public var label: String {
|
||||||
|
switch self {
|
||||||
|
case .none: return "None"
|
||||||
|
case .unreadIndicator: return "Unread Indicator"
|
||||||
|
case .unreadCount: return "Unread Count"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// Builds the multipart/form-data body for Outline's presigned-upload
|
||||||
|
/// targets (`attachments.create`'s `uploadUrl`/`form`) — an S3-style
|
||||||
|
/// presigned POST: every `form` field has to ride along as its own part in
|
||||||
|
/// the same request as the file, not as query params or headers.
|
||||||
|
enum MultipartFormDataBuilder {
|
||||||
|
static func build(
|
||||||
|
fields: [String: String],
|
||||||
|
fileFieldName: String,
|
||||||
|
fileName: String,
|
||||||
|
fileData: Data,
|
||||||
|
fileContentType: String,
|
||||||
|
boundary: String = "Boundary-\(UUID().uuidString)"
|
||||||
|
) -> (body: Data, contentType: String) {
|
||||||
|
var body = Data()
|
||||||
|
|
||||||
|
for (key, value) in fields {
|
||||||
|
body.append("--\(boundary)\r\n".utf8Data)
|
||||||
|
body.append("Content-Disposition: form-data; name=\"\(key)\"\r\n\r\n".utf8Data)
|
||||||
|
body.append(value.utf8Data)
|
||||||
|
body.append("\r\n".utf8Data)
|
||||||
|
}
|
||||||
|
|
||||||
|
body.append("--\(boundary)\r\n".utf8Data)
|
||||||
|
body.append(
|
||||||
|
"Content-Disposition: form-data; name=\"\(fileFieldName)\"; filename=\"\(fileName)\"\r\n".utf8Data
|
||||||
|
)
|
||||||
|
body.append("Content-Type: \(fileContentType)\r\n\r\n".utf8Data)
|
||||||
|
body.append(fileData)
|
||||||
|
body.append("\r\n".utf8Data)
|
||||||
|
body.append("--\(boundary)--\r\n".utf8Data)
|
||||||
|
|
||||||
|
return (body, "multipart/form-data; boundary=\(boundary)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private extension String {
|
||||||
|
var utf8Data: Data { Data(utf8) }
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// `apiKeys.create`. `expiresAt: nil` (the key omitted entirely, not sent as
|
||||||
|
/// literal `null`) confirmed live to mean no expiration — Swift's
|
||||||
|
/// synthesized `Encodable` already omits `nil` optionals via
|
||||||
|
/// `encodeIfPresent`, so no custom `encode(to:)` is needed here the way
|
||||||
|
/// `UpdateUserAvatarRequest` needed one for the opposite case.
|
||||||
|
public struct CreateApiKeyRequest: Encodable, Sendable {
|
||||||
|
public let name: String
|
||||||
|
public let expiresAt: Date?
|
||||||
|
/// `nil`/omitted grants full access — confirmed live (every key created
|
||||||
|
/// without a scope came back with unrestricted access). A specific
|
||||||
|
/// scope is a list of allowed API paths, e.g. `["/api/documents.info"]`.
|
||||||
|
public let scope: [String]?
|
||||||
|
|
||||||
|
public init(name: String, expiresAt: Date? = nil, scope: [String]? = nil) {
|
||||||
|
self.name = name
|
||||||
|
self.expiresAt = expiresAt
|
||||||
|
self.scope = scope
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// Requests an upload target for a new file — not the upload itself, see
|
||||||
|
/// `OutlineAPIClient.uploadAttachmentFile`. `documentId: nil` is what a
|
||||||
|
/// user-avatar upload sends (confirmed live); a real value scopes the
|
||||||
|
/// attachment to a document instead (e.g. an inline image embed).
|
||||||
|
public struct CreateAttachmentRequest: Encodable, Sendable {
|
||||||
|
public let name: String
|
||||||
|
public let contentType: String
|
||||||
|
public let size: Int
|
||||||
|
public let documentId: String?
|
||||||
|
|
||||||
|
public init(name: String, contentType: String, size: Int, documentId: String? = nil) {
|
||||||
|
self.name = name
|
||||||
|
self.contentType = contentType
|
||||||
|
self.size = size
|
||||||
|
self.documentId = documentId
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
import Foundation
|
import Foundation
|
||||||
|
|
||||||
public struct CreateDocumentRequest: Encodable, Sendable {
|
public struct CreateDocumentRequest: Codable, Sendable {
|
||||||
public let title: String
|
public let title: String
|
||||||
public let text: String
|
public let text: String
|
||||||
public let collectionId: String
|
public let collectionId: String
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ import Foundation
|
|||||||
|
|
||||||
/// See `OutlinePin`. `collectionId: nil` = "Pin to Home", non-nil = "Pin to
|
/// See `OutlinePin`. `collectionId: nil` = "Pin to Home", non-nil = "Pin to
|
||||||
/// Collection" — these are distinct actions on the real server.
|
/// Collection" — these are distinct actions on the real server.
|
||||||
public struct CreatePinRequest: Encodable, Sendable {
|
public struct CreatePinRequest: Codable, Sendable {
|
||||||
public let documentId: String
|
public let documentId: String
|
||||||
public let collectionId: String?
|
public let collectionId: String?
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import Foundation
|
import Foundation
|
||||||
|
|
||||||
/// See `OutlineSubscription` — best-effort shape, not in the vendored spec.
|
/// See `OutlineSubscription` — best-effort shape, not in the vendored spec.
|
||||||
public struct CreateSubscriptionRequest: Encodable, Sendable {
|
public struct CreateSubscriptionRequest: Codable, Sendable {
|
||||||
public let documentId: String
|
public let documentId: String
|
||||||
public let event: String
|
public let event: String
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,14 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// `apiKeys.list` — matches every other paginated `.list` endpoint's flat
|
||||||
|
/// offset/limit convention (e.g. `ListSharesRequest`), not the nested
|
||||||
|
/// `pagination` object that only appears in list *responses*.
|
||||||
|
public struct ListApiKeysRequest: Encodable, Sendable {
|
||||||
|
public let offset: Int
|
||||||
|
public let limit: Int
|
||||||
|
|
||||||
|
public init(offset: Int = 0, limit: Int = 25) {
|
||||||
|
self.offset = offset
|
||||||
|
self.limit = limit
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// `users.notificationsSubscribe` / `users.notificationsUnsubscribe`. A
|
||||||
|
/// `nil` `eventType` targets every notification event at once — confirmed
|
||||||
|
/// live via Outline's own "All notifications" master toggle, which sends
|
||||||
|
/// no `eventType` at all.
|
||||||
|
public struct NotificationSubscriptionRequest: Encodable, Sendable {
|
||||||
|
public let eventType: String?
|
||||||
|
|
||||||
|
public init(eventType: String? = nil) {
|
||||||
|
self.eventType = eventType
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
import Foundation
|
import Foundation
|
||||||
|
|
||||||
public struct StarCollectionRequest: Encodable, Sendable {
|
public struct StarCollectionRequest: Codable, Sendable {
|
||||||
public let collectionId: String
|
public let collectionId: String
|
||||||
|
|
||||||
public init(collectionId: String) {
|
public init(collectionId: String) {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import Foundation
|
import Foundation
|
||||||
|
|
||||||
public struct StarDocumentRequest: Encodable, Sendable {
|
public struct StarDocumentRequest: Codable, Sendable {
|
||||||
public let documentId: String
|
public let documentId: String
|
||||||
|
|
||||||
public init(documentId: String) {
|
public init(documentId: String) {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import Foundation
|
import Foundation
|
||||||
|
|
||||||
public struct UpdateCollectionRequest: Encodable, Sendable {
|
public struct UpdateCollectionRequest: Codable, Sendable {
|
||||||
public let id: String
|
public let id: String
|
||||||
public let name: String?
|
public let name: String?
|
||||||
public let description: String?
|
public let description: String?
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import Foundation
|
import Foundation
|
||||||
|
|
||||||
public struct UpdateDocumentRequest: Encodable, Sendable {
|
public struct UpdateDocumentRequest: Codable, Sendable {
|
||||||
public let id: String
|
public let id: String
|
||||||
public let title: String?
|
public let title: String?
|
||||||
public let text: String?
|
public let text: String?
|
||||||
|
|||||||
@@ -0,0 +1,28 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// `users.update`, scoped to just the avatar. Custom `encode(to:)` because
|
||||||
|
/// Swift's synthesized `Encodable` uses `encodeIfPresent` for `Optional`
|
||||||
|
/// properties, which *omits* the key entirely when the value is `nil` —
|
||||||
|
/// removing the avatar needs a literal `"avatarUrl": null` in the request
|
||||||
|
/// body, not the key missing. `id` is required: confirmed live (the
|
||||||
|
/// captured request body's length only matches `{"id": "...", "avatarUrl":
|
||||||
|
/// ...}`, not a shorter shape without it).
|
||||||
|
public struct UpdateUserAvatarRequest: Encodable, Sendable {
|
||||||
|
public let id: String
|
||||||
|
public let avatarUrl: String?
|
||||||
|
|
||||||
|
public init(id: String, avatarUrl: String?) {
|
||||||
|
self.id = id
|
||||||
|
self.avatarUrl = avatarUrl
|
||||||
|
}
|
||||||
|
|
||||||
|
private enum CodingKeys: String, CodingKey {
|
||||||
|
case id, avatarUrl
|
||||||
|
}
|
||||||
|
|
||||||
|
public func encode(to encoder: Encoder) throws {
|
||||||
|
var container = encoder.container(keyedBy: CodingKeys.self)
|
||||||
|
try container.encode(id, forKey: .id)
|
||||||
|
try container.encode(avatarUrl, forKey: .avatarUrl)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// `users.update`, language only.
|
||||||
|
public struct UpdateUserLanguageRequest: Encodable, Sendable {
|
||||||
|
public let id: String
|
||||||
|
public let language: String
|
||||||
|
|
||||||
|
public init(id: String, language: String) {
|
||||||
|
self.id = id
|
||||||
|
self.language = language
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// `users.update`, name only.
|
||||||
|
public struct UpdateUserNameRequest: Encodable, Sendable {
|
||||||
|
public let id: String
|
||||||
|
public let name: String
|
||||||
|
|
||||||
|
public init(id: String, name: String) {
|
||||||
|
self.id = id
|
||||||
|
self.name = name
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// `users.update`, preferences only. Sends the *whole* preferences object
|
||||||
|
/// back (not a single changed key) — avoids needing to know whether the
|
||||||
|
/// server deep-merges a partial `preferences` body or replaces it outright.
|
||||||
|
public struct UpdateUserPreferencesRequest: Encodable, Sendable {
|
||||||
|
public let id: String
|
||||||
|
public let preferences: OutlineUserPreferences
|
||||||
|
|
||||||
|
public init(id: String, preferences: OutlineUserPreferences) {
|
||||||
|
self.id = id
|
||||||
|
self.preferences = preferences
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,514 @@
|
|||||||
|
import XCTest
|
||||||
|
@testable import OutlineKit
|
||||||
|
|
||||||
|
private struct NotStubbed: Error {}
|
||||||
|
|
||||||
|
/// Conforms to the full protocol (so it can stand in for `live`), but only
|
||||||
|
/// the two methods under test in this file have real behavior — everything
|
||||||
|
/// else throws loudly if a test accidentally exercises it.
|
||||||
|
private final class StubOutlineAPIClient: OutlineAPIClient, @unchecked Sendable {
|
||||||
|
var documentInfoHandler: (@Sendable (String) async throws -> OutlineDocument)?
|
||||||
|
var listCollectionsHandler: (@Sendable (Int, Int) async throws -> [OutlineCollection])?
|
||||||
|
var updateDocumentHandler: (@Sendable (UpdateDocumentRequest) async throws -> OutlineDocument)?
|
||||||
|
var createPinHandler: (@Sendable (CreatePinRequest) async throws -> OutlinePin)?
|
||||||
|
var deletePinHandler: (@Sendable (String) async throws -> Void)?
|
||||||
|
var listDocumentsHandler: (@Sendable (String?, String?, Int, Int) async throws -> [OutlineDocument])?
|
||||||
|
var createDocumentHandler: (@Sendable (CreateDocumentRequest) async throws -> OutlineDocument)?
|
||||||
|
|
||||||
|
func authInfo() async throws -> OutlineAuthInfo { throw NotStubbed() }
|
||||||
|
|
||||||
|
func documentInfo(id: String) async throws -> OutlineDocument {
|
||||||
|
guard let handler = documentInfoHandler else { throw NotStubbed() }
|
||||||
|
return try await handler(id)
|
||||||
|
}
|
||||||
|
|
||||||
|
func listDocuments(collectionId: String?, parentDocumentId: String?, offset: Int, limit: Int) async throws -> [OutlineDocument] {
|
||||||
|
guard let handler = listDocumentsHandler else { throw NotStubbed() }
|
||||||
|
return try await handler(collectionId, parentDocumentId, offset, limit)
|
||||||
|
}
|
||||||
|
|
||||||
|
func documentsList(_ request: DocumentsListRequest) async throws -> [OutlineDocument] { throw NotStubbed() }
|
||||||
|
func listViewedDocuments(offset: Int, limit: Int) async throws -> [OutlineDocument] { throw NotStubbed() }
|
||||||
|
func searchDocuments(_ request: DocumentSearchRequest) async throws -> [OutlineDocumentSearchResult] { throw NotStubbed() }
|
||||||
|
func searchDocumentTitles(_ request: DocumentSearchTitlesRequest) async throws -> [OutlineDocument] { throw NotStubbed() }
|
||||||
|
func createDocument(_ request: CreateDocumentRequest) async throws -> OutlineDocument {
|
||||||
|
guard let handler = createDocumentHandler else { throw NotStubbed() }
|
||||||
|
return try await handler(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
func updateDocument(_ request: UpdateDocumentRequest) async throws -> OutlineDocument {
|
||||||
|
guard let handler = updateDocumentHandler else { throw NotStubbed() }
|
||||||
|
return try await handler(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
func starDocument(_ request: StarDocumentRequest) async throws -> OutlineStar { throw NotStubbed() }
|
||||||
|
func templatizeDocument(_ request: TemplatizeDocumentRequest) async throws -> OutlineTemplate { throw NotStubbed() }
|
||||||
|
func duplicateDocument(_ request: DuplicateDocumentRequest) async throws -> [OutlineDocument] { throw NotStubbed() }
|
||||||
|
func unpublishDocument(_ request: UnpublishDocumentRequest) async throws -> OutlineDocument { throw NotStubbed() }
|
||||||
|
func archiveDocument(id: String) async throws -> OutlineDocument { throw NotStubbed() }
|
||||||
|
func moveDocument(_ request: MoveDocumentRequest) async throws { throw NotStubbed() }
|
||||||
|
func deleteDocument(_ request: DeleteDocumentRequest) async throws { throw NotStubbed() }
|
||||||
|
func documentInsights(_ request: DocumentInsightsRequest) async throws -> [OutlineDocumentInsight] { throw NotStubbed() }
|
||||||
|
func listRevisions(_ request: ListRevisionsRequest) async throws -> [OutlineRevision] { throw NotStubbed() }
|
||||||
|
func exportDocument(id: String) async throws -> String { throw NotStubbed() }
|
||||||
|
func createShare(_ request: CreateShareRequest) async throws -> OutlineShare { throw NotStubbed() }
|
||||||
|
func shareInfo(documentId: String) async throws -> OutlineShare? { throw NotStubbed() }
|
||||||
|
func updateShare(_ request: UpdateShareRequest) async throws -> OutlineShare { throw NotStubbed() }
|
||||||
|
func listShares(_ request: ListSharesRequest) async throws -> [OutlineShare] { throw NotStubbed() }
|
||||||
|
func revokeShare(id: String) async throws { throw NotStubbed() }
|
||||||
|
func createPin(_ request: CreatePinRequest) async throws -> OutlinePin {
|
||||||
|
guard let handler = createPinHandler else { throw NotStubbed() }
|
||||||
|
return try await handler(request)
|
||||||
|
}
|
||||||
|
|
||||||
|
func listPins(_ request: ListPinsRequest) async throws -> [OutlinePin] { throw NotStubbed() }
|
||||||
|
|
||||||
|
func deletePin(id: String) async throws {
|
||||||
|
guard let handler = deletePinHandler else { throw NotStubbed() }
|
||||||
|
try await handler(id)
|
||||||
|
}
|
||||||
|
func createSubscription(_ request: CreateSubscriptionRequest) async throws -> OutlineSubscription { throw NotStubbed() }
|
||||||
|
func listSubscriptions(_ request: ListSubscriptionsRequest) async throws -> [OutlineSubscription] { throw NotStubbed() }
|
||||||
|
func deleteSubscription(id: String) async throws { throw NotStubbed() }
|
||||||
|
func listViews(_ request: ListViewsRequest) async throws -> [OutlineView] { throw NotStubbed() }
|
||||||
|
func addDocumentUser(_ request: AddDocumentUserRequest) async throws -> OutlineMembership { throw NotStubbed() }
|
||||||
|
func removeDocumentUser(_ request: RemoveDocumentUserRequest) async throws { throw NotStubbed() }
|
||||||
|
func documentUsers(_ request: ListDocumentUsersRequest) async throws -> [OutlineDocumentMember] { throw NotStubbed() }
|
||||||
|
func listUsers(_ request: ListUsersRequest) async throws -> [OutlineUser] { throw NotStubbed() }
|
||||||
|
|
||||||
|
func listCollections(offset: Int, limit: Int) async throws -> [OutlineCollection] {
|
||||||
|
guard let handler = listCollectionsHandler else { throw NotStubbed() }
|
||||||
|
return try await handler(offset, limit)
|
||||||
|
}
|
||||||
|
|
||||||
|
func collectionInfo(id: String) async throws -> OutlineCollection { throw NotStubbed() }
|
||||||
|
func updateCollection(_ request: UpdateCollectionRequest) async throws -> OutlineCollection { throw NotStubbed() }
|
||||||
|
func deleteCollection(id: String) async throws { throw NotStubbed() }
|
||||||
|
func exportCollection(_ request: ExportCollectionRequest) async throws -> OutlineFileOperation { throw NotStubbed() }
|
||||||
|
func starCollection(_ request: StarCollectionRequest) async throws -> OutlineStar { throw NotStubbed() }
|
||||||
|
func listStars(_ request: ListStarsRequest) async throws -> [OutlineStar] { throw NotStubbed() }
|
||||||
|
func deleteStar(id: String) async throws { throw NotStubbed() }
|
||||||
|
func currentUser() async throws -> OutlineUser { throw NotStubbed() }
|
||||||
|
func createAttachment(_ request: CreateAttachmentRequest) async throws -> CreateAttachmentResult { throw NotStubbed() }
|
||||||
|
func uploadAttachmentFile(_ result: CreateAttachmentResult, fileData: Data) async throws { throw NotStubbed() }
|
||||||
|
func deleteAttachment(id: String) async throws { throw NotStubbed() }
|
||||||
|
func updateUserAvatar(_ request: UpdateUserAvatarRequest) async throws -> OutlineUser { throw NotStubbed() }
|
||||||
|
func updateUserName(_ request: UpdateUserNameRequest) async throws -> OutlineUser { throw NotStubbed() }
|
||||||
|
func updateUserLanguage(_ request: UpdateUserLanguageRequest) async throws -> OutlineUser { throw NotStubbed() }
|
||||||
|
func updateUserPreferences(_ request: UpdateUserPreferencesRequest) async throws -> OutlineUser { throw NotStubbed() }
|
||||||
|
func deleteAccount() async throws { throw NotStubbed() }
|
||||||
|
func subscribeToNotifications(eventType: NotificationEventType?) async throws -> OutlineUser { throw NotStubbed() }
|
||||||
|
func unsubscribeFromNotifications(eventType: NotificationEventType?) async throws -> OutlineUser { throw NotStubbed() }
|
||||||
|
func listApiKeys(_ request: ListApiKeysRequest) async throws -> [OutlineAPIKey] { throw NotStubbed() }
|
||||||
|
func createApiKey(_ request: CreateApiKeyRequest) async throws -> OutlineAPIKey { throw NotStubbed() }
|
||||||
|
func deleteApiKey(id: String) async throws { throw NotStubbed() }
|
||||||
|
func installationInfo() async throws -> OutlineInstallationInfo { throw NotStubbed() }
|
||||||
|
}
|
||||||
|
|
||||||
|
private struct StubTransportError: Error {}
|
||||||
|
|
||||||
|
final class CachingOutlineAPIClientTests: XCTestCase {
|
||||||
|
private func makeCache() throws -> OfflineCacheStore {
|
||||||
|
OfflineCacheStore(modelContainer: try OfflineCacheStore.makeContainer(inMemory: true))
|
||||||
|
}
|
||||||
|
|
||||||
|
private func makeDocument(id: String = "doc-1", title: String = "Hello") -> OutlineDocument {
|
||||||
|
OutlineDocument(
|
||||||
|
id: id,
|
||||||
|
title: title,
|
||||||
|
text: "body",
|
||||||
|
url: "/doc/\(id)",
|
||||||
|
createdAt: Date(timeIntervalSince1970: 0),
|
||||||
|
updatedAt: Date(timeIntervalSince1970: 0)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private func makeCollection(id: String = "col-1", name: String = "Engineering") -> OutlineCollection {
|
||||||
|
OutlineCollection(
|
||||||
|
id: id,
|
||||||
|
name: name,
|
||||||
|
createdAt: Date(timeIntervalSince1970: 0),
|
||||||
|
updatedAt: Date(timeIntervalSince1970: 0)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func testDocumentInfoWritesThroughToCacheOnSuccess() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
let document = makeDocument()
|
||||||
|
stub.documentInfoHandler = { _ in document }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
let result = try await sut.documentInfo(id: "doc-1")
|
||||||
|
|
||||||
|
XCTAssertEqual(result, document)
|
||||||
|
}
|
||||||
|
|
||||||
|
func testDocumentInfoFallsBackToCacheWhenLiveFails() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
let document = makeDocument()
|
||||||
|
var callCount = 0
|
||||||
|
stub.documentInfoHandler = { _ in
|
||||||
|
callCount += 1
|
||||||
|
if callCount == 1 { return document }
|
||||||
|
throw StubTransportError()
|
||||||
|
}
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
// First call succeeds and populates the cache.
|
||||||
|
_ = try await sut.documentInfo(id: "doc-1")
|
||||||
|
// Second call fails live — should transparently return the cached value.
|
||||||
|
let result = try await sut.documentInfo(id: "doc-1")
|
||||||
|
|
||||||
|
XCTAssertEqual(result, document)
|
||||||
|
XCTAssertEqual(callCount, 2)
|
||||||
|
}
|
||||||
|
|
||||||
|
func testDocumentInfoRethrowsWhenLiveFailsAndCacheIsEmpty() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
stub.documentInfoHandler = { _ in throw StubTransportError() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
do {
|
||||||
|
_ = try await sut.documentInfo(id: "doc-1")
|
||||||
|
XCTFail("Expected an error")
|
||||||
|
} catch is StubTransportError {
|
||||||
|
// expected
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testListCollectionsFallsBackToCacheWhenLiveFails() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
let collections = [makeCollection()]
|
||||||
|
var callCount = 0
|
||||||
|
stub.listCollectionsHandler = { _, _ in
|
||||||
|
callCount += 1
|
||||||
|
if callCount == 1 { return collections }
|
||||||
|
throw StubTransportError()
|
||||||
|
}
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
_ = try await sut.listCollections(offset: 0, limit: 25)
|
||||||
|
let result = try await sut.listCollections(offset: 0, limit: 25)
|
||||||
|
|
||||||
|
XCTAssertEqual(result, collections)
|
||||||
|
}
|
||||||
|
|
||||||
|
func testDifferentDocumentIdsAreCachedSeparately() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
let docOne = makeDocument(id: "doc-1", title: "One")
|
||||||
|
let docTwo = makeDocument(id: "doc-2", title: "Two")
|
||||||
|
stub.documentInfoHandler = { id in id == "doc-1" ? docOne : docTwo }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
_ = try await sut.documentInfo(id: "doc-1")
|
||||||
|
_ = try await sut.documentInfo(id: "doc-2")
|
||||||
|
stub.documentInfoHandler = { _ in throw StubTransportError() }
|
||||||
|
|
||||||
|
let cachedOne = try await sut.documentInfo(id: "doc-1")
|
||||||
|
let cachedTwo = try await sut.documentInfo(id: "doc-2")
|
||||||
|
|
||||||
|
XCTAssertEqual(cachedOne, docOne)
|
||||||
|
XCTAssertEqual(cachedTwo, docTwo)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Offline writes
|
||||||
|
|
||||||
|
func testUpdateDocumentQueuesAndAppliesOptimisticallyWhenLiveFails() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
let original = makeDocument(id: "doc-1", title: "Original")
|
||||||
|
stub.documentInfoHandler = { _ in original }
|
||||||
|
stub.updateDocumentHandler = { _ in throw StubTransportError() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
// Populate the cache with the base document first (as a real open would).
|
||||||
|
_ = try await sut.documentInfo(id: "doc-1")
|
||||||
|
|
||||||
|
let updated = try await sut.updateDocument(UpdateDocumentRequest(id: "doc-1", title: "Edited Offline"))
|
||||||
|
XCTAssertEqual(updated.title, "Edited Offline")
|
||||||
|
|
||||||
|
// Re-opening the document (still offline) should reflect the optimistic edit.
|
||||||
|
stub.documentInfoHandler = { _ in throw StubTransportError() }
|
||||||
|
let reopened = try await sut.documentInfo(id: "doc-1")
|
||||||
|
XCTAssertEqual(reopened.title, "Edited Offline")
|
||||||
|
|
||||||
|
let pending = await sut.pendingOperations()
|
||||||
|
XCTAssertEqual(pending.count, 1)
|
||||||
|
XCTAssertEqual(pending.first?.kind, "updateDocument")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testUpdateDocumentRethrowsWhenDocumentWasNeverCached() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
stub.updateDocumentHandler = { _ in throw StubTransportError() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
do {
|
||||||
|
_ = try await sut.updateDocument(UpdateDocumentRequest(id: "never-seen", title: "x"))
|
||||||
|
XCTFail("Expected an error")
|
||||||
|
} catch is StubTransportError {
|
||||||
|
// expected — nothing to optimistically merge onto
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func testSecondOfflineEditCoalescesIntoOneQueuedOperation() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
let original = makeDocument(id: "doc-1", title: "Original")
|
||||||
|
stub.documentInfoHandler = { _ in original }
|
||||||
|
stub.updateDocumentHandler = { _ in throw StubTransportError() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
_ = try await sut.documentInfo(id: "doc-1")
|
||||||
|
_ = try await sut.updateDocument(UpdateDocumentRequest(id: "doc-1", title: "First Edit"))
|
||||||
|
_ = try await sut.updateDocument(UpdateDocumentRequest(id: "doc-1", title: "Second Edit"))
|
||||||
|
|
||||||
|
let pending = await sut.pendingOperations()
|
||||||
|
XCTAssertEqual(pending.count, 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
func testPinThenUnpinBeforeSyncCancelsOutWithoutQueuingADelete() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
stub.createPinHandler = { _ in throw StubTransportError() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
let pin = try await sut.createPin(CreatePinRequest(documentId: "doc-1"))
|
||||||
|
XCTAssertTrue(pin.id.hasPrefix("pending-"))
|
||||||
|
let pendingCount1 = await sut.pendingOperations().count
|
||||||
|
XCTAssertEqual(pendingCount1, 1)
|
||||||
|
|
||||||
|
try await sut.deletePin(id: pin.id)
|
||||||
|
|
||||||
|
let pendingCount0 = await sut.pendingOperations().count
|
||||||
|
XCTAssertEqual(pendingCount0, 0)
|
||||||
|
}
|
||||||
|
|
||||||
|
func testFlushPendingOperationsReplaysAndClearsOnSuccess() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
let original = makeDocument(id: "doc-1", title: "Original")
|
||||||
|
stub.documentInfoHandler = { _ in original }
|
||||||
|
stub.updateDocumentHandler = { _ in throw StubTransportError() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
_ = try await sut.documentInfo(id: "doc-1")
|
||||||
|
_ = try await sut.updateDocument(UpdateDocumentRequest(id: "doc-1", title: "Edited Offline"))
|
||||||
|
let pendingCount1 = await sut.pendingOperations().count
|
||||||
|
XCTAssertEqual(pendingCount1, 1)
|
||||||
|
|
||||||
|
// Network's back — replay should now succeed.
|
||||||
|
stub.updateDocumentHandler = { request in
|
||||||
|
self.makeDocument(id: request.id, title: request.title ?? "")
|
||||||
|
}
|
||||||
|
let summary = await sut.flushPendingOperations()
|
||||||
|
|
||||||
|
XCTAssertEqual(summary.succeeded, 1)
|
||||||
|
XCTAssertEqual(summary.failed, 0)
|
||||||
|
let pendingCount0 = await sut.pendingOperations().count
|
||||||
|
XCTAssertEqual(pendingCount0, 0)
|
||||||
|
}
|
||||||
|
|
||||||
|
func testFlushPendingOperationsRecordsErrorAndKeepsFailedOperation() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
let original = makeDocument(id: "doc-1", title: "Original")
|
||||||
|
stub.documentInfoHandler = { _ in original }
|
||||||
|
stub.updateDocumentHandler = { _ in throw StubTransportError() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
_ = try await sut.documentInfo(id: "doc-1")
|
||||||
|
_ = try await sut.updateDocument(UpdateDocumentRequest(id: "doc-1", title: "Edited Offline"))
|
||||||
|
|
||||||
|
// Still offline — replay should fail and keep the operation queued.
|
||||||
|
let summary = await sut.flushPendingOperations()
|
||||||
|
|
||||||
|
XCTAssertEqual(summary.succeeded, 0)
|
||||||
|
XCTAssertEqual(summary.failed, 1)
|
||||||
|
let pending = await sut.pendingOperations()
|
||||||
|
XCTAssertEqual(pending.count, 1)
|
||||||
|
XCTAssertEqual(pending.first?.attemptCount, 1)
|
||||||
|
XCTAssertNotNil(pending.first?.lastError)
|
||||||
|
}
|
||||||
|
|
||||||
|
func testManualOfflineModeSkipsLiveEntirely() async throws {
|
||||||
|
let defaults = UserDefaults(suiteName: "CachingOutlineAPIClientTests.manualOffline")!
|
||||||
|
defaults.removePersistentDomain(forName: "CachingOutlineAPIClientTests.manualOffline")
|
||||||
|
defaults.set(true, forKey: CachingOutlineAPIClient.offlineModeDefaultsKey)
|
||||||
|
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
var liveCallCount = 0
|
||||||
|
stub.createPinHandler = { _ in
|
||||||
|
liveCallCount += 1
|
||||||
|
return OutlinePin(id: "real-id", documentId: "doc-1", collectionId: nil, index: nil)
|
||||||
|
}
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache(), defaults: defaults)
|
||||||
|
|
||||||
|
let pin = try await sut.createPin(CreatePinRequest(documentId: "doc-1"))
|
||||||
|
|
||||||
|
XCTAssertEqual(liveCallCount, 0, "Manual offline mode should never attempt the live call")
|
||||||
|
XCTAssertTrue(pin.id.hasPrefix("pending-"))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Regression test: manual offline mode used to only gate writes —
|
||||||
|
/// reads (listCollections, documentInfo, etc.) still hit `live` first
|
||||||
|
/// any time the device actually had a connection, silently defeating
|
||||||
|
/// "skip the network entirely" for the one thing that mattered most:
|
||||||
|
/// the sidebar showing more than what was actually cached.
|
||||||
|
func testManualOfflineModeSkipsLiveForReadsToo() async throws {
|
||||||
|
let defaults = UserDefaults(suiteName: "CachingOutlineAPIClientTests.manualOfflineReads")!
|
||||||
|
defaults.removePersistentDomain(forName: "CachingOutlineAPIClientTests.manualOfflineReads")
|
||||||
|
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
let cachedCollection = makeCollection(id: "col-1")
|
||||||
|
var liveCallCount = 0
|
||||||
|
stub.listCollectionsHandler = { _, _ in
|
||||||
|
liveCallCount += 1
|
||||||
|
return [cachedCollection]
|
||||||
|
}
|
||||||
|
let cache = try makeCache()
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: cache, defaults: defaults)
|
||||||
|
|
||||||
|
// Online first — populates the cache normally.
|
||||||
|
let firstResult = try await sut.listCollections(offset: 0, limit: 25)
|
||||||
|
XCTAssertEqual(firstResult, [cachedCollection])
|
||||||
|
XCTAssertEqual(liveCallCount, 1)
|
||||||
|
|
||||||
|
// Flip manual offline mode on, still "connected" (stub would happily
|
||||||
|
// answer) — the live call must not be attempted at all.
|
||||||
|
defaults.set(true, forKey: CachingOutlineAPIClient.offlineModeDefaultsKey)
|
||||||
|
let secondResult = try await sut.listCollections(offset: 0, limit: 25)
|
||||||
|
|
||||||
|
XCTAssertEqual(secondResult, [cachedCollection])
|
||||||
|
XCTAssertEqual(liveCallCount, 1, "listCollections should have served entirely from cache")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testCacheStorageSummaryReflectsCachedItems() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
stub.documentInfoHandler = { _ in self.makeDocument() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
_ = try await sut.documentInfo(id: "doc-1")
|
||||||
|
let summary = await sut.cacheStorageSummary()
|
||||||
|
|
||||||
|
XCTAssertEqual(summary.itemCount, 1)
|
||||||
|
XCTAssertGreaterThan(summary.totalBytes, 0)
|
||||||
|
|
||||||
|
await sut.clearCache()
|
||||||
|
let clearedSummary = await sut.cacheStorageSummary()
|
||||||
|
XCTAssertEqual(clearedSummary.itemCount, 0)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Full sync
|
||||||
|
|
||||||
|
func testPerformFullSyncNeverRequestsMoreThan100CollectionsPerPage() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
var requestedLimits: [Int] = []
|
||||||
|
// 105 collections across two pages (100 + 5) — regression test for a
|
||||||
|
// real bug: this used to ask for `limit: 250` in one shot, which
|
||||||
|
// Outline's server rejects outright ("Pagination limit is too large
|
||||||
|
// (max 100)"), turning the whole sync into a single silent failure.
|
||||||
|
stub.listCollectionsHandler = { offset, limit in
|
||||||
|
requestedLimits.append(limit)
|
||||||
|
let remaining = max(0, 105 - offset)
|
||||||
|
let count = min(limit, remaining)
|
||||||
|
return (0..<count).map { self.makeCollection(id: "col-\(offset + $0)") }
|
||||||
|
}
|
||||||
|
stub.listDocumentsHandler = { _, _, _, _ in [] }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
let summary = await sut.performFullSync()
|
||||||
|
|
||||||
|
XCTAssertEqual(summary.collectionsCount, 105)
|
||||||
|
XCTAssertTrue(summary.errors.isEmpty)
|
||||||
|
XCTAssertTrue(requestedLimits.allSatisfy { $0 <= 100 }, "requested limits: \(requestedLimits)")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testPerformFullSyncCachesEachDocumentIndividually() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
stub.listCollectionsHandler = { offset, _ in offset == 0 ? [self.makeCollection(id: "col-1")] : [] }
|
||||||
|
stub.listDocumentsHandler = { _, _, offset, _ in
|
||||||
|
offset == 0 ? [self.makeDocument(id: "doc-1"), self.makeDocument(id: "doc-2")] : []
|
||||||
|
}
|
||||||
|
let cache = try makeCache()
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: cache)
|
||||||
|
|
||||||
|
let summary = await sut.performFullSync()
|
||||||
|
XCTAssertEqual(summary.documentsCount, 2)
|
||||||
|
|
||||||
|
// A plain documentInfo read (no live call available) should now hit
|
||||||
|
// the cache full sync populated, not just the list-shaped cache key.
|
||||||
|
stub.documentInfoHandler = { _ in throw StubTransportError() }
|
||||||
|
let cachedDoc = try await sut.documentInfo(id: "doc-2")
|
||||||
|
XCTAssertEqual(cachedDoc.id, "doc-2")
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Offline document creation
|
||||||
|
|
||||||
|
func testCreateDocumentQueuesAndReturnsUsableDocumentWhenOffline() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
stub.createDocumentHandler = { _ in throw StubTransportError() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
let created = try await sut.createDocument(
|
||||||
|
CreateDocumentRequest(title: "New Doc", text: "hello", collectionId: "col-1")
|
||||||
|
)
|
||||||
|
|
||||||
|
XCTAssertTrue(created.id.hasPrefix("pending-"))
|
||||||
|
XCTAssertEqual(created.title, "New Doc")
|
||||||
|
XCTAssertEqual(created.text, "hello")
|
||||||
|
|
||||||
|
// It's immediately readable, same as any other cached document.
|
||||||
|
stub.documentInfoHandler = { _ in throw StubTransportError() }
|
||||||
|
let reopened = try await sut.documentInfo(id: created.id)
|
||||||
|
XCTAssertEqual(reopened.title, "New Doc")
|
||||||
|
|
||||||
|
let pending = await sut.pendingOperations()
|
||||||
|
XCTAssertEqual(pending.count, 1)
|
||||||
|
XCTAssertEqual(pending.first?.kind, "createDocument")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testEditingAnUnsyncedCreatedDocumentFoldsIntoTheCreateInsteadOfQueuingAnUpdate() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
stub.createDocumentHandler = { _ in throw StubTransportError() }
|
||||||
|
stub.updateDocumentHandler = { _ in throw StubTransportError() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
let created = try await sut.createDocument(
|
||||||
|
CreateDocumentRequest(title: "Untitled", text: "", collectionId: "col-1")
|
||||||
|
)
|
||||||
|
_ = try await sut.updateDocument(UpdateDocumentRequest(id: created.id, title: "Real Title", text: "Real body"))
|
||||||
|
|
||||||
|
let pending = await sut.pendingOperations()
|
||||||
|
XCTAssertEqual(pending.count, 1, "the edit should have folded into the pending create, not added a second operation")
|
||||||
|
XCTAssertEqual(pending.first?.kind, "createDocument")
|
||||||
|
|
||||||
|
stub.documentInfoHandler = { _ in throw StubTransportError() }
|
||||||
|
let reopened = try await sut.documentInfo(id: created.id)
|
||||||
|
XCTAssertEqual(reopened.title, "Real Title")
|
||||||
|
XCTAssertEqual(reopened.text, "Real body")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testFlushingAPendingCreateReconcilesThePlaceholderIdToTheRealOne() async throws {
|
||||||
|
let stub = StubOutlineAPIClient()
|
||||||
|
stub.createDocumentHandler = { _ in throw StubTransportError() }
|
||||||
|
let sut = CachingOutlineAPIClient(live: stub, cache: try makeCache())
|
||||||
|
|
||||||
|
let created = try await sut.createDocument(
|
||||||
|
CreateDocumentRequest(title: "New Doc", text: "hello", collectionId: "col-1")
|
||||||
|
)
|
||||||
|
let realDocument = makeDocument(id: "real-server-id", title: "New Doc")
|
||||||
|
stub.createDocumentHandler = { _ in realDocument }
|
||||||
|
|
||||||
|
let summary = await sut.flushPendingOperations()
|
||||||
|
XCTAssertEqual(summary.succeeded, 1)
|
||||||
|
XCTAssertEqual(summary.failed, 0)
|
||||||
|
|
||||||
|
// The real document is now readable under its real id...
|
||||||
|
stub.documentInfoHandler = { _ in throw StubTransportError() }
|
||||||
|
let byRealId = try await sut.documentInfo(id: "real-server-id")
|
||||||
|
XCTAssertEqual(byRealId.id, "real-server-id")
|
||||||
|
|
||||||
|
// ...and the placeholder is gone rather than left as a dead orphan.
|
||||||
|
do {
|
||||||
|
_ = try await sut.documentInfo(id: created.id)
|
||||||
|
XCTFail("Expected the placeholder cache entry to have been removed")
|
||||||
|
} catch {
|
||||||
|
// expected — nothing left under the old id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -993,6 +993,490 @@ final class LiveOutlineAPIClientTests: XCTestCase {
|
|||||||
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/users.list")
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/users.list")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func testUpdateUserAvatarSendsExplicitNullWhenRemoving() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": "user-1",
|
||||||
|
"name": "Jane Doe",
|
||||||
|
"avatarUrl": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let user = try await client.updateUserAvatar(UpdateUserAvatarRequest(id: "user-1", avatarUrl: nil))
|
||||||
|
|
||||||
|
XCTAssertNil(user.avatarUrl)
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/users.update")
|
||||||
|
let sentBody = try XCTUnwrap(httpClient.lastRequest?.httpBody)
|
||||||
|
let sentJSON = try XCTUnwrap(String(data: sentBody, encoding: .utf8))
|
||||||
|
// The whole point of UpdateUserAvatarRequest's custom encode(to:) —
|
||||||
|
// Swift's synthesized Encodable would have omitted the key entirely
|
||||||
|
// for a nil Optional instead of sending a literal null.
|
||||||
|
XCTAssertTrue(sentJSON.contains("\"avatarUrl\":null"), "expected an explicit null, got: \(sentJSON)")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testUpdateUserAvatarSendsTheNewURLWhenSet() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": "user-1",
|
||||||
|
"name": "Jane Doe",
|
||||||
|
"avatarUrl": "/api/attachments.redirect?id=abc"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let user = try await client.updateUserAvatar(
|
||||||
|
UpdateUserAvatarRequest(id: "user-1", avatarUrl: "/api/attachments.redirect?id=abc")
|
||||||
|
)
|
||||||
|
|
||||||
|
XCTAssertEqual(user.avatarUrl, "/api/attachments.redirect?id=abc")
|
||||||
|
let sentBody = try XCTUnwrap(httpClient.lastRequest?.httpBody)
|
||||||
|
let sentJSON = try XCTUnwrap(String(data: sentBody, encoding: .utf8))
|
||||||
|
XCTAssertTrue(sentJSON.contains("\"id\":\"user-1\""))
|
||||||
|
}
|
||||||
|
|
||||||
|
func testUpdateUserNameSendsRequestAndDecodesResult() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": "user-1",
|
||||||
|
"name": "New Name"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let user = try await client.updateUserName(UpdateUserNameRequest(id: "user-1", name: "New Name"))
|
||||||
|
|
||||||
|
XCTAssertEqual(user.name, "New Name")
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/users.update")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testUpdateUserLanguageSendsRequestAndDecodesResult() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": "user-1",
|
||||||
|
"name": "Jane Doe",
|
||||||
|
"language": "fr_FR"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let user = try await client.updateUserLanguage(UpdateUserLanguageRequest(id: "user-1", language: "fr_FR"))
|
||||||
|
|
||||||
|
XCTAssertEqual(user.language, "fr_FR")
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/users.update")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testUpdateUserPreferencesSendsWholeObjectAndDecodesResult() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": "user-1",
|
||||||
|
"name": "Jane Doe",
|
||||||
|
"preferences": { "rememberLastPath": true, "useCursorPointer": true }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let preferences = OutlineUserPreferences(rememberLastPath: true, useCursorPointer: true)
|
||||||
|
let user = try await client.updateUserPreferences(UpdateUserPreferencesRequest(id: "user-1", preferences: preferences))
|
||||||
|
|
||||||
|
XCTAssertEqual(user.preferences?.rememberLastPath, true)
|
||||||
|
XCTAssertEqual(user.preferences?.useCursorPointer, true)
|
||||||
|
|
||||||
|
let sentBody = try JSONSerialization.jsonObject(with: httpClient.lastRequest!.httpBody!) as? [String: Any]
|
||||||
|
let sentPreferences = sentBody?["preferences"] as? [String: Any]
|
||||||
|
XCTAssertEqual(sentPreferences?["rememberLastPath"] as? Bool, true)
|
||||||
|
XCTAssertEqual(sentPreferences?["useCursorPointer"] as? Bool, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Locks in the wire mapping confirmed against a live server's own web
|
||||||
|
/// app traffic: `seamlessEdit`/`commentsInGutter`/`enableSmartText` are
|
||||||
|
/// the real keys (not `separateEditing`/`showCommentMarker`/`smartText`
|
||||||
|
/// this struct exposes), and `seamlessEdit` is the *negation* of this
|
||||||
|
/// app's `separateEditing`.
|
||||||
|
func testOutlineUserPreferencesDecodesRealWireKeys() throws {
|
||||||
|
let json = """
|
||||||
|
{
|
||||||
|
"seamlessEdit": false,
|
||||||
|
"commentsInGutter": true,
|
||||||
|
"enableSmartText": true,
|
||||||
|
"rememberLastPath": true,
|
||||||
|
"useCursorPointer": true,
|
||||||
|
"codeBlockLineNumbers": false,
|
||||||
|
"notificationBadge": "indicator",
|
||||||
|
"fullWidthDocuments": true
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let preferences = try JSONDecoder().decode(OutlineUserPreferences.self, from: json)
|
||||||
|
|
||||||
|
XCTAssertEqual(preferences.separateEditing, true, "seamlessEdit: false means separate editing is ON")
|
||||||
|
XCTAssertEqual(preferences.showCommentMarker, true)
|
||||||
|
XCTAssertEqual(preferences.smartText, true)
|
||||||
|
XCTAssertEqual(preferences.rememberLastPath, true)
|
||||||
|
XCTAssertEqual(preferences.useCursorPointer, true)
|
||||||
|
XCTAssertEqual(preferences.codeBlockLineNumbers, false)
|
||||||
|
XCTAssertEqual(preferences.notificationBadge, "indicator")
|
||||||
|
XCTAssertEqual(preferences.fullWidthDocuments, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
func testOutlineUserPreferencesEncodesRealWireKeysAndInvertsSeparateEditing() throws {
|
||||||
|
var preferences = OutlineUserPreferences()
|
||||||
|
preferences.separateEditing = true
|
||||||
|
preferences.showCommentMarker = false
|
||||||
|
preferences.smartText = true
|
||||||
|
preferences.fullWidthDocuments = true
|
||||||
|
|
||||||
|
let data = try JSONEncoder().encode(preferences)
|
||||||
|
let object = try JSONSerialization.jsonObject(with: data) as? [String: Any]
|
||||||
|
|
||||||
|
XCTAssertEqual(object?["seamlessEdit"] as? Bool, false, "separateEditing: true must encode as seamlessEdit: false")
|
||||||
|
XCTAssertEqual(object?["commentsInGutter"] as? Bool, false)
|
||||||
|
XCTAssertEqual(object?["enableSmartText"] as? Bool, true)
|
||||||
|
XCTAssertEqual(object?["fullWidthDocuments"] as? Bool, true)
|
||||||
|
XCTAssertNil(object?["separateEditing"], "must not leak this app's own field name onto the wire")
|
||||||
|
XCTAssertNil(object?["showCommentMarker"])
|
||||||
|
XCTAssertNil(object?["smartText"])
|
||||||
|
}
|
||||||
|
|
||||||
|
func testSubscribeToNotificationsSendsEventTypeAndDecodesResult() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": "user-1",
|
||||||
|
"name": "Jane Doe",
|
||||||
|
"notificationSettings": { "documents.publish": true }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let user = try await client.subscribeToNotifications(eventType: .documentPublish)
|
||||||
|
|
||||||
|
XCTAssertEqual(user.notificationSettings?["documents.publish"], true)
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/users.notificationsSubscribe")
|
||||||
|
let sentBody = try JSONSerialization.jsonObject(with: httpClient.lastRequest!.httpBody!) as? [String: Any]
|
||||||
|
XCTAssertEqual(sentBody?["eventType"] as? String, "documents.publish")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testUnsubscribeFromNotificationsWithNilEventTypeTargetsAll() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": "user-1",
|
||||||
|
"name": "Jane Doe",
|
||||||
|
"notificationSettings": { "documents.publish": false }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
_ = try await client.unsubscribeFromNotifications(eventType: nil)
|
||||||
|
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/users.notificationsUnsubscribe")
|
||||||
|
let sentBody = try JSONSerialization.jsonObject(with: httpClient.lastRequest!.httpBody!) as? [String: Any]
|
||||||
|
XCTAssertNil(sentBody?["eventType"])
|
||||||
|
}
|
||||||
|
|
||||||
|
func testListApiKeysDecodesResult() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"pagination": { "limit": 25, "offset": 0 },
|
||||||
|
"data": [
|
||||||
|
{
|
||||||
|
"id": "c3eec545-6d38-4065-90dc-b6c96a551445",
|
||||||
|
"name": "Outpost",
|
||||||
|
"scope": null,
|
||||||
|
"last4": "dl1h",
|
||||||
|
"createdAt": "2026-08-12T18:44:32.467Z",
|
||||||
|
"updatedAt": "2026-08-12T18:44:32.467Z",
|
||||||
|
"expiresAt": null,
|
||||||
|
"lastActiveAt": "2026-08-18T01:01:36.553Z"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let keys = try await client.listApiKeys(ListApiKeysRequest())
|
||||||
|
|
||||||
|
XCTAssertEqual(keys.count, 1)
|
||||||
|
XCTAssertEqual(keys.first?.name, "Outpost")
|
||||||
|
XCTAssertEqual(keys.first?.last4, "dl1h")
|
||||||
|
XCTAssertNil(keys.first?.expiresAt)
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/apiKeys.list")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testInstallationInfoDecodesResult() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": { "version": "1.9.2", "latestVersion": "1.9.2", "versionsBehind": 0 },
|
||||||
|
"policies": []
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let info = try await client.installationInfo()
|
||||||
|
|
||||||
|
XCTAssertEqual(info.version, "1.9.2")
|
||||||
|
XCTAssertEqual(info.versionsBehind, 0)
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/installation.info")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testCreateApiKeyOmitsExpiresAtWhenNilAndDecodesValue() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": "5655fb3e-2a8c-4f2c-9cae-bbd910ef8683",
|
||||||
|
"name": "test",
|
||||||
|
"scope": null,
|
||||||
|
"value": "ol_api_Xqx9Jti7xUunb5b8bXh29vHmBngqjJl3Id0DGv",
|
||||||
|
"last4": "0DGv",
|
||||||
|
"createdAt": "2026-08-18T15:39:29.872Z",
|
||||||
|
"expiresAt": null,
|
||||||
|
"lastActiveAt": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let key = try await client.createApiKey(CreateApiKeyRequest(name: "test"))
|
||||||
|
|
||||||
|
XCTAssertEqual(key.value, "ol_api_Xqx9Jti7xUunb5b8bXh29vHmBngqjJl3Id0DGv")
|
||||||
|
XCTAssertNil(key.expiresAt)
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/apiKeys.create")
|
||||||
|
let sentBody = try JSONSerialization.jsonObject(with: httpClient.lastRequest!.httpBody!) as? [String: Any]
|
||||||
|
XCTAssertEqual(sentBody?["name"] as? String, "test")
|
||||||
|
XCTAssertNil(sentBody?["expiresAt"], "omitting expiresAt (not sending null) is what produces a non-expiring key")
|
||||||
|
XCTAssertNil(sentBody?["scope"])
|
||||||
|
}
|
||||||
|
|
||||||
|
func testCreateApiKeySendsExpiresAtWhenProvided() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": "04e204fb-51a4-4b54-aed1-2056dfd576d7",
|
||||||
|
"name": "Test",
|
||||||
|
"scope": null,
|
||||||
|
"value": "ol_api_aeYcOts7I2sJXw3zaztjydRM3W3W89TBAtcLts",
|
||||||
|
"last4": "cLts",
|
||||||
|
"createdAt": "2026-08-18T15:38:22.928Z",
|
||||||
|
"expiresAt": "2026-11-16T23:59:59.999Z",
|
||||||
|
"lastActiveAt": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let expiresAt = Date(timeIntervalSince1970: 1_795_000_000)
|
||||||
|
_ = try await client.createApiKey(CreateApiKeyRequest(name: "Test", expiresAt: expiresAt))
|
||||||
|
|
||||||
|
let sentBody = try JSONSerialization.jsonObject(with: httpClient.lastRequest!.httpBody!) as? [String: Any]
|
||||||
|
XCTAssertNotNil(sentBody?["expiresAt"])
|
||||||
|
}
|
||||||
|
|
||||||
|
func testDeleteApiKeySendsRequest() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{ "success": true }
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
try await client.deleteApiKey(id: "5655fb3e-2a8c-4f2c-9cae-bbd910ef8683")
|
||||||
|
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/apiKeys.delete")
|
||||||
|
let sentBody = try JSONSerialization.jsonObject(with: httpClient.lastRequest!.httpBody!) as? [String: Any]
|
||||||
|
XCTAssertEqual(sentBody?["id"] as? String, "5655fb3e-2a8c-4f2c-9cae-bbd910ef8683")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testDeleteAccountSendsRequest() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{ "success": true }
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
try await client.deleteAccount()
|
||||||
|
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/users.delete")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testDeleteAttachmentSendsRequest() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{ "success": true }
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
try await client.deleteAttachment(id: "attach-1")
|
||||||
|
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/attachments.delete")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testCreateAttachmentDecodesUploadTargetAndFormFields() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"attachment": {
|
||||||
|
"id": "attach-1",
|
||||||
|
"documentId": null,
|
||||||
|
"contentType": "image/jpeg",
|
||||||
|
"name": "avatar.jpg",
|
||||||
|
"url": "/api/attachments.redirect?id=attach-1",
|
||||||
|
"size": "59304"
|
||||||
|
},
|
||||||
|
"uploadUrl": "/api/files.create",
|
||||||
|
"form": {
|
||||||
|
"Content-Type": "image/jpeg",
|
||||||
|
"key": "uploads/user-1/attach-1/avatar.jpg",
|
||||||
|
"acl": "public-read"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let result = try await client.createAttachment(
|
||||||
|
CreateAttachmentRequest(name: "avatar.jpg", contentType: "image/jpeg", size: 59304)
|
||||||
|
)
|
||||||
|
|
||||||
|
XCTAssertEqual(result.attachment.id, "attach-1")
|
||||||
|
XCTAssertEqual(result.attachment.size, "59304")
|
||||||
|
XCTAssertEqual(result.uploadUrl, "/api/files.create")
|
||||||
|
XCTAssertEqual(result.form["acl"], "public-read")
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.path, "/api/attachments.create")
|
||||||
|
}
|
||||||
|
|
||||||
|
func testUploadAttachmentFilePostsToTheResolvedRelativeURL() async throws {
|
||||||
|
let httpClient = MockHTTPClient()
|
||||||
|
httpClient.responseData = """
|
||||||
|
{ "success": true }
|
||||||
|
""".data(using: .utf8)!
|
||||||
|
|
||||||
|
let client = LiveOutlineAPIClient(
|
||||||
|
configuration: OutlineConfiguration(baseURL: URL(string: "https://outline.example.com")!),
|
||||||
|
tokenStore: StaticTokenStore(),
|
||||||
|
httpClient: httpClient
|
||||||
|
)
|
||||||
|
|
||||||
|
let uploadTarget = CreateAttachmentResult(
|
||||||
|
attachment: OutlineAttachment(
|
||||||
|
id: "attach-1",
|
||||||
|
documentId: nil,
|
||||||
|
contentType: "image/jpeg",
|
||||||
|
name: "avatar.jpg",
|
||||||
|
url: "/api/attachments.redirect?id=attach-1",
|
||||||
|
size: "3"
|
||||||
|
),
|
||||||
|
uploadUrl: "/api/files.create",
|
||||||
|
form: ["Content-Type": "image/jpeg", "key": "uploads/attach-1"]
|
||||||
|
)
|
||||||
|
|
||||||
|
try await client.uploadAttachmentFile(uploadTarget, fileData: Data("abc".utf8))
|
||||||
|
|
||||||
|
// Resolved against baseURL's host, not appended onto "/api/<baseURL-relative-path>".
|
||||||
|
XCTAssertEqual(httpClient.lastRequest?.url?.absoluteString, "https://outline.example.com/api/files.create")
|
||||||
|
XCTAssertNil(httpClient.lastRequest?.value(forHTTPHeaderField: "Authorization"))
|
||||||
|
let contentType = httpClient.lastRequest?.value(forHTTPHeaderField: "Content-Type")
|
||||||
|
XCTAssertTrue(contentType?.hasPrefix("multipart/form-data; boundary=") ?? false)
|
||||||
|
}
|
||||||
|
|
||||||
func testMissingTokenThrowsTokenUnavailable() async throws {
|
func testMissingTokenThrowsTokenUnavailable() async throws {
|
||||||
let httpClient = MockHTTPClient()
|
let httpClient = MockHTTPClient()
|
||||||
let client = LiveOutlineAPIClient(
|
let client = LiveOutlineAPIClient(
|
||||||
|
|||||||
@@ -0,0 +1,48 @@
|
|||||||
|
import XCTest
|
||||||
|
@testable import OutlineKit
|
||||||
|
|
||||||
|
final class MultipartFormDataBuilderTests: XCTestCase {
|
||||||
|
func testBuildIncludesEveryFieldAndTheFile() throws {
|
||||||
|
let fileData = Data("fake-jpeg-bytes".utf8)
|
||||||
|
let (body, contentType) = MultipartFormDataBuilder.build(
|
||||||
|
fields: ["key": "uploads/abc", "acl": "public-read", "Content-Type": "image/jpeg"],
|
||||||
|
fileFieldName: "file",
|
||||||
|
fileName: "avatar.jpg",
|
||||||
|
fileData: fileData,
|
||||||
|
fileContentType: "image/jpeg",
|
||||||
|
boundary: "TestBoundary"
|
||||||
|
)
|
||||||
|
|
||||||
|
let bodyString = String(decoding: body, as: UTF8.self)
|
||||||
|
|
||||||
|
XCTAssertEqual(contentType, "multipart/form-data; boundary=TestBoundary")
|
||||||
|
XCTAssertTrue(bodyString.contains("Content-Disposition: form-data; name=\"key\""))
|
||||||
|
XCTAssertTrue(bodyString.contains("uploads/abc"))
|
||||||
|
XCTAssertTrue(bodyString.contains("Content-Disposition: form-data; name=\"acl\""))
|
||||||
|
XCTAssertTrue(bodyString.contains("public-read"))
|
||||||
|
XCTAssertTrue(bodyString.contains("Content-Disposition: form-data; name=\"file\"; filename=\"avatar.jpg\""))
|
||||||
|
XCTAssertTrue(bodyString.contains("fake-jpeg-bytes"))
|
||||||
|
XCTAssertTrue(bodyString.hasPrefix("--TestBoundary\r\n"))
|
||||||
|
XCTAssertTrue(bodyString.hasSuffix("--TestBoundary--\r\n"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func testFileFieldComesAfterAllFormFields() throws {
|
||||||
|
let (body, _) = MultipartFormDataBuilder.build(
|
||||||
|
fields: ["a": "1", "b": "2"],
|
||||||
|
fileFieldName: "file",
|
||||||
|
fileName: "x.jpg",
|
||||||
|
fileData: Data("bytes".utf8),
|
||||||
|
fileContentType: "image/jpeg",
|
||||||
|
boundary: "B"
|
||||||
|
)
|
||||||
|
let bodyString = String(decoding: body, as: UTF8.self)
|
||||||
|
|
||||||
|
let fieldsRange = bodyString.range(of: "name=\"a\"")
|
||||||
|
let fileRange = bodyString.range(of: "name=\"file\"")
|
||||||
|
XCTAssertNotNil(fieldsRange)
|
||||||
|
XCTAssertNotNil(fileRange)
|
||||||
|
if let fieldsRange, let fileRange {
|
||||||
|
XCTAssertTrue(fieldsRange.lowerBound < fileRange.lowerBound)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -299,7 +299,7 @@
|
|||||||
CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
|
CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
|
||||||
COPY_PHASE_STRIP = NO;
|
COPY_PHASE_STRIP = NO;
|
||||||
DEBUG_INFORMATION_FORMAT = dwarf;
|
DEBUG_INFORMATION_FORMAT = dwarf;
|
||||||
DEVELOPMENT_TEAM = B95H74ZDY6;
|
DEVELOPMENT_TEAM = CW6GQT9SK5;
|
||||||
ENABLE_STRICT_OBJC_MSGSEND = YES;
|
ENABLE_STRICT_OBJC_MSGSEND = YES;
|
||||||
ENABLE_TESTABILITY = YES;
|
ENABLE_TESTABILITY = YES;
|
||||||
ENABLE_USER_SCRIPT_SANDBOXING = YES;
|
ENABLE_USER_SCRIPT_SANDBOXING = YES;
|
||||||
@@ -361,7 +361,7 @@
|
|||||||
CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
|
CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
|
||||||
COPY_PHASE_STRIP = NO;
|
COPY_PHASE_STRIP = NO;
|
||||||
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
|
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
|
||||||
DEVELOPMENT_TEAM = B95H74ZDY6;
|
DEVELOPMENT_TEAM = CW6GQT9SK5;
|
||||||
ENABLE_NS_ASSERTIONS = NO;
|
ENABLE_NS_ASSERTIONS = NO;
|
||||||
ENABLE_STRICT_OBJC_MSGSEND = YES;
|
ENABLE_STRICT_OBJC_MSGSEND = YES;
|
||||||
ENABLE_USER_SCRIPT_SANDBOXING = YES;
|
ENABLE_USER_SCRIPT_SANDBOXING = YES;
|
||||||
@@ -385,15 +385,20 @@
|
|||||||
buildSettings = {
|
buildSettings = {
|
||||||
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
|
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
|
||||||
ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
|
ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
|
||||||
|
ASSETCATALOG_COMPILER_INCLUDE_ALL_APPICON_ASSETS = YES;
|
||||||
CODE_SIGN_ENTITLEMENTS = Outpost/Outpost.entitlements;
|
CODE_SIGN_ENTITLEMENTS = Outpost/Outpost.entitlements;
|
||||||
|
CODE_SIGN_IDENTITY = "Apple Development";
|
||||||
|
"CODE_SIGN_IDENTITY[sdk=macosx*]" = "Apple Development";
|
||||||
CODE_SIGN_STYLE = Automatic;
|
CODE_SIGN_STYLE = Automatic;
|
||||||
CURRENT_PROJECT_VERSION = 1;
|
CURRENT_PROJECT_VERSION = 1;
|
||||||
DEVELOPMENT_TEAM = B95H74ZDY6;
|
DEVELOPMENT_TEAM = CW6GQT9SK5;
|
||||||
ENABLE_APP_SANDBOX = YES;
|
ENABLE_APP_SANDBOX = YES;
|
||||||
ENABLE_HARDENED_RUNTIME = YES;
|
ENABLE_HARDENED_RUNTIME = YES;
|
||||||
ENABLE_PREVIEWS = YES;
|
ENABLE_PREVIEWS = YES;
|
||||||
ENABLE_USER_SELECTED_FILES = readonly;
|
ENABLE_USER_SELECTED_FILES = readonly;
|
||||||
GENERATE_INFOPLIST_FILE = YES;
|
GENERATE_INFOPLIST_FILE = YES;
|
||||||
|
INFOPLIST_KEY_CFBundleDisplayName = Outpost;
|
||||||
|
INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.productivity";
|
||||||
"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphoneos*]" = YES;
|
"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphoneos*]" = YES;
|
||||||
"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphonesimulator*]" = YES;
|
"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphonesimulator*]" = YES;
|
||||||
"INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents[sdk=iphoneos*]" = YES;
|
"INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents[sdk=iphoneos*]" = YES;
|
||||||
@@ -408,9 +413,10 @@
|
|||||||
LD_RUNPATH_SEARCH_PATHS = "@executable_path/Frameworks";
|
LD_RUNPATH_SEARCH_PATHS = "@executable_path/Frameworks";
|
||||||
"LD_RUNPATH_SEARCH_PATHS[sdk=macosx*]" = "@executable_path/../Frameworks";
|
"LD_RUNPATH_SEARCH_PATHS[sdk=macosx*]" = "@executable_path/../Frameworks";
|
||||||
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
||||||
MARKETING_VERSION = 0.0.2;
|
MARKETING_VERSION = 0.0.4;
|
||||||
PRODUCT_BUNDLE_IDENTIFIER = com.psmattas.Outpost;
|
PRODUCT_BUNDLE_IDENTIFIER = com.psmattas.OutpostApp;
|
||||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||||
|
PROVISIONING_PROFILE_SPECIFIER = "";
|
||||||
REGISTER_APP_GROUPS = YES;
|
REGISTER_APP_GROUPS = YES;
|
||||||
SDKROOT = auto;
|
SDKROOT = auto;
|
||||||
STRING_CATALOG_GENERATE_SYMBOLS = YES;
|
STRING_CATALOG_GENERATE_SYMBOLS = YES;
|
||||||
@@ -430,15 +436,20 @@
|
|||||||
buildSettings = {
|
buildSettings = {
|
||||||
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
|
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
|
||||||
ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
|
ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
|
||||||
|
ASSETCATALOG_COMPILER_INCLUDE_ALL_APPICON_ASSETS = YES;
|
||||||
CODE_SIGN_ENTITLEMENTS = Outpost/Outpost.entitlements;
|
CODE_SIGN_ENTITLEMENTS = Outpost/Outpost.entitlements;
|
||||||
|
CODE_SIGN_IDENTITY = "Apple Development";
|
||||||
|
"CODE_SIGN_IDENTITY[sdk=macosx*]" = "Apple Development";
|
||||||
CODE_SIGN_STYLE = Automatic;
|
CODE_SIGN_STYLE = Automatic;
|
||||||
CURRENT_PROJECT_VERSION = 1;
|
CURRENT_PROJECT_VERSION = 1;
|
||||||
DEVELOPMENT_TEAM = B95H74ZDY6;
|
DEVELOPMENT_TEAM = CW6GQT9SK5;
|
||||||
ENABLE_APP_SANDBOX = YES;
|
ENABLE_APP_SANDBOX = YES;
|
||||||
ENABLE_HARDENED_RUNTIME = YES;
|
ENABLE_HARDENED_RUNTIME = YES;
|
||||||
ENABLE_PREVIEWS = YES;
|
ENABLE_PREVIEWS = YES;
|
||||||
ENABLE_USER_SELECTED_FILES = readonly;
|
ENABLE_USER_SELECTED_FILES = readonly;
|
||||||
GENERATE_INFOPLIST_FILE = YES;
|
GENERATE_INFOPLIST_FILE = YES;
|
||||||
|
INFOPLIST_KEY_CFBundleDisplayName = Outpost;
|
||||||
|
INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.productivity";
|
||||||
"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphoneos*]" = YES;
|
"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphoneos*]" = YES;
|
||||||
"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphonesimulator*]" = YES;
|
"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphonesimulator*]" = YES;
|
||||||
"INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents[sdk=iphoneos*]" = YES;
|
"INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents[sdk=iphoneos*]" = YES;
|
||||||
@@ -453,9 +464,10 @@
|
|||||||
LD_RUNPATH_SEARCH_PATHS = "@executable_path/Frameworks";
|
LD_RUNPATH_SEARCH_PATHS = "@executable_path/Frameworks";
|
||||||
"LD_RUNPATH_SEARCH_PATHS[sdk=macosx*]" = "@executable_path/../Frameworks";
|
"LD_RUNPATH_SEARCH_PATHS[sdk=macosx*]" = "@executable_path/../Frameworks";
|
||||||
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
||||||
MARKETING_VERSION = 0.0.2;
|
MARKETING_VERSION = 0.0.4;
|
||||||
PRODUCT_BUNDLE_IDENTIFIER = com.psmattas.Outpost;
|
PRODUCT_BUNDLE_IDENTIFIER = com.psmattas.OutpostApp;
|
||||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||||
|
PROVISIONING_PROFILE_SPECIFIER = "";
|
||||||
REGISTER_APP_GROUPS = YES;
|
REGISTER_APP_GROUPS = YES;
|
||||||
SDKROOT = auto;
|
SDKROOT = auto;
|
||||||
STRING_CATALOG_GENERATE_SYMBOLS = YES;
|
STRING_CATALOG_GENERATE_SYMBOLS = YES;
|
||||||
@@ -476,7 +488,7 @@
|
|||||||
BUNDLE_LOADER = "$(TEST_HOST)";
|
BUNDLE_LOADER = "$(TEST_HOST)";
|
||||||
CODE_SIGN_STYLE = Automatic;
|
CODE_SIGN_STYLE = Automatic;
|
||||||
CURRENT_PROJECT_VERSION = 1;
|
CURRENT_PROJECT_VERSION = 1;
|
||||||
DEVELOPMENT_TEAM = B95H74ZDY6;
|
DEVELOPMENT_TEAM = CW6GQT9SK5;
|
||||||
GENERATE_INFOPLIST_FILE = YES;
|
GENERATE_INFOPLIST_FILE = YES;
|
||||||
IPHONEOS_DEPLOYMENT_TARGET = 27.0;
|
IPHONEOS_DEPLOYMENT_TARGET = 27.0;
|
||||||
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
||||||
@@ -502,7 +514,7 @@
|
|||||||
BUNDLE_LOADER = "$(TEST_HOST)";
|
BUNDLE_LOADER = "$(TEST_HOST)";
|
||||||
CODE_SIGN_STYLE = Automatic;
|
CODE_SIGN_STYLE = Automatic;
|
||||||
CURRENT_PROJECT_VERSION = 1;
|
CURRENT_PROJECT_VERSION = 1;
|
||||||
DEVELOPMENT_TEAM = B95H74ZDY6;
|
DEVELOPMENT_TEAM = CW6GQT9SK5;
|
||||||
GENERATE_INFOPLIST_FILE = YES;
|
GENERATE_INFOPLIST_FILE = YES;
|
||||||
IPHONEOS_DEPLOYMENT_TARGET = 27.0;
|
IPHONEOS_DEPLOYMENT_TARGET = 27.0;
|
||||||
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
||||||
@@ -527,7 +539,7 @@
|
|||||||
buildSettings = {
|
buildSettings = {
|
||||||
CODE_SIGN_STYLE = Automatic;
|
CODE_SIGN_STYLE = Automatic;
|
||||||
CURRENT_PROJECT_VERSION = 1;
|
CURRENT_PROJECT_VERSION = 1;
|
||||||
DEVELOPMENT_TEAM = B95H74ZDY6;
|
DEVELOPMENT_TEAM = CW6GQT9SK5;
|
||||||
GENERATE_INFOPLIST_FILE = YES;
|
GENERATE_INFOPLIST_FILE = YES;
|
||||||
IPHONEOS_DEPLOYMENT_TARGET = 27.0;
|
IPHONEOS_DEPLOYMENT_TARGET = 27.0;
|
||||||
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
||||||
@@ -552,7 +564,7 @@
|
|||||||
buildSettings = {
|
buildSettings = {
|
||||||
CODE_SIGN_STYLE = Automatic;
|
CODE_SIGN_STYLE = Automatic;
|
||||||
CURRENT_PROJECT_VERSION = 1;
|
CURRENT_PROJECT_VERSION = 1;
|
||||||
DEVELOPMENT_TEAM = B95H74ZDY6;
|
DEVELOPMENT_TEAM = CW6GQT9SK5;
|
||||||
GENERATE_INFOPLIST_FILE = YES;
|
GENERATE_INFOPLIST_FILE = YES;
|
||||||
IPHONEOS_DEPLOYMENT_TARGET = 27.0;
|
IPHONEOS_DEPLOYMENT_TARGET = 27.0;
|
||||||
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
MACOSX_DEPLOYMENT_TARGET = 27.0;
|
||||||
|
|||||||
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"images" : [
|
||||||
|
{
|
||||||
|
"filename" : "outpost-ios-1024.png",
|
||||||
|
"idiom" : "universal",
|
||||||
|
"scale" : "1x"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"idiom" : "universal",
|
||||||
|
"scale" : "2x"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"idiom" : "universal",
|
||||||
|
"scale" : "3x"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"info" : {
|
||||||
|
"author" : "xcode",
|
||||||
|
"version" : 1
|
||||||
|
}
|
||||||
|
}
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 440 KiB |
@@ -2,25 +2,19 @@
|
|||||||
import AppKit
|
import AppKit
|
||||||
import SwiftUI
|
import SwiftUI
|
||||||
|
|
||||||
struct AboutView: View {
|
/// Bare content (icon, name, version, links) with no window chrome — reused
|
||||||
|
/// by both the standalone "About Outpost" window (`AboutView`, the standard
|
||||||
|
/// macOS app-menu affordance) and the Settings page's own About section, so
|
||||||
|
/// the two can't drift out of sync.
|
||||||
|
struct AboutInfoView: View {
|
||||||
private let repositoryURL = URL(string: "https://git.psmattas.com/psmattas/Outpost")!
|
private let repositoryURL = URL(string: "https://git.psmattas.com/psmattas/Outpost")!
|
||||||
private let releasesURL = URL(string: "https://git.psmattas.com/psmattas/Outpost/releases")!
|
private let releasesURL = URL(string: "https://git.psmattas.com/psmattas/Outpost/releases")!
|
||||||
|
|
||||||
private var appName: String {
|
var appName: String {
|
||||||
Bundle.main.object(forInfoDictionaryKey: "CFBundleName") as? String ?? "Outpost"
|
Bundle.main.object(forInfoDictionaryKey: "CFBundleName") as? String ?? "Outpost"
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Bumped alongside `MARKETING_VERSION` in the Xcode project — kept out
|
var versionString: String { OutpostVersion.fullVersionString }
|
||||||
/// of the bundle version itself since `CFBundleShortVersionString` is
|
|
||||||
/// expected to stay a plain dotted-numeric string, not `0.0.1-ALPHA`.
|
|
||||||
private let releaseStage = "ALPHA"
|
|
||||||
|
|
||||||
private var versionString: String {
|
|
||||||
let shortVersion = Bundle.main.object(forInfoDictionaryKey: "CFBundleShortVersionString") as? String ?? "0.0.1"
|
|
||||||
let buildNumber = Bundle.main.object(forInfoDictionaryKey: "CFBundleVersion") as? String ?? "1"
|
|
||||||
let stageSuffix = releaseStage.isEmpty ? "" : "-\(releaseStage)"
|
|
||||||
return "Version \(shortVersion)\(stageSuffix) (\(buildNumber))"
|
|
||||||
}
|
|
||||||
|
|
||||||
private var copyrightYear: String {
|
private var copyrightYear: String {
|
||||||
String(Calendar.current.component(.year, from: Date()))
|
String(Calendar.current.component(.year, from: Date()))
|
||||||
@@ -66,8 +60,6 @@ struct AboutView: View {
|
|||||||
.font(.caption2)
|
.font(.caption2)
|
||||||
.foregroundStyle(.tertiary)
|
.foregroundStyle(.tertiary)
|
||||||
}
|
}
|
||||||
.padding(32)
|
|
||||||
.frame(width: 320)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// No Sparkle-style in-app updater yet — this just opens the releases page
|
// No Sparkle-style in-app updater yet — this just opens the releases page
|
||||||
@@ -76,4 +68,12 @@ struct AboutView: View {
|
|||||||
NSWorkspace.shared.open(releasesURL)
|
NSWorkspace.shared.open(releasesURL)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
struct AboutView: View {
|
||||||
|
var body: some View {
|
||||||
|
AboutInfoView()
|
||||||
|
.padding(32)
|
||||||
|
.frame(width: 320)
|
||||||
|
}
|
||||||
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
#if os(macOS)
|
#if os(macOS)
|
||||||
import SwiftUI
|
import SwiftUI
|
||||||
|
import OutlineKit
|
||||||
|
|
||||||
/// Uses a plain `Button` + `.popover` rather than `Menu`. A `Menu` whose label
|
/// Uses a plain `Button` + `.popover` rather than `Menu`. A `Menu` whose label
|
||||||
/// contains the avatar image reliably broke its own sizing on click (even after
|
/// contains the avatar image reliably broke its own sizing on click (even after
|
||||||
@@ -7,10 +8,11 @@ import SwiftUI
|
|||||||
/// label rendering, which a `Button` doesn't go through.
|
/// label rendering, which a `Button` doesn't go through.
|
||||||
struct AccountFooter: View {
|
struct AccountFooter: View {
|
||||||
@Environment(SessionStore.self) private var session
|
@Environment(SessionStore.self) private var session
|
||||||
|
@Environment(AppNavigation.self) private var navigation
|
||||||
@Environment(\.openURL) private var openURL
|
@Environment(\.openURL) private var openURL
|
||||||
@Environment(\.openWindow) private var openWindow
|
@Environment(\.openWindow) private var openWindow
|
||||||
@Environment(\.openSettings) private var openSettings
|
|
||||||
@AppStorage("outpost.appearance") private var appearance: AppAppearance = .system
|
@AppStorage("outpost.appearance") private var appearance: AppAppearance = .system
|
||||||
|
@AppStorage(CachingOutlineAPIClient.offlineModeDefaultsKey) private var isOfflineModeEnabled = false
|
||||||
@State private var isMenuPresented = false
|
@State private var isMenuPresented = false
|
||||||
@State private var isShowingLogoutConfirmation = false
|
@State private var isShowingLogoutConfirmation = false
|
||||||
@State private var isShowingProfile = false
|
@State private var isShowingProfile = false
|
||||||
@@ -93,8 +95,17 @@ struct AccountFooter: View {
|
|||||||
.padding(.horizontal, 6)
|
.padding(.horizontal, 6)
|
||||||
.padding(.vertical, 4)
|
.padding(.vertical, 4)
|
||||||
|
|
||||||
|
Toggle("Offline Mode", isOn: $isOfflineModeEnabled)
|
||||||
|
.padding(.horizontal, 6)
|
||||||
|
.padding(.vertical, 4)
|
||||||
|
|
||||||
menuItem("Profile…") { isShowingProfile = true }
|
menuItem("Profile…") { isShowingProfile = true }
|
||||||
menuItem("Preferences…") { openSettings() }
|
// Deferred a tick: setting this synchronously in the same call
|
||||||
|
// that dismisses this popover collides two AppKit window/layer
|
||||||
|
// transactions in the same runloop turn (visible in the console
|
||||||
|
// as "Invalid attempt to open a new transaction during CA
|
||||||
|
// commit") — letting the popover's dismissal finish first avoids it.
|
||||||
|
menuItem("Settings…") { Task { @MainActor in navigation.isShowingSettings = true } }
|
||||||
|
|
||||||
Divider()
|
Divider()
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,114 @@
|
|||||||
|
#if os(macOS)
|
||||||
|
import AppKit
|
||||||
|
import SwiftUI
|
||||||
|
|
||||||
|
/// Crop/rotate/zoom editor shown after picking a photo, before it's
|
||||||
|
/// uploaded — pan (drag), zoom (pinch or the slider), and 90°-increment
|
||||||
|
/// rotate, all inside a circular mask matching how the avatar actually
|
||||||
|
/// renders everywhere else in the app.
|
||||||
|
///
|
||||||
|
/// The on-screen preview and the final exported image are built from the
|
||||||
|
/// exact same view composition (`avatarContent`), just instantiated once
|
||||||
|
/// for display and once inside an `ImageRenderer` — that's deliberate:
|
||||||
|
/// hand-deriving a separate set of crop-math for a higher-resolution
|
||||||
|
/// render would risk it silently disagreeing with what the user actually
|
||||||
|
/// saw and confirmed, and there's no way to visually verify that
|
||||||
|
/// agreement without running the app. Reusing the identical view tree
|
||||||
|
/// makes the export WYSIWYG by construction instead of by careful math.
|
||||||
|
struct AvatarCropperView: View {
|
||||||
|
let sourceImage: NSImage
|
||||||
|
let onConfirm: (Data) -> Void
|
||||||
|
let onCancel: () -> Void
|
||||||
|
|
||||||
|
@State private var scale: CGFloat = 1
|
||||||
|
@State private var offset: CGSize = .zero
|
||||||
|
@State private var rotationDegrees: Double = 0
|
||||||
|
@GestureState private var dragTranslation: CGSize = .zero
|
||||||
|
|
||||||
|
/// Used for both the live preview and the exported image — see the
|
||||||
|
/// type-level doc comment for why that's the same size, not two.
|
||||||
|
private let diameter: CGFloat = 320
|
||||||
|
|
||||||
|
var body: some View {
|
||||||
|
VStack(spacing: 20) {
|
||||||
|
Text("Edit Photo")
|
||||||
|
.font(.headline)
|
||||||
|
|
||||||
|
ZStack {
|
||||||
|
avatarContent
|
||||||
|
.clipShape(Circle())
|
||||||
|
Circle()
|
||||||
|
.strokeBorder(Color.primary.opacity(0.15), lineWidth: 1)
|
||||||
|
}
|
||||||
|
.frame(width: diameter, height: diameter)
|
||||||
|
.contentShape(Circle())
|
||||||
|
.gesture(
|
||||||
|
DragGesture()
|
||||||
|
.updating($dragTranslation) { value, state, _ in state = value.translation }
|
||||||
|
.onEnded { value in
|
||||||
|
offset.width += value.translation.width
|
||||||
|
offset.height += value.translation.height
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
HStack(spacing: 16) {
|
||||||
|
Button {
|
||||||
|
withAnimation(.easeInOut(duration: 0.2)) { rotationDegrees -= 90 }
|
||||||
|
} label: {
|
||||||
|
Image(systemName: "rotate.left")
|
||||||
|
}
|
||||||
|
.help("Rotate left")
|
||||||
|
|
||||||
|
Slider(value: $scale, in: 1...4)
|
||||||
|
.frame(width: 140)
|
||||||
|
|
||||||
|
Button {
|
||||||
|
withAnimation(.easeInOut(duration: 0.2)) { rotationDegrees += 90 }
|
||||||
|
} label: {
|
||||||
|
Image(systemName: "rotate.right")
|
||||||
|
}
|
||||||
|
.help("Rotate right")
|
||||||
|
}
|
||||||
|
|
||||||
|
HStack {
|
||||||
|
Button("Cancel", role: .cancel, action: onCancel)
|
||||||
|
Spacer()
|
||||||
|
Button("Use Photo") {
|
||||||
|
if let data = renderFinalImage() {
|
||||||
|
onConfirm(data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.buttonStyle(.borderedProminent)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.padding(24)
|
||||||
|
.frame(width: 360)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Aspect-fills `sourceImage` into a `diameter`×`diameter` square, then
|
||||||
|
/// applies the user's pan/zoom/rotation on top — identical between the
|
||||||
|
/// live preview and the final render (see the type-level doc comment).
|
||||||
|
private var avatarContent: some View {
|
||||||
|
Image(nsImage: sourceImage)
|
||||||
|
.resizable()
|
||||||
|
.aspectRatio(contentMode: .fill)
|
||||||
|
.frame(width: diameter, height: diameter)
|
||||||
|
.scaleEffect(scale)
|
||||||
|
.rotationEffect(.degrees(rotationDegrees))
|
||||||
|
.offset(x: offset.width + dragTranslation.width, y: offset.height + dragTranslation.height)
|
||||||
|
.frame(width: diameter, height: diameter)
|
||||||
|
.clipped()
|
||||||
|
}
|
||||||
|
|
||||||
|
@MainActor
|
||||||
|
private func renderFinalImage() -> Data? {
|
||||||
|
let content = avatarContent
|
||||||
|
.clipShape(Circle())
|
||||||
|
.frame(width: diameter, height: diameter)
|
||||||
|
let renderer = ImageRenderer(content: content)
|
||||||
|
renderer.scale = 2 // @2x so it isn't a blurry 320px avatar on Retina displays
|
||||||
|
guard let nsImage = renderer.nsImage else { return nil }
|
||||||
|
return nsImage.jpegData(compressionQuality: 0.9)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
#if os(macOS)
|
|
||||||
import SwiftUI
|
|
||||||
|
|
||||||
struct PreferencesView: View {
|
|
||||||
@Environment(SessionStore.self) private var session
|
|
||||||
@AppStorage("outpost.appearance") private var appearance: AppAppearance = .system
|
|
||||||
@State private var isShowingLogoutConfirmation = false
|
|
||||||
|
|
||||||
var body: some View {
|
|
||||||
Form {
|
|
||||||
Section("Appearance") {
|
|
||||||
Picker("Appearance", selection: $appearance) {
|
|
||||||
ForEach(AppAppearance.allCases) { option in
|
|
||||||
Text(option.label).tag(option)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
.pickerStyle(.segmented)
|
|
||||||
.labelsHidden()
|
|
||||||
}
|
|
||||||
|
|
||||||
Section("Account") {
|
|
||||||
LabeledContent("Signed in as", value: session.userName ?? "—")
|
|
||||||
if let email = session.userEmail {
|
|
||||||
LabeledContent("Email", value: email)
|
|
||||||
}
|
|
||||||
if let teamName = session.teamName {
|
|
||||||
LabeledContent("Workspace", value: teamName)
|
|
||||||
}
|
|
||||||
|
|
||||||
Button("Log Out…", role: .destructive) {
|
|
||||||
isShowingLogoutConfirmation = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
.formStyle(.grouped)
|
|
||||||
.frame(width: 380, height: 300)
|
|
||||||
.logoutConfirmationDialog(isPresented: $isShowingLogoutConfirmation, session: session)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
#if os(macOS)
|
||||||
|
import SwiftUI
|
||||||
|
import OutlineKit
|
||||||
|
|
||||||
|
/// Swapped into the real sidebar's content slot (search field, collections
|
||||||
|
/// tree, account footer) while Settings is open — same sidebar, different
|
||||||
|
/// content, rather than a separate mini sidebar nested inside a page. "Done"
|
||||||
|
/// clears `AppNavigation.isShowingSettings`, which puts the collections tree
|
||||||
|
/// back.
|
||||||
|
///
|
||||||
|
/// Grouped by `SettingsCategory` — `general` (ours) sits under an "Outpost"
|
||||||
|
/// header at the top, then Outline's own Account/Workspace groups, matching
|
||||||
|
/// the settings page structure of the Outline web app. Outline's own server
|
||||||
|
/// version has no dedicated section (there used to be an Integrations &
|
||||||
|
/// Installation category for just that) — it's cheap enough to show
|
||||||
|
/// unconditionally in the footer here instead, alongside Outpost's own
|
||||||
|
/// version.
|
||||||
|
struct SettingsSidebarList: View {
|
||||||
|
@Binding var selection: SettingsSection?
|
||||||
|
let onDone: () -> Void
|
||||||
|
|
||||||
|
@Environment(SessionStore.self) private var session
|
||||||
|
@AppStorage(CachingOutlineAPIClient.offlineModeDefaultsKey) private var isOfflineModeEnabled = false
|
||||||
|
@State private var outlineVersion: String?
|
||||||
|
|
||||||
|
/// Mirrors `SettingsView`'s own check — a real dropped connection or
|
||||||
|
/// the manual Offline Mode toggle both mean there's no server to ask.
|
||||||
|
private var isEffectivelyOnline: Bool {
|
||||||
|
session.networkMonitor.isOnline && !isOfflineModeEnabled
|
||||||
|
}
|
||||||
|
|
||||||
|
var body: some View {
|
||||||
|
VStack(spacing: 0) {
|
||||||
|
HStack {
|
||||||
|
Text("Settings")
|
||||||
|
.font(.headline)
|
||||||
|
Spacer()
|
||||||
|
}
|
||||||
|
.padding(.horizontal, 16)
|
||||||
|
.padding(.vertical, 12)
|
||||||
|
|
||||||
|
Divider()
|
||||||
|
|
||||||
|
List(selection: $selection) {
|
||||||
|
ForEach(SettingsCategory.allCases) { category in
|
||||||
|
let sections = SettingsSection.allCases.filter { $0.category == category }
|
||||||
|
Section {
|
||||||
|
ForEach(sections) { section in
|
||||||
|
Label(section.title, systemImage: section.icon)
|
||||||
|
.tag(section)
|
||||||
|
}
|
||||||
|
} header: {
|
||||||
|
if let title = category.title {
|
||||||
|
HStack(spacing: 6) {
|
||||||
|
Text(title)
|
||||||
|
// Not hardcoded to `.workspace` specifically —
|
||||||
|
// stays correct on its own as sections get
|
||||||
|
// built, only shows while every section in
|
||||||
|
// the category is still `!isImplemented`.
|
||||||
|
if sections.allSatisfy({ !$0.isImplemented }) {
|
||||||
|
Text("Coming Soon")
|
||||||
|
.font(.system(size: 9, weight: .semibold))
|
||||||
|
.foregroundStyle(.secondary)
|
||||||
|
.padding(.horizontal, 6)
|
||||||
|
.padding(.vertical, 2)
|
||||||
|
.background(.secondary.opacity(0.15), in: Capsule())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.listStyle(.sidebar)
|
||||||
|
|
||||||
|
Divider()
|
||||||
|
|
||||||
|
versionFooter
|
||||||
|
|
||||||
|
Divider()
|
||||||
|
|
||||||
|
Button("Done", action: onDone)
|
||||||
|
.keyboardShortcut(.cancelAction)
|
||||||
|
.buttonStyle(.borderedProminent)
|
||||||
|
.frame(maxWidth: .infinity)
|
||||||
|
.padding(12)
|
||||||
|
}
|
||||||
|
// Keyed to connectivity, not a one-shot `.task {}` — reconnecting
|
||||||
|
// (or turning the manual Offline Mode toggle back off) re-fires
|
||||||
|
// this automatically instead of leaving the footer stuck on
|
||||||
|
// whatever it last knew, or blank, until Settings is reopened.
|
||||||
|
.task(id: isEffectivelyOnline) { await refreshOutlineVersion() }
|
||||||
|
}
|
||||||
|
|
||||||
|
private var versionFooter: some View {
|
||||||
|
VStack(alignment: .leading, spacing: 2) {
|
||||||
|
Text("Outpost \(OutpostVersion.displayString)")
|
||||||
|
if let outlineVersion {
|
||||||
|
Text("Outline \(outlineVersion)")
|
||||||
|
} else if !isEffectivelyOnline {
|
||||||
|
Text("Outline — offline")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.font(.caption2)
|
||||||
|
.foregroundStyle(.tertiary)
|
||||||
|
.frame(maxWidth: .infinity, alignment: .leading)
|
||||||
|
.padding(.horizontal, 16)
|
||||||
|
.padding(.vertical, 8)
|
||||||
|
}
|
||||||
|
|
||||||
|
private func refreshOutlineVersion() async {
|
||||||
|
guard isEffectivelyOnline, let apiClient = session.apiClient else { return }
|
||||||
|
outlineVersion = try? await apiClient.installationInfo().version
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -3,21 +3,17 @@ import SwiftUI
|
|||||||
struct AuthHeaderView: View {
|
struct AuthHeaderView: View {
|
||||||
var body: some View {
|
var body: some View {
|
||||||
VStack(spacing: 12) {
|
VStack(spacing: 12) {
|
||||||
ZStack {
|
// A plain Image Set, not the AppIcon *app icon* asset — App Icon
|
||||||
Circle()
|
// sets aren't reliably resolvable through Image(_:)/UIImage
|
||||||
.fill(
|
// (named:) at runtime (confirmed live: showed nothing). This is
|
||||||
LinearGradient(
|
// the same source artwork (outpost-ios-1024.png) duplicated
|
||||||
colors: [Color.accentColor, Color.accentColor.opacity(0.6)],
|
// into a normal image set so SwiftUI can actually load it.
|
||||||
startPoint: .topLeading,
|
Image("AppLogo")
|
||||||
endPoint: .bottomTrailing
|
.resizable()
|
||||||
)
|
.scaledToFit()
|
||||||
)
|
.frame(width: 72, height: 72)
|
||||||
.frame(width: 64, height: 64)
|
.clipShape(RoundedRectangle(cornerRadius: 72 * 0.2237, style: .continuous))
|
||||||
Image(systemName: "text.book.closed.fill")
|
.shadow(color: .black.opacity(0.25), radius: 12, y: 6)
|
||||||
.font(.system(size: 26, weight: .semibold))
|
|
||||||
.foregroundStyle(.white)
|
|
||||||
}
|
|
||||||
.shadow(color: Color.accentColor.opacity(0.35), radius: 12, y: 6)
|
|
||||||
|
|
||||||
VStack(spacing: 4) {
|
VStack(spacing: 4) {
|
||||||
Text("Welcome to Outpost")
|
Text("Welcome to Outpost")
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ struct CollectionRowView: View {
|
|||||||
} icon: {
|
} icon: {
|
||||||
if let emoji = collection.emojiIcon {
|
if let emoji = collection.emojiIcon {
|
||||||
Text(emoji)
|
Text(emoji)
|
||||||
} else if let symbolName = collection.icon.flatMap(OutlineIconMapping.sfSymbolName) {
|
} else if let symbolName = collection.icon.flatMap({ OutlineIconMapping.sfSymbolName(for: $0) }) {
|
||||||
Image(systemName: symbolName)
|
Image(systemName: symbolName)
|
||||||
.foregroundStyle(tintColor)
|
.foregroundStyle(tintColor)
|
||||||
} else {
|
} else {
|
||||||
|
|||||||
@@ -4,6 +4,8 @@ import OutlineKit
|
|||||||
|
|
||||||
struct ContentView_macOS: View {
|
struct ContentView_macOS: View {
|
||||||
@Environment(SessionStore.self) private var session
|
@Environment(SessionStore.self) private var session
|
||||||
|
@Environment(AppNavigation.self) private var navigation
|
||||||
|
@AppStorage(CachingOutlineAPIClient.offlineModeDefaultsKey) private var isOfflineModeEnabled = false
|
||||||
/// The landing state — no collection selected yet is what Home actually
|
/// The landing state — no collection selected yet is what Home actually
|
||||||
/// means, so this starts `true` rather than auto-selecting the first
|
/// means, so this starts `true` rather than auto-selecting the first
|
||||||
/// collection the way this used to work.
|
/// collection the way this used to work.
|
||||||
@@ -26,11 +28,73 @@ struct ContentView_macOS: View {
|
|||||||
globalSearchQuery.trimmingCharacters(in: .whitespacesAndNewlines)
|
globalSearchQuery.trimmingCharacters(in: .whitespacesAndNewlines)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// `@Environment(AppNavigation.self)` doesn't hand out `$`-bindings on its
|
||||||
|
/// own (that's `@Bindable`'s job, and introducing one in `body` would
|
||||||
|
/// mean restructuring it away from a single implicit-return expression)
|
||||||
|
/// — a manually-built `Binding` over the same reference is simpler here.
|
||||||
|
private var selectedSettingsSectionBinding: Binding<SettingsSection?> {
|
||||||
|
Binding(
|
||||||
|
get: { navigation.selectedSettingsSection },
|
||||||
|
set: { navigation.selectedSettingsSection = $0 }
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
var body: some View {
|
var body: some View {
|
||||||
|
// A totally separate top-level branch, not content swapped inside
|
||||||
|
// one persistent `NavigationSplitView` — that was tried first (an
|
||||||
|
// `if/else` inside a single split view, then an explicit `.id()` on
|
||||||
|
// just the detail pane) and neither reliably replaced the detail
|
||||||
|
// pane's content on macOS: `NavigationSplitView` bridges to
|
||||||
|
// `NSSplitViewController`, and swapping a `NavigationStack` with
|
||||||
|
// real push history for a plain view inside one persisting instance
|
||||||
|
// doesn't propagate the way plain SwiftUI identity rules would
|
||||||
|
// suggest. A different `if` branch is a genuinely different view
|
||||||
|
// hierarchy, so there's no existing split view instance for AppKit
|
||||||
|
// to get confused about reusing.
|
||||||
|
if navigation.isShowingSettings {
|
||||||
|
settingsContent
|
||||||
|
} else {
|
||||||
|
mainContent
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private var settingsContent: some View {
|
||||||
|
NavigationSplitView {
|
||||||
|
SettingsSidebarList(
|
||||||
|
selection: selectedSettingsSectionBinding,
|
||||||
|
onDone: { navigation.isShowingSettings = false }
|
||||||
|
)
|
||||||
|
.navigationSplitViewColumnWidth(min: 220, ideal: 260)
|
||||||
|
} detail: {
|
||||||
|
SettingsView(section: navigation.selectedSettingsSection ?? .appearance)
|
||||||
|
}
|
||||||
|
.navigationTitle("")
|
||||||
|
.toolbar {
|
||||||
|
ToolbarItem(placement: .navigation) {
|
||||||
|
HStack(spacing: 6) {
|
||||||
|
Image(systemName: "gearshape.fill")
|
||||||
|
Text("Settings")
|
||||||
|
}
|
||||||
|
.font(.headline)
|
||||||
|
.padding(.horizontal, 10)
|
||||||
|
.padding(.vertical, 4)
|
||||||
|
.background(.fill.tertiary, in: Capsule())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private var mainContent: some View {
|
||||||
NavigationSplitView {
|
NavigationSplitView {
|
||||||
VStack(spacing: 0) {
|
VStack(spacing: 0) {
|
||||||
SidebarSearchField(text: $globalSearchQuery)
|
SidebarSearchField(text: $globalSearchQuery)
|
||||||
Divider()
|
Divider()
|
||||||
|
if isOfflineModeEnabled {
|
||||||
|
OfflineBanner(isManual: true)
|
||||||
|
Divider()
|
||||||
|
} else if !session.networkMonitor.isOnline {
|
||||||
|
OfflineConnectionPromptBanner(onEnableOfflineMode: { isOfflineModeEnabled = true })
|
||||||
|
Divider()
|
||||||
|
}
|
||||||
sidebar
|
sidebar
|
||||||
AccountFooter()
|
AccountFooter()
|
||||||
}
|
}
|
||||||
@@ -92,6 +156,7 @@ struct ContentView_macOS: View {
|
|||||||
isContextualSearchExpanded = false
|
isContextualSearchExpanded = false
|
||||||
selectedCollection = nil
|
selectedCollection = nil
|
||||||
isShowingHome = true
|
isShowingHome = true
|
||||||
|
navigation.isShowingSettings = false
|
||||||
replaceDocumentPath(with: [])
|
replaceDocumentPath(with: [])
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ import OutlineKit
|
|||||||
struct DocumentReaderView: View {
|
struct DocumentReaderView: View {
|
||||||
@Environment(SessionStore.self) private var session
|
@Environment(SessionStore.self) private var session
|
||||||
@Environment(StarStore.self) private var starStore
|
@Environment(StarStore.self) private var starStore
|
||||||
|
@AppStorage(CachingOutlineAPIClient.offlineModeDefaultsKey) private var isOfflineModeEnabled = false
|
||||||
|
|
||||||
@State private var viewModel: DocumentReaderViewModel
|
@State private var viewModel: DocumentReaderViewModel
|
||||||
let apiClient: OutlineAPIClient
|
let apiClient: OutlineAPIClient
|
||||||
@@ -56,6 +57,15 @@ struct DocumentReaderView: View {
|
|||||||
self.onDocumentCreated = onDocumentCreated
|
self.onDocumentCreated = onDocumentCreated
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// New Document, editing, pin/star/subscribe, and Full Width all queue
|
||||||
|
/// and sync later (see `CachingOutlineAPIClient`) — everything else here
|
||||||
|
/// (sharing, permissions, move/archive/delete/duplicate/templatize,
|
||||||
|
/// history, insights, export) hits the server directly with no offline
|
||||||
|
/// path, so it's disabled rather than left to fail confusingly on tap.
|
||||||
|
private var isEffectivelyOnline: Bool {
|
||||||
|
session.networkMonitor.isOnline && !isOfflineModeEnabled
|
||||||
|
}
|
||||||
|
|
||||||
var body: some View {
|
var body: some View {
|
||||||
ScrollView {
|
ScrollView {
|
||||||
VStack(alignment: .leading, spacing: 12) {
|
VStack(alignment: .leading, spacing: 12) {
|
||||||
@@ -82,6 +92,7 @@ struct DocumentReaderView: View {
|
|||||||
NativeTextViewWrapper(
|
NativeTextViewWrapper(
|
||||||
text: $viewModel.text,
|
text: $viewModel.text,
|
||||||
configuration: .init(heightBehavior: .fitsContent),
|
configuration: .init(heightBehavior: .fitsContent),
|
||||||
|
documentId: viewModel.documentId,
|
||||||
isEditable: viewModel.isEditing
|
isEditable: viewModel.isEditing
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -110,7 +121,8 @@ struct DocumentReaderView: View {
|
|||||||
} label: {
|
} label: {
|
||||||
Image(systemName: "square.and.arrow.up")
|
Image(systemName: "square.and.arrow.up")
|
||||||
}
|
}
|
||||||
.help("Share")
|
.help(isEffectivelyOnline ? "Share" : "Sharing needs an internet connection")
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
.popover(isPresented: $isShowingShareSheet, arrowEdge: .bottom) {
|
.popover(isPresented: $isShowingShareSheet, arrowEdge: .bottom) {
|
||||||
DocumentShareSheet(apiClient: apiClient, documentId: viewModel.documentId)
|
DocumentShareSheet(apiClient: apiClient, documentId: viewModel.documentId)
|
||||||
}
|
}
|
||||||
@@ -235,7 +247,8 @@ struct DocumentReaderView: View {
|
|||||||
viewModel.isPinned,
|
viewModel.isPinned,
|
||||||
viewModel.isInsightsEnabled ?? false,
|
viewModel.isInsightsEnabled ?? false,
|
||||||
viewModel.isFullWidth,
|
viewModel.isFullWidth,
|
||||||
viewModel.isEditing
|
viewModel.isEditing,
|
||||||
|
isEffectivelyOnline
|
||||||
].map(String.init).joined(separator: "-")
|
].map(String.init).joined(separator: "-")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -305,27 +318,33 @@ struct DocumentReaderView: View {
|
|||||||
Button("Permissions…") {
|
Button("Permissions…") {
|
||||||
isShowingShareSheet = true
|
isShowingShareSheet = true
|
||||||
}
|
}
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
|
|
||||||
Divider()
|
Divider()
|
||||||
|
|
||||||
Button("Templatize") {
|
Button("Templatize") {
|
||||||
Task { await templatize() }
|
Task { await templatize() }
|
||||||
}
|
}
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
Button("Duplicate") {
|
Button("Duplicate") {
|
||||||
Task { await duplicate() }
|
Task { await duplicate() }
|
||||||
}
|
}
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
Button("Unpublish") {
|
Button("Unpublish") {
|
||||||
isShowingUnpublishConfirmation = true
|
isShowingUnpublishConfirmation = true
|
||||||
}
|
}
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
Button("Archive…") {
|
Button("Archive…") {
|
||||||
isShowingArchiveConfirmation = true
|
isShowingArchiveConfirmation = true
|
||||||
}
|
}
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
|
|
||||||
Divider()
|
Divider()
|
||||||
|
|
||||||
Button("Move") {
|
Button("Move") {
|
||||||
isShowingMoveSheet = true
|
isShowingMoveSheet = true
|
||||||
}
|
}
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
// Multipart file upload is its own subsystem — deferred rather than
|
// Multipart file upload is its own subsystem — deferred rather than
|
||||||
// half-built here.
|
// half-built here.
|
||||||
Button("Import Document…") {}
|
Button("Import Document…") {}
|
||||||
@@ -342,9 +361,13 @@ struct DocumentReaderView: View {
|
|||||||
Button("History") {
|
Button("History") {
|
||||||
isShowingHistorySheet = true
|
isShowingHistorySheet = true
|
||||||
}
|
}
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
Button("Insights") {
|
Button("Insights") {
|
||||||
isShowingInsightsSheet = true
|
isShowingInsightsSheet = true
|
||||||
}
|
}
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
|
// Present/Search in Document both read `documents.info`, which is
|
||||||
|
// read-through cached — they work offline on whatever's cached.
|
||||||
Button("Present") {
|
Button("Present") {
|
||||||
isShowingPresentSheet = true
|
isShowingPresentSheet = true
|
||||||
}
|
}
|
||||||
@@ -354,6 +377,7 @@ struct DocumentReaderView: View {
|
|||||||
Button("Download") {
|
Button("Download") {
|
||||||
Task { await download() }
|
Task { await download() }
|
||||||
}
|
}
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
Button("Copy") {
|
Button("Copy") {
|
||||||
Task { await copyMarkdown() }
|
Task { await copyMarkdown() }
|
||||||
}
|
}
|
||||||
@@ -370,6 +394,7 @@ struct DocumentReaderView: View {
|
|||||||
get: { viewModel.isInsightsEnabled ?? false },
|
get: { viewModel.isInsightsEnabled ?? false },
|
||||||
set: { _ in Task { await toggleInsights() } }
|
set: { _ in Task { await toggleInsights() } }
|
||||||
))
|
))
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
// Confirmed against a live server: there's no per-document embeds
|
// Confirmed against a live server: there's no per-document embeds
|
||||||
// field. Only a workspace-level setting exists, and that's not
|
// field. Only a workspace-level setting exists, and that's not
|
||||||
// reachable via the API either (no `team.update` endpoint in the
|
// reachable via the API either (no `team.update` endpoint in the
|
||||||
@@ -386,6 +411,7 @@ struct DocumentReaderView: View {
|
|||||||
Button("Delete…", role: .destructive) {
|
Button("Delete…", role: .destructive) {
|
||||||
isShowingDeleteConfirmation = true
|
isShowingDeleteConfirmation = true
|
||||||
}
|
}
|
||||||
|
.disabled(!isEffectivelyOnline)
|
||||||
}
|
}
|
||||||
|
|
||||||
private func star() async {
|
private func star() async {
|
||||||
|
|||||||
@@ -0,0 +1,27 @@
|
|||||||
|
#if os(macOS)
|
||||||
|
import SwiftUI
|
||||||
|
|
||||||
|
/// Shown at the top of the sidebar whenever the app is offline — either for
|
||||||
|
/// real (`NetworkMonitor` reports no connection) or because the user turned
|
||||||
|
/// on the manual "Offline Mode" toggle. Cached collections/documents keep
|
||||||
|
/// browsing working either way, but the user should know they might be
|
||||||
|
/// looking at stale data.
|
||||||
|
struct OfflineBanner: View {
|
||||||
|
/// Whether this is the user's own "Offline Mode" toggle rather than a
|
||||||
|
/// real dropped connection — same banner slot, different explanation.
|
||||||
|
var isManual: Bool = false
|
||||||
|
|
||||||
|
var body: some View {
|
||||||
|
HStack(spacing: 8) {
|
||||||
|
Image(systemName: "wifi.slash")
|
||||||
|
.foregroundStyle(.orange)
|
||||||
|
Text(isManual ? "Offline Mode — showing cached content" : "Offline — showing cached content")
|
||||||
|
.font(.callout)
|
||||||
|
Spacer(minLength: 0)
|
||||||
|
}
|
||||||
|
.padding(.horizontal, 12)
|
||||||
|
.padding(.vertical, 8)
|
||||||
|
.background(Color.orange.opacity(0.12))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
#if os(macOS)
|
||||||
|
import SwiftUI
|
||||||
|
|
||||||
|
/// Shown in the sidebar when the network is actually down and the user
|
||||||
|
/// hasn't turned on Offline Mode themselves yet. Deliberately doesn't change
|
||||||
|
/// any fetch behavior on its own — reads still try live and fall back to
|
||||||
|
/// cache the normal way (see `CachingOutlineAPIClient`) until the user
|
||||||
|
/// actually taps the button here, same as `RemoteChangesBanner` never
|
||||||
|
/// auto-refreshes on their behalf either.
|
||||||
|
struct OfflineConnectionPromptBanner: View {
|
||||||
|
let onEnableOfflineMode: () -> Void
|
||||||
|
|
||||||
|
var body: some View {
|
||||||
|
HStack(spacing: 8) {
|
||||||
|
Image(systemName: "wifi.slash")
|
||||||
|
.foregroundStyle(.orange)
|
||||||
|
Text("No connection")
|
||||||
|
.font(.callout)
|
||||||
|
Spacer(minLength: 8)
|
||||||
|
Button("Turn On Offline Mode", action: onEnableOfflineMode)
|
||||||
|
.buttonStyle(.borderedProminent)
|
||||||
|
.tint(.orange)
|
||||||
|
.controlSize(.small)
|
||||||
|
}
|
||||||
|
.padding(.horizontal, 12)
|
||||||
|
.padding(.vertical, 8)
|
||||||
|
.background(Color.orange.opacity(0.12))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
@@ -57,25 +57,33 @@ final class HomeViewModel {
|
|||||||
/// Fetches fresh pinned docs and the current tab's documents to compare
|
/// Fetches fresh pinned docs and the current tab's documents to compare
|
||||||
/// against what's displayed, without replacing either. Bails silently
|
/// against what's displayed, without replacing either. Bails silently
|
||||||
/// on a fetch failure rather than treating it as "changed" — a
|
/// on a fetch failure rather than treating it as "changed" — a
|
||||||
/// transient network hiccup shouldn't pop the refresh banner.
|
/// transient network hiccup (or, offline, `listPins` failing outright —
|
||||||
|
/// it isn't one of the cached endpoints) shouldn't pop the refresh
|
||||||
|
/// banner. This needs the *throwing* pinned-fetch specifically: the
|
||||||
|
/// plain `fetchPinned()` used elsewhere collapses any failure to `[]`,
|
||||||
|
/// which used to read here as "pins changed" against whatever was
|
||||||
|
/// already displayed and falsely popped the banner on every offline
|
||||||
|
/// poll.
|
||||||
func checkForRemoteChanges(tab: HomeTab) async {
|
func checkForRemoteChanges(tab: HomeTab) async {
|
||||||
async let freshPinned = fetchPinned()
|
async let freshPinnedTask = fetchPinnedThrowing()
|
||||||
guard let freshTab = try? await fetch(tab: tab) else { return }
|
guard let freshTab = try? await fetch(tab: tab) else { return }
|
||||||
let pinned = await freshPinned
|
guard let pinned = try? await freshPinnedTask else { return }
|
||||||
if Self.fingerprint(pinned) != Self.fingerprint(pinnedDocuments)
|
if Self.fingerprint(pinned) != Self.fingerprint(pinnedDocuments)
|
||||||
|| Self.fingerprint(freshTab) != Self.fingerprint(documents(for: tab)) {
|
|| Self.fingerprint(freshTab) != Self.fingerprint(documents(for: tab)) {
|
||||||
hasRemoteChanges = true
|
hasRemoteChanges = true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private func fetchPinned() async -> [OutlineDocument] {
|
||||||
|
(try? await fetchPinnedThrowing()) ?? []
|
||||||
|
}
|
||||||
|
|
||||||
/// `pins.list` only returns pin records, not the documents themselves —
|
/// `pins.list` only returns pin records, not the documents themselves —
|
||||||
/// fetches each pinned document individually. Pins are a small curated
|
/// fetches each pinned document individually. Pins are a small curated
|
||||||
/// set (unlike a full collection tree), so the N+1 here is acceptable
|
/// set (unlike a full collection tree), so the N+1 here is acceptable
|
||||||
/// where it wouldn't be in the sidebar.
|
/// where it wouldn't be in the sidebar.
|
||||||
private func fetchPinned() async -> [OutlineDocument] {
|
private func fetchPinnedThrowing() async throws -> [OutlineDocument] {
|
||||||
guard let pins = try? await apiClient.listPins(ListPinsRequest(collectionId: nil)) else {
|
let pins = try await apiClient.listPins(ListPinsRequest(collectionId: nil))
|
||||||
return []
|
|
||||||
}
|
|
||||||
var documents: [OutlineDocument] = []
|
var documents: [OutlineDocument] = []
|
||||||
for pin in pins {
|
for pin in pins {
|
||||||
if let document = try? await apiClient.documentInfo(id: pin.documentId) {
|
if let document = try? await apiClient.documentInfo(id: pin.documentId) {
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ import AppKit
|
|||||||
@main
|
@main
|
||||||
struct OutpostApp: App {
|
struct OutpostApp: App {
|
||||||
@State private var session = SessionStore()
|
@State private var session = SessionStore()
|
||||||
|
@State private var navigation = AppNavigation()
|
||||||
@AppStorage("outpost.appearance") private var appearance: AppAppearance = .system
|
@AppStorage("outpost.appearance") private var appearance: AppAppearance = .system
|
||||||
|
|
||||||
#if os(macOS)
|
#if os(macOS)
|
||||||
@@ -25,6 +26,7 @@ struct OutpostApp: App {
|
|||||||
WindowGroup {
|
WindowGroup {
|
||||||
RootView()
|
RootView()
|
||||||
.environment(session)
|
.environment(session)
|
||||||
|
.environment(navigation)
|
||||||
#if os(iOS)
|
#if os(iOS)
|
||||||
.preferredColorScheme(appearance.colorScheme)
|
.preferredColorScheme(appearance.colorScheme)
|
||||||
#endif
|
#endif
|
||||||
@@ -41,6 +43,16 @@ struct OutpostApp: App {
|
|||||||
openWindow(id: "about")
|
openWindow(id: "about")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
// No `Settings {}` scene anymore — Settings renders inside the
|
||||||
|
// root window (see `AppNavigation`), not a separate popup, so
|
||||||
|
// ⌘, has to be wired up by hand instead of coming for free.
|
||||||
|
CommandGroup(replacing: .appSettings) {
|
||||||
|
Button("Settings…") {
|
||||||
|
navigation.isShowingSettings = true
|
||||||
|
}
|
||||||
|
.keyboardShortcut(",")
|
||||||
|
.disabled(!session.isSignedIn)
|
||||||
|
}
|
||||||
CommandGroup(after: .appSettings) {
|
CommandGroup(after: .appSettings) {
|
||||||
Divider()
|
Divider()
|
||||||
Button("Log Out…") {
|
Button("Log Out…") {
|
||||||
@@ -63,11 +75,6 @@ struct OutpostApp: App {
|
|||||||
.disablesFullScreen()
|
.disablesFullScreen()
|
||||||
}
|
}
|
||||||
.windowResizability(.contentSize)
|
.windowResizability(.contentSize)
|
||||||
|
|
||||||
Settings {
|
|
||||||
PreferencesView()
|
|
||||||
.environment(session)
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,137 @@
|
|||||||
|
import Observation
|
||||||
|
|
||||||
|
/// Top-level groupings shown as section headers in `SettingsSidebarList`.
|
||||||
|
/// `general` holds everything that's ours, not Outline's own settings
|
||||||
|
/// categories — labeled "Outpost" so it reads as clearly distinct from the
|
||||||
|
/// Outline-sourced groups below it.
|
||||||
|
enum SettingsCategory: String, CaseIterable, Identifiable {
|
||||||
|
case general
|
||||||
|
case account
|
||||||
|
case workspace
|
||||||
|
|
||||||
|
var id: String { rawValue }
|
||||||
|
|
||||||
|
var title: String? {
|
||||||
|
switch self {
|
||||||
|
case .general: return "Outpost"
|
||||||
|
case .account: return "Account"
|
||||||
|
case .workspace: return "Workspace"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// One entry in the Settings sidebar. Mirrors Outline's own settings
|
||||||
|
/// categories (Account/Workspace) so this app's settings read as a native
|
||||||
|
/// counterpart to the web app's, plus a `general` group for things that are
|
||||||
|
/// ours and don't map onto Outline's structure (offline/sync, advanced,
|
||||||
|
/// about, appearance). Outline's own version info moved to the sidebar
|
||||||
|
/// footer (`SettingsSidebarList`) instead of a standalone
|
||||||
|
/// Integrations & Installation section.
|
||||||
|
///
|
||||||
|
/// Most of the Account/Workspace cases are navigation-only for now —
|
||||||
|
/// `SettingsView` renders a "Coming Soon" placeholder for anything not
|
||||||
|
/// explicitly built yet. Content lands section by section.
|
||||||
|
enum SettingsSection: String, CaseIterable, Identifiable, Hashable {
|
||||||
|
// General (ours)
|
||||||
|
case appearance, offlineSync, advanced, about
|
||||||
|
|
||||||
|
// Account
|
||||||
|
case profile, preferences, notifications, passkeys, apiAccess
|
||||||
|
|
||||||
|
// Workspace
|
||||||
|
case details, authentication, security, ai, members, groups, templates, emojis, applications, shared, links, webhooks, importData, exportData
|
||||||
|
|
||||||
|
var id: String { rawValue }
|
||||||
|
|
||||||
|
var category: SettingsCategory {
|
||||||
|
switch self {
|
||||||
|
case .appearance, .offlineSync, .advanced, .about:
|
||||||
|
return .general
|
||||||
|
case .profile, .preferences, .notifications, .passkeys, .apiAccess:
|
||||||
|
return .account
|
||||||
|
case .details, .authentication, .security, .ai, .members, .groups, .templates, .emojis, .applications, .shared, .links, .webhooks, .importData, .exportData:
|
||||||
|
return .workspace
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var title: String {
|
||||||
|
switch self {
|
||||||
|
case .appearance: return "Appearance"
|
||||||
|
case .offlineSync: return "Offline & Sync"
|
||||||
|
case .advanced: return "Advanced"
|
||||||
|
case .about: return "About"
|
||||||
|
case .profile: return "Profile"
|
||||||
|
case .preferences: return "Preferences"
|
||||||
|
case .notifications: return "Notifications"
|
||||||
|
case .passkeys: return "Passkeys"
|
||||||
|
case .apiAccess: return "API & Access"
|
||||||
|
case .details: return "Details"
|
||||||
|
case .authentication: return "Authentication"
|
||||||
|
case .security: return "Security"
|
||||||
|
case .ai: return "AI"
|
||||||
|
case .members: return "Members"
|
||||||
|
case .groups: return "Groups"
|
||||||
|
case .templates: return "Templates"
|
||||||
|
case .emojis: return "Emojis"
|
||||||
|
case .applications: return "Applications"
|
||||||
|
case .shared: return "Shared"
|
||||||
|
case .links: return "Links"
|
||||||
|
case .webhooks: return "Webhooks"
|
||||||
|
case .importData: return "Import"
|
||||||
|
case .exportData: return "Export"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var icon: String {
|
||||||
|
switch self {
|
||||||
|
case .appearance: return "paintbrush"
|
||||||
|
case .offlineSync: return "arrow.triangle.2.circlepath"
|
||||||
|
case .advanced: return "wrench.and.screwdriver"
|
||||||
|
case .about: return "info.circle"
|
||||||
|
case .profile: return "person.crop.circle"
|
||||||
|
case .preferences: return "gearshape"
|
||||||
|
case .notifications: return "bell"
|
||||||
|
case .passkeys: return "key"
|
||||||
|
case .apiAccess: return "chevron.left.forwardslash.chevron.right"
|
||||||
|
case .details: return "building.2"
|
||||||
|
case .authentication: return "lock"
|
||||||
|
case .security: return "shield"
|
||||||
|
case .ai: return "sparkles"
|
||||||
|
case .members: return "person.2"
|
||||||
|
case .groups: return "person.3"
|
||||||
|
case .templates: return "doc.on.doc"
|
||||||
|
case .emojis: return "face.smiling"
|
||||||
|
case .applications: return "app.badge"
|
||||||
|
case .shared: return "square.and.arrow.up.on.square"
|
||||||
|
case .links: return "link"
|
||||||
|
case .webhooks: return "bolt.horizontal"
|
||||||
|
case .importData: return "square.and.arrow.down"
|
||||||
|
case .exportData: return "square.and.arrow.up"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Everything actually built so far — everything else in Account/
|
||||||
|
/// Workspace renders a "Coming Soon" placeholder until its content is
|
||||||
|
/// specified and built.
|
||||||
|
var isImplemented: Bool {
|
||||||
|
switch self {
|
||||||
|
case .appearance, .offlineSync, .advanced, .about, .profile, .preferences, .notifications, .passkeys, .apiAccess:
|
||||||
|
return true
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Cross-cutting UI state that doesn't belong to any one screen. Lives at
|
||||||
|
/// `OutpostApp` (so both `RootView`'s content and its `⌘,` command can reach
|
||||||
|
/// it) and is read wherever something needs to open Settings (the profile
|
||||||
|
/// menu) or render it — as a swap of the *existing* sidebar/detail panes in
|
||||||
|
/// `ContentView_macOS`, not a separate popup window or an overlay that hides
|
||||||
|
/// the sidebar.
|
||||||
|
@Observable
|
||||||
|
@MainActor
|
||||||
|
final class AppNavigation {
|
||||||
|
var isShowingSettings = false
|
||||||
|
var selectedSettingsSection: SettingsSection? = .appearance
|
||||||
|
}
|
||||||
@@ -5,6 +5,19 @@ struct RootView: View {
|
|||||||
@Environment(SessionStore.self) private var session
|
@Environment(SessionStore.self) private var session
|
||||||
@State private var welcomeName: String?
|
@State private var welcomeName: String?
|
||||||
@State private var starStore = StarStore()
|
@State private var starStore = StarStore()
|
||||||
|
@AppStorage("outpost.fullLocalSyncEnabled") private var isFullLocalSyncEnabled = false
|
||||||
|
@AppStorage(CachingOutlineAPIClient.offlineModeDefaultsKey) private var isOfflineModeEnabled = false
|
||||||
|
|
||||||
|
/// Real connectivity is only half of "can talk to the server" — the
|
||||||
|
/// manual Offline Mode toggle is the other half. Syncing needs to
|
||||||
|
/// resume on either one clearing, not just a real reconnect: turning
|
||||||
|
/// the toggle off while the network had been up the whole time never
|
||||||
|
/// changes `networkMonitor.isOnline`, so keying the flush task off that
|
||||||
|
/// alone left pending operations stuck until the next real network
|
||||||
|
/// blip.
|
||||||
|
private var isEffectivelyOnline: Bool {
|
||||||
|
session.networkMonitor.isOnline && !isOfflineModeEnabled
|
||||||
|
}
|
||||||
|
|
||||||
var body: some View {
|
var body: some View {
|
||||||
ZStack {
|
ZStack {
|
||||||
@@ -32,6 +45,48 @@ struct RootView: View {
|
|||||||
starStore.reset()
|
starStore.reset()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
// Replay whatever queued up while offline the moment either signal
|
||||||
|
// clears — a real reconnect, or the user turning Offline Mode back
|
||||||
|
// off — no need to wait for the user to open Settings and hit Retry.
|
||||||
|
// Also catches Full Local Sync back up immediately, rather than
|
||||||
|
// leaving it to wait out the rest of the periodic loop below.
|
||||||
|
//
|
||||||
|
// The flush itself gets a retry loop with a cooloff, not just one
|
||||||
|
// attempt: a single transient failure (one bad operation, a blip
|
||||||
|
// mid-flush) used to leave everything else stuck until the user
|
||||||
|
// manually hit Retry or connectivity changed again. Keeps retrying
|
||||||
|
// every 5 minutes for as long as *anything* is still pending and
|
||||||
|
// this signal stays on — stops on its own once the queue is empty,
|
||||||
|
// and `.task(id:)` cancels/restarts it automatically if
|
||||||
|
// isEffectivelyOnline flips again in the meantime.
|
||||||
|
.task(id: isEffectivelyOnline) {
|
||||||
|
guard isEffectivelyOnline, let cachingClient = session.cachingClient else { return }
|
||||||
|
if isFullLocalSyncEnabled {
|
||||||
|
_ = await cachingClient.performFullSync()
|
||||||
|
}
|
||||||
|
while !Task.isCancelled {
|
||||||
|
_ = await cachingClient.flushPendingOperations()
|
||||||
|
let remaining = await cachingClient.pendingOperations()
|
||||||
|
guard !remaining.isEmpty else { break }
|
||||||
|
try? await Task.sleep(for: .seconds(300))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Fully automatic — this is the only place Full Local Sync actually
|
||||||
|
// runs from (Settings' "Sync Now" is just an on-demand nudge at the
|
||||||
|
// same call). Syncs immediately whenever this task (re)starts, which
|
||||||
|
// covers both "just switched on" and "was already on at launch" —
|
||||||
|
// `.task(id:)` restarts on either, an `@AppStorage`-backed toggle
|
||||||
|
// changing anywhere updates every view reading that key — then every
|
||||||
|
// 20 minutes after, for as long as it stays enabled.
|
||||||
|
.task(id: isFullLocalSyncEnabled) {
|
||||||
|
guard isFullLocalSyncEnabled else { return }
|
||||||
|
while !Task.isCancelled {
|
||||||
|
if isEffectivelyOnline, let cachingClient = session.cachingClient {
|
||||||
|
_ = await cachingClient.performFullSync()
|
||||||
|
}
|
||||||
|
try? await Task.sleep(for: .seconds(1200))
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private func startWelcomeTransition(_ result: AuthViewModel.AuthResult) {
|
private func startWelcomeTransition(_ result: AuthViewModel.AuthResult) {
|
||||||
|
|||||||
@@ -11,12 +11,26 @@ final class SessionStore {
|
|||||||
private let defaults: UserDefaults
|
private let defaults: UserDefaults
|
||||||
|
|
||||||
var isSignedIn: Bool
|
var isSignedIn: Bool
|
||||||
|
private(set) var userId: String?
|
||||||
var userName: String?
|
var userName: String?
|
||||||
var userEmail: String?
|
var userEmail: String?
|
||||||
var userAvatarURL: URL?
|
var userAvatarURL: URL?
|
||||||
|
var userLanguage: String?
|
||||||
|
var userPreferences: OutlineUserPreferences?
|
||||||
|
var userNotificationSettings: [String: Bool]?
|
||||||
var teamName: String?
|
var teamName: String?
|
||||||
var teamAvatarURL: URL?
|
var teamAvatarURL: URL?
|
||||||
private(set) var apiClient: OutlineAPIClient?
|
private(set) var apiClient: OutlineAPIClient?
|
||||||
|
/// Same object as `apiClient` when the offline cache is available — kept
|
||||||
|
/// as a separately-typed reference so Settings can reach cache/sync-queue
|
||||||
|
/// specific methods (`flushPendingOperations`, `performFullSync`, etc.)
|
||||||
|
/// without downcasting the protocol-typed `apiClient` everywhere.
|
||||||
|
private(set) var cachingClient: CachingOutlineAPIClient?
|
||||||
|
let networkMonitor = NetworkMonitor()
|
||||||
|
/// `nil` only if the on-disk SwiftData store failed to open (e.g. disk
|
||||||
|
/// full) — in that case `apiClient` falls back to talking to the server
|
||||||
|
/// directly with no offline cache, rather than failing sign-in outright.
|
||||||
|
private let cacheStore: OfflineCacheStore?
|
||||||
|
|
||||||
var serverURL: URL? {
|
var serverURL: URL? {
|
||||||
defaults.string(forKey: Self.serverURLDefaultsKey).flatMap(URL.init(string:))
|
defaults.string(forKey: Self.serverURLDefaultsKey).flatMap(URL.init(string:))
|
||||||
@@ -25,36 +39,66 @@ final class SessionStore {
|
|||||||
init(tokenStore: TokenStoring = KeychainTokenStore(), defaults: UserDefaults = .standard) {
|
init(tokenStore: TokenStoring = KeychainTokenStore(), defaults: UserDefaults = .standard) {
|
||||||
self.tokenStore = tokenStore
|
self.tokenStore = tokenStore
|
||||||
self.defaults = defaults
|
self.defaults = defaults
|
||||||
self.isSignedIn = (try? tokenStore.token()) != nil
|
self.cacheStore = (try? OfflineCacheStore.makeContainer()).map(OfflineCacheStore.init(modelContainer:))
|
||||||
|
|
||||||
if isSignedIn, let serverURL {
|
let hasToken = (try? tokenStore.token()) != nil
|
||||||
apiClient = LiveOutlineAPIClient(
|
let storedServerURL = defaults.string(forKey: Self.serverURLDefaultsKey).flatMap(URL.init(string:))
|
||||||
configuration: OutlineConfiguration(baseURL: serverURL),
|
|
||||||
tokenStore: tokenStore
|
if hasToken, let storedServerURL {
|
||||||
)
|
isSignedIn = true
|
||||||
|
(apiClient, cachingClient) = Self.makeAPIClient(serverURL: storedServerURL, tokenStore: tokenStore, cache: cacheStore)
|
||||||
|
} else {
|
||||||
|
// Keychain and the sandboxed UserDefaults container don't
|
||||||
|
// always survive together — a Keychain item written by an
|
||||||
|
// older-signed build can outlive a reinstall that wipes the
|
||||||
|
// container (or vice versa), leaving a token with no server or
|
||||||
|
// a server with no token. Clear whichever half survived rather
|
||||||
|
// than showing a broken "signed in" UI with no working
|
||||||
|
// apiClient — a fresh sign-in rewrites both consistently.
|
||||||
|
if hasToken {
|
||||||
|
try? tokenStore.clear()
|
||||||
|
}
|
||||||
|
defaults.removeObject(forKey: Self.serverURLDefaultsKey)
|
||||||
|
isSignedIn = false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func signIn(serverURL: URL, user: OutlineUser, team: OutlineTeam) {
|
func signIn(serverURL: URL, user: OutlineUser, team: OutlineTeam) {
|
||||||
defaults.set(serverURL.absoluteString, forKey: Self.serverURLDefaultsKey)
|
defaults.set(serverURL.absoluteString, forKey: Self.serverURLDefaultsKey)
|
||||||
apiClient = LiveOutlineAPIClient(
|
(apiClient, cachingClient) = Self.makeAPIClient(serverURL: serverURL, tokenStore: tokenStore, cache: cacheStore)
|
||||||
|
apply(user: user, team: team, serverURL: serverURL)
|
||||||
|
isSignedIn = true
|
||||||
|
}
|
||||||
|
|
||||||
|
private static func makeAPIClient(
|
||||||
|
serverURL: URL,
|
||||||
|
tokenStore: TokenStoring,
|
||||||
|
cache: OfflineCacheStore?
|
||||||
|
) -> (OutlineAPIClient, CachingOutlineAPIClient?) {
|
||||||
|
let live = LiveOutlineAPIClient(
|
||||||
configuration: OutlineConfiguration(baseURL: serverURL),
|
configuration: OutlineConfiguration(baseURL: serverURL),
|
||||||
tokenStore: tokenStore
|
tokenStore: tokenStore
|
||||||
)
|
)
|
||||||
apply(user: user, team: team, serverURL: serverURL)
|
guard let cache else { return (live, nil) }
|
||||||
isSignedIn = true
|
let caching = CachingOutlineAPIClient(live: live, cache: cache)
|
||||||
|
return (caching, caching)
|
||||||
}
|
}
|
||||||
|
|
||||||
func signOut() {
|
func signOut() {
|
||||||
try? tokenStore.clear()
|
try? tokenStore.clear()
|
||||||
defaults.removeObject(forKey: Self.serverURLDefaultsKey)
|
defaults.removeObject(forKey: Self.serverURLDefaultsKey)
|
||||||
isSignedIn = false
|
isSignedIn = false
|
||||||
|
userId = nil
|
||||||
userName = nil
|
userName = nil
|
||||||
userEmail = nil
|
userEmail = nil
|
||||||
userAvatarURL = nil
|
userAvatarURL = nil
|
||||||
|
userLanguage = nil
|
||||||
|
userPreferences = nil
|
||||||
|
userNotificationSettings = nil
|
||||||
teamName = nil
|
teamName = nil
|
||||||
teamAvatarURL = nil
|
teamAvatarURL = nil
|
||||||
apiClient = nil
|
apiClient = nil
|
||||||
|
cachingClient = nil
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Re-fetches user/workspace name/logo on relaunch, when the token survived but this
|
/// Re-fetches user/workspace name/logo on relaunch, when the token survived but this
|
||||||
@@ -65,13 +109,30 @@ final class SessionStore {
|
|||||||
apply(user: auth.user, team: auth.team, serverURL: serverURL)
|
apply(user: auth.user, team: auth.team, serverURL: serverURL)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Settings calls this after a successful name/avatar change so the
|
||||||
|
/// sidebar's account footer and everywhere else reading these reflect
|
||||||
|
/// it immediately, without waiting for the next `auth.info` refresh.
|
||||||
|
func applyUpdatedProfile(_ user: OutlineUser) {
|
||||||
|
guard let serverURL else { return }
|
||||||
|
userId = user.id
|
||||||
|
userName = user.name
|
||||||
|
userAvatarURL = user.avatarUrl.flatMap { URL(string: $0, relativeTo: serverURL)?.absoluteURL }
|
||||||
|
userLanguage = user.language
|
||||||
|
userPreferences = user.preferences
|
||||||
|
userNotificationSettings = user.notificationSettings
|
||||||
|
}
|
||||||
|
|
||||||
private func apply(user: OutlineUser, team: OutlineTeam, serverURL: URL) {
|
private func apply(user: OutlineUser, team: OutlineTeam, serverURL: URL) {
|
||||||
|
userId = user.id
|
||||||
userName = user.name
|
userName = user.name
|
||||||
userEmail = user.email
|
userEmail = user.email
|
||||||
// Outline can return either an absolute URL or a server-relative path
|
// Outline can return either an absolute URL or a server-relative path
|
||||||
// (e.g. `/api/files.get?key=...`) for avatarUrl — resolve against the
|
// (e.g. `/api/files.get?key=...`) for avatarUrl — resolve against the
|
||||||
// configured server so relative paths don't fail as "unsupported URL".
|
// configured server so relative paths don't fail as "unsupported URL".
|
||||||
userAvatarURL = user.avatarUrl.flatMap { URL(string: $0, relativeTo: serverURL)?.absoluteURL }
|
userAvatarURL = user.avatarUrl.flatMap { URL(string: $0, relativeTo: serverURL)?.absoluteURL }
|
||||||
|
userLanguage = user.language
|
||||||
|
userPreferences = user.preferences
|
||||||
|
userNotificationSettings = user.notificationSettings
|
||||||
teamName = team.name
|
teamName = team.name
|
||||||
teamAvatarURL = team.avatarUrl.flatMap { URL(string: $0, relativeTo: serverURL)?.absoluteURL }
|
teamAvatarURL = team.avatarUrl.flatMap { URL(string: $0, relativeTo: serverURL)?.absoluteURL }
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
import SwiftUI
|
import SwiftUI
|
||||||
|
import OutlineKit
|
||||||
|
|
||||||
#if os(macOS)
|
#if os(macOS)
|
||||||
import AppKit
|
import AppKit
|
||||||
@@ -41,11 +42,46 @@ struct AvatarBadge: View {
|
|||||||
.task(id: avatarURL) {
|
.task(id: avatarURL) {
|
||||||
loadedImage = nil
|
loadedImage = nil
|
||||||
guard let avatarURL else { return }
|
guard let avatarURL else { return }
|
||||||
guard let (data, _) = try? await URLSession.shared.data(from: avatarURL) else { return }
|
loadedImage = await Self.loadImage(from: avatarURL)
|
||||||
loadedImage = PlatformImage(data: data)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The real fix, confirmed against a live network capture: every other
|
||||||
|
/// request this app makes attaches `Authorization: Bearer <token>` —
|
||||||
|
/// this one never did, sending a bare unauthenticated GET. Outline's
|
||||||
|
/// browser session authenticates `attachments.redirect` via cookies
|
||||||
|
/// instead, which a native app doesn't have; the API-token equivalent
|
||||||
|
/// is the same Bearer header every RPC call already uses. Almost
|
||||||
|
/// certainly means no avatar image (not just a freshly-uploaded one)
|
||||||
|
/// has ever actually loaded in this app — a 401 and a "no avatar set"
|
||||||
|
/// look identical here, both just fall back to the placeholder icon
|
||||||
|
/// with nothing on screen to flag it as an error.
|
||||||
|
///
|
||||||
|
/// The retry loop is a secondary, independent hardening — cheap
|
||||||
|
/// insurance against a self-hosted reverse-proxied storage backend not
|
||||||
|
/// being instantly consistent right after an upload — kept alongside
|
||||||
|
/// the auth fix rather than instead of it.
|
||||||
|
private static func loadImage(from url: URL) async -> PlatformImage? {
|
||||||
|
var request = URLRequest(url: url)
|
||||||
|
request.cachePolicy = .reloadIgnoringLocalCacheData
|
||||||
|
if let token = try? KeychainTokenStore().token() {
|
||||||
|
request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
|
||||||
|
}
|
||||||
|
|
||||||
|
for attempt in 0..<3 {
|
||||||
|
if attempt > 0 {
|
||||||
|
try? await Task.sleep(for: .milliseconds(400))
|
||||||
|
}
|
||||||
|
if let (data, response) = try? await URLSession.shared.data(for: request),
|
||||||
|
let httpResponse = response as? HTTPURLResponse,
|
||||||
|
(200...299).contains(httpResponse.statusCode),
|
||||||
|
let image = PlatformImage(data: data) {
|
||||||
|
return image
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
private func platformImage(_ image: PlatformImage) -> Image {
|
private func platformImage(_ image: PlatformImage) -> Image {
|
||||||
#if os(macOS)
|
#if os(macOS)
|
||||||
Image(nsImage: image)
|
Image(nsImage: image)
|
||||||
|
|||||||
@@ -0,0 +1,14 @@
|
|||||||
|
#if os(macOS)
|
||||||
|
import AppKit
|
||||||
|
|
||||||
|
extension NSImage {
|
||||||
|
/// `NSImage` has no built-in JPEG encoder (unlike `UIImage`) — routes
|
||||||
|
/// through a bitmap representation to get one.
|
||||||
|
func jpegData(compressionQuality: CGFloat) -> Data? {
|
||||||
|
guard let tiffData = tiffRepresentation, let bitmap = NSBitmapImageRep(data: tiffData) else {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return bitmap.representation(using: .jpeg, properties: [.compressionFactor: compressionQuality])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
import Foundation
|
||||||
|
import Network
|
||||||
|
import Observation
|
||||||
|
|
||||||
|
/// Backs the sidebar's offline badge — purely a UI signal. Unrelated to
|
||||||
|
/// `CachingOutlineAPIClient`'s own fallback logic, which reacts to actual
|
||||||
|
/// request failures rather than pre-checking reachability.
|
||||||
|
@Observable
|
||||||
|
@MainActor
|
||||||
|
final class NetworkMonitor {
|
||||||
|
private(set) var isOnline = true
|
||||||
|
|
||||||
|
private let monitor = NWPathMonitor()
|
||||||
|
private let queue = DispatchQueue(label: "com.outpost.network-monitor")
|
||||||
|
|
||||||
|
init() {
|
||||||
|
// Weak on the outer closure (it's held by `monitor` for the object's
|
||||||
|
// whole lifetime, so a strong capture here would be a retain cycle),
|
||||||
|
// then unwrapped once into a plain strong local — the inner `Task`
|
||||||
|
// closure capturing that local `self` is what a nested closure needs
|
||||||
|
// to be consistent about capture semantics with its enclosing one.
|
||||||
|
monitor.pathUpdateHandler = { [weak self] path in
|
||||||
|
guard let self else { return }
|
||||||
|
|
||||||
|
let online = path.status == .satisfied
|
||||||
|
Task { @MainActor in
|
||||||
|
self.isOnline = online
|
||||||
|
}
|
||||||
|
}
|
||||||
|
monitor.start(queue: queue)
|
||||||
|
}
|
||||||
|
|
||||||
|
deinit {
|
||||||
|
monitor.cancel()
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// Outline's interface-language options. Not exhaustive — Outline accepts
|
||||||
|
/// community translations via its own translation portal, so the real list
|
||||||
|
/// on any given server can be longer than this; this covers the common
|
||||||
|
/// cases and falls back to showing whatever code the server already has
|
||||||
|
/// set even if it isn't in this list.
|
||||||
|
struct OutlineLocale: Identifiable, Hashable {
|
||||||
|
let code: String
|
||||||
|
let label: String
|
||||||
|
|
||||||
|
var id: String { code }
|
||||||
|
|
||||||
|
static let all: [OutlineLocale] = [
|
||||||
|
OutlineLocale(code: "en_US", label: "English (US)"),
|
||||||
|
OutlineLocale(code: "en_GB", label: "English (UK)"),
|
||||||
|
OutlineLocale(code: "de_DE", label: "Deutsch"),
|
||||||
|
OutlineLocale(code: "fr_FR", label: "Français"),
|
||||||
|
OutlineLocale(code: "es_ES", label: "Español"),
|
||||||
|
OutlineLocale(code: "pt_PT", label: "Português"),
|
||||||
|
OutlineLocale(code: "pt_BR", label: "Português (Brasil)"),
|
||||||
|
OutlineLocale(code: "it_IT", label: "Italiano"),
|
||||||
|
OutlineLocale(code: "nl_NL", label: "Nederlands"),
|
||||||
|
OutlineLocale(code: "pl_PL", label: "Polski"),
|
||||||
|
OutlineLocale(code: "ru_RU", label: "Русский"),
|
||||||
|
OutlineLocale(code: "ja_JP", label: "日本語"),
|
||||||
|
OutlineLocale(code: "ko_KR", label: "한국어"),
|
||||||
|
OutlineLocale(code: "zh_CN", label: "中文 (简体)"),
|
||||||
|
OutlineLocale(code: "zh_TW", label: "中文 (繁體)"),
|
||||||
|
]
|
||||||
|
|
||||||
|
static func label(for code: String) -> String {
|
||||||
|
all.first(where: { $0.code == code })?.label ?? code
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
import Foundation
|
||||||
|
|
||||||
|
/// Single source of truth for how Outpost's own version is formatted —
|
||||||
|
/// used by both the About page and the Settings sidebar footer, so they
|
||||||
|
/// can't drift out of sync the way `AboutInfoView` was already written to
|
||||||
|
/// avoid for its own two call sites.
|
||||||
|
enum OutpostVersion {
|
||||||
|
/// Bumped alongside `MARKETING_VERSION` in the Xcode project — kept out
|
||||||
|
/// of the bundle version itself since `CFBundleShortVersionString` is
|
||||||
|
/// expected to stay a plain dotted-numeric string, not `0.0.1-ALPHA`.
|
||||||
|
static let releaseStage = "ALPHA"
|
||||||
|
|
||||||
|
static var shortVersion: String {
|
||||||
|
Bundle.main.object(forInfoDictionaryKey: "CFBundleShortVersionString") as? String ?? "0.0.1"
|
||||||
|
}
|
||||||
|
|
||||||
|
static var buildNumber: String {
|
||||||
|
Bundle.main.object(forInfoDictionaryKey: "CFBundleVersion") as? String ?? "1"
|
||||||
|
}
|
||||||
|
|
||||||
|
/// e.g. `"0.0.3-ALPHA"` — for compact display (sidebar footer).
|
||||||
|
static var displayString: String {
|
||||||
|
let stageSuffix = releaseStage.isEmpty ? "" : "-\(releaseStage)"
|
||||||
|
return "\(shortVersion)\(stageSuffix)"
|
||||||
|
}
|
||||||
|
|
||||||
|
/// e.g. `"Version 0.0.3-ALPHA (1)"` — for the About page.
|
||||||
|
static var fullVersionString: String {
|
||||||
|
"Version \(displayString) (\(buildNumber))"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,27 +1,29 @@
|
|||||||
# Outpost
|
<p align="center">
|
||||||
|
<img src="Outpost/Assets.xcassets/AppLogo.imageset/outpost-ios-1024.png" width="120" alt="Outpost logo">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<h1 align="center">Outpost</h1>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://testflight.apple.com/join/y1mYcYAM">
|
||||||
|
<img src="https://img.shields.io/badge/Download-TestFlight-0D96F6?style=for-the-badge&logo=apple&logoColor=white" alt="Download on TestFlight">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
A native Apple ecosystem client for [Outline](https://github.com/outline/outline) — built for iOS, iPadOS, and macOS from a single SwiftUI codebase, aiming for full editing parity with Outline's web app, including realtime collaborative editing.
|
A native Apple ecosystem client for [Outline](https://github.com/outline/outline) — built for iOS, iPadOS, and macOS from a single SwiftUI codebase, aiming for full editing parity with Outline's web app, including realtime collaborative editing.
|
||||||
|
|
||||||
|
> **Early alpha — macOS only for now.** Expect missing features and rough edges. iOS/iPadOS support is planned but not in the current build. See the [releases page](https://git.psmattas.com/psmattas/Outpost/releases) for changelogs, and [open an issue](https://git.psmattas.com/psmattas/Outpost/issues) if you hit anything.
|
||||||
|
|
||||||
## Why
|
## Why
|
||||||
|
|
||||||
Outline's web app is great, but there's no native Apple client with full editing parity. This project connects to a self-hosted Outline instance over its REST API and realtime collaboration socket to provide a proper native experience across the Apple ecosystem.
|
Outline's web app is great, but there's no native Apple client with full editing parity. This project connects to a self-hosted Outline instance over its REST API and realtime collaboration socket to provide a proper native experience across the Apple ecosystem.
|
||||||
|
|
||||||
## Status
|
|
||||||
|
|
||||||
Early development. See `CLAUDE.md` for the current architecture and phased build plan.
|
|
||||||
|
|
||||||
- [ ] Phase 1 — Auth, browse, search, REST-only editing
|
|
||||||
- [ ] Phase 2 — Realtime collaborative editing (Yjs/Hocuspocus)
|
|
||||||
- [ ] Phase 3 — Offline cache, tables, embeds, comments, macOS polish
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Xcode 16+
|
- Xcode 27+ (currently developed against an Xcode 27 beta — this is a hard minimum, not a suggestion)
|
||||||
- iOS 17+ / iPadOS 17+ / macOS 14+
|
- macOS 27+. iOS/iPadOS support is planned but not in the current build (see the alpha note above) — same 27+ minimum will apply once it lands
|
||||||
- A self-hosted (or hosted) Outline instance with API access
|
- A self-hosted (or hosted) Outline instance with API access
|
||||||
|
|
||||||
> They will be updated. These are old requirements.
|
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
1. Clone the repo and open the `.xcodeproj` in Xcode.
|
1. Clone the repo and open the `.xcodeproj` in Xcode.
|
||||||
@@ -42,6 +44,16 @@ Parts of this codebase are AI-assisted (built with the help of AI coding tools).
|
|||||||
|
|
||||||
This project is a client only — it does not include, vendor, or redistribute any of Outline's (BSL 1.1 licensed) server source. See [`LICENSE`](./LICENSE) for this repository's own license.
|
This project is a client only — it does not include, vendor, or redistribute any of Outline's (BSL 1.1 licensed) server source. See [`LICENSE`](./LICENSE) for this repository's own license.
|
||||||
|
|
||||||
|
## Privacy
|
||||||
|
|
||||||
|
Outpost collects nothing about you — no analytics, no telemetry, no crash reporting of its own, no age or demographic data, nothing. The only thing stored locally is your Outline server URL and API token (in the device Keychain) and, optionally, a local offline cache of what you've viewed. Everything else goes straight from your device to whatever Outline server you configure — there's no backend in between, and the developer has no access to your data or your server.
|
||||||
|
|
||||||
|
Full policy, terms of service, and data-processing statement are on the [wiki](https://git.psmattas.com/psmattas/Outpost/wiki):
|
||||||
|
|
||||||
|
- [Privacy Policy](https://git.psmattas.com/psmattas/Outpost/wiki/Privacy-Policy)
|
||||||
|
- [Terms of Service](https://git.psmattas.com/psmattas/Outpost/wiki/Terms-of-Service)
|
||||||
|
- [Data Processing Statement](https://git.psmattas.com/psmattas/Outpost/wiki/Data-Processing-Statement)
|
||||||
|
|
||||||
## Not affiliated with Outline
|
## Not affiliated with Outline
|
||||||
|
|
||||||
This is an independent, unofficial client. Not affiliated with or endorsed by General Outline, Inc.
|
This is an independent, unofficial client. Not affiliated with or endorsed by General Outline, Inc.
|
||||||
|
|||||||
Reference in New Issue
Block a user