cloudkit 0.3.5

Safe Rust bindings for Apple's CloudKit framework — iCloud databases and sync on macOS
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
import CloudKit
import Foundation

let ckISO8601Formatter: ISO8601DateFormatter = {
    let formatter = ISO8601DateFormatter()
    formatter.formatOptions = [.withInternetDateTime, .withFractionalSeconds]
    return formatter
}()

enum CKRecordValueKind: String, Codable {
    case string
    case int
    case double
    case bool
    case bytes
    case date
    case asset
    case reference
    case array
}

struct CKRecordZoneIDPayload: Codable {
    var zoneName: String
    var ownerName: String
}

struct CKRecordIDPayload: Codable {
    var recordName: String
    var zoneID: CKRecordZoneIDPayload
}

struct CKReferencePayload: Codable {
    var recordID: CKRecordIDPayload
    var action: UInt
}

struct CKAssetPayload: Codable {
    var fileURL: String
}

struct CKRecordValuePayload: Codable {
    var kind: CKRecordValueKind
    var stringValue: String?
    var intValue: Int64?
    var doubleValue: Double?
    var boolValue: Bool?
    var bytesValue: [UInt8]?
    var dateValue: String?
    var assetValue: CKAssetPayload?
    var referenceValue: CKReferencePayload?
    var arrayValue: [CKRecordValuePayload]?
}

struct CKRecordPayload: Codable {
    var recordType: String
    var recordID: CKRecordIDPayload
    var fields: [String: CKRecordValuePayload]
    var encodedSystemFields: [UInt8]
    var recordChangeTag: String?
    var creatorUserRecordID: CKRecordIDPayload?
    var creationDate: String?
    var lastModifiedUserRecordID: CKRecordIDPayload?
    var modificationDate: String?
    var parent: CKReferencePayload?
    var share: CKReferencePayload?
    var changedKeys: [String]
    var allTokens: [String]
}

struct CKRecordZonePayload: Codable {
    var zoneID: CKRecordZoneIDPayload
    var capabilities: UInt64
    var share: CKReferencePayload?
    var encryptionScope: Int?
}

struct SortDescriptorPayload: Codable {
    var key: String
    var ascending: Bool
}

struct CKQueryPayload: Codable {
    var recordType: String
    var predicateFormat: String
    var sortDescriptors: [SortDescriptorPayload]
}

struct CKModifyRecordsOperationPayload: Codable {
    var recordsToSave: [CKRecordPayload]
    var recordIDsToDelete: [CKRecordIDPayload]
    var savePolicy: Int32
    var atomic: Bool
}

struct CKRecordSaveResultPayload: Codable {
    var recordID: CKRecordIDPayload
    var record: CKRecordPayload?
    var error: CKErrorPayload?
}

struct CKRecordDeleteResultPayload: Codable {
    var recordID: CKRecordIDPayload
    var error: CKErrorPayload?
}

struct CKModifyRecordsResultPayload: Codable {
    var savedRecords: [CKRecordPayload]
    var deletedRecordIDs: [CKRecordIDPayload]
    var saveResults: [CKRecordSaveResultPayload]
    var deleteResults: [CKRecordDeleteResultPayload]
    var operationError: CKErrorPayload?
}

struct CKQueryOperationPayload: Codable {
    var query: CKQueryPayload
    var zoneID: CKRecordZoneIDPayload?
    var desiredKeys: [String]?
    var resultsLimit: Int?
}

struct CKQueryMatchResultPayload: Codable {
    var recordID: CKRecordIDPayload
    var record: CKRecordPayload?
    var error: CKErrorPayload?
}

struct CKQueryOperationResultPayload: Codable {
    var records: [CKRecordPayload]
    var matches: [CKQueryMatchResultPayload]
    var cursorReturned: Bool
    var operationError: CKErrorPayload?
}

func ckEncodeZoneID(_ zoneID: CKRecordZone.ID) -> CKRecordZoneIDPayload {
    CKRecordZoneIDPayload(zoneName: zoneID.zoneName, ownerName: zoneID.ownerName)
}

func ckDecodeZoneID(_ payload: CKRecordZoneIDPayload) -> CKRecordZone.ID {
    CKRecordZone.ID(zoneName: payload.zoneName, ownerName: payload.ownerName)
}

func ckEncodeRecordID(_ recordID: CKRecord.ID) -> CKRecordIDPayload {
    CKRecordIDPayload(recordName: recordID.recordName, zoneID: ckEncodeZoneID(recordID.zoneID))
}

func ckDecodeRecordID(_ payload: CKRecordIDPayload) -> CKRecord.ID {
    CKRecord.ID(recordName: payload.recordName, zoneID: ckDecodeZoneID(payload.zoneID))
}

func ckEncodeReference(_ reference: CKRecord.Reference) -> CKReferencePayload {
    CKReferencePayload(recordID: ckEncodeRecordID(reference.recordID), action: reference.action.rawValue)
}

func ckDecodeReference(_ payload: CKReferencePayload) -> CKRecord.Reference {
    CKRecord.Reference(recordID: ckDecodeRecordID(payload.recordID), action: CKRecord.ReferenceAction(rawValue: payload.action) ?? .none)
}

func ckArchiveSystemFields(_ record: CKRecord) throws -> [UInt8] {
    let archiver = NSKeyedArchiver(requiringSecureCoding: true)
    record.encodeSystemFields(with: archiver)
    archiver.finishEncoding()
    return [UInt8](archiver.encodedData)
}

func ckEncodeRecordValue(_ value: Any) -> CKRecordValuePayload? {
    if let string = value as? String {
        return CKRecordValuePayload(
            kind: .string,
            stringValue: string,
            intValue: nil,
            doubleValue: nil,
            boolValue: nil,
            bytesValue: nil,
            dateValue: nil,
            assetValue: nil,
            referenceValue: nil,
            arrayValue: nil
        )
    }
    if let number = value as? NSNumber {
        if CFGetTypeID(number) == CFBooleanGetTypeID() {
            return CKRecordValuePayload(
                kind: .bool,
                stringValue: nil,
                intValue: nil,
                doubleValue: nil,
                boolValue: number.boolValue,
                bytesValue: nil,
                dateValue: nil,
                assetValue: nil,
                referenceValue: nil,
                arrayValue: nil
            )
        }
        if CFNumberIsFloatType(number) {
            return CKRecordValuePayload(
                kind: .double,
                stringValue: nil,
                intValue: nil,
                doubleValue: number.doubleValue,
                boolValue: nil,
                bytesValue: nil,
                dateValue: nil,
                assetValue: nil,
                referenceValue: nil,
                arrayValue: nil
            )
        }
        return CKRecordValuePayload(
            kind: .int,
            stringValue: nil,
            intValue: number.int64Value,
            doubleValue: nil,
            boolValue: nil,
            bytesValue: nil,
            dateValue: nil,
            assetValue: nil,
            referenceValue: nil,
            arrayValue: nil
        )
    }
    if let data = value as? Data {
        return CKRecordValuePayload(
            kind: .bytes,
            stringValue: nil,
            intValue: nil,
            doubleValue: nil,
            boolValue: nil,
            bytesValue: [UInt8](data),
            dateValue: nil,
            assetValue: nil,
            referenceValue: nil,
            arrayValue: nil
        )
    }
    if let date = value as? Date {
        return CKRecordValuePayload(
            kind: .date,
            stringValue: nil,
            intValue: nil,
            doubleValue: nil,
            boolValue: nil,
            bytesValue: nil,
            dateValue: ckISO8601Formatter.string(from: date),
            assetValue: nil,
            referenceValue: nil,
            arrayValue: nil
        )
    }
    if let asset = value as? CKAsset {
        return CKRecordValuePayload(
            kind: .asset,
            stringValue: nil,
            intValue: nil,
            doubleValue: nil,
            boolValue: nil,
            bytesValue: nil,
            dateValue: nil,
            assetValue: ckEncodeAsset(asset),
            referenceValue: nil,
            arrayValue: nil
        )
    }
    if let reference = value as? CKRecord.Reference {
        return CKRecordValuePayload(
            kind: .reference,
            stringValue: nil,
            intValue: nil,
            doubleValue: nil,
            boolValue: nil,
            bytesValue: nil,
            dateValue: nil,
            assetValue: nil,
            referenceValue: ckEncodeReference(reference),
            arrayValue: nil
        )
    }
    if let array = value as? [Any] {
        var payloads: [CKRecordValuePayload] = []
        payloads.reserveCapacity(array.count)
        for item in array {
            guard let payload = ckEncodeRecordValue(item) else { return nil }
            payloads.append(payload)
        }
        return CKRecordValuePayload(
            kind: .array,
            stringValue: nil,
            intValue: nil,
            doubleValue: nil,
            boolValue: nil,
            bytesValue: nil,
            dateValue: nil,
            assetValue: nil,
            referenceValue: nil,
            arrayValue: payloads
        )
    }
    return nil
}

func ckDecodeRecordValue(_ payload: CKRecordValuePayload) throws -> (any CKRecordValue)? {
    switch payload.kind {
    case .string:
        return payload.stringValue.map(NSString.init(string:))
    case .int:
        return payload.intValue.map(NSNumber.init(value:))
    case .double:
        return payload.doubleValue.map(NSNumber.init(value:))
    case .bool:
        return payload.boolValue.map(NSNumber.init(value:))
    case .bytes:
        return payload.bytesValue.map { NSData(data: Data($0)) }
    case .date:
        guard let dateValue = payload.dateValue else { return nil }
        guard let date = ckISO8601Formatter.date(from: dateValue) else {
            throw ckBridgeNSError(code: CKR_INVALID_ARGUMENT, message: "Invalid ISO-8601 date: \(dateValue)")
        }
        return date as NSDate
    case .asset:
        guard let asset = payload.assetValue else { return nil }
        return ckDecodeAsset(asset)
    case .reference:
        guard let referenceValue = payload.referenceValue else { return nil }
        return ckDecodeReference(referenceValue)
    case .array:
        let values = try payload.arrayValue?.map { try ckDecodeRecordValue($0) } ?? []
        return values.compactMap { $0 } as NSArray
    }
}

func ckApplyRecordPayload(_ payload: CKRecordPayload, to record: CKRecord) throws {
    let desiredKeys = Set(payload.fields.keys)
    for key in record.allKeys() where !desiredKeys.contains(key) {
        record.setObject(nil, forKey: key)
    }
    for (key, valuePayload) in payload.fields {
        record.setObject(try ckDecodeRecordValue(valuePayload), forKey: key)
    }
    record.parent = payload.parent.map(ckDecodeReference)
}

func ckDecodeRecord(_ payload: CKRecordPayload) throws -> CKRecord {
    let recordID = ckDecodeRecordID(payload.recordID)
    let record: CKRecord
    if payload.encodedSystemFields.isEmpty {
        record = CKRecord(recordType: payload.recordType, recordID: recordID)
    } else {
        let data = Data(payload.encodedSystemFields)
        let unarchiver = try NSKeyedUnarchiver(forReadingFrom: data)
        unarchiver.requiresSecureCoding = true
        if payload.recordType == CKRecord.SystemType.share {
            record = CKShare(coder: unarchiver)
        } else {
            guard let decoded = CKRecord(coder: unarchiver) else {
                throw ckBridgeNSError(code: CKR_FAILURE, message: "Failed to decode CKRecord from encoded system fields")
            }
            record = decoded
        }
        unarchiver.finishDecoding()
    }

    try ckApplyRecordPayload(payload, to: record)
    return record
}

func ckEncodeRecord(_ record: CKRecord) throws -> CKRecordPayload {
    var fields: [String: CKRecordValuePayload] = [:]
    for key in record.allKeys() {
        if let value = record.object(forKey: key), let payload = ckEncodeRecordValue(value) {
            fields[key] = payload
        }
    }
    return CKRecordPayload(
        recordType: record.recordType,
        recordID: ckEncodeRecordID(record.recordID),
        fields: fields,
        encodedSystemFields: try ckArchiveSystemFields(record),
        recordChangeTag: record.recordChangeTag,
        creatorUserRecordID: record.creatorUserRecordID.map(ckEncodeRecordID),
        creationDate: record.creationDate.map(ckISO8601Formatter.string),
        lastModifiedUserRecordID: record.lastModifiedUserRecordID.map(ckEncodeRecordID),
        modificationDate: record.modificationDate.map(ckISO8601Formatter.string),
        parent: record.parent.map(ckEncodeReference),
        share: record.share.map(ckEncodeReference),
        changedKeys: record.changedKeys(),
        allTokens: record.allTokens()
    )
}

func ckEncodeZone(_ zone: CKRecordZone) -> CKRecordZonePayload {
    let encryptionScope: Int?
    if #available(macOS 26.0, *) {
        encryptionScope = zone.encryptionScope.rawValue
    } else {
        encryptionScope = nil
    }
    return CKRecordZonePayload(
        zoneID: ckEncodeZoneID(zone.zoneID),
        capabilities: UInt64(zone.capabilities.rawValue),
        share: zone.share.map(ckEncodeReference),
        encryptionScope: encryptionScope
    )
}

func ckDecodeZone(_ payload: CKRecordZonePayload) -> CKRecordZone {
    let zone = CKRecordZone(zoneID: ckDecodeZoneID(payload.zoneID))
    if #available(macOS 26.0, *), let encryptionScope = payload.encryptionScope,
       let scope = CKRecordZone.EncryptionScope(rawValue: encryptionScope) {
        zone.encryptionScope = scope
    }
    return zone
}

func ckDecodeQuery(_ payload: CKQueryPayload) -> CKQuery {
    let query = CKQuery(recordType: payload.recordType, predicate: NSPredicate(format: payload.predicateFormat))
    if !payload.sortDescriptors.isEmpty {
        query.sortDescriptors = payload.sortDescriptors.map { NSSortDescriptor(key: $0.key, ascending: $0.ascending) }
    }
    return query
}