@pluv/types 0.2.0 → 0.2.2

package/.turbo/turbo-build.log

@@ -1,17 +1,18 @@
 
-> @pluv/types@0.2.0 build /home/runner/work/pluv/pluv/packages/types
+> @pluv/types@0.2.2 build /home/runner/work/pluv/pluv/packages/types
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
-CLI tsup v6.7.0
+CLI tsup v7.1.0
 CLI Target: es6
 ESM Build start
 CJS Build start
-CJS dist/index.js 754.00 B
-CJS ⚡️ Build success in 35ms
 ESM dist/index.mjs 0 B
-ESM ⚡️ Build success in 38ms
+ESM ⚡️ Build success in 29ms
+CJS dist/index.js 754.00 B
+CJS ⚡️ Build success in 29ms
 DTS Build start
-DTS ⚡️ Build success in 1181ms
-DTS dist/index.d.ts 7.18 KB
+DTS ⚡️ Build success in 1398ms
+DTS dist/index.d.mts 7.18 KB
+DTS dist/index.d.ts  7.18 KB

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @pluv/types
 
+## 0.2.2
+
+### Patch Changes
+
+- 8fba48b: fix including incorrect dependency
+- 8997c65: bumped dependencies
+
+## 0.2.1
+
+### Patch Changes
+
+- 8d11672: bumped dependencies to latest
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -0,0 +1,152 @@
+type Constructable = {
+    new (...args: any[]): any;
+};
+type Maybe<T> = T | null | undefined;
+type MaybePromise<T> = Promise<T> | T;
+type MaybeReadonlyArray<T> = T[] | readonly T[];
+type OptionalPropertyNames<T> = {
+    [K in keyof T]-?: {} extends {
+        [P in K]: T[K];
+    } ? K : never;
+}[keyof T];
+type SpreadProperties<L, R, K extends keyof L & keyof R> = {
+    [P in K]: L[P] | Exclude<R[P], undefined>;
+};
+type Id<T> = T extends infer U ? U extends Constructable ? U : {
+    [K in keyof U]: U[K];
+} : never;
+type SpreadTwo<L, R> = Id<Pick<L, Exclude<keyof L, keyof R>> & Pick<R, Exclude<keyof R, OptionalPropertyNames<R>>> & Pick<R, Exclude<OptionalPropertyNames<R>, keyof L>> & SpreadProperties<L, R, OptionalPropertyNames<R> & keyof L>>;
+type Spread<A extends readonly [...any]> = A extends [
+    infer L,
+    ...infer R
+] ? SpreadTwo<L, Spread<R>> : unknown;
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends Array<infer U> ? Array<DeepPartial<U>> : T[P] extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : DeepPartial<T[P]>;
+};
+type DeepWriteable<T> = {
+    -readonly [P in keyof T]: DeepWriteable<T[P]>;
+};
+type OptionalProps<T extends Record<string, any>, K extends keyof T = keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+type NonNilProps<T extends Record<string, any>, K extends keyof T = keyof T> = Omit<T, K> & {
+    [P in K]-?: NonNullable<T[P]>;
+};
+type JsonPrimitive = string | number | boolean | null;
+type Json = JsonPrimitive | Json[] | readonly Json[] | {
+    [key: string]: Json;
+};
+type JsonObject = Record<string, Json>;
+
+type BaseUser = {
+    id: string;
+};
+interface BaseClientEventRecord {
+    $GET_OTHERS: {};
+    $INITIALIZE_SESSION: {
+        presence: JsonObject;
+        update: string | null;
+    };
+    $PING: {};
+    $UPDATE_PRESENCE: {
+        presence: JsonObject;
+    };
+    $UPDATE_STORAGE: {
+        origin: string | null;
+        update: string;
+    };
+}
+type BaseClientMessage = InferEventMessage<BaseClientEventRecord>;
+interface BaseIOAuthorize {
+    required: false;
+    secret: string;
+    user: InputZodLike<BaseUser>;
+}
+interface BaseIOAuthorizeEventRecord<TAuthorize extends IOAuthorize<any, any>> {
+    $OTHERS_RECEIVED: {
+        others: {
+            [connectionId: string]: {
+                connectionId: string;
+                presence: JsonObject | null;
+                room: string | null;
+                user: InferIOAuthorizeUser<TAuthorize>;
+            };
+        };
+    };
+    $USER_JOINED: {
+        connectionId: string;
+        user: NonNullable<InferIOAuthorizeUser<TAuthorize>>;
+        presence: JsonObject;
+    };
+}
+type BaseIOEventRecord<TAuthorize extends IOAuthorize<any, any>> = BaseIOAuthorizeEventRecord<TAuthorize> & {
+    $ERROR: {
+        message: string;
+        stack?: string | null;
+    };
+    $EXIT: {
+        sessionId: string;
+    };
+    $PONG: {};
+    $PRESENCE_UPDATED: {
+        presence: JsonObject;
+    };
+    $REGISTERED: {
+        sessionId: string;
+    };
+    $STORAGE_RECEIVED: {
+        state: string;
+    };
+    $STORAGE_UPDATED: {
+        state: string;
+    };
+};
+interface EventMessage<TEvent extends string, TData extends JsonObject = {}> {
+    data: TData;
+    type: TEvent;
+}
+type EventRecord<TEvent extends string, TData extends JsonObject> = {
+    [key in `${TEvent}`]: TData;
+};
+type GetEventMessage<T extends EventRecord<string, any>, TEvent extends keyof T> = TEvent extends string ? EventMessage<TEvent, T[TEvent]> : never;
+type InferEventMessage<TEvents extends EventRecord<string, any> = EventRecord<string, any>, TEvent extends keyof TEvents = keyof TEvents> = {
+    [P in TEvent]: P extends string ? Id<EventMessage<P, TEvents[P]>> : never;
+}[TEvent];
+type InferIOAuthorize<TIO extends IOLike> = TIO extends IOLike<infer IAuthorize> ? IAuthorize : never;
+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 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;
+};
+interface IOAuthorize<TUser extends BaseUser = any, TRequired extends boolean = false> {
+    required: TRequired;
+    secret: string;
+    user: InputZodLike<TUser>;
+}
+type IOAuthorizeEventMessage<TIO extends IOLike> = InferIOAuthorizeRequired<InferIOAuthorize<TIO>> extends false ? IOAuthorizeOptionalEventMessage<TIO> : IOAuthorizeRequiredEventMessage<TIO>;
+interface IOAuthorizeOptionalEventMessage<TIO extends IOLike> {
+    connectionId: string | null;
+    user: InferIOAuthorizeUser<InferIOAuthorize<TIO>> | null;
+}
+type IOAuthorizeRequiredEventMessage<TIO extends IOLike> = NonNilProps<IOAuthorizeOptionalEventMessage<TIO>, "connectionId" | "user">;
+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> = {}, 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<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, 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.2.0",
+  "version": "0.2.2",
   "description": "@pluv/io shared types",
   "author": "leedavidcs",
   "license": "MIT",
@@ -16,10 +16,13 @@
     "access": "public"
   },
   "devDependencies": {
-    "tsup": "^6.7.0",
-    "typescript": "^5.0.4",
-    "@pluv/tsconfig": "^0.1.6",
-    "eslint-config-pluv": "^0.1.11"
+    "tsup": "^7.1.0",
+    "typescript": "^5.1.6",
+    "@pluv/tsconfig": "^0.1.8",
+    "eslint-config-pluv": "^0.1.14"
+  },
+  "dependencies": {
+    "@types/react": "^18.2.15"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/general.ts

@@ -27,7 +27,7 @@ type SpreadTwo<L, R> = Id<
 
 export type Spread<A extends readonly [...any]> = A extends [
     infer L,
-    ...infer R
+    ...infer R,
 ]
     ? SpreadTwo<L, Spread<R>>
     : unknown;
@@ -46,12 +46,12 @@ export type DeepWriteable<T> = {
 
 export type OptionalProps<
     T extends Record<string, any>,
-    K extends keyof T = keyof T
+    K extends keyof T = keyof T,
 > = Omit<T, K> & Partial<Pick<T, K>>;
 
 export type NonNilProps<
     T extends Record<string, any>,
-    K extends keyof T = keyof T
+    K extends keyof T = keyof T,
 > = Omit<T, K> & { [P in K]-?: NonNullable<T[P]> };
 
 export type JsonPrimitive = string | number | boolean | null;

package/src/pluv.ts

@@ -29,7 +29,7 @@ export interface BaseIOAuthorize {
 }
 
 export interface BaseIOAuthorizeEventRecord<
-    TAuthorize extends IOAuthorize<any, any>
+    TAuthorize extends IOAuthorize<any, any>,
 > {
     $OTHERS_RECEIVED: {
         others: {
@@ -74,7 +74,7 @@ export type BaseIOEventRecord<TAuthorize extends IOAuthorize<any, any>> =
 
 export interface EventMessage<
     TEvent extends string,
-    TData extends JsonObject = {}
+    TData extends JsonObject = {},
 > {
     data: TData;
     type: TEvent;
@@ -86,12 +86,12 @@ export type EventRecord<TEvent extends string, TData extends JsonObject> = {
 
 export type GetEventMessage<
     T extends EventRecord<string, any>,
-    TEvent extends keyof T
+    TEvent extends keyof T,
 > = TEvent extends string ? EventMessage<TEvent, T[TEvent]> : never;
 
 export type InferEventMessage<
     TEvents extends EventRecord<string, any> = EventRecord<string, any>,
-    TEvent extends keyof TEvents = keyof TEvents
+    TEvent extends keyof TEvents = keyof TEvents,
 > = {
     [P in TEvent]: P extends string ? Id<EventMessage<P, TEvents[P]>> : never;
 }[TEvent];
@@ -163,7 +163,7 @@ export type InputZodLike<TData extends JsonObject> = {
 
 export interface IOAuthorize<
     TUser extends BaseUser = any,
-    TRequired extends boolean = false
+    TRequired extends boolean = false,
 > {
     required: TRequired;
     secret: string;
@@ -187,7 +187,7 @@ export type IOAuthorizeRequiredEventMessage<TIO extends IOLike> = NonNilProps<
 
 export type IOEventMessage<
     TIO extends IOLike,
-    TEvent extends keyof InferIOOutput<TIO> = keyof InferIOOutput<TIO>
+    TEvent extends keyof InferIOOutput<TIO> = keyof InferIOOutput<TIO>,
 > = Id<
     { room: string } & InferEventMessage<InferIOOutput<TIO>, TEvent> &
         (InferEventMessage<InferIOOutput<TIO>, TEvent>["type"] extends "$ERROR"
@@ -200,7 +200,7 @@ export interface IOLike<
     TInput extends EventRecord<string, any> = {},
     TOutputBroadcast extends EventRecord<string, any> = {},
     TOutputSelf extends EventRecord<string, any> = {},
-    TOutputSync extends EventRecord<string, any> = {}
+    TOutputSync extends EventRecord<string, any> = {},
 > {
     _authorize: TAuthorize | null;
     _events: {