@websimai/socket-types 0.0.3 → 0.0.5

package/dist/index.d.mts

@@ -3,47 +3,34 @@ type Expand<T> = T extends infer O ? { [K in keyof O]: O[K] } : never;
 type KeyValue = Record<string, any>;
 //#endregion
 //#region src/types/collection-api.d.ts
-interface CollectionAPI<T extends string> {
-  getList: <TData extends KeyValue>() => Expand<TData & {
-    readonly id: string;
-    readonly $type: T;
-    readonly created_at: string;
+type BaseData<$Type extends string, Id extends string = string> = {
+  readonly id: Id;
+  readonly $type: $Type;
+  readonly created_at: string;
+  readonly username: string;
+};
+interface CollectionAPI<$Type extends string> {
+  getList<Data extends KeyValue>(): Expand<Data & BaseData<$Type> & {
     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 & {
+  create<Data extends KeyValue>(data: Data): Promise<Expand<Data & BaseData<$Type>>>;
+  update<Id extends string, Data extends KeyValue>(id: Id, data: Data): Promise<Expand<Data & BaseData<$Type, Id>>>;
+  upsert<Data extends KeyValue & {
+    id?: Id;
+  }, Id extends string = string>(data: Data): Promise<Expand<(Data extends {
+    id: Id;
+  } ? Data & KeyValue : Data) & BaseData<$Type, Id>>>;
+  delete(id: string): Promise<void>;
+  subscribe(callback: (records: Expand<KeyValue & {
     id: string;
-    $type: T;
+    $type: $Type;
     created_at: string;
     updated_at: string;
     user_id: string;
     username: string;
-  }>[]) => void) => () => void;
-  filter: (filters: KeyValue) => CollectionAPI<T>;
+  }>[]) => void): () => void;
+  filter(filters: KeyValue): CollectionAPI<$Type>;
 }
 //#endregion
 //#region src/types/peers.d.ts
@@ -75,14 +62,14 @@ interface WebsimSocketParty {
    * This is always up-to-date.
    */
   readonly peers: {
-    [id: string]: {
+    readonly [id: string]: {
       readonly avatarUrl: `https://${string}/${string}`;
       readonly username: string;
       readonly id: string;
       readonly is_anonymous: boolean;
     };
   };
-  subscribe: (callback: (peers: Peers) => void) => () => void;
+  subscribe(callback: (peers: Peers) => void): () => void;
   /**
    * Object containing the current presence state of all connected peers, including this client.
    * This is always up-to-date after initialization.
@@ -132,7 +119,7 @@ declare class WebsimSocketClass {
   close(_code?: number, _reason?: string): void;
   send<TData extends string | object>(data: TData): void;
   query<TParams extends unknown = unknown>(queryString: string, params?: TParams[]): QueryAPI;
-  collection<T extends string>($type: T): CollectionAPI<T>;
+  collection<$Type extends string>($type: $Type): CollectionAPI<$Type>;
   readonly clientId: string;
   /**
    * Object containing information about the connected client and their peers.
@@ -159,18 +146,18 @@ declare class WebsimSocketClass {
    * @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;
+  subscribePresenceUpdateRequests<UpdateRequest extends KeyValue>(callback: (updateRequest: UpdateRequest, 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;
+  updateRoomState<Delta extends KeyValue>(delta: Delta): 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;
+  subscribeRoomState<RoomState extends KeyValue>(callback: (state: RoomState) => void): () => void;
   /**
    * Object containing the current presence state of all connected peers, including this client.
    * This is always up-to-date after initialization.
@@ -192,14 +179,14 @@ declare class WebsimSocketClass {
    * Updates the current client's presence state.
    * @param presence The new presence state to set.
    */
-  updatePresence<TPresence extends KeyValue>(presence: TPresence): void;
+  updatePresence<Presence extends KeyValue>(presence: Presence): 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;
+  subscribePresence<Presence extends KeyValue>(callback: (presence: {
+    [clientId: string]: Presence;
   }) => void): () => void;
 }
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websimai/socket-types",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Type declarations for the `WebsimSocket` class",
   "type": "module",
   "author": "GameRoMan",
@@ -11,7 +11,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/websimnpm/websim.git",
-    "directory": "packages/socket-api-types"
+    "directory": "packages/socket-types"
   },
   "keywords": [
     "websim",
@@ -35,6 +35,6 @@
     "./package.json": "./package.json"
   },
   "devDependencies": {
-    "tsdown": "^0.17.3"
+    "tsdown": "^0.18.2"
   }
 }