@reopt-ai/brandapp-sdk 3.3.0 → 3.5.0

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 (104) hide show
  1. package/CHANGELOG.md +115 -0
  2. package/README.md +10 -1
  3. package/dist/abort--nOBFN4M.js +50 -0
  4. package/dist/ai/index.d.ts +2 -314
  5. package/dist/ai/index.js +3 -8
  6. package/dist/ai-provider/index.d.ts +79 -163
  7. package/dist/ai-provider/index.js +752 -685
  8. package/dist/auth/index.d.ts +27 -27
  9. package/dist/auth/index.js +41 -34
  10. package/dist/better-auth/client.d.ts +6 -5
  11. package/dist/better-auth/client.js +28 -5
  12. package/dist/better-auth/index.d.ts +19 -17
  13. package/dist/better-auth/index.js +180 -144
  14. package/dist/client-61ldOHMz.js +503 -0
  15. package/dist/client-7PCoxVhZ.js +28 -0
  16. package/dist/client-B7rZQ8Zi.d.ts +272 -0
  17. package/dist/client-BGGd_cpV.d.ts +103 -0
  18. package/dist/client-BoIuyx4S.js +273 -0
  19. package/dist/client-BruP5_nU.d.ts +147 -0
  20. package/dist/client-BxtZt405.js +305 -0
  21. package/dist/client-ByN3EQdk.js +83 -0
  22. package/dist/client-CAghoGD_.js +53 -0
  23. package/dist/client-C_pHsPlj.js +81 -0
  24. package/dist/client-D0eBxh8j.d.ts +284 -0
  25. package/dist/client-D6gs61w8.d.ts +53 -0
  26. package/dist/client-DDw5yz_h.d.ts +53 -0
  27. package/dist/client-Dxg8_DIH.d.ts +71 -0
  28. package/dist/client-aMR4CRB8.d.ts +211 -0
  29. package/dist/client-lk6wBu_0.d.ts +48 -0
  30. package/dist/client-wEVKLdly.js +55 -0
  31. package/dist/client-zF1RG2uA.js +86 -0
  32. package/dist/cms/index.d.ts +52 -108
  33. package/dist/cms/index.js +103 -86
  34. package/dist/config-CRytOPPl.d.ts +394 -0
  35. package/dist/config-aml9oQpX.js +487 -0
  36. package/dist/dev/index.d.ts +2 -528
  37. package/dist/dev/index.js +3047 -2967
  38. package/dist/eav/coerce.d.ts +3 -1
  39. package/dist/eav/coerce.js +72 -46
  40. package/dist/eav/index.d.ts +72 -100
  41. package/dist/eav/index.js +158 -126
  42. package/dist/eav/migrate.d.ts +112 -109
  43. package/dist/eav/migrate.js +230 -196
  44. package/dist/eav/schema.d.ts +111 -150
  45. package/dist/eav/schema.js +624 -603
  46. package/dist/encoding-Bwfm3iaE.js +21 -0
  47. package/dist/{errors-BjDFIyA6.d.ts → errors-CRCcErNC.d.ts} +55 -53
  48. package/dist/feedback/index.d.ts +2 -132
  49. package/dist/feedback/index.js +3 -6
  50. package/dist/files/index.d.ts +14 -14
  51. package/dist/files/index.js +41 -25
  52. package/dist/http-client-BZc2mngq.js +386 -0
  53. package/dist/index-1j_738qk.d.ts +470 -0
  54. package/dist/index-CeOLGdyL.d.ts +169 -0
  55. package/dist/index.d.ts +6 -230
  56. package/dist/index.js +119 -71
  57. package/dist/logout/index.d.ts +56 -53
  58. package/dist/logout/index.js +232 -289
  59. package/dist/plans/index.d.ts +2 -236
  60. package/dist/plans/index.js +3 -6
  61. package/dist/push/index.d.ts +2 -79
  62. package/dist/push/index.js +3 -6
  63. package/dist/query-xWqtfkvR.js +35 -0
  64. package/dist/react/hooks.d.ts +157 -100
  65. package/dist/react/hooks.js +862 -406
  66. package/dist/sse-parser-FMjxM7sY.js +86 -0
  67. package/dist/terms/index.d.ts +3 -79
  68. package/dist/terms/index.js +3 -6
  69. package/dist/testing/index.d.ts +52 -104
  70. package/dist/testing/index.js +94 -72
  71. package/dist/types-B-SMkH6s.d.ts +26 -0
  72. package/dist/types-BXDcoJHG.d.ts +131 -0
  73. package/dist/types-BrghN2rJ.d.ts +105 -0
  74. package/dist/types-DjDRszNj.js +11 -0
  75. package/dist/webhooks/index.d.ts +77 -50
  76. package/dist/webhooks/index.js +150 -127
  77. package/docs/api-reference.md +121 -8
  78. package/docs/errors.md +19 -0
  79. package/docs/files.md +165 -7
  80. package/package.json +7 -6
  81. package/dist/chunk-2LSCQHAU.js +0 -21
  82. package/dist/chunk-4U4ZPPL4.js +0 -599
  83. package/dist/chunk-55KHY5GH.js +0 -96
  84. package/dist/chunk-C5VTRZWX.js +0 -458
  85. package/dist/chunk-F7BXBTZI.js +0 -54
  86. package/dist/chunk-FJUCWXX3.js +0 -350
  87. package/dist/chunk-H33OTQEN.js +0 -112
  88. package/dist/chunk-L4DHB36G.js +0 -75
  89. package/dist/chunk-OG7R3UAR.js +0 -105
  90. package/dist/chunk-PF24XU54.js +0 -32
  91. package/dist/chunk-QN3QD67K.js +0 -49
  92. package/dist/chunk-REIKXSMY.js +0 -7
  93. package/dist/chunk-UGBBXCZE.js +0 -157
  94. package/dist/chunk-UVT2E6KD.js +0 -81
  95. package/dist/chunk-YPLT3RFL.js +0 -63
  96. package/dist/chunk-YTKSAWV2.js +0 -463
  97. package/dist/client-BkcO-0C2.d.ts +0 -216
  98. package/dist/client-CN5_tNOC.d.ts +0 -147
  99. package/dist/client-DttyeM_h.d.ts +0 -102
  100. package/dist/config-CtxyJsDR.d.ts +0 -397
  101. package/dist/typed-client-BxOVIiMU.d.ts +0 -40
  102. package/dist/types-6E3ZLL9X.d.ts +0 -24
  103. package/dist/types-DskYLVb8.d.ts +0 -104
  104. package/dist/types-ckmDDW3N.d.ts +0 -129
package/docs/files.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # File Management API
2
2
 
3
- BrandApp SDK의 파일 관리 모듈로, 파일 목록 조회, 단건 조회, 업로드, 삭제를 지원합니다.
3
+ BrandApp SDK의 파일 관리 모듈로, 파일 목록 조회, 단건 조회, 업로드, 이름 변경·폴더
4
+ 이동, 텍스트 내용 읽기, 삭제와 폴더 CRUD(3.5+), 저장공간 사용량 조회를 지원합니다.
4
5
 
5
6
  ## Entry Point
6
7
 
@@ -23,7 +24,8 @@ import {
23
24
  const { data: files, meta } = await sdk.files.list({
24
25
  page: 1,
25
26
  limit: 20,
26
- contentType: "image/*", // MIME 타입 필터
27
+ contentType: "image/*", // MIME 타입 필터 — 정확 일치 또는 "type/*" 와일드카드
28
+ folderId: folder.id, // 폴더 필터 — 미지정=전체, null=루트만, id=해당 폴더 직속
27
29
  sortBy: "createdAt", // "createdAt" | "name" | "size"
28
30
  sortOrder: "desc", // "asc" | "desc"
29
31
  });
@@ -32,6 +34,10 @@ console.log(`Total files: ${meta.total}`);
32
34
  files.forEach((f) => console.log(f.name, f.url));
33
35
  ```
34
36
 
37
+ > `contentType` 와일드카드는 서버 3.5+에서 prefix 매치로 동작한다
38
+ > (`"image/*"` → `image/`로 시작하는 모든 타입). 구버전 서버는 정확 일치만
39
+ > 지원했다.
40
+
35
41
  ### `sdk.files.get(fileId)`
36
42
 
37
43
  단일 파일 정보를 조회합니다.
@@ -73,6 +79,45 @@ const uploaded = await sdk.files.upload(buf, {
73
79
  | ------------- | -------- | ----------------------------------- |
74
80
  | `name` | `string` | 파일명 (미지정 시 원본 파일명 사용) |
75
81
  | `contentType` | `string` | MIME 타입 (미지정 시 자동 감지) |
82
+ | `folderId` | `string` | 업로드할 폴더 (미지정 시 루트) |
83
+
84
+ ### `sdk.files.update(fileId, input)` (3.5+)
85
+
86
+ 파일 이름을 바꾸거나 폴더로 이동합니다. `name`은 표시명만 바꾸며 저장 경로
87
+ (`pathname`)와 URL은 불변입니다.
88
+
89
+ ```typescript
90
+ await sdk.files.update(fileId, { name: "renamed.png" });
91
+ await sdk.files.update(fileId, { folderId: folder.id }); // 폴더로 이동
92
+ await sdk.files.update(fileId, { folderId: null }); // 루트로 이동
93
+ ```
94
+
95
+ ### `sdk.files.readContent(fileId)` (3.5+)
96
+
97
+ 텍스트 파일의 내용을 문자열로 읽습니다 (미리보기용). 텍스트 계열
98
+ (`text/*`, `application/json`, `application/yaml` 등)만 지원하며, 그 외 타입은
99
+ 415(`UNSUPPORTED_CONTENT_TYPE`), 1MB 초과 파일은 413(`CONTENT_TOO_LARGE`)으로
100
+ 거부됩니다.
101
+
102
+ ```typescript
103
+ const text = await sdk.files.readContent(fileId);
104
+ ```
105
+
106
+ ### `sdk.files.usage()` (3.5+)
107
+
108
+ 저장공간 사용량을 조회합니다 — 파일 매니저의 사용량 미터·"한도 임박" 경고용.
109
+
110
+ ```typescript
111
+ const { usedBytes, limitBytes, fileCount } = await sdk.files.usage();
112
+ if (limitBytes != null && usedBytes / limitBytes > 0.9) {
113
+ console.warn("저장공간이 거의 찼습니다");
114
+ }
115
+ ```
116
+
117
+ - `usedBytes` / `limitBytes`는 **워크스페이스 단위** — 초과 업로드를 거부하는
118
+ 402 `STORAGE_LIMIT` 판정과 동일한 소스를 읽으므로 미터와 실제 거부가 어긋나지
119
+ 않습니다. `limitBytes: null`은 무제한 플랜.
120
+ - `fileCount`는 이 brandapp 스코프의 파일 수.
76
121
 
77
122
  ### `sdk.files.delete(fileId)`
78
123
 
@@ -82,6 +127,56 @@ const uploaded = await sdk.files.upload(buf, {
82
127
  await sdk.files.delete("file-uuid");
83
128
  ```
84
129
 
130
+ 파일이 브랜드프론트 페이지·이메일 등에서 사용 중이면 409 `FILE_IN_USE`로
131
+ 거부되며, 메시지에 사용처가 담깁니다 (UI에 그대로 표면화 가능).
132
+
133
+ ## Folders (3.5+)
134
+
135
+ 폴더 계층으로 파일을 정리할 수 있습니다. 폴더는 brandapp 스코프에 격리됩니다.
136
+
137
+ ### `sdk.files.listFolders(query?)`
138
+
139
+ 직속 자식 폴더 목록을 조회합니다. `parentId` 미지정(또는 `null`)이면 루트.
140
+
141
+ ```typescript
142
+ const rootFolders = await sdk.files.listFolders();
143
+ const children = await sdk.files.listFolders({ parentId: folder.id });
144
+ // FolderInfo: { id, name, parentId, childCount, fileCount, createdAt, updatedAt }
145
+ ```
146
+
147
+ ### `sdk.files.createFolder(input)`
148
+
149
+ ```typescript
150
+ const folder = await sdk.files.createFolder({ name: "invoices" });
151
+ const child = await sdk.files.createFolder({
152
+ name: "2026",
153
+ parentId: folder.id,
154
+ });
155
+ ```
156
+
157
+ 같은 위치에 동명 폴더가 있으면 409 `CONFLICT`.
158
+
159
+ ### `sdk.files.updateFolder(folderId, input)`
160
+
161
+ 이름 변경 + 이동을 겸합니다. 폴더를 자기 자신 또는 자손 밑으로 옮기는 요청은
162
+ 400으로 거부됩니다 (cycle 방지).
163
+
164
+ ```typescript
165
+ await sdk.files.updateFolder(folderId, { name: "archive" });
166
+ await sdk.files.updateFolder(folderId, { parentId: otherFolder.id });
167
+ await sdk.files.updateFolder(folderId, { parentId: null }); // 루트로
168
+ ```
169
+
170
+ ### `sdk.files.deleteFolder(folderId)`
171
+
172
+ 폴더를 삭제합니다. **비어있어야 합니다** — 파일이나 하위 폴더가 남아 있으면
173
+ 409 `FOLDER_NOT_EMPTY`(메시지에 남은 개수 포함)로 거부되므로, 내용물을 먼저
174
+ 이동/삭제하세요.
175
+
176
+ ```typescript
177
+ await sdk.files.deleteFolder(folderId);
178
+ ```
179
+
85
180
  ## Image Generation + File Management Workflow
86
181
 
87
182
  AI 이미지 생성 결과를 파일로 관리하는 워크플로우:
@@ -123,22 +218,44 @@ import {
123
218
  useFiles,
124
219
  useFile,
125
220
  useUploadFile,
221
+ useUpdateFile,
126
222
  useDeleteFile,
223
+ useFolders,
224
+ useCreateFolder,
225
+ useUpdateFolder,
226
+ useDeleteFolder,
227
+ useFileUsage,
127
228
  } from "@reopt-ai/brandapp-sdk/react/hooks";
128
229
 
129
- // 파일 목록 조회
130
- const { data } = useFiles(sdk, { contentType: "image/*" });
230
+ // 파일 목록 조회 (폴더별)
231
+ const { data } = useFiles(sdk, { folderId: folder.id });
131
232
 
132
233
  // 단일 파일 조회
133
234
  const { data: file } = useFile(sdk, fileId);
134
235
 
135
- // 파일 업로드
236
+ // 파일 업로드 (성공 시 files/folders/usage 캐시 자동 무효화)
136
237
  const upload = useUploadFile(sdk);
137
- await upload.mutateAsync({ file: blob, options: { name: "banner.png" } });
238
+ await upload.mutateAsync({
239
+ file: blob,
240
+ options: { name: "banner.png", folderId: folder.id },
241
+ });
242
+
243
+ // 파일 rename/move
244
+ const update = useUpdateFile(sdk);
245
+ await update.mutateAsync({ fileId, input: { name: "renamed.png" } });
138
246
 
139
247
  // 파일 삭제
140
248
  const deleteFile = useDeleteFile(sdk);
141
249
  await deleteFile.mutateAsync("file-uuid");
250
+
251
+ // 폴더
252
+ const { data: folders } = useFolders(sdk); // 루트
253
+ const createFolder = useCreateFolder(sdk);
254
+ const updateFolder = useUpdateFolder(sdk);
255
+ const deleteFolder = useDeleteFolder(sdk);
256
+
257
+ // 저장공간 사용량
258
+ const { data: usage } = useFileUsage(sdk);
142
259
  ```
143
260
 
144
261
  ## Error Handling
@@ -157,6 +274,9 @@ try {
157
274
  case "FILE_TOO_LARGE":
158
275
  console.log("파일 크기 제한 초과");
159
276
  break;
277
+ case "STORAGE_LIMIT":
278
+ console.log("저장공간 한도 초과 (402) — usage()로 사전 확인 가능");
279
+ break;
160
280
  case "UPLOAD_FAILED":
161
281
  console.log("업로드 실패:", e.message);
162
282
  break;
@@ -168,6 +288,20 @@ try {
168
288
  }
169
289
  ```
170
290
 
291
+ 주요 도메인 에러 코드:
292
+
293
+ | Code | Status | 발생 지점 |
294
+ | -------------------------- | ------ | ---------------------------------------------------------------- |
295
+ | `STORAGE_LIMIT` | 402 | 업로드 — 플랜 저장공간 한도 초과 (`usage()`로 사전 확인) |
296
+ | `FILE_IN_USE` | 409 | 파일 삭제 — 브랜드프론트·이메일 등에서 사용 중 (메시지에 사용처) |
297
+ | `FOLDER_NOT_EMPTY` | 409 | 폴더 삭제 — 파일/하위 폴더가 남아 있음 |
298
+ | `CONFLICT` | 409 | 폴더 생성/이동 — 같은 위치에 동명 폴더 존재 |
299
+ | `UNSUPPORTED_CONTENT_TYPE` | 415 | `readContent` — 텍스트 계열이 아닌 파일 |
300
+ | `CONTENT_TOO_LARGE` | 413 | `readContent` — 1MB 초과 |
301
+
302
+ `STORAGE_LIMIT`·`FILE_IN_USE`의 메시지는 사람이 읽을 수 있는 형태라 UI에 그대로
303
+ 표면화해도 됩니다.
304
+
171
305
  ## Types
172
306
 
173
307
  ```typescript
@@ -178,6 +312,7 @@ type FileInfo = {
178
312
  size: number;
179
313
  contentType: string | null;
180
314
  pathname: string;
315
+ folderId?: string | null; // 3.5+ — 루트면 null
181
316
  createdAt: string;
182
317
  updatedAt: string;
183
318
  };
@@ -185,7 +320,8 @@ type FileInfo = {
185
320
  type FileListQuery = {
186
321
  page?: number;
187
322
  limit?: number;
188
- contentType?: string;
323
+ contentType?: string; // "image/png" | "image/*"
324
+ folderId?: string | null; // 미지정=전체, null=루트만
189
325
  sortBy?: "createdAt" | "name" | "size";
190
326
  sortOrder?: "asc" | "desc";
191
327
  };
@@ -198,6 +334,28 @@ type FileListResponse = {
198
334
  type UploadOptions = {
199
335
  name?: string;
200
336
  contentType?: string;
337
+ folderId?: string;
338
+ };
339
+
340
+ type UpdateFileInput = {
341
+ name?: string;
342
+ folderId?: string | null;
343
+ };
344
+
345
+ type FolderInfo = {
346
+ id: string;
347
+ name: string;
348
+ parentId: string | null;
349
+ childCount: number;
350
+ fileCount: number;
351
+ createdAt: string;
352
+ updatedAt: string;
353
+ };
354
+
355
+ type FileUsageInfo = {
356
+ usedBytes: number; // 워크스페이스 전체
357
+ limitBytes: number | null; // null = 무제한
358
+ fileCount: number; // 이 brandapp 스코프
201
359
  };
202
360
  ```
203
361
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@reopt-ai/brandapp-sdk",
3
- "version": "3.3.0",
3
+ "version": "3.5.0",
4
4
  "description": "Reopt Brandapp SDK — Better Auth adapter, OAuth login, and EAV client",
5
5
  "author": "Reopt",
6
6
  "license": "MIT",
@@ -136,14 +136,15 @@
136
136
  }
137
137
  },
138
138
  "devDependencies": {
139
- "@ai-sdk/provider": "4.0.0",
139
+ "@ai-sdk/provider": "4.0.4",
140
140
  "@reopt-ai/opt-editor": "1.1.2",
141
141
  "@testing-library/react": "^16.3.2",
142
+ "@types/node": "22.13.9",
142
143
  "better-auth": "^1.4.0",
143
144
  "happy-dom": "^20.8.9",
144
145
  "hono": "^4.7.0",
145
- "tsup": "^8.0.0",
146
- "typescript": "5.9.2",
146
+ "tsdown": "^0.22.14",
147
+ "typescript": "^7",
147
148
  "vitest": "^4.1.2",
148
149
  "@reopt/typescript-config": "0.0.0"
149
150
  },
@@ -167,8 +168,8 @@
167
168
  "node": ">=18"
168
169
  },
169
170
  "scripts": {
170
- "build": "tsup",
171
- "dev": "tsup --watch",
171
+ "build": "tsdown",
172
+ "dev": "tsdown --watch",
172
173
  "type-check": "tsc --noEmit",
173
174
  "test": "vitest run",
174
175
  "test:coverage": "vitest run --coverage",
@@ -1,21 +0,0 @@
1
- // src/core/encoding.ts
2
- function encodeBase64(str) {
3
- const bytes = new TextEncoder().encode(str);
4
- const binString = Array.from(bytes, (b) => String.fromCodePoint(b)).join("");
5
- return btoa(binString);
6
- }
7
- function createBasicAuthHeader(clientId, clientSecret) {
8
- return `Basic ${encodeBase64(`${clientId}:${clientSecret}`)}`;
9
- }
10
- function createAuthHeader(config) {
11
- const token = config.token?.trim();
12
- if (token) return `Bearer ${token}`;
13
- return createBasicAuthHeader(
14
- config.clientId ?? "",
15
- config.clientSecret ?? ""
16
- );
17
- }
18
-
19
- export { createAuthHeader };
20
- //# sourceMappingURL=chunk-2LSCQHAU.js.map
21
- //# sourceMappingURL=chunk-2LSCQHAU.js.map