@lemoncloud/chatic-sockets-lib 0.2.1 → 0.3.1

package/dist/modules/sockets/types.js

@@ -0,0 +1,86 @@
+"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

@@ -0,0 +1,67 @@
+/**
+ * `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

@@ -0,0 +1,23 @@
+"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;

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@lemoncloud/chatic-sockets-lib",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "Client websocket transport and sync runtime for chatic sockets v2",
   "main": "dist/client-socket-v2/index.js",
   "types": "dist/client-socket-v2/index.d.ts",
   "files": [
-    "dist/**/*",
+    "dist/client-socket-v2/**/*",
+    "dist/lib/**/*",
+    "dist/modules/**/*",
     "README.md"
   ],
   "exports": {