polfan-server-js-client 0.0.5 → 0.0.6

package/old/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "polfan-server-js-client",
+  "version": "0.0.5",
+  "description": "JavaScript client library for handling communication with Polfan chat server.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "webpack"
+  },
+  "author": "Jarosław Żak",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^4.6.3",
+    "webpack-cli": "^4.9.2"
+  },
+  "dependencies": {
+    "@types/uuid": "^8.3.4",
+    "ts-loader": "^9.2.8",
+    "uuid": "^8.3.2"
+  }
+}

package/old/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "strictPropertyInitialization": false,
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/__tests__/*"]
+}

package/package.json

@@ -1,22 +1,64 @@
 {
   "name": "polfan-server-js-client",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "JavaScript client library for handling communication with Polfan chat server.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "author": "Jarosław Żak",
+  "license": "MIT",
+  "main": "build/index.js",
+  "types": "build/types/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "webpack"
+    "start": "webpack serve --config webpack.config.demo.js",
+    "build": "webpack && tsc",
+    "build:demo": "webpack --config webpack.config.demo.js",
+    "test": "jest --silent",
+    "coverage": "npm run test -- --coverage",
+    "prepare": "npm run build",
+    "trypublish": "npm publish || true"
   },
-  "author": "Jarosław Żak",
-  "license": "ISC",
   "devDependencies": {
-    "typescript": "^4.6.3",
-    "webpack-cli": "^4.9.2"
+    "@babel/cli": "^7.20.7",
+    "@babel/core": "^7.20.12",
+    "@babel/plugin-proposal-class-properties": "^7.16.0",
+    "@babel/plugin-transform-typescript": "^7.20.2",
+    "@babel/polyfill": "^7.12.1",
+    "@babel/preset-env": "^7.20.2",
+    "@types/jest": "^29.2.5",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
+    "babel-eslint": "^10.1.0",
+    "babel-loader": "^9.1.2",
+    "babel-preset-minify": "^0.5.2",
+    "css-loader": "^6.7.3",
+    "css-minimizer-webpack-plugin": "^4.2.2",
+    "eslint": "^7.32.0",
+    "file-loader": "^6.2.0",
+    "html-webpack-plugin": "^5.5.0",
+    "jest": "^29.3.1",
+    "mini-css-extract-plugin": "^2.7.2",
+    "style-loader": "^3.3.1",
+    "terser-webpack-plugin": "^5.3.5",
+    "typescript": "^4.9.4",
+    "url-loader": "^4.1.1",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^5.0.1",
+    "webpack-dev-server": "4.11.1"
   },
-  "dependencies": {
-    "@types/uuid": "^8.3.4",
-    "ts-loader": "^9.2.8",
-    "uuid": "^8.3.2"
+  "jest": {
+    "moduleNameMapper": {
+      "\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": "<rootDir>/scripts/testMock.js",
+      "\\.(css|less)$": "<rootDir>/scripts/testMock.js"
+    },
+    "moduleFileExtensions": [
+      "web.js",
+      "js",
+      "web.ts",
+      "ts",
+      "web.tsx",
+      "tsx",
+      "json",
+      "web.jsx",
+      "jsx",
+      "node"
+    ]
   }
 }

package/tsconfig.json

@@ -1,12 +1,17 @@
 {
-  "compilerOptions": {
-    "target": "ES6",
-    "module": "commonjs",
-    "declaration": true,
-    "outDir": "./dist",
-    "strict": true,
-    "strictPropertyInitialization": false,
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "**/__tests__/*"]
+    "compilerOptions": {
+      "noImplicitAny": true,
+      "outDir": "build/types",
+      "module": "esnext",
+      "target": "es5",
+      "allowJs": true,
+      "sourceMap": true,
+      "declaration": true,
+      "emitDeclarationOnly": true,
+      "suppressImplicitAnyIndexErrors": true,
+      "lib": ["es2018", "dom"],
+      "moduleResolution": "node",
+    },
+    "include": ["src/lib"],
+    "exclude": ["src/lib/**/tests"],
 }

package/webpack.config.demo.js

@@ -0,0 +1,47 @@
+const MiniCssExtractPlugin = require("mini-css-extract-plugin");
+const HtmlWebpackPlugin = require('html-webpack-plugin');
+
+module.exports = {
+  mode: "development",
+  devtool: 'cheap-module-source-map',
+  entry: './src/demo/index.ts',
+  output: {
+    filename: 'index.js'
+  },
+  optimization: {
+    minimize: false,
+  },
+  devServer: {
+    open: true,
+    hot: true,
+    host: "localhost",
+    port: 9000
+  },
+  module: {
+    rules: [
+      {
+        test: /\.(m|j|t)s$/,
+        exclude: /(node_modules|bower_components)/,
+        use: {
+          loader: 'babel-loader'
+        }
+      },
+      {
+        test: /\.(sa|sc|c)ss$/,
+        use: [
+          MiniCssExtractPlugin.loader,
+          { loader: "css-loader", options: { sourceMap: true } },
+        ],
+      }
+    ]
+  },
+  plugins: [
+    new MiniCssExtractPlugin({
+      filename: 'css/index.css'
+    }),
+    new HtmlWebpackPlugin(),
+  ],
+  resolve: {
+    extensions: ['.ts', '.js', '.json']
+  }
+};

package/src/Client.ts

@@ -1,166 +0,0 @@
-import {ConnectionEvent, ConnectionInterface} from "./connections/ConnectionInterface";
-import {EventTarget} from "./ObservableInterface";
-import {Envelope} from "./dtos/protocol/Envelope";
-import {JoinRoom} from "./dtos/protocol/commands/JoinRoom";
-import {Dto} from "./dtos/Dto";
-import {RoomJoined} from "./dtos/protocol/events/RoomJoined";
-import {LeaveRoom} from "./dtos/protocol/commands/LeaveRoom";
-import {RoomLeft} from "./dtos/protocol/events/RoomLeft";
-import {CreateRoom} from "./dtos/protocol/commands/CreateRoom";
-import {Error} from "./dtos/protocol/events/Error";
-import {SpaceRooms} from "./dtos/protocol/events/SpaceRooms";
-import {DeleteRoom} from "./dtos/protocol/commands/DeleteRoom";
-import {RoomDeleted} from "./dtos/protocol/events/RoomDeleted";
-import {GetRoomMembers} from "./dtos/protocol/commands/GetRoomMembers";
-import {RoomMembers} from "./dtos/protocol/events/RoomMembers";
-import {JoinSpace} from "./dtos/protocol/commands/JoinSpace";
-import {SpaceJoined} from "./dtos/protocol/events/SpaceJoined";
-import {LeaveSpace} from "./dtos/protocol/commands/LeaveSpace";
-import {SpaceLeft} from "./dtos/protocol/events/SpaceLeft";
-import {CreateSpace} from "./dtos/protocol/commands/CreateSpace";
-import {DeleteSpace} from "./dtos/protocol/commands/DeleteSpace";
-import {SpaceDeleted} from "./dtos/protocol/events/SpaceDeleted";
-import {GetSpaceMembers} from "./dtos/protocol/commands/GetSpaceMembers";
-import {SpaceMembers} from "./dtos/protocol/events/SpaceMembers";
-import {GetSpaceRooms} from "./dtos/protocol/commands/GetSpaceRooms";
-import {GetSession} from "./dtos/protocol/commands/GetSession";
-import {Session} from "./dtos/protocol/events/Session";
-import {AssignRole} from "./dtos/protocol/commands/AssignRole";
-import {SpaceMemberUpdate} from "./dtos/protocol/events/SpaceMemberUpdate";
-import {DeassignRole} from "./dtos/protocol/commands/DeassignRole";
-import {CreateRole} from "./dtos/protocol/commands/CreateRole";
-import {NewRole} from "./dtos/protocol/events/NewRole";
-import {DeleteRole} from "./dtos/protocol/commands/DeleteRole";
-import {RoleDeleted} from "./dtos/protocol/events/RoleDeleted";
-import {SetRolePermissions} from "./dtos/protocol/commands/SetRolePermissions";
-import {Permissions} from "./dtos/protocol/events/Permissions";
-import {SetUserPermissions} from "./dtos/protocol/commands/SetUserPermissions";
-import {CreateTopic} from "./dtos/protocol/commands/CreateTopic";
-import {NewTopic} from "./dtos/protocol/events/NewTopic";
-import {DeleteTopic} from "./dtos/protocol/commands/DeleteTopic";
-import {TopicDeleted} from "./dtos/protocol/events/TopicDeleted";
-import {CreateMessage} from "./dtos/protocol/commands/CreateMessage";
-import {NewMessage} from "./dtos/protocol/events/NewMessage";
-import {GetComputedPermissions} from "./dtos/protocol/commands/GetComputedPermissions";
-import {GetRolePermissions} from "./dtos/protocol/commands/GetRolePermissions";
-import {GetUserPermissions} from "./dtos/protocol/commands/GetUserPermissions";
-import {commands, events} from "./protocol";
-
-type ArrayOfPromiseResolvers = [(value: any) => void, (reason?: any) => void];
-type CmdResult<EventDto> = EventDto | Error;
-type CommandsToEventsType<CommandT> =
-    // General commands
-    CommandT extends GetSession ? CmdResult<Session> :
-    CommandT extends SetUserPermissions ? CmdResult<Permissions> :
-    CommandT extends GetUserPermissions ? CmdResult<Permissions> :
-    CommandT extends GetComputedPermissions ? CmdResult<Permissions> :
-    // Space commands
-    CommandT extends JoinSpace ? CmdResult<SpaceJoined> :
-    CommandT extends LeaveSpace ? CmdResult<SpaceLeft> :
-    CommandT extends CreateSpace ? CmdResult<SpaceJoined> :
-    CommandT extends DeleteSpace ? CmdResult<SpaceDeleted> :
-    CommandT extends GetSpaceMembers ? CmdResult<SpaceMembers> :
-    CommandT extends GetSpaceRooms ? CmdResult<SpaceRooms> :
-    CommandT extends CreateRole ? CmdResult<NewRole> :
-    CommandT extends DeleteRole ? CmdResult<RoleDeleted> :
-    CommandT extends AssignRole ? CmdResult<SpaceMemberUpdate> :
-    CommandT extends DeassignRole ? CmdResult<SpaceMemberUpdate> :
-    CommandT extends SetRolePermissions ? CmdResult<Permissions> :
-    CommandT extends GetRolePermissions ? CmdResult<Permissions> :
-    // Room commands
-    CommandT extends JoinRoom ? CmdResult<RoomJoined> :
-    CommandT extends LeaveRoom ? CmdResult<RoomLeft> :
-    CommandT extends CreateRoom ? CmdResult<RoomJoined> :
-    CommandT extends DeleteRoom ? CmdResult<RoomDeleted> :
-    CommandT extends GetRoomMembers ? CmdResult<RoomMembers> :
-    // Topic commands
-    CommandT extends CreateTopic ? CmdResult<NewTopic> :
-    CommandT extends DeleteTopic ? CmdResult<TopicDeleted> :
-    CommandT extends CreateMessage ? CmdResult<NewMessage> :
-    any;
-
-function guessCommandType(obj: any): string {
-    for (const type in commands) {
-        if (obj instanceof commands[type]) {
-            return type;
-        }
-    }
-    return Object.getPrototypeOf(obj).constructor.name;
-}
-
-export class Client extends EventTarget {
-    protected commandsCount = 0;
-    protected awaitingResponse: Map<string, ArrayOfPromiseResolvers> = new Map<string, ArrayOfPromiseResolvers>();
-    protected eventsMap: {[x: string]: typeof Dto};
-
-    public constructor(private connection: ConnectionInterface) {
-        super();
-        this.setCustomEventMap({}); // Set default event map.
-        this.connection.on(ConnectionEvent.message, payload => this.onMessage(payload));
-        this.connection.on(ConnectionEvent.disconnect, () => this.onDisconnect());
-    }
-
-    /**
-     * Send command to server.
-     * @param commandPayload Command payload object.
-     * @param commandType Command type; if not specified, it will be guessed from the command payload class name.
-     * @return Promise which resolves to the event returned by server (including `Error`)
-     * in response to command and rejects with connection error.
-     */
-    public async exec<CommandT extends Dto = any>(
-        commandPayload: CommandT,
-        commandType?: string
-    ): Promise<CommandsToEventsType<CommandT>> {
-        const message = this.createEnvelope(commandType ?? guessCommandType(commandPayload), commandPayload);
-        this.connection.send(message.toJson());
-        return new Promise(
-            (...args) => this.awaitingResponse.set(message.meta.ref as string, args)
-        );
-    }
-
-    /**
-     * Set custom DTO classes for events.
-     */
-    public setCustomEventMap(customMap: {[x: string]: typeof Dto}): this {
-        this.eventsMap = {...events, ...customMap};
-        return this;
-    }
-
-    private onMessage(payload: string) {
-        const message: Envelope = JSON.parse(payload);
-        const dto = this.createEventByEnvelope(message);
-
-        const [resolve] = this.awaitingResponse.get(message.meta.ref ?? '') ?? [];
-        if (resolve) {
-            resolve(dto ?? message.data);
-            this.awaitingResponse.delete(message.meta.ref as string);
-        }
-
-        this.emit('message', message);
-        this.emit(message.meta.type ?? 'unknown', message, dto);
-    }
-
-    private onDisconnect(): void {
-        this.awaitingResponse.forEach(([resolve, reject], key: string) => {
-            reject('Disconnected');
-            this.awaitingResponse.delete(key);
-        });
-    }
-
-    private createEnvelope(commandType: string, dto: Dto): Envelope {
-        return new Envelope({
-            meta: {
-                type: commandType,
-                ref: (++this.commandsCount).toString()
-            },
-            data: dto
-        });
-    }
-
-    private createEventByEnvelope(message: Envelope): Dto | null {
-        if ((message.meta.type ?? false) && this.eventsMap.hasOwnProperty(message.meta.type)) {
-            return new (this.eventsMap[message.meta.type] as any)(message.data);
-        }
-        return null;
-    }
-}

package/src/ObservableInterface.ts

@@ -1,22 +0,0 @@
-export type EventHandler<T = any> = (...args: T[]) => void;
-
-export interface ObservableInterface {
-    on(eventName: string, handler: EventHandler): ObservableInterface;
-}
-
-export abstract class EventTarget implements ObservableInterface {
-    protected events: Map<string, EventHandler[]> = new Map<string, EventHandler[]>();
-
-    public on(eventName: string, handler: EventHandler): EventTarget {
-        const handlers = this.events.get(eventName) ?? [];
-        handlers.push(handler);
-        this.events.set(eventName, handlers);
-        return this;
-    }
-
-    public emit(eventName: string, ...args: any): EventTarget
-    {
-        this.events.get(eventName)?.forEach(callback => callback(...args));
-        return this;
-    }
-}

package/src/Token.ts

@@ -1,21 +0,0 @@
-const apiUrl = 'https://polfan.pl/webservice/api/auth/token';
-const defaultClientName = 'Polfan JS Library';
-
-export interface TokenInterface {
-    token: string,
-    expiration: string
-}
-
-export async function getToken(login: string, password: string, clientName: string = defaultClientName): Promise<TokenInterface> {
-    const response = await fetch(apiUrl, {
-        method: 'POST',
-        headers: {
-            'Content-Type': 'application/json',
-            Accept: 'application/json'
-        },
-        body: JSON.stringify({
-            login, password, client_name: clientName
-        })
-    });
-    return response.json();
-}

package/src/connections/ConnectionInterface.ts

@@ -1,20 +0,0 @@
-import {ObservableInterface} from "../ObservableInterface";
-
-export enum ConnectionState {
-    pending,
-    ready,
-    disconnected
-}
-
-export enum ConnectionEvent {
-    message = 'message',
-    connect = 'connect',
-    disconnect = 'disconnect'
-}
-
-export interface ConnectionInterface extends ObservableInterface {
-    state: ConnectionState,
-    connect(): void;
-    disconnect(): void;
-    send(data: string): void;
-}

package/src/connections/WebApiConnection.ts

@@ -1,43 +0,0 @@
-import {ConnectionEvent, ConnectionInterface, ConnectionState} from "./ConnectionInterface";
-import {EventTarget} from "../ObservableInterface";
-
-export interface WebApiConnectionConfig {
-    token: string;
-    url: string;
-}
-
-export class WebApiConnection extends EventTarget implements ConnectionInterface {
-    public state: ConnectionState = ConnectionState.ready;
-
-    public constructor(
-        private readonly config: WebApiConnectionConfig
-    ) {
-        super();
-    }
-
-    public connect(): void {
-        this.emit(ConnectionEvent.connect);
-    }
-
-    public disconnect(): void {
-        this.emit(ConnectionEvent.disconnect);
-    }
-
-    public send(data: string): void {
-        fetch(this.config.url, {
-            method: 'POST',
-            headers: {
-                Authorization: `Bearer ${this.config.token}`,
-                ContentType: 'application/json',
-                Accept: 'application/json'
-            },
-            body: JSON.stringify(data)
-        })
-            .then((response: Response) => response.text())
-            .then(this.onMessage);
-    }
-
-    private onMessage(message: string): void {
-        this.emit(ConnectionEvent.message, message);
-    }
-}

package/src/connections/WebSocketConnection.ts

@@ -1,47 +0,0 @@
-import {EventTarget} from "../ObservableInterface";
-import {ConnectionEvent, ConnectionInterface, ConnectionState} from "./ConnectionInterface";
-
-interface WebSocketConnectionConfig {
-    url: string;
-    token: string;
-}
-
-export class WebSocketConnection extends EventTarget implements ConnectionInterface {
-    public state: ConnectionState = ConnectionState.disconnected;
-
-    private ws: WebSocket|null = null;
-
-    public constructor(private config: WebSocketConnectionConfig) {
-        super();
-    }
-
-    public connect(): void {
-        this.ws = new WebSocket(`${this.config.url}?token=${this.config.token}`);
-        this.ws.onopen = () => this.onOpen();
-        this.ws.onclose = () => this.onClose();
-        this.ws.onerror = () => this.onClose();
-        this.ws.onmessage = ev => this.onMessage(ev);
-    }
-
-    public disconnect(): void {
-        this.ws?.close();
-    }
-
-    public send(data: string): void {
-        this.ws?.send(data);
-    }
-
-    private onMessage(event: MessageEvent): void {
-        this.emit(ConnectionEvent.message, event.data);
-    }
-
-    private onClose(): void {
-        this.state = ConnectionState.disconnected;
-        this.emit(ConnectionEvent.disconnect);
-    }
-
-    private onOpen(): void {
-        this.state = ConnectionState.ready;
-        this.emit(ConnectionEvent.connect);
-    }
-}

package/src/dtos/Dto.ts

@@ -1,45 +0,0 @@
-export function cast<T extends typeof Dto>(data: any, dto: T): T {
-    if (data instanceof dto) {
-        return data as any;
-    }
-    return new (dto as any)(data);
-}
-
-export function castArray<T extends typeof Dto>(data: any[], dto: T): T[] {
-    if (!Array.isArray(data)) throw new Error(`Passed data is not an array of ${dto.name}`);
-    return data.map(item => cast(item, dto));
-}
-
-type ExcludeMethods<T> = Pick<T, { [K in keyof T]: T[K] extends Function ? never : K }[keyof T]>;
-export type DtoData<T> = { [K in keyof ExcludeMethods<T>]: any };
-
-export abstract class Dto {
-    public constructor(...args: any[]) {
-    }
-
-    public toJson(overrideBy: any = {}): string {
-        return JSON.stringify(this.toRaw(overrideBy));
-    }
-
-    public toRaw(overrideBy: any = {}): DtoData<this> {
-        const object: {[key: string]: any} = {};
-        Object.keys(this).forEach(key => {
-            if (overrideBy.hasOwnProperty(key)) {
-                object[key] = overrideBy[key];
-            } else if ((this as any)[key] instanceof Dto) {
-                object[key] = (this as any)[key].toRaw();
-            } else {
-                object[key] = (this as any)[key]
-            }
-        });
-        return object as DtoData<this>;
-    }
-
-    public clone(overrideBy: any = {}): this {
-        return new (this.constructor as any)(this.toRaw(overrideBy));
-    }
-
-    protected fill(data: any, overrideBy: any = {}) {
-        Object.assign(this, {...data, ...overrideBy});
-    }
-}

package/src/dtos/Message.ts

@@ -1,16 +0,0 @@
-import {cast, Dto, DtoData} from "./Dto";
-import {User} from "./User";
-
-export class Message extends Dto {
-    public readonly id: string;
-    public readonly author: User;
-    public readonly topicId: string;
-    public readonly content: string;
-
-    public constructor(data: DtoData<Message>) {
-        super();
-        this.fill(data, {
-            author: cast(data.author, User),
-        });
-    }
-}

package/src/dtos/Permission.ts

@@ -1,12 +0,0 @@
-import {Dto, DtoData} from "./Dto";
-
-export class Permission extends Dto {
-    public readonly name: string;
-    public readonly value: boolean;
-    public readonly skip: boolean;
-
-    public constructor(data: DtoData<Permission>) {
-        super(data);
-        this.fill(data);
-    }
-}

package/src/dtos/Role.ts

@@ -1,12 +0,0 @@
-import {Dto, DtoData} from "./Dto";
-
-export class Role extends Dto {
-    public readonly id: string;
-    public readonly name: string;
-    public readonly color?: string;
-
-    public constructor(data: DtoData<Role>) {
-        super();
-        this.fill(data);
-    }
-}

package/src/dtos/Room.ts

@@ -1,15 +0,0 @@
-import {castArray, Dto, DtoData} from "./Dto";
-import {Topic} from "./Topic";
-
-export class Room extends Dto {
-    public readonly id: string;
-    public readonly name: string;
-    public readonly topics: Topic[];
-
-    public constructor(data: DtoData<Room>) {
-        super();
-        this.fill(data, {
-            topics: castArray(data.topics, Topic),
-        });
-    }
-}

package/src/dtos/RoomMember.ts

@@ -1,13 +0,0 @@
-import {cast, Dto, DtoData} from "./Dto";
-import {User} from "./User";
-
-export class RoomMember extends Dto {
-    public readonly user: User;
-
-    public constructor(data: DtoData<RoomMember>) {
-        super();
-        this.fill(data, {
-            user: cast(data.user, User),
-        });
-    }
-}

package/src/dtos/RoomSummary.ts

@@ -1,12 +0,0 @@
-import {Dto, DtoData} from "./Dto";
-
-export class RoomSummary extends Dto {
-    public readonly id: string;
-    public readonly name: string;
-    public readonly description: string;
-
-    public constructor(data: DtoData<RoomSummary>) {
-        super();
-        this.fill(data);
-    }
-}

package/src/dtos/Space.ts

@@ -1,15 +0,0 @@
-import {castArray, Dto, DtoData} from "./Dto";
-import {Role} from "./Role";
-
-export class Space extends Dto {
-    public readonly id: string;
-    public readonly name: string;
-    public readonly roles: Role[];
-
-    public constructor(data: DtoData<Space>) {
-        super();
-        this.fill(data, {
-            roles: castArray(data.roles, Role)
-        });
-    }
-}