@pluv/io 5.0.1 → 5.0.2

package/eslint.config.mjs

@@ -1,4 +0,0 @@
-import { config } from "eslint-config-pluv/base";
-
-/** @type {import("eslint").Linter.Config} */
-export default config;

package/src/AbstractPersistence.ts

@@ -1,29 +0,0 @@
-import type { JsonObject } from "@pluv/types";
-
-export abstract class AbstractPersistence {
-    public abstract addUser(
-        room: string,
-        connectionId: string,
-        user: JsonObject | null,
-    ): Promise<void>;
-
-    public abstract deleteStorageState(room: string): Promise<void>;
-
-    public abstract deleteUser(room: string, connectionId: string): Promise<void>;
-
-    public abstract deleteUsers(room: string): Promise<void>;
-
-    public abstract getStorageState(room: string): Promise<string | null>;
-
-    public abstract getUser(room: string, connectionId: string): Promise<JsonObject | null>;
-
-    public abstract getUsers(
-        room: string,
-    ): Promise<Map<[connectionId: string][0], JsonObject | null>>;
-
-    public abstract getUsersSize(room: string): Promise<number>;
-
-    public abstract initialize(roomContext: any): typeof this;
-
-    public abstract setStorageState(room: string, state: string): Promise<void>;
-}

package/src/AbstractPlatform.ts

@@ -1,105 +0,0 @@
-import type { Maybe } from "@pluv/types";
-import type { AbstractPersistence } from "./AbstractPersistence";
-import type { AbstractPubSub } from "./AbstractPubSub";
-import type { AbstractWebSocket, InferWebSocketSource } from "./AbstractWebSocket";
-import type { JWTEncodeParams } from "./authorize";
-import { Persistence } from "./Persistence";
-import { PubSub } from "./PubSub";
-import type { PlatformConfig, ResolvedPluvIOAuthorize, WebSocketSerializedState } from "./types";
-
-export type InferPlatformWebSocketType<TPlatform extends AbstractPlatform> =
-    TPlatform extends AbstractPlatform<infer IAbstractWebSocket> ? IAbstractWebSocket : never;
-
-export type InferPlatformWebSocketSource<TPlatform> =
-    TPlatform extends AbstractPlatform<infer IAbstractWebSocket>
-        ? InferWebSocketSource<IAbstractWebSocket>
-        : never;
-
-export type InferInitContextType<TPlatform extends AbstractPlatform> =
-    TPlatform extends AbstractPlatform<any, infer IInitContext> ? IInitContext : never;
-
-export type InferRoomContextType<TPlatform extends AbstractPlatform> =
-    TPlatform extends AbstractPlatform<any, any, infer IRoomContext> ? IRoomContext : never;
-
-export type AbstractPlatformConfig<TRoomContext extends Record<string, any> = {}> = {
-    persistence?: AbstractPersistence;
-    pubSub?: AbstractPubSub;
-    roomContext?: TRoomContext;
-};
-
-export interface ConvertWebSocketConfig {
-    room: string;
-}
-
-export abstract class AbstractPlatform<
-    TWebSocket extends AbstractWebSocket<any, any> = AbstractWebSocket<any, any>,
-    TInitContext extends Record<string, any> = {},
-    TRoomContext extends Record<string, any> = {},
-    TConfig extends PlatformConfig = PlatformConfig,
-> {
-    protected readonly _initContext: TInitContext | undefined;
-    protected readonly _roomContext: TRoomContext | undefined;
-
-    private _initialized: boolean = false;
-
-    public persistence: AbstractPersistence;
-    public pubSub: AbstractPubSub;
-
-    public abstract readonly id: string;
-    public readonly _createToken?: (
-        params: JWTEncodeParams<any, any> & {
-            authorize: Maybe<ResolvedPluvIOAuthorize<any, any>>;
-        },
-    ) => Promise<string>;
-    public _fetch?: (...args: any[]) => Promise<any>;
-    public abstract readonly _config: TConfig;
-    public abstract readonly _name: string;
-
-    constructor(config: AbstractPlatformConfig<TRoomContext> = {}) {
-        const { roomContext, persistence, pubSub } = config;
-
-        (this as any)._meta = (config as any)._meta;
-        if (!!roomContext) this._roomContext = roomContext;
-
-        this.persistence = persistence ?? new Persistence();
-        this.pubSub = pubSub ?? new PubSub();
-    }
-
-    public abstract acceptWebSocket(webSocket: AbstractWebSocket): Promise<void>;
-
-    public abstract convertWebSocket(
-        webSocket: InferWebSocketSource<TWebSocket>,
-        config: ConvertWebSocketConfig,
-    ): AbstractWebSocket<any, any>;
-
-    public abstract getLastPing(webSocket: AbstractWebSocket<any, any>): number | null;
-
-    public abstract getSerializedState(
-        webSocket: InferWebSocketSource<TWebSocket>,
-    ): WebSocketSerializedState | null;
-
-    public abstract getSessionId(webSocket: InferWebSocketSource<TWebSocket>): string | null;
-
-    public abstract getWebSockets(): readonly InferWebSocketSource<TWebSocket>[];
-
-    public abstract initialize(config: AbstractPlatformConfig<TRoomContext>): this;
-
-    public abstract parseData(data: string | ArrayBuffer): Record<string, any>;
-
-    public abstract randomUUID(): string;
-
-    public abstract setSerializedState(
-        webSocket: AbstractWebSocket,
-        state: WebSocketSerializedState,
-    ): WebSocketSerializedState;
-
-    public validateConfig(config: any): void {}
-
-    protected _initialize(): typeof this {
-        if (this._initialized) throw new Error("Platform is already initialized");
-
-        this._initialized = true;
-
-        return this;
-    }
-}

package/src/AbstractPubSub.ts

@@ -1,20 +0,0 @@
-import type { IOEventMessage, IOLike, InferIOOutput } from "@pluv/types";
-import type { SendMessageOptions } from "./types";
-
-export type IOPubSubEventMessage<
-    TIO extends IOLike,
-    TEvent extends keyof InferIOOutput<TIO> = keyof InferIOOutput<TIO>,
-> = IOEventMessage<TIO, TEvent> & {
-    options?: SendMessageOptions;
-};
-
-export abstract class AbstractPubSub {
-    public abstract publish(roomName: string, payload: IOPubSubEventMessage<any>): Promise<void>;
-
-    public abstract subscribe(
-        roomName: string,
-        onMessage: (message: IOPubSubEventMessage<any>) => void,
-    ): Promise<number>;
-
-    public abstract unsubscribe(subscriptionId: number): void;
-}

package/src/AbstractWebSocket.ts

@@ -1,134 +0,0 @@
-import type {
-    BaseUser,
-    InferIOAuthorizeUser,
-    IOAuthorize,
-    IOEventMessage,
-    JsonObject,
-    MaybePromise,
-} from "@pluv/types";
-import type { AbstractPersistence } from "./AbstractPersistence";
-import type { AbstractPlatform } from "./AbstractPlatform";
-import type { WebSocketSerializedState, WebSocketSession } from "./types";
-
-export type AbstractEvent = {};
-
-export type AbstractCloseEvent = AbstractEvent & {
-    readonly code: number;
-    readonly reason: string;
-};
-
-export type AbstractMessageEvent<T = any> = AbstractEvent & {
-    readonly data: T;
-};
-
-export type AbstractErrorEvent = AbstractEvent & {
-    error: unknown;
-    message?: string;
-};
-
-export interface AbstractEventMap {
-    close: AbstractCloseEvent;
-    message: AbstractMessageEvent;
-    error: AbstractErrorEvent;
-}
-
-export type EventType = keyof AbstractEventMap;
-
-export interface AbstractWebSocketHandleErrorParams {
-    error: unknown;
-    message?: string;
-    room: string;
-    session?: WebSocketSession<any>;
-}
-
-export type AbstractListener<TType extends keyof AbstractEventMap> = (
-    event: AbstractEventMap[TType],
-) => MaybePromise<void>;
-
-export type InferWebSocketSource<TAbstractWebSocket extends AbstractWebSocket> =
-    TAbstractWebSocket extends AbstractWebSocket<infer IWebSocket> ? IWebSocket : never;
-
-export interface AbstractWebSocketConfig {
-    persistence: AbstractPersistence;
-    platform: AbstractPlatform<any>;
-    room: string;
-}
-
-export abstract class AbstractWebSocket<
-    TWebSocket = any,
-    TAuthorize extends IOAuthorize<any, any> | null = null,
-> {
-    /** The connection is not yet open. */
-    public readonly CONNECTING = 0;
-    /** The connection is open and ready to communicate. */
-    public readonly OPEN = 1;
-    /** The connection is in the process of closing. */
-    public readonly CLOSING = 2;
-    /** The connection is closed. */
-    public readonly CLOSED = 3;
-
-    public readonly persistence: AbstractPersistence;
-    public readonly room: string;
-    public readonly webSocket: TWebSocket;
-
-    protected readonly _platform: AbstractPlatform<this>;
-
-    public abstract set presence(presence: JsonObject | null);
-    public abstract get readyState(): 0 | 1 | 2 | 3;
-    public abstract get session(): WebSocketSession<TAuthorize>;
-    public abstract get sessionId(): string;
-    public abstract get state(): WebSocketSerializedState;
-    public abstract set state(state: WebSocketSerializedState);
-    public abstract set user(user: InferIOAuthorizeUser<TAuthorize>);
-
-    constructor(webSocket: TWebSocket, config: AbstractWebSocketConfig) {
-        const { persistence, platform, room } = config;
-
-        this.persistence = persistence;
-        this._platform = platform;
-        this.room = room;
-        this.webSocket = webSocket;
-    }
-
-    /**
-     * TODO
-     * @description Return an unsubscribe method to remove the event-listener.
-     * This is preferred over adding an explicit abstract removeEventListener
-     * method, because the implementing class might have to transform the
-     * listener, and removing the same listener might be complicated as a
-     * result.
-     * @date August 28, 2022
-     */
-    public abstract addEventListener<TType extends EventType>(
-        type: TType,
-        handler: AbstractListener<TType>,
-    ): void;
-
-    public abstract close(code?: number | undefined, reason?: string | undefined): void;
-
-    public abstract send(message: ArrayBuffer | ArrayBufferView | string): void;
-
-    public abstract terminate(): void;
-
-    public handleError(params: AbstractWebSocketHandleErrorParams): void {
-        const { error, message: _message, room, session } = params;
-
-        const message = error instanceof Error ? error.message : "Unexpected error";
-        const stack: string | null = error instanceof Error ? (error.stack ?? null) : null;
-        const connectionId = (session?.id ?? null) as string;
-
-        return this.sendMessage({
-            connectionId,
-            data: { message, stack },
-            room,
-            type: "$error" as const,
-            user: session?.user ?? null,
-        });
-    }
-
-    public sendMessage<TMessage extends IOEventMessage<any> = IOEventMessage<any>>(
-        data: TMessage,
-    ): void {
-        return this.send(JSON.stringify(data));
-    }
-}