entity-server-client 0.2.4 → 0.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,203 @@
1
+ import type { EntityHistoryRecord, EntityListParams, EntityListResult, EntityQueryRequest, EntityServerClientOptions, RegisterPushDeviceOptions } from "./types";
2
+ export declare class EntityServerClient {
3
+ private baseUrl;
4
+ private token;
5
+ private apiKey;
6
+ private hmacSecret;
7
+ private packetMagicLen;
8
+ private encryptRequests;
9
+ private activeTxId;
10
+ private keepSession;
11
+ private refreshBuffer;
12
+ private onTokenRefreshed?;
13
+ private onSessionExpired?;
14
+ private _sessionRefreshToken;
15
+ private _refreshTimer;
16
+ /**
17
+ * EntityServerClient 인스턴스를 생성합니다.
18
+ *
19
+ * 기본값:
20
+ * - `baseUrl`: `VITE_ENTITY_SERVER_URL` 또는 `http://localhost:47200`
21
+ * - `packetMagicLen`: `VITE_ENTITY_SERVER_PACKET_MAGIC_LEN` 또는 `4`
22
+ */
23
+ constructor(options?: EntityServerClientOptions);
24
+ /** baseUrl, token, packetMagicLen, encryptRequests 값을 런타임에 갱신합니다. */
25
+ configure(options: Partial<EntityServerClientOptions>): void;
26
+ /** 인증 요청에 사용할 JWT Access Token을 설정합니다. */
27
+ setToken(token: string): void;
28
+ /** HMAC 인증용 API Key를 설정합니다. */
29
+ setApiKey(apiKey: string): void;
30
+ /** HMAC 인증용 시크릿을 설정합니다. */
31
+ setHmacSecret(secret: string): void;
32
+ /** 암호화 패킷 magic 길이(`packet_magic_len`)를 설정합니다. */
33
+ setPacketMagicLen(length: number): void;
34
+ /** 현재 암호화 패킷 magic 길이를 반환합니다. */
35
+ getPacketMagicLen(): number;
36
+ /** @internal 자동 토큰 갱신 타이머를 시작합니다. */
37
+ private _scheduleKeepSession;
38
+ /** @internal 자동 갱신 타이머를 정리합니다. */
39
+ private _clearRefreshTimer;
40
+ /**
41
+ * 세션 유지 타이머를 중지합니다.
42
+ * `logout()` 호출 시 자동으로 중지되며, 직접 호출이 필요한 경우는 드뭅니다.
43
+ */
44
+ stopKeepSession(): void;
45
+ /**
46
+ * 서버 헬스 체크를 수행하고 패킷 암호화 활성 여부를 자동으로 감지합니다.
47
+ *
48
+ * 서버가 `packet_encryption: true`를 응답하면 이후 모든 요청에 암호화가 자동 적용됩니다.
49
+ *
50
+ * ```ts
51
+ * await client.checkHealth();
52
+ * await client.login(email, password);
53
+ * ```
54
+ */
55
+ checkHealth(): Promise<{
56
+ ok: boolean;
57
+ packet_encryption?: boolean;
58
+ }>;
59
+ /** 로그인 후 `access_token`을 내부 상태에 저장합니다. */
60
+ login(email: string, password: string): Promise<{
61
+ access_token: string;
62
+ refresh_token: string;
63
+ expires_in: number;
64
+ }>;
65
+ /** Refresh Token으로 Access Token을 재발급받아 내부 토큰을 교체합니다. */
66
+ refreshToken(refreshToken: string): Promise<{
67
+ access_token: string;
68
+ expires_in: number;
69
+ }>;
70
+ /**
71
+ * 서버에 로그아웃을 요청하고 내부 토큰을 초기화합니다.
72
+ * refresh_token을 서버에 전달해 무효화합니다.
73
+ */
74
+ logout(refreshToken: string): Promise<{
75
+ ok: boolean;
76
+ }>;
77
+ /** 트랜잭션을 시작하고 활성 트랜잭션 ID를 저장합니다. */
78
+ transStart(): Promise<string>;
79
+ /** 활성 트랜잭션(또는 전달된 transactionId)을 롤백합니다. */
80
+ transRollback(transactionId?: string): Promise<{
81
+ ok: boolean;
82
+ }>;
83
+ /**
84
+ * 활성 트랜잭션(또는 전달된 transactionId)을 커밋합니다.
85
+ *
86
+ * @returns `results` 배열: commit된 각 작업의 `entity`, `action`, `seq`
87
+ */
88
+ transCommit(transactionId?: string): Promise<{
89
+ ok: boolean;
90
+ results: Array<{
91
+ entity: string;
92
+ action: string;
93
+ seq: number;
94
+ }>;
95
+ }>;
96
+ /** 시퀀스 ID로 엔티티 단건을 조회합니다. */
97
+ get<T = unknown>(entity: string, seq: number, opts?: {
98
+ skipHooks?: boolean;
99
+ }): Promise<{
100
+ ok: boolean;
101
+ data: T;
102
+ }>;
103
+ /** 조건으로 엔티티 단건을 조회합니다. data 컬럼을 완전히 복호화하여 반환합니다. */
104
+ find<T = unknown>(entity: string, conditions?: Record<string, unknown>, opts?: {
105
+ skipHooks?: boolean;
106
+ }): Promise<{
107
+ ok: boolean;
108
+ data: T;
109
+ }>;
110
+ /** 페이지네이션/정렬/필터 조건으로 엔티티 목록을 조회합니다. */
111
+ list<T = unknown>(entity: string, params?: EntityListParams): Promise<{
112
+ ok: boolean;
113
+ data: EntityListResult<T>;
114
+ }>;
115
+ /**
116
+ * 엔티티 총 건수를 조회합니다.
117
+ *
118
+ * @param conditions 필터 조건 (예: `{ status: "active" }`)
119
+ */
120
+ count(entity: string, conditions?: Record<string, unknown>): Promise<{
121
+ ok: boolean;
122
+ count: number;
123
+ }>;
124
+ /**
125
+ * 커스텀 SQL로 엔티티를 조회합니다.
126
+ *
127
+ * SELECT 전용이며 인덱스 테이블만 조회 가능합니다. JOIN 지원.
128
+ */
129
+ query<T = unknown>(entity: string, req: EntityQueryRequest): Promise<{
130
+ ok: boolean;
131
+ data: {
132
+ items: T[];
133
+ count: number;
134
+ };
135
+ }>;
136
+ /** 엔티티 데이터를 생성/수정(Submit)합니다. `seq`가 없으면 INSERT, 있으면 UPDATE입니다. */
137
+ submit(entity: string, data: Record<string, unknown>, opts?: {
138
+ transactionId?: string;
139
+ skipHooks?: boolean;
140
+ }): Promise<{
141
+ ok: boolean;
142
+ seq: number;
143
+ }>;
144
+ /** 시퀀스 ID로 엔티티를 삭제합니다(`hard=true`면 하드 삭제, 기본은 소프트 삭제). */
145
+ delete(entity: string, seq: number, opts?: {
146
+ transactionId?: string;
147
+ hard?: boolean;
148
+ skipHooks?: boolean;
149
+ }): Promise<{
150
+ ok: boolean;
151
+ deleted: number;
152
+ }>;
153
+ /** 엔티티 단건의 변경 이력을 조회합니다. */
154
+ history<T = unknown>(entity: string, seq: number, params?: Pick<EntityListParams, "page" | "limit">): Promise<{
155
+ ok: boolean;
156
+ data: EntityListResult<EntityHistoryRecord<T>>;
157
+ }>;
158
+ /** 특정 이력 시점으로 엔티티를 롤백합니다. */
159
+ rollback(entity: string, historySeq: number): Promise<{
160
+ ok: boolean;
161
+ }>;
162
+ /** 푸시 관련 엔티티로 payload를 전송(Submit)합니다. */
163
+ push(pushEntity: string, payload: Record<string, unknown>, opts?: {
164
+ transactionId?: string;
165
+ }): Promise<{
166
+ ok: boolean;
167
+ seq: number;
168
+ }>;
169
+ /** 푸시 로그 엔티티 목록을 조회합니다. */
170
+ pushLogList<T = unknown>(params?: EntityListParams): Promise<{
171
+ ok: boolean;
172
+ data: EntityListResult<T>;
173
+ }>;
174
+ /** 계정의 푸시 디바이스를 등록합니다. */
175
+ registerPushDevice(accountSeq: number, deviceId: string, pushToken: string, opts?: RegisterPushDeviceOptions): Promise<{
176
+ ok: boolean;
177
+ seq: number;
178
+ }>;
179
+ /** 디바이스 레코드의 푸시 토큰을 갱신합니다. */
180
+ updatePushDeviceToken(deviceSeq: number, pushToken: string, opts?: {
181
+ pushEnabled?: boolean;
182
+ transactionId?: string;
183
+ }): Promise<{
184
+ ok: boolean;
185
+ seq: number;
186
+ }>;
187
+ /** 디바이스의 푸시 수신을 비활성화합니다. */
188
+ disablePushDevice(deviceSeq: number, opts?: {
189
+ transactionId?: string;
190
+ }): Promise<{
191
+ ok: boolean;
192
+ seq: number;
193
+ }>;
194
+ /**
195
+ * 요청 바디를 파싱합니다.
196
+ * `application/octet-stream`이면 XChaCha20-Poly1305 복호화, 그 외는 JSON 파싱합니다.
197
+ *
198
+ * @param requireEncrypted `true`이면 암호화된 요청만 허용합니다.
199
+ */
200
+ readRequestBody<T = Record<string, unknown>>(body: ArrayBuffer | Uint8Array | string | T | null | undefined, contentType?: string, requireEncrypted?: boolean): T;
201
+ private get _reqOpts();
202
+ private request;
203
+ }
@@ -0,0 +1,8 @@
1
+ /**
2
+ * HMAC-SHA256 서명 헤더를 생성합니다.
3
+ *
4
+ * 서명 대상: `METHOD|PATH|TIMESTAMP|NONCE|BODY`
5
+ *
6
+ * @returns `X-API-Key`, `X-Timestamp`, `X-Nonce`, `X-Signature` 헤더 객체
7
+ */
8
+ export declare function buildHmacHeaders(method: string, path: string, bodyBytes: Uint8Array, apiKey: string, hmacSecret: string): Record<string, string>;
@@ -0,0 +1,22 @@
1
+ /**
2
+ * 패킷 암호화 키를 유도합니다.
3
+ * - HMAC 모드 (`hmacSecret` 유효 시): HKDF-SHA256(hmac_secret, "entity-server:packet-encryption")
4
+ * - JWT 모드: SHA-256(jwt_token)
5
+ */
6
+ export declare function derivePacketKey(hmacSecret: string, token: string): Uint8Array;
7
+ /**
8
+ * 평문 바이트를 XChaCha20-Poly1305로 암호화합니다.
9
+ * 포맷: [random_magic:magicLen][random_nonce:24][ciphertext+tag]
10
+ */
11
+ export declare function encryptPacket(plaintext: Uint8Array, key: Uint8Array, magicLen: number): Uint8Array;
12
+ /**
13
+ * XChaCha20-Poly1305 패킷을 복호화해 JSON 객체로 변환합니다.
14
+ * 포맷: [magic:magicLen][nonce:24][ciphertext+tag]
15
+ */
16
+ export declare function decryptPacket<T>(buffer: ArrayBuffer, key: Uint8Array, magicLen: number): T;
17
+ /**
18
+ * 요청 바디를 파싱합니다. `application/octet-stream`이면 복호화, 그 외는 JSON 파싱합니다.
19
+ *
20
+ * @param requireEncrypted `true`이면 암호화된 요청만 허용합니다.
21
+ */
22
+ export declare function parseRequestBody<T>(body: ArrayBuffer | Uint8Array | string | T | null | undefined, contentType: string, requireEncrypted: boolean, key: Uint8Array, magicLen: number): T;
@@ -0,0 +1,16 @@
1
+ export interface RequestOptions {
2
+ baseUrl: string;
3
+ token: string;
4
+ apiKey: string;
5
+ hmacSecret: string;
6
+ packetMagicLen: number;
7
+ encryptRequests: boolean;
8
+ }
9
+ /**
10
+ * Entity Server에 HTTP 요청을 보냅니다.
11
+ *
12
+ * - `encryptRequests` 활성화 시 인증된 POST 바디를 자동 암호화합니다.
13
+ * - 응답이 `application/octet-stream`이면 자동 복호화합니다.
14
+ * - JSON 응답의 `ok`가 false이면 에러를 던집니다.
15
+ */
16
+ export declare function entityRequest<T>(opts: RequestOptions, method: string, path: string, body?: unknown, withAuth?: boolean, extraHeaders?: Record<string, string>): Promise<T>;
@@ -0,0 +1,4 @@
1
+ /** Vite 환경변수(`import.meta.env`)에서 값을 읽습니다. */
2
+ export declare function readEnv(name: string): string | undefined;
3
+ /** 쿼리 파라미터 객체를 URL 쿼리 문자열로 변환합니다. `orderBy` 키는 `order_by`로 변환됩니다. */
4
+ export declare function buildQuery(params: Record<string, unknown>): string;
package/dist/index.d.ts CHANGED
@@ -1,394 +1,4 @@
1
- /**
2
- * 엔티티 목록 조회 파라미터입니다.
3
- *
4
- * ```ts
5
- * client.list("post", {
6
- * page: 1, limit: 10,
7
- * orderBy: "created_time", orderDir: "DESC",
8
- * fields: ["seq", "title", "created_time"],
9
- * conditions: { status: "active" },
10
- * });
11
- * ```
12
- */
13
- export interface EntityListParams {
14
- /** 조회 페이지 번호. 기본값: `1` */
15
- page?: number;
16
- /** 페이지당 레코드 수. 기본값: `20` */
17
- limit?: number;
18
- /** 정렬 기준 필드명 */
19
- orderBy?: string;
20
- /** 정렬 방향. 기본값: `"ASC"` */
21
- orderDir?: "ASC" | "DESC";
22
- /**
23
- * 반환할 필드 목록.
24
- *
25
- * - **미지정 (기본값)**: 엔티티의 인덱스 필드만 반환합니다.
26
- * 복호화를 건너뛰기 때문에 **가장 빠릅니다**.
27
- * - `["*"]`: 전체 필드 반환 (복호화 수행).
28
- * - 필드명 목록: 해당 필드만 반환합니다.
29
- * 엔티티 설정에 `index`로 선언된 필드만 지정 가능합니다.
30
- * 존재하지 않는 필드명을 지정하면 서버 에러가 발생합니다.
31
- * - `seq`, `created_time`, `updated_time`, `license_seq`는 필드에 관계없이 항상 포함됩니다.
32
- *
33
- * ```ts
34
- * // 기본값 (인덱스 필드만, 가장 빠름)
35
- * client.list("account")
36
- * // 전체 필드
37
- * client.list("account", { fields: ["*"] })
38
- * // seq, name, email만
39
- * client.list("account", { fields: ["seq", "name", "email"] })
40
- * ```
41
- */
42
- fields?: string[];
43
- /** 필터 조건. POST body로 전달됩니다. (예: `{ status: "active" }`) */
44
- conditions?: Record<string, unknown>;
45
- }
46
- /**
47
- * `query()` 메서드에 전달하는 SQL 쿼리 요청입니다.
48
- *
49
- * - `sql`: SELECT 전용 SQL. 인덱스 테이블만 조회 가능하며 JOIN 지원.
50
- * - `params`: SQL 바인딩 파라미터 (`?` 플레이스홀더 대응).
51
- * - `limit`: 최대 반환 건수 (최대 1000. 미지정 시 서버 기본값 적용).
52
- *
53
- * ```ts
54
- * client.query("order", {
55
- * sql: `SELECT o.seq, o.status, u.name
56
- * FROM order o
57
- * JOIN account u ON u.data_seq = o.account_seq
58
- * WHERE o.status = ?`,
59
- * params: ["pending"],
60
- * limit: 100,
61
- * });
62
- * ```
63
- */
64
- export interface EntityQueryRequest {
65
- sql: string;
66
- params?: unknown[];
67
- limit?: number;
68
- }
69
- export interface RegisterPushDeviceOptions {
70
- platform?: string;
71
- deviceType?: string;
72
- browser?: string;
73
- browserVersion?: string;
74
- pushEnabled?: boolean;
75
- transactionId?: string;
76
- }
77
- /** EntityServerClient 생성/설정 옵션입니다. */
78
- export interface EntityServerClientOptions {
79
- baseUrl?: string;
80
- token?: string;
81
- packetMagicLen?: number;
82
- /**
83
- * `true`이면 인증된 POST/PUT 요청 바디를 XChaCha20-Poly1305로 암호화합니다.
84
- *
85
- * 서버의 `EnablePacketEncryption`이 활성화된 경우 필수로 설정해야 합니다.
86
- * 로그인(`login()`)·토큰 갱신(`refreshToken()`)은 인증 전 요청이므로 자동으로 건너뜁니다.
87
- *
88
- * 기본값: `false`
89
- */
90
- encryptRequests?: boolean;
91
- /**
92
- * `true`이면 `login()` 성공 후 Access Token 만료 전에 자동으로 갱신(silent refresh)합니다.
93
- * 갱신 시점은 `expires_in - refreshBuffer` 초입니다.
94
- *
95
- * 갱신 성공 시 `onTokenRefreshed`, 실패 시 `onSessionExpired` 콜백이 호출됩니다.
96
- *
97
- * 기본값: `false`
98
- */
99
- keepSession?: boolean;
100
- /**
101
- * 만료 몇 초 전에 자동 갱신을 시도할지 설정합니다.
102
- *
103
- * 예: `expires_in = 3600`, `refreshBuffer = 60` → 3540초 후 갱신
104
- *
105
- * 기본값: `60`
106
- */
107
- refreshBuffer?: number;
108
- /**
109
- * 자동 갱신 성공 시 호출되는 콜백입니다.
110
- * 새 `access_token`과 `expires_in`이 전달됩니다.
111
- * 앱은 이 콜백에서 localStorage 등에 토큰을 저장해야 합니다.
112
- */
113
- onTokenRefreshed?: (accessToken: string, expiresIn: number) => void;
114
- /**
115
- * 세션 유지 갱신 실패 시 호출되는 콜백입니다.
116
- * refresh_token 만료 등으로 재발급이 불가능한 경우입니다.
117
- * 앱은 이 콜백에서 로그인 페이지로 이동하는 등의 처리를 해야 합니다.
118
- */
119
- onSessionExpired?: (error: Error) => void;
120
- /**
121
- * HMAC 인증용 API Key (`X-API-Key` 헤더).
122
- * `hmacSecret`과 함께 설정하면 HMAC 인증 모드로 동작합니다.
123
- * **서버 사이드(Node.js 등) 전용. 브라우저에서는 사용하지 마세요.**
124
- */
125
- apiKey?: string;
126
- /**
127
- * HMAC 인증 시크릿. `apiKey`와 함께 설정하면 HMAC 인증 모드로 동작합니다.
128
- *
129
- * 패킷 암호화 키도 이 값에서 HKDF-SHA256으로 유도합니다:
130
- * `key = HKDF-SHA256(hmac_secret, info="entity-server:packet-encryption", salt="entity-server:hkdf:v1")`
131
- *
132
- * **서버 사이드(Node.js 등) 전용. 브라우저에서는 사용하지 마세요.**
133
- */
134
- hmacSecret?: string;
135
- }
136
- /**
137
- * `list()`, `history()` 응답의 `data` 필드 구조입니다.
138
- *
139
- * 서버는 항상 이 구조로 반환합니다:
140
- * ```json
141
- * { "ok": true, "data": { "items": [...], "total": 100, "page": 1, "limit": 20 } }
142
- * ```
143
- */
144
- export interface EntityListResult<T = unknown> {
145
- items: T[];
146
- /** 전체 레코드 수 */
147
- total: number;
148
- /** 현재 페이지 번호 */
149
- page: number;
150
- /** 페이지당 레코드 수 */
151
- limit: number;
152
- }
153
- /**
154
- * `history()` 응답의 개별 이력 레코드 구조입니다.
155
- *
156
- * - `action`: `"INSERT"` | `"UPDATE"` | `"DELETE_SOFT"` | `"DELETE_HARD"` | `"ROLLBACK"`
157
- * - `data_snapshot`: 변경 당시 엔티티 데이터 스냅샷
158
- */
159
- export interface EntityHistoryRecord<T = unknown> {
160
- seq: number;
161
- action: "INSERT" | "UPDATE" | "DELETE_SOFT" | "DELETE_HARD" | "ROLLBACK" | string;
162
- data_snapshot: T | null;
163
- changed_by: number | null;
164
- changed_time: string;
165
- }
166
- export declare class EntityServerClient {
167
- private baseUrl;
168
- private token;
169
- private apiKey;
170
- private hmacSecret;
171
- private packetMagicLen;
172
- private encryptRequests;
173
- private activeTxId;
174
- private keepSession;
175
- private refreshBuffer;
176
- private onTokenRefreshed?;
177
- private onSessionExpired?;
178
- private _sessionRefreshToken;
179
- private _refreshTimer;
180
- /**
181
- * EntityServerClient 인스턴스를 생성합니다.
182
- *
183
- * 기본값:
184
- * - `baseUrl`: `VITE_ENTITY_SERVER_URL` 또는 `http://localhost:47200`
185
- * - `packetMagicLen`: `VITE_ENTITY_SERVER_PACKET_MAGIC_LEN` 또는 `4`
186
- */
187
- constructor(options?: EntityServerClientOptions);
188
- /** baseUrl, token, packetMagicLen, encryptRequests 값을 런타임에 갱신합니다. */
189
- configure(options: Partial<EntityServerClientOptions>): void;
190
- /** 인증 요청에 사용할 JWT Access Token을 설정합니다. */
191
- setToken(token: string): void;
192
- /** HMAC 인증용 API Key를 설정합니다. */
193
- setApiKey(apiKey: string): void;
194
- /** HMAC 인증용 시크릿을 설정합니다. */
195
- setHmacSecret(secret: string): void;
196
- /** 암호화 패킷 magic 길이(`packet_magic_len`)를 설정합니다. */
197
- setPacketMagicLen(length: number): void;
198
- /** 현재 암호화 패킷 magic 길이를 반환합니다. */
199
- getPacketMagicLen(): number;
200
- /**
201
- * 자동 토큰 갱신 타이머를 시작합니다.
202
- * @param refreshToken 갱신에 사용할 Refresh Token
203
- * @param expiresIn Access Token의 유효 기간 (초)
204
- */
205
- private _scheduleKeepSession;
206
- /** 자동 갱신 타이머를 정리합니다. */
207
- private _clearRefreshTimer;
208
- /**
209
- * 세션 유지 타이머를 중지합니다.
210
- * `logout()` 호출 시 자동으로 중지되므로 직접 호출이 필요한 경우는 드뭅니다.
211
- */
212
- stopKeepSession(): void;
213
- /**
214
- * 서버 헬스 체크를 수행하고 패킷 암호화 활성 여부를 자동으로 감지합니다.
215
- *
216
- * 서버가 `packet_encryption: true`를 응답하면 이후 모든 요청에 암호화가 자동 적용됩니다.
217
- * 초기화 직후 또는 로그인 전에 호출하면 암호화 설정을 자동으로 구성할 수 있습니다.
218
- *
219
- * ```ts
220
- * await client.checkHealth();
221
- * await client.login(email, password); // 이후 요청은 암호화 자동 적용
222
- * ```
223
- *
224
- * @returns `{ ok: true }` 또는 `{ ok: true, packet_encryption: true }`
225
- */
226
- checkHealth(): Promise<{
227
- ok: boolean;
228
- packet_encryption?: boolean;
229
- }>;
230
- /** 로그인 후 `access_token`을 내부 상태에 저장합니다. */
231
- login(email: string, password: string): Promise<{
232
- access_token: string;
233
- refresh_token: string;
234
- expires_in: number;
235
- }>;
236
- /** Refresh Token으로 Access Token을 재발급받아 내부 토큰을 교체합니다. */
237
- refreshToken(refreshToken: string): Promise<{
238
- access_token: string;
239
- expires_in: number;
240
- }>;
241
- /**
242
- * 서버에 로그아웃을 요청하고 내부 토큰을 초기화합니다.
243
- * refresh_token을 서버에 전달해 무효화합니다.
244
- */
245
- logout(refreshToken: string): Promise<{
246
- ok: boolean;
247
- }>;
248
- /** 트랜잭션을 시작하고 활성 트랜잭션 ID를 저장합니다. */
249
- transStart(): Promise<string>;
250
- /** 활성 트랜잭션(또는 전달된 transactionId)을 롤백합니다. */
251
- transRollback(transactionId?: string): Promise<{
252
- ok: boolean;
253
- }>;
254
- /** 활성 트랜잭션(또는 전달된 transactionId)을 커밋합니다.
255
- *
256
- * @returns `results` 배열: commit된 각 작업의 `entity`, `action`, `seq`
257
- */
258
- transCommit(transactionId?: string): Promise<{
259
- ok: boolean;
260
- results: Array<{
261
- entity: string;
262
- action: string;
263
- seq: number;
264
- }>;
265
- }>;
266
- /** 시퀀스 ID로 엔티티 단건을 조회합니다. */
267
- get<T = unknown>(entity: string, seq: number, opts?: {
268
- skipHooks?: boolean;
269
- }): Promise<{
270
- ok: boolean;
271
- data: T;
272
- }>;
273
- /** 조건으로 엔티티 단건을 조회합니다. data 컬럼을 완전히 복호화하여 반환합니다. */
274
- find<T = unknown>(entity: string, conditions?: Record<string, unknown>, opts?: {
275
- skipHooks?: boolean;
276
- }): Promise<{
277
- ok: boolean;
278
- data: T;
279
- }>;
280
- /** 페이지네이션/정렬/필터 조건으로 엔티티 목록을 조회합니다. */
281
- list<T = unknown>(entity: string, params?: EntityListParams): Promise<{
282
- ok: boolean;
283
- data: EntityListResult<T>;
284
- }>;
285
- /**
286
- * 엔티티 총 건수를 조회합니다.
287
- *
288
- * @param conditions 필터 조건 (예: `{ status: "active" }`)
289
- */
290
- count(entity: string, conditions?: Record<string, unknown>): Promise<{
291
- ok: boolean;
292
- count: number;
293
- }>;
294
- /**
295
- * 커스텀 SQL로 엔티티를 조회합니다.
296
- *
297
- * SELECT 전용이며 인덱스 테이블만 조회 가능합니다.
298
- * JOIN을 사용해 여러 엔티티를 조합할 수 있습니다.
299
- * `entity`는 SQL에 포함된 기본 엔티티명(라우트 경로용)입니다.
300
- */
301
- query<T = unknown>(entity: string, req: EntityQueryRequest): Promise<{
302
- ok: boolean;
303
- data: {
304
- items: T[];
305
- count: number;
306
- };
307
- }>;
308
- /** 엔티티 데이터를 생성/수정(Submit)합니다. `seq`가 없으면 INSERT, 있으면 UPDATE입니다. */
309
- submit(entity: string, data: Record<string, unknown>, opts?: {
310
- transactionId?: string;
311
- skipHooks?: boolean;
312
- }): Promise<{
313
- ok: boolean;
314
- seq: number;
315
- }>;
316
- /** 시퀀스 ID로 엔티티를 삭제합니다(`hard=true`면 하드 삭제, 기본은 소프트 삭제). */
317
- delete(entity: string, seq: number, opts?: {
318
- transactionId?: string;
319
- hard?: boolean;
320
- skipHooks?: boolean;
321
- }): Promise<{
322
- ok: boolean;
323
- deleted: number;
324
- }>;
325
- /** 엔티티 단건의 변경 이력을 조회합니다. 이력 항목당 `action`, `data_snapshot`, `changed_by`, `changed_time`을 포함합니다. */
326
- history<T = unknown>(entity: string, seq: number, params?: Pick<EntityListParams, "page" | "limit">): Promise<{
327
- ok: boolean;
328
- data: EntityListResult<EntityHistoryRecord<T>>;
329
- }>;
330
- /** 특정 이력 시점으로 엔티티를 롤백합니다. */
331
- rollback(entity: string, historySeq: number): Promise<{
332
- ok: boolean;
333
- }>;
334
- /** 푸시 관련 엔티티로 payload를 전송(Submit)합니다. */
335
- push(pushEntity: string, payload: Record<string, unknown>, opts?: {
336
- transactionId?: string;
337
- }): Promise<{
338
- ok: boolean;
339
- seq: number;
340
- }>;
341
- /** 푸시 로그 엔티티 목록을 조회합니다. */
342
- pushLogList<T = unknown>(params?: EntityListParams): Promise<{
343
- ok: boolean;
344
- data: EntityListResult<T>;
345
- }>;
346
- /** 계정의 푸시 디바이스를 등록합니다. */
347
- registerPushDevice(accountSeq: number, deviceId: string, pushToken: string, opts?: RegisterPushDeviceOptions): Promise<{
348
- ok: boolean;
349
- seq: number;
350
- }>;
351
- /** 디바이스 레코드의 푸시 토큰을 갱신합니다. */
352
- updatePushDeviceToken(deviceSeq: number, pushToken: string, opts?: {
353
- pushEnabled?: boolean;
354
- transactionId?: string;
355
- }): Promise<{
356
- ok: boolean;
357
- seq: number;
358
- }>;
359
- /** 디바이스의 푸시 수신을 비활성화합니다. */
360
- disablePushDevice(deviceSeq: number, opts?: {
361
- transactionId?: string;
362
- }): Promise<{
363
- ok: boolean;
364
- seq: number;
365
- }>;
366
- /**
367
- * 요청 바디를 파싱하고 `application/octet-stream`인 경우 복호화합니다.
368
- *
369
- * 원시 암호화 payload를 직접 다루는 클라이언트에서 사용합니다.
370
- */
371
- readRequestBody<T = Record<string, unknown>>(body: ArrayBuffer | Uint8Array | string | T | null | undefined, contentType?: string, requireEncrypted?: boolean): T;
372
- /**
373
- * 공통 HTTP 요청 함수입니다.
374
- *
375
- * - `encryptRequests`가 활성화된 인증 요청의 POST 바디를 자동 암호화합니다.
376
- * - 응답이 `application/octet-stream`이면 자동 복호화합니다.
377
- * - JSON 응답의 `ok`가 false이면 에러를 던집니다.
378
- */
379
- private request;
380
- /**
381
- * 패킷 암호화 키를 유도합니다.
382
- * - HMAC 모드 (`hmacSecret` 설정 시): HKDF-SHA256(hmac_secret, "entity-server:packet-encryption")
383
- * - JWT 모드: sha256(jwt_token)
384
- */
385
- private derivePacketKey;
386
- /**
387
- * 평문 바이트를 XChaCha20-Poly1305로 암호화합니다.
388
- * 포맷: [random_magic:packetMagicLen][random_nonce:24][ciphertext+tag]
389
- */
390
- private encryptPacket;
391
- /** 서버의 암호화 패킷을 복호화해 JSON 객체로 변환합니다. */
392
- private decryptPacket;
393
- }
1
+ export * from "./types";
2
+ export * from "./EntityServerClient";
3
+ import { EntityServerClient } from "./EntityServerClient";
394
4
  export declare const entityServer: EntityServerClient;