@lumir-company/editor 0.4.10 → 0.4.11

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.
package/README.md CHANGED
@@ -1,1506 +1,1511 @@
1
- # LumirEditor
2
-
3
- **이미지 전용** BlockNote 기반 Rich Text 에디터
4
-
5
- [![npm version](https://img.shields.io/npm/v/@lumir-company/editor.svg)](https://www.npmjs.com/package/@lumir-company/editor)
6
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
-
8
- > 이미지 업로드에 최적화된 경량 에디터. S3 업로드, 파일명 커스터마이징, 로딩 스피너 내장.
9
-
10
- ---
11
-
12
- ## 목차
13
-
14
- - [특징](#특징)
15
- - [빠른 시작](#빠른-시작)
16
- - [이미지 업로드](#이미지-업로드)
17
- - [S3 업로드 설정](#1-s3-업로드-권장)
18
- - [파일명 커스터마이징](#파일명-커스터마이징)
19
- - [커스텀 업로더](#2-커스텀-업로더)
20
- - [동영상 업로드 및 임베딩](#동영상-업로드-및-임베딩)
21
- - [업로드 진행률 표시](#업로드-진행률-표시-이미지동영상-공통)
22
- - [이미지·동영상 업로드 상세 가이드](#이미지동영상-업로드-상세-가이드)
23
- - [이미지·비디오 삭제](#이미지비디오-삭제)
24
- - [HTML 미리보기](#html-미리보기)
25
- - [Placeholder](#placeholder)
26
- - [링크 프리뷰](#링크-프리뷰)
27
- - [Props API](#props-api)
28
- - [사용 예제](#사용-예제)
29
- - [스타일링](#스타일링)
30
- - [트러블슈팅](#트러블슈팅)
31
-
32
- ---
33
-
34
- ## 특징
35
-
36
- | 특징 | 설명 |
37
- | ----------------------- | -------------------------------------------------------------------------------- |
38
- | **이미지 전용** | 이미지 업로드/드래그앤드롭 기본 지원 (비디오는 `allowVideoUpload`로 옵션 활성화) |
39
- | **HTML 미리보기** | HTML 파일을 드래그 앤 드롭하여 iframe으로 미리보기 |
40
- | **S3 연동** | Presigned URL 기반 S3 업로드 내장 |
41
- | **파일명 커스터마이징** | 업로드 파일명 변경 콜백 + UUID 자동 추가 지원 |
42
- | **로딩 스피너** | 이미지 업로드 중 자동 스피너 표시 |
43
- | **성능 최적화** | 애니메이션 비활성화로 빠른 렌더링 |
44
- | **TypeScript** | 완전한 타입 안전성 |
45
- | **테마 지원** | 라이트/다크 테마 및 커스텀 테마 |
46
-
47
- ### 지원 이미지 형식
48
-
49
- ```
50
- PNG, JPEG/JPG, GIF, WebP, BMP
51
- ```
52
-
53
- ---
54
-
55
- ## 빠른 시작
56
-
57
- ### 1. 설치
58
-
59
- ```bash
60
- npm install @lumir-company/editor
61
- # 또는
62
- yarn add @lumir-company/editor
63
- ```
64
-
65
- **필수 Peer Dependencies:**
66
-
67
- - `react` >= 18.0.0
68
- - `react-dom` >= 18.0.0
69
-
70
- ### 2. 기본 사용
71
-
72
- ```tsx
73
- import { LumirEditor } from "@lumir-company/editor";
74
- import "@lumir-company/editor/style.css"; // 필수!
75
-
76
- export default function App() {
77
- return (
78
- <div className="w-full h-[500px]">
79
- <LumirEditor onContentChange={(blocks) => console.log(blocks)} />
80
- </div>
81
- );
82
- }
83
- ```
84
-
85
- > **중요**: `style.css`를 임포트하지 않으면 에디터가 정상 작동하지 않습니다.
86
-
87
- ### 3. Next.js에서 사용
88
-
89
- ```tsx
90
- "use client";
91
-
92
- import dynamic from "next/dynamic";
93
- import "@lumir-company/editor/style.css";
94
-
95
- // SSR 비활성화 필수
96
- const LumirEditor = dynamic(
97
- () =>
98
- import("@lumir-company/editor").then((m) => ({ default: m.LumirEditor })),
99
- { ssr: false },
100
- );
101
-
102
- export default function EditorPage() {
103
- return (
104
- <div className="h-[500px]">
105
- <LumirEditor />
106
- </div>
107
- );
108
- }
109
- ```
110
-
111
- ---
112
-
113
- ## 이미지 업로드
114
-
115
- ### 1. S3 업로드 (권장)
116
-
117
- Presigned URL을 사용한 안전한 S3 업로드 방식입니다.
118
-
119
- ```tsx
120
- <LumirEditor
121
- s3Upload={{
122
- apiEndpoint: "/api/s3/presigned",
123
- env: "production",
124
- path: "blog/images",
125
- }}
126
- />
127
- ```
128
-
129
- #### S3 파일 저장 경로
130
-
131
- ```
132
- {env}/{path}/{filename}
133
-
134
- 예시:
135
- production/blog/images/my-photo.png
136
- ```
137
-
138
- #### API 엔드포인트 응답 형식
139
-
140
- 서버는 다음 형식으로 응답해야 합니다:
141
-
142
- ```json
143
- {
144
- "presignedUrl": "https://s3.amazonaws.com/bucket/upload-url",
145
- "publicUrl": "https://cdn.example.com/production/blog/images/my-photo.png"
146
- }
147
- ```
148
-
149
- 클라이언트는 `apiEndpoint?key={파일키}&contentType={MIME}` 형태로 GET 요청을 보내고, 서버는 위 형식으로 JSON을 반환하면 됩니다.
150
-
151
- #### S3 Presigned URL API 구현 예시
152
-
153
- **Next.js (App Router)**
154
-
155
- 파일: `app/api/s3/presigned/route.ts`
156
-
157
- ```typescript
158
- import { NextRequest, NextResponse } from "next/server";
159
- import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3";
160
- import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
161
-
162
- const s3 = new S3Client({
163
- region: process.env.AWS_REGION!,
164
- credentials: {
165
- accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
166
- secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
167
- },
168
- });
169
-
170
- export async function GET(req: NextRequest) {
171
- const { searchParams } = new URL(req.url);
172
- const key = searchParams.get("key");
173
- const contentType = searchParams.get("contentType");
174
-
175
- if (!key) {
176
- return NextResponse.json({ error: "key is required" }, { status: 400 });
177
- }
178
-
179
- const command = new PutObjectCommand({
180
- Bucket: process.env.AWS_S3_BUCKET!,
181
- Key: key,
182
- ContentType: contentType || "application/octet-stream",
183
- });
184
-
185
- const presignedUrl = await getSignedUrl(s3, command, { expiresIn: 60 });
186
- const publicUrl = `https://${process.env.AWS_S3_BUCKET}.s3.${process.env.AWS_REGION}.amazonaws.com/${key}`;
187
-
188
- return NextResponse.json({ presignedUrl, publicUrl, key });
189
- }
190
- ```
191
-
192
- 필요한 환경 변수: `AWS_REGION`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_S3_BUCKET`
193
-
194
- **Next.js가 아닌 프로젝트에서 사용하기**
195
-
196
- 동일하게 **GET** 요청으로 `key`, `contentType` 쿼리 파라미터를 받아 `presignedUrl`, `publicUrl`을 JSON으로 반환하는 엔드포인트를 구현하면 됩니다.
197
-
198
- - **Express (Node.js)**
199
-
200
- ```javascript
201
- const express = require("express");
202
- const { S3Client, PutObjectCommand } = require("@aws-sdk/client-s3");
203
- const { getSignedUrl } = require("@aws-sdk/s3-request-presigner");
204
-
205
- const s3 = new S3Client({
206
- region: process.env.AWS_REGION,
207
- credentials: {
208
- accessKeyId: process.env.AWS_ACCESS_KEY_ID,
209
- secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
210
- },
211
- });
212
-
213
- app.get("/api/s3/presigned", async (req, res) => {
214
- const key = req.query.key;
215
- const contentType = req.query.contentType || "application/octet-stream";
216
-
217
- if (!key) {
218
- return res.status(400).json({ error: "key is required" });
219
- }
220
-
221
- const command = new PutObjectCommand({
222
- Bucket: process.env.AWS_S3_BUCKET,
223
- Key: key,
224
- ContentType: contentType,
225
- });
226
-
227
- const presignedUrl = await getSignedUrl(s3, command, { expiresIn: 60 });
228
- const publicUrl = `https://${process.env.AWS_S3_BUCKET}.s3.${process.env.AWS_REGION}.amazonaws.com/${key}`;
229
-
230
- res.json({ presignedUrl, publicUrl, key });
231
- });
232
- ```
233
-
234
- 에디터 사용 시 `apiEndpoint`만 해당 서버 주소로 맞추면 됩니다.
235
-
236
- ```tsx
237
- <LumirEditor
238
- s3Upload={{
239
- apiEndpoint: "https://api.myapp.com/api/s3/presigned",
240
- env: "production",
241
- path: "uploads",
242
- }}
243
- />
244
- ```
245
-
246
- - **Remix / SvelteKit / 기타 프레임워크**
247
- GET 라우트에서 `key`, `contentType`을 받아 `@aws-sdk/client-s3`의 `PutObjectCommand`와 `@aws-sdk/s3-request-presigner`의 `getSignedUrl`로 presigned URL을 생성한 뒤, `{ presignedUrl, publicUrl, key }` 형태로 JSON 응답하면 동일하게 사용할 수 있습니다. CORS가 필요한 경우 해당 도메인을 허용해 두세요.
248
-
249
- ---
250
-
251
- ### 파일명 커스터마이징
252
-
253
- 여러 이미지를 동시에 업로드할 때 파일명 중복을 방지하고 관리하기 쉽게 만드는 기능입니다.
254
-
255
- > **참고**: 기본적으로 확장자는 자동으로 붙습니다. `preserveExtension: false`로 설정하면 확장자를 붙이지 않습니다.
256
-
257
- #### 옵션 1: UUID 자동 추가
258
-
259
- ```tsx
260
- <LumirEditor
261
- s3Upload={{
262
- apiEndpoint: "/api/s3/presigned",
263
- env: "production",
264
- path: "uploads",
265
- appendUUID: true, // 파일명 뒤에 UUID 자동 추가
266
- }}
267
- />
268
- ```
269
-
270
- **결과:**
271
-
272
- ```
273
- 원본: photo.png
274
- 업로드: photo_550e8400-e29b-41d4-a716-446655440000.png
275
- ```
276
-
277
- #### 옵션 2: 파일명 변환 콜백
278
-
279
- ```tsx
280
- <LumirEditor
281
- s3Upload={{
282
- apiEndpoint: "/api/s3/presigned",
283
- env: "production",
284
- path: "uploads",
285
- fileNameTransform: (nameWithoutExt, file) => {
286
- // nameWithoutExt는 확장자가 제거된 파일명 (예: "photo")
287
- // 확장자는 자동으로 붙습니다
288
- const userId = getCurrentUserId();
289
- return `${userId}_${nameWithoutExt}`;
290
- },
291
- }}
292
- />
293
- ```
294
-
295
- **결과:**
296
-
297
- ```
298
- 원본: photo.png
299
- → nameWithoutExt: "photo"
300
- → 변환 후: "user123_photo"
301
- → 최종: user123_photo.png
302
- ```
303
-
304
- #### 옵션 3: 조합 사용 (권장)
305
-
306
- ```tsx
307
- <LumirEditor
308
- s3Upload={{
309
- apiEndpoint: "/api/s3/presigned",
310
- env: "production",
311
- path: "uploads",
312
- fileNameTransform: (nameWithoutExt) => `user123_${nameWithoutExt}`,
313
- appendUUID: true, // 변환 후 UUID 추가
314
- }}
315
- />
316
- ```
317
-
318
- **결과:**
319
-
320
- ```
321
- 원본: photo.png
322
- → nameWithoutExt: "photo"
323
- 1. fileNameTransform 적용: "user123_photo"
324
- 2. appendUUID 적용: "user123_photo_550e8400-e29b-41d4"
325
- 3. 확장자 붙이기: user123_photo_550e8400-e29b-41d4.png
326
- ```
327
-
328
- #### 실전 예제: 타임스탬프 + UUID
329
-
330
- ```tsx
331
- function MyEditor() {
332
- return (
333
- <LumirEditor
334
- s3Upload={{
335
- apiEndpoint: "/api/s3/presigned",
336
- env: "production",
337
- path: "uploads",
338
- fileNameTransform: (nameWithoutExt, file) => {
339
- // nameWithoutExt는 이미 확장자가 제거됨
340
- const timestamp = new Date().toISOString().split("T")[0]; // 2024-01-15
341
- return `${timestamp}_${nameWithoutExt}`;
342
- },
343
- appendUUID: true,
344
- }}
345
- />
346
- );
347
- }
348
- ```
349
-
350
- **결과:**
351
-
352
- ```
353
- 원본: photo.png
354
- → nameWithoutExt: "photo"
355
- 1. fileNameTransform: "2024-01-15_photo"
356
- 2. appendUUID: "2024-01-15_photo_550e8400-e29b-41d4"
357
- 3. 확장자 붙이기: 2024-01-15_photo_550e8400-e29b-41d4.png
358
- ```
359
-
360
- #### 옵션 4: 확장자 제거 (preserveExtension: false)
361
-
362
- ```tsx
363
- <LumirEditor
364
- s3Upload={{
365
- apiEndpoint: "/api/s3/presigned",
366
- env: "production",
367
- path: "uploads",
368
- fileNameTransform: (nameWithoutExt) => `${nameWithoutExt}_custom`,
369
- preserveExtension: false, // 확장자 안 붙임
370
- }}
371
- />
372
- ```
373
-
374
- **결과:**
375
-
376
- ```
377
- 원본: photo.png
378
- → nameWithoutExt: "photo"
379
- → 변환 후: "photo_custom"
380
- → 최종: photo_custom (확장자 없음)
381
- ```
382
-
383
- **사용 사례**: WebP 변환 등 서버에서 확장자를 변경하는 경우
384
-
385
- ```tsx
386
- fileNameTransform: (nameWithoutExt) => `${nameWithoutExt}.webp`,
387
- preserveExtension: false,
388
- ```
389
-
390
- ---
391
-
392
- ### 2. 커스텀 업로더
393
-
394
- 자체 업로드 로직을 사용할 때:
395
-
396
- ```tsx
397
- <LumirEditor
398
- uploadFile={async (file) => {
399
- const formData = new FormData();
400
- formData.append("image", file);
401
-
402
- const response = await fetch("/api/upload", {
403
- method: "POST",
404
- body: formData,
405
- });
406
-
407
- const { url } = await response.json();
408
- return url; // 업로드된 이미지 URL 반환
409
- }}
410
- />
411
- ```
412
-
413
- ### 3. 헬퍼 함수 사용
414
-
415
- ```tsx
416
- import { createS3Uploader } from "@lumir-company/editor";
417
-
418
- const s3Uploader = createS3Uploader({
419
- apiEndpoint: "/api/s3/presigned",
420
- env: "production",
421
- path: "images",
422
- appendUUID: true,
423
- });
424
-
425
- // 에디터에 적용
426
- <LumirEditor uploadFile={s3Uploader} />;
427
-
428
- // 또는 별도로 사용
429
- const imageUrl = await s3Uploader(imageFile);
430
- ```
431
-
432
- ### 업로드 우선순위
433
-
434
- 1. `uploadFile` prop이 있으면 우선 사용
435
- 2. `uploadFile` 없고 `s3Upload`가 있으면 S3 업로드 사용
436
- 3. 둘 다 없으면 업로드 실패
437
-
438
- ---
439
-
440
- ## 동영상 업로드 및 임베딩
441
-
442
- `allowVideoUpload={true}`로 설정하면 동영상 업로드와 에디터 내 재생이 가능합니다. S3/`uploadFile`은 이미지와 동일한 설정을 사용하며, 동영상은 최대 100MB까지 허용됩니다.
443
-
444
- ### 동영상 업로드 활성화
445
-
446
- ```tsx
447
- <LumirEditor
448
- allowVideoUpload={true}
449
- s3Upload={{
450
- apiEndpoint: "/api/s3/presigned",
451
- env: "production",
452
- path: "videos",
453
- appendUUID: true,
454
- }}
455
- />
456
- ```
457
-
458
- - **지원 형식**: MP4, WebM, OGG
459
- - **삽입 경로**: 붙여넣기, 드래그 앤 드롭, 슬래시 메뉴("Video"), FloatingMenu 이미지/동영상 버튼
460
-
461
- ### 업로드 진행률 표시 (이미지·동영상 공통)
462
-
463
- S3 업로드 시 `s3Upload.onProgress` 콜백을 지정하면 업로드 진행률(0~100%)을 받을 수 있습니다. 에디터는 내부적으로 이 값을 사용해 업로드 중 툴바에 **"n%"** 를 표시합니다. 동영상처럼 대용량 파일은 브라우저가 `progress` 이벤트를 자주 보내지 않을 수 있어, 내부적으로 **보간 로직**을 적용해 0→100만 보이지 않고 중간 진행률이 부드럽게 갱신되도록 했습니다.
464
-
465
- ```tsx
466
- <LumirEditor
467
- allowVideoUpload={true}
468
- s3Upload={{
469
- apiEndpoint: "/api/s3/presigned",
470
- env: "production",
471
- path: "videos",
472
- appendUUID: true,
473
- onProgress: (percent) => {
474
- console.log(`업로드 진행률: ${percent}%`);
475
- // 에디터 기본 UI에 이미 표시되며, 필요 시 자체 프로그레스 바 등에 연동 가능
476
- },
477
- }}
478
- />
479
- ```
480
-
481
- - **동작**: S3 PUT 요청 시에만 호출됩니다. Presigned URL 요청 단계에서는 호출되지 않습니다.
482
- - **표시**: `onProgress`를 넘기면 에디터 툴바에 `n%`가 자동 표시되며, 업로드 완료 시 숨겨집니다.
483
-
484
- ### 데이터 내부 동영상 임베딩
485
-
486
- 동영상 블록은 `initialContent` / `onContentChange`에 포함됩니다. 저장 시 `{ type: "video", props: { url: "..." } }` 형태로 블록이 유지됩니다.
487
-
488
- - **재생**: 화면에서 동영상을 재생하려면 `allowVideoUpload={true}`로 두어야 합니다. 이렇게 해야 video 확장이 활성화되어 BlockNote 기본 플레이어가 렌더링됩니다.
489
- - `allowVideoUpload={false}`인 상태에서 initialContent에 video 블록만 넣으면 데이터는 보존되지만, 재생 UI는 비활성화된 확장 때문에 표시되지 않을 수 있습니다.
490
- - **지원 URL**: 비디오 블록의 `url`은 **직접 재생 가능한 비디오 파일 URL**만 지원합니다(예: S3에 업로드된 `.mp4`, `.webm`, `.ogg`). YouTube·Vimeo 등 스트리밍 페이지 URL(`youtube.com/watch?v=...` 등)은 `<video>` 요소의 `src`로 재생되지 않으므로, 해당 링크를 video 블록 URL로 넣으면 재생되지 않습니다. YouTube 임베드가 필요하면 별도 embed 블록 또는 iframe 삽입 방식을 고려해야 합니다.
491
-
492
- ---
493
-
494
- ## 이미지·동영상 업로드 상세 가이드
495
-
496
- 이미지와 동영상 업로드 기능을 함께 쓰는 방법을 단계별로 정리했습니다.
497
-
498
- ### 1. 개요
499
-
500
- | 구분 | 이미지 | 동영상 |
501
- | --------------- | ------------------------------- | ------------------------------------------ |
502
- | **기본 동작** | 업로드 항상 사용 가능 (설정 시) | `allowVideoUpload={true}`일 때만 사용 가능 |
503
- | **최대 용량** | 10MB | 100MB |
504
- | **업로드 설정** | `s3Upload` 또는 `uploadFile` | 이미지와 동일한 설정 공유 |
505
-
506
- - 이미지만 쓸 때: `s3Upload` 또는 `uploadFile`만 설정하면 됩니다.
507
- - 이미지 + 동영상: 위 설정에 더해 `allowVideoUpload={true}`를 넣습니다.
508
-
509
- ### 2. 지원 형식 및 제한
510
-
511
- **이미지**
512
-
513
- - **MIME**: `image/jpeg`, `image/png`, `image/gif`, `image/webp`, `image/bmp`
514
- - **확장자**: `.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.bmp`
515
- - **용량**: 기본 최대 10MB. `maxImageFileSize`(바이트)로 변경 가능.
516
- - **제외**: SVG (XSS 방지로 업로드 불가)
517
-
518
- **동영상** (`allowVideoUpload={true}`일 때)
519
-
520
- - **MIME**: `video/mp4`, `video/webm`, `video/ogg`, `video/quicktime`
521
- - **확장자**: `.mp4`, `.webm`, `.ogg`, `.mov`
522
- - **용량**: 기본 최대 100MB. `maxVideoFileSize`(바이트)로 변경 가능.
523
-
524
- **업로드 타임아웃**: S3 업로드 시 PUT 요청 타임아웃은 `s3Upload.uploadTimeoutMs`로 설정합니다. 미설정 시 120초(120000ms)가 적용됩니다.
525
-
526
- **용량 및 타임아웃 사용자 설정**
527
-
528
- 이미지·동영상 최대 용량과 S3 PUT 타임아웃을 props로 변경할 수 있습니다. 미설정 시 기본값(이미지 10MB, 동영상 100MB, 타임아웃 120초)이 적용됩니다.
529
-
530
- ```tsx
531
- <LumirEditor
532
- allowVideoUpload={true}
533
- maxImageFileSize={5 * 1024 * 1024} // 5MB
534
- maxVideoFileSize={200 * 1024 * 1024} // 200MB
535
- s3Upload={{
536
- apiEndpoint: "/api/s3/presigned",
537
- env: "production",
538
- path: "uploads",
539
- uploadTimeoutMs: 180000, // 180초 (대용량 동영상 시 연장)
540
- }}
541
- />
542
- ```
543
-
544
- ### 3. 삽입 경로 (공통)
545
-
546
- 이미지·동영상 모두 아래 경로로 삽입할 수 있습니다.
547
-
548
- | 경로 | 설명 |
549
- | ------------------ | ----------------------------------------------------------------- |
550
- | **붙여넣기** | 클립보드 이미지/동영상 → Ctrl+V (또는 Cmd+V) |
551
- | **드래그 앤 드롭** | 파일을 에디터 영역으로 끌어다 놓기 |
552
- | **슬래시 메뉴** | `/` 입력 후 "Image" 또는 "Video"(동영상 허용 시) 선택 → 파일 선택 |
553
- | **FloatingMenu** | 툴바의 이미지/동영상 버튼 클릭 → 파일 선택 |
554
-
555
- 동영상은 `allowVideoUpload={true}`일 때만 슬래시 메뉴에 "Video"가 보이고, FloatingMenu에서도 동영상 파일을 선택할 수 있습니다.
556
-
557
- ### 4. 설정 방법 요약
558
-
559
- **우선순위**
560
-
561
- 1. `uploadFile` prop이 있으면 → 해당 함수로 업로드 (이미지·동영상 동일)
562
- 2. `uploadFile` 없고 `s3Upload`가 있으면 → Presigned URL 기반 S3 업로드
563
- 3. 둘 다 없으면 → 업로드 시 에러 (에디터는 동작하지만 파일 삽입 불가)
564
-
565
- **이미지만 사용하는 경우**
566
-
567
- ```tsx
568
- <LumirEditor
569
- s3Upload={{
570
- apiEndpoint: "/api/s3/presigned",
571
- env: "production",
572
- path: "images",
573
- appendUUID: true,
574
- }}
575
- onContentChange={(blocks) => setContent(blocks)}
576
- />
577
- ```
578
-
579
- **이미지 + 동영상 사용하는 경우**
580
-
581
- ```tsx
582
- <LumirEditor
583
- allowVideoUpload={true}
584
- s3Upload={{
585
- apiEndpoint: "/api/s3/presigned",
586
- env: "production",
587
- path: "images",
588
- appendUUID: true,
589
- }}
590
- onContentChange={(blocks) => setContent(blocks)}
591
- />
592
- ```
593
-
594
- 동영상은 같은 `s3Upload`로 업로드됩니다. 서버에서 이미지와 동영상을 다른 경로에 두고 싶다면 아래처럼 `fileNameTransform`으로 prefix를 분리하면 됩니다.
595
-
596
- **이미지·동영상 업로드 경로 분리 (fileNameTransform)**
597
-
598
- `fileNameTransform`의 두 번째 인자 `file`로 이미지/동영상을 구분해, 파일명 앞에 폴더 prefix를 붙이면 됩니다. 최종 S3 키는 `{env}/{path}/{filename}` 이므로, `filename`에 `images/...` / `videos/...` 를 넣으면 경로가 나뉩니다.
599
-
600
- ```tsx
601
- <LumirEditor
602
- allowVideoUpload={true}
603
- s3Upload={{
604
- apiEndpoint: "/api/s3/presigned",
605
- env: "production",
606
- path: "uploads", // 공통 상위 경로
607
- appendUUID: true,
608
- fileNameTransform: (nameWithoutExt, file) => {
609
- const isVideo = file.type.startsWith("video/");
610
- return `${isVideo ? "videos" : "images"}/${nameWithoutExt}`;
611
- },
612
- }}
613
- />
614
- ```
615
-
616
- 결과 예: 이미지 → `production/uploads/images/photo_abc123.png`, 동영상 → `production/uploads/videos/clip_def456.mp4`
617
-
618
- **커스텀 업로더로 이미지·동영상 통합**
619
-
620
- ```tsx
621
- <LumirEditor
622
- allowVideoUpload={true}
623
- uploadFile={async (file) => {
624
- const formData = new FormData();
625
- formData.append("file", file);
626
- const res = await fetch("/api/upload", { method: "POST", body: formData });
627
- const { url } = await res.json();
628
- return url;
629
- }}
630
- />
631
- ```
632
-
633
- `uploadFile`은 이미지/동영상 구분 없이 `File`을 받아 업로드 후 **공개 URL 문자열**을 반환하면 됩니다.
634
-
635
- ### 5. 저장 데이터 구조
636
-
637
- `onContentChange` / `initialContent`에서 사용하는 블록 형태입니다.
638
-
639
- **이미지 블록**
640
-
641
- ```json
642
- {
643
- "type": "image",
644
- "props": {
645
- "url": "https://your-cdn.com/images/photo_xxx.png",
646
- "caption": "",
647
- "previewWidth": 512
648
- },
649
- "content": [],
650
- "children": []
651
- }
652
- ```
653
-
654
- **동영상 블록**
655
-
656
- ```json
657
- {
658
- "type": "video",
659
- "props": {
660
- "url": "https://your-cdn.com/videos/clip_xxx.mp4"
661
- },
662
- "content": [],
663
- "children": []
664
- }
665
- ```
666
-
667
- `url`은 반드시 **브라우저에서 직접 재생 가능한 URL**이어야 합니다. 동영상은 YouTube/Vimeo 링크가 아니라, 업로드 후 받은 `.mp4` 등 직접 재생 URL만 지원합니다.
668
-
669
- ### 6. 삭제 시 콜백
670
-
671
- 이미지·동영상 블록을 에디터에서 삭제하면 `onImageDelete`가 호출됩니다. 인자는 삭제된 미디어의 URL입니다.
672
-
673
- ```tsx
674
- <LumirEditor
675
- s3Upload={{ ... }}
676
- allowVideoUpload={true}
677
- onImageDelete={(url) => {
678
- // url은 이미지 또는 동영상 URL
679
- console.log("삭제됨:", url);
680
- // S3/스토리지에서 삭제 API 호출
681
- }}
682
- />
683
- ```
684
-
685
- Undo로 블록을 복원해도 이미 삭제 API를 호출했다면 서버 상태와 불일치할 수 있으므로, 지연 삭제(예: 5분 후 삭제) 패턴을 권장합니다. 자세한 예시는 [이미지·비디오 삭제](#이미지비디오-삭제)를 참고하세요.
686
-
687
- ### 7. 에러 처리
688
-
689
- - **지원하지 않는 형식**: 업로드 시 `LumirEditorError`가 발생할 수 있으며, `onError`로 처리할 수 있습니다.
690
- - **용량 초과**: 기본 한도(이미지 10MB·동영상 100MB)를 넘으면 업로드가 거부됩니다. `maxImageFileSize`, `maxVideoFileSize`로 한도를 변경할 수 있습니다.
691
- - **업로드 실패**: `uploadFile` 또는 S3 업로드에서 예외가 나면 해당 파일만 삽입되지 않고, 콘솔에 경고가 출력됩니다.
692
-
693
- ```tsx
694
- <LumirEditor
695
- s3Upload={{ ... }}
696
- onError={(err) => {
697
- console.error("에디터 에러:", err);
698
- // 토스트 등으로 사용자 알림
699
- }}
700
- />
701
- ```
702
-
703
- ---
704
-
705
- ## 이미지·비디오 삭제
706
-
707
- 에디터에서 **이미지 또는 비디오**가 삭제될 때 S3 등 외부 스토리지에서도 자동으로 삭제하고 싶다면 `onImageDelete` 콜백을 사용하세요. 이미지 블록과 비디오 블록 삭제 시 모두 호출됩니다.
708
-
709
- ### 기본 사용
710
-
711
- ```tsx
712
- <LumirEditor
713
- s3Upload={{
714
- apiEndpoint: "/api/s3/presigned",
715
- env: "production",
716
- path: "images",
717
- }}
718
- onImageDelete={(imageUrl) => {
719
- console.log("미디어(이미지/비디오) 삭제됨:", imageUrl);
720
- // S3에서 삭제 로직 구현
721
- }}
722
- />
723
- ```
724
-
725
- ### 권장: 지연 삭제 (Undo/Redo 대응)
726
-
727
- Undo로 이미지·비디오를 복원할 수 있도록 **지연 삭제**를 권장합니다.
728
-
729
- ```tsx
730
- "use client";
731
-
732
- import { useState, useRef, useCallback } from "react";
733
-
734
- function Editor() {
735
- const pendingDeletes = useRef(new Map());
736
-
737
- const handleImageDelete = useCallback((imageUrl: string) => {
738
- // 이미 예약된 삭제가 있으면 무시
739
- if (pendingDeletes.current.has(imageUrl)) return;
740
-
741
- // 5분 후 삭제 예약
742
- const timeoutId = setTimeout(
743
- async () => {
744
- pendingDeletes.current.delete(imageUrl);
745
-
746
- // S3에서 실제 삭제
747
- await fetch(`/api/s3/delete?url=${encodeURIComponent(imageUrl)}`, {
748
- method: "DELETE",
749
- });
750
- },
751
- 5 * 60 * 1000,
752
- ); // 5분
753
-
754
- pendingDeletes.current.set(imageUrl, timeoutId);
755
- }, []);
756
-
757
- return (
758
- <LumirEditor
759
- s3Upload={
760
- {
761
- /* ... */
762
- }
763
- }
764
- onImageDelete={handleImageDelete}
765
- />
766
- );
767
- }
768
- ```
769
-
770
- ### S3 삭제 API 예시
771
-
772
- > **참고**: `onImageDelete`는 **프레임워크 독립적**이며, 이미지와 비디오 삭제 시 모두 호출됩니다. 아래는 각 환경별 구현 예시입니다.
773
-
774
- #### Next.js API Route
775
-
776
- **파일**: `app/api/s3/delete/route.ts`
777
-
778
- ```typescript
779
- import { NextRequest, NextResponse } from "next/server";
780
- import { S3Client, DeleteObjectCommand } from "@aws-sdk/client-s3";
781
-
782
- const s3 = new S3Client({
783
- region: process.env.AWS_REGION!,
784
- credentials: {
785
- accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
786
- secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
787
- },
788
- });
789
-
790
- export async function DELETE(req: NextRequest) {
791
- const { searchParams } = new URL(req.url);
792
- const imageUrl = searchParams.get("url");
793
-
794
- if (!imageUrl) {
795
- return NextResponse.json({ error: "url is required" }, { status: 400 });
796
- }
797
-
798
- // URL에서 S3 키 추출
799
- const key = extractKeyFromUrl(imageUrl);
800
-
801
- await s3.send(
802
- new DeleteObjectCommand({
803
- Bucket: process.env.AWS_S3_BUCKET!,
804
- Key: key,
805
- }),
806
- );
807
-
808
- return NextResponse.json({ success: true });
809
- }
810
-
811
- function extractKeyFromUrl(url: string): string {
812
- const urlObj = new URL(url);
813
- return decodeURIComponent(urlObj.pathname.slice(1));
814
- }
815
- ```
816
-
817
- **클라이언트 구현**:
818
-
819
- ```tsx
820
- const handleImageDelete = (imageUrl: string) => {
821
- fetch(`/api/s3/delete?url=${encodeURIComponent(imageUrl)}`, {
822
- method: "DELETE",
823
- });
824
- };
825
-
826
- <LumirEditor onImageDelete={handleImageDelete} />;
827
- ```
828
-
829
- #### React + Express
830
-
831
- **서버** (`server.js`):
832
-
833
- ```javascript
834
- app.delete("/api/images", async (req, res) => {
835
- const { imageUrl } = req.body;
836
- const key = extractKeyFromS3Url(imageUrl);
837
-
838
- await s3Client.send(
839
- new DeleteObjectCommand({
840
- Bucket: process.env.S3_BUCKET,
841
- Key: key,
842
- }),
843
- );
844
-
845
- res.json({ success: true });
846
- });
847
- ```
848
-
849
- **클라이언트**:
850
-
851
- ```tsx
852
- const handleImageDelete = async (imageUrl: string) => {
853
- await fetch("https://api.myapp.com/api/images", {
854
- method: "DELETE",
855
- headers: { "Content-Type": "application/json" },
856
- body: JSON.stringify({ imageUrl }),
857
- });
858
- };
859
-
860
- <LumirEditor onImageDelete={handleImageDelete} />;
861
- ```
862
-
863
- #### React Native + Firebase Storage
864
-
865
- ```tsx
866
- import storage from "@react-native-firebase/storage";
867
-
868
- const handleImageDelete = async (imageUrl: string) => {
869
- const ref = storage().refFromURL(imageUrl);
870
- await ref.delete();
871
- };
872
-
873
- <LumirEditor onImageDelete={handleImageDelete} />;
874
- ```
875
-
876
- #### Vue + Axios + FastAPI
877
-
878
- ```typescript
879
- const handleImageDelete = async (imageUrl: string) => {
880
- await axios.delete("https://api.myapp.com/v1/images", {
881
- data: { imageUrl },
882
- });
883
- };
884
- ```
885
-
886
- ### 주의사항
887
-
888
- | 항목 | 설명 |
889
- | --------------- | --------------------------------------------- |
890
- | **Undo/Redo** | 지연 삭제로 복원 가능하게 구현 (권장: 5-10분) |
891
- | **권한 검증** | 프로덕션에서는 인증/인가 필수 |
892
- | **참조 카운트** | 같은 이미지를 여러 문서에서 사용하는지 확인 |
893
- | **삭제 로그** | 감사 추적을 위한 삭제 기록 저장 권장 |
894
-
895
- ---
896
-
897
- ## HTML 미리보기
898
-
899
- LumirEditor는 HTML 파일을 iframe을 사용하여 미리보기할 수 있는 커스텀 블록을 제공합니다. 편집 불가능한 순수 미리보기 기능으로, HTML 문서를 안전하게 표시할 수 있습니다.
900
-
901
- ### 사용 방법
902
-
903
- #### 1. 드래그 앤 드롭
904
-
905
- HTML 파일(`.html`, `.htm`)을 에디터에 드래그 앤 드롭하면 자동으로 iframe 미리보기 블록이 삽입됩니다.
906
-
907
- ```tsx
908
- <LumirEditor />
909
- ```
910
-
911
- - **지원 파일 형식**: `.html`, `.htm`
912
- - **특징**:
913
- - 편집 불가능한 순수 미리보기
914
- - 접기/펼치기 기능
915
- - 안전한 sandbox 처리 (`allow-same-origin`, JavaScript 실행 비활성화)
916
- - 파일명 표시
917
-
918
- #### 2. 슬래시 메뉴
919
-
920
- 에디터에서 `/`를 입력하고 "HTML Preview"를 선택하면 예제 HTML 미리보기 블록이 삽입됩니다.
921
-
922
- ```
923
- / → HTML Preview
924
- ```
925
-
926
- ### 특징
927
-
928
- - **iframe 기반**: HTML 문서를 독립된 iframe에서 안전하게 렌더링
929
- - **Sandbox 보안**: `sandbox="allow-same-origin"` 속성으로 보안 강화 (JavaScript 실행 의도적 비활성화)
930
- - **접기/펼치기**: 헤더 클릭으로 미리보기 영역 토글
931
- - **드래그 리사이즈**: 하단 핸들을 드래그하여 높이 조절 가능 (100px ~ 1200px)
932
- - **새 창 열기**: HTML 문서를 새 창에서 전체 화면으로 확인
933
- - **다운로드**: HTML 파일로 다운로드
934
- - **편집 불가**: 순수 미리보기 전용
935
-
936
- ### 사용 예제
937
-
938
- ```tsx
939
- import { LumirEditor } from "@lumir-company/editor";
940
- import "@lumir-company/editor/style.css";
941
-
942
- function App() {
943
- return (
944
- <div className="w-full h-[600px]">
945
- <LumirEditor
946
- onContentChange={(blocks) => {
947
- // HTML 미리보기 블록도 일반 블록과 동일하게 처리됨
948
- console.log(blocks);
949
- }}
950
- />
951
- </div>
952
- );
953
- }
954
- ```
955
-
956
- ### 프로그래밍 방식으로 블록 삽입
957
-
958
- ```tsx
959
- import { HtmlPreview } from "@lumir-company/editor";
960
-
961
- // 에디터 인스턴스에서 직접 블록 삽입
962
- editor.insertBlocks([
963
- {
964
- type: "htmlPreview",
965
- props: {
966
- htmlContent: "<h1>Hello World</h1><p>This is HTML content</p>",
967
- fileName: "example.html",
968
- height: "400px",
969
- },
970
- },
971
- ]);
972
- ```
973
-
974
- ### 주의사항
975
-
976
- - HTML 내용은 iframe의 `sandbox="allow-same-origin"` 속성으로 보안이 강화되어 있습니다
977
- - **JavaScript는 의도적으로 비활성화**되어 있습니다 (보안상 이유)
978
- - 외부 리소스(CSS, JS, 이미지 등)는 상대 경로가 작동하지 않을 수 있습니다
979
- - 인라인 CSS 스타일을 권장합니다
980
-
981
- ---
982
-
983
- ## Placeholder
984
-
985
- 에디터가 비어있을 때 사용자에게 안내 텍스트를 표시합니다.
986
-
987
- ### 사용 방법
988
-
989
- ```tsx
990
- <LumirEditor placeholder="내용을 입력하세요..." />
991
- ```
992
-
993
- - 빈 블록에 연한 색상으로 안내 텍스트가 표시됩니다
994
- - 사용자가 입력을 시작하면 자동으로 사라집니다
995
- - 모든 빈 블록(첫 번째 블록 포함)에 동일한 텍스트가 적용됩니다
996
-
997
- ---
998
-
999
- ## 링크 프리뷰
1000
-
1001
- URL을 붙여넣거나 슬래시 메뉴에서 선택하면 Open Graph 카드를 표시합니다.
1002
-
1003
- > **서버 사이드 필수**: 링크 프리뷰는 외부 사이트의 OG 메타데이터를 가져오기 위해 **서버 사이드 API 라우트**가 필요합니다. 브라우저의 CORS 정책으로 인해 클라이언트에서 직접 외부 HTML을 가져올 수 없습니다.
1004
-
1005
- ### 사용 조건
1006
-
1007
- | 조건 | 설명 |
1008
- | -------------------------- | -------------------------------------------------------------------------- |
1009
- | **서버 환경** | Next.js, Remix, SvelteKit 등 서버 사이드 라우팅을 지원하는 프레임워크 필요 |
1010
- | **API 라우트** | 패키지 내장 핸들러를 re-export하는 1줄짜리 파일 필요 |
1011
- | **순수 React (CRA, Vite)** | 별도 백엔드 서버 없이는 사용 불가 |
1012
-
1013
- ### 설정 방법 (Next.js App Router)
1014
-
1015
- **1단계: API 라우트 생성** (1줄)
1016
-
1017
- ```ts
1018
- // src/app/api/link-preview/route.ts
1019
- export { linkPreviewHandler as GET } from "@lumir-company/editor/api/link-preview";
1020
- ```
1021
-
1022
- 패키지에 내장된 핸들러를 re-export하므로 별도 로직 작성이 불필요합니다.
1023
-
1024
- **2단계: 에디터에 linkPreview prop 설정**
1025
-
1026
- ```tsx
1027
- <LumirEditor linkPreview={{ apiEndpoint: "/api/link-preview" }} />
1028
- ```
1029
-
1030
- ### 설정 방법 (Remix / SvelteKit)
1031
-
1032
- 패키지의 `GET` 핸들러는 표준 Web API(`Request`/`Response`)를 사용하므로 Remix, SvelteKit 등에서도 동일하게 사용 가능합니다.
1033
-
1034
- ```ts
1035
- // Remix: app/routes/api.link-preview.ts
1036
- export { linkPreviewHandler as loader } from "@lumir-company/editor/api/link-preview";
1037
- ```
1038
-
1039
- ### 설정 방법 (Express / Fastify 등 커스텀 서버)
1040
-
1041
- 패키지에서 `fetchUrlMetadata`와 `parseMetaTags`를 import하여 직접 라우트를 구현할 수 있습니다.
1042
-
1043
- ```ts
1044
- import { fetchUrlMetadata } from "@lumir-company/editor/api/link-preview";
1045
-
1046
- app.get("/api/link-preview", async (req, res) => {
1047
- const url = req.query.url as string;
1048
- if (!url) return res.status(400).json({ error: "url required" });
1049
-
1050
- try {
1051
- const metadata = await fetchUrlMetadata(url);
1052
- res.json(metadata);
1053
- } catch {
1054
- res.status(500).json({ error: "Failed to fetch metadata" });
1055
- }
1056
- });
1057
- ```
1058
-
1059
- ### 주요 기능
1060
-
1061
- - URL 붙여넣기 시 자동 링크 프리뷰 블록 생성
1062
- - 슬래시 메뉴(`/`)에서 Link Preview 항목 선택
1063
- - 드래그 리사이즈 (좌우 너비, 하단 이미지 높이)
1064
- - 텍스트 링크를 링크 프리뷰로 전환 (링크 툴바 버튼)
1065
- - 메타데이터에 이미지 없으면 이미지 영역 자동 생략
1066
- - 에러 카드 클릭 시 링크 이동
1067
-
1068
- ### 내장 API 핸들러 export 목록
1069
-
1070
- `@lumir-company/editor/api/link-preview`에서 export되는 항목:
1071
-
1072
- | Export | 타입 | 설명 |
1073
- | -------------------- | ------------------------------------------------- | ------------------------------------------------ |
1074
- | `linkPreviewHandler` | `(request: Request) => Promise<Response>` | 링크 프리뷰 메타데이터 조회 핸들러 (re-export용) |
1075
- | `fetchUrlMetadata` | `(url: string) => Promise<LinkMetadata>` | 서버에서 직접 메타데이터 조회 |
1076
- | `parseMetaTags` | `(html: string, baseUrl: string) => LinkMetadata` | HTML에서 OG 메타데이터 파싱 |
1077
- | `LinkMetadata` | `interface` | 메타데이터 타입 정의 |
1078
-
1079
- ---
1080
-
1081
- ## Props API
1082
-
1083
- ### 핵심 Props
1084
-
1085
- | Prop | 타입 | 기본값 | 설명 |
1086
- | ----------------- | ----------------------------------- | ----------- | -------------------------- |
1087
- | `s3Upload` | `S3UploaderConfig` | `undefined` | S3 업로드 설정 |
1088
- | `uploadFile` | `(file: File) => Promise<string>` | `undefined` | 커스텀 업로드 함수 |
1089
- | `onContentChange` | `(blocks) => void` | `undefined` | 콘텐츠 변경 콜백 |
1090
- | `onImageDelete` | `(imageUrl: string) => void` | `undefined` | 이미지·비디오 삭제 시 콜백 |
1091
- | `onError` | `(error: LumirEditorError) => void` | `undefined` | 에러 발생 시 콜백 |
1092
- | `initialContent` | `Block[] \| string` | `undefined` | 초기 콘텐츠 |
1093
- | `editable` | `boolean` | `true` | 편집 가능 여부 |
1094
- | `placeholder` | `string` | `undefined` | 빈 블록 안내 텍스트 |
1095
- | `linkPreview` | `{ apiEndpoint: string }` | `undefined` | 링크 프리뷰 설정 |
1096
- | `theme` | `"light" \| "dark"` | `"light"` | 테마 |
1097
- | `className` | `string` | `""` | CSS 클래스 |
1098
- | `maxImageFileSize` | `number` | `undefined` | 이미지 최대 용량(바이트). 미설정 시 10MB |
1099
- | `maxVideoFileSize` | `number` | `undefined` | 동영상 최대 용량(바이트). 미설정 시 100MB |
1100
-
1101
- ### S3UploaderConfig
1102
-
1103
- ```tsx
1104
- interface S3UploaderConfig {
1105
- // 필수
1106
- apiEndpoint: string; // Presigned URL API 엔드포인트
1107
- env: "development" | "production";
1108
- path: string; // S3 저장 경로
1109
-
1110
- // 선택 (파일명 커스터마이징)
1111
- fileNameTransform?: (nameWithoutExt: string, file: File) => string; // 확장자 제외한 이름 변환
1112
- appendUUID?: boolean; // true: 파일명 뒤에 UUID 추가 (확장자 앞에 삽입)
1113
- preserveExtension?: boolean; // false: 확장자를 붙이지 않음 (기본: true)
1114
-
1115
- // 선택 (업로드 동작)
1116
- onProgress?: (percent: number) => void; // 업로드 진행률 0~100 콜백 (S3 PUT 시만 호출, 중간 진행률 보간 지원)
1117
- uploadTimeoutMs?: number; // PUT 타임아웃(ms). 미설정 시 120000(120초). 대용량 동영상 시 연장 권장
1118
- maxRetries?: number; // PUT 실패 시 재시도 횟수. 기본 2(최대 3회 시도)
1119
- }
1120
- ```
1121
-
1122
- ### 전체 Props
1123
-
1124
- <details>
1125
- <summary>전체 Props 보기</summary>
1126
-
1127
- ```tsx
1128
- interface LumirEditorProps {
1129
- // === 에디터 설정 ===
1130
- initialContent?: DefaultPartialBlock[] | string; // 초기 콘텐츠 (블록 배열 또는 JSON 문자열)
1131
- initialEmptyBlocks?: number; // 초기 빈 블록 개수 (기본: 3)
1132
- placeholder?: string; // 빈 블록에 표시할 안내 텍스트 (예: "내용을 입력하세요...")
1133
- uploadFile?: (file: File) => Promise<string>; // 커스텀 파일 업로드 함수
1134
- s3Upload?: {
1135
- apiEndpoint: string;
1136
- env: "development" | "production";
1137
- path: string;
1138
- fileNameTransform?: (nameWithoutExt: string, file: File) => string; // 확장자 제외한 이름 변환
1139
- appendUUID?: boolean; // UUID 자동 추가 (확장자 앞)
1140
- preserveExtension?: boolean; // 확장자 자동 붙이기 (기본: true)
1141
- onProgress?: (percent: number) => void; // 업로드 진행률 0~100 (이미지·동영상 공통, 중간 진행률 보간)
1142
- uploadTimeoutMs?: number; // PUT 타임아웃(ms). 기본 120000
1143
- maxRetries?: number; // PUT 재시도 횟수. 기본 2
1144
- };
1145
-
1146
- // === 콜백 ===
1147
- onContentChange?: (blocks: DefaultPartialBlock[]) => void; // 콘텐츠 변경 시 호출
1148
- onImageDelete?: (imageUrl: string) => void; // 이미지·비디오 삭제 시 호출 (S3 삭제 등)
1149
- onSelectionChange?: () => void; // 선택 영역 변경 시 호출
1150
- onError?: (error: LumirEditorError) => void; // 에러 발생 시 호출
1151
-
1152
- // 기능 설정
1153
- tables?: TableConfig; // 테이블 기능 설정 (splitCells, cellBackgroundColor 등)
1154
- heading?: { levels?: (1 | 2 | 3 | 4 | 5 | 6)[] }; // 헤딩 레벨 설정 (기본: [1,2,3,4,5,6])
1155
- defaultStyles?: boolean; // 기본 스타일 활성화 (기본: true)
1156
- disableExtensions?: string[]; // 비활성화할 확장 기능 목록
1157
- tabBehavior?: "prefer-navigate-ui" | "prefer-indent"; // 탭 키 동작 (기본: "prefer-navigate-ui")
1158
- trailingBlock?: boolean; // 마지막에 빈 블록 자동 추가 (기본: true)
1159
-
1160
- // === UI 설정 ===
1161
- editable?: boolean; // 편집 가능 여부 (기본: true)
1162
- theme?: "light" | "dark" | ThemeObject; // 에디터 테마 (기본: "light")
1163
- formattingToolbar?: boolean; // 서식 툴바 표시 (기본: true)
1164
- linkToolbar?: boolean; // 링크 툴바 표시 (기본: true)
1165
- sideMenu?: boolean; // 사이드 메뉴 표시 (기본: true)
1166
- sideMenuAddButton?: boolean; // 사이드 메뉴 + 버튼 표시 (기본: false, 드래그 핸들만 표시)
1167
- emojiPicker?: boolean; // 이모지 선택기 표시 (기본: true)
1168
- filePanel?: boolean; // 파일 패널 표시 (기본: true)
1169
- tableHandles?: boolean; // 테이블 핸들 표시 (기본: true)
1170
- className?: string; // 컨테이너 CSS 클래스
1171
-
1172
- // === 링크 프리뷰 설정 ===
1173
- linkPreview?: {
1174
- apiEndpoint: string; // 링크 메타데이터를 가져올 API 엔드포인트 (예: "/api/link-preview")
1175
- };
1176
-
1177
- // 미디어 업로드 허용 여부 (기본: 모두 비활성)
1178
- allowVideoUpload?: boolean; // 비디오 업로드 허용 (기본: false)
1179
- allowAudioUpload?: boolean; // 오디오 업로드 허용 (기본: false)
1180
- allowFileUpload?: boolean; // 일반 파일 업로드 허용 (기본: false)
1181
- maxImageFileSize?: number; // 이미지 최대 파일 크기(바이트). 미설정 시 10MB
1182
- maxVideoFileSize?: number; // 동영상 최대 파일 크기(바이트). 미설정 시 100MB
1183
- }
1184
- ```
1185
-
1186
- </details>
1187
-
1188
- ---
1189
-
1190
- ## 사용 예제
1191
-
1192
- ### 읽기 전용 모드
1193
-
1194
- ```tsx
1195
- <LumirEditor
1196
- editable={false}
1197
- initialContent={savedContent}
1198
- sideMenu={false}
1199
- formattingToolbar={false}
1200
- />
1201
- ```
1202
-
1203
- ### 다크 테마
1204
-
1205
- ```tsx
1206
- <LumirEditor theme="dark" className="bg-gray-900 rounded-lg" />
1207
- ```
1208
-
1209
- ### 콘텐츠 저장 및 불러오기
1210
-
1211
- ```tsx
1212
- import { useState, useEffect } from "react";
1213
- import { LumirEditor, ContentUtils } from "@lumir-company/editor";
1214
-
1215
- function EditorWithSave() {
1216
- const [content, setContent] = useState("");
1217
-
1218
- // 불러오기
1219
- useEffect(() => {
1220
- const saved = localStorage.getItem("content");
1221
- if (saved && ContentUtils.isValidJSONString(saved)) {
1222
- setContent(saved);
1223
- }
1224
- }, []);
1225
-
1226
- // 저장
1227
- const handleChange = (blocks) => {
1228
- const json = JSON.stringify(blocks);
1229
- localStorage.setItem("content", json);
1230
- };
1231
-
1232
- return (
1233
- <LumirEditor initialContent={content} onContentChange={handleChange} />
1234
- );
1235
- }
1236
- ```
1237
-
1238
- ---
1239
-
1240
- ## 스타일링
1241
-
1242
- ### Tailwind CSS와 함께 사용
1243
-
1244
- ```tsx
1245
- import { LumirEditor, cn } from "@lumir-company/editor";
1246
-
1247
- <LumirEditor
1248
- className={cn(
1249
- "min-h-[400px] rounded-xl",
1250
- "border border-gray-200 shadow-lg",
1251
- "focus-within:ring-2 focus-within:ring-blue-500",
1252
- )}
1253
- />;
1254
- ```
1255
-
1256
- ### 커스텀 스타일
1257
-
1258
- ```css
1259
- /* globals.css */
1260
- .my-editor .bn-editor {
1261
- padding: 20px 30px;
1262
- font-size: 16px;
1263
- line-height: 1.6;
1264
- }
1265
-
1266
- .my-editor [data-content-type="heading"] {
1267
- font-weight: 700;
1268
- margin-top: 24px;
1269
- }
1270
- ```
1271
-
1272
- ```tsx
1273
- <LumirEditor className="my-editor" />
1274
- ```
1275
-
1276
- ---
1277
-
1278
- ## 트러블슈팅
1279
-
1280
- ### 필수 체크리스트
1281
-
1282
- - [ ] CSS 임포트: `import "@lumir-company/editor/style.css"`
1283
- - [ ] 컨테이너 높이 설정: 부모 요소에 높이 지정 필수
1284
- - [ ] Next.js: `dynamic(..., { ssr: false })` 사용
1285
- - [ ] React 버전: 18.0.0 이상
1286
-
1287
- ### 자주 발생하는 문제
1288
-
1289
- #### 1. 에디터가 보이지 않음
1290
-
1291
- ```tsx
1292
- // 잘못됨
1293
- <LumirEditor />;
1294
-
1295
- // 올바름
1296
- import "@lumir-company/editor/style.css";
1297
- <div className="h-[400px]">
1298
- <LumirEditor />
1299
- </div>;
1300
- ```
1301
-
1302
- #### 2. Next.js Hydration 오류
1303
-
1304
- ```tsx
1305
- // 잘못됨
1306
- import { LumirEditor } from "@lumir-company/editor";
1307
-
1308
- // 올바름
1309
- const LumirEditor = dynamic(
1310
- () =>
1311
- import("@lumir-company/editor").then((m) => ({ default: m.LumirEditor })),
1312
- { ssr: false },
1313
- );
1314
- ```
1315
-
1316
- #### 3. 이미지 업로드 실패
1317
-
1318
- ```tsx
1319
- // uploadFile 또는 s3Upload 중 하나는 반드시 설정!
1320
- <LumirEditor
1321
- s3Upload={{
1322
- apiEndpoint: "/api/s3/presigned",
1323
- env: "development",
1324
- path: "images",
1325
- }}
1326
- />
1327
- ```
1328
-
1329
- #### 4. 여러 이미지 업로드 시 중복 문제
1330
-
1331
- ```tsx
1332
- // 해결: appendUUID 사용
1333
- <LumirEditor
1334
- s3Upload={{
1335
- apiEndpoint: "/api/s3/presigned",
1336
- env: "production",
1337
- path: "images",
1338
- appendUUID: true, // 고유한 파일명 보장
1339
- }}
1340
- />
1341
- ```
1342
-
1343
- ---
1344
-
1345
- ## 유틸리티 API
1346
-
1347
- ### ContentUtils
1348
-
1349
- ```tsx
1350
- import { ContentUtils } from "@lumir-company/editor";
1351
-
1352
- // JSON 검증
1353
- ContentUtils.isValidJSONString('[{"type":"paragraph"}]'); // true
1354
-
1355
- // JSON 파싱
1356
- const blocks = ContentUtils.parseJSONContent(jsonString);
1357
-
1358
- // 기본 블록 생성
1359
- const emptyBlock = ContentUtils.createDefaultBlock();
1360
- ```
1361
-
1362
- ### createS3Uploader
1363
-
1364
- ```tsx
1365
- import { createS3Uploader } from "@lumir-company/editor";
1366
-
1367
- const uploader = createS3Uploader({
1368
- apiEndpoint: "/api/s3/presigned",
1369
- env: "production",
1370
- path: "uploads",
1371
- appendUUID: true,
1372
- });
1373
-
1374
- // 직접 사용
1375
- const url = await uploader(imageFile);
1376
- ```
1377
-
1378
- ## 관련 링크
1379
-
1380
- - [npm Package](https://www.npmjs.com/package/@lumir-company/editor)
1381
- - [BlockNote Documentation](https://www.blocknotejs.org/)
1382
-
1383
- ---
1384
-
1385
- ## 변경 로그
1386
-
1387
- ### v0.4.10
1388
-
1389
- - **동영상·이미지 업로드 진행률 표시**
1390
- - S3 업로드 진행률이 0만 보이다가 100으로 바로 완료되던 문제 개선
1391
- - `xhr.upload.onprogress`와 **보간 타이머**를 함께 사용해 중간 진행률(0→…→100)이 부드럽게 갱신되도록 변경
1392
- - 업로드 시작 직후 `onProgress(0)` 호출, 완료 시 `onProgress(100)` 보장
1393
- - README: `s3Upload.onProgress` 설명 및 업로드 진행률 표시 섹션 추가
1394
- - README: `S3UploaderConfig`에 `onProgress`, `uploadTimeoutMs`, `maxRetries` 문서화
1395
-
1396
- ### v0.4.9
1397
-
1398
- - **업로드 용량·타임아웃 사용자 설정**
1399
- - `maxImageFileSize`, `maxVideoFileSize` prop 추가 (미설정 시 기본 10MB/100MB)
1400
- - `isImageFile(file, maxSize?)`, `isVideoFile(file, maxSize?)` 시그니처 확장
1401
- - README: 용량 및 타임아웃 설정 예시 및 `s3Upload.uploadTimeoutMs` 안내 보강
1402
-
1403
- ### v0.4.8
1404
-
1405
- - README update (video & image upload)
1406
- - 버전 배포
1407
-
1408
- ### v0.4.6
1409
-
1410
- - **README: S3 Presigned URL API**
1411
- - Next.js App Router용 `app/api/s3/presigned/route.ts` 구현 예시 추가 (PutObjectCommand, getSignedUrl)
1412
- - Next.js가 아닌 프로젝트: Express 예시 및 Remix/SvelteKit 등 동일 패턴 안내
1413
- - **README: 이미지·동영상 업로드 경로 분리**
1414
- - `fileNameTransform`으로 이미지/동영상 prefix 분리 (`images/`, `videos/`) 예시 및 결과 경로 설명 추가
1415
-
1416
- ### v0.4.5
1417
-
1418
- - **README: 이미지·동영상 업로드**
1419
- - 지원 형식/용량, 삽입 경로, 설정 방법(s3Upload / uploadFile), 저장 데이터 구조, 삭제 콜백, 에러 처리 정리
1420
- - 동영상 블록은 직접 재생 가능한 파일 URL만 지원한다는 안내 추가 (YouTube/Vimeo 링크 미지원)
1421
-
1422
- ### v0.4.4
1423
-
1424
- - **Link Preview API 핸들러 내장**
1425
- - `@lumir-company/editor/api/link-preview` 서브패스 export 추가
1426
- - 표준 Web API (`Request`/`Response`) 기반으로 Next.js, Remix, SvelteKit 호환
1427
- - 소비자는 1줄 re-export만으로 API 라우트 설정 가능 (220줄 route.ts 제거)
1428
- - `linkPreviewHandler`, `fetchUrlMetadata`, `parseMetaTags` 함수 export
1429
- - **Placeholder 문서화**
1430
- - Placeholder 사용 가이드 추가
1431
- - **README 개선**
1432
- - 링크 프리뷰 서버사이드 요구사항 설정 방법 가이드 추가
1433
- - 내장 API 핸들러 export 목록 문서화
1434
- - Props API 테이블에 `placeholder`, `linkPreview` 추가
1435
-
1436
- ### v0.4.3
1437
-
1438
- - **링크 프리뷰 기능 추가**
1439
- - `linkPreview` prop으로 링크 미리보기 활성화 (카카오톡 스타일 OG 카드)
1440
- - URL 붙여넣기 시 자동 링크 프리뷰 블록 생성 (빈 블록이면 교체, 텍스트 있으면 하단 삽입)
1441
- - 슬래시 메뉴(`/`)에서 Link Preview 항목 추가
1442
- - 드래그 리사이즈 지원 (좌우 너비, 하단 이미지 높이 조절)
1443
- - 메타데이터에 이미지 없을 경우 이미지 영역 생략
1444
- - 에러 카드 클릭 링크 이동 지원
1445
- - `fetchLinkMetadata`, `clearMetadataCache`, `LinkMetadata` 타입 export
1446
- - **링크 툴바 커스텀**
1447
- - 텍스트 링크를 링크 프리뷰 블록으로 전환하는 버튼 추가 (`replaceBlocks` 사용)
1448
- - `linkPreview.apiEndpoint` 설정 시에만 전환 버튼 표시
1449
- - **placeholder prop 추가**
1450
- - `placeholder` prop으로 에디터 빈 블록 안내 텍스트 설정
1451
- - **이미지 삭제 기능 추가**
1452
- - `onImageDelete` 콜백 prop 추가 - 에디터에서 이미지 삭제 호출
1453
- - S3 외부 스토리지에서 이미지 자동 삭제 지원
1454
- - 지연 삭제 패턴으로 Undo/Redo 대응 가능
1455
- - 이미지 URL 추출 삭제 감지 헬퍼 함수 내장
1456
- - **보안 강화**
1457
- - URL 이스케이프 처리 추가 (XSS 방지)
1458
- - LinkButton: `javascript:`, `data:`, `vbscript:`, `file:` 프로토콜 차단
1459
- - 위험한 URL 입력 에러 메시지 표시
1460
- - **링크 삽입 버그 수정**
1461
- - 플로팅 메뉴 링크 버튼: 텍스트 미선택 시에도 URL 텍스트로 링크 삽입 지원
1462
- - `editor.focus()` 호출로 선택 상태 복원
1463
- - **README 개선**
1464
- - 링크 프리뷰 사용 가이드 API 라우트 예시 추가
1465
- - 이미지 삭제 섹션 추가 (지연 삭제 예시 포함)
1466
- - S3 삭제 API 구현 예시 추가
1467
- - Props API 문서 업데이트
1468
-
1469
- ### v0.4.2
1470
-
1471
- - **코드 구조 리팩토링**
1472
- - FloatingMenu 컴포넌트 분리 (Icons, 개별 버튼 컴포넌트)
1473
- - 색상 상수 별도 파일로 분리 (`constants/colors.ts`)
1474
- - 미사용 기능 제거 (FontSelect, FontSizeControl)
1475
- - **에러 처리 개선**
1476
- - `LumirEditorError` 커스텀 에러 클래스 추가
1477
- - `onError` 콜백 prop 추가 - 에러 발생 시 사용자 정의 핸들링 가능
1478
- - 에러 발생 사용자 친화적 토스트 메시지 자동 표시
1479
- - **HTML 미리보기 개선**
1480
- - sandbox 설정 명확화 (JavaScript 의도적 비활성화)
1481
- - 드래그 리사이즈, 열기, 다운로드 기능 문서화
1482
- - **타입 개선**
1483
- - `LumirErrorCode`, `LumirErrorDetails` 타입 export
1484
- - `ColorItem` 타입 export
1485
-
1486
- ### v0.4.1
1487
-
1488
- - `preserveExtension` prop 추가 - 확장자 자동 붙이기 제어 (기본: true)
1489
- - **중요**: 파일명 변환 시 확장자 위치 수정 (확장자가 항상 맨 뒤에 오도록)
1490
- - **Breaking Change**: `fileNameTransform` 파라미터 변경 - 이제 확장자 제외한 파일명만 전달됨
1491
- - 이전: `fileNameTransform: (originalName, file) => ...` → originalName에 확장자 포함
1492
- - 변경: `fileNameTransform: (nameWithoutExt, file) => ...` → nameWithoutExt에 확장자 제외
1493
- - 확장자 제거 사용 사례 문서화
1494
- - README 예제 설명 개선
1495
-
1496
- ### v0.4.0
1497
-
1498
- - 파일명 변환 콜백 (`fileNameTransform`) 추가
1499
- - UUID 자동 추가 옵션 (`appendUUID`) 추가
1500
- - 여러 이미지 동시 업로드 시 중복 문제 해결
1501
- - 문서 대폭 개선
1502
-
1503
- ### v0.3.3
1504
-
1505
- - 에디터 재생성 방지 최적화
1506
- - 타입 정의 개선
1
+ # LumirEditor
2
+
3
+ **이미지 전용** BlockNote 기반 Rich Text 에디터
4
+
5
+ [![npm version](https://img.shields.io/npm/v/@lumir-company/editor.svg)](https://www.npmjs.com/package/@lumir-company/editor)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
+
8
+ > 이미지 업로드에 최적화된 경량 에디터. S3 업로드, 파일명 커스터마이징, 로딩 스피너 내장.
9
+
10
+ ---
11
+
12
+ ## 목차
13
+
14
+ - [특징](#특징)
15
+ - [빠른 시작](#빠른-시작)
16
+ - [이미지 업로드](#이미지-업로드)
17
+ - [S3 업로드 설정](#1-s3-업로드-권장)
18
+ - [파일명 커스터마이징](#파일명-커스터마이징)
19
+ - [커스텀 업로더](#2-커스텀-업로더)
20
+ - [동영상 업로드 및 임베딩](#동영상-업로드-및-임베딩)
21
+ - [업로드 진행률 표시](#업로드-진행률-표시-이미지동영상-공통)
22
+ - [이미지·동영상 업로드 상세 가이드](#이미지동영상-업로드-상세-가이드)
23
+ - [이미지·비디오 삭제](#이미지비디오-삭제)
24
+ - [HTML 미리보기](#html-미리보기)
25
+ - [Placeholder](#placeholder)
26
+ - [링크 프리뷰](#링크-프리뷰)
27
+ - [Props API](#props-api)
28
+ - [사용 예제](#사용-예제)
29
+ - [스타일링](#스타일링)
30
+ - [트러블슈팅](#트러블슈팅)
31
+
32
+ ---
33
+
34
+ ## 특징
35
+
36
+ | 특징 | 설명 |
37
+ | ----------------------- | -------------------------------------------------------------------------------- |
38
+ | **이미지 전용** | 이미지 업로드/드래그앤드롭 기본 지원 (비디오는 `allowVideoUpload`로 옵션 활성화) |
39
+ | **HTML 미리보기** | HTML 파일을 드래그 앤 드롭하여 iframe으로 미리보기 |
40
+ | **S3 연동** | Presigned URL 기반 S3 업로드 내장 |
41
+ | **파일명 커스터마이징** | 업로드 파일명 변경 콜백 + UUID 자동 추가 지원 |
42
+ | **로딩 스피너** | 이미지 업로드 중 자동 스피너 표시 |
43
+ | **성능 최적화** | 애니메이션 비활성화로 빠른 렌더링 |
44
+ | **TypeScript** | 완전한 타입 안전성 |
45
+ | **테마 지원** | 라이트/다크 테마 및 커스텀 테마 |
46
+
47
+ ### 지원 이미지 형식
48
+
49
+ ```
50
+ PNG, JPEG/JPG, GIF, WebP, BMP
51
+ ```
52
+
53
+ ---
54
+
55
+ ## 빠른 시작
56
+
57
+ ### 1. 설치
58
+
59
+ ```bash
60
+ npm install @lumir-company/editor
61
+ # 또는
62
+ yarn add @lumir-company/editor
63
+ ```
64
+
65
+ **필수 Peer Dependencies:**
66
+
67
+ - `react` >= 18.0.0
68
+ - `react-dom` >= 18.0.0
69
+
70
+ ### 2. 기본 사용
71
+
72
+ ```tsx
73
+ import { LumirEditor } from "@lumir-company/editor";
74
+ import "@lumir-company/editor/style.css"; // 필수!
75
+
76
+ export default function App() {
77
+ return (
78
+ <div className="w-full h-[500px]">
79
+ <LumirEditor onContentChange={(blocks) => console.log(blocks)} />
80
+ </div>
81
+ );
82
+ }
83
+ ```
84
+
85
+ > **중요**: `style.css`를 임포트하지 않으면 에디터가 정상 작동하지 않습니다.
86
+
87
+ ### 3. Next.js에서 사용
88
+
89
+ ```tsx
90
+ "use client";
91
+
92
+ import dynamic from "next/dynamic";
93
+ import "@lumir-company/editor/style.css";
94
+
95
+ // SSR 비활성화 필수
96
+ const LumirEditor = dynamic(
97
+ () =>
98
+ import("@lumir-company/editor").then((m) => ({ default: m.LumirEditor })),
99
+ { ssr: false },
100
+ );
101
+
102
+ export default function EditorPage() {
103
+ return (
104
+ <div className="h-[500px]">
105
+ <LumirEditor />
106
+ </div>
107
+ );
108
+ }
109
+ ```
110
+
111
+ ---
112
+
113
+ ## 이미지 업로드
114
+
115
+ ### 1. S3 업로드 (권장)
116
+
117
+ Presigned URL을 사용한 안전한 S3 업로드 방식입니다.
118
+
119
+ ```tsx
120
+ <LumirEditor
121
+ s3Upload={{
122
+ apiEndpoint: "/api/s3/presigned",
123
+ env: "production",
124
+ path: "blog/images",
125
+ }}
126
+ />
127
+ ```
128
+
129
+ #### S3 파일 저장 경로
130
+
131
+ ```
132
+ {env}/{path}/{filename}
133
+
134
+ 예시:
135
+ production/blog/images/my-photo.png
136
+ ```
137
+
138
+ #### API 엔드포인트 응답 형식
139
+
140
+ 서버는 다음 형식으로 응답해야 합니다:
141
+
142
+ ```json
143
+ {
144
+ "presignedUrl": "https://s3.amazonaws.com/bucket/upload-url",
145
+ "publicUrl": "https://cdn.example.com/production/blog/images/my-photo.png"
146
+ }
147
+ ```
148
+
149
+ 클라이언트는 `apiEndpoint?key={파일키}&contentType={MIME}` 형태로 GET 요청을 보내고, 서버는 위 형식으로 JSON을 반환하면 됩니다.
150
+
151
+ #### S3 Presigned URL API 구현 예시
152
+
153
+ **Next.js (App Router)**
154
+
155
+ 파일: `app/api/s3/presigned/route.ts`
156
+
157
+ ```typescript
158
+ import { NextRequest, NextResponse } from "next/server";
159
+ import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3";
160
+ import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
161
+
162
+ const s3 = new S3Client({
163
+ region: process.env.AWS_REGION!,
164
+ credentials: {
165
+ accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
166
+ secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
167
+ },
168
+ });
169
+
170
+ export async function GET(req: NextRequest) {
171
+ const { searchParams } = new URL(req.url);
172
+ const key = searchParams.get("key");
173
+ const contentType = searchParams.get("contentType");
174
+
175
+ if (!key) {
176
+ return NextResponse.json({ error: "key is required" }, { status: 400 });
177
+ }
178
+
179
+ const command = new PutObjectCommand({
180
+ Bucket: process.env.AWS_S3_BUCKET!,
181
+ Key: key,
182
+ ContentType: contentType || "application/octet-stream",
183
+ });
184
+
185
+ const presignedUrl = await getSignedUrl(s3, command, { expiresIn: 60 });
186
+ const publicUrl = `https://${process.env.AWS_S3_BUCKET}.s3.${process.env.AWS_REGION}.amazonaws.com/${key}`;
187
+
188
+ return NextResponse.json({ presignedUrl, publicUrl, key });
189
+ }
190
+ ```
191
+
192
+ 필요한 환경 변수: `AWS_REGION`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_S3_BUCKET`
193
+
194
+ **Next.js가 아닌 프로젝트에서 사용하기**
195
+
196
+ 동일하게 **GET** 요청으로 `key`, `contentType` 쿼리 파라미터를 받아 `presignedUrl`, `publicUrl`을 JSON으로 반환하는 엔드포인트를 구현하면 됩니다.
197
+
198
+ - **Express (Node.js)**
199
+
200
+ ```javascript
201
+ const express = require("express");
202
+ const { S3Client, PutObjectCommand } = require("@aws-sdk/client-s3");
203
+ const { getSignedUrl } = require("@aws-sdk/s3-request-presigner");
204
+
205
+ const s3 = new S3Client({
206
+ region: process.env.AWS_REGION,
207
+ credentials: {
208
+ accessKeyId: process.env.AWS_ACCESS_KEY_ID,
209
+ secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
210
+ },
211
+ });
212
+
213
+ app.get("/api/s3/presigned", async (req, res) => {
214
+ const key = req.query.key;
215
+ const contentType = req.query.contentType || "application/octet-stream";
216
+
217
+ if (!key) {
218
+ return res.status(400).json({ error: "key is required" });
219
+ }
220
+
221
+ const command = new PutObjectCommand({
222
+ Bucket: process.env.AWS_S3_BUCKET,
223
+ Key: key,
224
+ ContentType: contentType,
225
+ });
226
+
227
+ const presignedUrl = await getSignedUrl(s3, command, { expiresIn: 60 });
228
+ const publicUrl = `https://${process.env.AWS_S3_BUCKET}.s3.${process.env.AWS_REGION}.amazonaws.com/${key}`;
229
+
230
+ res.json({ presignedUrl, publicUrl, key });
231
+ });
232
+ ```
233
+
234
+ 에디터 사용 시 `apiEndpoint`만 해당 서버 주소로 맞추면 됩니다.
235
+
236
+ ```tsx
237
+ <LumirEditor
238
+ s3Upload={{
239
+ apiEndpoint: "https://api.myapp.com/api/s3/presigned",
240
+ env: "production",
241
+ path: "uploads",
242
+ }}
243
+ />
244
+ ```
245
+
246
+ - **Remix / SvelteKit / 기타 프레임워크**
247
+ GET 라우트에서 `key`, `contentType`을 받아 `@aws-sdk/client-s3`의 `PutObjectCommand`와 `@aws-sdk/s3-request-presigner`의 `getSignedUrl`로 presigned URL을 생성한 뒤, `{ presignedUrl, publicUrl, key }` 형태로 JSON 응답하면 동일하게 사용할 수 있습니다. CORS가 필요한 경우 해당 도메인을 허용해 두세요.
248
+
249
+ ---
250
+
251
+ ### 파일명 커스터마이징
252
+
253
+ 여러 이미지를 동시에 업로드할 때 파일명 중복을 방지하고 관리하기 쉽게 만드는 기능입니다.
254
+
255
+ > **참고**: 기본적으로 확장자는 자동으로 붙습니다. `preserveExtension: false`로 설정하면 확장자를 붙이지 않습니다.
256
+
257
+ #### 옵션 1: UUID 자동 추가
258
+
259
+ ```tsx
260
+ <LumirEditor
261
+ s3Upload={{
262
+ apiEndpoint: "/api/s3/presigned",
263
+ env: "production",
264
+ path: "uploads",
265
+ appendUUID: true, // 파일명 뒤에 UUID 자동 추가
266
+ }}
267
+ />
268
+ ```
269
+
270
+ **결과:**
271
+
272
+ ```
273
+ 원본: photo.png
274
+ 업로드: photo_550e8400-e29b-41d4-a716-446655440000.png
275
+ ```
276
+
277
+ #### 옵션 2: 파일명 변환 콜백
278
+
279
+ ```tsx
280
+ <LumirEditor
281
+ s3Upload={{
282
+ apiEndpoint: "/api/s3/presigned",
283
+ env: "production",
284
+ path: "uploads",
285
+ fileNameTransform: (nameWithoutExt, file) => {
286
+ // nameWithoutExt는 확장자가 제거된 파일명 (예: "photo")
287
+ // 확장자는 자동으로 붙습니다
288
+ const userId = getCurrentUserId();
289
+ return `${userId}_${nameWithoutExt}`;
290
+ },
291
+ }}
292
+ />
293
+ ```
294
+
295
+ **결과:**
296
+
297
+ ```
298
+ 원본: photo.png
299
+ → nameWithoutExt: "photo"
300
+ → 변환 후: "user123_photo"
301
+ → 최종: user123_photo.png
302
+ ```
303
+
304
+ #### 옵션 3: 조합 사용 (권장)
305
+
306
+ ```tsx
307
+ <LumirEditor
308
+ s3Upload={{
309
+ apiEndpoint: "/api/s3/presigned",
310
+ env: "production",
311
+ path: "uploads",
312
+ fileNameTransform: (nameWithoutExt) => `user123_${nameWithoutExt}`,
313
+ appendUUID: true, // 변환 후 UUID 추가
314
+ }}
315
+ />
316
+ ```
317
+
318
+ **결과:**
319
+
320
+ ```
321
+ 원본: photo.png
322
+ → nameWithoutExt: "photo"
323
+ 1. fileNameTransform 적용: "user123_photo"
324
+ 2. appendUUID 적용: "user123_photo_550e8400-e29b-41d4"
325
+ 3. 확장자 붙이기: user123_photo_550e8400-e29b-41d4.png
326
+ ```
327
+
328
+ #### 실전 예제: 타임스탬프 + UUID
329
+
330
+ ```tsx
331
+ function MyEditor() {
332
+ return (
333
+ <LumirEditor
334
+ s3Upload={{
335
+ apiEndpoint: "/api/s3/presigned",
336
+ env: "production",
337
+ path: "uploads",
338
+ fileNameTransform: (nameWithoutExt, file) => {
339
+ // nameWithoutExt는 이미 확장자가 제거됨
340
+ const timestamp = new Date().toISOString().split("T")[0]; // 2024-01-15
341
+ return `${timestamp}_${nameWithoutExt}`;
342
+ },
343
+ appendUUID: true,
344
+ }}
345
+ />
346
+ );
347
+ }
348
+ ```
349
+
350
+ **결과:**
351
+
352
+ ```
353
+ 원본: photo.png
354
+ → nameWithoutExt: "photo"
355
+ 1. fileNameTransform: "2024-01-15_photo"
356
+ 2. appendUUID: "2024-01-15_photo_550e8400-e29b-41d4"
357
+ 3. 확장자 붙이기: 2024-01-15_photo_550e8400-e29b-41d4.png
358
+ ```
359
+
360
+ #### 옵션 4: 확장자 제거 (preserveExtension: false)
361
+
362
+ ```tsx
363
+ <LumirEditor
364
+ s3Upload={{
365
+ apiEndpoint: "/api/s3/presigned",
366
+ env: "production",
367
+ path: "uploads",
368
+ fileNameTransform: (nameWithoutExt) => `${nameWithoutExt}_custom`,
369
+ preserveExtension: false, // 확장자 안 붙임
370
+ }}
371
+ />
372
+ ```
373
+
374
+ **결과:**
375
+
376
+ ```
377
+ 원본: photo.png
378
+ → nameWithoutExt: "photo"
379
+ → 변환 후: "photo_custom"
380
+ → 최종: photo_custom (확장자 없음)
381
+ ```
382
+
383
+ **사용 사례**: WebP 변환 등 서버에서 확장자를 변경하는 경우
384
+
385
+ ```tsx
386
+ fileNameTransform: (nameWithoutExt) => `${nameWithoutExt}.webp`,
387
+ preserveExtension: false,
388
+ ```
389
+
390
+ ---
391
+
392
+ ### 2. 커스텀 업로더
393
+
394
+ 자체 업로드 로직을 사용할 때:
395
+
396
+ ```tsx
397
+ <LumirEditor
398
+ uploadFile={async (file) => {
399
+ const formData = new FormData();
400
+ formData.append("image", file);
401
+
402
+ const response = await fetch("/api/upload", {
403
+ method: "POST",
404
+ body: formData,
405
+ });
406
+
407
+ const { url } = await response.json();
408
+ return url; // 업로드된 이미지 URL 반환
409
+ }}
410
+ />
411
+ ```
412
+
413
+ ### 3. 헬퍼 함수 사용
414
+
415
+ ```tsx
416
+ import { createS3Uploader } from "@lumir-company/editor";
417
+
418
+ const s3Uploader = createS3Uploader({
419
+ apiEndpoint: "/api/s3/presigned",
420
+ env: "production",
421
+ path: "images",
422
+ appendUUID: true,
423
+ });
424
+
425
+ // 에디터에 적용
426
+ <LumirEditor uploadFile={s3Uploader} />;
427
+
428
+ // 또는 별도로 사용
429
+ const imageUrl = await s3Uploader(imageFile);
430
+ ```
431
+
432
+ ### 업로드 우선순위
433
+
434
+ 1. `uploadFile` prop이 있으면 우선 사용
435
+ 2. `uploadFile` 없고 `s3Upload`가 있으면 S3 업로드 사용
436
+ 3. 둘 다 없으면 업로드 실패
437
+
438
+ ---
439
+
440
+ ## 동영상 업로드 및 임베딩
441
+
442
+ `allowVideoUpload={true}`로 설정하면 동영상 업로드와 에디터 내 재생이 가능합니다. S3/`uploadFile`은 이미지와 동일한 설정을 사용하며, 동영상은 최대 100MB까지 허용됩니다.
443
+
444
+ ### 동영상 업로드 활성화
445
+
446
+ ```tsx
447
+ <LumirEditor
448
+ allowVideoUpload={true}
449
+ s3Upload={{
450
+ apiEndpoint: "/api/s3/presigned",
451
+ env: "production",
452
+ path: "videos",
453
+ appendUUID: true,
454
+ }}
455
+ />
456
+ ```
457
+
458
+ - **지원 형식**: MP4, WebM, OGG
459
+ - **삽입 경로**: 붙여넣기, 드래그 앤 드롭, 슬래시 메뉴("Video"), FloatingMenu 이미지/동영상 버튼
460
+
461
+ ### 업로드 진행률 표시 (이미지·동영상 공통)
462
+
463
+ S3 업로드 시 `s3Upload.onProgress` 콜백을 지정하면 업로드 진행률(0~100%)을 받을 수 있습니다. 에디터는 내부적으로 이 값을 사용해 업로드 중 툴바에 **"n%"** 를 표시합니다. 동영상처럼 대용량 파일은 브라우저가 `progress` 이벤트를 자주 보내지 않을 수 있어, 내부적으로 **보간 로직**을 적용해 0→100만 보이지 않고 중간 진행률이 부드럽게 갱신되도록 했습니다.
464
+
465
+ ```tsx
466
+ <LumirEditor
467
+ allowVideoUpload={true}
468
+ s3Upload={{
469
+ apiEndpoint: "/api/s3/presigned",
470
+ env: "production",
471
+ path: "videos",
472
+ appendUUID: true,
473
+ onProgress: (percent) => {
474
+ console.log(`업로드 진행률: ${percent}%`);
475
+ // 에디터 기본 UI에 이미 표시되며, 필요 시 자체 프로그레스 바 등에 연동 가능
476
+ },
477
+ }}
478
+ />
479
+ ```
480
+
481
+ - **동작**: S3 PUT 요청 시에만 호출됩니다. Presigned URL 요청 단계에서는 호출되지 않습니다.
482
+ - **표시**: `onProgress`를 넘기면 에디터 툴바에 `n%`가 자동 표시되며, 업로드 완료 시 숨겨집니다.
483
+
484
+ ### 데이터 내부 동영상 임베딩
485
+
486
+ 동영상 블록은 `initialContent` / `onContentChange`에 포함됩니다. 저장 시 `{ type: "video", props: { url: "..." } }` 형태로 블록이 유지됩니다.
487
+
488
+ - **재생**: 화면에서 동영상을 재생하려면 `allowVideoUpload={true}`로 두어야 합니다. 이렇게 해야 video 확장이 활성화되어 BlockNote 기본 플레이어가 렌더링됩니다.
489
+ - `allowVideoUpload={false}`인 상태에서 initialContent에 video 블록만 넣으면 데이터는 보존되지만, 재생 UI는 비활성화된 확장 때문에 표시되지 않을 수 있습니다.
490
+ - **지원 URL**: 비디오 블록의 `url`은 **직접 재생 가능한 비디오 파일 URL**만 지원합니다(예: S3에 업로드된 `.mp4`, `.webm`, `.ogg`). YouTube·Vimeo 등 스트리밍 페이지 URL(`youtube.com/watch?v=...` 등)은 `<video>` 요소의 `src`로 재생되지 않으므로, 해당 링크를 video 블록 URL로 넣으면 재생되지 않습니다. YouTube 임베드가 필요하면 별도 embed 블록 또는 iframe 삽입 방식을 고려해야 합니다.
491
+
492
+ ---
493
+
494
+ ## 이미지·동영상 업로드 상세 가이드
495
+
496
+ 이미지와 동영상 업로드 기능을 함께 쓰는 방법을 단계별로 정리했습니다.
497
+
498
+ ### 1. 개요
499
+
500
+ | 구분 | 이미지 | 동영상 |
501
+ | --------------- | ------------------------------- | ------------------------------------------ |
502
+ | **기본 동작** | 업로드 항상 사용 가능 (설정 시) | `allowVideoUpload={true}`일 때만 사용 가능 |
503
+ | **최대 용량** | 10MB | 100MB |
504
+ | **업로드 설정** | `s3Upload` 또는 `uploadFile` | 이미지와 동일한 설정 공유 |
505
+
506
+ - 이미지만 쓸 때: `s3Upload` 또는 `uploadFile`만 설정하면 됩니다.
507
+ - 이미지 + 동영상: 위 설정에 더해 `allowVideoUpload={true}`를 넣습니다.
508
+
509
+ ### 2. 지원 형식 및 제한
510
+
511
+ **이미지**
512
+
513
+ - **MIME**: `image/jpeg`, `image/png`, `image/gif`, `image/webp`, `image/bmp`
514
+ - **확장자**: `.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.bmp`
515
+ - **용량**: 기본 최대 10MB. `maxImageFileSize`(바이트)로 변경 가능.
516
+ - **제외**: SVG (XSS 방지로 업로드 불가)
517
+
518
+ **동영상** (`allowVideoUpload={true}`일 때)
519
+
520
+ - **MIME**: `video/mp4`, `video/webm`, `video/ogg`, `video/quicktime`
521
+ - **확장자**: `.mp4`, `.webm`, `.ogg`, `.mov`
522
+ - **용량**: 기본 최대 100MB. `maxVideoFileSize`(바이트)로 변경 가능.
523
+
524
+ **업로드 타임아웃**: S3 업로드 시 PUT 요청 타임아웃은 `s3Upload.uploadTimeoutMs`로 설정합니다. 미설정 시 120초(120000ms)가 적용됩니다.
525
+
526
+ **용량 및 타임아웃 사용자 설정**
527
+
528
+ 이미지·동영상 최대 용량과 S3 PUT 타임아웃을 props로 변경할 수 있습니다. 미설정 시 기본값(이미지 10MB, 동영상 100MB, 타임아웃 120초)이 적용됩니다.
529
+
530
+ ```tsx
531
+ <LumirEditor
532
+ allowVideoUpload={true}
533
+ maxImageFileSize={5 * 1024 * 1024} // 5MB
534
+ maxVideoFileSize={200 * 1024 * 1024} // 200MB
535
+ s3Upload={{
536
+ apiEndpoint: "/api/s3/presigned",
537
+ env: "production",
538
+ path: "uploads",
539
+ uploadTimeoutMs: 180000, // 180초 (대용량 동영상 시 연장)
540
+ }}
541
+ />
542
+ ```
543
+
544
+ ### 3. 삽입 경로 (공통)
545
+
546
+ 이미지·동영상 모두 아래 경로로 삽입할 수 있습니다.
547
+
548
+ | 경로 | 설명 |
549
+ | ------------------ | ----------------------------------------------------------------- |
550
+ | **붙여넣기** | 클립보드 이미지/동영상 → Ctrl+V (또는 Cmd+V) |
551
+ | **드래그 앤 드롭** | 파일을 에디터 영역으로 끌어다 놓기 |
552
+ | **슬래시 메뉴** | `/` 입력 후 "Image" 또는 "Video"(동영상 허용 시) 선택 → 파일 선택 |
553
+ | **FloatingMenu** | 툴바의 이미지/동영상 버튼 클릭 → 파일 선택 |
554
+
555
+ 동영상은 `allowVideoUpload={true}`일 때만 슬래시 메뉴에 "Video"가 보이고, FloatingMenu에서도 동영상 파일을 선택할 수 있습니다.
556
+
557
+ ### 4. 설정 방법 요약
558
+
559
+ **우선순위**
560
+
561
+ 1. `uploadFile` prop이 있으면 → 해당 함수로 업로드 (이미지·동영상 동일)
562
+ 2. `uploadFile` 없고 `s3Upload`가 있으면 → Presigned URL 기반 S3 업로드
563
+ 3. 둘 다 없으면 → 업로드 시 에러 (에디터는 동작하지만 파일 삽입 불가)
564
+
565
+ **이미지만 사용하는 경우**
566
+
567
+ ```tsx
568
+ <LumirEditor
569
+ s3Upload={{
570
+ apiEndpoint: "/api/s3/presigned",
571
+ env: "production",
572
+ path: "images",
573
+ appendUUID: true,
574
+ }}
575
+ onContentChange={(blocks) => setContent(blocks)}
576
+ />
577
+ ```
578
+
579
+ **이미지 + 동영상 사용하는 경우**
580
+
581
+ ```tsx
582
+ <LumirEditor
583
+ allowVideoUpload={true}
584
+ s3Upload={{
585
+ apiEndpoint: "/api/s3/presigned",
586
+ env: "production",
587
+ path: "images",
588
+ appendUUID: true,
589
+ }}
590
+ onContentChange={(blocks) => setContent(blocks)}
591
+ />
592
+ ```
593
+
594
+ 동영상은 같은 `s3Upload`로 업로드됩니다. 서버에서 이미지와 동영상을 다른 경로에 두고 싶다면 아래처럼 `fileNameTransform`으로 prefix를 분리하면 됩니다.
595
+
596
+ **이미지·동영상 업로드 경로 분리 (fileNameTransform)**
597
+
598
+ `fileNameTransform`의 두 번째 인자 `file`로 이미지/동영상을 구분해, 파일명 앞에 폴더 prefix를 붙이면 됩니다. 최종 S3 키는 `{env}/{path}/{filename}` 이므로, `filename`에 `images/...` / `videos/...` 를 넣으면 경로가 나뉩니다.
599
+
600
+ ```tsx
601
+ <LumirEditor
602
+ allowVideoUpload={true}
603
+ s3Upload={{
604
+ apiEndpoint: "/api/s3/presigned",
605
+ env: "production",
606
+ path: "uploads", // 공통 상위 경로
607
+ appendUUID: true,
608
+ fileNameTransform: (nameWithoutExt, file) => {
609
+ const isVideo = file.type.startsWith("video/");
610
+ return `${isVideo ? "videos" : "images"}/${nameWithoutExt}`;
611
+ },
612
+ }}
613
+ />
614
+ ```
615
+
616
+ 결과 예: 이미지 → `production/uploads/images/photo_abc123.png`, 동영상 → `production/uploads/videos/clip_def456.mp4`
617
+
618
+ **커스텀 업로더로 이미지·동영상 통합**
619
+
620
+ ```tsx
621
+ <LumirEditor
622
+ allowVideoUpload={true}
623
+ uploadFile={async (file) => {
624
+ const formData = new FormData();
625
+ formData.append("file", file);
626
+ const res = await fetch("/api/upload", { method: "POST", body: formData });
627
+ const { url } = await res.json();
628
+ return url;
629
+ }}
630
+ />
631
+ ```
632
+
633
+ `uploadFile`은 이미지/동영상 구분 없이 `File`을 받아 업로드 후 **공개 URL 문자열**을 반환하면 됩니다.
634
+
635
+ ### 5. 저장 데이터 구조
636
+
637
+ `onContentChange` / `initialContent`에서 사용하는 블록 형태입니다.
638
+
639
+ **이미지 블록**
640
+
641
+ ```json
642
+ {
643
+ "type": "image",
644
+ "props": {
645
+ "url": "https://your-cdn.com/images/photo_xxx.png",
646
+ "caption": "",
647
+ "previewWidth": 512
648
+ },
649
+ "content": [],
650
+ "children": []
651
+ }
652
+ ```
653
+
654
+ **동영상 블록**
655
+
656
+ ```json
657
+ {
658
+ "type": "video",
659
+ "props": {
660
+ "url": "https://your-cdn.com/videos/clip_xxx.mp4"
661
+ },
662
+ "content": [],
663
+ "children": []
664
+ }
665
+ ```
666
+
667
+ `url`은 반드시 **브라우저에서 직접 재생 가능한 URL**이어야 합니다. 동영상은 YouTube/Vimeo 링크가 아니라, 업로드 후 받은 `.mp4` 등 직접 재생 URL만 지원합니다.
668
+
669
+ ### 6. 삭제 시 콜백
670
+
671
+ 이미지·동영상 블록을 에디터에서 삭제하면 `onImageDelete`가 호출됩니다. 인자는 삭제된 미디어의 URL입니다.
672
+
673
+ ```tsx
674
+ <LumirEditor
675
+ s3Upload={{ ... }}
676
+ allowVideoUpload={true}
677
+ onImageDelete={(url) => {
678
+ // url은 이미지 또는 동영상 URL
679
+ console.log("삭제됨:", url);
680
+ // S3/스토리지에서 삭제 API 호출
681
+ }}
682
+ />
683
+ ```
684
+
685
+ Undo로 블록을 복원해도 이미 삭제 API를 호출했다면 서버 상태와 불일치할 수 있으므로, 지연 삭제(예: 5분 후 삭제) 패턴을 권장합니다. 자세한 예시는 [이미지·비디오 삭제](#이미지비디오-삭제)를 참고하세요.
686
+
687
+ ### 7. 에러 처리
688
+
689
+ - **지원하지 않는 형식**: 업로드 시 `LumirEditorError`가 발생할 수 있으며, `onError`로 처리할 수 있습니다.
690
+ - **용량 초과**: 기본 한도(이미지 10MB·동영상 100MB)를 넘으면 업로드가 거부됩니다. `maxImageFileSize`, `maxVideoFileSize`로 한도를 변경할 수 있습니다.
691
+ - **업로드 실패**: `uploadFile` 또는 S3 업로드에서 예외가 나면 해당 파일만 삽입되지 않고, 콘솔에 경고가 출력됩니다.
692
+
693
+ ```tsx
694
+ <LumirEditor
695
+ s3Upload={{ ... }}
696
+ onError={(err) => {
697
+ console.error("에디터 에러:", err);
698
+ // 토스트 등으로 사용자 알림
699
+ }}
700
+ />
701
+ ```
702
+
703
+ ---
704
+
705
+ ## 이미지·비디오 삭제
706
+
707
+ 에디터에서 **이미지 또는 비디오**가 삭제될 때 S3 등 외부 스토리지에서도 자동으로 삭제하고 싶다면 `onImageDelete` 콜백을 사용하세요. 이미지 블록과 비디오 블록 삭제 시 모두 호출됩니다.
708
+
709
+ ### 기본 사용
710
+
711
+ ```tsx
712
+ <LumirEditor
713
+ s3Upload={{
714
+ apiEndpoint: "/api/s3/presigned",
715
+ env: "production",
716
+ path: "images",
717
+ }}
718
+ onImageDelete={(imageUrl) => {
719
+ console.log("미디어(이미지/비디오) 삭제됨:", imageUrl);
720
+ // S3에서 삭제 로직 구현
721
+ }}
722
+ />
723
+ ```
724
+
725
+ ### 권장: 지연 삭제 (Undo/Redo 대응)
726
+
727
+ Undo로 이미지·비디오를 복원할 수 있도록 **지연 삭제**를 권장합니다.
728
+
729
+ ```tsx
730
+ "use client";
731
+
732
+ import { useState, useRef, useCallback } from "react";
733
+
734
+ function Editor() {
735
+ const pendingDeletes = useRef(new Map());
736
+
737
+ const handleImageDelete = useCallback((imageUrl: string) => {
738
+ // 이미 예약된 삭제가 있으면 무시
739
+ if (pendingDeletes.current.has(imageUrl)) return;
740
+
741
+ // 5분 후 삭제 예약
742
+ const timeoutId = setTimeout(
743
+ async () => {
744
+ pendingDeletes.current.delete(imageUrl);
745
+
746
+ // S3에서 실제 삭제
747
+ await fetch(`/api/s3/delete?url=${encodeURIComponent(imageUrl)}`, {
748
+ method: "DELETE",
749
+ });
750
+ },
751
+ 5 * 60 * 1000,
752
+ ); // 5분
753
+
754
+ pendingDeletes.current.set(imageUrl, timeoutId);
755
+ }, []);
756
+
757
+ return (
758
+ <LumirEditor
759
+ s3Upload={
760
+ {
761
+ /* ... */
762
+ }
763
+ }
764
+ onImageDelete={handleImageDelete}
765
+ />
766
+ );
767
+ }
768
+ ```
769
+
770
+ ### S3 삭제 API 예시
771
+
772
+ > **참고**: `onImageDelete`는 **프레임워크 독립적**이며, 이미지와 비디오 삭제 시 모두 호출됩니다. 아래는 각 환경별 구현 예시입니다.
773
+
774
+ #### Next.js API Route
775
+
776
+ **파일**: `app/api/s3/delete/route.ts`
777
+
778
+ ```typescript
779
+ import { NextRequest, NextResponse } from "next/server";
780
+ import { S3Client, DeleteObjectCommand } from "@aws-sdk/client-s3";
781
+
782
+ const s3 = new S3Client({
783
+ region: process.env.AWS_REGION!,
784
+ credentials: {
785
+ accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
786
+ secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
787
+ },
788
+ });
789
+
790
+ export async function DELETE(req: NextRequest) {
791
+ const { searchParams } = new URL(req.url);
792
+ const imageUrl = searchParams.get("url");
793
+
794
+ if (!imageUrl) {
795
+ return NextResponse.json({ error: "url is required" }, { status: 400 });
796
+ }
797
+
798
+ // URL에서 S3 키 추출
799
+ const key = extractKeyFromUrl(imageUrl);
800
+
801
+ await s3.send(
802
+ new DeleteObjectCommand({
803
+ Bucket: process.env.AWS_S3_BUCKET!,
804
+ Key: key,
805
+ }),
806
+ );
807
+
808
+ return NextResponse.json({ success: true });
809
+ }
810
+
811
+ function extractKeyFromUrl(url: string): string {
812
+ const urlObj = new URL(url);
813
+ return decodeURIComponent(urlObj.pathname.slice(1));
814
+ }
815
+ ```
816
+
817
+ **클라이언트 구현**:
818
+
819
+ ```tsx
820
+ const handleImageDelete = (imageUrl: string) => {
821
+ fetch(`/api/s3/delete?url=${encodeURIComponent(imageUrl)}`, {
822
+ method: "DELETE",
823
+ });
824
+ };
825
+
826
+ <LumirEditor onImageDelete={handleImageDelete} />;
827
+ ```
828
+
829
+ #### React + Express
830
+
831
+ **서버** (`server.js`):
832
+
833
+ ```javascript
834
+ app.delete("/api/images", async (req, res) => {
835
+ const { imageUrl } = req.body;
836
+ const key = extractKeyFromS3Url(imageUrl);
837
+
838
+ await s3Client.send(
839
+ new DeleteObjectCommand({
840
+ Bucket: process.env.S3_BUCKET,
841
+ Key: key,
842
+ }),
843
+ );
844
+
845
+ res.json({ success: true });
846
+ });
847
+ ```
848
+
849
+ **클라이언트**:
850
+
851
+ ```tsx
852
+ const handleImageDelete = async (imageUrl: string) => {
853
+ await fetch("https://api.myapp.com/api/images", {
854
+ method: "DELETE",
855
+ headers: { "Content-Type": "application/json" },
856
+ body: JSON.stringify({ imageUrl }),
857
+ });
858
+ };
859
+
860
+ <LumirEditor onImageDelete={handleImageDelete} />;
861
+ ```
862
+
863
+ #### React Native + Firebase Storage
864
+
865
+ ```tsx
866
+ import storage from "@react-native-firebase/storage";
867
+
868
+ const handleImageDelete = async (imageUrl: string) => {
869
+ const ref = storage().refFromURL(imageUrl);
870
+ await ref.delete();
871
+ };
872
+
873
+ <LumirEditor onImageDelete={handleImageDelete} />;
874
+ ```
875
+
876
+ #### Vue + Axios + FastAPI
877
+
878
+ ```typescript
879
+ const handleImageDelete = async (imageUrl: string) => {
880
+ await axios.delete("https://api.myapp.com/v1/images", {
881
+ data: { imageUrl },
882
+ });
883
+ };
884
+ ```
885
+
886
+ ### 주의사항
887
+
888
+ | 항목 | 설명 |
889
+ | --------------- | --------------------------------------------- |
890
+ | **Undo/Redo** | 지연 삭제로 복원 가능하게 구현 (권장: 5-10분) |
891
+ | **권한 검증** | 프로덕션에서는 인증/인가 필수 |
892
+ | **참조 카운트** | 같은 이미지를 여러 문서에서 사용하는지 확인 |
893
+ | **삭제 로그** | 감사 추적을 위한 삭제 기록 저장 권장 |
894
+
895
+ ---
896
+
897
+ ## HTML 미리보기
898
+
899
+ LumirEditor는 HTML 파일을 iframe을 사용하여 미리보기할 수 있는 커스텀 블록을 제공합니다. 편집 불가능한 순수 미리보기 기능으로, HTML 문서를 안전하게 표시할 수 있습니다.
900
+
901
+ ### 사용 방법
902
+
903
+ #### 1. 드래그 앤 드롭
904
+
905
+ HTML 파일(`.html`, `.htm`)을 에디터에 드래그 앤 드롭하면 자동으로 iframe 미리보기 블록이 삽입됩니다.
906
+
907
+ ```tsx
908
+ <LumirEditor />
909
+ ```
910
+
911
+ - **지원 파일 형식**: `.html`, `.htm`
912
+ - **특징**:
913
+ - 편집 불가능한 순수 미리보기
914
+ - 접기/펼치기 기능
915
+ - 안전한 sandbox 처리 (`allow-same-origin`, JavaScript 실행 비활성화)
916
+ - 파일명 표시
917
+
918
+ #### 2. 슬래시 메뉴
919
+
920
+ 에디터에서 `/`를 입력하고 "HTML Preview"를 선택하면 예제 HTML 미리보기 블록이 삽입됩니다.
921
+
922
+ ```
923
+ / → HTML Preview
924
+ ```
925
+
926
+ ### 특징
927
+
928
+ - **iframe 기반**: HTML 문서를 독립된 iframe에서 안전하게 렌더링
929
+ - **Sandbox 보안**: `sandbox="allow-same-origin"` 속성으로 보안 강화 (JavaScript 실행 의도적 비활성화)
930
+ - **접기/펼치기**: 헤더 클릭으로 미리보기 영역 토글
931
+ - **드래그 리사이즈**: 하단 핸들을 드래그하여 높이 조절 가능 (100px ~ 1200px)
932
+ - **새 창 열기**: HTML 문서를 새 창에서 전체 화면으로 확인
933
+ - **다운로드**: HTML 파일로 다운로드
934
+ - **편집 불가**: 순수 미리보기 전용
935
+
936
+ ### 사용 예제
937
+
938
+ ```tsx
939
+ import { LumirEditor } from "@lumir-company/editor";
940
+ import "@lumir-company/editor/style.css";
941
+
942
+ function App() {
943
+ return (
944
+ <div className="w-full h-[600px]">
945
+ <LumirEditor
946
+ onContentChange={(blocks) => {
947
+ // HTML 미리보기 블록도 일반 블록과 동일하게 처리됨
948
+ console.log(blocks);
949
+ }}
950
+ />
951
+ </div>
952
+ );
953
+ }
954
+ ```
955
+
956
+ ### 프로그래밍 방식으로 블록 삽입
957
+
958
+ ```tsx
959
+ import { HtmlPreview } from "@lumir-company/editor";
960
+
961
+ // 에디터 인스턴스에서 직접 블록 삽입
962
+ editor.insertBlocks([
963
+ {
964
+ type: "htmlPreview",
965
+ props: {
966
+ htmlContent: "<h1>Hello World</h1><p>This is HTML content</p>",
967
+ fileName: "example.html",
968
+ height: "400px",
969
+ },
970
+ },
971
+ ]);
972
+ ```
973
+
974
+ ### 주의사항
975
+
976
+ - HTML 내용은 iframe의 `sandbox="allow-same-origin"` 속성으로 보안이 강화되어 있습니다
977
+ - **JavaScript는 의도적으로 비활성화**되어 있습니다 (보안상 이유)
978
+ - 외부 리소스(CSS, JS, 이미지 등)는 상대 경로가 작동하지 않을 수 있습니다
979
+ - 인라인 CSS 스타일을 권장합니다
980
+
981
+ ---
982
+
983
+ ## Placeholder
984
+
985
+ 에디터가 비어있을 때 사용자에게 안내 텍스트를 표시합니다.
986
+
987
+ ### 사용 방법
988
+
989
+ ```tsx
990
+ <LumirEditor placeholder="내용을 입력하세요..." />
991
+ ```
992
+
993
+ - 빈 블록에 연한 색상으로 안내 텍스트가 표시됩니다
994
+ - 사용자가 입력을 시작하면 자동으로 사라집니다
995
+ - 모든 빈 블록(첫 번째 블록 포함)에 동일한 텍스트가 적용됩니다
996
+
997
+ ---
998
+
999
+ ## 링크 프리뷰
1000
+
1001
+ URL을 붙여넣거나 슬래시 메뉴에서 선택하면 Open Graph 카드를 표시합니다.
1002
+
1003
+ > **서버 사이드 필수**: 링크 프리뷰는 외부 사이트의 OG 메타데이터를 가져오기 위해 **서버 사이드 API 라우트**가 필요합니다. 브라우저의 CORS 정책으로 인해 클라이언트에서 직접 외부 HTML을 가져올 수 없습니다.
1004
+
1005
+ ### 사용 조건
1006
+
1007
+ | 조건 | 설명 |
1008
+ | -------------------------- | -------------------------------------------------------------------------- |
1009
+ | **서버 환경** | Next.js, Remix, SvelteKit 등 서버 사이드 라우팅을 지원하는 프레임워크 필요 |
1010
+ | **API 라우트** | 패키지 내장 핸들러를 re-export하는 1줄짜리 파일 필요 |
1011
+ | **순수 React (CRA, Vite)** | 별도 백엔드 서버 없이는 사용 불가 |
1012
+
1013
+ ### 설정 방법 (Next.js App Router)
1014
+
1015
+ **1단계: API 라우트 생성** (1줄)
1016
+
1017
+ ```ts
1018
+ // src/app/api/link-preview/route.ts
1019
+ export { linkPreviewHandler as GET } from "@lumir-company/editor/api/link-preview";
1020
+ ```
1021
+
1022
+ 패키지에 내장된 핸들러를 re-export하므로 별도 로직 작성이 불필요합니다.
1023
+
1024
+ **2단계: 에디터에 linkPreview prop 설정**
1025
+
1026
+ ```tsx
1027
+ <LumirEditor linkPreview={{ apiEndpoint: "/api/link-preview" }} />
1028
+ ```
1029
+
1030
+ ### 설정 방법 (Remix / SvelteKit)
1031
+
1032
+ 패키지의 `GET` 핸들러는 표준 Web API(`Request`/`Response`)를 사용하므로 Remix, SvelteKit 등에서도 동일하게 사용 가능합니다.
1033
+
1034
+ ```ts
1035
+ // Remix: app/routes/api.link-preview.ts
1036
+ export { linkPreviewHandler as loader } from "@lumir-company/editor/api/link-preview";
1037
+ ```
1038
+
1039
+ ### 설정 방법 (Express / Fastify 등 커스텀 서버)
1040
+
1041
+ 패키지에서 `fetchUrlMetadata`와 `parseMetaTags`를 import하여 직접 라우트를 구현할 수 있습니다.
1042
+
1043
+ ```ts
1044
+ import { fetchUrlMetadata } from "@lumir-company/editor/api/link-preview";
1045
+
1046
+ app.get("/api/link-preview", async (req, res) => {
1047
+ const url = req.query.url as string;
1048
+ if (!url) return res.status(400).json({ error: "url required" });
1049
+
1050
+ try {
1051
+ const metadata = await fetchUrlMetadata(url);
1052
+ res.json(metadata);
1053
+ } catch {
1054
+ res.status(500).json({ error: "Failed to fetch metadata" });
1055
+ }
1056
+ });
1057
+ ```
1058
+
1059
+ ### 주요 기능
1060
+
1061
+ - URL 붙여넣기 시 자동 링크 프리뷰 블록 생성
1062
+ - 슬래시 메뉴(`/`)에서 Link Preview 항목 선택
1063
+ - 드래그 리사이즈 (좌우 너비, 하단 이미지 높이)
1064
+ - 텍스트 링크를 링크 프리뷰로 전환 (링크 툴바 버튼)
1065
+ - 메타데이터에 이미지 없으면 이미지 영역 자동 생략
1066
+ - 에러 카드 클릭 시 링크 이동
1067
+
1068
+ ### 내장 API 핸들러 export 목록
1069
+
1070
+ `@lumir-company/editor/api/link-preview`에서 export되는 항목:
1071
+
1072
+ | Export | 타입 | 설명 |
1073
+ | -------------------- | ------------------------------------------------- | ------------------------------------------------ |
1074
+ | `linkPreviewHandler` | `(request: Request) => Promise<Response>` | 링크 프리뷰 메타데이터 조회 핸들러 (re-export용) |
1075
+ | `fetchUrlMetadata` | `(url: string) => Promise<LinkMetadata>` | 서버에서 직접 메타데이터 조회 |
1076
+ | `parseMetaTags` | `(html: string, baseUrl: string) => LinkMetadata` | HTML에서 OG 메타데이터 파싱 |
1077
+ | `LinkMetadata` | `interface` | 메타데이터 타입 정의 |
1078
+
1079
+ ---
1080
+
1081
+ ## Props API
1082
+
1083
+ ### 핵심 Props
1084
+
1085
+ | Prop | 타입 | 기본값 | 설명 |
1086
+ | ------------------ | ----------------------------------- | ----------- | ----------------------------------------- |
1087
+ | `s3Upload` | `S3UploaderConfig` | `undefined` | S3 업로드 설정 |
1088
+ | `uploadFile` | `(file: File) => Promise<string>` | `undefined` | 커스텀 업로드 함수 |
1089
+ | `onContentChange` | `(blocks) => void` | `undefined` | 콘텐츠 변경 콜백 |
1090
+ | `onImageDelete` | `(imageUrl: string) => void` | `undefined` | 이미지·비디오 삭제 시 콜백 |
1091
+ | `onError` | `(error: LumirEditorError) => void` | `undefined` | 에러 발생 시 콜백 |
1092
+ | `initialContent` | `Block[] \| string` | `undefined` | 초기 콘텐츠 |
1093
+ | `editable` | `boolean` | `true` | 편집 가능 여부 |
1094
+ | `placeholder` | `string` | `undefined` | 빈 블록 안내 텍스트 |
1095
+ | `linkPreview` | `{ apiEndpoint: string }` | `undefined` | 링크 프리뷰 설정 |
1096
+ | `theme` | `"light" \| "dark"` | `"light"` | 테마 |
1097
+ | `className` | `string` | `""` | CSS 클래스 |
1098
+ | `maxImageFileSize` | `number` | `undefined` | 이미지 최대 용량(바이트). 미설정 시 10MB |
1099
+ | `maxVideoFileSize` | `number` | `undefined` | 동영상 최대 용량(바이트). 미설정 시 100MB |
1100
+
1101
+ ### S3UploaderConfig
1102
+
1103
+ ```tsx
1104
+ interface S3UploaderConfig {
1105
+ // 필수
1106
+ apiEndpoint: string; // Presigned URL API 엔드포인트
1107
+ env: "development" | "production";
1108
+ path: string; // S3 저장 경로
1109
+
1110
+ // 선택 (파일명 커스터마이징)
1111
+ fileNameTransform?: (nameWithoutExt: string, file: File) => string; // 확장자 제외한 이름 변환
1112
+ appendUUID?: boolean; // true: 파일명 뒤에 UUID 추가 (확장자 앞에 삽입)
1113
+ preserveExtension?: boolean; // false: 확장자를 붙이지 않음 (기본: true)
1114
+
1115
+ // 선택 (업로드 동작)
1116
+ onProgress?: (percent: number) => void; // 업로드 진행률 0~100 콜백 (S3 PUT 시만 호출, 중간 진행률 보간 지원)
1117
+ uploadTimeoutMs?: number; // PUT 타임아웃(ms). 미설정 시 120000(120초). 대용량 동영상 시 연장 권장
1118
+ maxRetries?: number; // PUT 실패 시 재시도 횟수. 기본 2(최대 3회 시도)
1119
+ }
1120
+ ```
1121
+
1122
+ ### 전체 Props
1123
+
1124
+ <details>
1125
+ <summary>전체 Props 보기</summary>
1126
+
1127
+ ```tsx
1128
+ interface LumirEditorProps {
1129
+ // === 에디터 설정 ===
1130
+ initialContent?: DefaultPartialBlock[] | string; // 초기 콘텐츠 (블록 배열 또는 JSON 문자열)
1131
+ initialEmptyBlocks?: number; // 초기 빈 블록 개수 (기본: 3)
1132
+ placeholder?: string; // 빈 블록에 표시할 안내 텍스트 (예: "내용을 입력하세요...")
1133
+ uploadFile?: (file: File) => Promise<string>; // 커스텀 파일 업로드 함수
1134
+ s3Upload?: {
1135
+ apiEndpoint: string;
1136
+ env: "development" | "production";
1137
+ path: string;
1138
+ fileNameTransform?: (nameWithoutExt: string, file: File) => string; // 확장자 제외한 이름 변환
1139
+ appendUUID?: boolean; // UUID 자동 추가 (확장자 앞)
1140
+ preserveExtension?: boolean; // 확장자 자동 붙이기 (기본: true)
1141
+ onProgress?: (percent: number) => void; // 업로드 진행률 0~100 (이미지·동영상 공통, 중간 진행률 보간)
1142
+ uploadTimeoutMs?: number; // PUT 타임아웃(ms). 기본 120000
1143
+ maxRetries?: number; // PUT 재시도 횟수. 기본 2
1144
+ };
1145
+
1146
+ // === 콜백 ===
1147
+ onContentChange?: (blocks: DefaultPartialBlock[]) => void; // 콘텐츠 변경 시 호출
1148
+ onImageDelete?: (imageUrl: string) => void; // 이미지·비디오 삭제 시 호출 (S3 삭제 등)
1149
+ onSelectionChange?: () => void; // 선택 영역 변경 시 호출
1150
+ onError?: (error: LumirEditorError) => void; // 에러 발생 시 호출
1151
+
1152
+ // 기능 설정
1153
+ tables?: TableConfig; // 테이블 기능 설정 (splitCells, cellBackgroundColor 등)
1154
+ heading?: { levels?: (1 | 2 | 3 | 4 | 5 | 6)[] }; // 헤딩 레벨 설정 (기본: [1,2,3,4,5,6])
1155
+ defaultStyles?: boolean; // 기본 스타일 활성화 (기본: true)
1156
+ disableExtensions?: string[]; // 비활성화할 확장 기능 목록
1157
+ tabBehavior?: "prefer-navigate-ui" | "prefer-indent"; // 탭 키 동작 (기본: "prefer-navigate-ui")
1158
+ trailingBlock?: boolean; // 마지막에 빈 블록 자동 추가 (기본: true)
1159
+
1160
+ // === UI 설정 ===
1161
+ editable?: boolean; // 편집 가능 여부 (기본: true)
1162
+ theme?: "light" | "dark" | ThemeObject; // 에디터 테마 (기본: "light")
1163
+ formattingToolbar?: boolean; // 서식 툴바 표시 (기본: true)
1164
+ linkToolbar?: boolean; // 링크 툴바 표시 (기본: true)
1165
+ sideMenu?: boolean; // 사이드 메뉴 표시 (기본: true)
1166
+ sideMenuAddButton?: boolean; // 사이드 메뉴 + 버튼 표시 (기본: false, 드래그 핸들만 표시)
1167
+ emojiPicker?: boolean; // 이모지 선택기 표시 (기본: true)
1168
+ filePanel?: boolean; // 파일 패널 표시 (기본: true)
1169
+ tableHandles?: boolean; // 테이블 핸들 표시 (기본: true)
1170
+ className?: string; // 컨테이너 CSS 클래스
1171
+
1172
+ // === 링크 프리뷰 설정 ===
1173
+ linkPreview?: {
1174
+ apiEndpoint: string; // 링크 메타데이터를 가져올 API 엔드포인트 (예: "/api/link-preview")
1175
+ };
1176
+
1177
+ // 미디어 업로드 허용 여부 (기본: 모두 비활성)
1178
+ allowVideoUpload?: boolean; // 비디오 업로드 허용 (기본: false)
1179
+ allowAudioUpload?: boolean; // 오디오 업로드 허용 (기본: false)
1180
+ allowFileUpload?: boolean; // 일반 파일 업로드 허용 (기본: false)
1181
+ maxImageFileSize?: number; // 이미지 최대 파일 크기(바이트). 미설정 시 10MB
1182
+ maxVideoFileSize?: number; // 동영상 최대 파일 크기(바이트). 미설정 시 100MB
1183
+ }
1184
+ ```
1185
+
1186
+ </details>
1187
+
1188
+ ---
1189
+
1190
+ ## 사용 예제
1191
+
1192
+ ### 읽기 전용 모드
1193
+
1194
+ ```tsx
1195
+ <LumirEditor
1196
+ editable={false}
1197
+ initialContent={savedContent}
1198
+ sideMenu={false}
1199
+ formattingToolbar={false}
1200
+ />
1201
+ ```
1202
+
1203
+ ### 다크 테마
1204
+
1205
+ ```tsx
1206
+ <LumirEditor theme="dark" className="bg-gray-900 rounded-lg" />
1207
+ ```
1208
+
1209
+ ### 콘텐츠 저장 및 불러오기
1210
+
1211
+ ```tsx
1212
+ import { useState, useEffect } from "react";
1213
+ import { LumirEditor, ContentUtils } from "@lumir-company/editor";
1214
+
1215
+ function EditorWithSave() {
1216
+ const [content, setContent] = useState("");
1217
+
1218
+ // 불러오기
1219
+ useEffect(() => {
1220
+ const saved = localStorage.getItem("content");
1221
+ if (saved && ContentUtils.isValidJSONString(saved)) {
1222
+ setContent(saved);
1223
+ }
1224
+ }, []);
1225
+
1226
+ // 저장
1227
+ const handleChange = (blocks) => {
1228
+ const json = JSON.stringify(blocks);
1229
+ localStorage.setItem("content", json);
1230
+ };
1231
+
1232
+ return (
1233
+ <LumirEditor initialContent={content} onContentChange={handleChange} />
1234
+ );
1235
+ }
1236
+ ```
1237
+
1238
+ ---
1239
+
1240
+ ## 스타일링
1241
+
1242
+ ### Tailwind CSS와 함께 사용
1243
+
1244
+ ```tsx
1245
+ import { LumirEditor, cn } from "@lumir-company/editor";
1246
+
1247
+ <LumirEditor
1248
+ className={cn(
1249
+ "min-h-[400px] rounded-xl",
1250
+ "border border-gray-200 shadow-lg",
1251
+ "focus-within:ring-2 focus-within:ring-blue-500",
1252
+ )}
1253
+ />;
1254
+ ```
1255
+
1256
+ ### 커스텀 스타일
1257
+
1258
+ ```css
1259
+ /* globals.css */
1260
+ .my-editor .bn-editor {
1261
+ padding: 20px 30px;
1262
+ font-size: 16px;
1263
+ line-height: 1.6;
1264
+ }
1265
+
1266
+ .my-editor [data-content-type="heading"] {
1267
+ font-weight: 700;
1268
+ margin-top: 24px;
1269
+ }
1270
+ ```
1271
+
1272
+ ```tsx
1273
+ <LumirEditor className="my-editor" />
1274
+ ```
1275
+
1276
+ ---
1277
+
1278
+ ## 트러블슈팅
1279
+
1280
+ ### 필수 체크리스트
1281
+
1282
+ - [ ] CSS 임포트: `import "@lumir-company/editor/style.css"`
1283
+ - [ ] 컨테이너 높이 설정: 부모 요소에 높이 지정 필수
1284
+ - [ ] Next.js: `dynamic(..., { ssr: false })` 사용
1285
+ - [ ] React 버전: 18.0.0 이상
1286
+
1287
+ ### 자주 발생하는 문제
1288
+
1289
+ #### 1. 에디터가 보이지 않음
1290
+
1291
+ ```tsx
1292
+ // 잘못됨
1293
+ <LumirEditor />;
1294
+
1295
+ // 올바름
1296
+ import "@lumir-company/editor/style.css";
1297
+ <div className="h-[400px]">
1298
+ <LumirEditor />
1299
+ </div>;
1300
+ ```
1301
+
1302
+ #### 2. Next.js Hydration 오류
1303
+
1304
+ ```tsx
1305
+ // 잘못됨
1306
+ import { LumirEditor } from "@lumir-company/editor";
1307
+
1308
+ // 올바름
1309
+ const LumirEditor = dynamic(
1310
+ () =>
1311
+ import("@lumir-company/editor").then((m) => ({ default: m.LumirEditor })),
1312
+ { ssr: false },
1313
+ );
1314
+ ```
1315
+
1316
+ #### 3. 이미지 업로드 실패
1317
+
1318
+ ```tsx
1319
+ // uploadFile 또는 s3Upload 중 하나는 반드시 설정!
1320
+ <LumirEditor
1321
+ s3Upload={{
1322
+ apiEndpoint: "/api/s3/presigned",
1323
+ env: "development",
1324
+ path: "images",
1325
+ }}
1326
+ />
1327
+ ```
1328
+
1329
+ #### 4. 여러 이미지 업로드 시 중복 문제
1330
+
1331
+ ```tsx
1332
+ // 해결: appendUUID 사용
1333
+ <LumirEditor
1334
+ s3Upload={{
1335
+ apiEndpoint: "/api/s3/presigned",
1336
+ env: "production",
1337
+ path: "images",
1338
+ appendUUID: true, // 고유한 파일명 보장
1339
+ }}
1340
+ />
1341
+ ```
1342
+
1343
+ ---
1344
+
1345
+ ## 유틸리티 API
1346
+
1347
+ ### ContentUtils
1348
+
1349
+ ```tsx
1350
+ import { ContentUtils } from "@lumir-company/editor";
1351
+
1352
+ // JSON 검증
1353
+ ContentUtils.isValidJSONString('[{"type":"paragraph"}]'); // true
1354
+
1355
+ // JSON 파싱
1356
+ const blocks = ContentUtils.parseJSONContent(jsonString);
1357
+
1358
+ // 기본 블록 생성
1359
+ const emptyBlock = ContentUtils.createDefaultBlock();
1360
+ ```
1361
+
1362
+ ### createS3Uploader
1363
+
1364
+ ```tsx
1365
+ import { createS3Uploader } from "@lumir-company/editor";
1366
+
1367
+ const uploader = createS3Uploader({
1368
+ apiEndpoint: "/api/s3/presigned",
1369
+ env: "production",
1370
+ path: "uploads",
1371
+ appendUUID: true,
1372
+ });
1373
+
1374
+ // 직접 사용
1375
+ const url = await uploader(imageFile);
1376
+ ```
1377
+
1378
+ ## 관련 링크
1379
+
1380
+ - [npm Package](https://www.npmjs.com/package/@lumir-company/editor)
1381
+ - [BlockNote Documentation](https://www.blocknotejs.org/)
1382
+
1383
+ ---
1384
+
1385
+ ## 변경 로그
1386
+
1387
+ ### v0.4.10
1388
+
1389
+ - **Numbered List & Bullet List font size 14px**
1390
+ - Numbered List & Bullet List의 font size 14px로 일반 텍스트 크기와 통일성 있게 변경
1391
+
1392
+ ### v0.4.10
1393
+
1394
+ - **동영상·이미지 업로드 진행률 표시**
1395
+ - S3 업로드 시 진행률이 0만 보이다가 100으로 바로 완료되던 문제 개선
1396
+ - `xhr.upload.onprogress`와 **보간 타이머**를 함께 사용해 중간 진행률(0→…→100)이 부드럽게 갱신되도록 변경
1397
+ - 업로드 시작 직후 `onProgress(0)` 호출, 완료 시 `onProgress(100)` 보장
1398
+ - README: `s3Upload.onProgress` 설명 및 업로드 진행률 표시 섹션 추가
1399
+ - README: `S3UploaderConfig`에 `onProgress`, `uploadTimeoutMs`, `maxRetries` 문서화
1400
+
1401
+ ### v0.4.9
1402
+
1403
+ - **업로드 용량·타임아웃 사용자 설정**
1404
+ - `maxImageFileSize`, `maxVideoFileSize` prop 추가 (미설정 시 기본 10MB/100MB)
1405
+ - `isImageFile(file, maxSize?)`, `isVideoFile(file, maxSize?)` 시그니처 확장
1406
+ - README: 용량 및 타임아웃 설정 예시 및 `s3Upload.uploadTimeoutMs` 안내 보강
1407
+
1408
+ ### v0.4.8
1409
+
1410
+ - README update (video & image upload)
1411
+ - 버전 배포
1412
+
1413
+ ### v0.4.6
1414
+
1415
+ - **README: S3 Presigned URL API**
1416
+ - Next.js App Router용 `app/api/s3/presigned/route.ts` 구현 예시 추가 (PutObjectCommand, getSignedUrl)
1417
+ - Next.js가 아닌 프로젝트: Express 예시 및 Remix/SvelteKit 등 동일 패턴 안내
1418
+ - **README: 이미지·동영상 업로드 경로 분리**
1419
+ - `fileNameTransform`으로 이미지/동영상 prefix 분리 (`images/`, `videos/`) 예시 결과 경로 설명 추가
1420
+
1421
+ ### v0.4.5
1422
+
1423
+ - **README: 이미지·동영상 업로드**
1424
+ - 지원 형식/용량, 삽입 경로, 설정 방법(s3Upload / uploadFile), 저장 데이터 구조, 삭제 콜백, 에러 처리 정리
1425
+ - 동영상 블록은 직접 재생 가능한 파일 URL만 지원한다는 안내 추가 (YouTube/Vimeo 링크 미지원)
1426
+
1427
+ ### v0.4.4
1428
+
1429
+ - **Link Preview API 핸들러 내장**
1430
+ - `@lumir-company/editor/api/link-preview` 서브패스 export 추가
1431
+ - 표준 Web API (`Request`/`Response`) 기반으로 Next.js, Remix, SvelteKit 호환
1432
+ - 소비자는 1줄 re-export만으로 API 라우트 설정 가능 (220줄 route.ts 제거)
1433
+ - `linkPreviewHandler`, `fetchUrlMetadata`, `parseMetaTags` 함수 export
1434
+ - **Placeholder 문서화**
1435
+ - Placeholder 사용 가이드 추가
1436
+ - **README 개선**
1437
+ - 링크 프리뷰 서버사이드 요구사항 및 설정 방법 가이드 추가
1438
+ - 내장 API 핸들러 export 목록 문서화
1439
+ - Props API 테이블에 `placeholder`, `linkPreview` 추가
1440
+
1441
+ ### v0.4.3
1442
+
1443
+ - **링크 프리뷰 기능 추가**
1444
+ - `linkPreview` prop으로 링크 미리보기 활성화 (카카오톡 스타일 OG 카드)
1445
+ - URL 붙여넣기 자동 링크 프리뷰 블록 생성 (빈 블록이면 교체, 텍스트 있으면 하단 삽입)
1446
+ - 슬래시 메뉴(`/`)에서 Link Preview 항목 추가
1447
+ - 드래그 리사이즈 지원 (좌우 너비, 하단 이미지 높이 조절)
1448
+ - 메타데이터에 이미지 없을 경우 이미지 영역 생략
1449
+ - 에러 카드 클릭 시 링크 이동 지원
1450
+ - `fetchLinkMetadata`, `clearMetadataCache`, `LinkMetadata` 타입 export
1451
+ - **링크 툴바 커스텀**
1452
+ - 텍스트 링크를 링크 프리뷰 블록으로 전환하는 버튼 추가 (`replaceBlocks` 사용)
1453
+ - `linkPreview.apiEndpoint` 설정 시에만 전환 버튼 표시
1454
+ - **placeholder prop 추가**
1455
+ - `placeholder` prop으로 에디터 블록 안내 텍스트 설정
1456
+ - **이미지 삭제 기능 추가**
1457
+ - `onImageDelete` 콜백 prop 추가 - 에디터에서 이미지 삭제 시 호출
1458
+ - S3 외부 스토리지에서 이미지 자동 삭제 지원
1459
+ - 지연 삭제 패턴으로 Undo/Redo 대응 가능
1460
+ - 이미지 URL 추출 및 삭제 감지 헬퍼 함수 내장
1461
+ - **보안 강화**
1462
+ - URL 이스케이프 처리 추가 (XSS 방지)
1463
+ - LinkButton: `javascript:`, `data:`, `vbscript:`, `file:` 프로토콜 차단
1464
+ - 위험한 URL 입력 에러 메시지 표시
1465
+ - **링크 삽입 버그 수정**
1466
+ - 플로팅 메뉴 링크 버튼: 텍스트 미선택 시에도 URL 텍스트로 링크 삽입 지원
1467
+ - `editor.focus()` 호출로 선택 상태 복원
1468
+ - **README 개선**
1469
+ - 링크 프리뷰 사용 가이드 및 API 라우트 예시 추가
1470
+ - 이미지 삭제 섹션 추가 (지연 삭제 예시 포함)
1471
+ - S3 삭제 API 구현 예시 추가
1472
+ - Props API 문서 업데이트
1473
+
1474
+ ### v0.4.2
1475
+
1476
+ - **코드 구조 리팩토링**
1477
+ - FloatingMenu 컴포넌트 분리 (Icons, 개별 버튼 컴포넌트)
1478
+ - 색상 상수 별도 파일로 분리 (`constants/colors.ts`)
1479
+ - 미사용 기능 제거 (FontSelect, FontSizeControl)
1480
+ - **에러 처리 개선**
1481
+ - `LumirEditorError` 커스텀 에러 클래스 추가
1482
+ - `onError` 콜백 prop 추가 - 에러 발생 시 사용자 정의 핸들링 가능
1483
+ - 에러 발생 사용자 친화적 토스트 메시지 자동 표시
1484
+ - **HTML 미리보기 개선**
1485
+ - sandbox 설정 명확화 (JavaScript 의도적 비활성화)
1486
+ - 드래그 리사이즈, 새 창 열기, 다운로드 기능 문서화
1487
+ - **타입 개선**
1488
+ - `LumirErrorCode`, `LumirErrorDetails` 타입 export
1489
+ - `ColorItem` 타입 export
1490
+
1491
+ ### v0.4.1
1492
+
1493
+ - `preserveExtension` prop 추가 - 확장자 자동 붙이기 제어 (기본: true)
1494
+ - **중요**: 파일명 변환 확장자 위치 수정 (확장자가 항상 맨 뒤에 오도록)
1495
+ - **Breaking Change**: `fileNameTransform` 파라미터 변경 - 이제 확장자 제외한 파일명만 전달됨
1496
+ - 이전: `fileNameTransform: (originalName, file) => ...` → originalName에 확장자 포함
1497
+ - 변경: `fileNameTransform: (nameWithoutExt, file) => ...` → nameWithoutExt에 확장자 제외
1498
+ - 확장자 제거 사용 사례 문서화
1499
+ - README 예제 설명 개선
1500
+
1501
+ ### v0.4.0
1502
+
1503
+ - 파일명 변환 콜백 (`fileNameTransform`) 추가
1504
+ - UUID 자동 추가 옵션 (`appendUUID`) 추가
1505
+ - 여러 이미지 동시 업로드 시 중복 문제 해결
1506
+ - 문서 대폭 개선
1507
+
1508
+ ### v0.3.3
1509
+
1510
+ - 에디터 재생성 방지 최적화
1511
+ - 타입 정의 개선