PubNub Swift Chat SDK 0.20.0 release (#20)

feat(async-await): add async/await counterparts to existing closure-based methods
feat(async-await): add `AsyncStream` counterparts for methods returning `AutoCloseable`
feat(tests): add a new Test Plan testing async/await methods and streams
feat(tests): introduce common classes for unit test targets to centralize shared functionality and reduce duplication
feat(message): add the new way to create a thread message
fix(chat): provide a default `ChatConfiguration()` value in the `ChatImpl` constructor
fix(chat): provide a default value for the `limit` parameter in the Chat's `getUsers(filter:sort:limit:page:completion:)`
fix(membership): fix `PubNub.MembershipSortField` extension to handle all user sort options properly

Author: jguz-pubnub

.github/workflows/run-tests.yml

@@ -32,7 +32,7 @@ jobs:
     strategy:
       matrix:
         environment: [iOS]
-    timeout-minutes: 18
+    timeout-minutes: 21
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

.pubnub.yml

@@ -1,8 +1,25 @@
 name: swift-chat-sdk
 scm: github.com/pubnub/swift-chat-sdk
-version: 0.12.0
+version: 0.20.0
 schema: 1
 changelog:
+  - date: 2025-03-25
+    version: 0.20.0
+    changes:
+      - type: feature
+        text: "Add async/await counterparts to existing closure-based methods."
+      - type: feature
+        text: "Add `AsyncStream` counterparts for methods returning `AutoCloseable`."
+      - type: feature
+        text: "Add a new Test Plan testing async/await methods and streams."
+      - type: feature
+        text: "Add the new way to create a thread message."
+      - type: bug
+        text: "Provide a default `ChatConfiguration()` value in the `ChatImpl` constructor."
+      - type: bug
+        text: "Provide a default value for the `limit` parameter in the Chat's `getUsers(filter:sort:limit:page:completion:)`."
+      - type: bug
+        text: "Fix `PubNub.MembershipSortField` extension to handle all user sort options properly."
   - date: 2025-03-21
     version: 0.12.0
     changes:
@@ -133,7 +150,7 @@ sdks:
           - distribution-type: source
             distribution-repository: GitHub release
             package-name: PubNubSwiftChatSDK
-            location: https://github.com/pubnub/swift-chat-sdk/archive/refs/tags/0.12.0.zip
+            location: https://github.com/pubnub/swift-chat-sdk/archive/refs/tags/0.20.0.zip
             supported-platforms:
               supported-operating-systems:
                 iOS:

.swiftlint.yml

@@ -6,8 +6,10 @@ disabled_rules:
   - type_name
   - function_body_length
   - function_parameter_count
+  - type_body_length
 included:
   - Sources/
+  - Tests/
 opt_in_rules:
   - force_unwrapping
   - overridden_super_call

PubNubSwiftChatSDK.xcodeproj/project.pbxproj

@@ -30,7 +30,7 @@
       shouldUseLaunchSchemeArgsEnv = "YES">
       <TestPlans>
          <TestPlanReference
-            reference = "container:Tests/PubNubSwiftChatSDKTests.xctestplan"
+            reference = "container:Tests/PubNubSwiftChatSDKAsyncTests.xctestplan"
             default = "YES">
          </TestPlanReference>
       </TestPlans>

PubNubSwiftChatSDK.xcodeproj/xcshareddata/xcschemes/PubNubSwiftChatSDK.xcscheme

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1530"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES"
+      buildArchitectures = "Automatic">
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "3D46D4552D131EB2007D08DB"
+               BuildableName = "PubNubSwiftChatSDKAsyncTests.xctest"
+               BlueprintName = "PubNubSwiftChatSDKAsyncTests"
+               ReferencedContainer = "container:PubNubSwiftChatSDK.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

PubNubSwiftChatSDK.xcodeproj/xcshareddata/xcschemes/PubNubSwiftChatSDKAsyncTests.xcscheme

@@ -4,79 +4,112 @@
 
 ### Receiving Updates
 
+- ``streamUpdates()``
 - ``streamUpdates(callback:)``
+- ``streamUpdatesOn(channels:)``
 - ``streamUpdatesOn(channels:callback:)``
+- ``streamReadReceipts()``
 - ``streamReadReceipts(callback:)``
+- ``streamMessageReports()``
 - ``streamMessageReports(callback:)``
+- ``streamPresence()``
 - ``streamPresence(callback:)``
 
 ### Update and Delete a Channel
 
+- ``update(name:custom:description:status:type:)``
 - ``update(name:custom:description:status:type:completion:)``
+- ``delete(soft:)``
 - ``delete(soft:completion:)``
 
 ### Typing Indicator
 
+- ``startTyping()``
 - ``startTyping(completion:)``
+- ``stopTyping()``
 - ``stopTyping(completion:)``
+- ``getTyping()``
 - ``getTyping(callback:)``
 
 ### Presence Management
 
+- ``whoIsPresent()``
 - ``whoIsPresent(completion:)``
+- ``isPresent(userId:)``
 - ``isPresent(userId:completion:)``
+- ``join(custom:)``
 - ``join(custom:callback:completion:)``
+- ``leave()``
 - ``leave(completion:)``
+- ``streamPresence()``
 - ``streamPresence(callback:)``
 
 ### Memberships Management
 
+- ``invite(user:)``
 - ``invite(user:completion:)``
+- ``inviteMultiple(users:)``
 - ``inviteMultiple(users:completion:)``
+- ``getMembers(limit:page:filter:sort:)``
 - ``getMembers(limit:page:filter:sort:completion:)``
 
 ### Sending a text
 
 - ``InputFile``
-- ``sendText(text:meta:shouldStore:usePost:ttl:mentionedUsers:referencedChannels:textLinks:quotedMessage:files:completion:)``
-- ``sendText(text:meta:shouldStore:usePost:ttl:quotedMessage:files:usersToMention:completion:)``
+- ``sendText(text:meta:shouldStore:usePost:ttl:quotedMessage:files:usersToMention:customPushData:)``
+- ``sendText(text:meta:shouldStore:usePost:ttl:quotedMessage:files:usersToMention:customPushData:completion:)``
+- ``sendText(text:meta:shouldStore:usePost:ttl:mentionedUsers:referencedChannels:textLinks:quotedMessage:files:customPushData:completion:)``
 
 ### Creating Message Draft
 
 - ``createMessageDraft(userSuggestionSource:isTypingIndicatorTriggered:userLimit:channelLimit:)``
 
 ### Messages Management
 
+- ``connect()``
 - ``connect(callback:)``
+- ``forward(message:)``
 - ``forward(message:completion:)``
+- ``getHistory(startTimetoken:endTimetoken:count:)``
 - ``getHistory(startTimetoken:endTimetoken:count:completion:)``
+- ``getMessage(timetoken:)``
 - ``getMessage(timetoken:completion:)``
 
 ### Pinning and Unpinning a Message
 
+- ``pinMessage(message:)``
 - ``pinMessage(message:completion:)``
+- ``unpinMessage()``
 - ``unpinMessage(completion:)``
+- ``getPinnedMessage()``
 - ``getPinnedMessage(completion:)``
 
 ### Push Management
 
+- ``registerForPush()``
 - ``registerForPush(completion:)``
+- ``unregisterFromPush()``
 - ``unregisterFromPush(completion:)``
 
 ### Delete a File
 
+- ``deleteFile(id:name:)``
 - ``deleteFile(id:name:completion:)``
 
 ### Getting Files
 
 - ``GetFileItem``
+- ``getFiles(limit:next:)``
 - ``getFiles(limit:next:completion:)``
 
 ### User Suggestions 
 
+- ``getUserSuggestions(text:limit:)``
 - ``getUserSuggestions(text:limit:completion:)``
 
 ### Message Reports
 
+- ``getMessageReportsHistory(startTimetoken:endTimetoken:count:)``
 - ``getMessageReportsHistory(startTimetoken:endTimetoken:count:completion:)``
+- ``streamMessageReports()``
 - ``streamMessageReports(callback:)``

PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/Channel.md

@@ -4,79 +4,112 @@
 
 ### Receiving Updates
 
+- ``streamUpdates()``
 - ``streamUpdates(callback:)``
+- ``streamUpdatesOn(channels:)``
 - ``streamUpdatesOn(channels:callback:)``
+- ``streamReadReceipts()``
 - ``streamReadReceipts(callback:)``
+- ``streamMessageReports()``
 - ``streamMessageReports(callback:)``
+- ``streamPresence()``
 - ``streamPresence(callback:)``
 
 ### Update and Delete a Channel
 
+- ``update(name:custom:description:status:type:)``
 - ``update(name:custom:description:status:type:completion:)``
+- ``delete(soft:)``
 - ``delete(soft:completion:)``
 
 ### Typing Indicator
 
+- ``startTyping()``
 - ``startTyping(completion:)``
+- ``stopTyping()``
 - ``stopTyping(completion:)``
+- ``getTyping()``
 - ``getTyping(callback:)``
 
 ### Presence Management
 
+- ``whoIsPresent()``
 - ``whoIsPresent(completion:)``
+- ``isPresent(userId:)``
 - ``isPresent(userId:completion:)``
+- ``join(custom:)``
 - ``join(custom:callback:completion:)``
+- ``leave()``
 - ``leave(completion:)``
+- ``streamPresence()``
 - ``streamPresence(callback:)``
 
 ### Memberships Management
 
+- ``invite(user:)``
 - ``invite(user:completion:)``
+- ``inviteMultiple(users:)``
 - ``inviteMultiple(users:completion:)``
+- ``getMembers(limit:page:filter:sort:)``
 - ``getMembers(limit:page:filter:sort:completion:)``
 
 ### Sending a text
 
 - ``InputFile``
-- ``sendText(text:meta:shouldStore:usePost:ttl:mentionedUsers:referencedChannels:textLinks:quotedMessage:files:completion:)``
-- ``sendText(text:meta:shouldStore:usePost:ttl:quotedMessage:files:usersToMention:completion:)``
+- ``sendText(text:meta:shouldStore:usePost:ttl:quotedMessage:files:usersToMention:customPushData:)``
+- ``sendText(text:meta:shouldStore:usePost:ttl:quotedMessage:files:usersToMention:customPushData:completion:)``
+- ``sendText(text:meta:shouldStore:usePost:ttl:mentionedUsers:referencedChannels:textLinks:quotedMessage:files:customPushData:completion:)``
 
 ### Creating Message Draft
 
 - ``createMessageDraft(userSuggestionSource:isTypingIndicatorTriggered:userLimit:channelLimit:)``
 
 ### Messages Management
 
+- ``connect()``
 - ``connect(callback:)``
+- ``forward(message:)``
 - ``forward(message:completion:)``
+- ``getHistory(startTimetoken:endTimetoken:count:)``
 - ``getHistory(startTimetoken:endTimetoken:count:completion:)``
+- ``getMessage(timetoken:)``
 - ``getMessage(timetoken:completion:)``
 
 ### Pinning and Unpinning a Message
 
+- ``pinMessage(message:)``
 - ``pinMessage(message:completion:)``
+- ``unpinMessage()``
 - ``unpinMessage(completion:)``
+- ``getPinnedMessage()``
 - ``getPinnedMessage(completion:)``
 
 ### Push Management
 
+- ``registerForPush()``
 - ``registerForPush(completion:)``
+- ``unregisterFromPush()``
 - ``unregisterFromPush(completion:)``
 
 ### Delete a File
 
+- ``deleteFile(id:name:)``
 - ``deleteFile(id:name:completion:)``
 
 ### Getting Files
 
 - ``GetFileItem``
+- ``getFiles(limit:next:)``
 - ``getFiles(limit:next:completion:)``
 
 ### User Suggestions 
 
+- ``getUserSuggestions(text:limit:)``
 - ``getUserSuggestions(text:limit:completion:)``
 
 ### Message Reports
 
+- ``getMessageReportsHistory(startTimetoken:endTimetoken:count:)``
 - ``getMessageReportsHistory(startTimetoken:endTimetoken:count:completion:)``
+- ``streamMessageReports()``
 - ``streamMessageReports(callback:)``