Merge pull request #24 from cybozu/add-fetchRecordComments

Kyome22 · web-flow · commit 756ce17fbcca · 2025-02-19T16:03:34.000+09:00
Add fetchRecordComments API
diff --git a/Example/Example/ContentView.swift b/Example/Example/ContentView.swift
@@ -72,6 +72,15 @@ enum TabCategory {
         }
     }
 
+    func fetchRecordComments(recordID: Int) async -> RecordComments? {
+        do {
+            return try await kintoneAPI.fetchRecordComments(appID: appID, recordID: recordID)
+        } catch {
+            print(error.localizedDescription)
+            return nil
+        }
+    }
+
     func updateStatus(recordIdentity: RecordIdentity.Write, action: StatusAction) async {
         do {
             let assignee = statusSettings?.states.first(where: { $0.name == action.to })?.assignee.entities.first?.code
@@ -224,6 +233,9 @@ enum TabCategory {
                         },
                         downloadFileHandler: { fileKey in
                             await viewModel.downloadFile(fileKey: fileKey)
+                        },
+                        fetchRecordCommentsHandler: { recordID in
+                            await viewModel.fetchRecordComments(recordID: recordID)
                         }
                     )
                     .tabItem {
diff --git a/Example/Example/Extensions/KintoneAPI+Extension.swift b/Example/Example/Extensions/KintoneAPI+Extension.swift
@@ -38,3 +38,5 @@ extension RecordState: @retroactive Identifiable {
 extension StatusAction: @retroactive Identifiable {
     public var id: String { name }
 }
+
+extension RecordComment.Read: @retroactive Identifiable {}
diff --git a/Example/Example/FetchApps/FetchAppsView.swift b/Example/Example/FetchApps/FetchAppsView.swift
@@ -27,16 +27,16 @@ struct FetchAppsView: View {
                         Divider()
                         VStack(alignment: .leading, spacing: 4) {
                             VStack(alignment: .leading, spacing: 4) {
-                                Text("Created At: \(String(optional: app.createdAt))")
-                                Text("Code: \(app.creator.code)")
-                                Text("Name: \(String(optional: app.creator.name))")
+                                Text("Created At: \(app.createdAt)")
+                                Text("Creator/Code: \(app.creator.code)")
+                                Text("Creator/Name: \(String(optional: app.creator.name))")
                             }
                             .frame(maxWidth: .infinity, alignment: .leading)
                             .cornerRadiusBorder()
                             VStack(alignment: .leading, spacing: 4) {
-                                Text("Modified At: \(String(optional: app.modifiedAt))")
-                                Text("Code: \(app.modifier.code)")
-                                Text("Name: \(String(optional: app.modifier.name))")
+                                Text("Modified At: \(app.modifiedAt)")
+                                Text("Modifier/Code: \(app.modifier.code)")
+                                Text("Modifier/Name: \(String(optional: app.modifier.name))")
                             }
                             .frame(maxWidth: .infinity, alignment: .leading)
                             .cornerRadiusBorder()
diff --git a/Example/Example/FetchRecordComments/FetchRecordCommentsView.swift b/Example/Example/FetchRecordComments/FetchRecordCommentsView.swift
@@ -0,0 +1,37 @@
+//
+//  FetchRecordCommentsView.swift
+//  Example
+//
+//  Created by ky0me22 on 2025/02/19.
+//
+
+import KintoneAPI
+import SwiftUI
+
+struct FetchRecordCommentsView: View {
+    @State private var isPresented = false
+    @State private var comments = [RecordComment.Read]()
+    var fetchRecordCommentsHandler: () async -> RecordComments?
+
+    var body: some View {
+        HStack(alignment: .top) {
+            Text("Comments:")
+            Divider()
+            Button {
+                isPresented = true
+            } label: {
+                Text("Fetch")
+            }
+        }
+        .frame(maxWidth: .infinity, alignment: .leading)
+        .cornerRadiusBorder()
+        .sheet(isPresented: $isPresented) {
+            RecordCommentsView(comments: comments)
+                .task {
+                    if let recordComments = await fetchRecordCommentsHandler() {
+                        comments = recordComments.comments
+                    }
+                }
+        }
+    }
+}
diff --git a/Example/Example/FetchRecordComments/RecordCommentViewDetailView.swift b/Example/Example/FetchRecordComments/RecordCommentViewDetailView.swift
@@ -0,0 +1,53 @@
+//
+//  RecordCommentViewDetailView.swift
+//  Example
+//
+//  Created by ky0me22 on 2025/02/19.
+//
+
+import KintoneAPI
+import SwiftUI
+
+struct RecordCommentViewDetailView: View {
+    var comment: RecordComment.Read
+
+    var body: some View {
+        VStack(alignment: .leading, spacing: 4) {
+            CornerRadiusText("ID: \(comment.id)")
+            HStack(alignment: .top) {
+                Text("Text:")
+                Divider()
+                Text(comment.text)
+            }
+            .frame(maxWidth: .infinity, alignment: .leading)
+            .cornerRadiusBorder()
+            VStack(alignment: .leading, spacing: 4) {
+                Text("Created At: \(comment.createdAt)")
+                Text("Creator/Code: \(comment.creator.code)")
+                Text("Creator/Name: \(String(optional: comment.creator.name))")
+            }
+            .frame(maxWidth: .infinity, alignment: .leading)
+            .cornerRadiusBorder()
+            if comment.mentions.isEmpty {
+                CornerRadiusText("Mentions: Empty")
+            } else {
+                HStack(alignment: .top) {
+                    Text("Mentions:")
+                    Divider()
+                    VStack(alignment: .leading, spacing: 4) {
+                        ForEach(comment.mentions) { entity in
+                            VStack(alignment: .leading, spacing: 4) {
+                                Text("Code: \(entity.code)")
+                                Text("Type: \(entity.type)")
+                            }
+                            .frame(maxWidth: .infinity, alignment: .leading)
+                            .cornerRadiusBorder()
+                        }
+                    }
+                }
+                .cornerRadiusBorder()
+            }
+        }
+        .cornerRadiusBorder()
+    }
+}
diff --git a/Example/Example/FetchRecordComments/RecordCommentsView.swift b/Example/Example/FetchRecordComments/RecordCommentsView.swift
@@ -0,0 +1,28 @@
+//
+//  RecordCommentsView.swift
+//  Example
+//
+//  Created by ky0me22 on 2025/02/19.
+//
+
+import KintoneAPI
+import SwiftUI
+
+struct RecordCommentsView: View {
+    var comments: [RecordComment.Read]
+
+    var body: some View {
+        ScrollView {
+            VStack(spacing: 16) {
+                if comments.isEmpty {
+                    CornerRadiusText("Comments: Empty")
+                } else {
+                    ForEach(comments) { comment in
+                        RecordCommentViewDetailView(comment: comment)
+                    }
+                }
+            }
+            .padding()
+        }
+    }
+}
diff --git a/Example/Example/FetchRecords/FetchRecordsView.swift b/Example/Example/FetchRecords/FetchRecordsView.swift
@@ -13,6 +13,7 @@ struct FetchRecordsView: View {
     var actions: [StatusAction]
     var updateStatusHandler: (RecordIdentity.Write, StatusAction) async -> Void
     var downloadFileHandler: (String) async -> Data?
+    var fetchRecordCommentsHandler: (Int) async -> RecordComments?
 
     var body: some View {
         ScrollView {
@@ -22,7 +23,8 @@ struct FetchRecordsView: View {
                         record: records[i],
                         actions: actions,
                         updateStatusHandler: updateStatusHandler,
-                        downloadFileHandler: downloadFileHandler
+                        downloadFileHandler: downloadFileHandler,
+                        fetchRecordCommentsHandler: fetchRecordCommentsHandler
                     )
                 }
             }
diff --git a/Example/Example/FetchRecords/RecordDetailView.swift b/Example/Example/FetchRecords/RecordDetailView.swift
@@ -13,6 +13,7 @@ struct RecordDetailView: View {
     var actions: [StatusAction]
     var updateStatusHandler: (RecordIdentity.Write, StatusAction) async -> Void
     var downloadFileHandler: (String) async -> Data?
+    var fetchRecordCommentsHandler: (Int) async -> RecordComments?
 
     var body: some View {
         VStack(alignment: .leading, spacing: 4) {
@@ -27,6 +28,9 @@ struct RecordDetailView: View {
                     downloadFileHandler: downloadFileHandler
                 )
             }
+            FetchRecordCommentsView {
+                await fetchRecordCommentsHandler(record.identity.id)
+            }
         }
         .cornerRadiusBorder()
     }
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ Providing kintone REST API with Swift interface.
 | `removeRecords`          | DELETE | [/k/v1/records.json](https://kintone.dev/en/docs/kintone/rest-api/records/delete-records/)                  |
 | `submitRecord`           | POST   | [/k/v1/record.json](https://kintone.dev/en/docs/kintone/rest-api/records/add-record/)                       |
 | `updateRecord`           | PUT    | [/k/v1/record.json](https://kintone.dev/en/docs/kintone/rest-api/records/update-record/)                    |
+| `fetchRecordComments`    | GET    | [/k/v1/record/comments.json](https://kintone.dev/en/docs/kintone/rest-api/records/get-comments/)            |
 | `updateStatus`           | PUT    | [/k/v1/record/status.json](https://kintone.dev/en/docs/kintone/rest-api/records/update-status/)             |
 | `downloadFile`           | GET    | [/k/v1/file.json](https://kintone.dev/en/docs/kintone/rest-api/files/download-file/)                        |
 | `uploadFile`             | POST   | [/k/v1/file.json](https://kintone.dev/en/docs/kintone/rest-api/files/upload-file/)                          |
diff --git a/Sources/KintoneAPI/Decodable/Comment/RecordComment.swift b/Sources/KintoneAPI/Decodable/Comment/RecordComment.swift
@@ -0,0 +1,39 @@
+//
+//  RecordComment+Read.swift
+//
+//
+//  Created by ky0me22 on 2025/02/19.
+//
+
+import Foundation
+
+extension RecordComment {
+    public struct Read: Decodable, Sendable {
+        public var id: Int
+        public var text: String
+        public var createdAt: Date
+        public var creator: Entity.Read
+        public var mentions: [Entity.Read]
+
+        enum CodingKeys: CodingKey {
+            case id
+            case text
+            case createdAt
+            case creator
+            case mentions
+        }
+
+        public init(from decoder: any Decoder) throws {
+            let container = try decoder.container(keyedBy: CodingKeys.self)
+            id = try container.customDecode(String.self, forKey: .id) { Int($0) }
+            text = try container.decode(String.self, forKey: .text)
+            createdAt = try container.customDecode(String.self, forKey: .createdAt) {
+                DateFormatter.kintoneDateTime.date(from: $0.normalizedDateTime)
+            }
+            creator = try container.customDecode(EntityValue.self, forKey: .creator) {
+                Entity.Read(type: .user, code: $0.code, name: $0.name)
+            }
+            mentions = try container.decode([Entity.Read].self, forKey: .mentions)
+        }
+    }
+}
diff --git a/Sources/KintoneAPI/Decodable/Comment/RecordComments.swift b/Sources/KintoneAPI/Decodable/Comment/RecordComments.swift
@@ -0,0 +1,12 @@
+//
+//  RecordComments.swift
+//
+//
+//  Created by ky0me22 on 2025/02/19.
+//
+
+public struct RecordComments: Decodable, Sendable {
+    public var comments: [RecordComment.Read]
+    public var older: Bool
+    public var newer: Bool
+}
diff --git a/Sources/KintoneAPI/Decodable/FetchRecordCommentsResponse.swift b/Sources/KintoneAPI/Decodable/FetchRecordCommentsResponse.swift
@@ -0,0 +1,14 @@
+//
+//  FetchRecordCommentsResponse.swift
+//
+//
+//  Created by ky0me22 on 2025/02/19.
+//
+
+struct FetchRecordCommentsResponse: Decodable {
+    var recordComments: RecordComments
+
+    init(from decoder: any Decoder) throws {
+        recordComments = try RecordComments(from: decoder)
+    }
+}
diff --git a/Sources/KintoneAPI/Decodable/KintoneApp/KintoneApp.swift b/Sources/KintoneAPI/Decodable/KintoneApp/KintoneApp.swift
@@ -14,9 +14,9 @@ public struct KintoneApp: Decodable, Sendable {
     public var description: String
     public var spaceID: Int?
     public var threadID: Int?
-    public var createdAt: Date?
+    public var createdAt: Date
     public var creator: Entity.Read
-    public var modifiedAt: Date?
+    public var modifiedAt: Date
     public var modifier: Entity.Read
 
     enum CodingKeys: String, CodingKey {
@@ -40,13 +40,13 @@ public struct KintoneApp: Decodable, Sendable {
         description = try container.decode(String.self, forKey: .description)
         spaceID = try container.customDecodeIfPresent(String.self, forKey: .spaceID) { Int($0) }
         threadID = try container.customDecodeIfPresent(String.self, forKey: .threadID) { Int($0) }
-        createdAt = try container.customDecodeIfPresent(String.self, forKey: .createdAt) {
+        createdAt = try container.customDecode(String.self, forKey: .createdAt) {
             DateFormatter.kintoneDateTime.date(from: $0.normalizedDateTime)
         }
         creator = try container.customDecode(EntityValue.self, forKey: .creator) {
             Entity.Read(type: .user, code: $0.code, name: $0.name)
         }
-        modifiedAt = try container.customDecodeIfPresent(String.self, forKey: .modifiedAt) {
+        modifiedAt = try container.customDecode(String.self, forKey: .modifiedAt) {
             DateFormatter.kintoneDateTime.date(from: $0.normalizedDateTime)
         }
         modifier = try container.customDecode(EntityValue.self, forKey: .modifier) {
diff --git a/Sources/KintoneAPI/Endpoint.swift b/Sources/KintoneAPI/Endpoint.swift
@@ -6,13 +6,14 @@
 //
 
 enum Endpoint: String {
-    case apps =         "/k/v1/apps.json"
-    case formLayout =   "/k/v1/app/form/layout.json"
-    case fields =       "/k/v1/app/form/fields.json"
-    case appSettings =  "/k/v1/app/settings.json"
-    case appStatus =    "/k/v1/app/status.json"
-    case records =      "/k/v1/records.json"
-    case record =       "/k/v1/record.json"
-    case recordStatus = "/k/v1/record/status.json"
-    case file =         "/k/v1/file.json"
+    case apps =           "/k/v1/apps.json"
+    case formLayout =     "/k/v1/app/form/layout.json"
+    case fields =         "/k/v1/app/form/fields.json"
+    case appSettings =    "/k/v1/app/settings.json"
+    case appStatus =      "/k/v1/app/status.json"
+    case records =        "/k/v1/records.json"
+    case record =         "/k/v1/record.json"
+    case recordComments = "/k/v1/record/comments.json"
+    case recordStatus =   "/k/v1/record/status.json"
+    case file =           "/k/v1/file.json"
 }
diff --git a/Sources/KintoneAPI/KintoneAPI.swift b/Sources/KintoneAPI/KintoneAPI.swift
@@ -186,6 +186,26 @@ public struct KintoneAPI: Sendable {
         return RecordIdentity.Read(id: recordIdentity.id, revision: updateRecordResponse.revision)
     }
 
+    public func fetchRecordComments(
+        appID: Int,
+        recordID: Int,
+        order: Order? = nil,
+        offset: Int? = nil,
+        limit: Int? = nil
+    ) async throws -> RecordComments {
+        var queryItems = [URLQueryItem]()
+        queryItems.appendQueryItem(name: "app", value: appID.description)
+        queryItems.appendQueryItem(name: "record", value: recordID.description)
+        queryItems.appendQueryItem(name: "order", value: order?.rawValue)
+        queryItems.appendQueryItem(name: "offset", value: offset?.description)
+        queryItems.appendQueryItem(name: "limit", value: limit?.description)
+        let request = makeRequest(httpMethod: .get, endpoint: .recordComments, queryItems: queryItems)
+        let (data, response) = try await dataRequestHandler(request)
+        try check(response: response)
+        let fetchRecordCommentsResponse = try JSONDecoder().decode(FetchRecordCommentsResponse.self, from: data)
+        return fetchRecordCommentsResponse.recordComments
+    }
+
     @discardableResult
     public func updateStatus(
         appID: Int,
diff --git a/Sources/KintoneAPI/NameSpace.swift b/Sources/KintoneAPI/NameSpace.swift
@@ -20,3 +20,5 @@ public enum RecordField {}
 public enum RecordFieldValue {}
 
 public enum SubtableValue {}
+
+public enum RecordComment {}
diff --git a/Sources/KintoneAPI/Order.swift b/Sources/KintoneAPI/Order.swift
@@ -0,0 +1,13 @@
+//
+//  Order.swift
+//
+//
+//  Created by ky0me22 on 2025/02/18.
+//
+
+import Foundation
+
+public enum Order: String, Sendable {
+    case ascending = "asc"
+    case descending = "desc"
+}
diff --git a/Tests/KintoneAPITests/DecodableTests/FetchRecordCommentsResponseTests.swift b/Tests/KintoneAPITests/DecodableTests/FetchRecordCommentsResponseTests.swift

Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,15 @@ enum TabCategory {`
`72`	`72`	`}`
`73`	`73`	`}`
`74`	`74`
	`75`	`+ func fetchRecordComments(recordID: Int) async -> RecordComments? {`
	`76`	`+ do {`
	`77`	`+ return try await kintoneAPI.fetchRecordComments(appID: appID, recordID: recordID)`
	`78`	`+ } catch {`
	`79`	`+ print(error.localizedDescription)`
	`80`	`+ return nil`
	`81`	`+ }`
	`82`	`+ }`
	`83`	`+`
`75`	`84`	`func updateStatus(recordIdentity: RecordIdentity.Write, action: StatusAction) async {`
`76`	`85`	`do {`
`77`	`86`	`let assignee = statusSettings?.states.first(where: { $0.name == action.to })?.assignee.entities.first?.code`
`@@ -224,6 +233,9 @@ enum TabCategory {`
`224`	`233`	`},`
`225`	`234`	`downloadFileHandler: { fileKey in`
`226`	`235`	`await viewModel.downloadFile(fileKey: fileKey)`
	`236`	`+ },`
	`237`	`+ fetchRecordCommentsHandler: { recordID in`
	`238`	`+ await viewModel.fetchRecordComments(recordID: recordID)`
`227`	`239`	`}`
`228`	`240`	`)`
`229`	`241`	`.tabItem {`
Original file line number	Diff line number	Diff line change
`@@ -38,3 +38,5 @@ extension RecordState: @retroactive Identifiable {`
`38`	`38`	`extension StatusAction: @retroactive Identifiable {`
`39`	`39`	`public var id: String { name }`
`40`	`40`	`}`
	`41`	`+`
	`42`	`+extension RecordComment.Read: @retroactive Identifiable {}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ struct FetchRecordsView: View {`
`13`	`13`	`var actions: [StatusAction]`
`14`	`14`	`var updateStatusHandler: (RecordIdentity.Write, StatusAction) async -> Void`
`15`	`15`	`var downloadFileHandler: (String) async -> Data?`
	`16`	`+ var fetchRecordCommentsHandler: (Int) async -> RecordComments?`
`16`	`17`
`17`	`18`	`var body: some View {`
`18`	`19`	`ScrollView {`
`@@ -22,7 +23,8 @@ struct FetchRecordsView: View {`
`22`	`23`	`record: records[i],`
`23`	`24`	`actions: actions,`
`24`	`25`	`updateStatusHandler: updateStatusHandler,`
`25`		`- downloadFileHandler: downloadFileHandler`
	`26`	`+ downloadFileHandler: downloadFileHandler,`
	`27`	`+ fetchRecordCommentsHandler: fetchRecordCommentsHandler`
`26`	`28`	`)`
`27`	`29`	`}`
`28`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ struct RecordDetailView: View {`
`13`	`13`	`var actions: [StatusAction]`
`14`	`14`	`var updateStatusHandler: (RecordIdentity.Write, StatusAction) async -> Void`
`15`	`15`	`var downloadFileHandler: (String) async -> Data?`
	`16`	`+ var fetchRecordCommentsHandler: (Int) async -> RecordComments?`
`16`	`17`
`17`	`18`	`var body: some View {`
`18`	`19`	`VStack(alignment: .leading, spacing: 4) {`
`@@ -27,6 +28,9 @@ struct RecordDetailView: View {`
`27`	`28`	`downloadFileHandler: downloadFileHandler`
`28`	`29`	`)`
`29`	`30`	`}`
	`31`	`+ FetchRecordCommentsView {`
	`32`	`+ await fetchRecordCommentsHandler(record.identity.id)`
	`33`	`+ }`
`30`	`34`	`}`
`31`	`35`	`.cornerRadiusBorder()`
`32`	`36`	`}`