polfan-server-js-client 0.1.1 → 0.1.6

package/src/types/src/index.ts

@@ -0,0 +1,168 @@
+import {Envelope} from "./schemes/Envelope";
+import {Message} from "./schemes/Message";
+import {PermissionOverwritesValue} from "./schemes/PermissionOverwritesValue";
+import {Role} from "./schemes/Role";
+import {Room} from "./schemes/Room";
+import {RoomMember} from "./schemes/RoomMember";
+import {RoomSummary} from "./schemes/RoomSummary";
+import {Space} from "./schemes/Space";
+import {SpaceMember} from "./schemes/SpaceMember";
+import {Topic} from "./schemes/Topic";
+import {User} from "./schemes/User";
+import {UserState} from "./schemes/UserState";
+import {Bye} from "./schemes/events/Bye";
+import {Error} from "./schemes/events/Error";
+import {Session} from "./schemes/events/Session";
+import {ComputedPermissions} from "./schemes/events/ComputedPermissions";
+import {SpaceJoined} from "./schemes/events/SpaceJoined";
+import {SpaceLeft} from "./schemes/events/SpaceLeft";
+import {SpaceMemberJoined} from "./schemes/events/SpaceMemberJoined";
+import {SpaceMemberLeft} from "./schemes/events/SpaceMemberLeft";
+import {SpaceMemberUpdated} from "./schemes/events/SpaceMemberUpdated";
+import {SpaceDeleted} from "./schemes/events/SpaceDeleted";
+import {SpaceMembers} from "./schemes/events/SpaceMembers";
+import {SpaceRooms} from "./schemes/events/SpaceRooms";
+import {NewRole} from "./schemes/events/NewRole";
+import {RoleDeleted} from "./schemes/events/RoleDeleted";
+import {RoomJoined} from "./schemes/events/RoomJoined";
+import {RoomLeft} from "./schemes/events/RoomLeft";
+import {RoomMemberJoined} from "./schemes/events/RoomMemberJoined";
+import {RoomMemberLeft} from "./schemes/events/RoomMemberLeft";
+import {RoomMembers} from "./schemes/events/RoomMembers";
+import {RoomMemberUpdated} from "./schemes/events/RoomMemberUpdated";
+import {NewRoom} from "./schemes/events/NewRoom";
+import {RoomDeleted} from "./schemes/events/RoomDeleted";
+import {NewTopic} from "./schemes/events/NewTopic";
+import {TopicDeleted} from "./schemes/events/TopicDeleted";
+import {NewMessage} from "./schemes/events/NewMessage";
+import {PermissionOverwritesUpdated} from "./schemes/events/PermissionOverwritesUpdated";
+import {PermissionOverwrites} from "./schemes/events/PermissionOverwrites";
+import {GetSession} from "./schemes/commands/GetSession";
+import {GetComputedPermissions} from "./schemes/commands/GetComputedPermissions";
+import {JoinSpace} from "./schemes/commands/JoinSpace";
+import {LeaveSpace} from "./schemes/commands/LeaveSpace";
+import {CreateSpace} from "./schemes/commands/CreateSpace";
+import {DeleteSpace} from "./schemes/commands/DeleteSpace";
+import {GetSpaceMembers} from "./schemes/commands/GetSpaceMembers";
+import {GetSpaceRooms} from "./schemes/commands/GetSpaceRooms";
+import {CreateRole} from "./schemes/commands/CreateRole";
+import {DeleteRole} from "./schemes/commands/DeleteRole";
+import {RoleUpdated} from "./schemes/events/RoleUpdated";
+import {AssignRole} from "./schemes/commands/AssignRole";
+import {DeassignRole} from "./schemes/commands/DeassignRole";
+import {SetPermissionOverwrites} from "./schemes/commands/SetPermissionOverwrites";
+import {GetPermissionOverwrites} from "./schemes/commands/GetPermissionOverwrites";
+import {JoinRoom} from "./schemes/commands/JoinRoom";
+import {LeaveRoom} from "./schemes/commands/LeaveRoom";
+import {CreateRoom} from "./schemes/commands/CreateRoom";
+import {DeleteRoom} from "./schemes/commands/DeleteRoom";
+import {GetRoomMembers} from "./schemes/commands/GetRoomMembers";
+import {CreateTopic} from "./schemes/commands/CreateTopic";
+import {DeleteTopic} from "./schemes/commands/DeleteTopic";
+import {CreateMessage} from "./schemes/commands/CreateMessage";
+import {UpdateRole} from "./schemes/commands/UpdateRole";
+import {GetAckReports} from "./schemes/commands/GetAckReports";
+import {Ack} from "./schemes/commands/Ack";
+import {AckReports} from "./schemes/events/AckReports";
+import {AckReport} from "./schemes/AckReport";
+import {UserUpdated} from "./schemes/events/UserUpdated";
+import {UpdateRoom} from "./schemes/commands/UpdateRoom";
+import {UpdateSpace} from "./schemes/commands/UpdateSpace";
+import {RoomUpdated} from "./schemes/events/RoomUpdated";
+import {SpaceUpdated} from "./schemes/events/SpaceUpdated";
+import {ChatLocation} from "./schemes/ChatLocation";
+import {GetPermissionOverwriteTargets} from "./schemes/commands/GetPermissionOverwriteTargets";
+import {PermissionOverwriteTargets} from "./schemes/events/PermissionOverwriteTargets";
+import { CreateOwner } from "./schemes/commands/CreateOwner";
+import { DeleteOwner } from "./schemes/commands/DeleteOwner";
+import { GetOwners } from "./schemes/commands/GetOwners";
+import { Owners } from "./schemes/events/Owners";
+import { Ok } from "./schemes/events/Ok";
+import {RoomType} from "./schemes/Room";
+
+export {
+    // objects
+    Envelope,
+    Message,
+    AckReport,
+    Role,
+    Room,
+    RoomType,
+    RoomMember,
+    RoomSummary,
+    Space,
+    SpaceMember,
+    Topic,
+    User,
+    UserState,
+    PermissionOverwritesValue,
+    ChatLocation,
+    // events
+    Bye,
+    Error,
+    NewMessage,
+    AckReports,
+    NewRole,
+    NewRoom,
+    NewTopic,
+    ComputedPermissions,
+    PermissionOverwrites,
+    PermissionOverwritesUpdated,
+    RoleDeleted,
+    RoleUpdated,
+    RoomDeleted,
+    RoomUpdated,
+    RoomJoined,
+    RoomLeft,
+    RoomMemberJoined,
+    RoomMemberLeft,
+    RoomMembers,
+    RoomMemberUpdated,
+    UserUpdated,
+    Session,
+    SpaceDeleted,
+    SpaceUpdated,
+    SpaceJoined,
+    SpaceLeft,
+    SpaceMemberJoined,
+    SpaceMemberLeft,
+    SpaceMembers,
+    SpaceMemberUpdated,
+    SpaceRooms,
+    TopicDeleted,
+    PermissionOverwriteTargets,
+    Owners,
+    Ok,
+    // commands
+    AssignRole,
+    CreateMessage,
+    Ack,
+    CreateRole,
+    CreateRoom,
+    CreateSpace,
+    CreateTopic,
+    DeassignRole,
+    DeleteRole,
+    DeleteRoom,
+    DeleteSpace,
+    DeleteTopic,
+    SetPermissionOverwrites,
+    GetPermissionOverwrites,
+    GetComputedPermissions,
+    GetRoomMembers,
+    GetSession,
+    GetSpaceMembers,
+    GetSpaceRooms,
+    GetAckReports,
+    JoinRoom,
+    JoinSpace,
+    LeaveRoom,
+    LeaveSpace,
+    UpdateRole,
+    UpdateSpace,
+    UpdateRoom,
+    GetPermissionOverwriteTargets,
+    CreateOwner,
+    DeleteOwner,
+    GetOwners,
+};

package/src/types/src/schemes/AckReport.ts

@@ -0,0 +1,7 @@
+export interface AckReport {
+    roomId: string;
+    topicId: string;
+    lastAckMessageId: string | null;
+    missed: number | null;
+    missedMoreThan: number | null;
+}

package/src/types/src/schemes/ChatLocation.ts

@@ -0,0 +1,5 @@
+export interface ChatLocation {
+    spaceId?: string;
+    roomId?: string;
+    topicId?: string;
+}

package/src/types/src/schemes/Envelope.ts

@@ -0,0 +1,5 @@
+export interface Envelope<T = any> {
+    type: string;
+    ref?: string;
+    data: T;
+}

package/src/types/src/schemes/Message.ts

@@ -0,0 +1,8 @@
+import {User} from "./User";
+
+export interface Message {
+    id: string;
+    author: User;
+    content: string;
+    topicRef: string | null;
+}

package/src/types/src/schemes/PermissionOverwritesValue.ts

@@ -0,0 +1,4 @@
+export interface PermissionOverwritesValue {
+    allow: number | null;
+    deny: number | null;
+}

package/src/types/src/schemes/Role.ts

@@ -0,0 +1,6 @@
+export interface Role {
+    id: string;
+    priority: number;
+    name: string;
+    color?: string;
+}

package/src/types/src/schemes/Room.ts

@@ -0,0 +1,12 @@
+import {Topic} from "./Topic";
+
+export type RoomType = 'Text';
+
+export interface Room {
+    id: string;
+    spaceId: string | null;
+    name: string;
+    description: string;
+    type: RoomType;
+    defaultTopic: Topic | null;
+}

package/src/types/src/schemes/RoomMember.ts

@@ -0,0 +1,8 @@
+import {User} from "./User";
+import {SpaceMember} from "./SpaceMember";
+
+export interface RoomMember {
+    user: User | null;
+    spaceMember: SpaceMember | null;
+    roles: string[] | null;
+}

package/src/types/src/schemes/RoomSummary.ts

@@ -0,0 +1,5 @@
+export interface RoomSummary {
+    id: string;
+    name: string;
+    description: string;
+}

package/src/types/src/schemes/Space.ts

@@ -0,0 +1,7 @@
+import {Role} from "./Role";
+
+export interface Space {
+    id: string;
+    name: string;
+    roles: Role[];
+}

package/src/types/src/schemes/SpaceMember.ts

@@ -0,0 +1,6 @@
+import {User} from "./User";
+
+export interface SpaceMember {
+    user: User | null;
+    roles: string[];
+}

package/src/types/src/schemes/Topic.ts

@@ -0,0 +1,5 @@
+export interface Topic {
+    id: string;
+    name: string;
+    description: string;
+}

package/src/types/src/schemes/User.ts

@@ -0,0 +1,9 @@
+export type UserFlag = 'bot' | 'temp';
+
+export interface User {
+    id: string;
+    nick: string;
+    avatar: string;
+    flags: UserFlag[];
+    online: boolean;
+}

package/src/types/src/schemes/UserState.ts

@@ -0,0 +1,7 @@
+import {Space} from "./Space";
+import {Room} from "./Room";
+
+export interface UserState {
+    spaces: Space[];
+    rooms: Room[];
+}

package/src/types/src/schemes/commands/Ack.ts

@@ -0,0 +1,6 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface Ack {
+    location: ChatLocation;
+    messageId?: string;
+}

package/src/types/src/schemes/commands/AssignRole.ts

@@ -0,0 +1,7 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface AssignRole {
+    roleId: string;
+    userId: string;
+    location: ChatLocation;
+}

package/src/types/src/schemes/commands/CreateMessage.ts

@@ -0,0 +1,6 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface CreateMessage {
+    location: ChatLocation;
+    content: string;
+}

package/src/types/src/schemes/commands/CreateOwner.ts

@@ -0,0 +1,6 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface CreateOwner {
+    location: ChatLocation;
+    userId: string;
+}

package/src/types/src/schemes/commands/CreateRole.ts

@@ -0,0 +1,5 @@
+export interface CreateRole {
+    spaceId: string;
+    name: string;
+    color: string;
+}

package/src/types/src/schemes/commands/CreateRoom.ts

@@ -0,0 +1,8 @@
+import {RoomType} from "../Room";
+
+export interface CreateRoom {
+    spaceId: string;
+    name: string;
+    description: string;
+    type: RoomType;
+}

package/src/types/src/schemes/commands/CreateSpace.ts

@@ -0,0 +1,3 @@
+export interface CreateSpace {
+    name: string;
+}

package/src/types/src/schemes/commands/CreateTopic.ts

@@ -0,0 +1,14 @@
+import {ChatLocation} from "../ChatLocation";
+import {CreateMessage} from "./CreateMessage";
+
+export interface MessageReference {
+    topicId: string;
+    messageId: string;
+}
+
+export interface CreateTopic {
+    location: ChatLocation;
+    name: string;
+    messageRef: MessageReference | null;
+    initialMessage: Omit<CreateMessage, 'location'> | null;
+}

package/src/types/src/schemes/commands/DeassignRole.ts

@@ -0,0 +1,7 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface DeassignRole {
+    roleId: string;
+    userId: string;
+    location: ChatLocation;
+}

package/src/types/src/schemes/commands/DeleteOwner.ts

@@ -0,0 +1,6 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface DeleteOwner {
+    location: ChatLocation;
+    userId: string;
+}

package/src/types/src/schemes/commands/DeleteRole.ts

@@ -0,0 +1,4 @@
+export interface DeleteRole {
+    roleId: string;
+    spaceId: string;
+}

package/src/types/src/schemes/commands/DeleteRoom.ts

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

package/src/types/src/schemes/commands/DeleteSpace.ts

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

package/src/types/src/schemes/commands/DeleteTopic.ts

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

package/src/types/src/schemes/commands/GetAckReports.ts

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

package/src/types/src/schemes/commands/GetComputedPermissions.ts

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

package/src/types/src/schemes/commands/GetOwners.ts

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

package/src/types/src/schemes/commands/GetPermissionOverwriteTargets.ts

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

package/src/types/src/schemes/commands/GetPermissionOverwrites.ts

@@ -0,0 +1,7 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface GetPermissionOverwrites {
+    location: ChatLocation;
+    target: 'User' | 'Role';
+    targetId: string;
+}

package/src/types/src/schemes/commands/GetRoomMembers.ts

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

package/src/types/src/schemes/commands/GetSession.ts

@@ -0,0 +1,2 @@
+export interface GetSession {
+}

package/src/types/src/schemes/commands/GetSpaceMembers.ts

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

package/src/types/src/schemes/commands/GetSpaceRooms.ts

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

package/src/types/src/schemes/commands/JoinRoom.ts

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

package/src/types/src/schemes/commands/JoinSpace.ts

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

package/src/types/src/schemes/commands/LeaveRoom.ts

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

package/src/types/src/schemes/commands/LeaveSpace.ts

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

package/src/types/src/schemes/commands/SetPermissionOverwrites.ts

@@ -0,0 +1,9 @@
+import {PermissionOverwritesValue} from "../PermissionOverwritesValue";
+import {ChatLocation} from "../ChatLocation";
+
+export interface SetPermissionOverwrites {
+    location: ChatLocation;
+    target: 'User' | 'Role';
+    targetId: string;
+    overwrites: PermissionOverwritesValue;
+}

package/src/types/src/schemes/commands/UpdateRole.ts

@@ -0,0 +1,7 @@
+export interface UpdateRole {
+    spaceId: string;
+    id: string;
+    priority?: number;
+    name?: string;
+    color?: string;
+}

package/src/types/src/schemes/commands/UpdateRoom.ts

@@ -0,0 +1,5 @@
+export interface UpdateRoom {
+    id: string;
+    name?: string;
+    description?: string;
+}

package/src/types/src/schemes/commands/UpdateSpace.ts

@@ -0,0 +1,4 @@
+export interface UpdateSpace {
+    id: string;
+    name: string;
+}

package/src/types/src/schemes/events/AckReports.ts

@@ -0,0 +1,5 @@
+import {AckReport} from "../AckReport";
+
+export interface AckReports {
+    reports: AckReport[];
+}

package/src/types/src/schemes/events/Bye.ts

@@ -0,0 +1,3 @@
+export interface Bye {
+    reason: string;
+}

package/src/types/src/schemes/events/ComputedPermissions.ts

@@ -0,0 +1,6 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface ComputedPermissions {
+    permissions: number;
+    location: ChatLocation;
+}

package/src/types/src/schemes/events/Error.ts

@@ -0,0 +1,4 @@
+export interface Error {
+    code: string;
+    message: string;
+}

package/src/types/src/schemes/events/NewMessage.ts

@@ -0,0 +1,7 @@
+import {Message} from "../Message";
+import {ChatLocation} from "../ChatLocation";
+
+export interface NewMessage {
+    location: ChatLocation;
+    message: Message;
+}

package/src/types/src/schemes/events/NewRole.ts

@@ -0,0 +1,6 @@
+import {Role} from "../Role";
+
+export interface NewRole {
+    spaceId: string;
+    role: Role;
+}

package/src/types/src/schemes/events/NewRoom.ts

@@ -0,0 +1,6 @@
+import {RoomSummary} from "../RoomSummary";
+
+export interface NewRoom {
+    summary: RoomSummary;
+    spaceId: string;
+}

package/src/types/src/schemes/events/NewTopic.ts

@@ -0,0 +1,6 @@
+import {Topic} from "../Topic";
+
+export interface NewTopic {
+    roomId: string;
+    topic: Topic;
+}

package/src/types/src/schemes/events/Ok.ts

@@ -0,0 +1,3 @@
+export interface Ok {
+
+}

package/src/types/src/schemes/events/Owners.ts

@@ -0,0 +1,9 @@
+import {ChatLocation} from "../ChatLocation";
+import {RoomMember} from "../RoomMember";
+import {SpaceMember} from "../SpaceMember";
+
+export interface Owners {
+    location: ChatLocation;
+    spaceMembers: SpaceMember[] | null;
+    roomMembers: RoomMember[] | null;
+}

package/src/types/src/schemes/events/PermissionOverwriteTargets.ts

@@ -0,0 +1,11 @@
+import {ChatLocation} from "../ChatLocation";
+import {SpaceMember} from "../SpaceMember";
+import {RoomMember} from "../RoomMember";
+import {Role} from "../Role";
+
+export interface PermissionOverwriteTargets {
+    location: ChatLocation;
+    spaceMembers: SpaceMember[] | null;
+    roomMembers: RoomMember[] | null;
+    roles: Role[] | null;
+}

package/src/types/src/schemes/events/PermissionOverwrites.ts

@@ -0,0 +1,9 @@
+import {PermissionOverwritesValue} from "../PermissionOverwritesValue";
+import {ChatLocation} from "../ChatLocation";
+
+export interface PermissionOverwrites {
+    location: ChatLocation;
+    target: 'User' | 'Role';
+    targetId: string;
+    overwrites: PermissionOverwritesValue;
+}

package/src/types/src/schemes/events/PermissionOverwritesUpdated.ts

@@ -0,0 +1,9 @@
+import {PermissionOverwritesValue} from "../PermissionOverwritesValue";
+import {ChatLocation} from "../ChatLocation";
+
+export interface PermissionOverwritesUpdated {
+    location: ChatLocation;
+    target: 'User' | 'Role';
+    targetId: string;
+    overwrites: PermissionOverwritesValue;
+}

package/src/types/src/schemes/events/RoleDeleted.ts

@@ -0,0 +1,4 @@
+export interface RoleDeleted {
+    id: string;
+    spaceId: string;
+}

package/src/types/src/schemes/events/RoleUpdated.ts

@@ -0,0 +1,6 @@
+import {Role} from "../Role";
+
+export interface RoleUpdated {
+    spaceId: string;
+    role: Role;
+}

package/src/types/src/schemes/events/RoomDeleted.ts

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

package/src/types/src/schemes/events/RoomJoined.ts

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