fix(lib): fix custom metadata not being returned properly (#110)

* fix(lib): fix custom metadata not being returned properly

* fix(lib): fix types

* PubNub SDK v0.22.0 release.

---------

Co-authored-by: PubNub Release Bot <[email protected]>

Author: piotr-suwala

.pubnub.yml

@@ -1,12 +1,17 @@
 ---
 name: pubnub-react-chat-components
-version: v0.21.0
+version: v0.22.0
 scm: github.com/pubnub/react-chat-components
 schema: 1
 files:
   - lib/dist/index.js
   - lib/dist/index.es.js
 changelog:
+  - date: 2023-03-28
+    version: v0.22.0
+    changes:
+      - type: feature
+        text: "UseUserMemberships hook and useChannelMembers - make sure that both channel and user custom metadata fields are present in the hooks' responses."
   - date: 2023-03-27
     version: v0.21.0
     changes:

packages/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pubnub/common-chat-components",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "main": "src/index.ts",
   "license": "MIT",
   "scripts": {

packages/common/src/hooks/use-channel-members.ts

@@ -2,15 +2,15 @@ import { useState, useEffect, useMemo } from "react";
 import { GetChannelMembersParameters } from "pubnub";
 import { usePubNub } from "pubnub-react";
 import { merge, cloneDeep } from "lodash";
-import { UserEntity } from "../types";
+import { UserEntityWithMembership } from "../types";
 
-type HookReturnValue = [UserEntity[], () => void, () => void, number, Error];
+type HookReturnValue = [UserEntityWithMembership[], () => void, () => void, number, Error];
 
 export const useChannelMembers = (options: GetChannelMembersParameters): HookReturnValue => {
   const jsonOptions = JSON.stringify(options);
 
   const pubnub = usePubNub();
-  const [members, setMembers] = useState<UserEntity[]>([]);
+  const [members, setMembers] = useState<UserEntityWithMembership[]>([]);
   const [totalCount, setTotalCount] = useState(0);
   const [page, setPage] = useState("");
   const [error, setError] = useState<Error>();
@@ -49,11 +49,22 @@ export const useChannelMembers = (options: GetChannelMembersParameters): HookRet
       try {
         if (totalCount && members.length >= totalCount) return;
         const response = await pubnub.objects.getChannelMembers(paginatedOptions);
+
         if (ignoreRequest) return;
         setDoFetch(false);
         setMembers((members) => [
           ...members,
-          ...(response.data.map((m) => m.uuid) as UserEntity[]),
+          ...(response.data.map((m) => {
+            const returnObject = {
+              ...m.uuid,
+            } as UserEntityWithMembership;
+
+            if (m.custom) {
+              returnObject.membership = m.custom;
+            }
+
+            return returnObject;
+          }) as UserEntityWithMembership[]),
         ]);
         setTotalCount(response.totalCount);
         setPage(response.next);

packages/common/src/hooks/use-user-memberships.ts

@@ -2,15 +2,15 @@ import { useState, useEffect, useMemo } from "react";
 import { GetMembershipsParametersv2 } from "pubnub";
 import { usePubNub } from "pubnub-react";
 import { merge, cloneDeep } from "lodash";
-import { ChannelEntity } from "../types";
+import { ChannelEntityWithMembership } from "../types";
 
-type HookReturnValue = [ChannelEntity[], () => void, () => void, number, Error];
+type HookReturnValue = [ChannelEntityWithMembership[], () => void, () => void, number, Error];
 
 export const useUserMemberships = (options: GetMembershipsParametersv2 = {}): HookReturnValue => {
   const jsonOptions = JSON.stringify(options);
 
   const pubnub = usePubNub();
-  const [channels, setChannels] = useState<ChannelEntity[]>([]);
+  const [channels, setChannels] = useState<ChannelEntityWithMembership[]>([]);
   const [totalCount, setTotalCount] = useState(0);
   const [page, setPage] = useState("");
   const [error, setError] = useState<Error>();
@@ -49,20 +49,22 @@ export const useUserMemberships = (options: GetMembershipsParametersv2 = {}): Ho
       try {
         if (totalCount && channels.length >= totalCount) return;
         const response = await pubnub.objects.getMemberships(paginatedOptions);
+
         if (ignoreRequest) return;
         setDoFetch(false);
         setChannels((channels) => [
           ...channels,
           ...(response.data.map((m) => {
+            const returnObject = {
+              ...m.channel,
+            } as ChannelEntityWithMembership;
+
             if (m.custom) {
-              return {
-                ...m.channel,
-                custom: m.custom,
-              };
+              returnObject.membership = m.custom;
             }
 
-            return m.channel;
-          }) as ChannelEntity[]),
+            return returnObject;
+          }) as ChannelEntityWithMembership[]),
         ]);
         setTotalCount(response.totalCount);
         setPage(response.next);

packages/common/src/types.ts

@@ -11,6 +11,14 @@ export type ChannelEntity = ChannelMetadataObject<ObjectCustom>;
 
 export type UserEntity = UUIDMetadataObject<ObjectCustom>;
 
+export type ChannelEntityWithMembership = ChannelEntity & {
+  membership?: ObjectCustom;
+};
+
+export type UserEntityWithMembership = UserEntity & {
+  membership?: ObjectCustom;
+};
+
 export interface MessageEnvelope {
   channel?: string;
   message: MessagePayload | FilePayload;

packages/react-native/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pubnub/react-native-chat-components",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "description": "PubNub Chat Components is a development kit of React Native components that aims to help you to easily build Chat applications using PubNub infrastructure. It removes the complexicity of picking an adequate Chat engine, learning its APIs and dealing with its low-level internals. As the same time it allows you to create apps of various use cases, with different functionalities and customizable looks.",
   "author": "PubNub <[email protected]>",
   "main": "dist/commonjs/index",

packages/react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pubnub/react-chat-components",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "description": "PubNub Chat Components is a development kit of React components that aims to help you to easily build Chat applications using PubNub infrastructure. It removes the complexicity of picking an adequate Chat engine, learning its APIs and dealing with its low-level internals. As the same time it allows you to create apps of various use cases, with different functionalities and customizable looks.",
   "author": "PubNub <[email protected]>",
   "main": "dist/index.js",