Merge pull request #1 from FastComments/release-2025-11-20

Release v0.1.0 - Add optional response fields, comment approvals, adds Linux support

Author: winrid

.swift-version

@@ -0,0 +1 @@
+6.2.1

Package.resolved

@@ -20,12 +20,16 @@ let package = Package(
     dependencies: [
         // Dependencies declare other packages that this package depends on.
         .package(url: "https://github.com/Alamofire/Alamofire.git", from: "5.8.0"),
+        .package(url: "https://github.com/apple/swift-crypto.git", from: "3.0.0"),
     ],
     targets: [
         // Targets are the basic building blocks of a package, defining a module or a test suite.
         .target(
             name: "FastCommentsSwift",
-            dependencies: ["Alamofire"],
+            dependencies: [
+                "Alamofire",
+                .product(name: "Crypto", package: "swift-crypto", condition: .when(platforms: [.linux])),
+            ],
             path: ".",
             exclude: [
                 "Tests",

Package.swift

@@ -10,7 +10,7 @@ Add the following to your `Package.swift` file:
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "0.0.1")
+    .package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "0.1.0")
 ]
 ```
 

README.md

@@ -1,5 +1,10 @@
 import Foundation
+
+#if canImport(CryptoKit)
 import CryptoKit
+#else
+import Crypto
+#endif
 
 /// Helper functions for FastComments SSO
 public enum Helpers {

Sources/FastCommentsSwift/SSO/Helpers.swift

@@ -11,15 +11,18 @@ public struct APICreateUserBadgeResponse: Sendable, Codable, JSONEncodable, Hash
 
     public var status: APIStatus
     public var userBadge: UserBadge
+    public var notes: [String]?
 
-    public init(status: APIStatus, userBadge: UserBadge) {
+    public init(status: APIStatus, userBadge: UserBadge, notes: [String]? = nil) {
         self.status = status
         self.userBadge = userBadge
+        self.notes = notes
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
         case status
         case userBadge
+        case notes
     }
 
     // Encodable protocol methods
@@ -28,6 +31,7 @@ public struct APICreateUserBadgeResponse: Sendable, Codable, JSONEncodable, Hash
         var container = encoder.container(keyedBy: CodingKeys.self)
         try container.encode(status, forKey: .status)
         try container.encode(userBadge, forKey: .userBadge)
+        try container.encodeIfPresent(notes, forKey: .notes)
     }
 }
 

client/FastCommentsSwift/Models/APICreateUserBadgeResponse.swift

@@ -11,6 +11,7 @@ public struct CreateUserBadge200Response: Sendable, Codable, JSONEncodable, Hash
 
     public var status: APIStatus
     public var userBadge: UserBadge
+    public var notes: [String]?
     public var reason: String
     public var code: String
     public var secondaryCode: String?
@@ -19,9 +20,10 @@ public struct CreateUserBadge200Response: Sendable, Codable, JSONEncodable, Hash
     public var translatedError: String?
     public var customConfig: CustomConfigParameters?
 
-    public init(status: APIStatus, userBadge: UserBadge, reason: String, code: String, secondaryCode: String? = nil, bannedUntil: Int64? = nil, maxCharacterLength: Int? = nil, translatedError: String? = nil, customConfig: CustomConfigParameters? = nil) {
+    public init(status: APIStatus, userBadge: UserBadge, notes: [String]? = nil, reason: String, code: String, secondaryCode: String? = nil, bannedUntil: Int64? = nil, maxCharacterLength: Int? = nil, translatedError: String? = nil, customConfig: CustomConfigParameters? = nil) {
         self.status = status
         self.userBadge = userBadge
+        self.notes = notes
         self.reason = reason
         self.code = code
         self.secondaryCode = secondaryCode
@@ -34,6 +36,7 @@ public struct CreateUserBadge200Response: Sendable, Codable, JSONEncodable, Hash
     public enum CodingKeys: String, CodingKey, CaseIterable {
         case status
         case userBadge
+        case notes
         case reason
         case code
         case secondaryCode
@@ -49,6 +52,7 @@ public struct CreateUserBadge200Response: Sendable, Codable, JSONEncodable, Hash
         var container = encoder.container(keyedBy: CodingKeys.self)
         try container.encode(status, forKey: .status)
         try container.encode(userBadge, forKey: .userBadge)
+        try container.encodeIfPresent(notes, forKey: .notes)
         try container.encode(reason, forKey: .reason)
         try container.encode(code, forKey: .code)
         try container.encodeIfPresent(secondaryCode, forKey: .secondaryCode)

client/FastCommentsSwift/Models/CreateUserBadge200Response.swift

@@ -61,6 +61,7 @@ public struct CustomConfigParameters: Sendable, Codable, JSONEncodable, Hashable
     public var noStyles: Bool?
     public var pageSize: Int?
     public var readonly: Bool?
+    public var noNewRootComments: Bool?
     public var requireSSO: Bool?
     public var enableResizeHandle: Bool?
     public var restrictedLinkDomains: [String]?
@@ -83,7 +84,7 @@ public struct CustomConfigParameters: Sendable, Codable, JSONEncodable, Hashable
     public var widgetSubQuestionVisibility: QuestionSubQuestionVisibility?
     public var wrap: Bool?
 
-    public init(absoluteAndRelativeDates: Bool? = nil, absoluteDates: Bool? = nil, allowAnon: Bool? = nil, allowAnonFlag: Bool? = nil, allowAnonVotes: Bool? = nil, allowedLanguages: [String]? = nil, collapseReplies: Bool? = nil, commentCountFormat: String? = nil, commentHTMLRenderingMode: CommentHTMLRenderingMode? = nil, commentThreadDeleteMode: CommentThreadDeletionMode? = nil, commenterNameFormat: CommenterNameFormats? = nil, countAboveToggle: Int? = nil, customCSS: String? = nil, defaultAvatarSrc: String? = nil, defaultSortDirection: SortDirections? = nil, defaultUsername: String? = nil, disableAutoAdminMigration: Bool? = nil, disableAutoHashTagCreation: Bool? = nil, disableBlocking: Bool? = nil, disableCommenterCommentDelete: Bool? = nil, disableCommenterCommentEdit: Bool? = nil, disableEmailInputs: Bool? = nil, disableLiveCommenting: Bool? = nil, disableNotificationBell: Bool? = nil, disableProfiles: Bool? = nil, disableSuccessMessage: Bool? = nil, disableToolbar: Bool? = nil, disableUnverifiedLabel: Bool? = nil, disableVoting: Bool? = nil, enableCommenterLinks: Bool? = nil, enableSearch: Bool? = nil, enableSpoilers: Bool? = nil, enableThirdPartyCookieBypass: Bool? = nil, enableViewCounts: Bool? = nil, enableVoteList: Bool? = nil, enableWYSIWYG: Bool? = nil, gifRating: GifRating? = nil, hasDarkBackground: Bool? = nil, headerHTML: String? = nil, hideAvatars: Bool? = nil, hideCommentsUnderCountTextFormat: String? = nil, imageContentProfanityLevel: ImageContentProfanityLevel? = nil, inputAfterComments: Bool? = nil, limitCommentsByGroups: Bool? = nil, locale: String? = nil, maxCommentCharacterLength: Int? = nil, maxCommentCreatedCountPUPM: Int? = nil, noCustomConfig: Bool? = nil, noImageUploads: Bool? = nil, noStyles: Bool? = nil, pageSize: Int? = nil, readonly: Bool? = nil, requireSSO: Bool? = nil, enableResizeHandle: Bool? = nil, restrictedLinkDomains: [String]? = nil, showBadgesInTopBar: Bool? = nil, showCommentSaveSuccess: Bool? = nil, showLiveRightAway: Bool? = nil, showQuestion: Bool? = nil, spamRules: [SpamRule]? = nil, ssoSecLvl: SSOSecurityLevel? = nil, translations: [String: String]? = nil, useShowCommentsToggle: Bool? = nil, useSingleLineCommentInput: Bool? = nil, voteStyle: VoteStyle? = nil, widgetQuestionId: String? = nil, widgetQuestionResultsStyle: CommentQuestionResultsRenderingType? = nil, widgetQuestionStyle: QuestionRenderingType? = nil, widgetQuestionWhenToSave: QuestionWhenSave? = nil, widgetQuestionsRequired: CommentQuestionsRequired? = nil, widgetSubQuestionVisibility: QuestionSubQuestionVisibility? = nil, wrap: Bool? = nil) {
+    public init(absoluteAndRelativeDates: Bool? = nil, absoluteDates: Bool? = nil, allowAnon: Bool? = nil, allowAnonFlag: Bool? = nil, allowAnonVotes: Bool? = nil, allowedLanguages: [String]? = nil, collapseReplies: Bool? = nil, commentCountFormat: String? = nil, commentHTMLRenderingMode: CommentHTMLRenderingMode? = nil, commentThreadDeleteMode: CommentThreadDeletionMode? = nil, commenterNameFormat: CommenterNameFormats? = nil, countAboveToggle: Int? = nil, customCSS: String? = nil, defaultAvatarSrc: String? = nil, defaultSortDirection: SortDirections? = nil, defaultUsername: String? = nil, disableAutoAdminMigration: Bool? = nil, disableAutoHashTagCreation: Bool? = nil, disableBlocking: Bool? = nil, disableCommenterCommentDelete: Bool? = nil, disableCommenterCommentEdit: Bool? = nil, disableEmailInputs: Bool? = nil, disableLiveCommenting: Bool? = nil, disableNotificationBell: Bool? = nil, disableProfiles: Bool? = nil, disableSuccessMessage: Bool? = nil, disableToolbar: Bool? = nil, disableUnverifiedLabel: Bool? = nil, disableVoting: Bool? = nil, enableCommenterLinks: Bool? = nil, enableSearch: Bool? = nil, enableSpoilers: Bool? = nil, enableThirdPartyCookieBypass: Bool? = nil, enableViewCounts: Bool? = nil, enableVoteList: Bool? = nil, enableWYSIWYG: Bool? = nil, gifRating: GifRating? = nil, hasDarkBackground: Bool? = nil, headerHTML: String? = nil, hideAvatars: Bool? = nil, hideCommentsUnderCountTextFormat: String? = nil, imageContentProfanityLevel: ImageContentProfanityLevel? = nil, inputAfterComments: Bool? = nil, limitCommentsByGroups: Bool? = nil, locale: String? = nil, maxCommentCharacterLength: Int? = nil, maxCommentCreatedCountPUPM: Int? = nil, noCustomConfig: Bool? = nil, noImageUploads: Bool? = nil, noStyles: Bool? = nil, pageSize: Int? = nil, readonly: Bool? = nil, noNewRootComments: Bool? = nil, requireSSO: Bool? = nil, enableResizeHandle: Bool? = nil, restrictedLinkDomains: [String]? = nil, showBadgesInTopBar: Bool? = nil, showCommentSaveSuccess: Bool? = nil, showLiveRightAway: Bool? = nil, showQuestion: Bool? = nil, spamRules: [SpamRule]? = nil, ssoSecLvl: SSOSecurityLevel? = nil, translations: [String: String]? = nil, useShowCommentsToggle: Bool? = nil, useSingleLineCommentInput: Bool? = nil, voteStyle: VoteStyle? = nil, widgetQuestionId: String? = nil, widgetQuestionResultsStyle: CommentQuestionResultsRenderingType? = nil, widgetQuestionStyle: QuestionRenderingType? = nil, widgetQuestionWhenToSave: QuestionWhenSave? = nil, widgetQuestionsRequired: CommentQuestionsRequired? = nil, widgetSubQuestionVisibility: QuestionSubQuestionVisibility? = nil, wrap: Bool? = nil) {
         self.absoluteAndRelativeDates = absoluteAndRelativeDates
         self.absoluteDates = absoluteDates
         self.allowAnon = allowAnon
@@ -136,6 +137,7 @@ public struct CustomConfigParameters: Sendable, Codable, JSONEncodable, Hashable
         self.noStyles = noStyles
         self.pageSize = pageSize
         self.readonly = readonly
+        self.noNewRootComments = noNewRootComments
         self.requireSSO = requireSSO
         self.enableResizeHandle = enableResizeHandle
         self.restrictedLinkDomains = restrictedLinkDomains
@@ -211,6 +213,7 @@ public struct CustomConfigParameters: Sendable, Codable, JSONEncodable, Hashable
         case noStyles
         case pageSize
         case readonly
+        case noNewRootComments
         case requireSSO
         case enableResizeHandle
         case restrictedLinkDomains
@@ -289,6 +292,7 @@ public struct CustomConfigParameters: Sendable, Codable, JSONEncodable, Hashable
         try container.encodeIfPresent(noStyles, forKey: .noStyles)
         try container.encodeIfPresent(pageSize, forKey: .pageSize)
         try container.encodeIfPresent(readonly, forKey: .readonly)
+        try container.encodeIfPresent(noNewRootComments, forKey: .noNewRootComments)
         try container.encodeIfPresent(requireSSO, forKey: .requireSSO)
         try container.encodeIfPresent(enableResizeHandle, forKey: .enableResizeHandle)
         try container.encodeIfPresent(restrictedLinkDomains, forKey: .restrictedLinkDomains)

client/FastCommentsSwift/Models/CustomConfigParameters.swift

@@ -11,19 +11,22 @@ public struct PatchPageAPIResponse: Sendable, Codable, JSONEncodable, Hashable {
 
     public var reason: String?
     public var code: String?
+    public var commentsUpdated: Int64?
     public var page: APIPage?
     public var status: String
 
-    public init(reason: String? = nil, code: String? = nil, page: APIPage? = nil, status: String) {
+    public init(reason: String? = nil, code: String? = nil, commentsUpdated: Int64? = nil, page: APIPage? = nil, status: String) {
         self.reason = reason
         self.code = code
+        self.commentsUpdated = commentsUpdated
         self.page = page
         self.status = status
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
         case reason
         case code
+        case commentsUpdated
         case page
         case status
     }
@@ -34,6 +37,7 @@ public struct PatchPageAPIResponse: Sendable, Codable, JSONEncodable, Hashable {
         var container = encoder.container(keyedBy: CodingKeys.self)
         try container.encodeIfPresent(reason, forKey: .reason)
         try container.encodeIfPresent(code, forKey: .code)
+        try container.encodeIfPresent(commentsUpdated, forKey: .commentsUpdated)
         try container.encodeIfPresent(page, forKey: .page)
         try container.encode(status, forKey: .status)
     }

client/FastCommentsSwift/Models/PatchPageAPIResponse.swift

@@ -37,6 +37,7 @@ public struct PublicComment: Sendable, Codable, JSONEncodable, Hashable {
     public var feedbackIds: [String]?
     public var requiresVerification: Bool?
     public var editKey: String?
+    public var approved: Bool?
     public var isUnread: Bool?
     public var myVoteId: String?
     public var isVotedDown: Bool?
@@ -51,7 +52,7 @@ public struct PublicComment: Sendable, Codable, JSONEncodable, Hashable {
     public var isFlagged: Bool?
     public var isBlocked: Bool?
 
-    public init(id: String, userId: String? = nil, commenterName: String, commenterLink: String? = nil, commentHTML: String, parentId: String? = nil, date: Date?, votes: Int? = nil, votesUp: Int? = nil, votesDown: Int? = nil, verified: Bool, avatarSrc: String? = nil, hasImages: Bool? = nil, isByAdmin: Bool? = nil, isByModerator: Bool? = nil, isPinned: Bool? = nil, isLocked: Bool? = nil, displayLabel: String? = nil, rating: Double? = nil, badges: [CommentUserBadgeInfo]? = nil, viewCount: Int64? = nil, isDeleted: Bool? = nil, isDeletedUser: Bool? = nil, isSpam: Bool? = nil, anonUserId: String? = nil, feedbackIds: [String]? = nil, requiresVerification: Bool? = nil, editKey: String? = nil, isUnread: Bool? = nil, myVoteId: String? = nil, isVotedDown: Bool? = nil, isVotedUp: Bool? = nil, hasChildren: Bool? = nil, nestedChildrenCount: Int? = nil, childCount: Int? = nil, children: [PublicComment]? = nil, isFlagged: Bool? = nil, isBlocked: Bool? = nil) {
+    public init(id: String, userId: String? = nil, commenterName: String, commenterLink: String? = nil, commentHTML: String, parentId: String? = nil, date: Date?, votes: Int? = nil, votesUp: Int? = nil, votesDown: Int? = nil, verified: Bool, avatarSrc: String? = nil, hasImages: Bool? = nil, isByAdmin: Bool? = nil, isByModerator: Bool? = nil, isPinned: Bool? = nil, isLocked: Bool? = nil, displayLabel: String? = nil, rating: Double? = nil, badges: [CommentUserBadgeInfo]? = nil, viewCount: Int64? = nil, isDeleted: Bool? = nil, isDeletedUser: Bool? = nil, isSpam: Bool? = nil, anonUserId: String? = nil, feedbackIds: [String]? = nil, requiresVerification: Bool? = nil, editKey: String? = nil, approved: Bool? = nil, isUnread: Bool? = nil, myVoteId: String? = nil, isVotedDown: Bool? = nil, isVotedUp: Bool? = nil, hasChildren: Bool? = nil, nestedChildrenCount: Int? = nil, childCount: Int? = nil, children: [PublicComment]? = nil, isFlagged: Bool? = nil, isBlocked: Bool? = nil) {
         self.id = id
         self.userId = userId
         self.commenterName = commenterName
@@ -80,6 +81,7 @@ public struct PublicComment: Sendable, Codable, JSONEncodable, Hashable {
         self.feedbackIds = feedbackIds
         self.requiresVerification = requiresVerification
         self.editKey = editKey
+        self.approved = approved
         self.isUnread = isUnread
         self.myVoteId = myVoteId
         self.isVotedDown = isVotedDown
@@ -121,6 +123,7 @@ public struct PublicComment: Sendable, Codable, JSONEncodable, Hashable {
         case feedbackIds
         case requiresVerification
         case editKey
+        case approved
         case isUnread
         case myVoteId
         case isVotedDown
@@ -165,6 +168,7 @@ public struct PublicComment: Sendable, Codable, JSONEncodable, Hashable {
         try container.encodeIfPresent(feedbackIds, forKey: .feedbackIds)
         try container.encodeIfPresent(requiresVerification, forKey: .requiresVerification)
         try container.encodeIfPresent(editKey, forKey: .editKey)
+        try container.encodeIfPresent(approved, forKey: .approved)
         try container.encodeIfPresent(isUnread, forKey: .isUnread)
         try container.encodeIfPresent(myVoteId, forKey: .myVoteId)
         try container.encodeIfPresent(isVotedDown, forKey: .isVotedDown)