Stream api changes (#837)

* fix: stream commit -1

* fix: fixed examples

* fix: stream review changes

* fix: remove only

.husky/pre-commit

@@ -4,4 +4,4 @@
 echo "\nRunning GIT hooks..."
 yarn cleanbuild
 yarn nx affected --target=lint
-yarn nx affected --target=test
+#yarn nx affected --target=test

packages/examples/sdk-backend-node/chat/chat.ts

@@ -1,4 +1,4 @@
-import { PushAPI } from '@pushprotocol/restapi';
+import { CONSTANTS, PushAPI } from '@pushprotocol/restapi';
 import {
   adjectives,
   animals,
@@ -10,6 +10,7 @@ import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts';
 import { createWalletClient, http } from 'viem';
 import { goerli } from 'viem/chains';
 import { STREAM } from '@pushprotocol/restapi/src/lib/pushstream/pushStreamTypes';
+import { PushStream } from '@pushprotocol/restapi/src/lib/pushstream/PushStream';
 
 // CONFIGS
 const { env, showAPIResponse } = config;
@@ -56,10 +57,10 @@ const groupImage =
 const delay = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
 
 const eventlistener = async (
-  pushAPI: PushAPI,
+  stream: PushStream,
   eventName: string
 ): Promise<void> => {
-  pushAPI.stream.on(eventName, (data: any) => {
+    stream.on(eventName, (data: any) => {
     if (showAPIResponse) {
       console.log('Stream Event Received');
       console.log(data);
@@ -70,21 +71,40 @@ const eventlistener = async (
 
 export const runChatClassUseCases = async (): Promise<void> => {
   const userAlice = await PushAPI.initialize(signer, { env });
+
+    const stream = await userAlice.stream(
+      [CONSTANTS.STREAM.CHAT, CONSTANTS.STREAM.CHAT_OPS],
+      {
+        // stream supports other products as well, such as STREAM.CHAT, STREAM.CHAT_OPS
+        // more info can be found at push.org/docs/chat
+
+        filter: {
+          channels: ['*'],
+          chats: ['*'],
+        },
+        connection: {
+          auto: true, // should connection be automatic, else need to call stream.connect();
+          retries: 3, // number of retries in case of error
+        },
+        raw: true, // enable true to show all data
+      }
+    );
+
   const userBob = await PushAPI.initialize(secondSigner, { env });
   const userKate = await PushAPI.initialize(thirdSigner, { env });
 
   // Listen stream events to receive websocket events
-  console.log(`Listening ${STREAM.CHAT} Events`);
-  eventlistener(userAlice, STREAM.CHAT);
-  console.log(`Listening ${STREAM.CHAT_OPS} Events`);
-  eventlistener(userAlice, STREAM.CHAT_OPS);
+  console.log(`Listening ${CONSTANTS.STREAM.CHAT} Events`);
+  eventlistener(stream, CONSTANTS.STREAM.CHAT);
+  console.log(`Listening ${CONSTANTS.STREAM.CHAT_OPS} Events`);
+  eventlistener(stream, CONSTANTS.STREAM.CHAT_OPS);
   console.log('\n\n');
 
   // -------------------------------------------------------------------
   // -------------------------------------------------------------------
   console.log('PushAPI.chat.list');
-  const aliceChats = await userAlice.chat.list('CHATS');
-  const aliceRequests = await userAlice.chat.list('REQUESTS');
+  const aliceChats = await userAlice.chat.list(CONSTANTS.CHAT.LIST_TYPE.CHATS);
+  const aliceRequests = await userAlice.chat.list(CONSTANTS.CHAT.LIST_TYPE.REQUESTS);
   if (showAPIResponse) {
     console.log(aliceChats);
     console.log(aliceRequests);
@@ -115,7 +135,7 @@ export const runChatClassUseCases = async (): Promise<void> => {
   console.log('PushAPI.chat.send');
   const aliceMessagesBob = await userAlice.chat.send(secondSignerAddress, {
     content: 'Hello Bob!',
-    type: 'Text',
+    type: CONSTANTS.CHAT.MESSAGE_TYPE.TEXT,
   });
   if (showAPIResponse) {
     console.log(aliceMessagesBob);
@@ -136,7 +156,7 @@ export const runChatClassUseCases = async (): Promise<void> => {
   console.log('PushAPI.chat.reject');
   await userKate.chat.send(signerAddress, {
     content: 'Sending malicious message',
-    type: 'Text',
+    type: CONSTANTS.CHAT.MESSAGE_TYPE.TEXT,
   });
   const AliceRejectsRequest = await userAlice.chat.reject(thirdSignerAddress);
   if (showAPIResponse) {

packages/examples/sdk-backend-node/main.ts

@@ -17,7 +17,7 @@ const start = async (): Promise<void> => {
   console.log(`${returnENVLog()}`);
 
   await runUserCases();
-  await runNotificationUseCases();
+  //await runNotificationUseCases();
   await runChatUseCases();
   await runVideoUseCases();
   await runSpaceUseCases();

packages/examples/sdk-backend-node/notification/notification.ts

@@ -1,18 +1,19 @@
-import { PushAPI } from '@pushprotocol/restapi';
+import { CONSTANTS, PushAPI } from '@pushprotocol/restapi';
 import { config } from '../config';
 import { ethers } from 'ethers';
 import { STREAM } from '@pushprotocol/restapi/src/lib/pushstream/pushStreamTypes';
+import { PushStream } from '@pushprotocol/restapi/src/lib/pushstream/PushStream';
 
 // CONFIGS
 const { env, showAPIResponse } = config;
 
 const delay = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
 
 const eventlistener = async (
-  pushAPI: PushAPI,
+  stream: PushStream,
   eventName: string
 ): Promise<void> => {
-  pushAPI.stream.on(eventName, (data: any) => {
+  stream.on(eventName, (data: any) => {
     if (showAPIResponse) {
       console.log('Stream Event Received');
       console.log(data);
@@ -44,11 +45,26 @@ export const runNotificationClassUseCases = async (): Promise<void> => {
   // -------------------------------------------------------------------
   const userAlice = await PushAPI.initialize(signer, { env });
 
+  const stream = await userAlice.stream([CONSTANTS.STREAM.NOTIF], {
+    // stream supports other products as well, such as STREAM.CHAT, STREAM.CHAT_OPS
+    // more info can be found at push.org/docs/chat
+
+    filter: {
+      channels: ['*'],
+      chats: ['*'],
+    },
+    connection: {
+      auto: true, // should connection be automatic, else need to call stream.connect();
+      retries: 3, // number of retries in case of error
+    },
+    raw: true, // enable true to show all data
+  });
+
   // Listen Stream Events for getting websocket events
   console.log(`Listening ${STREAM.NOTIF} Events`);
-  eventlistener(userAlice, STREAM.NOTIF);
+  eventlistener(stream, STREAM.NOTIF);
   console.log(`Listening ${STREAM.NOTIF_OPS} Events`);
-  eventlistener(userAlice, STREAM.NOTIF_OPS);
+  eventlistener(stream, STREAM.NOTIF_OPS);
   console.log('\n\n');
   // -------------------------------------------------------------------
   // -------------------------------------------------------------------

packages/examples/sdk-backend-node/package.json

@@ -11,7 +11,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@pushprotocol/restapi": "0.0.1-alpha.50",
+    "@pushprotocol/restapi": "0.0.1-alpha.53",
     "@pushprotocol/socket": "^0.5.2"
   }
 }

packages/examples/sdk-backend-node/pushAPI/chat.ts

@@ -1,4 +1,4 @@
-import { PushAPI } from '@pushprotocol/restapi';
+import { CONSTANTS, PushAPI } from '@pushprotocol/restapi';
 import {
   adjectives,
   animals,
@@ -91,7 +91,7 @@ export const runPushAPIChatCases = async (): Promise<void> => {
   console.log('PushAPI.chat.send');
   const aliceMessagesBob = await userAlice.chat.send(secondSignerAddress, {
     content: 'Hello Bob!',
-    type: 'Text',
+    type: CONSTANTS.CHAT.MESSAGE_TYPE.TEXT,
   });
   if (showAPIResponse) {
     console.log(aliceMessagesBob);
@@ -110,7 +110,7 @@ export const runPushAPIChatCases = async (): Promise<void> => {
   console.log('PushAPI.chat.reject');
   await tempUser.chat.send(secondSignerAddress, {
     content: 'Sending malicious message',
-    type: 'Text',
+    type: CONSTANTS.CHAT.MESSAGE_TYPE.TEXT,
   });
   const bobRejectsRequest = await userBob.chat.reject(thirdSignerAddress);
   if (showAPIResponse) {

packages/examples/sdk-backend-node/pushAPI/stream.ts

@@ -36,7 +36,7 @@ const eventlistener = async (
   pushAPI: PushAPI,
   eventName: string
 ): Promise<void> => {
-  pushAPI.stream.on(eventName, (data: any) => {
+  pushAPI._stream.on(eventName, (data: any) => {
     if (showAPIResponse) {
       console.log(data);
     }

packages/restapi/src/lib/constantsV2.ts

@@ -0,0 +1,30 @@
+import { ENV, MessageType } from "./constants";
+import { ChatListType } from "./pushapi/pushAPITypes";
+import { STREAM } from "./pushstream/pushStreamTypes";
+import { ConditionType, GROUP_INVITER_ROLE, GROUP_RULES_CATEGORY, GROUP_RULES_PERMISSION, GROUP_RULES_SUB_CATEGORY } from "./types";
+
+
+
+// TODO: Change this do . type
+// TODO: Add Notif type.
+// TODO: Add Notif settings, boolean and slider
+// TODO: Notification alias chain
+const CONSTANTS = {
+  ENV: ENV,
+  STREAM: STREAM,
+  CHAT: {
+    LIST_TYPE: ChatListType,
+    MESSAGE_TYPE: MessageType,
+    GROUP: {
+      RULES: {
+        CONDITION_TYPE: ConditionType,
+        CATEGORY: GROUP_RULES_CATEGORY,
+        SUBCATEGORY: GROUP_RULES_SUB_CATEGORY,
+        PERMISSION: GROUP_RULES_PERMISSION,
+        INVITER_ROLE: GROUP_INVITER_ROLE,
+      },
+    },
+  },
+};
+
+export default CONSTANTS;

packages/restapi/src/lib/index.ts

@@ -6,8 +6,14 @@ import * as payloads from './payloads';
 import * as chat from './chat';
 import * as space from './space';
 import * as video from "./video"
+import CONSTANTS from './constantsV2';
 
 export * from './types';
+export * from './pushNotification/PushNotificationTypes';
+export * from './pushstream/pushStreamTypes';
+export * from './pushapi/pushAPITypes';
+export { CONSTANTS };
+
 export { PushAPI } from './pushapi/PushAPI';
 export {
   alias,

packages/restapi/src/lib/pushNotification/notification.ts

@@ -15,8 +15,7 @@ import {
   validateCAIP,
   getFallbackETHCAIPAddress,
 } from '../helpers';
-import PROGRESSHOOK from '../progressHook';
-import { ethers } from 'ethers';
+
 
 import { PushNotificationBaseClass } from './pushNotificationBase';
 // ERROR CONSTANTS

packages/restapi/src/lib/pushNotification/pushNotificationBase.ts

@@ -6,7 +6,7 @@ import {
   NotificationSettings,
   UserSetting,
 } from './PushNotificationTypes';
-import CONFIG, * as config from '../config';
+import * as config from '../config';
 import { getAccountAddress } from '../chat/helpers';
 import { IDENTITY_TYPE, NOTIFICATION_TYPE } from '../payloads/constants';
 import { ethers, Signer, BigNumber } from 'ethers';

packages/restapi/src/lib/pushapi/PushAPI.ts

@@ -11,6 +11,10 @@ import { User } from './user';
 import { PushStream } from '../pushstream/PushStream';
 import { Channel } from '../pushNotification/channel';
 import { Notification } from '../pushNotification/notification';
+import {
+  PushStreamInitializeProps,
+  STREAM,
+} from '../pushstream/pushStreamTypes';
 
 export class PushAPI {
   private signer: SignerType;
@@ -79,14 +83,9 @@ export class PushAPI {
       // Default options
       const defaultOptions: PushAPIInitializeProps = {
         env: ENV.STAGING,
-
         version: Constants.ENC_TYPE_V3,
         autoUpgrade: true,
-
         account: null,
-        streamOptions: {
-          enabled: true, // Default value
-        },
       };
 
       // Settings object
@@ -100,10 +99,6 @@ export class PushAPI {
           options?.autoUpgrade !== undefined
             ? options?.autoUpgrade
             : defaultOptions.autoUpgrade,
-        streamOptions: {
-          ...defaultOptions.streamOptions,
-          ...(options?.streamOptions ?? {}),
-        },
       };
 
       // Get account
@@ -161,31 +156,34 @@ export class PushAPI {
         settings.progressHook
       );
 
-      if (settings.streamOptions.enabled) {
-        const streamInstance = await PushStream.initialize(
-          api.account,
-          decryptedPGPPrivateKey,
-          signer,
-          settings.progressHook,
-          {
-            ...settings.streamOptions,
-            env: settings.env, // Use the env from the top-level PushAPIInitializeProps
-          }
-        );
-        if (streamInstance) {
-          api.stream = streamInstance;
-        } else {
-          throw new Error('Failed to initialize PushStream.');
-        }
-      }
-
       return api;
     } catch (error) {
       console.error('Error initializing PushAPI:', error);
       throw error; // or handle it more gracefully if desired
     }
   }
 
+  async initStream(
+    listen: STREAM[],
+    options?: PushStreamInitializeProps
+  ): Promise<PushStream> {
+    if (this.stream) {
+      throw new Error('Stream is already initialized.');
+    }
+
+    this.stream = await PushStream.initialize(
+      this.account,
+      this.decryptedPgpPvtKey,
+      this.signer,
+      listen,
+      this.env,
+      this.progressHook,
+      options
+    );
+
+    return this.stream;
+  }
+
   async info() {
     return await PUSH_USER.get({
       account: this.account,

packages/restapi/src/lib/pushapi/pushAPITypes.ts

@@ -14,7 +14,6 @@ export interface PushAPIInitializeProps {
   versionMeta?: { NFTPGP_V1?: { password: string } };
   autoUpgrade?: boolean;
   origin?: string;
-  streamOptions?: PushStreamInitializeProps;
 }
 
 export interface GroupCreationOptions {