mezon-sdk 2.7.1 → 2.7.3

package/client.ts

@@ -1,327 +1,409 @@
-/**
- * Copyright 2020 The Nakama Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { SatoriApi, ApiSession, ApiAuthenticateRequest, ApiEventRequest, ApiAuthenticateLogoutRequest, ApiAuthenticateRefreshRequest, ApiIdentifyRequest, ApiUpdatePropertiesRequest, ApiEvent, ApiUpdateMessageRequest } from "./api.gen";
-
-import { Session } from "./session";
-
-const DEFAULT_HOST = "127.0.0.1";
-const DEFAULT_PORT = "7450";
-const DEFAULT_API_KEY = "defaultkey";
-const DEFAULT_TIMEOUT_MS = 7000;
-const DEFAULT_EXPIRED_TIMESPAN_MS = 5 * 60 * 1000;
-
-/** A client for Satori server. */
-export class Client {
-
-  /** The expired timespan used to check session lifetime. */
-  public expiredTimespanMs = DEFAULT_EXPIRED_TIMESPAN_MS;
-
-  /** The low level API client for Nakama server. */
-  private readonly apiClient: SatoriApi;
-
-  constructor(
-      readonly apiKey = DEFAULT_API_KEY,
-      readonly host = DEFAULT_HOST,
-      readonly port = DEFAULT_PORT,
-      readonly useSSL = false,
-      readonly timeout = DEFAULT_TIMEOUT_MS,
-      readonly autoRefreshSession = true) {
-    const scheme = (useSSL) ? "https://" : "http://";
-    const basePath = `${scheme}${host}:${port}`;
-
-    this.apiClient = new SatoriApi(apiKey, basePath, timeout);
-  }
-
-  /** Authenticate a user with an ID against the server. */
-  async authenticate(id: string, customProperties?: Record<string, string>, defaultProperties?: Record<string, string>) {
-
-    const request : ApiAuthenticateRequest = {
-      "id": id,
-      custom: customProperties,
-      default: defaultProperties
-    };
-
-    return this.apiClient.satoriAuthenticate(this.apiKey, "", request).then((apiSession : ApiSession) => {
-      return Promise.resolve(new Session(apiSession.token || "", apiSession.refresh_token || ""));
-    });
-  }
-
-  /** Refresh a user's session using a refresh token retrieved from a previous authentication request. */
-  async sessionRefresh(session: Session) {
-
-    const request : ApiAuthenticateRefreshRequest = {
-      "refresh_token": session.refresh_token,
-    };
-
-    return this.apiClient.satoriAuthenticateRefresh(this.apiKey, "", request).then((apiSession : ApiSession) => {
-      return Promise.resolve(new Session(apiSession.token || "", apiSession.refresh_token || ""));
-    });
-  }
-
-  /** Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. */
-  async logout(session: Session) {
-
-    const request : ApiAuthenticateLogoutRequest = {
-      "token": session.token,
-      "refresh_token": session.refresh_token
-    };
-
-    return this.apiClient.satoriAuthenticateLogout(session.token, request).then((response) => {
-      return Promise.resolve(response !== undefined);
-    });
-  }
-
-  /** Publish an event for this session. */
-  async event(session: Session, event: ApiEvent) {
-    if (this.autoRefreshSession && session.refresh_token &&
-      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-      await this.sessionRefresh(session);
-    }
-
-    const request : ApiEventRequest = {
-      events: [event]
-    };
-
-    return this.apiClient.satoriEvent(session.token, request).then((response) => {
-      return Promise.resolve(response !== undefined);
-    });
-  }
-
-  /** Publish multiple events for this session */
-  async events(session: Session, events: Array<ApiEvent>) {
-    if (this.autoRefreshSession && session.refresh_token &&
-      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-      await this.sessionRefresh(session);
-    }
-
-    const request : ApiEventRequest = {
-      events
-    };
-
-    return this.apiClient.satoriEvent(session.token, request).then((response) => {
-      return Promise.resolve(response !== undefined);
-    });
-  }
-
-  /** Get or list all available experiments for this identity. */
-  async getExperiments(session: Session, names?: Array<string>) {
-    if (this.autoRefreshSession && session.refresh_token &&
-      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-      await this.sessionRefresh(session);
-    }
-
-    return this.apiClient.satoriGetExperiments(session.token, names);
-  }
-
-  /** Get a single flag for this identity. Throws an error when the flag does not exist. */
-  async getFlag(session: Session, name: string) {
-    if (this.autoRefreshSession && session.refresh_token &&
-      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-      await this.sessionRefresh(session);
-    }
-
-    return this.apiClient.satoriGetFlags(session.token, "", "", [name]).then((flagList) => {
-      let flag = null;
-
-      flagList.flags?.forEach((f) => {
-        if (f.name === name) {
-          flag = f;
-        }
-      });
-
-      if (flag === null) {
-        return Promise.reject("Flag does not exist.");
-      }
-
-      return Promise.resolve(flag);
-    });
-  }
-
-
-  /** Get a single flag for this identity. */
-  async getFlagWithFallback(session: Session, name: string, fallbackValue?: string) {
-    return this.getFlag(session, name)
-      .then((flag) => {
-        return flag;
-      })
-      .catch(() => {
-        const flag = {
-          name,
-          value: fallbackValue
-        };
-
-        return Promise.resolve(flag)
-      });
-  }
-
-  /** Get a single flag with its configured default value. Throws an error when the flag does not exist. */
-  async getFlagDefault(name: string) {
-    return this.apiClient.satoriGetFlags("", this.apiKey, "", [name]).then((flagList) => {
-      let flag = null;
-
-      flagList.flags?.forEach((f) => {
-        if (f.name === name) {
-          flag = f;
-        }
-      });
-
-      if (flag === null) {
-        return Promise.reject("Flag does not exist.");
-      }
-
-      return Promise.resolve(flag);
-    });
-  }
-
-  /** Get a single flag with its configured default value.  */
-  async getFlagDefaultWithFallback(name: string, fallbackValue?: string) {
-    return this.getFlagDefault(name)
-      .then((flag) => {
-        return flag;
-      })
-      .catch(() => {
-        const flag = {
-          name,
-          value: fallbackValue
-        };
-
-        return Promise.resolve(flag)
-      });
-  }
-
-  /** List all available flags for this identity. */
-  async getFlags(session: Session, names?: Array<string>) {
-    if (this.autoRefreshSession && session.refresh_token &&
-      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-      await this.sessionRefresh(session);
-    }
-
-    return this.apiClient.satoriGetFlags(session.token, "", "", names);
-  }
-
-  /** List all available default flags. */
-  async getFlagsDefault(names?: Array<string>) {
-    return this.apiClient.satoriGetFlags("", this.apiKey, "", names);
-  }
-
-  /** Enrich/replace the current session with new identifier. */
-  async identify(session: Session, id: string, defaultProperties?: Record<string, string>, customProperties?: Record<string, string>) {
-    if (this.autoRefreshSession && session.refresh_token &&
-      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-      await this.sessionRefresh(session);
-    }
-
-    const request : ApiIdentifyRequest = {
-      id: id,
-      default: defaultProperties,
-      custom: customProperties
-    };
-
-    return this.apiClient.satoriIdentify(session.token, request).then((apiSession: ApiSession) => {
-      return Promise.resolve(new Session(apiSession.token || "", apiSession.refresh_token || ""));
-    });
-  }
-
-  /** List available live events. */
-  async getLiveEvents(session: Session, names?: Array<string>) {
-    if (this.autoRefreshSession && session.refresh_token &&
-      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-      await this.sessionRefresh(session);
-    }
-
-    return this.apiClient.satoriGetLiveEvents(session.token, names);
-  }
-
-  /** List properties associated with this identity. */
-  async listProperties(session: Session) {
-    if (this.autoRefreshSession && session.refresh_token &&
-      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-      await this.sessionRefresh(session);
-    }
-
-    return this.apiClient.satoriListProperties(session.token);
-  }
-
-  /** Update identity properties. */
-  async updateProperties(session: Session, defaultProperties?: Record<string, string>, customProperties?: Record<string, string>, recompute?: boolean) {
-    if (this.autoRefreshSession && session.refresh_token &&
-      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-      await this.sessionRefresh(session);
-    }
-
-    const request : ApiUpdatePropertiesRequest = {
-      default: defaultProperties,
-      custom: customProperties,
-      recompute: recompute,
-    };
-
-    return this.apiClient.satoriUpdateProperties(session.token, request).then((response) => {
-      return Promise.resolve(response !== undefined);
-    });
-  }
-
-    /** Delete the caller's identity and associated data. */
-    async deleteIdentity(session: Session) {
-      if (this.autoRefreshSession && session.refresh_token &&
-        session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-        await this.sessionRefresh(session);
-      }
-
-      return this.apiClient.satoriDeleteIdentity(session.token).then((response) => {
-        return Promise.resolve(response !== undefined);
-      });
-    }
-
-    async getMessageList(session : Session) {
-        if (this.autoRefreshSession && session.refresh_token &&
-            session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-            await this.sessionRefresh(session);
-        }
-
-        return this.apiClient.satoriGetMessageList(session.token).then((response) => {
-            return Promise.resolve(response !== undefined);
-        });
-    }
-
-    async deleteMessage(session : Session, id : string) {
-        if (this.autoRefreshSession && session.refresh_token &&
-            session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-            await this.sessionRefresh(session);
-        }
-
-        return this.apiClient.satoriDeleteMessage(session.token, id).then((response) => {
-            return Promise.resolve(response !== undefined);
-        });
-    }
-
-    async updateMessage(session : Session, id : string, consume_time? : string, read_time? : string) {
-        if (this.autoRefreshSession && session.refresh_token &&
-            session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
-            await this.sessionRefresh(session);
-        }
-
-        const request : ApiUpdateMessageRequest = {
-            id: id,
-            consume_time: consume_time,
-            read_time: read_time
-        };
-
-        return this.apiClient.satoriUpdateMessage(session.token, id, request).then((response) => {
-            return Promise.resolve(response !== undefined);
-        });
-    }
-};
+/**
+ * Copyright 2020 The Nakama Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { MezonApi, ApiAuthenticateLogoutRequest, ApiAuthenticateRefreshRequest, ApiUpdateMessageRequest, ApiSession } from "./api";
+import { Session } from "./session";
+import { ChannelCreatedEvent, ChannelDeletedEvent, ChannelUpdatedEvent, DefaultSocket, Socket, UserChannelAddedEvent, UserChannelRemovedEvent, UserClanRemovedEvent, VoiceJoinedEvent } from "./socket";
+import { WebSocketAdapter } from "./web_socket_adapter";
+import { WebSocketAdapterPb } from 'mezon-js-protobuf';
+
+const DEFAULT_HOST = "dev-mezon.nccsoft.vn";
+const DEFAULT_PORT = "7305";
+const DEFAULT_API_KEY = "defaultkey";
+const DEFAULT_TIMEOUT_MS = 7000;
+const DEFAULT_EXPIRED_TIMESPAN_MS = 5 * 60 * 1000;
+
+
+/**  */
+export interface ApiMessageAttachment {
+  //
+  filename?: string;
+  //
+  filetype?: string;
+  //
+  height?: number;
+  //
+  size?: number;
+  //
+  url?: string;
+  //
+  width?: number;
+  /** The channel this message belongs to. */
+  channel_id?:string;
+  // The mode
+  mode?: number;
+  // The channel label
+  channel_label?: string;
+  /** The message that user react */
+  message_id?: string;
+  /** Message sender, usually a user ID. */
+  sender_id?: string;
+}
+
+/**  */
+export interface ApiMessageDeleted {
+  //
+  deletor?: string;
+  //
+  message_id?: string;
+}
+
+/**  */
+export interface ApiMessageMention {
+  //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
+  create_time?: string;
+  //
+  id?: string;
+  //
+  user_id?: string;
+  //
+  username?: string;
+  // role id
+  role_id?: string;
+  // role name
+  rolename?: string;
+  // start position
+  s?: number;
+  // end position
+  e?: number;
+  /** The channel this message belongs to. */
+  channel_id?:string;
+// The mode
+  mode?: number;
+  // The channel label
+  channel_label?: string;
+  /** The message that user react */
+  message_id?: string;
+  /** Message sender, usually a user ID. */
+  sender_id?: string;
+}
+
+/**  */
+export interface ApiMessageReaction {
+  //
+  action?: boolean;
+  //
+  emoji_id: string;
+  //
+  emoji: string;
+  //
+  id?: string;
+  //
+  sender_id?: string;
+  //
+  sender_name?: string;
+  //
+  sender_avatar?: string;
+  // count of emoji
+  count: number;
+  /** The channel this message belongs to. */
+  channel_id:string;
+  // The mode
+  mode: number;
+  // The channel label
+  channel_label: string;
+  /** The message that user react */
+  message_id: string;
+}
+
+/**  */
+export interface ApiMessageRef {
+  //
+  message_id?: string;
+  //
+  message_ref_id?: string;
+  //
+  ref_type?: number;
+  //
+  message_sender_id?: string;
+  // original message sendre username
+  message_sender_username?: string;
+  // original message sender avatar
+  mesages_sender_avatar?: string;
+  // original sender clan nick name
+  message_sender_clan_nick?: string;
+  // original sender display name
+  message_sender_display_name?:string;
+  //
+  content?:string;
+  //
+  has_attachment: boolean;
+  /** The channel this message belongs to. */
+  channel_id:string;
+  // The mode
+  mode: number;
+  // The channel label
+  channel_label: string;
+}
+
+/** A message sent on a channel. */
+export interface ChannelMessage {
+  //The unique ID of this message.
+  id: string;
+  //
+  avatar?: string;
+  //The channel this message belongs to.
+  channel_id: string;
+  //The name of the chat room, or an empty string if this message was not sent through a chat room.
+  channel_label: string;
+  //The clan this message belong to.
+  clan_id?: string;
+  //The code representing a message type or category.
+  code: number;
+  //The content payload.
+  content: string;
+  //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
+  create_time: string;
+  //
+  reactions?: Array<ApiMessageReaction>;
+  //
+  mentions?: Array<ApiMessageMention>;
+  //
+  attachments?: Array<ApiMessageAttachment>;
+  //
+  references?: Array<ApiMessageRef>;
+  //
+  referenced_message?: ChannelMessage;
+  //True if the message was persisted to the channel's history, false otherwise.
+  persistent?: boolean;
+  //Message sender, usually a user ID.
+  sender_id: string;
+  //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated.
+  update_time?: string;
+  //The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
+  clan_logo?: string;
+  //The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
+  category_name?: string;
+  //The username of the message sender, if any.
+  username?: string;
+  // The clan nick name
+  clan_nick?: string;
+  // The clan avatar
+  clan_avatar?: string;
+  //
+  display_name?: string;
+  //
+  create_time_ms?: number;
+  //
+  update_time_ms?: number;
+  //
+  mode?: number;
+  //
+  message_id?: string;
+}
+
+export interface Client {
+  authenticate: () => Promise<string>;
+
+  /** Receive clan evnet. */
+  onMessage: (channelMessage: ChannelMessage) => void;
+  onClanMemberUpdate: (member_id: Array<string>, leave: boolean) => void;
+  onMessageDelete: (channelMessage: ChannelMessage) => void;
+  onMessageReactionAdd: (messageReactionEvent: ApiMessageReaction) => void;
+  onVoiceStateUpdate: (voiceState: VoiceJoinedEvent) => void;
+  onMessageReactionRemove: (messageReactionEvent: ApiMessageReaction) => void;
+}
+
+/** A client for Mezon server. */
+export class MezonClient  implements Client {
+
+  /** The expired timespan used to check session lifetime. */
+  public expiredTimespanMs = DEFAULT_EXPIRED_TIMESPAN_MS;
+
+  /** The low level API client for Nakama server. */
+  private readonly apiClient: MezonApi;
+
+  constructor(
+      readonly apiKey = DEFAULT_API_KEY,
+      readonly host = DEFAULT_HOST,
+      readonly port = DEFAULT_PORT,
+      readonly useSSL = true,
+      readonly timeout = DEFAULT_TIMEOUT_MS,
+      readonly autoRefreshSession = true) {
+    const scheme = (useSSL) ? "https://" : "http://";
+    const basePath = `${scheme}${host}:${port}`;
+
+    this.apiClient = new MezonApi(apiKey, basePath, timeout);
+  }
+
+  /** Authenticate a user with an ID against the server. */
+  async authenticate() {
+    return this.apiClient.mezonAuthenticate(this.apiKey, "", {
+      account: {
+        token: this.apiKey,
+      }
+    }).then(async (apiSession : ApiSession) => {
+      const sockSession = new Session(apiSession.token || "", apiSession.refresh_token || "");
+      const socket = this.createSocket(this.useSSL, true, new WebSocketAdapterPb());
+      const session = await socket.connect(sockSession, false);
+
+      if (!session) {
+        return Promise.resolve("error authenticate");
+      }
+      
+      const clans = await this.apiClient.listClanDescs(session.token);
+      clans.clandesc?.forEach(async clan => {
+        await socket.joinClanChat(clan.clan_id || '');
+      })
+
+      // join direct message
+      await socket.joinClanChat("0");
+
+      socket.onchannelmessage = this.onMessage;
+      socket.ondisconnect = this.ondisconnect;
+      socket.onerror = this.onerror;
+      socket.onmessagereaction = this.onmessagereaction;
+      socket.onuserchannelremoved = this.onuserchannelremoved;
+      socket.onuserclanremoved = this.onuserclanremoved;
+      socket.onuserchanneladded = this.onuserchanneladded;        
+      socket.onchannelcreated = this.onchannelcreated;
+      socket.onchanneldeleted = this.onchanneldeleted;
+      socket.onchannelupdated = this.onchannelupdated;
+      socket.onheartbeattimeout = this.onheartbeattimeout;
+      
+      return Promise.resolve("connect successful");
+    });
+  }
+
+  /** Refresh a user's session using a refresh token retrieved from a previous authentication request. */
+  async sessionRefresh(session: Session) {
+
+    const request : ApiAuthenticateRefreshRequest = {
+      "refresh_token": session.refresh_token,
+    };
+
+    return this.apiClient.mezonAuthenticateRefresh(this.apiKey, "", request).then((apiSession : ApiSession) => {
+      return Promise.resolve(new Session(apiSession.token || "", apiSession.refresh_token || ""));
+    });
+  }
+
+  /** Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. */
+  async logout(session: Session) {
+
+    const request : ApiAuthenticateLogoutRequest = {
+      "token": session.token,
+      "refresh_token": session.refresh_token
+    };
+
+    return this.apiClient.mezonAuthenticateLogout(session.token, request).then((response) => {
+      return Promise.resolve(response !== undefined);
+    });
+  }
+
+  async deleteMessage(session : Session, id : string) {
+    if (this.autoRefreshSession && session.refresh_token &&
+      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
+      await this.sessionRefresh(session);
+    }
+
+    return this.apiClient.mezonDeleteMessage(session.token, id).then((response) => {
+      return Promise.resolve(response !== undefined);
+    });
+  }
+
+  async updateMessage(session : Session, id : string, consume_time? : string, read_time? : string) {
+    if (this.autoRefreshSession && session.refresh_token &&
+      session.isexpired((Date.now() + this.expiredTimespanMs)/1000)) {
+      await this.sessionRefresh(session);
+    }
+
+    const request : ApiUpdateMessageRequest = {
+      id: id,
+      consume_time: consume_time,
+      read_time: read_time
+    };
+
+    return this.apiClient.mezonUpdateMessage(session.token, id, request).then((response) => {
+      return Promise.resolve(response !== undefined);
+    });
+  }
+
+  /** A socket created with the client's configuration. */
+  createSocket(useSSL = false, verbose: boolean = false, adapter : WebSocketAdapter = new WebSocketAdapterPb(), sendTimeoutMs : number = DefaultSocket.DefaultSendTimeoutMs): Socket {
+    return new DefaultSocket(this.host, this.port, useSSL, verbose, adapter, sendTimeoutMs);
+  }
+
+  onerror(evt: Event) {
+    console.log(evt);
+  }
+
+  onmessagereaction(messagereaction: ApiMessageReaction) {
+    console.log(messagereaction);
+    if (messagereaction.action) {
+      this.onMessageReactionRemove(messagereaction);
+    } else {
+      this.onMessageReactionAdd(messagereaction);
+    }
+  }
+
+  ondisconnect(e: Event) {
+    console.log(e);
+  }
+
+  onuserchanneladded(user: UserChannelAddedEvent) {
+      console.log(user);
+  }
+
+  onuserchannelremoved(user: UserChannelRemovedEvent) {
+    console.log(user);
+  }
+
+  onuserclanremoved(user: UserClanRemovedEvent) {
+    this.onClanMemberUpdate(user.user_ids, true);
+  }
+
+  onchannelcreated(channelCreated: ChannelCreatedEvent) {
+    console.log(channelCreated);
+  }
+
+  onchanneldeleted(channelDeleted: ChannelDeletedEvent) {
+    console.log(channelDeleted);
+  }
+
+  onchannelupdated(channelUpdated: ChannelUpdatedEvent) {
+    console.log(channelUpdated);
+  }
+
+  onheartbeattimeout() {
+    console.log("Heartbeat timeout.");
+  }
+
+  /** Receive clan evnet. */
+  onMessage(channelMessage: ChannelMessage) {
+    console.log(channelMessage);
+  }
+
+  onClanMemberUpdate(member_id: Array<string>, leave: boolean) {
+    console.log(member_id, leave);
+  }
+
+  onMessageDelete(channelMessage: ChannelMessage) {
+    console.log(channelMessage);
+  }
+
+  onMessageReactionAdd(messageReactionEvent: ApiMessageReaction) {
+    console.log(messageReactionEvent);
+  }
+
+  onVoiceStateUpdate(voiceState: VoiceJoinedEvent) {
+    console.log(voiceState);
+  }
+
+  onMessageReactionRemove(messageReactionEvent: ApiMessageReaction) {
+    console.log(messageReactionEvent);
+  }
+
+};