- Add POST /api/knowledge/import endpoint for .md and .zip files - Add GET /api/knowledge/export endpoint with markdown/json formats - Import parses frontmatter (title, tags, status, visibility) - Export includes frontmatter in markdown format - Add ImportExportActions component with drag-and-drop UI - Add import progress dialog with success/error summary - Add export dropdown with format selection - Include comprehensive test suite - Support bulk import with detailed error reporting
This commit is contained in:
Jason Woltje
@@ -57,6 +57,8 @@
|
||||
"@nestjs/schematics": "^11.0.1",
|
||||
"@nestjs/testing": "^11.1.12",
|
||||
"@swc/core": "^1.10.18",
|
||||
"@types/adm-zip": "^0.5.7",
|
||||
"@types/archiver": "^7.0.0",
|
||||
"@types/express": "^5.0.1",
|
||||
"@types/highlight.js": "^10.1.0",
|
||||
"@types/ioredis": "^5.0.0",
|
||||
|
||||
52
apps/api/src/knowledge/dto/import-export.dto.ts
Normal file
52
apps/api/src/knowledge/dto/import-export.dto.ts
Normal file
@@ -0,0 +1,52 @@
|
||||
import {
|
||||
IsString,
|
||||
IsOptional,
|
||||
IsEnum,
|
||||
IsArray,
|
||||
ArrayMinSize,
|
||||
} from "class-validator";
|
||||
|
||||
/**
|
||||
* Export format enum
|
||||
*/
|
||||
export enum ExportFormat {
|
||||
MARKDOWN = "markdown",
|
||||
JSON = "json",
|
||||
}
|
||||
|
||||
/**
|
||||
* DTO for export query parameters
|
||||
*/
|
||||
export class ExportQueryDto {
|
||||
@IsOptional()
|
||||
@IsEnum(ExportFormat, { message: "format must be either 'markdown' or 'json'" })
|
||||
format?: ExportFormat = ExportFormat.MARKDOWN;
|
||||
|
||||
@IsOptional()
|
||||
@IsArray({ message: "entryIds must be an array" })
|
||||
@IsString({ each: true, message: "each entryId must be a string" })
|
||||
entryIds?: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Import result for a single entry
|
||||
*/
|
||||
export interface ImportResult {
|
||||
filename: string;
|
||||
success: boolean;
|
||||
entryId?: string;
|
||||
slug?: string;
|
||||
title?: string;
|
||||
error?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Response DTO for import operation
|
||||
*/
|
||||
export interface ImportResponseDto {
|
||||
success: boolean;
|
||||
totalFiles: number;
|
||||
imported: number;
|
||||
failed: number;
|
||||
results: ImportResult[];
|
||||
}
|
||||
@@ -10,3 +10,9 @@ export {
|
||||
RecentEntriesDto,
|
||||
} from "./search-query.dto";
|
||||
export { GraphQueryDto } from "./graph-query.dto";
|
||||
export {
|
||||
ExportQueryDto,
|
||||
ExportFormat,
|
||||
ImportResult,
|
||||
ImportResponseDto,
|
||||
} from "./import-export.dto";
|
||||
|
||||
93
apps/api/src/knowledge/import-export.controller.ts
Normal file
93
apps/api/src/knowledge/import-export.controller.ts
Normal file
@@ -0,0 +1,93 @@
|
||||
import {
|
||||
Controller,
|
||||
Post,
|
||||
Get,
|
||||
Query,
|
||||
UseGuards,
|
||||
UseInterceptors,
|
||||
UploadedFile,
|
||||
Res,
|
||||
BadRequestException,
|
||||
} from "@nestjs/common";
|
||||
import { FileInterceptor } from "@nestjs/platform-express";
|
||||
import { Response } from "express";
|
||||
import { ImportExportService } from "./services/import-export.service";
|
||||
import { ExportQueryDto, ExportFormat, ImportResponseDto } from "./dto";
|
||||
import { AuthGuard } from "../auth/guards/auth.guard";
|
||||
import { WorkspaceGuard, PermissionGuard } from "../common/guards";
|
||||
import { Workspace, Permission, RequirePermission } from "../common/decorators";
|
||||
import { CurrentUser } from "../auth/decorators/current-user.decorator";
|
||||
|
||||
/**
|
||||
* Controller for knowledge import/export endpoints
|
||||
* All endpoints require authentication and workspace context
|
||||
*/
|
||||
@Controller("knowledge")
|
||||
@UseGuards(AuthGuard, WorkspaceGuard, PermissionGuard)
|
||||
export class ImportExportController {
|
||||
constructor(private readonly importExportService: ImportExportService) {}
|
||||
|
||||
/**
|
||||
* POST /api/knowledge/import
|
||||
* Import knowledge entries from uploaded file (.md or .zip)
|
||||
* Requires: MEMBER role or higher
|
||||
*/
|
||||
@Post("import")
|
||||
@RequirePermission(Permission.WORKSPACE_MEMBER)
|
||||
@UseInterceptors(FileInterceptor("file"))
|
||||
async importEntries(
|
||||
@Workspace() workspaceId: string,
|
||||
@CurrentUser() user: any,
|
||||
@UploadedFile() file: Express.Multer.File
|
||||
): Promise<ImportResponseDto> {
|
||||
if (!file) {
|
||||
throw new BadRequestException("No file uploaded");
|
||||
}
|
||||
|
||||
const result = await this.importExportService.importEntries(
|
||||
workspaceId,
|
||||
user.id,
|
||||
file
|
||||
);
|
||||
|
||||
return {
|
||||
success: result.failed === 0,
|
||||
totalFiles: result.totalFiles,
|
||||
imported: result.imported,
|
||||
failed: result.failed,
|
||||
results: result.results,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /api/knowledge/export
|
||||
* Export knowledge entries as a zip file
|
||||
* Query params:
|
||||
* - format: 'markdown' (default) or 'json'
|
||||
* - entryIds: optional array of entry IDs to export (exports all if not provided)
|
||||
* Requires: Any workspace member
|
||||
*/
|
||||
@Get("export")
|
||||
@RequirePermission(Permission.WORKSPACE_ANY)
|
||||
async exportEntries(
|
||||
@Workspace() workspaceId: string,
|
||||
@Query() query: ExportQueryDto,
|
||||
@Res() res: Response
|
||||
): Promise<void> {
|
||||
const format = query.format || ExportFormat.MARKDOWN;
|
||||
const entryIds = query.entryIds;
|
||||
|
||||
const { stream, filename } = await this.importExportService.exportEntries(
|
||||
workspaceId,
|
||||
format,
|
||||
entryIds
|
||||
);
|
||||
|
||||
// Set response headers
|
||||
res.setHeader("Content-Type", "application/zip");
|
||||
res.setHeader("Content-Disposition", `attachment; filename="${filename}"`);
|
||||
|
||||
// Pipe the archive stream to response
|
||||
stream.pipe(res);
|
||||
}
|
||||
}
|
||||
@@ -5,17 +5,24 @@ import { KnowledgeService } from "./knowledge.service";
|
||||
import { KnowledgeController } from "./knowledge.controller";
|
||||
import { SearchController } from "./search.controller";
|
||||
import { KnowledgeStatsController } from "./stats.controller";
|
||||
import { ImportExportController } from "./import-export.controller";
|
||||
import {
|
||||
LinkResolutionService,
|
||||
SearchService,
|
||||
LinkSyncService,
|
||||
GraphService,
|
||||
StatsService,
|
||||
ImportExportService,
|
||||
} from "./services";
|
||||
|
||||
@Module({
|
||||
imports: [PrismaModule, AuthModule],
|
||||
controllers: [KnowledgeController, SearchController, KnowledgeStatsController],
|
||||
controllers: [
|
||||
KnowledgeController,
|
||||
SearchController,
|
||||
KnowledgeStatsController,
|
||||
ImportExportController,
|
||||
],
|
||||
providers: [
|
||||
KnowledgeService,
|
||||
LinkResolutionService,
|
||||
@@ -23,6 +30,7 @@ import {
|
||||
LinkSyncService,
|
||||
GraphService,
|
||||
StatsService,
|
||||
ImportExportService,
|
||||
],
|
||||
exports: [KnowledgeService, LinkResolutionService, SearchService],
|
||||
})
|
||||
|
||||
297
apps/api/src/knowledge/services/import-export.service.spec.ts
Normal file
297
apps/api/src/knowledge/services/import-export.service.spec.ts
Normal file
@@ -0,0 +1,297 @@
|
||||
import { describe, it, expect, beforeEach, vi } from "vitest";
|
||||
import { Test, TestingModule } from "@nestjs/testing";
|
||||
import { BadRequestException } from "@nestjs/common";
|
||||
import { ImportExportService } from "./import-export.service";
|
||||
import { KnowledgeService } from "../knowledge.service";
|
||||
import { PrismaService } from "../../prisma/prisma.service";
|
||||
import { ExportFormat } from "../dto";
|
||||
import { EntryStatus, Visibility } from "@prisma/client";
|
||||
|
||||
describe("ImportExportService", () => {
|
||||
let service: ImportExportService;
|
||||
let knowledgeService: KnowledgeService;
|
||||
let prisma: PrismaService;
|
||||
|
||||
const workspaceId = "workspace-123";
|
||||
const userId = "user-123";
|
||||
|
||||
const mockEntry = {
|
||||
id: "entry-123",
|
||||
workspaceId,
|
||||
slug: "test-entry",
|
||||
title: "Test Entry",
|
||||
content: "Test content",
|
||||
summary: "Test summary",
|
||||
status: EntryStatus.PUBLISHED,
|
||||
visibility: Visibility.WORKSPACE,
|
||||
createdAt: new Date(),
|
||||
updatedAt: new Date(),
|
||||
tags: [
|
||||
{
|
||||
tag: {
|
||||
id: "tag-1",
|
||||
name: "TypeScript",
|
||||
slug: "typescript",
|
||||
color: "#3178c6",
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
const mockKnowledgeService = {
|
||||
create: vi.fn(),
|
||||
findAll: vi.fn(),
|
||||
};
|
||||
|
||||
const mockPrismaService = {
|
||||
knowledgeEntry: {
|
||||
findMany: vi.fn(),
|
||||
},
|
||||
};
|
||||
|
||||
beforeEach(async () => {
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
providers: [
|
||||
ImportExportService,
|
||||
{
|
||||
provide: KnowledgeService,
|
||||
useValue: mockKnowledgeService,
|
||||
},
|
||||
{
|
||||
provide: PrismaService,
|
||||
useValue: mockPrismaService,
|
||||
},
|
||||
],
|
||||
}).compile();
|
||||
|
||||
service = module.get<ImportExportService>(ImportExportService);
|
||||
knowledgeService = module.get<KnowledgeService>(KnowledgeService);
|
||||
prisma = module.get<PrismaService>(PrismaService);
|
||||
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
describe("importEntries", () => {
|
||||
it("should import a single markdown file successfully", async () => {
|
||||
const markdown = `---
|
||||
title: Test Entry
|
||||
status: PUBLISHED
|
||||
tags:
|
||||
- TypeScript
|
||||
- Testing
|
||||
---
|
||||
|
||||
This is the content of the entry.`;
|
||||
|
||||
const file: Express.Multer.File = {
|
||||
fieldname: "file",
|
||||
originalname: "test.md",
|
||||
encoding: "utf-8",
|
||||
mimetype: "text/markdown",
|
||||
size: markdown.length,
|
||||
buffer: Buffer.from(markdown),
|
||||
stream: null as any,
|
||||
destination: "",
|
||||
filename: "",
|
||||
path: "",
|
||||
};
|
||||
|
||||
mockKnowledgeService.create.mockResolvedValue({
|
||||
id: "entry-123",
|
||||
slug: "test-entry",
|
||||
title: "Test Entry",
|
||||
});
|
||||
|
||||
const result = await service.importEntries(workspaceId, userId, file);
|
||||
|
||||
expect(result.totalFiles).toBe(1);
|
||||
expect(result.imported).toBe(1);
|
||||
expect(result.failed).toBe(0);
|
||||
expect(result.results[0].success).toBe(true);
|
||||
expect(result.results[0].title).toBe("Test Entry");
|
||||
expect(mockKnowledgeService.create).toHaveBeenCalledWith(
|
||||
workspaceId,
|
||||
userId,
|
||||
expect.objectContaining({
|
||||
title: "Test Entry",
|
||||
content: "This is the content of the entry.",
|
||||
status: EntryStatus.PUBLISHED,
|
||||
tags: ["TypeScript", "Testing"],
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
it("should use filename as title if frontmatter title is missing", async () => {
|
||||
const markdown = `This is content without frontmatter.`;
|
||||
|
||||
const file: Express.Multer.File = {
|
||||
fieldname: "file",
|
||||
originalname: "my-entry.md",
|
||||
encoding: "utf-8",
|
||||
mimetype: "text/markdown",
|
||||
size: markdown.length,
|
||||
buffer: Buffer.from(markdown),
|
||||
stream: null as any,
|
||||
destination: "",
|
||||
filename: "",
|
||||
path: "",
|
||||
};
|
||||
|
||||
mockKnowledgeService.create.mockResolvedValue({
|
||||
id: "entry-123",
|
||||
slug: "my-entry",
|
||||
title: "my-entry",
|
||||
});
|
||||
|
||||
const result = await service.importEntries(workspaceId, userId, file);
|
||||
|
||||
expect(result.imported).toBe(1);
|
||||
expect(mockKnowledgeService.create).toHaveBeenCalledWith(
|
||||
workspaceId,
|
||||
userId,
|
||||
expect.objectContaining({
|
||||
title: "my-entry",
|
||||
content: "This is content without frontmatter.",
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
it("should reject invalid file types", async () => {
|
||||
const file: Express.Multer.File = {
|
||||
fieldname: "file",
|
||||
originalname: "test.txt",
|
||||
encoding: "utf-8",
|
||||
mimetype: "text/plain",
|
||||
size: 100,
|
||||
buffer: Buffer.from("test"),
|
||||
stream: null as any,
|
||||
destination: "",
|
||||
filename: "",
|
||||
path: "",
|
||||
};
|
||||
|
||||
await expect(
|
||||
service.importEntries(workspaceId, userId, file)
|
||||
).rejects.toThrow(BadRequestException);
|
||||
});
|
||||
|
||||
it("should handle import errors gracefully", async () => {
|
||||
const markdown = `---
|
||||
title: Test Entry
|
||||
---
|
||||
|
||||
Content`;
|
||||
|
||||
const file: Express.Multer.File = {
|
||||
fieldname: "file",
|
||||
originalname: "test.md",
|
||||
encoding: "utf-8",
|
||||
mimetype: "text/markdown",
|
||||
size: markdown.length,
|
||||
buffer: Buffer.from(markdown),
|
||||
stream: null as any,
|
||||
destination: "",
|
||||
filename: "",
|
||||
path: "",
|
||||
};
|
||||
|
||||
mockKnowledgeService.create.mockRejectedValue(
|
||||
new Error("Database error")
|
||||
);
|
||||
|
||||
const result = await service.importEntries(workspaceId, userId, file);
|
||||
|
||||
expect(result.totalFiles).toBe(1);
|
||||
expect(result.imported).toBe(0);
|
||||
expect(result.failed).toBe(1);
|
||||
expect(result.results[0].success).toBe(false);
|
||||
expect(result.results[0].error).toBe("Database error");
|
||||
});
|
||||
|
||||
it("should reject empty markdown content", async () => {
|
||||
const markdown = `---
|
||||
title: Empty Entry
|
||||
---
|
||||
|
||||
`;
|
||||
|
||||
const file: Express.Multer.File = {
|
||||
fieldname: "file",
|
||||
originalname: "empty.md",
|
||||
encoding: "utf-8",
|
||||
mimetype: "text/markdown",
|
||||
size: markdown.length,
|
||||
buffer: Buffer.from(markdown),
|
||||
stream: null as any,
|
||||
destination: "",
|
||||
filename: "",
|
||||
path: "",
|
||||
};
|
||||
|
||||
const result = await service.importEntries(workspaceId, userId, file);
|
||||
|
||||
expect(result.imported).toBe(0);
|
||||
expect(result.failed).toBe(1);
|
||||
expect(result.results[0].error).toBe("Empty content");
|
||||
});
|
||||
});
|
||||
|
||||
describe("exportEntries", () => {
|
||||
it("should export entries as markdown format", async () => {
|
||||
mockPrismaService.knowledgeEntry.findMany.mockResolvedValue([mockEntry]);
|
||||
|
||||
const result = await service.exportEntries(
|
||||
workspaceId,
|
||||
ExportFormat.MARKDOWN
|
||||
);
|
||||
|
||||
expect(result.filename).toMatch(/knowledge-export-\d{4}-\d{2}-\d{2}\.zip/);
|
||||
expect(result.stream).toBeDefined();
|
||||
expect(mockPrismaService.knowledgeEntry.findMany).toHaveBeenCalledWith({
|
||||
where: { workspaceId },
|
||||
include: {
|
||||
tags: {
|
||||
include: {
|
||||
tag: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
orderBy: {
|
||||
title: "asc",
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it("should export only specified entries", async () => {
|
||||
const entryIds = ["entry-123", "entry-456"];
|
||||
mockPrismaService.knowledgeEntry.findMany.mockResolvedValue([mockEntry]);
|
||||
|
||||
await service.exportEntries(workspaceId, ExportFormat.JSON, entryIds);
|
||||
|
||||
expect(mockPrismaService.knowledgeEntry.findMany).toHaveBeenCalledWith({
|
||||
where: {
|
||||
workspaceId,
|
||||
id: { in: entryIds },
|
||||
},
|
||||
include: {
|
||||
tags: {
|
||||
include: {
|
||||
tag: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
orderBy: {
|
||||
title: "asc",
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it("should throw error when no entries found", async () => {
|
||||
mockPrismaService.knowledgeEntry.findMany.mockResolvedValue([]);
|
||||
|
||||
await expect(
|
||||
service.exportEntries(workspaceId, ExportFormat.MARKDOWN)
|
||||
).rejects.toThrow(BadRequestException);
|
||||
});
|
||||
});
|
||||
});
|
||||
315
apps/api/src/knowledge/services/import-export.service.ts
Normal file
315
apps/api/src/knowledge/services/import-export.service.ts
Normal file
@@ -0,0 +1,315 @@
|
||||
import { Injectable, BadRequestException } from "@nestjs/common";
|
||||
import { EntryStatus, Visibility } from "@prisma/client";
|
||||
import * as archiver from "archiver";
|
||||
import * as AdmZip from "adm-zip";
|
||||
import * as matter from "gray-matter";
|
||||
import { Readable } from "stream";
|
||||
import { PrismaService } from "../../prisma/prisma.service";
|
||||
import { KnowledgeService } from "../knowledge.service";
|
||||
import type { ExportFormat, ImportResult } from "../dto";
|
||||
import type { CreateEntryDto } from "../dto/create-entry.dto";
|
||||
|
||||
/**
|
||||
* Service for handling knowledge entry import/export operations
|
||||
*/
|
||||
@Injectable()
|
||||
export class ImportExportService {
|
||||
constructor(
|
||||
private readonly prisma: PrismaService,
|
||||
private readonly knowledgeService: KnowledgeService
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Import entries from uploaded file(s)
|
||||
* Accepts single .md file or .zip containing multiple .md files
|
||||
*/
|
||||
async importEntries(
|
||||
workspaceId: string,
|
||||
userId: string,
|
||||
file: Express.Multer.File
|
||||
): Promise<{ results: ImportResult[]; totalFiles: number; imported: number; failed: number }> {
|
||||
const results: ImportResult[] = [];
|
||||
|
||||
try {
|
||||
if (file.mimetype === "text/markdown" || file.originalname.endsWith(".md")) {
|
||||
// Single markdown file
|
||||
const result = await this.importSingleMarkdown(
|
||||
workspaceId,
|
||||
userId,
|
||||
file.originalname,
|
||||
file.buffer.toString("utf-8")
|
||||
);
|
||||
results.push(result);
|
||||
} else if (
|
||||
file.mimetype === "application/zip" ||
|
||||
file.mimetype === "application/x-zip-compressed" ||
|
||||
file.originalname.endsWith(".zip")
|
||||
) {
|
||||
// Zip file containing multiple markdown files
|
||||
const zipResults = await this.importZipFile(workspaceId, userId, file.buffer);
|
||||
results.push(...zipResults);
|
||||
} else {
|
||||
throw new BadRequestException(
|
||||
"Invalid file type. Only .md and .zip files are accepted."
|
||||
);
|
||||
}
|
||||
} catch (error) {
|
||||
throw new BadRequestException(
|
||||
`Failed to import file: ${error instanceof Error ? error.message : "Unknown error"}`
|
||||
);
|
||||
}
|
||||
|
||||
const imported = results.filter((r) => r.success).length;
|
||||
const failed = results.filter((r) => !r.success).length;
|
||||
|
||||
return {
|
||||
results,
|
||||
totalFiles: results.length,
|
||||
imported,
|
||||
failed,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Import a single markdown file
|
||||
*/
|
||||
private async importSingleMarkdown(
|
||||
workspaceId: string,
|
||||
userId: string,
|
||||
filename: string,
|
||||
content: string
|
||||
): Promise<ImportResult> {
|
||||
try {
|
||||
// Parse frontmatter
|
||||
const parsed = matter(content);
|
||||
const frontmatter = parsed.data;
|
||||
const markdownContent = parsed.content.trim();
|
||||
|
||||
if (!markdownContent) {
|
||||
return {
|
||||
filename,
|
||||
success: false,
|
||||
error: "Empty content",
|
||||
};
|
||||
}
|
||||
|
||||
// Build CreateEntryDto from frontmatter and content
|
||||
const createDto: CreateEntryDto = {
|
||||
title: frontmatter.title || filename.replace(/\.md$/, ""),
|
||||
content: markdownContent,
|
||||
summary: frontmatter.summary,
|
||||
status: this.parseStatus(frontmatter.status),
|
||||
visibility: this.parseVisibility(frontmatter.visibility),
|
||||
tags: Array.isArray(frontmatter.tags) ? frontmatter.tags : undefined,
|
||||
changeNote: "Imported from markdown file",
|
||||
};
|
||||
|
||||
// Create the entry
|
||||
const entry = await this.knowledgeService.create(
|
||||
workspaceId,
|
||||
userId,
|
||||
createDto
|
||||
);
|
||||
|
||||
return {
|
||||
filename,
|
||||
success: true,
|
||||
entryId: entry.id,
|
||||
slug: entry.slug,
|
||||
title: entry.title,
|
||||
};
|
||||
} catch (error) {
|
||||
return {
|
||||
filename,
|
||||
success: false,
|
||||
error: error instanceof Error ? error.message : "Unknown error",
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Import entries from a zip file
|
||||
*/
|
||||
private async importZipFile(
|
||||
workspaceId: string,
|
||||
userId: string,
|
||||
buffer: Buffer
|
||||
): Promise<ImportResult[]> {
|
||||
const results: ImportResult[] = [];
|
||||
|
||||
try {
|
||||
const zip = new AdmZip(buffer);
|
||||
const zipEntries = zip.getEntries();
|
||||
|
||||
for (const zipEntry of zipEntries) {
|
||||
// Skip directories and non-markdown files
|
||||
if (zipEntry.isDirectory || !zipEntry.entryName.endsWith(".md")) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const content = zipEntry.getData().toString("utf-8");
|
||||
const result = await this.importSingleMarkdown(
|
||||
workspaceId,
|
||||
userId,
|
||||
zipEntry.entryName,
|
||||
content
|
||||
);
|
||||
results.push(result);
|
||||
}
|
||||
} catch (error) {
|
||||
throw new BadRequestException(
|
||||
`Failed to extract zip file: ${error instanceof Error ? error.message : "Unknown error"}`
|
||||
);
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
|
||||
/**
|
||||
* Export entries as a zip file
|
||||
*/
|
||||
async exportEntries(
|
||||
workspaceId: string,
|
||||
format: ExportFormat,
|
||||
entryIds?: string[]
|
||||
): Promise<{ stream: Readable; filename: string }> {
|
||||
// Fetch entries
|
||||
const entries = await this.fetchEntriesForExport(workspaceId, entryIds);
|
||||
|
||||
if (entries.length === 0) {
|
||||
throw new BadRequestException("No entries found to export");
|
||||
}
|
||||
|
||||
// Create archive
|
||||
const archive = archiver("zip", {
|
||||
zlib: { level: 9 },
|
||||
});
|
||||
|
||||
// Add entries to archive
|
||||
for (const entry of entries) {
|
||||
if (format === "markdown") {
|
||||
const markdown = this.entryToMarkdown(entry);
|
||||
const filename = `${entry.slug}.md`;
|
||||
archive.append(markdown, { name: filename });
|
||||
} else {
|
||||
// JSON format
|
||||
const json = JSON.stringify(entry, null, 2);
|
||||
const filename = `${entry.slug}.json`;
|
||||
archive.append(json, { name: filename });
|
||||
}
|
||||
}
|
||||
|
||||
// Finalize archive
|
||||
archive.finalize();
|
||||
|
||||
// Generate filename
|
||||
const timestamp = new Date().toISOString().split("T")[0];
|
||||
const filename = `knowledge-export-${timestamp}.zip`;
|
||||
|
||||
return {
|
||||
stream: archive,
|
||||
filename,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch entries for export
|
||||
*/
|
||||
private async fetchEntriesForExport(
|
||||
workspaceId: string,
|
||||
entryIds?: string[]
|
||||
): Promise<any[]> {
|
||||
const where: any = { workspaceId };
|
||||
|
||||
if (entryIds && entryIds.length > 0) {
|
||||
where.id = { in: entryIds };
|
||||
}
|
||||
|
||||
const entries = await this.prisma.knowledgeEntry.findMany({
|
||||
where,
|
||||
include: {
|
||||
tags: {
|
||||
include: {
|
||||
tag: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
orderBy: {
|
||||
title: "asc",
|
||||
},
|
||||
});
|
||||
|
||||
return entries.map((entry) => ({
|
||||
id: entry.id,
|
||||
slug: entry.slug,
|
||||
title: entry.title,
|
||||
content: entry.content,
|
||||
summary: entry.summary,
|
||||
status: entry.status,
|
||||
visibility: entry.visibility,
|
||||
tags: entry.tags.map((et) => et.tag.name),
|
||||
createdAt: entry.createdAt,
|
||||
updatedAt: entry.updatedAt,
|
||||
}));
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert entry to markdown format with frontmatter
|
||||
*/
|
||||
private entryToMarkdown(entry: any): string {
|
||||
const frontmatter: Record<string, any> = {
|
||||
title: entry.title,
|
||||
status: entry.status,
|
||||
visibility: entry.visibility,
|
||||
};
|
||||
|
||||
if (entry.summary) {
|
||||
frontmatter.summary = entry.summary;
|
||||
}
|
||||
|
||||
if (entry.tags && entry.tags.length > 0) {
|
||||
frontmatter.tags = entry.tags;
|
||||
}
|
||||
|
||||
frontmatter.createdAt = entry.createdAt.toISOString();
|
||||
frontmatter.updatedAt = entry.updatedAt.toISOString();
|
||||
|
||||
// Build frontmatter string
|
||||
const frontmatterStr = Object.entries(frontmatter)
|
||||
.map(([key, value]) => {
|
||||
if (Array.isArray(value)) {
|
||||
return `${key}:\n - ${value.join("\n - ")}`;
|
||||
}
|
||||
return `${key}: ${value}`;
|
||||
})
|
||||
.join("\n");
|
||||
|
||||
return `---\n${frontmatterStr}\n---\n\n${entry.content}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse status from frontmatter
|
||||
*/
|
||||
private parseStatus(value: any): EntryStatus | undefined {
|
||||
if (!value) return undefined;
|
||||
const statusMap: Record<string, EntryStatus> = {
|
||||
DRAFT: EntryStatus.DRAFT,
|
||||
PUBLISHED: EntryStatus.PUBLISHED,
|
||||
ARCHIVED: EntryStatus.ARCHIVED,
|
||||
};
|
||||
return statusMap[String(value).toUpperCase()];
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse visibility from frontmatter
|
||||
*/
|
||||
private parseVisibility(value: any): Visibility | undefined {
|
||||
if (!value) return undefined;
|
||||
const visibilityMap: Record<string, Visibility> = {
|
||||
PRIVATE: Visibility.PRIVATE,
|
||||
WORKSPACE: Visibility.WORKSPACE,
|
||||
PUBLIC: Visibility.PUBLIC,
|
||||
};
|
||||
return visibilityMap[String(value).toUpperCase()];
|
||||
}
|
||||
}
|
||||
@@ -8,3 +8,4 @@ export { LinkSyncService } from "./link-sync.service";
|
||||
export { SearchService } from "./search.service";
|
||||
export { GraphService } from "./graph.service";
|
||||
export { StatsService } from "./stats.service";
|
||||
export { ImportExportService } from "./import-export.service";
|
||||
|
||||
@@ -4,6 +4,7 @@ import { useState, useMemo } from "react";
|
||||
import { EntryStatus } from "@mosaic/shared";
|
||||
import { EntryList } from "@/components/knowledge/EntryList";
|
||||
import { EntryFilters } from "@/components/knowledge/EntryFilters";
|
||||
import { ImportExportActions } from "@/components/knowledge";
|
||||
import { mockEntries, mockTags } from "@/lib/api/knowledge";
|
||||
import Link from "next/link";
|
||||
import { Plus } from "lucide-react";
|
||||
@@ -99,22 +100,35 @@ export default function KnowledgePage() {
|
||||
return (
|
||||
<main className="container mx-auto px-4 py-8 max-w-5xl">
|
||||
{/* Header */}
|
||||
<div className="mb-8 flex items-center justify-between">
|
||||
<div>
|
||||
<h1 className="text-3xl font-bold text-gray-900">Knowledge Base</h1>
|
||||
<p className="text-gray-600 mt-2">
|
||||
Documentation, guides, and knowledge entries
|
||||
</p>
|
||||
<div className="mb-8">
|
||||
<div className="flex items-center justify-between mb-4">
|
||||
<div>
|
||||
<h1 className="text-3xl font-bold text-gray-900">Knowledge Base</h1>
|
||||
<p className="text-gray-600 mt-2">
|
||||
Documentation, guides, and knowledge entries
|
||||
</p>
|
||||
</div>
|
||||
|
||||
{/* Create button */}
|
||||
<Link
|
||||
href="/knowledge/new"
|
||||
className="inline-flex items-center gap-2 px-4 py-2 bg-blue-600 text-white rounded-lg hover:bg-blue-700 transition-colors shadow-sm"
|
||||
>
|
||||
<Plus className="w-5 h-5" />
|
||||
<span>Create Entry</span>
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
{/* Create button */}
|
||||
<Link
|
||||
href="/knowledge/new"
|
||||
className="inline-flex items-center gap-2 px-4 py-2 bg-blue-600 text-white rounded-lg hover:bg-blue-700 transition-colors shadow-sm"
|
||||
>
|
||||
<Plus className="w-5 h-5" />
|
||||
<span>Create Entry</span>
|
||||
</Link>
|
||||
{/* Import/Export Actions */}
|
||||
<div className="flex justify-end">
|
||||
<ImportExportActions
|
||||
onImportComplete={() => {
|
||||
// TODO: Refresh the entry list when real API is connected
|
||||
// For now, this would trigger a refetch of the entries
|
||||
window.location.reload();
|
||||
}}
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Filters */}
|
||||
|
||||
316
apps/web/src/components/knowledge/ImportExportActions.tsx
Normal file
316
apps/web/src/components/knowledge/ImportExportActions.tsx
Normal file
@@ -0,0 +1,316 @@
|
||||
"use client";
|
||||
|
||||
import { useState, useRef } from "react";
|
||||
import { Upload, Download, Loader2, CheckCircle2, XCircle } from "lucide-react";
|
||||
|
||||
interface ImportResult {
|
||||
filename: string;
|
||||
success: boolean;
|
||||
entryId?: string;
|
||||
slug?: string;
|
||||
title?: string;
|
||||
error?: string;
|
||||
}
|
||||
|
||||
interface ImportResponse {
|
||||
success: boolean;
|
||||
totalFiles: number;
|
||||
imported: number;
|
||||
failed: number;
|
||||
results: ImportResult[];
|
||||
}
|
||||
|
||||
interface ImportExportActionsProps {
|
||||
selectedEntryIds?: string[];
|
||||
onImportComplete?: () => void;
|
||||
}
|
||||
|
||||
export function ImportExportActions({
|
||||
selectedEntryIds = [],
|
||||
onImportComplete,
|
||||
}: ImportExportActionsProps) {
|
||||
const [isImporting, setIsImporting] = useState(false);
|
||||
const [isExporting, setIsExporting] = useState(false);
|
||||
const [importResult, setImportResult] = useState<ImportResponse | null>(null);
|
||||
const [showImportDialog, setShowImportDialog] = useState(false);
|
||||
const fileInputRef = useRef<HTMLInputElement>(null);
|
||||
|
||||
/**
|
||||
* Handle import file selection
|
||||
*/
|
||||
const handleImportClick = () => {
|
||||
fileInputRef.current?.click();
|
||||
};
|
||||
|
||||
/**
|
||||
* Handle file upload and import
|
||||
*/
|
||||
const handleFileChange = async (e: React.ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
|
||||
// Validate file type
|
||||
if (!file.name.endsWith(".md") && !file.name.endsWith(".zip")) {
|
||||
alert("Please upload a .md or .zip file");
|
||||
return;
|
||||
}
|
||||
|
||||
setIsImporting(true);
|
||||
setShowImportDialog(true);
|
||||
setImportResult(null);
|
||||
|
||||
try {
|
||||
const formData = new FormData();
|
||||
formData.append("file", file);
|
||||
|
||||
const response = await fetch("/api/knowledge/import", {
|
||||
method: "POST",
|
||||
body: formData,
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
const error = await response.json();
|
||||
throw new Error(error.message || "Import failed");
|
||||
}
|
||||
|
||||
const result: ImportResponse = await response.json();
|
||||
setImportResult(result);
|
||||
|
||||
// Notify parent component
|
||||
if (result.imported > 0 && onImportComplete) {
|
||||
onImportComplete();
|
||||
}
|
||||
} catch (error) {
|
||||
console.error("Import error:", error);
|
||||
alert(error instanceof Error ? error.message : "Failed to import file");
|
||||
setShowImportDialog(false);
|
||||
} finally {
|
||||
setIsImporting(false);
|
||||
// Reset file input
|
||||
if (fileInputRef.current) {
|
||||
fileInputRef.current.value = "";
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Handle export
|
||||
*/
|
||||
const handleExport = async (format: "markdown" | "json" = "markdown") => {
|
||||
setIsExporting(true);
|
||||
|
||||
try {
|
||||
// Build query params
|
||||
const params = new URLSearchParams({
|
||||
format,
|
||||
});
|
||||
|
||||
// Add selected entry IDs if any
|
||||
if (selectedEntryIds.length > 0) {
|
||||
selectedEntryIds.forEach((id) => params.append("entryIds", id));
|
||||
}
|
||||
|
||||
const response = await fetch(`/api/knowledge/export?${params.toString()}`, {
|
||||
method: "GET",
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error("Export failed");
|
||||
}
|
||||
|
||||
// Get filename from Content-Disposition header
|
||||
const contentDisposition = response.headers.get("Content-Disposition");
|
||||
const filenameMatch = contentDisposition?.match(/filename="(.+)"/);
|
||||
const filename = filenameMatch?.[1] || `knowledge-export-${format}.zip`;
|
||||
|
||||
// Download file
|
||||
const blob = await response.blob();
|
||||
const url = window.URL.createObjectURL(blob);
|
||||
const a = document.createElement("a");
|
||||
a.href = url;
|
||||
a.download = filename;
|
||||
document.body.appendChild(a);
|
||||
a.click();
|
||||
window.URL.revokeObjectURL(url);
|
||||
document.body.removeChild(a);
|
||||
} catch (error) {
|
||||
console.error("Export error:", error);
|
||||
alert("Failed to export entries");
|
||||
} finally {
|
||||
setIsExporting(false);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Close import dialog
|
||||
*/
|
||||
const handleCloseImportDialog = () => {
|
||||
setShowImportDialog(false);
|
||||
setImportResult(null);
|
||||
};
|
||||
|
||||
return (
|
||||
<>
|
||||
{/* Action Buttons */}
|
||||
<div className="flex items-center gap-2">
|
||||
{/* Import Button */}
|
||||
<button
|
||||
onClick={handleImportClick}
|
||||
disabled={isImporting}
|
||||
className="inline-flex items-center gap-2 px-4 py-2 bg-gray-100 text-gray-700 rounded-lg hover:bg-gray-200 transition-colors disabled:opacity-50 disabled:cursor-not-allowed"
|
||||
title="Import entries from .md or .zip file"
|
||||
>
|
||||
{isImporting ? (
|
||||
<Loader2 className="w-5 h-5 animate-spin" />
|
||||
) : (
|
||||
<Upload className="w-5 h-5" />
|
||||
)}
|
||||
<span>Import</span>
|
||||
</button>
|
||||
|
||||
{/* Export Dropdown */}
|
||||
<div className="relative group">
|
||||
<button
|
||||
disabled={isExporting}
|
||||
className="inline-flex items-center gap-2 px-4 py-2 bg-gray-100 text-gray-700 rounded-lg hover:bg-gray-200 transition-colors disabled:opacity-50 disabled:cursor-not-allowed"
|
||||
title="Export entries"
|
||||
>
|
||||
{isExporting ? (
|
||||
<Loader2 className="w-5 h-5 animate-spin" />
|
||||
) : (
|
||||
<Download className="w-5 h-5" />
|
||||
)}
|
||||
<span>Export</span>
|
||||
</button>
|
||||
|
||||
{/* Dropdown Menu */}
|
||||
<div className="absolute right-0 mt-1 w-48 bg-white rounded-lg shadow-lg border border-gray-200 opacity-0 invisible group-hover:opacity-100 group-hover:visible transition-all z-10">
|
||||
<div className="py-1">
|
||||
<button
|
||||
onClick={() => handleExport("markdown")}
|
||||
className="w-full text-left px-4 py-2 hover:bg-gray-100 text-sm text-gray-700"
|
||||
>
|
||||
Export as Markdown
|
||||
</button>
|
||||
<button
|
||||
onClick={() => handleExport("json")}
|
||||
className="w-full text-left px-4 py-2 hover:bg-gray-100 text-sm text-gray-700"
|
||||
>
|
||||
Export as JSON
|
||||
</button>
|
||||
{selectedEntryIds.length > 0 && (
|
||||
<div className="border-t border-gray-200 mt-1 pt-1 px-4 py-2 text-xs text-gray-500">
|
||||
{selectedEntryIds.length} selected
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Hidden File Input */}
|
||||
<input
|
||||
ref={fileInputRef}
|
||||
type="file"
|
||||
accept=".md,.zip"
|
||||
onChange={handleFileChange}
|
||||
className="hidden"
|
||||
/>
|
||||
|
||||
{/* Import Result Dialog */}
|
||||
{showImportDialog && (
|
||||
<div className="fixed inset-0 bg-black bg-opacity-50 flex items-center justify-center z-50">
|
||||
<div className="bg-white rounded-lg shadow-xl max-w-2xl w-full mx-4 max-h-[80vh] flex flex-col">
|
||||
{/* Header */}
|
||||
<div className="px-6 py-4 border-b border-gray-200">
|
||||
<h2 className="text-xl font-semibold text-gray-900">
|
||||
{isImporting ? "Importing..." : "Import Results"}
|
||||
</h2>
|
||||
</div>
|
||||
|
||||
{/* Content */}
|
||||
<div className="px-6 py-4 overflow-y-auto flex-1">
|
||||
{isImporting && (
|
||||
<div className="flex items-center justify-center py-8">
|
||||
<Loader2 className="w-8 h-8 animate-spin text-blue-600" />
|
||||
<span className="ml-3 text-gray-600">Processing file...</span>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{importResult && (
|
||||
<div>
|
||||
{/* Summary */}
|
||||
<div className="grid grid-cols-3 gap-4 mb-6">
|
||||
<div className="bg-gray-50 rounded-lg p-4">
|
||||
<div className="text-sm text-gray-600">Total Files</div>
|
||||
<div className="text-2xl font-semibold text-gray-900">
|
||||
{importResult.totalFiles}
|
||||
</div>
|
||||
</div>
|
||||
<div className="bg-green-50 rounded-lg p-4">
|
||||
<div className="text-sm text-green-600">Imported</div>
|
||||
<div className="text-2xl font-semibold text-green-700">
|
||||
{importResult.imported}
|
||||
</div>
|
||||
</div>
|
||||
<div className="bg-red-50 rounded-lg p-4">
|
||||
<div className="text-sm text-red-600">Failed</div>
|
||||
<div className="text-2xl font-semibold text-red-700">
|
||||
{importResult.failed}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Results List */}
|
||||
{importResult.results.length > 0 && (
|
||||
<div className="space-y-2">
|
||||
<h3 className="font-medium text-gray-900 mb-2">Details</h3>
|
||||
{importResult.results.map((result, index) => (
|
||||
<div
|
||||
key={index}
|
||||
className={`flex items-start gap-3 p-3 rounded-lg ${
|
||||
result.success ? "bg-green-50" : "bg-red-50"
|
||||
}`}
|
||||
>
|
||||
{result.success ? (
|
||||
<CheckCircle2 className="w-5 h-5 text-green-600 flex-shrink-0 mt-0.5" />
|
||||
) : (
|
||||
<XCircle className="w-5 h-5 text-red-600 flex-shrink-0 mt-0.5" />
|
||||
)}
|
||||
<div className="flex-1 min-w-0">
|
||||
<div className="font-medium text-sm text-gray-900 truncate">
|
||||
{result.title || result.filename}
|
||||
</div>
|
||||
{result.success ? (
|
||||
<div className="text-xs text-gray-600">
|
||||
{result.slug && `Slug: ${result.slug}`}
|
||||
</div>
|
||||
) : (
|
||||
<div className="text-xs text-red-600">{result.error}</div>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
|
||||
{/* Footer */}
|
||||
{!isImporting && (
|
||||
<div className="px-6 py-4 border-t border-gray-200 flex justify-end">
|
||||
<button
|
||||
onClick={handleCloseImportDialog}
|
||||
className="px-4 py-2 bg-blue-600 text-white rounded-lg hover:bg-blue-700 transition-colors"
|
||||
>
|
||||
Close
|
||||
</button>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -6,3 +6,4 @@ export { EntryViewer } from "./EntryViewer";
|
||||
export { EntryEditor } from "./EntryEditor";
|
||||
export { EntryMetadata } from "./EntryMetadata";
|
||||
export { VersionHistory } from "./VersionHistory";
|
||||
export { ImportExportActions } from "./ImportExportActions";
|
||||
|
||||
Reference in New Issue
Block a user