@lemoncloud/chatic-sockets-lib 0.3.1 → 0.3.3

package/dist/modules/sockets/model.d.ts

@@ -1,206 +0,0 @@
-/**
- * `model.ts`
- * - model definitions per account data
- *
- * @author      Steve <steve@lemoncloud.io>
- * @date        2022-08-29 initial version.
- * @author      Aiden <aiden@lemocloud.io>
- * @date        2025-07-23 refactored for sockets service
- *
- * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
- */
-import { CoreModel } from 'lemon-model';
-import $LUT, { DevicePlatform, DeviceStatus, ViewingType } from './types';
-import type { ChannelHead } from '../chat/model';
-/**
- * type: `ModelType`
- */
-export declare type ModelType = keyof typeof $LUT.ModelType;
-/**
- * type: `Model`: common model
- */
-export declare type Model = CoreModel<ModelType>;
-/**
- * interface: `SocketModel`
- */
-export interface SocketModel extends Model {
-    /** id of model */
-    id?: string;
-    /** name of model */
-    name?: string;
-}
-/**
- * interface: `ConnectionModel`
- * - a model for each connection to websocket.
- * - 웹소켓 연결 정보를 저장하는 모델
- */
-export interface ConnectionModel extends Model {
-    /**
-     * as `conn-id`
-     */
-    id?: string;
-    /**
-     * stereo type as initial `role`.
-     */
-    stereo?: string;
-    /**
-     * (required) The deployment stage of the API (e.g., 'dev', 'prod').
-     */
-    stage?: string;
-    /**
-     * (required) The domain name of the WebSocket API.
-     */
-    domain?: string;
-    /**
-     * (required) The API Gateway ID for Management API endpoint.
-     */
-    apiId?: string;
-    /**
-     * (required) The unique identifier for the WebSocket connection.
-     */
-    connectionId?: string;
-    /** (optional) if it has valid session infor. */
-    hasSession?: number;
-    /** (internal) Timestamp when the connection was established. */
-    connectedAt?: number;
-    /** (internal) Timestamp when the connection was terminated. */
-    disConnectedAt?: number;
-    /** (internal) version no */
-    versionNo?: number;
-    /** (internal) tracking no */
-    no?: number;
-    /**
-     * (extended) The origin of the request.
-     */
-    origin?: string;
-    /**
-     * (extended) The remote IP address of the client.
-     */
-    remote?: string;
-    /**
-     * (extended) The User-Agent string of the client.
-     */
-    agent?: string;
-    /**
-     * (extended) The reason for disconnection, if applicable.
-     */
-    reason?: string;
-    /**
-     * (extended) The code of disconnection.
-     */
-    disconnectCode?: number;
-    /**
-     * (extended) TTL for auto-deletion (ts)
-     */
-    ttl?: number;
-    /**
-     * (internal) ping-pong count
-     */
-    readonly count?: number;
-    /**
-     * (linked) 현재 연결이 구독 중인 채널(토픽) ID 목록
-     *
-     * @deprecated no more supported (see `chatic-socials-api`)
-     */
-    channels?: string[];
-    /**
-     * @deprecated  no longer in use (Channel management has been delegated to chatic-socials-api)
-     */
-    channel$$?: ChannelHead[];
-    /**
-     * (linked) device id for state sync
-     * NOTE it must be 1:1 matching with device.
-     * - `Device` has the major one connection.
-     * - `Connection` is belong to single `Device`.
-     */
-    deviceId?: string;
-    /** (internal) identity-id */
-    identityId?: string;
-    /** (internal) verified roles */
-    roles?: string[];
-    /** (internal) delegator-id — 소셜 로그인 시 게스트유저 uid */
-    did?: string;
-    /**
-     * (internal) connected device-info
-     */
-    readonly $device?: DeviceModel;
-}
-/**
- * interface: `DeviceHead`
- */
-export interface DeviceHead {
-    /** id of model */
-    id?: string;
-    /** name of model */
-    name?: string;
-}
-/**
- * interface: `DeviceModel` (종단 기기)ㅊ
- * - 디바이스 정보 관리 모델
- * - 그럼, 여기에서는 ENDPOINT 간의 상태 동기화
- *
- * ex) 브라우저 창, 네이티브 앱, 노드기반 클라이언트.
- */
-export interface DeviceModel extends Model, DeviceHead {
-    /** device-id (클라이언트에서 생성된 UUID) */
-    id?: string;
-    /** name of model */
-    name?: string;
-    /** device platform */
-    platform?: DevicePlatform;
-    /** status of device (for sync) */
-    status?: DeviceStatus;
-    /** tick count (for sync) */
-    tick?: number;
-    /** x position (for sync) */
-    posX?: number;
-    /** y position (for sync) */
-    posY?: number;
-    /** 현재 보고 있는 대상 종류 (예: 'channel') */
-    viewingType?: ViewingType;
-    /** 현재 보고 있는 대상 id */
-    viewingId?: string;
-    /** 현재 대상 진입 시각(ms) */
-    viewingSince?: number;
-    /** last activity timestamp */
-    lastActiveAt?: number;
-    /** connection start timestamp */
-    connectedAt?: number;
-    /** last disconnection timestamp */
-    disconnectedAt?: number;
-    /** (internal) connection-id */
-    connId?: string;
-    /** joined channel ids */
-    channelIds?: string[];
-    /**
-     * (internal) owner user-id
-     * - 푸시 전송 시, 타겟 유저 ID 매핑을 위해 이용됨.
-     * */
-    readonly userId?: string;
-}
-/**
- * extract field names from models
- * - only fields start with lowercase, or all upper.
- */
-export declare const filterFields: (fields: string[], base?: string[]) => string[];
-/** field names from head */
-export declare const $HEAD: {
-    device: string[];
-};
-export declare const $FIELD: {
-    socket: string[];
-    connection: string[];
-    device: string[];
-};
-/** must export default as below */
-declare const _default: {
-    $HEAD: {
-        device: string[];
-    };
-    $FIELD: {
-        socket: string[];
-        connection: string[];
-        device: string[];
-    };
-};
-export default _default;

package/dist/modules/sockets/model.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.$FIELD = exports.$HEAD = exports.filterFields = void 0;
-const field_registry_1 = require("../../generated/field-registry");
-/**
- * extract field names from models
- * - only fields start with lowercase, or all upper.
- */
-const filterFields = (fields, base = []) => fields
-    .filter(field => field !== '_id' && /^[a-z_][a-zA-Z_]+/.test(field))
-    .reduce((L, k) => {
-    if (k && !L.includes(k))
-        L.push(k);
-    return L;
-}, [...base]);
-exports.filterFields = filterFields;
-/** field names from head */
-exports.$HEAD = {
-    device: (0, exports.filterFields)(field_registry_1.fieldKeys.deviceHead()),
-};
-// extract field names from models
-exports.$FIELD = {
-    socket: (0, exports.filterFields)(field_registry_1.fieldKeys.socketModel(), ['meta']),
-    connection: (0, exports.filterFields)(field_registry_1.fieldKeys.connectionModel(), ['meta']),
-    device: (0, exports.filterFields)(field_registry_1.fieldKeys.deviceModel(), ['meta']),
-};
-/** must export default as below */
-exports.default = { $HEAD: exports.$HEAD, $FIELD: exports.$FIELD };

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

@@ -1,100 +0,0 @@
-/**
- * `types.ts`
- * - 기본 types used in `backend-proxy`
- *
- * **[중요! exports 순서]**
- * 1. define data type in `types.ts` w/ internal types.
- * 2. define Model in `model.ts`
- * 3. define View/Body in `view.ts`, and external types.
- *
- * @author      Steve <steve@lemoncloud.io>
- * @date        2022-08-29 initial version.
- * @author      Aiden <aiden@lemocloud.io>
- * @date        2025-07-23 refactored for sockets service
- *
- * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
- */
-/**
- * Lookup Table
- *
- * WARN! DO NOT EXPORT AS `$LUT`. use default export instead.
- */
-declare const $LUT: {
-    /**
-     * Possible type of model.
-     */
-    ModelType: {
-        /** socket model */
-        socket: string;
-        /** connection model */
-        connection: string;
-        /** device model */
-        device: string;
-    };
-    /**
-     * DeviceStatus
-     */
-    DeviceStatus: {
-        '': string;
-        /** green - online */
-        green: string;
-        /** red - offline */
-        red: string;
-        /** yellow - away/idle */
-        yellow: string;
-    };
-    /**
-     * DeviceEventType
-     */
-    DeviceEventType: {
-        '': string;
-        /** ping - heartbeat */
-        ping: string;
-        /** status - status change */
-        status: string;
-    };
-    /**
-     * ViewingType — 현재 보고 있는 대상 종류
-     */
-    ViewingType: {
-        '': string;
-        /** channel */
-        channel: string;
-    };
-    /**
-     * DevicePlatform
-     */
-    DevicePlatform: {
-        '': string;
-        /** iOS */
-        ios: string;
-        /** Android */
-        android: string;
-        /** Web browser */
-        web: string;
-        /** macOS */
-        macos: string;
-        /** Windows */
-        windows: string;
-        /** Linux */
-        linux: string;
-    };
-};
-/**
- * type: `DeviceStatus`
- */
-export declare type DeviceStatus = keyof typeof $LUT.DeviceStatus;
-/**
- * type: `DeviceEventType`
- */
-export declare type DeviceEventType = keyof typeof $LUT.DeviceEventType;
-/**
- * type: `ViewingType`
- */
-export declare type ViewingType = keyof typeof $LUT.ViewingType;
-/**
- * type: `DevicePlatform`
- */
-export declare type DevicePlatform = keyof typeof $LUT.DevicePlatform;
-/** must export $LUT as default */
-export default $LUT;

package/dist/modules/sockets/types.js

@@ -1,86 +0,0 @@
-"use strict";
-/**
- * `types.ts`
- * - 기본 types used in `backend-proxy`
- *
- * **[중요! exports 순서]**
- * 1. define data type in `types.ts` w/ internal types.
- * 2. define Model in `model.ts`
- * 3. define View/Body in `view.ts`, and external types.
- *
- * @author      Steve <steve@lemoncloud.io>
- * @date        2022-08-29 initial version.
- * @author      Aiden <aiden@lemocloud.io>
- * @date        2025-07-23 refactored for sockets service
- *
- * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Lookup Table
- *
- * WARN! DO NOT EXPORT AS `$LUT`. use default export instead.
- */
-const $LUT = {
-    /**
-     * Possible type of model.
-     */
-    ModelType: {
-        /** socket model */
-        socket: 'socket',
-        /** connection model */
-        connection: 'connection',
-        /** device model */
-        device: 'device',
-    },
-    /**
-     * DeviceStatus
-     */
-    DeviceStatus: {
-        '': '',
-        /** green - online */
-        green: 'green',
-        /** red - offline */
-        red: 'red',
-        /** yellow - away/idle */
-        yellow: 'yellow',
-    },
-    /**
-     * DeviceEventType
-     */
-    DeviceEventType: {
-        '': '',
-        /** ping - heartbeat */
-        ping: 'ping',
-        /** status - status change */
-        status: 'status',
-    },
-    /**
-     * ViewingType — 현재 보고 있는 대상 종류
-     */
-    ViewingType: {
-        '': '',
-        /** channel */
-        channel: 'channel',
-    },
-    /**
-     * DevicePlatform
-     */
-    DevicePlatform: {
-        '': '',
-        /** iOS */
-        ios: 'ios',
-        /** Android */
-        android: 'android',
-        /** Web browser */
-        web: 'web',
-        /** macOS */
-        macos: 'macos',
-        /** Windows */
-        windows: 'windows',
-        /** Linux */
-        linux: 'linux',
-    },
-};
-/** must export $LUT as default */
-exports.default = $LUT;

package/dist/modules/sockets/views.d.ts

@@ -1,67 +0,0 @@
-/**
- * `views.ts`
- * - type of views used in `backend-proxy`
- *
- * @author      Steve <steve@lemoncloud.io>
- * @date        2022-08-29 initial version.
- * @author      Aiden <aiden@lemoncloud.io>
- * @date        2024-07-23 refactored for sockets service
- *
- * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
- */
-import { View, Body } from 'lemon-model';
-import { ConnectionModel, DeviceModel, SocketModel } from './model';
-import $LUT from './types';
-export * from './types';
-export default $LUT;
-/**!SECTION */
-/**
- * type: `SocketView`
- * - usually same as post's body.
- */
-export interface SocketView extends View, Partial<SocketModel> {
-}
-/**
- * Type `SocketBody`
- */
-export interface SocketBody extends Body, Partial<SocketView> {
-}
-/**
- * type: `ConnectionView`
- * - usually same as post's body.
- */
-export interface ConnectionView extends View, Omit<Partial<ConnectionModel>, '$device'> {
-    /** (internal) connected device info */
-    readonly $device?: DeviceView;
-}
-/**
- * Type `ConnectionBody`
- */
-export interface ConnectionBody extends Body, Partial<ConnectionView> {
-}
-/**
- * type: `DeviceView`
- */
-export interface DeviceView extends View, Partial<DeviceModel> {
-}
-/**
- * Type `DeviceBody`
- */
-export interface DeviceBody extends Body, Partial<DeviceView> {
-}
-/**
- * type: `ServerPingResultView`
- * - 서버에서 커넥션 ping 테스트 결과
- */
-export interface ServerPingResultView {
-    /** 대상 connectionId */
-    connId: string;
-    /** ping 시도 시간 (timestamp) */
-    pingedAt: number;
-    /** 최종 활성 상태 */
-    isActive: boolean;
-    /** cleanup 수행 여부 */
-    isCleaned?: boolean;
-    /** 현재 connection 상태 */
-    $conn?: ConnectionView;
-}

package/dist/modules/sockets/views.js

@@ -1,23 +0,0 @@
-"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);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const types_1 = __importDefault(require("./types"));
-//! export all internal types
-__exportStar(require("./types"), exports);
-exports.default = types_1.default;