@pluv/types 0.1.6 → 0.2.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/types@0.1.6 build /home/runner/work/pluv/pluv/packages/types
+> @pluv/types@0.2.0 build /home/runner/work/pluv/pluv/packages/types
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,10 +8,10 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 0 B
-ESM ⚡️ Build success in 26ms
 CJS dist/index.js 754.00 B
-CJS ⚡️ Build success in 28ms
+CJS ⚡️ Build success in 35ms
+ESM dist/index.mjs 0 B
+ESM ⚡️ Build success in 38ms
 DTS Build start
-DTS ⚡️ Build success in 865ms
-DTS dist/index.d.ts 6.15 KB
+DTS ⚡️ Build success in 1181ms
+DTS dist/index.d.ts 7.18 KB

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @pluv/types
 
+## 0.2.0
+
+### Minor Changes
+
+- bb2886b: allow sending multiple output types (broadcast, self, sync) per event
+- ae679a8: updated offline presence to be set when reconnecting to a room
+
+### Patch Changes
+
+- 0dd847e: updated storage to be synced when reconnected to the room
+
 ## 0.1.6
 
 ### Patch Changes

package/dist/index.d.ts

@@ -41,6 +41,10 @@ type BaseUser = {
 };
 interface BaseClientEventRecord {
     $GET_OTHERS: {};
+    $INITIALIZE_SESSION: {
+        presence: JsonObject;
+        update: string | null;
+    };
     $PING: {};
     $UPDATE_PRESENCE: {
         presence: JsonObject;
@@ -70,6 +74,7 @@ interface BaseIOAuthorizeEventRecord<TAuthorize extends IOAuthorize<any, any>> {
     $USER_JOINED: {
         connectionId: string;
         user: NonNullable<InferIOAuthorizeUser<TAuthorize>>;
+        presence: JsonObject;
     };
 }
 type BaseIOEventRecord<TAuthorize extends IOAuthorize<any, any>> = BaseIOAuthorizeEventRecord<TAuthorize> & {
@@ -109,7 +114,10 @@ type InferIOAuthorize<TIO extends IOLike> = TIO extends IOLike<infer IAuthorize>
 type InferIOAuthorizeRequired<TAuthorize extends IOAuthorize<any, any>> = TAuthorize extends IOAuthorize<any, infer IRequired> ? IRequired : never;
 type InferIOAuthorizeUser<TAuthorize extends IOAuthorize<any, any>> = TAuthorize extends IOAuthorize<infer IUser, infer IRequired> ? IRequired extends true ? IUser : IUser | null : never;
 type InferIOInput<TIO extends IOLike> = TIO extends IOLike<any, infer IInput> ? IInput : never;
-type InferIOOutput<TIO extends IOLike> = TIO extends IOLike<any, any, infer IOutput> ? IOutput : never;
+type InferIOOutput<TIO extends IOLike> = TIO extends IOLike<any, any, infer IOutputBroadcast, infer IOutputSelf, infer IOutputSync> ? Spread<[IOutputBroadcast, IOutputSelf, IOutputSync]> : never;
+type InferIOOutputBroadcast<TIO extends IOLike> = TIO extends IOLike<any, any, infer IOutput> ? IOutput : never;
+type InferIOOutputSelf<TIO extends IOLike> = TIO extends IOLike<any, any, any, infer IOutput> ? IOutput : never;
+type InferIOOutputSync<TIO extends IOLike> = TIO extends IOLike<any, any, any, any, infer IOutput> ? IOutput : never;
 type InputZodLike<TData extends JsonObject> = {
     _input: TData;
     parse: (data: unknown) => TData;
@@ -128,13 +136,17 @@ type IOAuthorizeRequiredEventMessage<TIO extends IOLike> = NonNilProps<IOAuthori
 type IOEventMessage<TIO extends IOLike, TEvent extends keyof InferIOOutput<TIO> = keyof InferIOOutput<TIO>> = Id<{
     room: string;
 } & InferEventMessage<InferIOOutput<TIO>, TEvent> & (InferEventMessage<InferIOOutput<TIO>, TEvent>["type"] extends "$ERROR" ? IOAuthorizeOptionalEventMessage<TIO> : IOAuthorizeEventMessage<TIO>)>;
-interface IOLike<TAuthorize extends IOAuthorize<any, any> = IOAuthorize<any, any>, TInput extends EventRecord<string, any> = {}, TOutput extends EventRecord<string, any> = {}> {
+interface IOLike<TAuthorize extends IOAuthorize<any, any> = IOAuthorize<any, any>, TInput extends EventRecord<string, any> = {}, TOutputBroadcast extends EventRecord<string, any> = {}, TOutputSelf extends EventRecord<string, any> = {}, TOutputSync extends EventRecord<string, any> = {}> {
     _authorize: TAuthorize | null;
     _events: {
         [P in keyof TInput]: P extends string ? {
-            resolver: (data: TInput[P], ...args: any[]) => MaybePromise<TOutput | void>;
+            resolver: ((data: TInput[P], ...args: any[]) => MaybePromise<TOutputBroadcast | void>) | {
+                broadcast?: (data: TInput[P], ...args: any[]) => MaybePromise<TOutputBroadcast | void>;
+                self?: (data: TInput[P], ...args: any[]) => MaybePromise<TOutputSelf | void>;
+                sync?: (data: TInput[P], ...args: any[]) => MaybePromise<TOutputSync | void>;
+            };
         } : never;
     };
 }
 
-export { BaseClientEventRecord, BaseClientMessage, BaseIOAuthorize, BaseIOAuthorizeEventRecord, BaseIOEventRecord, BaseUser, Constructable, DeepPartial, DeepWriteable, EventMessage, EventRecord, GetEventMessage, IOAuthorize, IOAuthorizeEventMessage, IOAuthorizeOptionalEventMessage, IOAuthorizeRequiredEventMessage, IOEventMessage, IOLike, Id, InferEventMessage, InferIOAuthorize, InferIOAuthorizeRequired, InferIOAuthorizeUser, InferIOInput, InferIOOutput, InputZodLike, Json, JsonObject, JsonPrimitive, Maybe, MaybePromise, MaybeReadonlyArray, NonNilProps, OptionalProps, Spread, SpreadProperties };
+export { BaseClientEventRecord, BaseClientMessage, BaseIOAuthorize, BaseIOAuthorizeEventRecord, BaseIOEventRecord, BaseUser, Constructable, DeepPartial, DeepWriteable, EventMessage, EventRecord, GetEventMessage, IOAuthorize, IOAuthorizeEventMessage, IOAuthorizeOptionalEventMessage, IOAuthorizeRequiredEventMessage, IOEventMessage, IOLike, Id, InferEventMessage, InferIOAuthorize, InferIOAuthorizeRequired, InferIOAuthorizeUser, InferIOInput, InferIOOutput, InferIOOutputBroadcast, InferIOOutputSelf, InferIOOutputSync, InputZodLike, Json, JsonObject, JsonPrimitive, Maybe, MaybePromise, MaybeReadonlyArray, NonNilProps, OptionalProps, Spread, SpreadProperties };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/types",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "@pluv/io shared types",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,8 +18,8 @@
   "devDependencies": {
     "tsup": "^6.7.0",
     "typescript": "^5.0.4",
-    "@pluv/tsconfig": "^0.1.5",
-    "eslint-config-pluv": "^0.1.10"
+    "@pluv/tsconfig": "^0.1.6",
+    "eslint-config-pluv": "^0.1.11"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/index.ts

@@ -30,6 +30,9 @@ export type {
     InferIOAuthorizeUser,
     InferIOInput,
     InferIOOutput,
+    InferIOOutputBroadcast,
+    InferIOOutputSelf,
+    InferIOOutputSync,
     InputZodLike,
     IOEventMessage,
     IOAuthorize,

package/src/pluv.ts

@@ -1,4 +1,4 @@
-import { Id, JsonObject, MaybePromise, NonNilProps } from "./general";
+import { Id, JsonObject, MaybePromise, NonNilProps, Spread } from "./general";
 
 export type BaseUser = {
     id: string;
@@ -6,6 +6,10 @@ export type BaseUser = {
 
 export interface BaseClientEventRecord {
     $GET_OTHERS: {};
+    $INITIALIZE_SESSION: {
+        presence: JsonObject;
+        update: string | null;
+    };
     $PING: {};
     $UPDATE_PRESENCE: {
         presence: JsonObject;
@@ -40,6 +44,7 @@ export interface BaseIOAuthorizeEventRecord<
     $USER_JOINED: {
         connectionId: string;
         user: NonNullable<InferIOAuthorizeUser<TAuthorize>>;
+        presence: JsonObject;
     };
 }
 
@@ -115,6 +120,35 @@ export type InferIOInput<TIO extends IOLike> = TIO extends IOLike<
     : never;
 
 export type InferIOOutput<TIO extends IOLike> = TIO extends IOLike<
+    any,
+    any,
+    infer IOutputBroadcast,
+    infer IOutputSelf,
+    infer IOutputSync
+>
+    ? Spread<[IOutputBroadcast, IOutputSelf, IOutputSync]>
+    : never;
+
+export type InferIOOutputBroadcast<TIO extends IOLike> = TIO extends IOLike<
+    any,
+    any,
+    infer IOutput
+>
+    ? IOutput
+    : never;
+
+export type InferIOOutputSelf<TIO extends IOLike> = TIO extends IOLike<
+    any,
+    any,
+    any,
+    infer IOutput
+>
+    ? IOutput
+    : never;
+
+export type InferIOOutputSync<TIO extends IOLike> = TIO extends IOLike<
+    any,
+    any,
     any,
     any,
     infer IOutput
@@ -164,16 +198,33 @@ export type IOEventMessage<
 export interface IOLike<
     TAuthorize extends IOAuthorize<any, any> = IOAuthorize<any, any>,
     TInput extends EventRecord<string, any> = {},
-    TOutput extends EventRecord<string, any> = {}
+    TOutputBroadcast extends EventRecord<string, any> = {},
+    TOutputSelf extends EventRecord<string, any> = {},
+    TOutputSync extends EventRecord<string, any> = {}
 > {
     _authorize: TAuthorize | null;
     _events: {
         [P in keyof TInput]: P extends string
             ? {
-                  resolver: (
-                      data: TInput[P],
-                      ...args: any[]
-                  ) => MaybePromise<TOutput | void>;
+                  resolver:
+                      | ((
+                            data: TInput[P],
+                            ...args: any[]
+                        ) => MaybePromise<TOutputBroadcast | void>)
+                      | {
+                            broadcast?: (
+                                data: TInput[P],
+                                ...args: any[]
+                            ) => MaybePromise<TOutputBroadcast | void>;
+                            self?: (
+                                data: TInput[P],
+                                ...args: any[]
+                            ) => MaybePromise<TOutputSelf | void>;
+                            sync?: (
+                                data: TInput[P],
+                                ...args: any[]
+                            ) => MaybePromise<TOutputSync | void>;
+                        };
               }
             : never;
     };