mezon-sdk 2.7.3 → 2.7.4

package/client.ts

@@ -27,6 +27,42 @@ const DEFAULT_TIMEOUT_MS = 7000;
 const DEFAULT_EXPIRED_TIMESPAN_MS = 5 * 60 * 1000;
 
 
+/**  */
+export interface ClanDesc {
+  //
+  banner?: string;
+  //
+  clan_id?: string;
+  //
+  clan_name?: string;
+  //
+  creator_id?: string;
+  //
+  logo?: string;
+  //
+  status?: number;
+}
+
+/**  */
+export interface ChannelDescription {
+  // The clan of this channel
+  clan_id?: string;
+  // The channel this message belongs to.
+  channel_id?: string;
+  // The channel type.
+  type?: number;
+  // The channel lable
+  channel_label?: string;
+  // The channel private
+  channel_private?: number;
+  // meeting code
+  meeting_code?: string;
+  //
+  clan_name?: string;
+  //
+  parrent_id?: string;
+}
+
 /**  */
 export interface ApiMessageAttachment {
   //
@@ -81,7 +117,7 @@ export interface ApiMessageMention {
   e?: number;
   /** The channel this message belongs to. */
   channel_id?:string;
-// The mode
+  // The mode
   mode?: number;
   // The channel label
   channel_label?: string;
@@ -205,6 +241,49 @@ export interface ChannelMessage {
   message_id?: string;
 }
 
+
+/** A user in the server. */
+export interface ApiUser {
+  //
+  about_me?: string;
+  //The Apple Sign In ID in the user's account.
+  apple_id?: string;
+  //A URL for an avatar image.
+  avatar_url?: string;
+  //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user was created.
+  create_time?: string;
+  //The display name of the user.
+  display_name?: string;
+  //Number of related edges to this user.
+  edge_count?: number;
+  //The Facebook id in the user's account.
+  facebook_id?: string;
+  //The Apple Game Center in of the user's account.
+  gamecenter_id?: string;
+  //The Google id in the user's account.
+  google_id?: string;
+  //The id of the user's account.
+  id?: string;
+  //
+  join_time?: string;
+  //The language expected to be a tag which follows the BCP-47 spec.
+  lang_tag?: string;
+  //The location set by the user.
+  location?: string;
+  //Additional information stored as a JSON object.
+  metadata?: string;
+  //Indicates whether the user is currently online.
+  online?: boolean;
+  //The Steam id in the user's account.
+  steam_id?: string;
+  //The timezone set by the user.
+  timezone?: string;
+  //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user was last updated.
+  update_time?: string;
+  //The username of the user's account.
+  username?: string;
+}
+
 export interface Client {
   authenticate: () => Promise<string>;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mezon-sdk",
-    "version": "2.7.3",
+    "version": "2.7.4",
     "scripts": {
         "build": "npx tsc && npx rollup -c --bundleConfigAsCjs && node build.mjs",
         "docs": "typedoc index.ts --gaID UA-89839802-1 --out ../../docs"

package/socket.ts

@@ -490,12 +490,12 @@ interface StatusUpdate {
   /** Status string to set, if not present the user will appear offline. */
   status_update: {status?: string;};
 }
+
 export interface ClanNameExistedEvent {
   clan_name: string;
   exist: boolean;
 }
 
-
 /**  */
 export interface StrickerListedEvent {
   // clan id

package/dist/api.d.ts

@@ -1,68 +0,0 @@
-/**  */
-export interface ApiClanDescList {
-    clandesc?: Array<ApiClanDesc>;
-}
-/**  */
-export interface ApiClanDesc {
-    banner?: string;
-    clan_id?: string;
-    clan_name?: string;
-    creator_id?: string;
-    logo?: string;
-    status?: number;
-}
-/** A user's session used to authenticate messages. */
-export interface ApiSession {
-    created?: boolean;
-    refresh_token?: string;
-    token?: string;
-}
-/** Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. */
-export interface ApiAuthenticateLogoutRequest {
-    refresh_token?: string;
-    token?: string;
-}
-/** Authenticate against the server with a refresh token. */
-export interface ApiAuthenticateRefreshRequest {
-    refresh_token?: string;
-}
-/** Authenticate against the server with a device ID. */
-export interface ApiAuthenticateRequest {
-    account?: ApiAccountApp;
-}
-/** Send a app token to the server. Used with authenticate/link/unlink. */
-export interface ApiAccountApp {
-    appid?: string;
-    appname?: string;
-    token?: string;
-    vars?: Record<string, string>;
-}
-/** The request to update the status of a message. */
-export interface ApiUpdateMessageRequest {
-    consume_time?: string;
-    id?: string;
-    read_time?: string;
-}
-export declare class MezonApi {
-    readonly apiKey: string;
-    readonly basePath: string;
-    readonly timeoutMs: number;
-    constructor(apiKey: string, basePath: string, timeoutMs: number);
-    /** A healthcheck which load balancers can use to check the service. */
-    mezonHealthcheck(bearerToken: string, options?: any): Promise<any>;
-    /** A readycheck which load balancers can use to check the service. */
-    mezonReadycheck(bearerToken: string, options?: any): Promise<any>;
-    /** Authenticate a app with a token against the server. */
-    mezonAuthenticate(basicAuthUsername: string, basicAuthPassword: string, body: ApiAuthenticateRequest, options?: any): Promise<ApiSession>;
-    /** Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. */
-    mezonAuthenticateLogout(bearerToken: string, body: ApiAuthenticateLogoutRequest, options?: any): Promise<any>;
-    /** Refresh a user's session using a refresh token retrieved from a previous authentication request. */
-    mezonAuthenticateRefresh(basicAuthUsername: string, basicAuthPassword: string, body: ApiAuthenticateRefreshRequest, options?: any): Promise<ApiSession>;
-    /** Deletes a message for an identity. */
-    mezonDeleteMessage(bearerToken: string, id: string, options?: any): Promise<any>;
-    /** Updates a message for an identity. */
-    mezonUpdateMessage(bearerToken: string, id: string, body: ApiUpdateMessageRequest, options?: any): Promise<any>;
-    /** List clans */
-    listClanDescs(bearerToken: string, limit?: number, state?: number, cursor?: string, options?: any): Promise<ApiClanDescList>;
-    buildFullUrl(basePath: string, fragment: string, queryParams: Map<string, any>): string;
-}

package/dist/client.d.ts

@@ -1,173 +0,0 @@
-/**
- * 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 { Session } from "./session";
-import { ChannelCreatedEvent, ChannelDeletedEvent, ChannelUpdatedEvent, Socket, UserChannelAddedEvent, UserChannelRemovedEvent, UserClanRemovedEvent, VoiceJoinedEvent } from "./socket";
-import { WebSocketAdapter } from "./web_socket_adapter";
-/**  */
-export interface ApiMessageAttachment {
-    filename?: string;
-    filetype?: string;
-    height?: number;
-    size?: number;
-    url?: string;
-    width?: number;
-    /** The channel this message belongs to. */
-    channel_id?: string;
-    mode?: number;
-    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 {
-    create_time?: string;
-    id?: string;
-    user_id?: string;
-    username?: string;
-    role_id?: string;
-    rolename?: string;
-    s?: number;
-    e?: number;
-    /** The channel this message belongs to. */
-    channel_id?: string;
-    mode?: number;
-    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: number;
-    /** The channel this message belongs to. */
-    channel_id: string;
-    mode: number;
-    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;
-    message_sender_username?: string;
-    mesages_sender_avatar?: string;
-    message_sender_clan_nick?: string;
-    message_sender_display_name?: string;
-    content?: string;
-    has_attachment: boolean;
-    /** The channel this message belongs to. */
-    channel_id: string;
-    mode: number;
-    channel_label: string;
-}
-/** A message sent on a channel. */
-export interface ChannelMessage {
-    id: string;
-    avatar?: string;
-    channel_id: string;
-    channel_label: string;
-    clan_id?: string;
-    code: number;
-    content: string;
-    create_time: string;
-    reactions?: Array<ApiMessageReaction>;
-    mentions?: Array<ApiMessageMention>;
-    attachments?: Array<ApiMessageAttachment>;
-    references?: Array<ApiMessageRef>;
-    referenced_message?: ChannelMessage;
-    persistent?: boolean;
-    sender_id: string;
-    update_time?: string;
-    clan_logo?: string;
-    category_name?: string;
-    username?: string;
-    clan_nick?: string;
-    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 declare class MezonClient implements Client {
-    readonly apiKey: string;
-    readonly host: string;
-    readonly port: string;
-    readonly useSSL: boolean;
-    readonly timeout: number;
-    readonly autoRefreshSession: boolean;
-    /** The expired timespan used to check session lifetime. */
-    expiredTimespanMs: number;
-    /** The low level API client for Nakama server. */
-    private readonly apiClient;
-    constructor(apiKey?: string, host?: string, port?: string, useSSL?: boolean, timeout?: number, autoRefreshSession?: boolean);
-    /** Authenticate a user with an ID against the server. */
-    authenticate(): Promise<string>;
-    /** Refresh a user's session using a refresh token retrieved from a previous authentication request. */
-    sessionRefresh(session: Session): Promise<Session>;
-    /** Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. */
-    logout(session: Session): Promise<boolean>;
-    deleteMessage(session: Session, id: string): Promise<boolean>;
-    updateMessage(session: Session, id: string, consume_time?: string, read_time?: string): Promise<boolean>;
-    /** A socket created with the client's configuration. */
-    createSocket(useSSL?: boolean, verbose?: boolean, adapter?: WebSocketAdapter, sendTimeoutMs?: number): Socket;
-    onerror(evt: Event): void;
-    onmessagereaction(messagereaction: ApiMessageReaction): void;
-    ondisconnect(e: Event): void;
-    onuserchanneladded(user: UserChannelAddedEvent): void;
-    onuserchannelremoved(user: UserChannelRemovedEvent): void;
-    onuserclanremoved(user: UserClanRemovedEvent): void;
-    onchannelcreated(channelCreated: ChannelCreatedEvent): void;
-    onchanneldeleted(channelDeleted: ChannelDeletedEvent): void;
-    onchannelupdated(channelUpdated: ChannelUpdatedEvent): void;
-    onheartbeattimeout(): void;
-    /** 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;
-}

package/dist/index.d.ts

@@ -1,18 +0,0 @@
-/**
- * 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 "whatwg-fetch";
-export * from "./client";
-export * from "./session";