@waylis/core / Database
Interface: Database
Defined in: database/database.ts:7
Unified database interface combining chats, messages, confirmed steps, and files.
Extends
Properties
close()
close: () => Promise<void>;Defined in: database/database.ts:9
Returns
Promise<void>
isOpen
isOpen: boolean;Defined in: database/database.ts:8
open()
open: () => Promise<void>;Defined in: database/database.ts:10
Returns
Promise<void>
Methods
addChat()
addChat(chat: Chat): Promise<void>;Defined in: chat/chat.ts:23
Add a new chat to the database.
Parameters
chat
Chat object to store.
Returns
Promise<void>
Inherited from
addConfirmedStep()
addConfirmedStep(step: ConfirmedStep): Promise<void>;Defined in: scene/step.ts:43
Store a confirmed step.
Parameters
step
Step to add.
Returns
Promise<void>
Inherited from
ConfirmedStepDatabase.addConfirmedStep
addFile()
addFile(data: FileMeta): Promise<void>;Defined in: file/file.ts:61
Add file metadata to the database.
Parameters
data
File metadata to store.
Returns
Promise<void>
Inherited from
addMessage()
addMessage(msg: Message): Promise<void>;Defined in: message/message.ts:54
Add a new message to the database.
Parameters
msg
Message to store.
Returns
Promise<void>
Inherited from
countChatsByCreatorID()
countChatsByCreatorID(creatorID: string): Promise<number>;Defined in: chat/chat.ts:44
Count how many chats were created by a user.
Parameters
creatorID
string
User identifier.
Returns
Promise<number>
Inherited from
ChatDatabase.countChatsByCreatorID
deleteChatByID()
deleteChatByID(id: string): Promise<null | Chat>;Defined in: chat/chat.ts:59
Remove a chat by ID.
Parameters
id
string
Chat identifier.
Returns
Promise<null | Chat>
Deleted chat or null if not found.
Inherited from
deleteFileByID()
deleteFileByID(id: string): Promise<null | FileMeta>;Defined in: file/file.ts:81
Delete file metadata by ID.
Parameters
id
string
File identifier.
Returns
Promise<null | FileMeta>
Deleted metadata or null if not found.
Inherited from
deleteMessagesByChatID()
deleteMessagesByChatID(chatID: string): Promise<number>;Defined in: message/message.ts:89
Delete all messages belonging to a chat.
Parameters
chatID
string
Chat identifier.
Returns
Promise<number>
Number of deleted messages.
Inherited from
MessageDatabase.deleteMessagesByChatID
deleteOldConfirmedSteps()
deleteOldConfirmedSteps(maxDate: Date): Promise<number>;Defined in: scene/step.ts:56
Delete all confirmed steps created before a given date.
Parameters
maxDate
Date
Cutoff date.
Returns
Promise<number>
Number of deleted steps.
Inherited from
ConfirmedStepDatabase.deleteOldConfirmedSteps
deleteOldFiles()
deleteOldFiles(maxDate: Date): Promise<string[]>;Defined in: file/file.ts:88
Delete all files created before a given date.
Parameters
maxDate
Date
Cutoff date.
Returns
Promise<string[]>
List of deleted file IDs.
Inherited from
deleteOldMessages()
deleteOldMessages(maxDate: Date): Promise<number>;Defined in: message/message.ts:82
Delete all messages created before a given date.
Parameters
maxDate
Date
Cutoff date.
Returns
Promise<number>
Number of deleted messages.
Inherited from
MessageDatabase.deleteOldMessages
editChatByID()
editChatByID(id: string, updated: Partial<Chat>): Promise<null | Chat>;Defined in: chat/chat.ts:52
Update a chat by ID.
Parameters
id
string
Chat identifier.
updated
Partial<Chat>
Partial fields to update.
Returns
Promise<null | Chat>
Updated chat or null if not found.
Inherited from
getChatByID()
getChatByID(id: string): Promise<null | Chat>;Defined in: chat/chat.ts:30
Retrieve a chat by its ID.
Parameters
id
string
Chat identifier.
Returns
Promise<null | Chat>
Chat if found, otherwise null.
Inherited from
getChatsByCreatorID()
getChatsByCreatorID(
creatorID: string,
offset: number,
limit: number): Promise<Chat[]>;Defined in: chat/chat.ts:38
Retrieve chats created by a specific user.
Parameters
creatorID
string
User identifier.
offset
number
Skip this many results.
limit
number
Maximum number of results.
Returns
Promise<Chat[]>
Inherited from
ChatDatabase.getChatsByCreatorID
getConfirmedStepsByThreadID()
getConfirmedStepsByThreadID(threadID: string): Promise<ConfirmedStep[]>;Defined in: scene/step.ts:49
Retrieve all confirmed steps belonging to a thread.
Parameters
threadID
string
Thread identifier.
Returns
Promise<ConfirmedStep[]>
Inherited from
ConfirmedStepDatabase.getConfirmedStepsByThreadID
getFileByID()
getFileByID(id: string): Promise<null | FileMeta>;Defined in: file/file.ts:68
Retrieve file metadata by ID.
Parameters
id
string
File identifier.
Returns
Promise<null | FileMeta>
Metadata if found, otherwise null.
Inherited from
getFilesByIDs()
getFilesByIDs(ids: string[]): Promise<FileMeta[]>;Defined in: file/file.ts:74
Retrieve multiple files by IDs.
Parameters
ids
string[]
List of file identifiers.
Returns
Promise<FileMeta[]>
Inherited from
getMessageByID()
getMessageByID(id: string): Promise<null | Message>;Defined in: message/message.ts:61
Retrieve a message by its ID.
Parameters
id
string
Message identifier.
Returns
Promise<null | Message>
Message if found, otherwise null.
Inherited from
MessageDatabase.getMessageByID
getMessagesByChatID()
getMessagesByChatID(
chatID: string,
offset: number,
limit: number): Promise<Message[]>;Defined in: message/message.ts:75
Retrieve messages from a chat.
Parameters
chatID
string
Chat identifier.
offset
number
Skip this many results.
limit
number
Maximum number of results.
Returns
Promise<Message[]>
Inherited from
MessageDatabase.getMessagesByChatID
getMessagesByIDs()
getMessagesByIDs(ids: string[]): Promise<Message[]>;Defined in: message/message.ts:67
Retrieve multiple messages by IDs.
Parameters
ids
string[]
List of message identifiers.
Returns
Promise<Message[]>