feat: Support for status and type fields in AppContext APIs (#130)

* feat: appContext apis: added support for `status` and `type` fields

* added prameter descriptions

* fix: dart analyze, removed dead code.

* PubNub SDK v5.1.0 release.

---------

Co-authored-by: Mohit Tejani <mohit.tejani@Mohits-MacBook-Pro.local>
Co-authored-by: PubNub Release Bot <120067856+pubnub-release-bot@users.noreply.github.com>

.pubnub.yml

@@ -1,5 +1,10 @@
 ---
 changelog:
+  - date: 2024-12-18
+    version: v5.1.0
+    changes:
+      - type: feature
+        text: "Added support for `status` and `type` fields in AppContext APIs."
   - date: 2024-12-10
     version: v5.0.0
     changes:
@@ -461,7 +466,7 @@ supported-platforms:
     platforms:
       - "Dart SDK >=2.6.0 <3.0.0"
     version: "PubNub Dart SDK"
-version: "5.0.0"
+version: "5.1.0"
 sdks:
   -
     full-name: PubNub Dart SDK

pubnub/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v5.1.0
+December 18 2024
+
+#### Added
+- Added support for `status` and `type` fields in AppContext APIs.
+
 ## v5.0.0
 December 10 2024
 

pubnub/README.md

@@ -14,7 +14,7 @@ To add the package to your Dart or Flutter project, add `pubnub` as a dependency
 
 ```yaml
 dependencies:
-  pubnub: ^5.0.0
+  pubnub: ^5.1.0
 ```
 
 After adding the dependency to `pubspec.yaml`, run the `dart pub get` command in the root directory of your project (the same that the `pubspec.yaml` is in).

pubnub/lib/src/core/core.dart

@@ -21,7 +21,7 @@ class Core {
   /// Internal module responsible for supervising.
   SupervisorModule supervisor = SupervisorModule();
 
-  static String version = '5.0.0';
+  static String version = '5.1.0';
 
   Core(
       {Keyset? defaultKeyset,

pubnub/lib/src/crypto/encryption_mode.dart

@@ -11,8 +11,6 @@ extension EncryptionModeExtension on EncryptionMode {
         return AESMode.cbc;
       case EncryptionMode.ECB:
         return AESMode.ecb;
-      default:
-        throw Exception('Unreachable state');
     }
   }
 }

pubnub/lib/src/dx/_endpoints/push.dart

@@ -23,8 +23,6 @@ extension EnvironmentExtension on Environment {
         return 'development';
       case Environment.production:
         return 'production';
-      default:
-        throw Exception('Invalid Gateway Type');
     }
   }
 }
@@ -43,8 +41,6 @@ extension PushGatewayExtension on PushGateway {
         return 'apns';
       case PushGateway.apns2:
         return 'apns2';
-      default:
-        throw Exception('Invalid Gateway Type');
     }
   }
 }

pubnub/lib/src/dx/channel/channel_history.dart

@@ -19,8 +19,6 @@ extension ChannelHistoryOrderExtension on ChannelHistoryOrder {
         return descending;
       case ChannelHistoryOrder.ascending:
         return ascending;
-      default:
-        throw Exception('Unreachable state');
     }
   }
 }

pubnub/lib/src/dx/objects/channel_metadata.dart

@@ -17,6 +17,18 @@ class ChannelMetadata {
   /// To include `uuid` metadata fields of channel's memebrs in response, set [includeUUIDFields] to `true`
   /// To include `custom` fields of channel member's uuidMetadata, set [includeUUIDCustomFields] to `true`
   ///
+  /// To omit `status` field from member metadata, set [includeStatus] to `false`
+  /// Default is `true`.
+  ///
+  /// To omit `type` field from member metadata, set [includeType] to `false`
+  /// Default is `true`.
+  ///
+  /// To get `status` field of UUID metadata, set [includeUUIDStatus] to `true`
+  /// Default is `false`.
+  ///
+  /// To omit `type` field of UUID metadata, set [includeUUIDType] to `true`
+  /// Default is `false`.
+  ///
   /// Use [limit] to specify Number of objects to return in response.
   /// Default is 100, which is also the maximum value.
   ///
@@ -41,6 +53,10 @@ class ChannelMetadata {
           bool? includeUUIDFields,
           bool? includeUUIDCustomFields,
           bool? includeCount,
+          bool includeUUIDStatus = false,
+          bool includeUUIDType = false,
+          bool includeStatus = true,
+          bool includeType = true,
           String? filter,
           Set<String>? sort}) =>
       _objects.setChannelMembers(_id, channelMembersMetadata,
@@ -50,6 +66,10 @@ class ChannelMetadata {
           includeCustomFields: includeCustomFields,
           includeUUIDFields: includeUUIDFields,
           includeUUIDCustomFields: includeUUIDCustomFields,
+          includeUUIDStatus: includeUUIDStatus,
+          includeUUIDType: includeUUIDType,
+          includeStatus: includeStatus,
+          includeType: includeType,
           includeCount: includeCount,
           filter: filter,
           sort: sort);
@@ -61,6 +81,18 @@ class ChannelMetadata {
   /// To include `uuid` metadata fields of channel's memebrs in response, set [includeUUIDFields] to `true`
   /// To include `custom` fields of channel member's uuidMetadata, set [includeUUIDCustomFields] to `true`
   ///
+  /// To omit `status` field from member metadata, set [includeStatus] to `false`
+  /// Default is `true`.
+  ///
+  /// To omit `type` field from member metadata, set [includeType] to `false`
+  /// Default is `true`.
+  ///
+  /// To get `status` field of UUID metadata, set [includeUUIDStatus] to `true`
+  /// Default is `false`.
+  ///
+  /// To omit `type` field of UUID metadata, set [includeUUIDType] to `true`
+  /// Default is `false`.
+  ///
   /// Use [limit] to specify Number of objects to return in response.
   /// Default is 100, which is also the maximum value.
   ///
@@ -84,6 +116,10 @@ class ChannelMetadata {
           bool? includeUUIDFields,
           bool? includeUUIDCustomFields,
           bool? includeCount,
+          bool includeUUIDStatus = false,
+          bool includeUUIDType = false,
+          bool includeStatus = true,
+          bool includeType = true,
           String? filter,
           Set<String>? sort}) =>
       _objects.removeChannelMembers(_id, uuids,
@@ -94,6 +130,10 @@ class ChannelMetadata {
           includeCustomFields: includeCustomFields,
           includeUUIDFields: includeUUIDFields,
           includeUUIDCustomFields: includeUUIDCustomFields,
+          includeUUIDStatus: includeUUIDStatus,
+          includeUUIDType: includeUUIDType,
+          includeStatus: includeStatus,
+          includeType: includeType,
           includeCount: includeCount,
           filter: filter,
           sort: sort);