mezon-sdk 2.7.1 → 2.7.2

package/dist/api.d.ts

@@ -0,0 +1,53 @@
+/** 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>;
+    buildFullUrl(basePath: string, fragment: string, queryParams: Map<string, any>): string;
+}

package/dist/client.d.ts

@@ -1,74 +1,60 @@
-/**
- * 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 { ApiEvent } from "./api.gen";
-import { Session } from "./session";
-/** A client for Satori server. */
-export declare class 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(id: string, customProperties?: Record<string, string>, defaultProperties?: Record<string, string>): Promise<Session>;
-    /** 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>;
-    /** Publish an event for this session. */
-    event(session: Session, event: ApiEvent): Promise<boolean>;
-    /** Publish multiple events for this session */
-    events(session: Session, events: Array<ApiEvent>): Promise<boolean>;
-    /** Get or list all available experiments for this identity. */
-    getExperiments(session: Session, names?: Array<string>): Promise<import("./api.gen").ApiExperimentList>;
-    /** Get a single flag for this identity. Throws an error when the flag does not exist. */
-    getFlag(session: Session, name: string): Promise<never>;
-    /** Get a single flag for this identity. */
-    getFlagWithFallback(session: Session, name: string, fallbackValue?: string): Promise<{
-        name: string;
-        value: string | undefined;
-    }>;
-    /** Get a single flag with its configured default value. Throws an error when the flag does not exist. */
-    getFlagDefault(name: string): Promise<never>;
-    /** Get a single flag with its configured default value.  */
-    getFlagDefaultWithFallback(name: string, fallbackValue?: string): Promise<{
-        name: string;
-        value: string | undefined;
-    }>;
-    /** List all available flags for this identity. */
-    getFlags(session: Session, names?: Array<string>): Promise<import("./api.gen").ApiFlagList>;
-    /** List all available default flags. */
-    getFlagsDefault(names?: Array<string>): Promise<import("./api.gen").ApiFlagList>;
-    /** Enrich/replace the current session with new identifier. */
-    identify(session: Session, id: string, defaultProperties?: Record<string, string>, customProperties?: Record<string, string>): Promise<Session>;
-    /** List available live events. */
-    getLiveEvents(session: Session, names?: Array<string>): Promise<import("./api.gen").ApiLiveEventList>;
-    /** List properties associated with this identity. */
-    listProperties(session: Session): Promise<import("./api.gen").ApiProperties>;
-    /** Update identity properties. */
-    updateProperties(session: Session, defaultProperties?: Record<string, string>, customProperties?: Record<string, string>, recompute?: boolean): Promise<boolean>;
-    /** Delete the caller's identity and associated data. */
-    deleteIdentity(session: Session): Promise<boolean>;
-    getMessageList(session: Session): Promise<boolean>;
-    deleteMessage(session: Session, id: string): Promise<boolean>;
-    updateMessage(session: Session, id: string, consume_time?: string, read_time?: string): Promise<boolean>;
-}
+/**
+ * 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 { ApiMessageReaction, ChannelCreatedEvent, ChannelDeletedEvent, ChannelMessage, ChannelUpdatedEvent, Socket, UserChannelAddedEvent, UserChannelRemovedEvent, UserClanRemovedEvent, VoiceJoinedEvent } from "./socket";
+import { WebSocketAdapter } from "./web_socket_adapter";
+/** A client for Mezon server. */
+export declare class 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 | undefined>;
+    /** 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;
+    onchannelmessage(channelMessage: ChannelMessage): 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 +1,18 @@
-/**
- * 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";
+/**
+ * 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";