mezon-js 2.7.1

package/dist/web_socket_adapter.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Copyright 2020 The Mezon 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.
+ */
+/**
+ * An interface used by Mezon's web socket to determine the payload protocol.
+ */
+export interface WebSocketAdapter {
+    /**
+     * Dispatched when the web socket closes.
+     */
+    onClose: SocketCloseHandler | null;
+    /**
+     * Dispatched when the web socket receives an error.
+     */
+    onError: SocketErrorHandler | null;
+    /**
+     * Dispatched when the web socket receives a normal message.
+     */
+    onMessage: SocketMessageHandler | null;
+    /**
+     * Dispatched when the web socket opens.
+     */
+    onOpen: SocketOpenHandler | null;
+    isOpen(): boolean;
+    close(): void;
+    connect(scheme: string, host: string, port: string, createStatus: boolean, token: string): void;
+    send(message: any): void;
+}
+/**
+ * SocketCloseHandler defines a lambda that handles WebSocket close events.
+ */
+export interface SocketCloseHandler {
+    (this: WebSocket, evt: CloseEvent): void;
+}
+/**
+ * SocketErrorHandler defines a lambda that handles responses from the server via WebSocket
+ * that indicate an error.
+ */
+export interface SocketErrorHandler {
+    (this: WebSocket, evt: Event): void;
+}
+/**
+ * SocketMessageHandler defines a lambda that handles valid WebSocket messages.
+ */
+export interface SocketMessageHandler {
+    (message: any): void;
+}
+/**
+ * SocketOpenHandler defines a lambda that handles WebSocket open events.
+ */
+export interface SocketOpenHandler {
+    (this: WebSocket, evt: Event): void;
+}
+/**
+ * A text-based socket adapter that accepts and transmits payloads over UTF-8.
+ */
+export declare class WebSocketAdapterText implements WebSocketAdapter {
+    private _socket?;
+    get onClose(): SocketCloseHandler | null;
+    set onClose(value: SocketCloseHandler | null);
+    get onError(): SocketErrorHandler | null;
+    set onError(value: SocketErrorHandler | null);
+    get onMessage(): SocketMessageHandler | null;
+    set onMessage(value: SocketMessageHandler | null);
+    get onOpen(): SocketOpenHandler | null;
+    set onOpen(value: SocketOpenHandler | null);
+    isOpen(): boolean;
+    connect(scheme: string, host: string, port: string, createStatus: boolean, token: string): void;
+    close(): void;
+    send(msg: any): void;
+}

package/index.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2020 The Mezon 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";
+export * from "./socket";
+export * from "./web_socket_adapter";
+
+/**
+ * Reexported due to duplicate definition of ChannelMessage in [Client]{@link ./client.ts} and [Session]{@link ./session.ts}
+ */
+export { ChannelMessage } from "./client";

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "mezon-js",
+  "version": "2.7.1",
+  "scripts": {
+    "build": "npx tsc && npx rollup -c --bundleConfigAsCjs && node build.mjs"
+  },
+  "description": "JavaScript client for Mezon server written in TypeScript.",
+  "main": "dist/mezon-js.cjs.js",
+  "module": "dist/mezon-js.esm.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/mezon-js.esm.mjs",
+      "require": "./dist/mezon-js.cjs.js"
+    }
+  },
+  "keywords": [
+    "app server",
+    "client library",
+    "game server",
+    "mezon",
+    "realtime",
+    "realtime chat"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/heroiclabs/mezon-js.git"
+  },
+  "homepage": "https://heroiclabs.com",
+  "bugs": {
+    "url": "https://github.com/heroiclabs/mezon-js/issues"
+  },
+  "author": "Chris Molozian <chris@heroiclabs.com>",
+  "contributors": [
+    "Andrei Mihu <andrei@heroiclabs.com>",
+    "Mo Firouz <mo@heroiclabs.com>"
+  ],
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@scarf/scarf": "^1.1.1",
+    "base64-arraybuffer": "^1.0.2",
+    "esbuild": "^0.19.11",
+    "js-base64": "^3.7.4",
+    "whatwg-fetch": "^3.6.2"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "rollup": "^3.10.0",
+    "tslib": "^2.4.1"
+  }
+}

package/rollup.config.js

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2020 Heroic Labs
+ *
+ * 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.
+ */
+
+// Rollup is the legacy build system for mezon-js and is only used for cocos2d-x-js support.
+
+import typescript from '@rollup/plugin-typescript';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+
+export default {
+    input: './index.ts',
+    output:  {
+        format: 'umd',
+        name: 'mezonjs',
+        dir: "dist",
+        entryFileNames: "mezon-js.umd.js" // workaround for TS requirement that dir is specified in config
+    },
+    plugins: [
+        typescript({
+            include: ["**/*.ts"],
+            target: "es5"
+        }),
+        nodeResolve()
+    ],
+    moduleContext: {
+        [require.resolve('whatwg-fetch')]: 'window'
+    }
+};

package/session.ts

@@ -0,0 +1,114 @@
+/**
+ * Copyright 2022 The Mezon 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 * as base64 from "js-base64"
+
+/** A session authenticated for a user with Mezon server. */
+export interface ISession {
+  /** Claims */
+  /** The authorization token used to construct this session. */
+  token: string;
+  /** If the user account for this session was just created. */
+  created: boolean
+  /** The UNIX timestamp when this session was created. */
+  readonly created_at: number;
+  /** The UNIX timestamp when this session will expire. */
+  expires_at?: number;
+  /** The UNIX timestamp when the refresh token will expire. */
+  refresh_expires_at?: number;
+  /** Refresh token that can be used for session token renewal. */
+  refresh_token: string;
+  /** The username of the user who owns this session. */
+  username?: string;
+  /** The ID of the user who owns this session. */
+  user_id?: string;
+  /** Any custom properties associated with this session. */
+  vars?: object;
+
+  /** Validate token */
+  /** If the session has expired. */
+  isexpired(currenttime: number): boolean;
+  /** If the refresh token has expired. */
+  isrefreshexpired(currenttime: number): boolean;
+}
+
+export class Session implements ISession {
+
+  token : string;
+  readonly created_at: number;
+  expires_at?: number;
+  refresh_expires_at?: number;
+  refresh_token: string;
+  username?: string;
+  user_id?: string;
+  vars?: object;
+
+  constructor(
+    token: string,
+    refresh_token: string,
+    readonly created: boolean) {
+    this.token = token;
+    this.refresh_token = refresh_token;
+    this.created_at = Math.floor(new Date().getTime() / 1000);
+    this.update(token, refresh_token);
+  }
+
+  isexpired(currenttime: number): boolean {
+    return (this.expires_at! - currenttime) < 0;
+  }
+
+  isrefreshexpired(currenttime: number): boolean {
+      return (this.refresh_expires_at! - currenttime) < 0;
+  }
+
+  update(token: string, refreshToken: string) {
+
+    const tokenParts = token.split('.');
+    if (tokenParts.length != 3) {
+      throw 'jwt is not valid.';
+    }
+
+    const tokenDecoded = JSON.parse(base64.atob(tokenParts[1]));
+    const tokenExpiresAt = Math.floor(parseInt(tokenDecoded['exp']));
+
+    /** clients that have just updated to the refresh tokens */
+    /** client release will not have a cached refresh token */
+    if (refreshToken) {
+
+        const refreshTokenParts = refreshToken.split('.');
+
+        if (refreshTokenParts.length != 3) {
+            throw 'refresh jwt is not valid.';
+        }
+
+        const refreshTokenDecoded = JSON.parse(base64.atob(refreshTokenParts[1]))
+        const refreshTokenExpiresAt = Math.floor(parseInt(refreshTokenDecoded['exp']));
+        this.refresh_expires_at = refreshTokenExpiresAt;
+        this.refresh_token = refreshToken;
+    }
+
+    this.token = token;
+    this.expires_at = tokenExpiresAt;
+    this.username = tokenDecoded['usn'];
+    this.user_id = tokenDecoded['uid'];
+    this.vars = tokenDecoded['vrs'];
+  }
+
+  static restore(token: string, refreshToken: string): Session {
+    return new Session(token, refreshToken, false);
+  }
+}