polfan-server-js-client 0.1.2 → 0.1.7

package/build/types/types/src/schemes/events/RoomMembers.d.ts

@@ -0,0 +1,5 @@
+import { RoomMember } from "../RoomMember";
+export interface RoomMembers {
+    id: string;
+    members: RoomMember[];
+}

package/build/types/types/src/schemes/events/RoomUpdated.d.ts

@@ -0,0 +1,4 @@
+import { Room } from "../Room";
+export interface RoomUpdated {
+    room: Room;
+}

package/build/types/types/src/schemes/events/Session.d.ts

@@ -0,0 +1,7 @@
+import { UserState } from "../UserState";
+import { User } from "../User";
+export interface Session {
+    serverVersion: string;
+    state: UserState;
+    user: User;
+}

package/build/types/types/src/schemes/events/SpaceDeleted.d.ts

@@ -0,0 +1,3 @@
+export interface SpaceDeleted {
+    id: string;
+}

package/build/types/types/src/schemes/events/SpaceJoined.d.ts

@@ -0,0 +1,4 @@
+import { Space } from "../Space";
+export interface SpaceJoined {
+    space: Space;
+}

package/build/types/types/src/schemes/events/SpaceLeft.d.ts

@@ -0,0 +1,3 @@
+export interface SpaceLeft {
+    id: string;
+}

package/build/types/types/src/schemes/events/SpaceMemberJoined.d.ts

@@ -0,0 +1,5 @@
+import { SpaceMember } from "../SpaceMember";
+export interface SpaceMemberJoined {
+    spaceId: string;
+    member: SpaceMember;
+}

package/build/types/types/src/schemes/events/SpaceMemberLeft.d.ts

@@ -0,0 +1,4 @@
+export interface SpaceMemberLeft {
+    spaceId: string;
+    userId: string;
+}

package/build/types/types/src/schemes/events/SpaceMemberUpdated.d.ts

@@ -0,0 +1,6 @@
+import { SpaceMember } from "../SpaceMember";
+export interface SpaceMemberUpdated {
+    spaceId: string;
+    userId: string;
+    member: SpaceMember;
+}

package/build/types/types/src/schemes/events/SpaceMembers.d.ts

@@ -0,0 +1,5 @@
+import { SpaceMember } from "../SpaceMember";
+export interface SpaceMembers {
+    id: string;
+    members: SpaceMember[];
+}

package/build/types/types/src/schemes/events/SpaceRooms.d.ts

@@ -0,0 +1,5 @@
+import { RoomSummary } from "../RoomSummary";
+export interface SpaceRooms {
+    id: string;
+    summaries: RoomSummary[];
+}

package/build/types/types/src/schemes/events/SpaceUpdated.d.ts

@@ -0,0 +1,4 @@
+import { Space } from "../Space";
+export interface SpaceUpdated {
+    space: Space;
+}

package/build/types/types/src/schemes/events/TopicDeleted.d.ts

@@ -0,0 +1,4 @@
+import { ChatLocation } from "../ChatLocation";
+export interface TopicDeleted {
+    location: ChatLocation;
+}

package/build/types/types/src/schemes/events/UserUpdated.d.ts

@@ -0,0 +1,4 @@
+import { User } from "../User";
+export interface UserUpdated {
+    user: User;
+}

package/jest.config.ts

@@ -0,0 +1,199 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type {Config} from 'jest';
+
+const config: Config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "C:\\Users\\Szado\\AppData\\Local\\Temp\\jest",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "\\\\node_modules\\\\",
+  //   "\\.pnp\\.[^\\\\]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polfan-server-js-client",
-  "version": "0.1.2",
+  "version": "0.1.7",
   "description": "JavaScript client library for handling communication with Polfan chat server.",
   "author": "Jarosław Żak",
   "license": "MIT",
@@ -10,7 +10,7 @@
     "start": "webpack serve --config webpack.config.demo.js",
     "build": "webpack && tsc",
     "build:demo": "webpack --config webpack.config.demo.js",
-    "test": "jest --silent",
+    "test": "jest",
     "coverage": "npm run test -- --coverage",
     "prepare": "npm run build",
     "trypublish": "npm publish || true"
@@ -37,29 +37,11 @@
     "mini-css-extract-plugin": "^2.7.2",
     "style-loader": "^3.3.1",
     "terser-webpack-plugin": "^5.3.5",
+    "ts-node": "^10.9.2",
     "typescript": "^4.9.4",
     "url-loader": "^4.1.1",
     "webpack": "^5.75.0",
     "webpack-cli": "^5.0.1",
-    "webpack-dev-server": "4.11.1",
-    "pserv-ts-types": "^0.0.15"
-  },
-  "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"
-    ]
+    "webpack-dev-server": "4.11.1"
   }
 }

package/src/AbstractChatClient.ts

@@ -2,14 +2,13 @@ import {
     Bye,
     GetSession,
     JoinSpace,
-    Ok,
     Session,
     SpaceJoined,
     Error as ErrorType,
     SpaceLeft,
     SpaceMemberJoined,
     SpaceMemberLeft,
-    SpaceMemberUpdate,
+    SpaceMemberUpdated,
     SpaceDeleted,
     SpaceMembers,
     SpaceRooms,
@@ -24,8 +23,7 @@ import {
     NewTopic,
     TopicDeleted,
     NewMessage,
-    GetUserPermissions,
-    SetUserPermissions,
+    GetPermissionOverwrites,
     GetComputedPermissions,
     LeaveSpace,
     CreateSpace,
@@ -36,8 +34,7 @@ import {
     DeleteRole,
     AssignRole,
     DeassignRole,
-    SetRolePermissions,
-    GetRolePermissions,
+    SetPermissionOverwrites,
     JoinRoom,
     LeaveRoom,
     CreateRoom,
@@ -45,8 +42,28 @@ import {
     GetRoomMembers,
     CreateTopic,
     DeleteTopic,
-    CreateMessage, Envelope,
-} from "pserv-ts-types";
+    CreateMessage,
+    Envelope,
+    PermissionOverwrites,
+    PermissionOverwritesUpdated,
+    RoomMemberUpdated,
+    UpdateRole,
+    RoleUpdated,
+    AckReports,
+    Ack,
+    GetAckReports,
+    UserUpdated,
+    UpdateRoom,
+    RoomUpdated,
+    UpdateSpace,
+    SpaceUpdated,
+    PermissionOverwriteTargets,
+    GetPermissionOverwriteTargets,
+    Owners,
+    Ok,
+    GetOwners,
+    CreateOwner, RoleDeleted,
+} from "./types/src/index";
 import {EventTarget} from "./EventTarget";
 
 type ArrayOfPromiseResolvers = [(value: any) => void, (reason?: any) => void];
@@ -114,29 +131,39 @@ export type EventsMap = {
     Error: ErrorType,
     Session: Session,
     Permissions: Permissions,
+    PermissionOverwrites: PermissionOverwrites,
+    PermissionOverwritesUpdated: PermissionOverwritesUpdated,
+    PermissionOverwriteTargets: PermissionOverwriteTargets,
+    Owners: Owners,
     // Space events
     SpaceJoined: SpaceJoined,
     SpaceLeft: SpaceLeft,
     SpaceMemberJoined: SpaceMemberJoined,
     SpaceMemberLeft: SpaceMemberLeft,
-    SpaceMemberUpdate: SpaceMemberUpdate,
+    SpaceMemberUpdated: SpaceMemberUpdated,
+    SpaceUpdated: SpaceUpdated,
     SpaceDeleted: SpaceDeleted,
     SpaceMembers: SpaceMembers,
     SpaceRooms: SpaceRooms,
     NewRole: NewRole,
-    RoleDeleted: RoomDeleted,
+    RoleDeleted: RoleDeleted,
+    RoleUpdated: RoleUpdated,
     // Room events
     RoomJoined: RoomJoined,
     RoomLeft: RoomLeft,
     RoomMemberJoined: RoomMemberJoined,
     RoomMemberLeft: RoomMemberLeft,
+    RoomMemberUpdated: RoomMemberUpdated,
     RoomMembers: RoomMembers,
     NewRoom: NewRoom,
     RoomDeleted: RoomDeleted,
+    RoomUpdated: RoomUpdated,
     // Topic events
     NewTopic: NewTopic,
     TopicDeleted: TopicDeleted,
     NewMessage: NewMessage,
+    AckReports: AckReports,
+    UserUpdated: UserUpdated,
 };
 
 /**
@@ -145,30 +172,37 @@ export type EventsMap = {
 export type CommandsMap = {
     // General commands
     GetSession: [GetSession, EventsMap['Session']],
-    SetUserPermissions: [SetUserPermissions, EventsMap['Permissions']],
-    GetUserPermissions: [GetUserPermissions, EventsMap['Permissions']],
+    SetPermissionOverwrites: [SetPermissionOverwrites, EventsMap['PermissionOverwritesUpdated']],
+    GetPermissionOverwrites: [GetPermissionOverwrites, EventsMap['PermissionOverwrites']],
     GetComputedPermissions: [GetComputedPermissions, EventsMap['Permissions']],
+    GetPermissionOverwriteTargets: [GetPermissionOverwriteTargets, EventsMap['PermissionOverwriteTargets']],
+    GetOwners: [GetOwners, EventsMap['Owners']],
+    CreateOwner: [CreateOwner, EventsMap['Owners']],
+    DeleteOwner: [CreateOwner, EventsMap['Owners']],
     // Space commands
     JoinSpace: [JoinSpace, EventsMap['SpaceJoined']],
     LeaveSpace: [LeaveSpace, EventsMap['SpaceLeft']],
     CreateSpace: [CreateSpace, EventsMap['SpaceJoined']],
+    UpdateSpace: [UpdateSpace, EventsMap['SpaceUpdated']],
     DeleteSpace: [DeleteSpace, EventsMap['SpaceDeleted']],
     GetSpaceMembers: [GetSpaceMembers, EventsMap['SpaceMembers']],
     GetSpaceRooms: [GetSpaceRooms, EventsMap['SpaceRooms']],
     CreateRole: [CreateRole, EventsMap['NewRole']],
     DeleteRole: [DeleteRole, EventsMap['RoleDeleted']],
-    AssignRole: [AssignRole, EventsMap['SpaceMemberUpdate']],
-    DeassignRole: [DeassignRole, EventsMap['SpaceMemberUpdate']],
-    SetRolePermissions: [SetRolePermissions, EventsMap['Permissions']],
-    GetRolePermissions: [GetRolePermissions, EventsMap['Permissions']],
+    UpdateRole: [UpdateRole, EventsMap['RoleUpdated']],
+    AssignRole: [AssignRole, EventsMap['SpaceMemberUpdated'] | EventsMap['RoomMemberUpdated']],
+    DeassignRole: [DeassignRole, EventsMap['SpaceMemberUpdated'] | EventsMap['RoomMemberUpdated']],
     // Room commands
     JoinRoom: [JoinRoom, EventsMap['RoomJoined']],
     LeaveRoom: [LeaveRoom, EventsMap['RoomLeft']],
     CreateRoom: [CreateRoom, EventsMap['NewRoom']],
     DeleteRoom: [DeleteRoom, EventsMap['RoomDeleted']],
+    UpdateRoom: [UpdateRoom, EventsMap['RoomUpdated']],
     GetRoomMembers: [GetRoomMembers, EventsMap['RoomMembers']],
     // Topic commands
     CreateTopic: [CreateTopic, EventsMap['NewTopic']],
     DeleteTopic: [DeleteTopic, EventsMap['TopicDeleted']],
     CreateMessage: [CreateMessage, EventsMap['NewMessage']],
+    Ack: [Ack, EventsMap['AckReports']],
+    GetAckReports: [GetAckReports, EventsMap['AckReports']],
 }

package/src/AbstractRestClient.ts

@@ -1,66 +1,66 @@
-export interface RestClientOptions {
-    url?: string;
-    token: string;
-}
-
-export interface RestClientResponse<T> {
-    ok: boolean;
-    status: number;
-    data: T;
-}
-
-export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
-
-export abstract class AbstractRestClient {
-    protected abstract defaultUrl: string;
-
-    public constructor(
-        private readonly options: RestClientOptions,
-    ) {}
-
-    protected async send<ResponseT = any>(
-        method: HttpMethod,
-        uri: string,
-        data: any = undefined
-    ): Promise<RestClientResponse<ResponseT>> {
-        const headers: any = {
-            'Content-Type': 'application/json',
-            Accept: 'application/json'
-        };
-
-        if (this.options.token) {
-            headers.Authorization = `Bearer ${this.options.token}`;
-        }
-
-        let url = this.getUrl(uri);
-        let body = undefined;
-
-        if (data) {
-            if (['GET', 'DELETE'].includes(method)) {
-                url += new URLSearchParams(data).toString()
-            } else {
-                body = JSON.stringify(data);
-            }
-        }
-
-        const result = await fetch(url, {method, body, headers});
-
-        return {
-            ok: result.ok,
-            status: result.status,
-            data: await result.json(),
-        };
-    }
-
-    protected getUrl(uri: string): string {
-        return this.removeEndingSlash(this.options.url ?? this.defaultUrl) + '/' + this.removeStartingSlash(uri);
-    }
-
-    private removeStartingSlash(text: string): string {
-        return text.replace(/^\/+/, '');
-    }
-
-    private removeEndingSlash(text: string): string {
-        return text.replace(/\/+$/, '');
-    }
+export interface RestClientOptions {
+    url?: string;
+    token: string;
+}
+
+export interface RestClientResponse<T> {
+    ok: boolean;
+    status: number;
+    data: T;
+}
+
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+
+export abstract class AbstractRestClient {
+    protected abstract defaultUrl: string;
+
+    public constructor(
+        private readonly options: RestClientOptions,
+    ) {}
+
+    protected async send<ResponseT = any>(
+        method: HttpMethod,
+        uri: string,
+        data: any = undefined
+    ): Promise<RestClientResponse<ResponseT>> {
+        const headers: any = {
+            'Content-Type': 'application/json',
+            Accept: 'application/json'
+        };
+
+        if (this.options.token) {
+            headers.Authorization = `Bearer ${this.options.token}`;
+        }
+
+        let url = this.getUrl(uri);
+        let body = undefined;
+
+        if (data) {
+            if (['GET', 'DELETE'].includes(method)) {
+                url += new URLSearchParams(data).toString()
+            } else {
+                body = JSON.stringify(data);
+            }
+        }
+
+        const result = await fetch(url, {method, body, headers});
+
+        return {
+            ok: result.ok,
+            status: result.status,
+            data: result.headers.get('content-type')?.includes('json') ? await result.json() : await result.text(),
+        };
+    }
+
+    protected getUrl(uri: string): string {
+        return this.removeEndingSlash(this.options.url ?? this.defaultUrl) + '/' + this.removeStartingSlash(uri);
+    }
+
+    private removeStartingSlash(text: string): string {
+        return text.replace(/^\/+/, '');
+    }
+
+    private removeEndingSlash(text: string): string {
+        return text.replace(/\/+$/, '');
+    }
 }

package/src/IndexedObjectCollection.ts

@@ -21,7 +21,7 @@ export class IndexedCollection<KeyT, ValueT> {
         }
     }
 
-    public get(id: KeyT): ValueT | null {
+    public get(id: KeyT): ValueT | undefined {
         return this.items.get(id);
     }
 
@@ -81,11 +81,11 @@ export class IndexedObjectCollection<T> {
         this._items.set(...(items.map(item => [this.getId(item), item] as [string, T])));
     }
 
-    public get(id: any): T | null {
+    public get(id: any): T | undefined {
         return this._items.get(id);
     }
 
-    public getAt(index: number): T|null {
+    public getAt(index: number): T | undefined {
         return this.items[index];
     }