mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-04-25 08:46:22 +02:00
feat: add note management functionality with BlockNote support
- Introduced a new ENUM value 'NOTE' for document types in the database. - Implemented backend routes for creating, listing, and deleting notes. - Added a new frontend page for creating notes with a BlockNote editor. - Updated sidebar to include recent notes and an option to add new notes. - Enhanced API service for notes with validation and request/response schemas. - Updated translations to support new note-related terms.
This commit is contained in:
parent
8aedead33e
commit
8eceb7a5cb
13 changed files with 948 additions and 36 deletions
148
surfsense_web/lib/apis/notes-api.service.ts
Normal file
148
surfsense_web/lib/apis/notes-api.service.ts
Normal file
|
|
@ -0,0 +1,148 @@
|
|||
import { z } from "zod";
|
||||
import { ValidationError } from "../error";
|
||||
import { baseApiService } from "./base-api.service";
|
||||
|
||||
// Request/Response schemas
|
||||
const createNoteRequest = z.object({
|
||||
search_space_id: z.number(),
|
||||
title: z.string().min(1),
|
||||
blocknote_document: z.array(z.any()).optional(),
|
||||
});
|
||||
|
||||
const createNoteResponse = z.object({
|
||||
id: z.number(),
|
||||
title: z.string(),
|
||||
document_type: z.string(),
|
||||
content: z.string(),
|
||||
content_hash: z.string(),
|
||||
unique_identifier_hash: z.string().nullable(),
|
||||
document_metadata: z.record(z.any()).nullable(),
|
||||
search_space_id: z.number(),
|
||||
created_at: z.string(),
|
||||
updated_at: z.string().nullable(),
|
||||
});
|
||||
|
||||
const getNotesRequest = z.object({
|
||||
search_space_id: z.number(),
|
||||
skip: z.number().optional(),
|
||||
page: z.number().optional(),
|
||||
page_size: z.number().optional(),
|
||||
});
|
||||
|
||||
const noteItem = z.object({
|
||||
id: z.number(),
|
||||
title: z.string(),
|
||||
document_type: z.string(),
|
||||
content: z.string(),
|
||||
content_hash: z.string(),
|
||||
unique_identifier_hash: z.string().nullable(),
|
||||
document_metadata: z.record(z.any()).nullable(),
|
||||
search_space_id: z.number(),
|
||||
created_at: z.string(),
|
||||
updated_at: z.string().nullable(),
|
||||
});
|
||||
|
||||
const getNotesResponse = z.object({
|
||||
items: z.array(noteItem),
|
||||
total: z.number(),
|
||||
page: z.number(),
|
||||
page_size: z.number(),
|
||||
has_more: z.boolean(),
|
||||
});
|
||||
|
||||
const deleteNoteRequest = z.object({
|
||||
search_space_id: z.number(),
|
||||
note_id: z.number(),
|
||||
});
|
||||
|
||||
const deleteNoteResponse = z.object({
|
||||
message: z.string(),
|
||||
note_id: z.number(),
|
||||
});
|
||||
|
||||
// Type exports
|
||||
export type CreateNoteRequest = z.infer<typeof createNoteRequest>;
|
||||
export type CreateNoteResponse = z.infer<typeof createNoteResponse>;
|
||||
export type GetNotesRequest = z.infer<typeof getNotesRequest>;
|
||||
export type GetNotesResponse = z.infer<typeof getNotesResponse>;
|
||||
export type NoteItem = z.infer<typeof noteItem>;
|
||||
export type DeleteNoteRequest = z.infer<typeof deleteNoteRequest>;
|
||||
export type DeleteNoteResponse = z.infer<typeof deleteNoteResponse>;
|
||||
|
||||
class NotesApiService {
|
||||
/**
|
||||
* Create a new note
|
||||
*/
|
||||
createNote = async (request: CreateNoteRequest) => {
|
||||
const parsedRequest = createNoteRequest.safeParse(request);
|
||||
|
||||
if (!parsedRequest.success) {
|
||||
console.error("Invalid request:", parsedRequest.error);
|
||||
const errorMessage = parsedRequest.error.errors.map((err) => err.message).join(", ");
|
||||
throw new ValidationError(`Invalid request: ${errorMessage}`);
|
||||
}
|
||||
|
||||
const { search_space_id, title, blocknote_document } = parsedRequest.data;
|
||||
|
||||
// Send both title and blocknote_document in request body
|
||||
const body = {
|
||||
title,
|
||||
...(blocknote_document && { blocknote_document }),
|
||||
};
|
||||
|
||||
return baseApiService.post(
|
||||
`/api/v1/search-spaces/${search_space_id}/notes`,
|
||||
createNoteResponse,
|
||||
{ body }
|
||||
);
|
||||
};
|
||||
|
||||
/**
|
||||
* Get list of notes
|
||||
*/
|
||||
getNotes = async (request: GetNotesRequest) => {
|
||||
const parsedRequest = getNotesRequest.safeParse(request);
|
||||
|
||||
if (!parsedRequest.success) {
|
||||
console.error("Invalid request:", parsedRequest.error);
|
||||
const errorMessage = parsedRequest.error.errors.map((err) => err.message).join(", ");
|
||||
throw new ValidationError(`Invalid request: ${errorMessage}`);
|
||||
}
|
||||
|
||||
const { search_space_id, skip, page, page_size } = parsedRequest.data;
|
||||
|
||||
// Build query params
|
||||
const params = new URLSearchParams();
|
||||
if (skip !== undefined) params.append("skip", String(skip));
|
||||
if (page !== undefined) params.append("page", String(page));
|
||||
if (page_size !== undefined) params.append("page_size", String(page_size));
|
||||
|
||||
return baseApiService.get(
|
||||
`/api/v1/search-spaces/${search_space_id}/notes?${params.toString()}`,
|
||||
getNotesResponse
|
||||
);
|
||||
};
|
||||
|
||||
/**
|
||||
* Delete a note
|
||||
*/
|
||||
deleteNote = async (request: DeleteNoteRequest) => {
|
||||
const parsedRequest = deleteNoteRequest.safeParse(request);
|
||||
|
||||
if (!parsedRequest.success) {
|
||||
console.error("Invalid request:", parsedRequest.error);
|
||||
const errorMessage = parsedRequest.error.errors.map((err) => err.message).join(", ");
|
||||
throw new ValidationError(`Invalid request: ${errorMessage}`);
|
||||
}
|
||||
|
||||
const { search_space_id, note_id } = parsedRequest.data;
|
||||
|
||||
return baseApiService.delete(
|
||||
`/api/v1/search-spaces/${search_space_id}/notes/${note_id}`,
|
||||
deleteNoteResponse
|
||||
);
|
||||
};
|
||||
}
|
||||
|
||||
export const notesApiService = new NotesApiService();
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue