@websimai/socket-types 0.0.1 → 0.0.2

package/README.md

@@ -1,3 +1,3 @@
 # @websimai/socket-types
 
-WebsimSocket type declarations
+Type declarations for the `WebsimSocket` class

package/package.json

@@ -1,20 +1,17 @@
 {
   "name": "@websimai/socket-types",
-  "version": "0.0.1",
-  "description": "WebsimSocket type declarations",
+  "version": "0.0.2",
+  "description": "Type declarations for the `WebsimSocket` class",
   "author": "GameRoMan",
   "license": "MIT",
   "types": "./src/index.d.ts",
   "exports": {
     ".": {
       "types": "./src/index.d.ts"
-    },
-    "./socket": {
-      "types": "./src/socket.d.ts"
     }
   },
   "scripts": {
-    "publish": "bun publish --access public"
+    "npm:publish": "bun publish --access public"
   },
   "keywords": [
     "websim",

package/src/globals.d.ts

@@ -0,0 +1,13 @@
+import { WebsimSocket as WebsimSocketClass } from "./websim-socket";
+
+type WebsimSocketConstructor = typeof WebsimSocketClass;
+
+declare global {
+  interface Window {
+    readonly WebsimSocket: WebsimSocketConstructor;
+  }
+
+  const WebsimSocket: WebsimSocketConstructor;
+
+  type WebsimSocket = WebsimSocketClass;
+}

package/src/index.d.ts

@@ -1,15 +1,4 @@
-import type { WebsimSocket as WebsimSocketClass } from "./socket";
+export type { WebsimSocket } from "./websim-socket";
+export type * from "./types";
 
-type WebsimSocketConstructor = typeof WebsimSocketClass;
-
-declare global {
-  interface Window {
-    readonly WebsimSocket: WebsimSocketConstructor;
-  }
-
-  const WebsimSocket: WebsimSocketConstructor;
-}
-
-type WebsimSocket = InstanceType<WebsimSocketConstructor>;
-
-export { WebsimSocket };
+export type * from "./globals";

package/src/types/collection-api.d.ts

@@ -0,0 +1,70 @@
+import type { KeyValue, Expand } from "./utils";
+
+export interface CollectionAPI<T extends string> {
+  getList: <TData extends KeyValue>() => Expand<
+    TData & {
+      readonly id: string;
+      readonly $type: T;
+      readonly created_at: string;
+      readonly updated_at: string;
+      readonly user_id: string;
+      readonly username: string;
+    }
+  >[];
+  create: <TData extends KeyValue>(
+    data: TData
+  ) => Promise<
+    Expand<
+      TData & {
+        readonly id: string;
+        readonly $type: T;
+        readonly created_at: string;
+        readonly username: string;
+      }
+    >
+  >;
+  update: <T_Id extends string, TData extends KeyValue>(
+    id: T_Id,
+    data: TData
+  ) => Promise<
+    Expand<
+      TData & {
+        readonly id: T_Id;
+        readonly $type: T;
+        readonly created_at: string;
+        readonly username: string;
+      }
+    >
+  >;
+  upsert: <
+    TData extends KeyValue & { id?: T_Id },
+    T_Id extends string = string
+  >(
+    data: TData
+  ) => Promise<
+    Expand<
+      (TData extends { id: T_Id } ? TData & KeyValue : TData) & {
+        readonly id: T_Id;
+        readonly $type: T;
+        readonly created_at: string;
+        readonly username: string;
+      }
+    >
+  >;
+  delete: (id: string) => Promise<void>;
+  subscribe: (
+    callback: (
+      records: Expand<
+        KeyValue & {
+          id: string;
+          $type: T;
+          created_at: string;
+          updated_at: string;
+          user_id: string;
+          username: string;
+        }
+      >[]
+    ) => void
+  ) => () => void;
+  filter: (filters: KeyValue) => CollectionAPI<T>;
+}

package/src/types/index.d.ts

@@ -0,0 +1,2 @@
+export type * from "./collection-api";
+export type * from "./query-api";

package/src/types/query-api.d.ts

@@ -0,0 +1,7 @@
+import type { KeyValue } from "./utils";
+
+export interface QueryAPI<T extends readonly KeyValue[] = readonly KeyValue[]>
+  extends PromiseLike<T> {
+  getList(): Promise<T>;
+  subscribe(callback: (records: T) => void): () => void;
+}

package/src/types/utils/index.d.ts

@@ -0,0 +1,3 @@
+export type Expand<T> = T extends infer O ? { [K in keyof O]: O[K] } : never;
+
+export type KeyValue = Record<string, any>;

package/src/websim-socket-party.d.ts

@@ -0,0 +1,61 @@
+import type { KeyValue } from "./types/utils";
+
+export interface WebsimSocketParty {
+  /**
+   * Object containing the client ID, avatar URL, and username of this connected client.
+   */
+  readonly client: {
+    readonly id: string;
+    readonly avatarUrl: `https://${string}/${string}`;
+    readonly username: string;
+  };
+
+  /**
+   * Object containing all connected peers, including this client.
+   * This is always up-to-date.
+   */
+  readonly peers: {
+    [id: string]: {
+      readonly avatarUrl: `https://${string}/${string}`;
+      readonly username: string;
+      readonly id: string;
+      readonly is_anonymous: boolean;
+    };
+  };
+
+  subscribe: (
+    callback: (peers: {
+      [clientId: string]: {
+        avatarUrl: string;
+        username: string;
+      };
+    }) => void
+  ) => () => void;
+
+  /**
+   * Object containing the current presence state of all connected peers, including this client.
+   * This is always up-to-date after initialization.
+   */
+  readonly presence: KeyValue;
+
+  /**
+   * Updates the current client's presence state.
+   * @param presence The new presence state to set.
+   */
+  updatePresence<TPresence extends KeyValue>(presence: TPresence): void;
+
+  /**
+   * Subscribe to presence updates from all peers.
+   * @param callback Function to call when presence changes.
+   * @returns Function to unsubscribe.
+   */
+  subscribePresence<TPresence extends KeyValue>(
+    callback: (presence: { [clientId: string]: TPresence }) => void
+  ): () => void;
+
+  /**
+   * Object containing the current room-wide state.
+   * This is always up-to-date.
+   */
+  readonly roomState: KeyValue;
+}

package/src/websim-socket.d.ts

@@ -0,0 +1,134 @@
+import type { KeyValue } from "./types/utils";
+
+import type { WebsimSocketParty } from "./websim-socket-party";
+
+import type { CollectionAPI, QueryAPI } from "./types";
+
+export class WebsimSocket {
+  constructor();
+
+  readonly CONNECTING: 0;
+  readonly OPEN: 1;
+  readonly CLOSING: 2;
+  readonly CLOSED: 3;
+
+  readonly binaryType: "arraybuffer" | (string & {});
+  readonly bufferedAmount: number;
+  readonly extensions: string;
+  readonly protocol: "ws" | "wss";
+  readonly readyState: 0 | 1 | 2 | 3;
+  readonly url: string;
+
+  accept(): void;
+  serializeAttachment(): void;
+  deserializeAttachment(): void;
+
+  onclose: ((this: WebSocket, ev: CloseEvent) => any) | null;
+  onerror: ((this: WebSocket, ev: Event) => any) | null;
+  onmessage: ((this: WebSocket, ev: MessageEvent) => any) | null;
+  onopen: ((this: WebSocket, ev: Event) => any) | null;
+
+  dispatchEvent(event: Event | MessageEvent | CloseEvent | ErrorEvent): boolean;
+
+  close(_code?: number, _reason?: string): void;
+  send<TData extends string | object>(data: TData): void;
+
+  query(queryString: string, params?: any[]): QueryAPI;
+
+  collection<T extends string>($type: T): CollectionAPI<T>;
+
+  readonly clientId: string;
+
+  /**
+   * Object containing information about the connected client and their peers.
+   */
+  readonly party: WebsimSocketParty;
+
+  /**
+   * Legacy event handler for changes in connected peers.
+   * @param peers An object with client IDs as keys, each containing the client's avatar URL and username.
+   */
+  onPeersChanged:
+    | ((peers: {
+        [clientId: string]: {
+          avatarUrl: string;
+          username: string;
+        };
+      }) => any)
+    | null;
+
+  /**
+   * Initialize the WebSocket connection.
+   * @returns A promise that resolves when initialization is complete.
+   */
+  initialize(): Promise<void>;
+
+  /**
+   * Request a presence update from a specific client.
+   * @param clientId The ID of the client to request an update from.
+   * @param update The update to request.
+   */
+  requestPresenceUpdate(clientId: string, update: KeyValue): void;
+
+  /**
+   * Subscribe to presence update requests from other clients.
+   * @param callback Function to call when a presence update is requested.
+   * @returns Function to unsubscribe.
+   */
+  subscribePresenceUpdateRequests<TUpdateRequest extends KeyValue>(
+    callback: (updateRequest: TUpdateRequest, fromClientId: string) => void
+  ): () => void;
+
+  /**
+   * Updates the room-wide state. This merges with existing state.
+   * @param delta The new state to merge with current room state.
+   */
+  updateRoomState<TDelta extends KeyValue>(delta: TDelta): void;
+
+  /**
+   * Subscribe to room state updates.
+   * @param callback Function to call when room state changes.
+   * @returns Function to unsubscribe.
+   */
+  subscribeRoomState<TRoomState extends KeyValue>(
+    callback: (state: TRoomState) => void
+  ): () => void;
+
+  /**
+   * Object containing the current presence state of all connected peers, including this client.
+   * This is always up-to-date after initialization.
+   */
+  readonly presence: { [clientId: string]: KeyValue };
+
+  /**
+   * Object containing the current room-wide state.
+   * This is always up-to-date.
+   */
+  readonly roomState: KeyValue;
+
+  /**
+   * Object containing all connected peers, including this client.
+   * This is always up-to-date.
+   */
+  readonly peers: {
+    [clientId: string]: {
+      avatarUrl: string;
+      username: string;
+    };
+  };
+
+  /**
+   * Updates the current client's presence state.
+   * @param presence The new presence state to set.
+   */
+  updatePresence<TPresence extends KeyValue>(presence: TPresence): void;
+
+  /**
+   * Subscribe to presence updates from all peers.
+   * @param callback Function to call when presence changes.
+   * @returns Function to unsubscribe.
+   */
+  subscribePresence<TPresence extends KeyValue>(
+    callback: (presence: { [clientId: string]: TPresence }) => void
+  ): () => void;
+}

package/tsconfig.json

@@ -11,9 +11,12 @@
     "allowImportingTsExtensions": true,
     "noEmit": true,
 
+    // This is a type declarations package
+    "skipLibCheck": false,
+    "skipDefaultLibCheck": true,
+
     // Max strictness
     "strict": true,
-    "skipLibCheck": true,
     "noFallthroughCasesInSwitch": true,
     "noUncheckedIndexedAccess": true,
     "noImplicitOverride": true,

package/src/socket.d.ts

@@ -1,271 +0,0 @@
-type Expand<T> = T extends infer O ? { [K in keyof O]: O[K] } : never;
-
-type KeyValue = Record<string, any>;
-
-interface WebsimSocketParty {
-  /**
-   * Object containing the client ID, avatar URL, and username of this connected client.
-   */
-  client: {
-    id: string;
-    avatarUrl: `https://${string}`;
-    username: string;
-  };
-
-  /**
-   * Object containing all connected peers, including this client.
-   * This is always up-to-date.
-   */
-  peers: {
-    [id: string]: {
-      avatarUrl: `https://${string}`;
-      username: string;
-      id: string;
-      is_anonymous: boolean;
-    };
-  };
-
-  subscribe: (
-    callback: (peers: {
-      [clientId: string]: { avatarUrl: string; username: string };
-    }) => void
-  ) => () => void;
-
-  /**
-   * Object containing the current presence state of all connected peers, including this client.
-   * This is always up-to-date after initialization.
-   */
-  presence: KeyValue;
-
-  /**
-   * Updates the current client's presence state.
-   * @param presence The new presence state to set.
-   */
-  updatePresence<TPresence extends KeyValue>(presence: TPresence): void;
-
-  /**
-   * Subscribe to presence updates from all peers.
-   * @param callback Function to call when presence changes.
-   * @returns Function to unsubscribe.
-   */
-  subscribePresence<TPresence extends KeyValue>(
-    callback: (presence: { [clientId: string]: TPresence }) => void
-  ): () => void;
-
-  /**
-   * Object containing the current room-wide state.
-   * This is always up-to-date.
-   */
-  roomState: KeyValue;
-}
-
-interface CollectionAPI<T extends string> {
-  getList: <TData extends KeyValue>() => Promise<
-    Expand<
-      TData & {
-        id: string;
-        $type: T;
-        created_at: string;
-        updated_at: string;
-        user_id: string;
-        username: string;
-      }
-    >[]
-  >;
-  create: <TData extends KeyValue>(
-    data: TData
-  ) => Promise<
-    Expand<
-      TData & {
-        id: string;
-        $type: T;
-        created_at: string;
-        username: string;
-      }
-    >
-  >;
-  update: <T_Id extends string, TData extends KeyValue>(
-    id: T_Id,
-    data: TData
-  ) => Promise<
-    Expand<
-      TData & {
-        id: T_Id;
-        $type: T;
-        created_at: string;
-        username: string;
-      }
-    >
-  >;
-  upsert: <
-    TData extends KeyValue & { id?: T_Id },
-    T_Id extends string = string
-  >(
-    data: TData
-  ) => Promise<
-    Expand<
-      TData extends { id: T_Id }
-        ? TData &
-            KeyValue & {
-              id: T_Id;
-              $type: T;
-              created_at: string;
-              username: string;
-            }
-        : TData & {
-            id: T_Id;
-            $type: T;
-            created_at: string;
-            username: string;
-          }
-    >
-  >;
-  delete: (id: string) => Promise<void>;
-  subscribe: (
-    callback: (
-      records: Expand<
-        KeyValue & {
-          id: string;
-          $type: T;
-          created_at: string;
-          updated_at: string;
-          user_id: string;
-          username: string;
-        }
-      >[]
-    ) => void
-  ) => () => void;
-  filter: (filters: KeyValue) => CollectionAPI<T>;
-}
-
-interface QueryAPI<T extends readonly KeyValue[] = KeyValue[]>
-  extends PromiseLike<T> {
-  getList: () => Promise<T>;
-  subscribe: (callback: (records: T) => void) => () => void;
-}
-
-export class WebsimSocket {
-  constructor();
-
-  readonly CONNECTING: 0;
-  readonly OPEN: 1;
-  readonly CLOSING: 2;
-  readonly CLOSED: 3;
-
-  readonly binaryType: "arraybuffer" | (string & {});
-  readonly bufferedAmount: number;
-  readonly extensions: string;
-  readonly protocol: "ws" | "wss";
-  readonly readyState: 0 | 1 | 2 | 3;
-  readonly url: string;
-
-  accept(): void;
-  serializeAttachment(): void;
-  deserializeAttachment(): void;
-
-  onclose: ((this: WebSocket, ev: CloseEvent) => any) | null;
-  onerror: ((this: WebSocket, ev: Event) => any) | null;
-  onmessage: ((this: WebSocket, ev: MessageEvent) => any) | null;
-  onopen: ((this: WebSocket, ev: Event) => any) | null;
-
-  dispatchEvent(event: Event | MessageEvent | CloseEvent | ErrorEvent): boolean;
-
-  close(_code?: number, _reason?: string): void;
-  send<TData extends string | object>(data: TData): void;
-
-  query(queryString: string, params?: any[]): QueryAPI;
-
-  collection<T extends string>($type: T): CollectionAPI<T>;
-
-  clientId: string;
-
-  /**
-   * Object containing information about the connected client and their peers.
-   */
-  party: WebsimSocketParty;
-
-  /**
-   * Legacy event handler for changes in connected peers.
-   * @param peers An object with client IDs as keys, each containing the client's avatar URL and username.
-   */
-  onPeersChanged:
-    | ((peers: {
-        [clientId: string]: { avatarUrl: string; username: string };
-      }) => any)
-    | null;
-
-  /**
-   * Initialize the WebSocket connection.
-   * @returns A promise that resolves when initialization is complete.
-   */
-  initialize(): Promise<void>;
-
-  /**
-   * Request a presence update from a specific client.
-   * @param clientId The ID of the client to request an update from.
-   * @param update The update to request.
-   */
-  requestPresenceUpdate(clientId: string, update: KeyValue): void;
-
-  /**
-   * Subscribe to presence update requests from other clients.
-   * @param callback Function to call when a presence update is requested.
-   * @returns Function to unsubscribe.
-   */
-  subscribePresenceUpdateRequests<TUpdateRequest extends KeyValue>(
-    callback: (updateRequest: TUpdateRequest, fromClientId: string) => void
-  ): () => void;
-
-  /**
-   * Updates the room-wide state. This merges with existing state.
-   * @param delta The new state to merge with current room state.
-   */
-  updateRoomState<TDelta extends KeyValue>(delta: TDelta): void;
-
-  /**
-   * Subscribe to room state updates.
-   * @param callback Function to call when room state changes.
-   * @returns Function to unsubscribe.
-   */
-  subscribeRoomState<TRoomState extends KeyValue>(
-    callback: (state: TRoomState) => void
-  ): () => void;
-
-  /**
-   * Object containing the current presence state of all connected peers, including this client.
-   * This is always up-to-date after initialization.
-   */
-  presence: { [clientId: string]: KeyValue };
-
-  /**
-   * Object containing the current room-wide state.
-   * This is always up-to-date.
-   */
-  roomState: KeyValue;
-
-  /**
-   * Object containing all connected peers, including this client.
-   * This is always up-to-date.
-   */
-  peers: {
-    [clientId: string]: {
-      avatarUrl: string;
-      username: string;
-    };
-  };
-
-  /**
-   * Updates the current client's presence state.
-   * @param presence The new presence state to set.
-   */
-  updatePresence<TPresence extends KeyValue>(presence: TPresence): void;
-
-  /**
-   * Subscribe to presence updates from all peers.
-   * @param callback Function to call when presence changes.
-   * @returns Function to unsubscribe.
-   */
-  subscribePresence<TPresence extends KeyValue>(
-    callback: (presence: { [clientId: string]: TPresence }) => void
-  ): () => void;
-}