Skip to content

@waylis/core


@waylis/core / Database

Interface: Database

Defined in: src/database/database.ts:7

Unified database interface combining chats, messages, confirmed steps, and files.

Extends

Properties

close()

ts
close: () => Promise<void>;

Defined in: src/database/database.ts:9

Returns

Promise<void>


isOpen

ts
isOpen: boolean;

Defined in: src/database/database.ts:8


open()

ts
open: () => Promise<void>;

Defined in: src/database/database.ts:10

Returns

Promise<void>

Methods

addChat()

ts
addChat(chat: Chat): Promise<void>;

Defined in: src/chat/chat.ts:23

Add a new chat to the database.

Parameters

chat

Chat

Chat object to store.

Returns

Promise<void>

Inherited from

ChatDatabase.addChat


addConfirmedStep()

ts
addConfirmedStep(step: ConfirmedStep): Promise<void>;

Defined in: src/scene/step.ts:43

Store a confirmed step.

Parameters

step

ConfirmedStep

Step to add.

Returns

Promise<void>

Inherited from

ConfirmedStepDatabase.addConfirmedStep


addFile()

ts
addFile(data: FileMeta): Promise<void>;

Defined in: src/file/file.ts:61

Add file metadata to the database.

Parameters

data

FileMeta

File metadata to store.

Returns

Promise<void>

Inherited from

FileDatabase.addFile


addMessage()

ts
addMessage(msg: Message): Promise<void>;

Defined in: src/message/message.ts:53

Add a new message to the database.

Parameters

msg

Message

Message to store.

Returns

Promise<void>

Inherited from

MessageDatabase.addMessage


countChatsByCreatorID()

ts
countChatsByCreatorID(creatorID: string): Promise<number>;

Defined in: src/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()

ts
deleteChatByID(id: string): Promise<null | Chat>;

Defined in: src/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

ChatDatabase.deleteChatByID


deleteFileByID()

ts
deleteFileByID(id: string): Promise<null | FileMeta>;

Defined in: src/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

FileDatabase.deleteFileByID


deleteMessagesByChatID()

ts
deleteMessagesByChatID(chatID: string): Promise<number>;

Defined in: src/message/message.ts:88

Delete all messages belonging to a chat.

Parameters

chatID

string

Chat identifier.

Returns

Promise<number>

Number of deleted messages.

Inherited from

MessageDatabase.deleteMessagesByChatID


deleteOldConfirmedSteps()

ts
deleteOldConfirmedSteps(maxDate: Date): Promise<number>;

Defined in: src/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()

ts
deleteOldFiles(maxDate: Date): Promise<string[]>;

Defined in: src/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

FileDatabase.deleteOldFiles


deleteOldMessages()

ts
deleteOldMessages(maxDate: Date): Promise<number>;

Defined in: src/message/message.ts:81

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()

ts
editChatByID(id: string, updated: Partial<Chat>): Promise<null | Chat>;

Defined in: src/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

ChatDatabase.editChatByID


getChatByID()

ts
getChatByID(id: string): Promise<null | Chat>;

Defined in: src/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

ChatDatabase.getChatByID


getChatsByCreatorID()

ts
getChatsByCreatorID(
   creatorID: string, 
   offset: number, 
limit: number): Promise<Chat[]>;

Defined in: src/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()

ts
getConfirmedStepsByThreadID(threadID: string): Promise<ConfirmedStep[]>;

Defined in: src/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()

ts
getFileByID(id: string): Promise<null | FileMeta>;

Defined in: src/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

FileDatabase.getFileByID


getFilesByIDs()

ts
getFilesByIDs(ids: string[]): Promise<FileMeta[]>;

Defined in: src/file/file.ts:74

Retrieve multiple files by IDs.

Parameters

ids

string[]

List of file identifiers.

Returns

Promise<FileMeta[]>

Inherited from

FileDatabase.getFilesByIDs


getMessageByID()

ts
getMessageByID(id: string): Promise<null | Message>;

Defined in: src/message/message.ts:60

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()

ts
getMessagesByChatID(
   chatID: string, 
   offset: number, 
limit: number): Promise<Message[]>;

Defined in: src/message/message.ts:74

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()

ts
getMessagesByIDs(ids: string[]): Promise<Message[]>;

Defined in: src/message/message.ts:66

Retrieve multiple messages by IDs.

Parameters

ids

string[]

List of message identifiers.

Returns

Promise<Message[]>

Inherited from

MessageDatabase.getMessagesByIDs

Released under the MIT License.