Merge pull request #25 from cybozu/breaking-change-interface

Breaking Change to API

Author: Kyome22

Example/Example/ContentView.swift

@@ -27,12 +27,12 @@ enum TabCategory {
     var appID: Int
     var isPresented = false
     var tabCategory = TabCategory.fetchApps
-    var apps = [KintoneApp]()
-    var layout = [FormLayout]()
-    var fields = [FieldProperty]()
-    var appSettings: AppSettings?
-    var records = [Record.Read]()
-    var statusSettings: AppStatusSettings?
+    var appsResponse: FetchAppsResponse?
+    var formLayoutResponse: FetchFormLayoutResponse?
+    var fieldsResponse: FetchFieldsResponse?
+    var appSettingsResponse: FetchAppSettingsResponse?
+    var recordsResponse: FetchRecordsResponse?
+    var appStatusSettingsResponse: FetchAppStatusSettingsResponse?
 
     var kintoneAPI: KintoneAPI {
         .init(
@@ -61,18 +61,18 @@ enum TabCategory {
 
     func onTask() async {
         do {
-            apps = try await kintoneAPI.fetchApps()
-            layout = try await kintoneAPI.fetchFormLayout(appID: appID)
-            fields = try await kintoneAPI.fetchFields(appID: appID)
-            appSettings = try await kintoneAPI.fetchAppSettings(appID: appID)
-            records = try await kintoneAPI.fetchRecords(appID: appID)
-            statusSettings = try await kintoneAPI.fetchAppStatusSettings(appID: appID)
+            appsResponse = try await kintoneAPI.fetchApps()
+            formLayoutResponse = try await kintoneAPI.fetchFormLayout(appID: appID)
+            fieldsResponse = try await kintoneAPI.fetchFields(appID: appID)
+            appSettingsResponse = try await kintoneAPI.fetchAppSettings(appID: appID)
+            recordsResponse = try await kintoneAPI.fetchRecords(appID: appID)
+            appStatusSettingsResponse = try await kintoneAPI.fetchAppStatusSettings(appID: appID)
         } catch {
             print(error.localizedDescription)
         }
     }
 
-    func fetchRecordComments(recordID: Int) async -> RecordComments? {
+    func fetchRecordComments(recordID: Int) async -> FetchRecordCommentsResponse? {
         do {
             return try await kintoneAPI.fetchRecordComments(appID: appID, recordID: recordID)
         } catch {
@@ -83,9 +83,9 @@ enum TabCategory {
 
     func updateStatus(recordIdentity: RecordIdentity.Write, action: StatusAction) async {
         do {
-            let assignee = statusSettings?.states.first(where: { $0.name == action.to })?.assignee.entities.first?.code
+            let assignee = appStatusSettingsResponse?.states.first(where: { $0.name == action.to })?.assignee.entities.first?.code
             try await kintoneAPI.updateStatus(appID: appID, recordIdentity: recordIdentity, actionName: action.name, assignee: assignee)
-            records = try await kintoneAPI.fetchRecords(appID: appID)
+            recordsResponse = try await kintoneAPI.fetchRecords(appID: appID)
         } catch {
             print(error.localizedDescription)
         }
@@ -100,7 +100,7 @@ enum TabCategory {
         }
     }
 
-    func onSubmitRecord(fields: [String: RecordFieldValue.Write]) async -> RecordIdentity.Read? {
+    func onSubmitRecord(fields: [String: RecordFieldValue.Write]) async -> SubmitRecordResponse? {
         do {
             let fields = fields.compactMap { RecordField.Write(code: $0.key, value: $0.value) }
             let record = Record.Write(fields: fields)
@@ -111,7 +111,7 @@ enum TabCategory {
         }
     }
 
-    func onUpdateRecord(recordID: Int, fields: [String: RecordFieldValue.Write]) async -> RecordIdentity.Read? {
+    func onUpdateRecord(recordID: Int, fields: [String: RecordFieldValue.Write]) async -> UpdateRecordResponse? {
         do {
             let recordIdentity = RecordIdentity.Write(id: recordID)
             let fields = fields.compactMap { RecordField.Write(code: $0.key, value: $0.value) }
@@ -132,7 +132,7 @@ enum TabCategory {
         }
     }
 
-    func uploadFile(fileArguments: FileArguments?) async -> String? {
+    func uploadFile(fileArguments: FileArguments?) async -> UploadFileResponse? {
         guard let fileArguments else { return nil }
         do {
             return try await kintoneAPI.uploadFile(
@@ -200,23 +200,29 @@ enum TabCategory {
             .navigationBarTitleDisplayMode(.inline)
             .navigationDestination(isPresented: $viewModel.isPresented) {
                 TabView(selection: $viewModel.tabCategory) {
-                    FetchAppsView(apps: viewModel.apps)
-                        .tabItem {
-                            Label("Apps", systemImage: "app.fill")
-                        }
-                        .tag(TabCategory.fetchApps)
-                    FetchFormLayoutView(layout: viewModel.layout)
-                        .tabItem {
-                            Label("Form Layout", systemImage: "square.grid.2x2")
-                        }
-                        .tag(TabCategory.fetchFormLayout)
-                    FetchFieldsView(fields: viewModel.fields)
-                        .tabItem {
-                            Label("Fields", systemImage: "square.3.layers.3d.down.left")
-                        }
-                        .tag(TabCategory.fetchFields)
+                    FetchAppsView(
+                        appsResponse: viewModel.appsResponse
+                    )
+                    .tabItem {
+                        Label("Apps", systemImage: "app.fill")
+                    }
+                    .tag(TabCategory.fetchApps)
+                    FetchFormLayoutView(
+                        formLayoutResponse: viewModel.formLayoutResponse
+                    )
+                    .tabItem {
+                        Label("Form Layout", systemImage: "square.grid.2x2")
+                    }
+                    .tag(TabCategory.fetchFormLayout)
+                    FetchFieldsView(
+                        fieldsResponse: viewModel.fieldsResponse
+                    )
+                    .tabItem {
+                        Label("Fields", systemImage: "square.3.layers.3d.down.left")
+                    }
+                    .tag(TabCategory.fetchFields)
                     FetchAppSettingsView(
-                        appSettings: viewModel.appSettings,
+                        appSettingsResponse: viewModel.appSettingsResponse,
                         downloadFileHandler: { fileKey in
                             await viewModel.downloadFile(fileKey: fileKey)
                         }
@@ -226,8 +232,8 @@ enum TabCategory {
                     }
                     .tag(TabCategory.fetchAppSettings)
                     FetchRecordsView(
-                        records: viewModel.records,
-                        actions: viewModel.statusSettings?.actions ?? [],
+                        recordsResponse: viewModel.recordsResponse,
+                        appStatusSettingsResponse: viewModel.appStatusSettingsResponse,
                         updateStatusHandler: { recordIdentity, action in
                             await viewModel.updateStatus(recordIdentity: recordIdentity, action: action)
                         },
@@ -243,7 +249,7 @@ enum TabCategory {
                     }
                     .tag(TabCategory.fetchRecords)
                     SubmitRecordView(
-                        fields: viewModel.fields,
+                        fieldsResponse: viewModel.fieldsResponse,
                         onSubmitRecordHandler: { fields in
                             await viewModel.onSubmitRecord(fields: fields)
                         },
@@ -265,11 +271,13 @@ enum TabCategory {
                         Label("Upload File", systemImage: "square.and.arrow.up")
                     }
                     .tag(TabCategory.uploadFile)
-                    FetchAppStatusSettingsView(statusSettings: viewModel.statusSettings)
-                        .tabItem {
-                            Label("Status", systemImage: "point.bottomleft.forward.to.arrow.triangle.scurvepath.fill")
-                        }
-                        .tag(TabCategory.status)
+                    FetchAppStatusSettingsView(
+                        appStatusSettingsResponse: viewModel.appStatusSettingsResponse
+                    )
+                    .tabItem {
+                        Label("Status", systemImage: "point.bottomleft.forward.to.arrow.triangle.scurvepath.fill")
+                    }
+                    .tag(TabCategory.status)
                 }
                 .navigationTitle("kintone API")
                 .task {

Example/Example/Extensions/KintoneAPI+Extension.swift

@@ -11,7 +11,7 @@ extension KintoneApp: @retroactive Identifiable {
     public var id: Int { appID }
 }
 
-extension FieldProperty: @retroactive Identifiable {
+extension Field: @retroactive Identifiable {
     public var id: String { code }
 }
 

Example/Example/FetchAppSettings/FetchAppSettingsView.swift

@@ -9,29 +9,57 @@ import KintoneAPI
 import SwiftUI
 
 struct FetchAppSettingsView: View {
-    var appSettings: AppSettings?
-    var downloadFileHandler: (String) async -> Data?
+    private var name: String?
+    private var description: String?
+    private var icon: AppIcon.Read?
+    private var theme: AppThemeType?
+    private var titleField: TitleField?
+    private var enableThumbnails: Bool?
+    private var enableBulkDeletion: Bool?
+    private var enableComments: Bool?
+    private var enableDuplicateRecord: Bool?
+    private var enableInlineRecordEditing: Bool?
+    private var numberPrecision: NumberPrecision?
+    private var firstMonthOfFiscalYear: Int?
+    private var revision: Int?
+    private var downloadFileHandler: (String) async -> Data?
+
+    init(
+        appSettingsResponse: FetchAppSettingsResponse?,
+        downloadFileHandler: @escaping (String) async -> Data?
+    ) {
+        name = appSettingsResponse?.name
+        description = appSettingsResponse?.description
+        icon = appSettingsResponse?.icon
+        theme = appSettingsResponse?.theme
+        titleField = appSettingsResponse?.titleField
+        enableThumbnails = appSettingsResponse?.enableThumbnails
+        enableBulkDeletion = appSettingsResponse?.enableBulkDeletion
+        enableComments = appSettingsResponse?.enableComments
+        enableDuplicateRecord = appSettingsResponse?.enableDuplicateRecord
+        enableInlineRecordEditing = appSettingsResponse?.enableInlineRecordEditing
+        numberPrecision = appSettingsResponse?.numberPrecision
+        firstMonthOfFiscalYear = appSettingsResponse?.firstMonthOfFiscalYear
+        revision = appSettingsResponse?.revision
+        self.downloadFileHandler = downloadFileHandler
+    }
 
     var body: some View {
         ScrollView {
             VStack(spacing: 8) {
-                if let appSettings {
-                    CornerRadiusText("Name: \(appSettings.name)")
-                    CornerRadiusText("Description: \(appSettings.description)")
-                    IconFileView(icon: appSettings.icon, downloadFileHandler: downloadFileHandler)
-                    CornerRadiusText("Theme: \(appSettings.theme)")
-                    TitleFieldView(titleField: appSettings.titleField)
-                    CornerRadiusText("Enable Thumbnails: \(appSettings.enableThumbnails)")
-                    CornerRadiusText("Enable Bulk Deletion: \(appSettings.enableBulkDeletion)")
-                    CornerRadiusText("Enable Comments: \(appSettings.enableComments)")
-                    CornerRadiusText("Enable Duplicate Record: \(appSettings.enableDuplicateRecord)")
-                    CornerRadiusText("Enable Inline Record Editing: \(appSettings.enableInlineRecordEditing)")
-                    NumberPrecisionView(numberPrecision: appSettings.numberPrecision)
-                    CornerRadiusText("First Month Of Fiscal Year: \(appSettings.firstMonthOfFiscalYear)")
-                    CornerRadiusText("Revision: \(appSettings.revision)")
-                } else {
-                    Spacer()
-                }
+                CornerRadiusText("Name: \(String(optional: name))")
+                CornerRadiusText("Description: \(String(optional: description))")
+                IconFileView(icon: icon, downloadFileHandler: downloadFileHandler)
+                CornerRadiusText("Theme: \(String(optional: theme?.rawValue))")
+                TitleFieldView(titleField: titleField)
+                CornerRadiusText("Enable Thumbnails: \(String(optional: enableThumbnails))")
+                CornerRadiusText("Enable Bulk Deletion: \(String(optional: enableBulkDeletion))")
+                CornerRadiusText("Enable Comments: \(String(optional: enableComments))")
+                CornerRadiusText("Enable Duplicate Record: \(String(optional: enableDuplicateRecord))")
+                CornerRadiusText("Enable Inline Record Editing: \(String(optional: enableInlineRecordEditing))")
+                NumberPrecisionView(numberPrecision: numberPrecision)
+                CornerRadiusText("First Month Of Fiscal Year: \(String(optional: firstMonthOfFiscalYear))")
+                CornerRadiusText("Revision: \(String(optional: revision))")
             }
             .padding()
         }

Example/Example/FetchAppSettings/IconFileView.swift

@@ -10,7 +10,7 @@ import SwiftUI
 
 struct IconFileView: View {
     @State private var isPresented = false
-    var icon: AppIcon.Read
+    var icon: AppIcon.Read?
     var downloadFileHandler: (String) async -> Data?
 
     var body: some View {
@@ -38,6 +38,9 @@ struct IconFileView: View {
                         await downloadFileHandler(file.fileKey)
                     }
                 }
+            case .none:
+                Text("nil")
+                    .frame(maxWidth: .infinity, alignment: .leading)
             }
         }
         .cornerRadiusBorder()

Example/Example/FetchAppSettings/NumberPrecisionView.swift

@@ -9,16 +9,16 @@ import KintoneAPI
 import SwiftUI
 
 struct NumberPrecisionView: View {
-    var numberPrecision: NumberPrecision
+    var numberPrecision: NumberPrecision?
 
     var body: some View {
         HStack(alignment: .top) {
             Text("Number Precision:")
             Divider()
             VStack(alignment: .leading, spacing: 4) {
-                Text("Digits: \(numberPrecision.digits)")
-                Text("Decimal Places: \(numberPrecision.decimalPlaces)")
-                Text("Rounding Mode: \(numberPrecision.roundingMode)")
+                Text("Digits: \(String(optional: numberPrecision?.digits))")
+                Text("Decimal Places: \(String(optional: numberPrecision?.decimalPlaces))")
+                Text("Rounding Mode: \(String(optional: numberPrecision?.roundingMode.rawValue))")
             }
             .frame(maxWidth: .infinity, alignment: .leading)
             .cornerRadiusBorder()

Example/Example/FetchAppSettings/TitleFieldView.swift

@@ -9,15 +9,15 @@ import KintoneAPI
 import SwiftUI
 
 struct TitleFieldView: View {
-    var titleField: TitleField
+    var titleField: TitleField?
 
     var body: some View {
         HStack(alignment: .top) {
             Text("Title Field:")
             Divider()
             VStack(alignment: .leading, spacing: 4) {
-                Text("Selection Mode: \(titleField.selectionMode)")
-                Text("Code: \(titleField.code)")
+                Text("Selection Mode: \(String(optional: titleField?.selectionMode.rawValue))")
+                Text("Code: \(String(optional: titleField?.code))")
             }
             .frame(maxWidth: .infinity, alignment: .leading)
             .cornerRadiusBorder()

Example/Example/FetchAppStatusSettings/FetchAppStatusSettingsView.swift

@@ -9,19 +9,25 @@ import KintoneAPI
 import SwiftUI
 
 struct FetchAppStatusSettingsView: View {
-    var statusSettings: AppStatusSettings?
+    private var enable: Bool?
+    private var states: [RecordState]
+    private var actions: [StatusAction]
+    private var revision: Int?
+
+    init(appStatusSettingsResponse: FetchAppStatusSettingsResponse?) {
+        enable = appStatusSettingsResponse?.enable
+        states = appStatusSettingsResponse?.states ?? []
+        actions = appStatusSettingsResponse?.actions ?? []
+        revision = appStatusSettingsResponse?.revision
+    }
 
     var body: some View {
         ScrollView {
             VStack(spacing: 8) {
-                if let statusSettings {
-                    CornerRadiusText("Enable: \(statusSettings.enable)")
-                    CornerRadiusText("Revision: \(statusSettings.revision)")
-                    StatesView(states: statusSettings.states)
-                    ActionsView(actions: statusSettings.actions)
-                } else {
-                    Spacer()
-                }
+                CornerRadiusText("Enable: \(String(optional: enable))")
+                CornerRadiusText("Revision: \(String(optional: revision))")
+                StatesView(states: states)
+                ActionsView(actions: actions)
             }
             .padding()
         }

Example/Example/FetchApps/FetchAppsView.swift

@@ -9,7 +9,11 @@ import KintoneAPI
 import SwiftUI
 
 struct FetchAppsView: View {
-    var apps: [KintoneApp]
+    private var apps: [KintoneApp]
+
+    init(appsResponse: FetchAppsResponse?) {
+        apps = appsResponse?.apps ?? []
+    }
 
     var body: some View {
         ScrollView {

Example/Example/FetchFields/FetchFieldsView.swift

@@ -9,14 +9,21 @@ import KintoneAPI
 import SwiftUI
 
 struct FetchFieldsView: View {
-    var fields: [FieldProperty]
+    private var fields: [Field]
+    private var revision: Int?
+
+    init(fieldsResponse: FetchFieldsResponse?) {
+        fields = fieldsResponse?.fields ?? []
+        revision = fieldsResponse?.revision
+    }
 
     var body: some View {
         ScrollView {
             VStack(spacing: 16) {
                 ForEach(fields) { field in
                     FieldDetailView(field: field)
                 }
+                CornerRadiusText("Revision: \(String(optional: revision))")
             }
             .padding()
         }

Example/Example/FetchFields/FieldDetailView.swift

@@ -9,7 +9,7 @@ import KintoneAPI
 import SwiftUI
 
 struct FieldDetailView: View {
-    var field: FieldProperty
+    var field: Field
 
     var body: some View {
         HStack(alignment: .top) {