@taco_tsinghua/graphnode-sdk 0.1.15 → 0.1.19

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.
Files changed (61) hide show
  1. package/README.md +139 -377
  2. package/dist/client.d.ts +9 -1
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/client.js +10 -0
  5. package/dist/client.js.map +1 -1
  6. package/dist/endpoints/ai.d.ts +27 -30
  7. package/dist/endpoints/ai.d.ts.map +1 -1
  8. package/dist/endpoints/ai.js +220 -31
  9. package/dist/endpoints/ai.js.map +1 -1
  10. package/dist/endpoints/graph.d.ts +4 -1
  11. package/dist/endpoints/graph.d.ts.map +1 -1
  12. package/dist/endpoints/graph.js +10 -0
  13. package/dist/endpoints/graph.js.map +1 -1
  14. package/dist/endpoints/graphAi.d.ts +21 -0
  15. package/dist/endpoints/graphAi.d.ts.map +1 -1
  16. package/dist/endpoints/graphAi.js +24 -0
  17. package/dist/endpoints/graphAi.js.map +1 -1
  18. package/dist/endpoints/notification.d.ts +55 -0
  19. package/dist/endpoints/notification.d.ts.map +1 -0
  20. package/dist/endpoints/notification.js +62 -0
  21. package/dist/endpoints/notification.js.map +1 -0
  22. package/dist/endpoints/sync.d.ts +3 -1
  23. package/dist/endpoints/sync.d.ts.map +1 -1
  24. package/dist/endpoints/sync.js.map +1 -1
  25. package/dist/http-builder.d.ts +4 -1
  26. package/dist/http-builder.d.ts.map +1 -1
  27. package/dist/http-builder.js +46 -6
  28. package/dist/http-builder.js.map +1 -1
  29. package/dist/index.d.ts +1 -0
  30. package/dist/index.d.ts.map +1 -1
  31. package/dist/index.js +1 -0
  32. package/dist/index.js.map +1 -1
  33. package/dist/types/graph.d.ts +66 -0
  34. package/dist/types/graph.d.ts.map +1 -1
  35. package/dist/types/note.d.ts.map +1 -1
  36. package/package.json +40 -34
  37. package/src/client.ts +105 -0
  38. package/src/config.ts +9 -0
  39. package/src/endpoints/agent.ts +171 -0
  40. package/src/endpoints/ai.ts +296 -0
  41. package/src/endpoints/auth.apple.ts +39 -0
  42. package/src/endpoints/auth.google.ts +39 -0
  43. package/src/endpoints/conversations.ts +362 -0
  44. package/src/endpoints/graph.ts +398 -0
  45. package/src/endpoints/graphAi.ts +111 -0
  46. package/src/endpoints/health.ts +40 -0
  47. package/src/endpoints/me.ts +97 -0
  48. package/src/endpoints/note.ts +351 -0
  49. package/src/endpoints/notification.ts +68 -0
  50. package/src/endpoints/sync.ts +71 -0
  51. package/src/http-builder.ts +247 -0
  52. package/src/index.ts +60 -0
  53. package/src/types/aiInput.ts +111 -0
  54. package/src/types/conversation.ts +51 -0
  55. package/src/types/graph.ts +201 -0
  56. package/src/types/graphAi.ts +21 -0
  57. package/src/types/me.ts +49 -0
  58. package/src/types/message.ts +40 -0
  59. package/src/types/note.ts +89 -0
  60. package/src/types/problem.ts +22 -0
  61. package/src/types/sync.ts +35 -0
package/README.md CHANGED
@@ -1,377 +1,139 @@
1
- # GraphNode BE SDK
2
-
3
- This SDK provides a convenient way to interact with the GraphNode Backend API from a TypeScript/JavaScript client.
4
-
5
- ## Installation
6
-
7
- ```bash
8
- npm install @taco_tsinghua/graphnode-sdk
9
- ```
10
-
11
- ## Getting Started
12
-
13
- ### Initialization
14
-
15
- Create a client instance. The base URL is automatically configured to point to the GraphNode backend.
16
-
17
- ```typescript
18
- import { createGraphNodeClient } from '@taco_tsinghua/graphnode-sdk';
19
-
20
- // No need to pass baseUrl, it defaults to the internal constant
21
- const client = createGraphNodeClient();
22
- ```
23
-
24
- If you need to pass custom fetch options (e.g., for testing or specific environments):
25
-
26
- ```typescript
27
- const client = createGraphNodeClient({
28
- // fetch: customFetch
29
- });
30
- ```
31
-
32
- ### API Usage Examples
33
-
34
- The client is organized by API resources.
35
-
36
- #### Health
37
-
38
- Check the health of the API server.
39
-
40
- ```typescript
41
- const health = await client.health.check();
42
- console.log(health); // { ok: true }
43
- ```
44
-
45
- #### Me (User Profile)
46
-
47
- Get the profile of the currently authenticated user.
48
-
49
- ```typescript
50
- try {
51
- const me = await client.me.getProfile();
52
- console.log(me); // { id: '...', displayName: '...' }
53
- } catch (error) {
54
- console.error('Not authenticated');
55
- }
56
- ```
57
-
58
- #### Conversations
59
-
60
- **Create a single conversation:**
61
-
62
- ```typescript
63
- const newConversation = await client.conversations.create({
64
- id: 'client-generated-uuid-1',
65
- title: 'My First Conversation',
66
- });
67
- console.log(newConversation);
68
- ```
69
-
70
- **Bulk create multiple conversations:**
71
-
72
- ```typescript
73
- const response = await client.conversations.bulkCreate({
74
- conversations: [
75
- { id: 'bulk-uuid-1', title: 'Bulk Conversation 1' },
76
- {
77
- id: 'bulk-uuid-2',
78
- title: 'Bulk Conversation 2 with messages',
79
- messages: [{ id: 'msg-uuid-1', role: 'user', content: 'Hello!' }]
80
- }
81
- ]
82
- });
83
- console.log(response.conversations); // Array of created conversations
84
- ```
85
-
86
- **List all conversations:**
87
-
88
- ```typescript
89
- const conversations = await client.conversations.list();
90
- console.log(conversations);
91
- ```
92
-
93
- **Get a specific conversation:**
94
-
95
- ```typescript
96
- const conversation = await client.conversations.get('conversation-id-123');
97
- console.log(conversation);
98
- ```
99
-
100
- #### Messages
101
-
102
- Create a message within a conversation:
103
-
104
- ```typescript
105
- const newMessage = await client.conversations.createMessage('conversation-id-123', {
106
- id: 'message-uuid-456',
107
- role: 'user',
108
- content: 'Hello, this is a new message.',
109
- });
110
- console.log(newMessage);
111
- ```
112
-
113
- #### Graph
114
-
115
- **Nodes:**
116
-
117
- ```typescript
118
- // Create a node
119
- const node = await client.graph.createNode({
120
- id: 1,
121
- label: 'My Node',
122
- type: 'concept',
123
- properties: { color: 'red' }
124
- });
125
-
126
- // List nodes
127
- const nodes = await client.graph.listNodes();
128
-
129
- // Get node
130
- const myNode = await client.graph.getNode(1);
131
-
132
- // Update node
133
- await client.graph.updateNode(1, { label: 'Updated Node' });
134
-
135
- // Delete node
136
- await client.graph.deleteNode(1);
137
-
138
- // Delete node cascade (with edges)
139
- await client.graph.deleteNodeCascade(1);
140
- ```
141
-
142
- **Edges:**
143
-
144
- ```typescript
145
- // Create an edge
146
- const edge = await client.graph.createEdge({
147
- source: 1,
148
- target: 2,
149
- relationship: 'related_to'
150
- });
151
-
152
- // List edges
153
- const edges = await client.graph.listEdges();
154
-
155
- // Delete edge
156
- await client.graph.deleteEdge('edge-id');
157
- ```
158
-
159
- **Clusters:**
160
-
161
- ```typescript
162
- // Create cluster
163
- const cluster = await client.graph.createCluster({
164
- name: 'My Cluster',
165
- nodeIds: [1, 2]
166
- });
167
-
168
- // List clusters
169
- const clusters = await client.graph.listClusters();
170
-
171
- // Get cluster
172
- const myCluster = await client.graph.getCluster('cluster-id');
173
-
174
- // Delete cluster
175
- await client.graph.deleteCluster('cluster-id');
176
-
177
- // Delete cluster cascade
178
- await client.graph.deleteClusterCascade('cluster-id');
179
- ```
180
-
181
- **Stats & Snapshot:**
182
-
183
- ```typescript
184
- // Get stats
185
- const stats = await client.graph.getStats();
186
-
187
- // Get snapshot
188
- const snapshot = await client.graph.getSnapshot();
189
-
190
- // Save snapshot
191
- await client.graph.saveSnapshot(snapshot);
192
- ```
193
-
194
- #### Graph AI (Graph Generation)
195
-
196
- **Generate Graph from User Conversations:**
197
-
198
- Starts a background task to analyze the user's conversation history and generate a knowledge graph.
199
-
200
- ```typescript
201
- const response = await client.graphAi.generateGraph();
202
-
203
- if (response.isSuccess) {
204
- console.log('Task Started:', response.data.taskId);
205
- console.log('Status:', response.data.status);
206
- }
207
- ```
208
-
209
- **Generate Graph from JSON (Test Mode):**
210
-
211
- Directly sends conversation data (in ChatGPT export format) to the AI engine for graph generation. Useful for testing without existing DB data.
212
-
213
- ```typescript
214
- import { AiInputData } from '@taco_tsinghua/graphnode-sdk';
215
-
216
- const mockData: AiInputData[] = [{
217
- title: "Test Conversation",
218
- create_time: 1678900000,
219
- update_time: 1678900100,
220
- mapping: {
221
- "msg-1": {
222
- id: "msg-1",
223
- message: {
224
- id: "msg-1",
225
- author: { role: "user" },
226
- content: { content_type: "text", parts: ["Hello"] }
227
- },
228
- parent: null,
229
- children: []
230
- }
231
- }
232
- }];
233
-
234
- const response = await client.graphAi.generateGraphTest(mockData);
235
- ```
236
-
237
- #### Notes & Folders
238
-
239
- **Notes:**
240
-
241
- ```typescript
242
- // Create a note
243
- const note = await client.note.createNote({
244
- title: 'My Note',
245
- content: '# Hello World',
246
- folderId: null // Optional
247
- });
248
-
249
- // List notes
250
- const notes = await client.note.listNotes();
251
-
252
- // Get note
253
- const myNote = await client.note.getNote('note-id');
254
-
255
- // Update note
256
- const updatedNote = await client.note.updateNote('note-id', {
257
- content: '# Updated Content'
258
- });
259
-
260
- // Delete note
261
- await client.note.deleteNote('note-id');
262
- ```
263
-
264
- **Folders:**
265
-
266
- ```typescript
267
- // Create a folder
268
- const folder = await client.note.createFolder({
269
- name: 'My Folder',
270
- parentId: null // Optional
271
- });
272
-
273
- // List folders
274
- const folders = await client.note.listFolders();
275
-
276
- // Get folder
277
- const myFolder = await client.note.getFolder('folder-id');
278
-
279
- // Update folder
280
- const updatedFolder = await client.note.updateFolder('folder-id', {
281
- name: 'Updated Folder Name'
282
- });
283
-
284
- // Delete folder
285
- await client.note.deleteFolder('folder-id');
286
- ```
287
-
288
- ### Error Handling
289
-
290
- The SDK uses a unified `HttpResponse` object for all API responses, eliminating the need for `try...catch` blocks for handling HTTP errors. Each API method returns a `Promise<HttpResponse<T>>`, which is a discriminated union type. You can check the `isSuccess` property to determine if the call was successful.
291
-
292
- ```typescript
293
- import { createGraphNodeClient, HttpResponse } from '@taco_tsinghua/graphnode-sdk';
294
-
295
- const client = createGraphNodeClient();
296
-
297
- async function fetchConversation() {
298
- const response = await client.conversations.get('non-existent-id');
299
-
300
- if (response.isSuccess) {
301
- // Type-safe access to `data` and `statusCode`
302
- console.log('Success:', response.data);
303
- } else {
304
- // Type-safe access to `error`
305
- console.error('API Error:', response.error.message);
306
- console.error('Status:', response.error.statusCode);
307
-
308
- // The error body might contain RFC 9457 Problem Details
309
- const problem = response.error.body as { title: string; detail: string };
310
- if (problem) {
311
- console.error('Problem Title:', problem.title);
312
- console.error('Problem Detail:', problem.detail);
313
- }
314
- }
315
- }
316
- ```
317
-
318
- ### HTTP 상태 코드 가이드 (HTTP Status Codes Guide)
319
-
320
- API는 표준 HTTP 상태 코드를 사용하여 요청의 성공 또는 실패를 나타냅니다.
321
-
322
- #### 성공 코드 (General Success Codes)
323
- - **`200 OK`**: 요청이 성공적으로 처리되었습니다. 응답 본문에 요청한 데이터가 포함됩니다. (예: `GET`, `PATCH`, `PUT`)
324
- - **`201 Created`**: 리소스가 성공적으로 생성되었습니다. `Location` 헤더에 새 리소스의 URL이 포함되며, 본문에 생성된 리소스가 포함됩니다. (예: `POST`)
325
- - **`204 No Content`**: 요청은 성공했으나 반환할 본문이 없습니다. (예: `DELETE`, 본문 없는 `PATCH`)
326
-
327
- #### 에러 코드 (General Error Codes)
328
- 모든 에러 응답은 **RFC 9457 Problem Details** 형식(`application/problem+json`)을 따릅니다.
329
- - **`400 Bad Request`**: 클라이언트 오류로 인해 서버가 요청을 처리할 수 없습니다(예: 잘못된 구문, 유효성 검사 실패). 응답 본문에 유효성 검사 실패에 대한 세부 정보가 포함됩니다.
330
- - **`401 Unauthorized`**: 요청된 응답을 받으려면 인증이 필요합니다. 세션이 유효하지 않거나 만료된 경우 발생합니다.
331
- - **`403 Forbidden`**: 클라이언트가 콘텐츠에 대한 접근 권한이 없습니다. 401과 달리 서버가 클라이언트의 신원을 알고 있습니다.
332
- - **`404 Not Found`**: 서버가 요청한 리소스를 찾을 수 없습니다.
333
- - **`409 Conflict`**: 요청이 서버의 현재 상태와 충돌할 때 전송됩니다(예: 이미 존재하는 리소스 생성).
334
- - **`429 Too Many Requests`**: 사용자가 일정 시간 동안 너무 많은 요청을 보냈습니다("속도 제한").
335
- - **`500 Internal Server Error`**: 서버가 처리 방법을 모르는 상황에 직면했습니다.
336
- - **`502 Bad Gateway`**: 업스트림 오류. 외부 서비스(예: OpenAI, DB)가 유효하지 않은 응답을 반환했습니다.
337
- - **`503 Service Unavailable`**: 서비스 불가. DB 연결 실패 등 일시적으로 서비스를 이용할 수 없습니다.
338
- - **`504 Gateway Timeout`**: 업스트림 타임아웃. 외부 서비스의 응답이 지연되어 타임아웃이 발생했습니다.
339
-
340
- #### 엔드포인트별 상태 코드 (Endpoint-Specific Status Codes)
341
-
342
- | Endpoint | Method | Success Codes | Error Codes | Description |
343
- |---|---|---|---|---|
344
- | **/healthz** | `GET` | `200` | `503` | API 상태를 확인합니다. <br> `503`: DB 등 필수 의존성 서비스가 다운된 경우. |
345
- | **/auth/logout** | `POST` | `204` | `401` | 사용자를 로그아웃하고 세션을 무효화합니다. <br> `401`: 이미 로그아웃되었거나 세션이 유효하지 않은 경우. |
346
- | **/v1/me** | `GET` | `200` | `401` | 현재 사용자의 프로필을 조회합니다. <br> `401`: 로그인하지 않은 사용자. |
347
- | **/v1/me/api-keys/{model}** | `GET` | `200` | `401`, `404` | 특정 모델의 API 키를 조회합니다. <br> `401`: 미인증. <br> `404`: 해당 모델의 키가 설정되지 않음. |
348
- | | `PATCH` | `204` | `400`, `401` | API 키를 업데이트합니다. <br> `400`: 키 형식이 잘못됨. <br> `401`: 미인증. |
349
- | | `DELETE` | `204` | `401` | API 키를 삭제합니다. <br> `401`: 미인증. |
350
- | **/v1/ai/conversations** | `POST` | `201` | `400`, `401`, `409` | 새 대화를 생성합니다. <br> `400`: 제목 누락 등 입력값 오류. <br> `401`: 미인증. <br> `409`: 클라이언트가 제공한 ID가 이미 존재함. |
351
- | | `GET` | `200` | `401` | 모든 대화를 조회합니다. <br> `401`: 미인증. |
352
- | **/v1/ai/conversations/bulk** | `POST` | `201` | `400`, `401` | 대화를 일괄 생성합니다. <br> `400`: 배열 형식이 아니거나 데이터 오류. <br> `401`: 미인증. |
353
- | **/v1/ai/conversations/{id}** | `GET` | `200` | `401`, `404` | 단일 대화를 조회합니다. <br> `401`: 미인증. <br> `404`: 대화를 찾을 수 없거나 삭제됨. |
354
- | | `PATCH` | `200` | `400`, `401`, `404` | 대화를 업데이트합니다. <br> `400`: 입력값 오류. <br> `401`: 미인증. <br> `404`: 대화 없음. |
355
- | | `DELETE` | `204` | `401`, `404` | 대화를 삭제합니다. <br> `401`: 미인증. <br> `404`: 대화 없음. |
356
- | **/v1/ai/conversations/{id}/restore** | `POST` | `200` | `401`, `404` | 삭제된 대화를 복원합니다. <br> `401`: 미인증. <br> `404`: 삭제된 대화 기록을 찾을 수 없음. |
357
- | **/v1/ai/conversations/{id}/messages** | `POST` | `201` | `400`, `401`, `404` | 대화에 메시지를 추가합니다. <br> `400`: 내용 누락 등. <br> `401`: 미인증. <br> `404`: 대화가 존재하지 않음. |
358
- | **/v1/graph/nodes** | `POST` | `201` | `400`, `401`, `409` | 그래프 노드를 생성합니다. <br> `400`: 필수 필드 누락. <br> `401`: 미인증. <br> `409`: 노드 ID 중복. |
359
- | | `GET` | `200` | `401` | 모든 그래프 노드를 조회합니다. <br> `401`: 미인증. |
360
- | **/v1/graph/nodes/{id}** | `GET` | `200` | `401`, `404` | 단일 노드를 조회합니다. <br> `401`: 미인증. <br> `404`: 노드 없음. |
361
- | | `PATCH` | `204` | `400`, `401`, `404` | 노드를 업데이트합니다. <br> `400`: 입력값 오류. <br> `401`: 미인증. <br> `404`: 노드 없음. |
362
- | | `DELETE` | `204` | `401`, `404` | 노드를 삭제합니다. <br> `401`: 미인증. <br> `404`: 노드 없음. |
363
- | **/v1/graph/edges** | `POST` | `201` | `400`, `401` | 그래프 엣지를 생성합니다. <br> `400`: Source/Target 노드 ID 오류. <br> `401`: 미인증. |
364
- | | `GET` | `200` | `401` | 모든 그래프 엣지를 조회합니다. <br> `401`: 미인증. |
365
- | | `DELETE` | `204` | `401`, `404` | 엣지를 삭제합니다. <br> `401`: 미인증. <br> `404`: 엣지 없음. |
366
- | **/v1/notes** | `POST` | `201` | `400`, `401` | 노트를 생성합니다. <br> `400`: 제목/내용 누락. <br> `401`: 미인증. |
367
- | | `GET` | `200` | `401` | 모든 노트를 조회합니다. <br> `401`: 미인증. |
368
- | **/v1/notes/{id}** | `GET` | `200` | `401`, `404` | 단일 노트를 조회합니다. <br> `401`: 미인증. <br> `404`: 노트 없음. |
369
- | | `PATCH` | `200` | `400`, `401`, `404` | 노트를 업데이트합니다. <br> `400`: 입력값 오류. <br> `401`: 미인증. <br> `404`: 노트 없음. |
370
- | | `DELETE` | `204` | `401`, `404` | 노트를 삭제합니다. <br> `401`: 미인증. <br> `404`: 노트 없음. |
371
- | **/v1/folders** | `POST` | `201` | `400`, `401` | 폴더를 생성합니다. <br> `400`: 이름 누락. <br> `401`: 미인증. |
372
- | | `GET` | `200` | `401` | 모든 폴더를 조회합니다. <br> `401`: 미인증. |
373
- | **/v1/sync/pull** | `GET` | `200` | `400`, `401` | 변경 사항을 가져옵니다. <br> `400`: `since` 파라미터 형식 오류. <br> `401`: 미인증. |
374
- | **/v1/sync/push** | `POST` | `204` | `400`, `401`, `409` | 변경 사항을 푸시합니다. <br> `400`: 데이터 형식 오류. <br> `401`: 미인증. <br> `409`: 데이터 버전 충돌 (클라이언트가 구버전 데이터 수정 시도). |
375
- | **/v1/graph-ai/generate** | `POST` | `202` | `401`, `409` | 그래프 생성 요청을 시작합니다. <br> `401`: 미인증. <br> `409`: 이미 진행 중인 작업이 있음. |
376
- | **/v1/graph-ai/test/generate-json** | `POST` | `202` | `400` | [테스트용] JSON 기반 그래프 생성 요청. <br> `400`: JSON 형식이 잘못되었거나 필수 필드 누락. |
377
-
1
+ # GraphNode SDK for Frontend
2
+
3
+ > **TACO 4기 - GraphNode 서비스 프론트엔드 연동 SDK**
4
+
5
+ GraphNode 백엔드 API를 타입 안전(Type-Safe)하게 사용할 수 있도록 제공되는 공식 클라이언트 라이브러리입니다.
6
+
7
+ ## 📦 설치 (Installation)
8
+
9
+ ```bash
10
+ npm install @taco_tsinghua/graphnode-sdk
11
+ ```
12
+
13
+ *(현재는 모노레포 내부 패키지로 관리되고 있습니다.)*
14
+
15
+ ## 🚀 시작하기 (Getting Started)
16
+
17
+ ### 클라이언트 초기화
18
+
19
+ API 요청을 보내기 위해 `GraphNodeClient`를 초기화해야 합니다. 기본적으로 서버와의 세션(Cookie) 인증을 사용하므로 `credentials: 'include'` 옵션이 내장되어 있습니다.
20
+
21
+ ```typescript
22
+ import { createGraphNodeClient } from 'graphnode-sdk';
23
+
24
+ // 기본 설정으로 클라이언트 생성 (localhost:3000 기준)
25
+ const client = createGraphNodeClient({
26
+ baseUrl: 'http://localhost:3000' // 배포 환경에 따라 URL 변경
27
+ });
28
+ ```
29
+
30
+ ---
31
+
32
+ ## 📚 API Reference
33
+
34
+ ### 1. 인증 (Authentication)
35
+
36
+ | Method | Endpoint | Description | Status Codes |
37
+ | :--- | :--- | :--- | :--- |
38
+ | `client.me.getMe()` | `GET /v1/me` | 현재 로그인한 사용자 정보 조회 | `200` OK<br>`401` Unauth |
39
+ | `client.auth.google.getStartUrl()` | - | Google 로그인 시작 URL 반환 | - |
40
+ | `client.auth.apple.getStartUrl()` | - | Apple 로그인 시작 URL 반환 | - |
41
+ | `client.auth.logout()` | `POST /auth/logout` | 로그아웃 (세션 쿠키 삭제) | `204` Destroyed<br>`401` Unauth |
42
+
43
+ ### 2. AI 대화 (AI Chat)
44
+
45
+ | Method | Endpoint | Description | Status Codes |
46
+ | :--- | :--- | :--- | :--- |
47
+ | `client.ai.createConversation()` | `POST /v1/ai/conversations` | 새로운 대화방 생성 | `201` Created<br>`400` Bad Request |
48
+ | `client.ai.listConversations()` | `GET /v1/ai/conversations` | 대화방 목록 조회 | `200` OK |
49
+ | `client.ai.chat(convId, dto)` | `POST /v1/ai/conversations/:id/chat` | 메시지 전송 (파일 첨부 가능) | `200` OK<br>`400` Bad Req<br>`401` Unauth<br>`502` Upstream |
50
+ | `openAgentChatStream()` | `POST /v1/agent/stream` | 실시간 에이전트 스트리밍 (SSE) | `200` OK (Stream) |
51
+
52
+ ### 3. 그래프 AI (Graph AI)
53
+
54
+ | Method | Endpoint | Description | Status Codes |
55
+ | :--- | :--- | :--- | :--- |
56
+ | `client.graphAi.generateGraph()` | `POST /v1/graph-ai/generate` | 그래프 생성 요청 (Async Task) | `202` Accepted<br>`401` Unauth<br>`409` Conflict |
57
+ | `client.graphAi.requestSummary()` | `POST /v1/graph-ai/summary` | 그래프 요약 생성 요청 (Async Task) | `202` Accepted<br>`401` Unauth<br>`409` Conflict |
58
+ | `client.graphAi.getSummary()` | `GET /v1/graph-ai/summary` | 생성된 그래프 요약 조회 | `200` OK<br>`404` Not Found |
59
+
60
+ ### 4. 그래프 관리 (Graph Knowledge)
61
+
62
+ | Method | Endpoint | Description | Status Codes |
63
+ | :--- | :--- | :--- | :--- |
64
+ | `client.graph.listNodes()` | `GET /v1/graph/nodes` | 노드 목록 조회 | `200` OK<br>`401` Unauth |
65
+ | `client.graph.createNode()` | `POST /v1/graph/nodes` | 노드 생성 | `201` Created<br>`400` Bad Req |
66
+ | `client.graph.getNode(id)` | `GET /v1/graph/nodes/:id` | 노드 상세 조회 | `200` OK<br>`404` Not Found |
67
+ | `client.graph.updateNode()` | `PATCH /v1/graph/nodes/:id` | 노드 수정 | `204` Updated<br>`404` Not Found |
68
+ | `client.graph.deleteNode()` | `DELETE /v1/graph/nodes/:id` | 노드 삭제 | `204` Deleted<br>`401` Unauth |
69
+ | `client.graph.createEdge()` | `POST /v1/graph/edges` | 엣지 생성 | `201` Created<br>`400` Bad Req |
70
+ | `client.graph.getSnapshot()` | `GET /v1/graph/snapshot` | 전체 그래프 데이터 스냅샷 조회 | `200` OK<br>`401` Unauth |
71
+
72
+ ### 5. 노트 관리 (Notes & Folders)
73
+
74
+ | Method | Endpoint | Description | Status Codes |
75
+ | :--- | :--- | :--- | :--- |
76
+ | `client.note.createFolder()` | `POST /v1/folders` | 폴더 생성 | `201` Created<br>`400` Bad Req |
77
+ | `client.note.createNote()` | `POST /v1/notes` | 노트 생성 | `201` Created<br>`400` Bad Req |
78
+ | `client.note.listNotes()` | `GET /v1/notes` | 노트 목록 조회 | `200` OK<br>`401` Unauth |
79
+ | `client.note.updateNote()` | `PATCH /v1/notes/:id` | 노트 수정 | `200` OK<br>`404` Not Found |
80
+
81
+ ### 6. 동기화 (Sync)
82
+
83
+ 오프라인 우선(Offline-first) 아키텍처 지원을 위한 변경사항 동기화 API.
84
+
85
+ | Method | Endpoint | Description | Status Codes |
86
+ | :--- | :--- | :--- | :--- |
87
+ | `client.sync.pull()` | `GET /v1/sync/pull` | 서버 변경사항 가져오기 | `200` OK<br>`400` Bad Req |
88
+ | `client.sync.push()` | `POST /v1/sync/push` | 클라이언트 변경사항 반영 | `200` OK<br>`400` Bad Req<br>`502` Upstream |
89
+
90
+ ---
91
+
92
+ ## 💡 주요 타입 정의 (Types)
93
+
94
+ ### GraphSummaryDto
95
+ ```typescript
96
+ interface GraphSummaryDto {
97
+ overview: {
98
+ total_conversations: number;
99
+ summary_text: string;
100
+ ...
101
+ };
102
+ clusters: Array<{ name: string; insight_text: string; ... }>;
103
+ patterns: Array<{ pattern_type: string; description: string; ... }>;
104
+ connections: Array<{ source_cluster: string; target_cluster: string; ... }>;
105
+ recommendations: Array<{ title: string; priority: string; ... }>;
106
+ }
107
+ ```
108
+
109
+ ### SyncPushRequest
110
+ ```typescript
111
+ interface SyncPushRequest {
112
+ conversations?: ConversationDto[];
113
+ messages?: MessageDto[];
114
+ notes?: NoteDto[];
115
+ folders?: FolderDto[];
116
+ }
117
+ ```
118
+
119
+ ---
120
+
121
+ ## 🛠️ Error Handling
122
+
123
+ API 요청 실패 `HttpError`가 발생하며, 백엔드의 `ProblemDetails` 규격(`RFC 9457`)을 따릅니다.
124
+
125
+ ```typescript
126
+ try {
127
+ await client.note.createNote({ ... });
128
+ } catch (err) {
129
+ if (err.name === 'HttpError') {
130
+ // 400 Bad Request 등의 경우
131
+ console.error('Status:', err.response.status);
132
+ console.error('Problem:', err.response.data); // { type, title, detail, ... }
133
+ }
134
+ }
135
+ ```
136
+
137
+ ## 📝 License
138
+
139
+ This SDK is proprietary software of the TACO 4 Team.
package/dist/client.d.ts CHANGED
@@ -15,8 +15,10 @@ import { AiApi } from './endpoints/ai.js';
15
15
  * @property fetch 커스텀 fetch 함수 (선택)
16
16
  * @property headers 기본 헤더 (선택)
17
17
  * @property credentials 인증 모드 (include | omit | same-origin)
18
+ * @property accessToken 초기 Access Token (선택)
18
19
  */
19
- export interface GraphNodeClientOptions extends Omit<BuilderOptions, 'baseUrl'> {
20
+ export interface GraphNodeClientOptions extends Omit<BuilderOptions, 'baseUrl' | 'accessToken'> {
21
+ accessToken?: string | null;
20
22
  }
21
23
  /**
22
24
  * GraphNode API 클라이언트
@@ -44,7 +46,13 @@ export declare class GraphNodeClient {
44
46
  readonly sync: SyncApi;
45
47
  readonly ai: AiApi;
46
48
  private readonly rb;
49
+ private _accessToken;
47
50
  constructor(opts?: GraphNodeClientOptions);
51
+ /**
52
+ * Access Token을 설정합니다.
53
+ * @param token JWT Access Token 또는 null (로그아웃 시)
54
+ */
55
+ setAccessToken(token: string | null): void;
48
56
  }
49
57
  /**
50
58
  * GraphNode 클라이언트 인스턴스를 생성합니다.
@@ -1 +1 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,KAAK,cAAc,EAAkB,MAAM,mBAAmB,CAAC;AAE9F,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,WAAW,sBAAuB,SAAQ,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC;CAAG;AAElF;;;;;;;;;;;;;GAaG;AACH,qBAAa,eAAe;IAC1B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IACnB,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC;IACzC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IACnB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAiB;gBAExB,IAAI,GAAE,sBAA2B;CA+B9C;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,CAAC,EAAE,sBAAsB,GAAG,eAAe,CAEpF"}
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,KAAK,cAAc,EAAkB,MAAM,mBAAmB,CAAC;AAE9F,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE1C;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAuB,SAAQ,IAAI,CAAC,cAAc,EAAE,SAAS,GAAG,aAAa,CAAC;IAC7F,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,eAAe;IAC1B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IACnB,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC;IACzC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IACnB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAiB;IACpC,OAAO,CAAC,YAAY,CAAuB;gBAE/B,IAAI,GAAE,sBAA2B;IAmC7C;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;CAGpC;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,CAAC,EAAE,sBAAsB,GAAG,eAAe,CAEpF"}
package/dist/client.js CHANGED
@@ -26,6 +26,7 @@ import { AiApi } from './endpoints/ai.js';
26
26
  */
27
27
  export class GraphNodeClient {
28
28
  constructor(opts = {}) {
29
+ this._accessToken = null;
29
30
  let fetchFn = opts.fetch;
30
31
  if (!fetchFn) {
31
32
  if (typeof window !== 'undefined' && window.fetch) {
@@ -38,11 +39,13 @@ export class GraphNodeClient {
38
39
  fetchFn = globalThis.fetch.bind(globalThis);
39
40
  }
40
41
  }
42
+ this._accessToken = opts.accessToken ?? null;
41
43
  // 내부 고정 baseUrl 사용, FE는 fetch/headers/credentials 정도만 선택 주입 가능
42
44
  this.rb = createRequestBuilder({
43
45
  baseUrl: GRAPHNODE_BASE_URL,
44
46
  ...opts,
45
47
  fetch: fetchFn, // 바인딩된 fetch 주입
48
+ accessToken: () => this._accessToken, // 동적 토큰 주입을 위한 함수 전달
46
49
  });
47
50
  this.health = new HealthApi(this.rb);
48
51
  this.me = new MeApi(this.rb);
@@ -55,6 +58,13 @@ export class GraphNodeClient {
55
58
  this.sync = new SyncApi(this.rb);
56
59
  this.ai = new AiApi(this.rb);
57
60
  }
61
+ /**
62
+ * Access Token을 설정합니다.
63
+ * @param token JWT Access Token 또는 null (로그아웃 시)
64
+ */
65
+ setAccessToken(token) {
66
+ this._accessToken = token;
67
+ }
58
68
  }
59
69
  /**
60
70
  * GraphNode 클라이언트 인스턴스를 생성합니다.
@@ -1 +1 @@
1
- {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAuB,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC9F,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAW1C;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,eAAe;IAa1B,YAAY,OAA+B,EAAE;QAC3C,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;QAEzB,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAClD,iCAAiC;gBACjC,0DAA0D;gBAC1D,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtC,CAAC;iBAAM,IAAI,OAAO,UAAU,KAAK,WAAW,IAAK,UAAkB,CAAC,KAAK,EAAE,CAAC;gBAC1E,4BAA4B;gBAC5B,OAAO,GAAI,UAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAED,+DAA+D;QAC/D,IAAI,CAAC,EAAE,GAAG,oBAAoB,CAAC;YAC7B,OAAO,EAAE,kBAAkB;YAC3B,GAAG,IAAI;YACP,KAAK,EAAE,OAAO,EAAE,gBAAgB;SACjC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrC,IAAI,CAAC,EAAE,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CAAC,kBAAkB,CAAC,CAAC;QACxD,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,YAAY,CAAC,kBAAkB,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAA6B;IACjE,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC"}
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAuB,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC9F,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAc1C;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,eAAe;IAc1B,YAAY,OAA+B,EAAE;QAFrC,iBAAY,GAAkB,IAAI,CAAC;QAGzC,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;QAEzB,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAClD,iCAAiC;gBACjC,0DAA0D;gBAC1D,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtC,CAAC;iBAAM,IAAI,OAAO,UAAU,KAAK,WAAW,IAAK,UAAkB,CAAC,KAAK,EAAE,CAAC;gBAC1E,4BAA4B;gBAC5B,OAAO,GAAI,UAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC;QAE7C,+DAA+D;QAC/D,IAAI,CAAC,EAAE,GAAG,oBAAoB,CAAC;YAC7B,OAAO,EAAE,kBAAkB;YAC3B,GAAG,IAAI;YACP,KAAK,EAAE,OAAO,EAAE,gBAAgB;YAChC,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,qBAAqB;SAC5D,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrC,IAAI,CAAC,EAAE,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CAAC,kBAAkB,CAAC,CAAC;QACxD,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,YAAY,CAAC,kBAAkB,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,KAAoB;QACjC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAA6B;IACjE,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC"}