@lemoncloud/chatic-sockets-lib 0.2.0 → 0.3.0

package/dist/lib/socket-actions.d.ts

@@ -0,0 +1,291 @@
+/**
+ * `socket-actions.ts`
+ * - supported wsv2 socket domain/action lookup table.
+ *
+ * Keep this file client-safe. It is used as a public type contract and must not
+ * import server-side modules.
+ */
+/**
+ * lookup table
+ * - wsv2에서 공개/지원하는 socket action 목록
+ */
+export declare const SocketActionTypeLUT: {
+    /**
+     * DomainType
+     * - message domain
+     */
+    readonly DomainType: {
+        readonly '': "";
+        /** system - builtin/system messages */
+        readonly system: "system";
+        /** sockets - socket connection helpers */
+        readonly sockets: "sockets";
+        /** device - client device state */
+        readonly device: "device";
+        /** auth - connection authentication */
+        readonly auth: "auth";
+        /** channel - chat channel operations */
+        readonly channel: "channel";
+        /** chat - chat message operations */
+        readonly chat: "chat";
+        /** user - user/site profile operations */
+        readonly user: "user";
+        /** place - place(site) CRUD operations */
+        readonly place: "place";
+        /** profile - site profile operations */
+        readonly profile: "profile";
+        /** cloud - cloud profile operations */
+        readonly cloud: "cloud";
+    };
+    /**
+     * SystemActionType
+     * - system 도메인 액션
+     */
+    readonly SystemActionType: {
+        readonly '': "";
+        /** ping - keep-alive request */
+        readonly ping: "ping";
+        /** pong - keep-alive response/event */
+        readonly pong: "pong";
+        /** info - connection/server information */
+        readonly info: "info";
+        /** message - generic system message */
+        readonly message: "message";
+        /** error - generic system error */
+        readonly error: "error";
+    };
+    /**
+     * SocketsActionType
+     * - sockets 도메인 액션
+     */
+    readonly SocketsActionType: {
+        readonly '': "";
+        /** find-connection - find or create current connection model */
+        readonly 'find-connection': "find-connection";
+    };
+    /**
+     * DeviceActionType
+     * - device 도메인 액션
+     */
+    readonly DeviceActionType: {
+        readonly '': "";
+        /** save - create or update linked device */
+        readonly save: "save";
+        /** read - read linked or requested device */
+        readonly read: "read";
+        /** sync - client device state sync hint */
+        readonly sync: "sync";
+    };
+    /**
+     * AuthActionType
+     * - auth 도메인 액션
+     */
+    readonly AuthActionType: {
+        readonly '': "";
+        /** update - update authentication state for current connection */
+        readonly update: "update";
+    };
+    /**
+     * ChannelActionType
+     * - channel 도메인 액션
+     */
+    readonly ChannelActionType: {
+        readonly '': "";
+        /** create - create a channel */
+        readonly create: "create";
+        /** join - join a channel */
+        readonly join: "join";
+        /** leave - leave or kick from a channel */
+        readonly leave: "leave";
+        /** get-self - get or create personal channel */
+        readonly 'get-self': "get-self";
+        /** mine - list my channels */
+        readonly mine: "mine";
+        /** list-user - list channel members */
+        readonly 'list-user': "list-user";
+        /** invite - invite users to a channel */
+        readonly invite: "invite";
+        /** update - update channel information */
+        readonly update: "update";
+        /** update-join - update channel participation settings */
+        readonly 'update-join': "update-join";
+        /** delete - delete a channel */
+        readonly delete: "delete";
+        /** sync - synchronize channel list/state */
+        readonly sync: "sync";
+        /** read - pull authoritative single-channel item */
+        readonly read: "read";
+        /** sync-users - synchronize channel users */
+        readonly 'sync-users': "sync-users";
+        /** @deprecated use `profile.sync`. synchronize related site profile (하위호환) */
+        readonly 'sync-site-profile': "sync-site-profile";
+        /** unreads - get unread message summary */
+        readonly unreads: "unreads";
+    };
+    /**
+     * ChatActionType
+     * - chat 도메인 액션
+     */
+    readonly ChatActionType: {
+        readonly '': "";
+        /** send - send chat message */
+        readonly send: "send";
+        /** read - mark chat message/channel as read */
+        readonly read: "read";
+        /** feed - get chat feed */
+        readonly feed: "feed";
+    };
+    /**
+     * UserActionType
+     * - user 도메인 액션
+     */
+    readonly UserActionType: {
+        readonly '': "";
+        /** invite - invite a user */
+        readonly invite: "invite";
+        /** invite-batch - invite multiple users */
+        readonly 'invite-batch': "invite-batch";
+        /** my-site - list accessible sites */
+        readonly 'my-site': "my-site";
+        /** make-site - create a site */
+        readonly 'make-site': "make-site";
+        /** update-profile - update user profile */
+        readonly 'update-profile': "update-profile";
+        /** update-site - update site profile */
+        readonly 'update-site': "update-site";
+        /** get-site-profile - get site profile */
+        readonly 'get-site-profile': "get-site-profile";
+        /** set-site-profile - set site profile */
+        readonly 'set-site-profile': "set-site-profile";
+    };
+    /**
+     * PlaceActionType
+     * - place(site) 도메인 액션
+     */
+    readonly PlaceActionType: {
+        readonly '': "";
+        /** create - create a place(site) */
+        readonly create: "create";
+        /** get - get a place(site) */
+        readonly get: "get";
+        /** update - update a place(site) */
+        readonly update: "update";
+        /** delete - delete a place(site) */
+        readonly delete: "delete";
+    };
+    /**
+     * ProfileActionType
+     * - profile(site-profile) 도메인 액션
+     */
+    readonly ProfileActionType: {
+        readonly '': "";
+        /** get - get site profile by id */
+        readonly get: "get";
+        /** get-mine - get current session's site profile */
+        readonly 'get-mine': "get-mine";
+        /** set - set site profile */
+        readonly set: "set";
+        /** sync - synchronize site multi-profiles (delta since cursor) */
+        readonly sync: "sync";
+    };
+    /**
+     * CloudActionType
+     * - cloud 도메인 액션
+     */
+    readonly CloudActionType: {
+        readonly '': "";
+        /** create - create a cloud (미구현/500) */
+        readonly create: "create";
+        /** get - get a cloud */
+        readonly get: "get";
+        /** update - update a cloud */
+        readonly update: "update";
+        /** delete - delete a cloud */
+        readonly delete: "delete";
+    };
+};
+declare type SocketActionKeyOf<T> = Extract<keyof T, string>;
+declare type NonEmptySocketAction<T extends string> = Exclude<T, ''>;
+/**
+ * type: `SocketDomainType`
+ */
+export declare type SocketDomainType = SocketActionKeyOf<typeof SocketActionTypeLUT.DomainType>;
+/**
+ * type: `SocketSystemActionType`
+ */
+export declare type SocketSystemActionType = SocketActionKeyOf<typeof SocketActionTypeLUT.SystemActionType>;
+/**
+ * type: `SocketSocketsActionType`
+ */
+export declare type SocketSocketsActionType = SocketActionKeyOf<typeof SocketActionTypeLUT.SocketsActionType>;
+/**
+ * type: `SocketDeviceActionType`
+ */
+export declare type SocketDeviceActionType = SocketActionKeyOf<typeof SocketActionTypeLUT.DeviceActionType>;
+/**
+ * type: `SocketAuthActionType`
+ */
+export declare type SocketAuthActionType = SocketActionKeyOf<typeof SocketActionTypeLUT.AuthActionType>;
+/**
+ * type: `SocketChannelActionType`
+ */
+export declare type SocketChannelActionType = SocketActionKeyOf<typeof SocketActionTypeLUT.ChannelActionType>;
+/**
+ * type: `SocketChatActionType`
+ */
+export declare type SocketChatActionType = SocketActionKeyOf<typeof SocketActionTypeLUT.ChatActionType>;
+/**
+ * type: `SocketUserActionType`
+ */
+export declare type SocketUserActionType = SocketActionKeyOf<typeof SocketActionTypeLUT.UserActionType>;
+/**
+ * type: `SocketPlaceActionType`
+ */
+export declare type SocketPlaceActionType = SocketActionKeyOf<typeof SocketActionTypeLUT.PlaceActionType>;
+/**
+ * type: `SocketProfileActionType`
+ */
+export declare type SocketProfileActionType = SocketActionKeyOf<typeof SocketActionTypeLUT.ProfileActionType>;
+/**
+ * type: `SocketCloudActionType`
+ */
+export declare type SocketCloudActionType = SocketActionKeyOf<typeof SocketActionTypeLUT.CloudActionType>;
+/**
+ * type: `SocketActionType`
+ */
+export declare type SocketActionType = SocketSystemActionType | SocketSocketsActionType | SocketDeviceActionType | SocketAuthActionType | SocketChannelActionType | SocketChatActionType | SocketUserActionType | SocketPlaceActionType | SocketProfileActionType | SocketCloudActionType;
+/**
+ * interface: `SocketActionTypeMap`
+ * - domain to action type map
+ */
+export interface SocketActionTypeMap {
+    system: SocketSystemActionType;
+    sockets: SocketSocketsActionType;
+    device: SocketDeviceActionType;
+    auth: SocketAuthActionType;
+    channel: SocketChannelActionType;
+    chat: SocketChatActionType;
+    user: SocketUserActionType;
+    place: SocketPlaceActionType;
+    profile: SocketProfileActionType;
+    cloud: SocketCloudActionType;
+}
+/**
+ * type: `SocketSupportedDomainType`
+ */
+export declare type SocketSupportedDomainType = keyof SocketActionTypeMap;
+/**
+ * type: `SocketSupportedActionType`
+ */
+export declare type SocketSupportedActionType = NonEmptySocketAction<SocketActionType>;
+/**
+ * type: `SocketActionTypeOf`
+ */
+export declare type SocketActionTypeOf<TDomain extends SocketSupportedDomainType> = SocketActionTypeMap[TDomain];
+/**
+ * type: `SocketPacketActionType`
+ */
+export declare type SocketPacketActionType = {
+    [TDomain in SocketSupportedDomainType]: `${TDomain}.${NonEmptySocketAction<SocketActionTypeMap[TDomain]>}`;
+}[SocketSupportedDomainType];
+export {};

package/dist/lib/socket-actions.js

@@ -0,0 +1,209 @@
+"use strict";
+/**
+ * `socket-actions.ts`
+ * - supported wsv2 socket domain/action lookup table.
+ *
+ * Keep this file client-safe. It is used as a public type contract and must not
+ * import server-side modules.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SocketActionTypeLUT = void 0;
+/**
+ * lookup table
+ * - wsv2에서 공개/지원하는 socket action 목록
+ */
+exports.SocketActionTypeLUT = {
+    /**
+     * DomainType
+     * - message domain
+     */
+    DomainType: {
+        '': '',
+        /** system - builtin/system messages */
+        system: 'system',
+        /** sockets - socket connection helpers */
+        sockets: 'sockets',
+        /** device - client device state */
+        device: 'device',
+        /** auth - connection authentication */
+        auth: 'auth',
+        /** channel - chat channel operations */
+        channel: 'channel',
+        /** chat - chat message operations */
+        chat: 'chat',
+        /** user - user/site profile operations */
+        user: 'user',
+        /** place - place(site) CRUD operations */
+        place: 'place',
+        /** profile - site profile operations */
+        profile: 'profile',
+        /** cloud - cloud profile operations */
+        cloud: 'cloud',
+    },
+    /**
+     * SystemActionType
+     * - system 도메인 액션
+     */
+    SystemActionType: {
+        '': '',
+        /** ping - keep-alive request */
+        ping: 'ping',
+        /** pong - keep-alive response/event */
+        pong: 'pong',
+        /** info - connection/server information */
+        info: 'info',
+        /** message - generic system message */
+        message: 'message',
+        /** error - generic system error */
+        error: 'error',
+    },
+    /**
+     * SocketsActionType
+     * - sockets 도메인 액션
+     */
+    SocketsActionType: {
+        '': '',
+        /** find-connection - find or create current connection model */
+        'find-connection': 'find-connection',
+    },
+    /**
+     * DeviceActionType
+     * - device 도메인 액션
+     */
+    DeviceActionType: {
+        '': '',
+        /** save - create or update linked device */
+        save: 'save',
+        /** read - read linked or requested device */
+        read: 'read',
+        /** sync - client device state sync hint */
+        sync: 'sync',
+    },
+    /**
+     * AuthActionType
+     * - auth 도메인 액션
+     */
+    AuthActionType: {
+        '': '',
+        /** update - update authentication state for current connection */
+        update: 'update',
+    },
+    /**
+     * ChannelActionType
+     * - channel 도메인 액션
+     */
+    ChannelActionType: {
+        '': '',
+        /** create - create a channel */
+        create: 'create',
+        /** join - join a channel */
+        join: 'join',
+        /** leave - leave or kick from a channel */
+        leave: 'leave',
+        /** get-self - get or create personal channel */
+        'get-self': 'get-self',
+        /** mine - list my channels */
+        mine: 'mine',
+        /** list-user - list channel members */
+        'list-user': 'list-user',
+        /** invite - invite users to a channel */
+        invite: 'invite',
+        /** update - update channel information */
+        update: 'update',
+        /** update-join - update channel participation settings */
+        'update-join': 'update-join',
+        /** delete - delete a channel */
+        delete: 'delete',
+        /** sync - synchronize channel list/state */
+        sync: 'sync',
+        /** read - pull authoritative single-channel item */
+        read: 'read',
+        /** sync-users - synchronize channel users */
+        'sync-users': 'sync-users',
+        /** @deprecated use `profile.sync`. synchronize related site profile (하위호환) */
+        'sync-site-profile': 'sync-site-profile',
+        /** unreads - get unread message summary */
+        unreads: 'unreads',
+    },
+    /**
+     * ChatActionType
+     * - chat 도메인 액션
+     */
+    ChatActionType: {
+        '': '',
+        /** send - send chat message */
+        send: 'send',
+        /** read - mark chat message/channel as read */
+        read: 'read',
+        /** feed - get chat feed */
+        feed: 'feed',
+    },
+    /**
+     * UserActionType
+     * - user 도메인 액션
+     */
+    UserActionType: {
+        '': '',
+        /** invite - invite a user */
+        invite: 'invite',
+        /** invite-batch - invite multiple users */
+        'invite-batch': 'invite-batch',
+        /** my-site - list accessible sites */
+        'my-site': 'my-site',
+        /** make-site - create a site */
+        'make-site': 'make-site',
+        /** update-profile - update user profile */
+        'update-profile': 'update-profile',
+        /** update-site - update site profile */
+        'update-site': 'update-site',
+        /** get-site-profile - get site profile */
+        'get-site-profile': 'get-site-profile',
+        /** set-site-profile - set site profile */
+        'set-site-profile': 'set-site-profile',
+    },
+    /**
+     * PlaceActionType
+     * - place(site) 도메인 액션
+     */
+    PlaceActionType: {
+        '': '',
+        /** create - create a place(site) */
+        create: 'create',
+        /** get - get a place(site) */
+        get: 'get',
+        /** update - update a place(site) */
+        update: 'update',
+        /** delete - delete a place(site) */
+        delete: 'delete',
+    },
+    /**
+     * ProfileActionType
+     * - profile(site-profile) 도메인 액션
+     */
+    ProfileActionType: {
+        '': '',
+        /** get - get site profile by id */
+        get: 'get',
+        /** get-mine - get current session's site profile */
+        'get-mine': 'get-mine',
+        /** set - set site profile */
+        set: 'set',
+        /** sync - synchronize site multi-profiles (delta since cursor) */
+        sync: 'sync',
+    },
+    /**
+     * CloudActionType
+     * - cloud 도메인 액션
+     */
+    CloudActionType: {
+        '': '',
+        /** create - create a cloud (미구현/500) */
+        create: 'create',
+        /** get - get a cloud */
+        get: 'get',
+        /** update - update a cloud */
+        update: 'update',
+        /** delete - delete a cloud */
+        delete: 'delete',
+    },
+};

package/dist/lib/socket-inputs.d.ts

@@ -0,0 +1,15 @@
+/**
+ * `socket-inputs.ts`
+ * - public socket message.data input type barrel.
+ *
+ * Keep this file type-only and client-safe.
+ */
+export type { AuthUpdateInput } from './auth/types';
+export type { DeviceGetInput, DeviceReadInput, DeviceSaveInput, DeviceSyncInput } from './device/types';
+export type { FindConnectionModelInput, SocketsFindConnectionInput } from './sockets/types';
+export type { ChatFeedInput, ChatReadInput, ChatSendInput } from './chat/types';
+export type { ChannelCreateInput, ChannelDeleteInput, ChannelGetSelfInput, ChannelInviteInput, ChannelJoinInput, ChannelLeaveInput, ChannelListMyInput, ChannelListUserInput, ChannelMineInput, ChannelSyncInput, ChannelSyncProfileInput, ChannelSyncSiteProfileInput, ChannelSyncUsersInput, ChannelUnreadsInput, ChannelUpdateInput, ChannelUpdateJoinInput, ChatDeleteChannelInput, ChatInviteInput, ChatLeaveInput, ChatMineInput, ChatStartInput, ChatUpdateChannelInput, ChatUpdateJoinInput, ChatUsersInput, JoinUpdateInput, } from './channel/types';
+export type { PlaceCreateInput, PlaceDeleteInput, PlaceGetInput, PlaceUpdateInput } from './place/types';
+export type { ProfileGetInput, ProfileGetMineInput, ProfileSetInput, ProfileSyncInput } from './profile/types';
+export type { CloudCreateInput, CloudDeleteInput, CloudGetInput, CloudUpdateInput, UpdateCloudInput, } from './cloud/types';
+export type { UserGetSiteProfileInput, UserInviteBatchInput, UserInviteInput, UserMakeSiteInput, UserMySiteInput, UserSetSiteProfileInput, UserUpdateProfileInput, UserUpdateSiteInput, } from './user/types';

package/dist/lib/socket-inputs.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * `socket-inputs.ts`
+ * - public socket message.data input type barrel.
+ *
+ * Keep this file type-only and client-safe.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/sockets/types.d.ts

@@ -0,0 +1,27 @@
+export * from './packets';
+export interface FindConnectionModelEvent {
+    id?: string;
+    stage?: string;
+    domain?: string;
+    apiId?: string;
+    connectionId?: string;
+    connectedAt?: number;
+    origin?: string;
+    remote?: string;
+    reason?: string;
+    agent?: string;
+    route?: string;
+    param?: {
+        [key: string]: string;
+    };
+}
+export interface FindConnectionModelInput {
+    event: FindConnectionModelEvent;
+}
+export declare type SocketsFindConnectionInput = FindConnectionModelInput;
+export interface FindConnectionModelOptions {
+    useSession?: boolean;
+    errScope?: string;
+    validate?: boolean;
+    current?: number;
+}

package/dist/lib/sockets/types.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./packets"), exports);

package/dist/lib/types.d.ts

@@ -30,6 +30,8 @@ export interface SocketMessage<T = any, TType extends string = string> {
     meta?: SocketMessageMeta;
     /** optional error message */
     error?: string;
+    /** optional error code (HTTP status base); omitted when unclassified */
+    errorCode?: number;
 }
 /**
  * shared packet registry extension point.

package/dist/lib/user/types.d.ts

@@ -0,0 +1,102 @@
+import type { InferSocketRequest, SocketRequestMessage } from '../types';
+export interface UserMakeSiteRequestData {
+    name: string;
+}
+export interface UserInviteRequestData {
+    channelId?: string;
+    name: string;
+    phone: string;
+}
+export interface UserInviteBatchRequestData {
+    to: string[];
+    channelId?: string;
+    cloudId?: string;
+    cloudName?: string;
+}
+export interface UserUpdateProfileRequestData {
+    name?: string;
+    nick?: string;
+    thumbnail?: string;
+}
+export interface UserUpdateSiteRequestData {
+    sid?: string;
+    name?: string;
+    thumbnail?: string;
+}
+export interface UserSetSiteProfileRequestData {
+    id?: string;
+    userId?: string;
+    siteId?: string;
+    nick?: string;
+    thumbnail?: string;
+    active?: boolean;
+    [key: string]: unknown;
+}
+declare module '../types' {
+    interface SocketPacketRegistry {
+        'user.get-site-profile': {
+            request: Record<string, never>;
+            response: unknown;
+            error: null;
+        };
+        'user.my-site': {
+            request: Record<string, never>;
+            response: unknown;
+            error: null;
+        };
+        'user.make-site': {
+            request: UserMakeSiteRequestData;
+            response: unknown;
+            error: null;
+        };
+        'user.invite': {
+            request: UserInviteRequestData;
+            response: unknown;
+            error: null;
+        };
+        'user.invite-batch': {
+            request: UserInviteBatchRequestData;
+            response: unknown;
+            error: null;
+        };
+        'user.update-profile': {
+            request: UserUpdateProfileRequestData;
+            response: unknown;
+            error: null;
+        };
+        'user.update-site': {
+            request: UserUpdateSiteRequestData;
+            response: unknown;
+            error: null;
+        };
+        'user.set-site-profile': {
+            request: UserSetSiteProfileRequestData;
+            response: unknown;
+            error: null;
+        };
+    }
+}
+export declare type UserGetSiteProfileType = 'user.get-site-profile';
+export declare type UserGetSiteProfileInput = InferSocketRequest<UserGetSiteProfileType>;
+export declare type UserGetSiteProfileRequestMessage = SocketRequestMessage<UserGetSiteProfileType>;
+export declare type UserMySiteType = 'user.my-site';
+export declare type UserMySiteInput = InferSocketRequest<UserMySiteType>;
+export declare type UserMySiteRequestMessage = SocketRequestMessage<UserMySiteType>;
+export declare type UserMakeSiteType = 'user.make-site';
+export declare type UserMakeSiteInput = InferSocketRequest<UserMakeSiteType>;
+export declare type UserMakeSiteRequestMessage = SocketRequestMessage<UserMakeSiteType>;
+export declare type UserInviteType = 'user.invite';
+export declare type UserInviteInput = InferSocketRequest<UserInviteType>;
+export declare type UserInviteRequestMessage = SocketRequestMessage<UserInviteType>;
+export declare type UserInviteBatchType = 'user.invite-batch';
+export declare type UserInviteBatchInput = InferSocketRequest<UserInviteBatchType>;
+export declare type UserInviteBatchRequestMessage = SocketRequestMessage<UserInviteBatchType>;
+export declare type UserUpdateProfileType = 'user.update-profile';
+export declare type UserUpdateProfileInput = InferSocketRequest<UserUpdateProfileType>;
+export declare type UserUpdateProfileRequestMessage = SocketRequestMessage<UserUpdateProfileType>;
+export declare type UserUpdateSiteType = 'user.update-site';
+export declare type UserUpdateSiteInput = InferSocketRequest<UserUpdateSiteType>;
+export declare type UserUpdateSiteRequestMessage = SocketRequestMessage<UserUpdateSiteType>;
+export declare type UserSetSiteProfileType = 'user.set-site-profile';
+export declare type UserSetSiteProfileInput = InferSocketRequest<UserSetSiteProfileType>;
+export declare type UserSetSiteProfileRequestMessage = SocketRequestMessage<UserSetSiteProfileType>;

package/dist/lib/user/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });