@pluv/types 0.0.0

package/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: ["pluv"],
+};

package/.turbo/turbo-build.log

@@ -0,0 +1,17 @@
+
+> @pluv/types@0.0.0 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.5.0
+CLI Target: es6
+ESM Build start
+CJS Build start
+ESM dist/index.mjs 0 B
+ESM ⚡️ Build success in 30ms
+CJS dist/index.js 754.00 B
+CJS ⚡️ Build success in 32ms
+DTS Build start
+DTS ⚡️ Build success in 754ms
+DTS dist/index.d.ts 6.15 KB

package/dist/index.d.ts

@@ -0,0 +1,140 @@
+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: {};
+    $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>>;
+    };
+}
+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 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> = {}, TOutput extends EventRecord<string, any> = {}> {
+    _authorize: TAuthorize | null;
+    _events: {
+        [P in keyof TInput]: P extends string ? {
+            resolver: (data: TInput[P], ...args: any[]) => MaybePromise<TOutput | 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 };

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@pluv/types",
+  "version": "0.0.0",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@pluv/tsconfig": "^0.0.0",
+    "eslint-config-pluv": "^0.0.0",
+    "tsup": "^6.5.0",
+    "typescript": "^4.9.4"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
+    "lint": "eslint src/**/*.ts* --fix",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
+  }
+}

package/src/general.ts

@@ -0,0 +1,71 @@
+export type Constructable = { new (...args: any[]): any };
+
+export type Maybe<T> = T | null | undefined;
+export type MaybePromise<T> = Promise<T> | T;
+export type MaybeReadonlyArray<T> = T[] | readonly T[];
+
+type OptionalPropertyNames<T> = {
+    [K in keyof T]-?: {} extends { [P in K]: T[K] } ? K : never;
+}[keyof T];
+
+export type SpreadProperties<L, R, K extends keyof L & keyof R> = {
+    [P in K]: L[P] | Exclude<R[P], undefined>;
+};
+
+export 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>
+>;
+
+export type Spread<A extends readonly [...any]> = A extends [
+    infer L,
+    ...infer R
+]
+    ? SpreadTwo<L, Spread<R>>
+    : unknown;
+
+export 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]>;
+};
+
+export type DeepWriteable<T> = {
+    -readonly [P in keyof T]: DeepWriteable<T[P]>;
+};
+
+export type OptionalProps<
+    T extends Record<string, any>,
+    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
+> = Omit<T, K> & { [P in K]-?: NonNullable<T[P]> };
+
+export type JsonPrimitive = string | number | boolean | null;
+
+export type Json =
+    | JsonPrimitive
+    | Json[]
+    | readonly Json[]
+    | { [key: string]: Json };
+
+export type JsonObject = Record<string, Json>;
+
+export type StringLiteral<T> = T extends string
+    ? string extends T
+        ? never
+        : T
+    : never;

package/src/index.ts

@@ -0,0 +1,40 @@
+export type {
+    Constructable,
+    DeepPartial,
+    DeepWriteable,
+    Id,
+    Json,
+    JsonObject,
+    JsonPrimitive,
+    Maybe,
+    MaybePromise,
+    MaybeReadonlyArray,
+    NonNilProps,
+    OptionalProps,
+    Spread,
+    SpreadProperties,
+} from "./general";
+export type {
+    BaseUser,
+    BaseClientEventRecord,
+    BaseClientMessage,
+    BaseIOAuthorize,
+    BaseIOAuthorizeEventRecord,
+    BaseIOEventRecord,
+    EventMessage,
+    EventRecord,
+    GetEventMessage,
+    InferEventMessage,
+    InferIOAuthorize,
+    InferIOAuthorizeRequired,
+    InferIOAuthorizeUser,
+    InferIOInput,
+    InferIOOutput,
+    InputZodLike,
+    IOEventMessage,
+    IOAuthorize,
+    IOAuthorizeEventMessage,
+    IOAuthorizeOptionalEventMessage,
+    IOAuthorizeRequiredEventMessage,
+    IOLike,
+} from "./pluv";

package/src/pluv.ts

@@ -0,0 +1,180 @@
+import { Id, JsonObject, MaybePromise, NonNilProps } from "./general";
+
+export type BaseUser = {
+    id: string;
+};
+
+export interface BaseClientEventRecord {
+    $GET_OTHERS: {};
+    $PING: {};
+    $UPDATE_PRESENCE: {
+        presence: JsonObject;
+    };
+    $UPDATE_STORAGE: {
+        origin: string | null;
+        update: string;
+    };
+}
+
+export type BaseClientMessage = InferEventMessage<BaseClientEventRecord>;
+
+export interface BaseIOAuthorize {
+    required: false;
+    secret: string;
+    user: InputZodLike<BaseUser>;
+}
+
+export 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>>;
+    };
+}
+
+export 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;
+        };
+    };
+
+export interface EventMessage<
+    TEvent extends string,
+    TData extends JsonObject = {}
+> {
+    data: TData;
+    type: TEvent;
+}
+
+export type EventRecord<TEvent extends string, TData extends JsonObject> = {
+    [key in `${TEvent}`]: TData;
+};
+
+export type GetEventMessage<
+    T extends EventRecord<string, any>,
+    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
+> = {
+    [P in TEvent]: P extends string ? Id<EventMessage<P, TEvents[P]>> : never;
+}[TEvent];
+
+export type InferIOAuthorize<TIO extends IOLike> = TIO extends IOLike<
+    infer IAuthorize
+>
+    ? IAuthorize
+    : never;
+
+export type InferIOAuthorizeRequired<TAuthorize extends IOAuthorize<any, any>> =
+    TAuthorize extends IOAuthorize<any, infer IRequired> ? IRequired : never;
+
+export type InferIOAuthorizeUser<TAuthorize extends IOAuthorize<any, any>> =
+    TAuthorize extends IOAuthorize<infer IUser, infer IRequired>
+        ? IRequired extends true
+            ? IUser
+            : IUser | null
+        : never;
+
+export type InferIOInput<TIO extends IOLike> = TIO extends IOLike<
+    any,
+    infer IInput
+>
+    ? IInput
+    : never;
+
+export type InferIOOutput<TIO extends IOLike> = TIO extends IOLike<
+    any,
+    any,
+    infer IOutput
+>
+    ? IOutput
+    : never;
+
+export type InputZodLike<TData extends JsonObject> = {
+    _input: TData;
+    parse: (data: unknown) => TData;
+};
+
+export interface IOAuthorize<
+    TUser extends BaseUser = any,
+    TRequired extends boolean = false
+> {
+    required: TRequired;
+    secret: string;
+    user: InputZodLike<TUser>;
+}
+
+export type IOAuthorizeEventMessage<TIO extends IOLike> =
+    InferIOAuthorizeRequired<InferIOAuthorize<TIO>> extends false
+        ? IOAuthorizeOptionalEventMessage<TIO>
+        : IOAuthorizeRequiredEventMessage<TIO>;
+
+export interface IOAuthorizeOptionalEventMessage<TIO extends IOLike> {
+    connectionId: string | null;
+    user: InferIOAuthorizeUser<InferIOAuthorize<TIO>> | null;
+}
+
+export type IOAuthorizeRequiredEventMessage<TIO extends IOLike> = NonNilProps<
+    IOAuthorizeOptionalEventMessage<TIO>,
+    "connectionId" | "user"
+>;
+
+export 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>)
+>;
+
+export interface IOLike<
+    TAuthorize extends IOAuthorize<any, any> = IOAuthorize<any, any>,
+    TInput extends EventRecord<string, any> = {},
+    TOutput extends EventRecord<string, any> = {}
+> {
+    _authorize: TAuthorize | null;
+    _events: {
+        [P in keyof TInput]: P extends string
+            ? {
+                  resolver: (
+                      data: TInput[P],
+                      ...args: any[]
+                  ) => MaybePromise<TOutput | void>;
+              }
+            : never;
+    };
+}

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+	"extends": "@pluv/tsconfig/library.json",
+	"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
+	"exclude": ["node_modules"]
+}