From 40e149e6f465ac006f016bda4243a082164874af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tina=C3=ABl=20Devresse?= <32441291+HunteRoi@users.noreply.github.com> Date: Fri, 17 Mar 2023 16:02:21 +0100 Subject: [PATCH] feat: support new options structure !!BREAKING CHANGES (#12) * feat: support new options structure Introduce a new structure for the manager's options Fixes #10 * docs: update example's options & remove some errorMessages * fix: options not being stored in the manager * refactor: use string enum * fix: import ErrorMessage should be default * fix: typo * chore: properly increase package version Due to breaking changes in this new version, a major release is necessary * use coma instead of semicolon * chore: add build workflow * fix: properly export ErrorMessages enum --- .github/workflows/build.yml | 27 +++ BREAKING_CHANGES.md | 104 +------- README.md | 20 +- docs/api-docs/assets/search.js | 2 +- .../InteractionBasedMailboxManager.html | 70 +++--- docs/api-docs/classes/MailboxManager.html | 51 ++-- docs/api-docs/classes/Ticket.html | 93 +++---- docs/api-docs/enums/MailboxManagerEvents.html | 16 +- .../functions/createTicketContent.html | 13 +- .../createTicketContentFromInteraction.html | 13 +- docs/api-docs/index.html | 10 +- docs/api-docs/interfaces/IMailboxManager.html | 23 +- docs/api-docs/modules.html | 16 +- ...xManagerOptions.html => EmbedOptions.html} | 18 +- ...Options.html => GlobalMailboxOptions.html} | 22 +- docs/api-docs/types/InteractionOptions.html | 93 +++++++ docs/api-docs/types/LoggingOptions.html | 20 +- ...anagerOptions.html => ManagerOptions.html} | 33 ++- docs/api-docs/types/ModalOptions.html | 14 +- .../types/PerGuildMailboxOptions.html | 61 +++++ docs/api-docs/types/ThreadOptions.html | 16 +- docs/api-docs/types/TicketContent.html | 10 +- docs/api-docs/types/UserId.html | 10 +- docs/api-docs/types/UserTickets.html | 10 +- examples/index.js | 142 +++++------ package.json | 2 +- src/ErrorMessages.ts | 33 +-- src/InteractionBasedMailboxManager.ts | 229 +++++++++--------- src/MailboxManager.ts | 51 ++-- src/index.ts | 2 +- src/types/EmbedOptions.ts | 3 + src/types/GlobalMailboxOptions.ts | 24 ++ src/types/IMailboxManager.ts | 6 +- .../InteractionBasedMailboxManagerOptions.ts | 59 ----- src/types/InteractionOptions.ts | 31 +++ src/types/LoggingOptions.ts | 73 +++--- src/types/MailboxManagerOptions.ts | 35 --- src/types/ManagerOptions.ts | 26 ++ .../MessageBasedMailboxManagerOptions.ts | 69 ------ src/types/ModalOptions.ts | 24 +- src/types/PerGuildMailboxOptions.ts | 74 ++++++ src/types/ThreadOptions.ts | 20 +- src/types/Ticket.ts | 49 ++-- src/types/TicketContent.ts | 4 +- src/types/index.ts | 8 +- 45 files changed, 872 insertions(+), 857 deletions(-) create mode 100644 .github/workflows/build.yml rename docs/api-docs/types/{MessageBasedMailboxManagerOptions.html => EmbedOptions.html} (69%) rename docs/api-docs/types/{MailboxManagerOptions.html => GlobalMailboxOptions.html} (73%) create mode 100644 docs/api-docs/types/InteractionOptions.html rename docs/api-docs/types/{InteractionBasedMailboxManagerOptions.html => ManagerOptions.html} (65%) create mode 100644 docs/api-docs/types/PerGuildMailboxOptions.html create mode 100644 src/types/EmbedOptions.ts create mode 100644 src/types/GlobalMailboxOptions.ts delete mode 100644 src/types/InteractionBasedMailboxManagerOptions.ts create mode 100644 src/types/InteractionOptions.ts delete mode 100644 src/types/MailboxManagerOptions.ts create mode 100644 src/types/ManagerOptions.ts delete mode 100644 src/types/MessageBasedMailboxManagerOptions.ts create mode 100644 src/types/PerGuildMailboxOptions.ts diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..e6bda90 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,27 @@ +name: Build + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +jobs: + build: + concurrency: ci-${{ github.ref }} + + runs-on: ubuntu-latest + + strategy: + matrix: + node-version: [18.x] + + steps: + - uses: actions/checkout@v3 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} + cache: 'yarn' + - run: yarn install --frozen-lockfile + - run: yarn build diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md index ecca4a0..ae1588a 100644 --- a/BREAKING_CHANGES.md +++ b/BREAKING_CHANGES.md @@ -1,105 +1,11 @@ # Breaking Changes -## Support for Discord.js v14 +## Rework of the entire options parameter -The entire library has been ported to djs v14. +The option parameter is now fully supporting different guilds. The changes made are structural but some renaming also occured. -## MailboxManager class +It is strongly advised to revise the entire options you are passing to the manager and restructure it with the new type accessible [here](./src/types/ManagerOptions.ts). -The mailbox manager becomes a real tickets manager. It now only handles user tickets. - -## Format Title parameter - -The `options#formatTitle` method does not take the id as a parameter anymore, but directly relies on a [Ticket](./src/types/Ticket.ts) instance. - -```ts -// before -function formatTitle(id: string): string { - return `Ticket ${id}`; -} - -// after -function formatTitle(ticket: Ticket, guild: Guild): string { - return `Ticket ${ticket.id} - ${guild.name}`; -} -``` - -## ticketDelete event disappears - -This event was initially created to let the user know a ticket has been internally deleted but this information should not be shared outside the system through a different event than `ticketClose`. -It has thus been removed. - -## loggingOptions#format Changes - -The format function supposed to format each message of a ticket has changed. The whole signature actually got updated: -```ts -// before - -loggingOptions: { - ... - format: (message: Message) => `${message.author.username} sent: ${message.cleanContent}`, - ... -} - -// after -loggingOptions: { - ... - generateLogEntry: (ticketContent: TicketContent) => `${ticketContent.author.username} sent: ${ticketContent.cleanContent}`, - ... -} -``` - -## loggingOptions#showNames Rename - -The `showName` property of the logging options has been renamed to `showSenderNames` for more clarity on its meaning. - -## options#closeTicketAfter Unit Change - -The `closeTicketAfter` was initially in seconds. It is now in milliseconds. - -## options#closeTicketAfter Rename - -The `closeTicketAfter` property of the options has been renamed to `closeTicketAfterInMilliseconds` for more clarity on its unit. - -## options#notAllowedToPing Removal - -The `notAllowedToPing` property of the options has been removed. You should handle this using your client's options (property is called `allowedMentions`). - -## options#autoReplyMessage Removal - -The `autoReplyMessage` property of the options has been removed. You should use `ticketCreate` event to handle such side-effect. - -## options#replyMessageInFooter Removal - -The `replyMessageInFooter` property of the options has been removed. The footer is forced. - -## options#ticketClose Removal - -The `ticketClose` property of the options has been removed. You should use `ticketClose` event to handle such side-effect. - -## embedOptions#send Removal - -The `send` property of the embed options has been removed. Once an EmbedOptions object is found, the embed feature is used instead of standard messages. - -## options#deleteReplies Removal - -The `deleteReplies` property of the options has been removed. It actually is misleading to end users (staff members responding to messages). -If you want to still use it, you can perform the same action through the `replySent` event. - -## replyDelete event disappears - -This event was initially created to let the user know a replt has been deleted but the deletion behaviour has ben removed so thus event has no purpose anymore. -It has thus been removed. - -## options#sendToRecipient Removal - -The `sendToRecipient` property of the options has been removed. Indeed, users have the fundamental right to receive and keep a copy of the conversation with anyone. - -## options#mailboxChannel Removal - -The `mailboxChannel` property has been removed in profit of a `mailboxChannels` property to enable the management of several guilds by a single manager. - -## options#loggingOptions#channel Removal - -The `channel` property of the `loggingOptions` property has been removed in profit of a `channels` property to enable the management of several guilds by a single manager. +## Error messages have now error codes +The error messages now have error codes from 001 to 0006. You can inspect these directly [in the source code](./src/ErrorMessages.ts). \ No newline at end of file diff --git a/README.md b/README.md index bf932a1..2b855f9 100644 --- a/README.md +++ b/README.md @@ -47,29 +47,17 @@ manager.on(MailboxManagerEvents.ticketLog, (ticket: Ticket) => {}); manager.on(MailboxManagerEvents.ticketClose, (ticket: Ticket) => {}); -manager.on( - MailboxManagerEvents.ticketForceClose, - (ticket: Ticket, user: User | PartialUser) => {} -); +manager.on(MailboxManagerEvents.ticketForceClose, (ticket: Ticket, user: User | PartialUser) => {}); manager.on(MailboxManagerEvents.ticketDelete, (ticket: Ticket) => {}); -manager.on( - MailboxManagerEvents.replySent, - (message: Message, answer: Message) => {} -); +manager.on(MailboxManagerEvents.replySent, (message: Message, answer: Message) => {}); manager.on(MailboxManagerEvents.replyDelete, (message: Message) => {}); -manager.on( - MailboxManagerEvents.threadCreate, - (ticket: Ticket, thread: ThreadChannel) => {} -); +manager.on(MailboxManagerEvents.threadCreate, (ticket: Ticket, thread: ThreadChannel) => {}); -manager.on( - MailboxManagerEvents.threadArchive, - (ticket: Ticket, thread: ThreadChannel) => {} -); +manager.on(MailboxManagerEvents.threadArchive, (ticket: Ticket, thread: ThreadChannel) => {}); ``` ## Contribution diff --git a/docs/api-docs/assets/search.js b/docs/api-docs/assets/search.js index 0a179a6..f286fdc 100644 --- a/docs/api-docs/assets/search.js +++ b/docs/api-docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"8\":\"Enumeration\",\"16\":\"Enumeration Member\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":128,\"name\":\"MailboxManager\",\"url\":\"classes/MailboxManager.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/MailboxManager.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"classes/MailboxManager.html#options\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"MailboxManager\"},{\"kind\":1024,\"name\":\"client\",\"url\":\"classes/MailboxManager.html#client\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":1024,\"name\":\"usersTickets\",\"url\":\"classes/MailboxManager.html#usersTickets\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"checkTickets\",\"url\":\"classes/MailboxManager.html#checkTickets\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"createTicket\",\"url\":\"classes/MailboxManager.html#createTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"replyToTicket\",\"url\":\"classes/MailboxManager.html#replyToTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"closeTicket\",\"url\":\"classes/MailboxManager.html#closeTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"getTicketById\",\"url\":\"classes/MailboxManager.html#getTicketById\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"getTicketByLastMessage\",\"url\":\"classes/MailboxManager.html#getTicketByLastMessage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":128,\"name\":\"InteractionBasedMailboxManager\",\"url\":\"classes/InteractionBasedMailboxManager.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/InteractionBasedMailboxManager.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"classes/InteractionBasedMailboxManager.html#options\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"checkTickets\",\"url\":\"classes/InteractionBasedMailboxManager.html#checkTickets\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"sendSelectGuildMenu\",\"url\":\"classes/InteractionBasedMailboxManager.html#sendSelectGuildMenu\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":1024,\"name\":\"client\",\"url\":\"classes/InteractionBasedMailboxManager.html#client\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":1024,\"name\":\"usersTickets\",\"url\":\"classes/InteractionBasedMailboxManager.html#usersTickets\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"createTicket\",\"url\":\"classes/InteractionBasedMailboxManager.html#createTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"replyToTicket\",\"url\":\"classes/InteractionBasedMailboxManager.html#replyToTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"closeTicket\",\"url\":\"classes/InteractionBasedMailboxManager.html#closeTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"getTicketById\",\"url\":\"classes/InteractionBasedMailboxManager.html#getTicketById\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"getTicketByLastMessage\",\"url\":\"classes/InteractionBasedMailboxManager.html#getTicketByLastMessage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":8,\"name\":\"MailboxManagerEvents\",\"url\":\"enums/MailboxManagerEvents.html\",\"classes\":\"tsd-kind-enum\"},{\"kind\":16,\"name\":\"ticketCreate\",\"url\":\"enums/MailboxManagerEvents.html#ticketCreate\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"ticketUpdate\",\"url\":\"enums/MailboxManagerEvents.html#ticketUpdate\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"ticketClose\",\"url\":\"enums/MailboxManagerEvents.html#ticketClose\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"ticketLog\",\"url\":\"enums/MailboxManagerEvents.html#ticketLog\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"threadCreate\",\"url\":\"enums/MailboxManagerEvents.html#threadCreate\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"replySent\",\"url\":\"enums/MailboxManagerEvents.html#replySent\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"ticketForceClose\",\"url\":\"enums/MailboxManagerEvents.html#ticketForceClose\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":4194304,\"name\":\"UserId\",\"url\":\"types/UserId.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"UserTickets\",\"url\":\"types/UserTickets.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":256,\"name\":\"IMailboxManager\",\"url\":\"interfaces/IMailboxManager.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"usersTickets\",\"url\":\"interfaces/IMailboxManager.html#usersTickets\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IMailboxManager\"},{\"kind\":2048,\"name\":\"createTicket\",\"url\":\"interfaces/IMailboxManager.html#createTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"IMailboxManager\"},{\"kind\":2048,\"name\":\"replyToTicket\",\"url\":\"interfaces/IMailboxManager.html#replyToTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"IMailboxManager\"},{\"kind\":2048,\"name\":\"closeTicket\",\"url\":\"interfaces/IMailboxManager.html#closeTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"IMailboxManager\"},{\"kind\":2048,\"name\":\"checkTickets\",\"url\":\"interfaces/IMailboxManager.html#checkTickets\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"IMailboxManager\"},{\"kind\":4194304,\"name\":\"InteractionBasedMailboxManagerOptions\",\"url\":\"types/InteractionBasedMailboxManagerOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"LoggingOptions\",\"url\":\"types/LoggingOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/LoggingOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"LoggingOptions\"},{\"kind\":1024,\"name\":\"generateFilename\",\"url\":\"types/LoggingOptions.html#__type.generateFilename\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/LoggingOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":1024,\"name\":\"generateMessage\",\"url\":\"types/LoggingOptions.html#__type.generateMessage\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/LoggingOptions.html#__type.__type-5\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":1024,\"name\":\"generateLogEntry\",\"url\":\"types/LoggingOptions.html#__type.generateLogEntry\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/LoggingOptions.html#__type.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":1024,\"name\":\"showSenderNames\",\"url\":\"types/LoggingOptions.html#__type.showSenderNames\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":1024,\"name\":\"channels\",\"url\":\"types/LoggingOptions.html#__type.channels\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":1024,\"name\":\"sendInThread\",\"url\":\"types/LoggingOptions.html#__type.sendInThread\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":4194304,\"name\":\"MailboxManagerOptions\",\"url\":\"types/MailboxManagerOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/MailboxManagerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"MailboxManagerOptions\"},{\"kind\":1024,\"name\":\"mailboxChannels\",\"url\":\"types/MailboxManagerOptions.html#__type.mailboxChannels\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"MailboxManagerOptions.__type\"},{\"kind\":1024,\"name\":\"closeTicketAfterInMilliseconds\",\"url\":\"types/MailboxManagerOptions.html#__type.closeTicketAfterInMilliseconds\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"MailboxManagerOptions.__type\"},{\"kind\":1024,\"name\":\"maxOnGoingTicketsPerUser\",\"url\":\"types/MailboxManagerOptions.html#__type.maxOnGoingTicketsPerUser\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"MailboxManagerOptions.__type\"},{\"kind\":1024,\"name\":\"cronTime\",\"url\":\"types/MailboxManagerOptions.html#__type.cronTime\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"MailboxManagerOptions.__type\"},{\"kind\":4194304,\"name\":\"MessageBasedMailboxManagerOptions\",\"url\":\"types/MessageBasedMailboxManagerOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"ModalOptions\",\"url\":\"types/ModalOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ModalOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"ModalOptions\"},{\"kind\":1024,\"name\":\"formatTitle\",\"url\":\"types/ModalOptions.html#__type.formatTitle\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ModalOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ModalOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"ModalOptions.__type\"},{\"kind\":1024,\"name\":\"modalComponentsOptions\",\"url\":\"types/ModalOptions.html#__type.modalComponentsOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ModalOptions.__type\"},{\"kind\":4194304,\"name\":\"ThreadOptions\",\"url\":\"types/ThreadOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ThreadOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"ThreadOptions\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/ThreadOptions.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ThreadOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ThreadOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"ThreadOptions.__type\"},{\"kind\":1024,\"name\":\"startMessage\",\"url\":\"types/ThreadOptions.html#__type.startMessage\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ThreadOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ThreadOptions.html#__type.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"ThreadOptions.__type\"},{\"kind\":128,\"name\":\"Ticket\",\"url\":\"classes/Ticket.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Ticket.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"classes/Ticket.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":1024,\"name\":\"createdBy\",\"url\":\"classes/Ticket.html#createdBy\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":1024,\"name\":\"createdAt\",\"url\":\"classes/Ticket.html#createdAt\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":1024,\"name\":\"messages\",\"url\":\"classes/Ticket.html#messages\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":262144,\"name\":\"closedAt\",\"url\":\"classes/Ticket.html#closedAt\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":262144,\"name\":\"lastMessage\",\"url\":\"classes/Ticket.html#lastMessage\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":262144,\"name\":\"threadId\",\"url\":\"classes/Ticket.html#threadId\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":262144,\"name\":\"guildId\",\"url\":\"classes/Ticket.html#guildId\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":2048,\"name\":\"setChannel\",\"url\":\"classes/Ticket.html#setChannel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":2048,\"name\":\"setGuild\",\"url\":\"classes/Ticket.html#setGuild\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":2048,\"name\":\"addMessage\",\"url\":\"classes/Ticket.html#addMessage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":2048,\"name\":\"isOutdated\",\"url\":\"classes/Ticket.html#isOutdated\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/Ticket.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":64,\"name\":\"createTicketContent\",\"url\":\"functions/createTicketContent.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"createTicketContentFromInteraction\",\"url\":\"functions/createTicketContentFromInteraction.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":4194304,\"name\":\"TicketContent\",\"url\":\"types/TicketContent.html\",\"classes\":\"tsd-kind-type-alias\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,40.719]],[\"comment/0\",[]],[\"name/1\",[1,32.246]],[\"comment/1\",[]],[\"name/2\",[2,35.61]],[\"comment/2\",[]],[\"name/3\",[3,35.61]],[\"comment/3\",[]],[\"name/4\",[4,32.246]],[\"comment/4\",[]],[\"name/5\",[5,32.246]],[\"comment/5\",[]],[\"name/6\",[6,32.246]],[\"comment/6\",[]],[\"name/7\",[7,32.246]],[\"comment/7\",[]],[\"name/8\",[8,32.246]],[\"comment/8\",[]],[\"name/9\",[9,35.61]],[\"comment/9\",[]],[\"name/10\",[10,35.61]],[\"comment/10\",[]],[\"name/11\",[11,40.719]],[\"comment/11\",[]],[\"name/12\",[1,32.246]],[\"comment/12\",[]],[\"name/13\",[2,35.61]],[\"comment/13\",[]],[\"name/14\",[5,32.246]],[\"comment/14\",[]],[\"name/15\",[12,40.719]],[\"comment/15\",[]],[\"name/16\",[3,35.61]],[\"comment/16\",[]],[\"name/17\",[4,32.246]],[\"comment/17\",[]],[\"name/18\",[6,32.246]],[\"comment/18\",[]],[\"name/19\",[7,32.246]],[\"comment/19\",[]],[\"name/20\",[8,32.246]],[\"comment/20\",[]],[\"name/21\",[9,35.61]],[\"comment/21\",[]],[\"name/22\",[10,35.61]],[\"comment/22\",[]],[\"name/23\",[13,40.719]],[\"comment/23\",[]],[\"name/24\",[14,40.719]],[\"comment/24\",[]],[\"name/25\",[15,40.719]],[\"comment/25\",[]],[\"name/26\",[16,40.719]],[\"comment/26\",[]],[\"name/27\",[17,40.719]],[\"comment/27\",[]],[\"name/28\",[18,40.719]],[\"comment/28\",[]],[\"name/29\",[19,40.719]],[\"comment/29\",[]],[\"name/30\",[20,40.719]],[\"comment/30\",[]],[\"name/31\",[21,40.719]],[\"comment/31\",[]],[\"name/32\",[22,40.719]],[\"comment/32\",[]],[\"name/33\",[23,40.719]],[\"comment/33\",[]],[\"name/34\",[4,32.246]],[\"comment/34\",[]],[\"name/35\",[6,32.246]],[\"comment/35\",[]],[\"name/36\",[7,32.246]],[\"comment/36\",[]],[\"name/37\",[8,32.246]],[\"comment/37\",[]],[\"name/38\",[5,32.246]],[\"comment/38\",[]],[\"name/39\",[24,40.719]],[\"comment/39\",[]],[\"name/40\",[25,40.719]],[\"comment/40\",[]],[\"name/41\",[26,21.26]],[\"comment/41\",[]],[\"name/42\",[27,40.719]],[\"comment/42\",[]],[\"name/43\",[26,21.26]],[\"comment/43\",[]],[\"name/44\",[28,40.719]],[\"comment/44\",[]],[\"name/45\",[26,21.26]],[\"comment/45\",[]],[\"name/46\",[29,40.719]],[\"comment/46\",[]],[\"name/47\",[26,21.26]],[\"comment/47\",[]],[\"name/48\",[30,40.719]],[\"comment/48\",[]],[\"name/49\",[31,40.719]],[\"comment/49\",[]],[\"name/50\",[32,40.719]],[\"comment/50\",[]],[\"name/51\",[33,40.719]],[\"comment/51\",[]],[\"name/52\",[26,21.26]],[\"comment/52\",[]],[\"name/53\",[34,40.719]],[\"comment/53\",[]],[\"name/54\",[35,40.719]],[\"comment/54\",[]],[\"name/55\",[36,40.719]],[\"comment/55\",[]],[\"name/56\",[37,40.719]],[\"comment/56\",[]],[\"name/57\",[38,40.719]],[\"comment/57\",[]],[\"name/58\",[39,40.719]],[\"comment/58\",[]],[\"name/59\",[26,21.26]],[\"comment/59\",[]],[\"name/60\",[40,40.719]],[\"comment/60\",[]],[\"name/61\",[26,21.26]],[\"comment/61\",[]],[\"name/62\",[41,40.719]],[\"comment/62\",[]],[\"name/63\",[42,40.719]],[\"comment/63\",[]],[\"name/64\",[26,21.26]],[\"comment/64\",[]],[\"name/65\",[43,40.719]],[\"comment/65\",[]],[\"name/66\",[26,21.26]],[\"comment/66\",[]],[\"name/67\",[44,40.719]],[\"comment/67\",[]],[\"name/68\",[26,21.26]],[\"comment/68\",[]],[\"name/69\",[45,40.719]],[\"comment/69\",[]],[\"name/70\",[1,32.246]],[\"comment/70\",[]],[\"name/71\",[46,40.719]],[\"comment/71\",[]],[\"name/72\",[47,40.719]],[\"comment/72\",[]],[\"name/73\",[48,40.719]],[\"comment/73\",[]],[\"name/74\",[49,40.719]],[\"comment/74\",[]],[\"name/75\",[50,40.719]],[\"comment/75\",[]],[\"name/76\",[51,40.719]],[\"comment/76\",[]],[\"name/77\",[52,40.719]],[\"comment/77\",[]],[\"name/78\",[53,40.719]],[\"comment/78\",[]],[\"name/79\",[54,40.719]],[\"comment/79\",[]],[\"name/80\",[55,40.719]],[\"comment/80\",[]],[\"name/81\",[56,40.719]],[\"comment/81\",[]],[\"name/82\",[57,40.719]],[\"comment/82\",[]],[\"name/83\",[58,40.719]],[\"comment/83\",[]],[\"name/84\",[59,40.719]],[\"comment/84\",[]],[\"name/85\",[60,40.719]],[\"comment/85\",[]],[\"name/86\",[61,40.719]],[\"comment/86\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":26,\"name\":{\"41\":{},\"43\":{},\"45\":{},\"47\":{},\"52\":{},\"59\":{},\"61\":{},\"64\":{},\"66\":{},\"68\":{}},\"comment\":{}}],[\"addmessage\",{\"_index\":56,\"name\":{\"81\":{}},\"comment\":{}}],[\"channels\",{\"_index\":31,\"name\":{\"49\":{}},\"comment\":{}}],[\"checktickets\",{\"_index\":5,\"name\":{\"5\":{},\"14\":{},\"38\":{}},\"comment\":{}}],[\"client\",{\"_index\":3,\"name\":{\"3\":{},\"16\":{}},\"comment\":{}}],[\"close\",{\"_index\":58,\"name\":{\"83\":{}},\"comment\":{}}],[\"closedat\",{\"_index\":50,\"name\":{\"75\":{}},\"comment\":{}}],[\"closeticket\",{\"_index\":8,\"name\":{\"8\":{},\"20\":{},\"37\":{}},\"comment\":{}}],[\"closeticketafterinmilliseconds\",{\"_index\":35,\"name\":{\"54\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"12\":{},\"70\":{}},\"comment\":{}}],[\"createdat\",{\"_index\":48,\"name\":{\"73\":{}},\"comment\":{}}],[\"createdby\",{\"_index\":47,\"name\":{\"72\":{}},\"comment\":{}}],[\"createticket\",{\"_index\":6,\"name\":{\"6\":{},\"18\":{},\"35\":{}},\"comment\":{}}],[\"createticketcontent\",{\"_index\":59,\"name\":{\"84\":{}},\"comment\":{}}],[\"createticketcontentfrominteraction\",{\"_index\":60,\"name\":{\"85\":{}},\"comment\":{}}],[\"crontime\",{\"_index\":37,\"name\":{\"56\":{}},\"comment\":{}}],[\"formattitle\",{\"_index\":40,\"name\":{\"60\":{}},\"comment\":{}}],[\"generatefilename\",{\"_index\":27,\"name\":{\"42\":{}},\"comment\":{}}],[\"generatelogentry\",{\"_index\":29,\"name\":{\"46\":{}},\"comment\":{}}],[\"generatemessage\",{\"_index\":28,\"name\":{\"44\":{}},\"comment\":{}}],[\"getticketbyid\",{\"_index\":9,\"name\":{\"9\":{},\"21\":{}},\"comment\":{}}],[\"getticketbylastmessage\",{\"_index\":10,\"name\":{\"10\":{},\"22\":{}},\"comment\":{}}],[\"guildid\",{\"_index\":53,\"name\":{\"78\":{}},\"comment\":{}}],[\"id\",{\"_index\":46,\"name\":{\"71\":{}},\"comment\":{}}],[\"imailboxmanager\",{\"_index\":23,\"name\":{\"33\":{}},\"comment\":{}}],[\"interactionbasedmailboxmanager\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"interactionbasedmailboxmanageroptions\",{\"_index\":24,\"name\":{\"39\":{}},\"comment\":{}}],[\"isoutdated\",{\"_index\":57,\"name\":{\"82\":{}},\"comment\":{}}],[\"lastmessage\",{\"_index\":51,\"name\":{\"76\":{}},\"comment\":{}}],[\"loggingoptions\",{\"_index\":25,\"name\":{\"40\":{}},\"comment\":{}}],[\"mailboxchannels\",{\"_index\":34,\"name\":{\"53\":{}},\"comment\":{}}],[\"mailboxmanager\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"mailboxmanagerevents\",{\"_index\":13,\"name\":{\"23\":{}},\"comment\":{}}],[\"mailboxmanageroptions\",{\"_index\":33,\"name\":{\"51\":{}},\"comment\":{}}],[\"maxongoingticketsperuser\",{\"_index\":36,\"name\":{\"55\":{}},\"comment\":{}}],[\"messagebasedmailboxmanageroptions\",{\"_index\":38,\"name\":{\"57\":{}},\"comment\":{}}],[\"messages\",{\"_index\":49,\"name\":{\"74\":{}},\"comment\":{}}],[\"modalcomponentsoptions\",{\"_index\":41,\"name\":{\"62\":{}},\"comment\":{}}],[\"modaloptions\",{\"_index\":39,\"name\":{\"58\":{}},\"comment\":{}}],[\"name\",{\"_index\":43,\"name\":{\"65\":{}},\"comment\":{}}],[\"options\",{\"_index\":2,\"name\":{\"2\":{},\"13\":{}},\"comment\":{}}],[\"replysent\",{\"_index\":19,\"name\":{\"29\":{}},\"comment\":{}}],[\"replytoticket\",{\"_index\":7,\"name\":{\"7\":{},\"19\":{},\"36\":{}},\"comment\":{}}],[\"sendinthread\",{\"_index\":32,\"name\":{\"50\":{}},\"comment\":{}}],[\"sendselectguildmenu\",{\"_index\":12,\"name\":{\"15\":{}},\"comment\":{}}],[\"setchannel\",{\"_index\":54,\"name\":{\"79\":{}},\"comment\":{}}],[\"setguild\",{\"_index\":55,\"name\":{\"80\":{}},\"comment\":{}}],[\"showsendernames\",{\"_index\":30,\"name\":{\"48\":{}},\"comment\":{}}],[\"startmessage\",{\"_index\":44,\"name\":{\"67\":{}},\"comment\":{}}],[\"threadcreate\",{\"_index\":18,\"name\":{\"28\":{}},\"comment\":{}}],[\"threadid\",{\"_index\":52,\"name\":{\"77\":{}},\"comment\":{}}],[\"threadoptions\",{\"_index\":42,\"name\":{\"63\":{}},\"comment\":{}}],[\"ticket\",{\"_index\":45,\"name\":{\"69\":{}},\"comment\":{}}],[\"ticketclose\",{\"_index\":16,\"name\":{\"26\":{}},\"comment\":{}}],[\"ticketcontent\",{\"_index\":61,\"name\":{\"86\":{}},\"comment\":{}}],[\"ticketcreate\",{\"_index\":14,\"name\":{\"24\":{}},\"comment\":{}}],[\"ticketforceclose\",{\"_index\":20,\"name\":{\"30\":{}},\"comment\":{}}],[\"ticketlog\",{\"_index\":17,\"name\":{\"27\":{}},\"comment\":{}}],[\"ticketupdate\",{\"_index\":15,\"name\":{\"25\":{}},\"comment\":{}}],[\"userid\",{\"_index\":21,\"name\":{\"31\":{}},\"comment\":{}}],[\"userstickets\",{\"_index\":4,\"name\":{\"4\":{},\"17\":{},\"34\":{}},\"comment\":{}}],[\"usertickets\",{\"_index\":22,\"name\":{\"32\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"8\":\"Enumeration\",\"16\":\"Enumeration Member\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":128,\"name\":\"MailboxManager\",\"url\":\"classes/MailboxManager.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/MailboxManager.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":1024,\"name\":\"client\",\"url\":\"classes/MailboxManager.html#client\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":1024,\"name\":\"usersTickets\",\"url\":\"classes/MailboxManager.html#usersTickets\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"checkTickets\",\"url\":\"classes/MailboxManager.html#checkTickets\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"createTicket\",\"url\":\"classes/MailboxManager.html#createTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"replyToTicket\",\"url\":\"classes/MailboxManager.html#replyToTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"closeTicket\",\"url\":\"classes/MailboxManager.html#closeTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"getTicketById\",\"url\":\"classes/MailboxManager.html#getTicketById\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":2048,\"name\":\"getTicketByLastMessage\",\"url\":\"classes/MailboxManager.html#getTicketByLastMessage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MailboxManager\"},{\"kind\":128,\"name\":\"InteractionBasedMailboxManager\",\"url\":\"classes/InteractionBasedMailboxManager.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/InteractionBasedMailboxManager.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":1024,\"name\":\"#options\",\"url\":\"classes/InteractionBasedMailboxManager.html#_options\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"checkTickets\",\"url\":\"classes/InteractionBasedMailboxManager.html#checkTickets\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"sendSelectGuildMenu\",\"url\":\"classes/InteractionBasedMailboxManager.html#sendSelectGuildMenu\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":1024,\"name\":\"client\",\"url\":\"classes/InteractionBasedMailboxManager.html#client\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":1024,\"name\":\"usersTickets\",\"url\":\"classes/InteractionBasedMailboxManager.html#usersTickets\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"createTicket\",\"url\":\"classes/InteractionBasedMailboxManager.html#createTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"replyToTicket\",\"url\":\"classes/InteractionBasedMailboxManager.html#replyToTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"closeTicket\",\"url\":\"classes/InteractionBasedMailboxManager.html#closeTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"getTicketById\",\"url\":\"classes/InteractionBasedMailboxManager.html#getTicketById\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":2048,\"name\":\"getTicketByLastMessage\",\"url\":\"classes/InteractionBasedMailboxManager.html#getTicketByLastMessage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"InteractionBasedMailboxManager\"},{\"kind\":8,\"name\":\"MailboxManagerEvents\",\"url\":\"enums/MailboxManagerEvents.html\",\"classes\":\"tsd-kind-enum\"},{\"kind\":16,\"name\":\"ticketCreate\",\"url\":\"enums/MailboxManagerEvents.html#ticketCreate\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"ticketUpdate\",\"url\":\"enums/MailboxManagerEvents.html#ticketUpdate\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"ticketClose\",\"url\":\"enums/MailboxManagerEvents.html#ticketClose\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"ticketLog\",\"url\":\"enums/MailboxManagerEvents.html#ticketLog\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"threadCreate\",\"url\":\"enums/MailboxManagerEvents.html#threadCreate\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"replySent\",\"url\":\"enums/MailboxManagerEvents.html#replySent\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":16,\"name\":\"ticketForceClose\",\"url\":\"enums/MailboxManagerEvents.html#ticketForceClose\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MailboxManagerEvents\"},{\"kind\":4194304,\"name\":\"EmbedOptions\",\"url\":\"types/EmbedOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"GlobalMailboxOptions\",\"url\":\"types/GlobalMailboxOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/GlobalMailboxOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"GlobalMailboxOptions\"},{\"kind\":1024,\"name\":\"closeTicketAfterInMilliseconds\",\"url\":\"types/GlobalMailboxOptions.html#__type.closeTicketAfterInMilliseconds\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"GlobalMailboxOptions.__type\"},{\"kind\":1024,\"name\":\"maxOnGoingTicketsPerUser\",\"url\":\"types/GlobalMailboxOptions.html#__type.maxOnGoingTicketsPerUser\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"GlobalMailboxOptions.__type\"},{\"kind\":1024,\"name\":\"cronTime\",\"url\":\"types/GlobalMailboxOptions.html#__type.cronTime\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"GlobalMailboxOptions.__type\"},{\"kind\":4194304,\"name\":\"UserId\",\"url\":\"types/UserId.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"UserTickets\",\"url\":\"types/UserTickets.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":256,\"name\":\"IMailboxManager\",\"url\":\"interfaces/IMailboxManager.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"usersTickets\",\"url\":\"interfaces/IMailboxManager.html#usersTickets\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"IMailboxManager\"},{\"kind\":2048,\"name\":\"createTicket\",\"url\":\"interfaces/IMailboxManager.html#createTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"IMailboxManager\"},{\"kind\":2048,\"name\":\"replyToTicket\",\"url\":\"interfaces/IMailboxManager.html#replyToTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"IMailboxManager\"},{\"kind\":2048,\"name\":\"closeTicket\",\"url\":\"interfaces/IMailboxManager.html#closeTicket\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"IMailboxManager\"},{\"kind\":2048,\"name\":\"checkTickets\",\"url\":\"interfaces/IMailboxManager.html#checkTickets\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"IMailboxManager\"},{\"kind\":4194304,\"name\":\"InteractionOptions\",\"url\":\"types/InteractionOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/InteractionOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"InteractionOptions\"},{\"kind\":1024,\"name\":\"generateInteractionReplyMessage\",\"url\":\"types/InteractionOptions.html#__type.generateInteractionReplyMessage\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"InteractionOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/InteractionOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"InteractionOptions.__type\"},{\"kind\":1024,\"name\":\"createButtonOptions\",\"url\":\"types/InteractionOptions.html#__type.createButtonOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"InteractionOptions.__type\"},{\"kind\":1024,\"name\":\"replyButtonOptions\",\"url\":\"types/InteractionOptions.html#__type.replyButtonOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"InteractionOptions.__type\"},{\"kind\":1024,\"name\":\"forceCloseButtonOptions\",\"url\":\"types/InteractionOptions.html#__type.forceCloseButtonOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"InteractionOptions.__type\"},{\"kind\":4194304,\"name\":\"LoggingOptions\",\"url\":\"types/LoggingOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/LoggingOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"LoggingOptions\"},{\"kind\":1024,\"name\":\"generateFilename\",\"url\":\"types/LoggingOptions.html#__type.generateFilename\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/LoggingOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":1024,\"name\":\"generateMessage\",\"url\":\"types/LoggingOptions.html#__type.generateMessage\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/LoggingOptions.html#__type.__type-5\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":1024,\"name\":\"generateLogEntry\",\"url\":\"types/LoggingOptions.html#__type.generateLogEntry\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/LoggingOptions.html#__type.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":1024,\"name\":\"showSenderNames\",\"url\":\"types/LoggingOptions.html#__type.showSenderNames\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":1024,\"name\":\"logChannel\",\"url\":\"types/LoggingOptions.html#__type.logChannel\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":1024,\"name\":\"sendInThread\",\"url\":\"types/LoggingOptions.html#__type.sendInThread\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"LoggingOptions.__type\"},{\"kind\":4194304,\"name\":\"ManagerOptions\",\"url\":\"types/ManagerOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ManagerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"ManagerOptions\"},{\"kind\":1024,\"name\":\"selectGuildOptions\",\"url\":\"types/ManagerOptions.html#__type.selectGuildOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ManagerOptions.__type\"},{\"kind\":1024,\"name\":\"mailboxOptions\",\"url\":\"types/ManagerOptions.html#__type.mailboxOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ManagerOptions.__type\"},{\"kind\":1024,\"name\":\"optionsPerGuild\",\"url\":\"types/ManagerOptions.html#__type.optionsPerGuild\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ManagerOptions.__type\"},{\"kind\":4194304,\"name\":\"ModalOptions\",\"url\":\"types/ModalOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ModalOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"ModalOptions\"},{\"kind\":1024,\"name\":\"generateTitle\",\"url\":\"types/ModalOptions.html#__type.generateTitle\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ModalOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ModalOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"ModalOptions.__type\"},{\"kind\":1024,\"name\":\"modalComponentsOptions\",\"url\":\"types/ModalOptions.html#__type.modalComponentsOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ModalOptions.__type\"},{\"kind\":4194304,\"name\":\"PerGuildMailboxOptions\",\"url\":\"types/PerGuildMailboxOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"ThreadOptions\",\"url\":\"types/ThreadOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ThreadOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"ThreadOptions\"},{\"kind\":1024,\"name\":\"generateName\",\"url\":\"types/ThreadOptions.html#__type.generateName\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ThreadOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ThreadOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"ThreadOptions.__type\"},{\"kind\":1024,\"name\":\"generateStartMessage\",\"url\":\"types/ThreadOptions.html#__type.generateStartMessage\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ThreadOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ThreadOptions.html#__type.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"ThreadOptions.__type\"},{\"kind\":128,\"name\":\"Ticket\",\"url\":\"classes/Ticket.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Ticket.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"classes/Ticket.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":1024,\"name\":\"createdBy\",\"url\":\"classes/Ticket.html#createdBy\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":1024,\"name\":\"createdAt\",\"url\":\"classes/Ticket.html#createdAt\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":1024,\"name\":\"messages\",\"url\":\"classes/Ticket.html#messages\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":1024,\"name\":\"guildId\",\"url\":\"classes/Ticket.html#guildId\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":262144,\"name\":\"closedAt\",\"url\":\"classes/Ticket.html#closedAt\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":262144,\"name\":\"lastMessage\",\"url\":\"classes/Ticket.html#lastMessage\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":262144,\"name\":\"threadId\",\"url\":\"classes/Ticket.html#threadId\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":2048,\"name\":\"setThreadChannel\",\"url\":\"classes/Ticket.html#setThreadChannel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":2048,\"name\":\"addMessage\",\"url\":\"classes/Ticket.html#addMessage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":2048,\"name\":\"isOutdated\",\"url\":\"classes/Ticket.html#isOutdated\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/Ticket.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Ticket\"},{\"kind\":64,\"name\":\"createTicketContent\",\"url\":\"functions/createTicketContent.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"createTicketContentFromInteraction\",\"url\":\"functions/createTicketContentFromInteraction.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":4194304,\"name\":\"TicketContent\",\"url\":\"types/TicketContent.html\",\"classes\":\"tsd-kind-type-alias\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,41.692]],[\"comment/0\",[]],[\"name/1\",[1,33.219]],[\"comment/1\",[]],[\"name/2\",[2,36.584]],[\"comment/2\",[]],[\"name/3\",[3,33.219]],[\"comment/3\",[]],[\"name/4\",[4,33.219]],[\"comment/4\",[]],[\"name/5\",[5,33.219]],[\"comment/5\",[]],[\"name/6\",[6,33.219]],[\"comment/6\",[]],[\"name/7\",[7,33.219]],[\"comment/7\",[]],[\"name/8\",[8,36.584]],[\"comment/8\",[]],[\"name/9\",[9,36.584]],[\"comment/9\",[]],[\"name/10\",[10,41.692]],[\"comment/10\",[]],[\"name/11\",[1,33.219]],[\"comment/11\",[]],[\"name/12\",[11,41.692]],[\"comment/12\",[]],[\"name/13\",[4,33.219]],[\"comment/13\",[]],[\"name/14\",[12,41.692]],[\"comment/14\",[]],[\"name/15\",[2,36.584]],[\"comment/15\",[]],[\"name/16\",[3,33.219]],[\"comment/16\",[]],[\"name/17\",[5,33.219]],[\"comment/17\",[]],[\"name/18\",[6,33.219]],[\"comment/18\",[]],[\"name/19\",[7,33.219]],[\"comment/19\",[]],[\"name/20\",[8,36.584]],[\"comment/20\",[]],[\"name/21\",[9,36.584]],[\"comment/21\",[]],[\"name/22\",[13,41.692]],[\"comment/22\",[]],[\"name/23\",[14,41.692]],[\"comment/23\",[]],[\"name/24\",[15,41.692]],[\"comment/24\",[]],[\"name/25\",[16,41.692]],[\"comment/25\",[]],[\"name/26\",[17,41.692]],[\"comment/26\",[]],[\"name/27\",[18,41.692]],[\"comment/27\",[]],[\"name/28\",[19,41.692]],[\"comment/28\",[]],[\"name/29\",[20,41.692]],[\"comment/29\",[]],[\"name/30\",[21,41.692]],[\"comment/30\",[]],[\"name/31\",[22,41.692]],[\"comment/31\",[]],[\"name/32\",[23,19.72]],[\"comment/32\",[]],[\"name/33\",[24,41.692]],[\"comment/33\",[]],[\"name/34\",[25,41.692]],[\"comment/34\",[]],[\"name/35\",[26,41.692]],[\"comment/35\",[]],[\"name/36\",[27,41.692]],[\"comment/36\",[]],[\"name/37\",[28,41.692]],[\"comment/37\",[]],[\"name/38\",[29,41.692]],[\"comment/38\",[]],[\"name/39\",[3,33.219]],[\"comment/39\",[]],[\"name/40\",[5,33.219]],[\"comment/40\",[]],[\"name/41\",[6,33.219]],[\"comment/41\",[]],[\"name/42\",[7,33.219]],[\"comment/42\",[]],[\"name/43\",[4,33.219]],[\"comment/43\",[]],[\"name/44\",[30,41.692]],[\"comment/44\",[]],[\"name/45\",[23,19.72]],[\"comment/45\",[]],[\"name/46\",[31,41.692]],[\"comment/46\",[]],[\"name/47\",[23,19.72]],[\"comment/47\",[]],[\"name/48\",[32,41.692]],[\"comment/48\",[]],[\"name/49\",[33,41.692]],[\"comment/49\",[]],[\"name/50\",[34,41.692]],[\"comment/50\",[]],[\"name/51\",[35,41.692]],[\"comment/51\",[]],[\"name/52\",[23,19.72]],[\"comment/52\",[]],[\"name/53\",[36,41.692]],[\"comment/53\",[]],[\"name/54\",[23,19.72]],[\"comment/54\",[]],[\"name/55\",[37,41.692]],[\"comment/55\",[]],[\"name/56\",[23,19.72]],[\"comment/56\",[]],[\"name/57\",[38,41.692]],[\"comment/57\",[]],[\"name/58\",[23,19.72]],[\"comment/58\",[]],[\"name/59\",[39,41.692]],[\"comment/59\",[]],[\"name/60\",[40,41.692]],[\"comment/60\",[]],[\"name/61\",[41,41.692]],[\"comment/61\",[]],[\"name/62\",[42,41.692]],[\"comment/62\",[]],[\"name/63\",[23,19.72]],[\"comment/63\",[]],[\"name/64\",[43,41.692]],[\"comment/64\",[]],[\"name/65\",[44,41.692]],[\"comment/65\",[]],[\"name/66\",[45,41.692]],[\"comment/66\",[]],[\"name/67\",[46,41.692]],[\"comment/67\",[]],[\"name/68\",[23,19.72]],[\"comment/68\",[]],[\"name/69\",[47,41.692]],[\"comment/69\",[]],[\"name/70\",[23,19.72]],[\"comment/70\",[]],[\"name/71\",[48,41.692]],[\"comment/71\",[]],[\"name/72\",[49,41.692]],[\"comment/72\",[]],[\"name/73\",[50,41.692]],[\"comment/73\",[]],[\"name/74\",[23,19.72]],[\"comment/74\",[]],[\"name/75\",[51,41.692]],[\"comment/75\",[]],[\"name/76\",[23,19.72]],[\"comment/76\",[]],[\"name/77\",[52,41.692]],[\"comment/77\",[]],[\"name/78\",[23,19.72]],[\"comment/78\",[]],[\"name/79\",[53,41.692]],[\"comment/79\",[]],[\"name/80\",[1,33.219]],[\"comment/80\",[]],[\"name/81\",[54,41.692]],[\"comment/81\",[]],[\"name/82\",[55,41.692]],[\"comment/82\",[]],[\"name/83\",[56,41.692]],[\"comment/83\",[]],[\"name/84\",[57,41.692]],[\"comment/84\",[]],[\"name/85\",[58,41.692]],[\"comment/85\",[]],[\"name/86\",[59,41.692]],[\"comment/86\",[]],[\"name/87\",[60,41.692]],[\"comment/87\",[]],[\"name/88\",[61,41.692]],[\"comment/88\",[]],[\"name/89\",[62,41.692]],[\"comment/89\",[]],[\"name/90\",[63,41.692]],[\"comment/90\",[]],[\"name/91\",[64,41.692]],[\"comment/91\",[]],[\"name/92\",[65,41.692]],[\"comment/92\",[]],[\"name/93\",[66,41.692]],[\"comment/93\",[]],[\"name/94\",[67,41.692]],[\"comment/94\",[]],[\"name/95\",[68,41.692]],[\"comment/95\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":23,\"name\":{\"32\":{},\"45\":{},\"47\":{},\"52\":{},\"54\":{},\"56\":{},\"58\":{},\"63\":{},\"68\":{},\"70\":{},\"74\":{},\"76\":{},\"78\":{}},\"comment\":{}}],[\"addmessage\",{\"_index\":63,\"name\":{\"90\":{}},\"comment\":{}}],[\"checktickets\",{\"_index\":4,\"name\":{\"4\":{},\"13\":{},\"43\":{}},\"comment\":{}}],[\"client\",{\"_index\":2,\"name\":{\"2\":{},\"15\":{}},\"comment\":{}}],[\"close\",{\"_index\":65,\"name\":{\"92\":{}},\"comment\":{}}],[\"closedat\",{\"_index\":59,\"name\":{\"86\":{}},\"comment\":{}}],[\"closeticket\",{\"_index\":7,\"name\":{\"7\":{},\"19\":{},\"42\":{}},\"comment\":{}}],[\"closeticketafterinmilliseconds\",{\"_index\":24,\"name\":{\"33\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"11\":{},\"80\":{}},\"comment\":{}}],[\"createbuttonoptions\",{\"_index\":32,\"name\":{\"48\":{}},\"comment\":{}}],[\"createdat\",{\"_index\":56,\"name\":{\"83\":{}},\"comment\":{}}],[\"createdby\",{\"_index\":55,\"name\":{\"82\":{}},\"comment\":{}}],[\"createticket\",{\"_index\":5,\"name\":{\"5\":{},\"17\":{},\"40\":{}},\"comment\":{}}],[\"createticketcontent\",{\"_index\":66,\"name\":{\"93\":{}},\"comment\":{}}],[\"createticketcontentfrominteraction\",{\"_index\":67,\"name\":{\"94\":{}},\"comment\":{}}],[\"crontime\",{\"_index\":26,\"name\":{\"35\":{}},\"comment\":{}}],[\"embedoptions\",{\"_index\":21,\"name\":{\"30\":{}},\"comment\":{}}],[\"forceclosebuttonoptions\",{\"_index\":34,\"name\":{\"50\":{}},\"comment\":{}}],[\"generatefilename\",{\"_index\":36,\"name\":{\"53\":{}},\"comment\":{}}],[\"generateinteractionreplymessage\",{\"_index\":31,\"name\":{\"46\":{}},\"comment\":{}}],[\"generatelogentry\",{\"_index\":38,\"name\":{\"57\":{}},\"comment\":{}}],[\"generatemessage\",{\"_index\":37,\"name\":{\"55\":{}},\"comment\":{}}],[\"generatename\",{\"_index\":51,\"name\":{\"75\":{}},\"comment\":{}}],[\"generatestartmessage\",{\"_index\":52,\"name\":{\"77\":{}},\"comment\":{}}],[\"generatetitle\",{\"_index\":47,\"name\":{\"69\":{}},\"comment\":{}}],[\"getticketbyid\",{\"_index\":8,\"name\":{\"8\":{},\"20\":{}},\"comment\":{}}],[\"getticketbylastmessage\",{\"_index\":9,\"name\":{\"9\":{},\"21\":{}},\"comment\":{}}],[\"globalmailboxoptions\",{\"_index\":22,\"name\":{\"31\":{}},\"comment\":{}}],[\"guildid\",{\"_index\":58,\"name\":{\"85\":{}},\"comment\":{}}],[\"id\",{\"_index\":54,\"name\":{\"81\":{}},\"comment\":{}}],[\"imailboxmanager\",{\"_index\":29,\"name\":{\"38\":{}},\"comment\":{}}],[\"interactionbasedmailboxmanager\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"interactionoptions\",{\"_index\":30,\"name\":{\"44\":{}},\"comment\":{}}],[\"isoutdated\",{\"_index\":64,\"name\":{\"91\":{}},\"comment\":{}}],[\"lastmessage\",{\"_index\":60,\"name\":{\"87\":{}},\"comment\":{}}],[\"logchannel\",{\"_index\":40,\"name\":{\"60\":{}},\"comment\":{}}],[\"loggingoptions\",{\"_index\":35,\"name\":{\"51\":{}},\"comment\":{}}],[\"mailboxmanager\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"mailboxmanagerevents\",{\"_index\":13,\"name\":{\"22\":{}},\"comment\":{}}],[\"mailboxoptions\",{\"_index\":44,\"name\":{\"65\":{}},\"comment\":{}}],[\"manageroptions\",{\"_index\":42,\"name\":{\"62\":{}},\"comment\":{}}],[\"maxongoingticketsperuser\",{\"_index\":25,\"name\":{\"34\":{}},\"comment\":{}}],[\"messages\",{\"_index\":57,\"name\":{\"84\":{}},\"comment\":{}}],[\"modalcomponentsoptions\",{\"_index\":48,\"name\":{\"71\":{}},\"comment\":{}}],[\"modaloptions\",{\"_index\":46,\"name\":{\"67\":{}},\"comment\":{}}],[\"options\",{\"_index\":11,\"name\":{\"12\":{}},\"comment\":{}}],[\"optionsperguild\",{\"_index\":45,\"name\":{\"66\":{}},\"comment\":{}}],[\"perguildmailboxoptions\",{\"_index\":49,\"name\":{\"72\":{}},\"comment\":{}}],[\"replybuttonoptions\",{\"_index\":33,\"name\":{\"49\":{}},\"comment\":{}}],[\"replysent\",{\"_index\":19,\"name\":{\"28\":{}},\"comment\":{}}],[\"replytoticket\",{\"_index\":6,\"name\":{\"6\":{},\"18\":{},\"41\":{}},\"comment\":{}}],[\"selectguildoptions\",{\"_index\":43,\"name\":{\"64\":{}},\"comment\":{}}],[\"sendinthread\",{\"_index\":41,\"name\":{\"61\":{}},\"comment\":{}}],[\"sendselectguildmenu\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"setthreadchannel\",{\"_index\":62,\"name\":{\"89\":{}},\"comment\":{}}],[\"showsendernames\",{\"_index\":39,\"name\":{\"59\":{}},\"comment\":{}}],[\"threadcreate\",{\"_index\":18,\"name\":{\"27\":{}},\"comment\":{}}],[\"threadid\",{\"_index\":61,\"name\":{\"88\":{}},\"comment\":{}}],[\"threadoptions\",{\"_index\":50,\"name\":{\"73\":{}},\"comment\":{}}],[\"ticket\",{\"_index\":53,\"name\":{\"79\":{}},\"comment\":{}}],[\"ticketclose\",{\"_index\":16,\"name\":{\"25\":{}},\"comment\":{}}],[\"ticketcontent\",{\"_index\":68,\"name\":{\"95\":{}},\"comment\":{}}],[\"ticketcreate\",{\"_index\":14,\"name\":{\"23\":{}},\"comment\":{}}],[\"ticketforceclose\",{\"_index\":20,\"name\":{\"29\":{}},\"comment\":{}}],[\"ticketlog\",{\"_index\":17,\"name\":{\"26\":{}},\"comment\":{}}],[\"ticketupdate\",{\"_index\":15,\"name\":{\"24\":{}},\"comment\":{}}],[\"userid\",{\"_index\":27,\"name\":{\"36\":{}},\"comment\":{}}],[\"userstickets\",{\"_index\":3,\"name\":{\"3\":{},\"16\":{},\"39\":{}},\"comment\":{}}],[\"usertickets\",{\"_index\":28,\"name\":{\"37\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/api-docs/classes/InteractionBasedMailboxManager.html b/docs/api-docs/classes/InteractionBasedMailboxManager.html index 4bfd064..621a71e 100644 --- a/docs/api-docs/classes/InteractionBasedMailboxManager.html +++ b/docs/api-docs/classes/InteractionBasedMailboxManager.html @@ -26,7 +26,7 @@

Hierarchy

+
  • Defined in InteractionBasedMailboxManager.ts:46
    • @@ -38,8 +38,8 @@

    Constructors

    Properties

    -
    client -options +
    #options +client usersTickets
    @@ -57,7 +57,7 @@

    Constructors

    constructor

    +
    options: ManagerOptions

    Returns InteractionBasedMailboxManager

    +
  • Defined in InteractionBasedMailboxManager.ts:66

    • Properties

    +
    +

    Readonly Protected #options

    +
    #options: ManagerOptions
    +

    The options of the interactions manager.

    + +

    Memberof

    InteractionBasedMailboxManager

    +

    Readonly client

    client: Client<boolean>
    @@ -85,17 +94,7 @@

    Memberof

    MailboxManager

    -
    -

    Protected Readonly options

    -
    options: InteractionBasedMailboxManagerOptions
    -

    The options of the interactions manager.

    - -

    Memberof

    InteractionBasedMailboxManager

    -
    +
  • Defined in MailboxManager.ts:33

    • Readonly usersTickets

    usersTickets: Collection<string, UserTickets>
    @@ -103,7 +102,7 @@

    ReadonlyInherit

    +
  • Defined in MailboxManager.ts:36

    • Methods

    @@ -116,7 +115,7 @@

    Inherit

    Returns void

    +
  • Defined in InteractionBasedMailboxManager.ts:115

    • closeTicket

    Returns void
    +
  • Defined in MailboxManager.ts:93

    • createTicket

    Returns Ticket

    +
  • Defined in MailboxManager.ts:70

    • getTicketById

    Returns Ticket
    +
  • Defined in MailboxManager.ts:114

    • getTicketByLastMessage

  • @@ -203,7 +204,7 @@
    safeReturn: true
    • Returns undefined | Ticket
    +
  • Defined in MailboxManager.ts:131

    • replyToTicket

    Returns void
    +
  • Defined in MailboxManager.ts:85

    • sendSelectGuildMenu

    Returns Promise<void>

    +
  • Defined in InteractionBasedMailboxManager.ts:135
    • @@ -266,8 +266,8 @@

    InteractionBasedMailboxManager
    @@ -46,7 +46,6 @@

    Constructors

    Properties

    client -options usersTickets
    @@ -63,7 +62,7 @@

    Constructors

    constructor

    +
    options: GlobalMailboxOptions

    Returns MailboxManager

    +
  • Defined in MailboxManager.ts:44

    • Properties

    @@ -90,16 +89,7 @@

    ReadonlyMemberof

    MailboxManager

    -
    -

    Protected Readonly options

    -
    options: MailboxManagerOptions
    -

    The mailbox options.

    - -

    Memberof

    MailboxManager

    -
    +
  • Defined in MailboxManager.ts:33

    • Readonly usersTickets

    usersTickets: Collection<string, UserTickets>
    @@ -107,7 +97,7 @@

    ReadonlyInherit

    +
  • Defined in MailboxManager.ts:36

    • Methods

    @@ -120,7 +110,7 @@

    Inherit

    Returns void

    +
  • Defined in MailboxManager.ts:60

    • closeTicket

    Returns void
    +
  • Defined in MailboxManager.ts:93

    • createTicket

    Returns Ticket

    +
  • Defined in MailboxManager.ts:70

    • getTicketById

    Returns Ticket

    +
  • Defined in MailboxManager.ts:114

    • getTicketByLastMessage

    Returns Ticket

    +
  • Defined in MailboxManager.ts:130
  • @@ -204,7 +196,7 @@
    lastMessageId: string
    • safeReturn: true

    Returns undefined | Ticket

    +
  • Defined in MailboxManager.ts:131

    • replyToTicket

    Returns void
    +
  • Defined in MailboxManager.ts:85
    • @@ -249,7 +241,6 @@

    constructor
  • client
    • -
  • options
  • usersTickets
  • checkTickets
  • closeTicket
    • diff --git a/docs/api-docs/classes/Ticket.html b/docs/api-docs/classes/Ticket.html index 899b078..0cb02d6 100644 --- a/docs/api-docs/classes/Ticket.html +++ b/docs/api-docs/classes/Ticket.html @@ -24,7 +24,7 @@

    Hierarchy

    • Ticket
    +
  • Defined in types/Ticket.ts:12
    • @@ -38,13 +38,13 @@

    Constructors

    Properties

    createdAt createdBy +guildId id messages

    Accessors

    closedAt -guildId lastMessage threadId
    @@ -53,15 +53,14 @@

    Methods

    addMessage close isOutdated -setChannel -setGuild +setThreadChannel

    Constructors

    constructor

    Returns Ticket

    +
  • Defined in types/Ticket.ts:94

    • Properties

    @@ -85,7 +86,7 @@

    ReadonlyMemberof

    Ticket

    +
  • Defined in types/Ticket.ts:35

    • Readonly createdBy

    createdBy: User
    @@ -94,7 +95,16 @@

    ReadonlyMemberof

    Ticket

    +
  • Defined in types/Ticket.ts:27
    • +
    +

    Readonly guildId

    +
    guildId: string
    +

    The guild in which the ticket has been created.

    + +

    Memberof

    Ticket

    +

    Readonly id

    id: string
    @@ -103,7 +113,7 @@

    ReadonlyMemberof

    Ticket

    +
  • Defined in types/Ticket.ts:19

    • Readonly messages

    messages: TicketContent[]
    @@ -112,7 +122,7 @@

    ReadonlyMemberof

    Ticket

    +
  • Defined in types/Ticket.ts:43

    • Accessors

    @@ -126,19 +136,7 @@

    Memberof

    Ticket

    Returns null | number

    -
    -

    guildId

    -
    +
  • Defined in types/Ticket.ts:63

    • lastMessage

    +
  • Defined in types/Ticket.ts:74

    • threadId

    +
  • Defined in types/Ticket.ts:85

    • Methods

    @@ -181,7 +179,7 @@

    Parameters

    message: TicketContent

    Returns void

    +
  • Defined in types/Ticket.ts:122

    • close

    +
  • Defined in types/Ticket.ts:146

    • isOutdated

    Returns boolean

    -
    -

    setChannel

    +
  • Defined in types/Ticket.ts:134
    • +
    +

    setThreadChannel

    -
    -

    setGuild

    -

    Returns void

    +
  • Defined in types/Ticket.ts:112
    • @@ -274,15 +254,14 @@

    constructor
  • createdAt
  • createdBy
    • +
  • guildId
  • id
  • messages
  • closedAt
    • -
  • guildId
  • lastMessage
  • threadId
  • addMessage
  • close
  • isOutdated
    • -
  • setChannel
    • -
  • setGuild

    • +
  • setThreadChannel
    • \ No newline at end of file diff --git a/docs/api-docs/enums/MailboxManagerEvents.html b/docs/api-docs/enums/MailboxManagerEvents.html index a7056db..09e3891 100644 --- a/docs/api-docs/enums/MailboxManagerEvents.html +++ b/docs/api-docs/enums/MailboxManagerEvents.html @@ -20,7 +20,7 @@

    Enumeration MailboxManagerEvents

    Export

    +
  • Defined in MailboxManagerEvents.ts:7
    • @@ -44,49 +44,49 @@

    replySent

    Emitted once a reply is sent for a ticket.

    +
  • Defined in MailboxManagerEvents.ts:32

    • threadCreate

    threadCreate: "threadCreate"

    Emitted once a thread is created for a ticket

    +
  • Defined in MailboxManagerEvents.ts:28

    • ticketClose

    ticketClose: "ticketClose"

    Emitted when a ticket is closed

    +
  • Defined in MailboxManagerEvents.ts:19

    • ticketCreate

    ticketCreate: "ticketCreate"

    Emitted when a ticket is created

    +
  • Defined in MailboxManagerEvents.ts:11

    • ticketForceClose

    ticketForceClose: "ticketForceClose"

    Emitted once a ticket is force-closed.

    +
  • Defined in MailboxManagerEvents.ts:36

    • ticketLog

    ticketLog: "ticketLog"

    Emitted when a ticket is logged

    +
  • Defined in MailboxManagerEvents.ts:23

    • ticketUpdate

    ticketUpdate: "ticketUpdate"

    Emitted when a ticket is updated

    +
  • Defined in MailboxManagerEvents.ts:15
    • diff --git a/docs/api-docs/functions/createTicketContent.html b/docs/api-docs/functions/createTicketContent.html index 7de4dc4..4d126e5 100644 --- a/docs/api-docs/functions/createTicketContent.html +++ b/docs/api-docs/functions/createTicketContent.html @@ -22,8 +22,7 @@

    Function createTicketContent

    Creates a ticket content.

    Export

    -

    Returns

    {TicketContent}

    -
    +

    Returns

    Parameters

    Returns TicketContent

    +
  • Defined in types/TicketContent.ts:43
    • @@ -71,11 +70,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/functions/createTicketContentFromInteraction.html b/docs/api-docs/functions/createTicketContentFromInteraction.html index 0513754..f5a788f 100644 --- a/docs/api-docs/functions/createTicketContentFromInteraction.html +++ b/docs/api-docs/functions/createTicketContentFromInteraction.html @@ -22,8 +22,7 @@

    Function createTicketContentFromInteraction

    Creates a ticket content from an interaction submission.

    Export

    -

    Returns

    {TicketContent}

    -
    +

    Returns

    Parameters

    Returns TicketContent

    +
  • Defined in types/TicketContent.ts:75
    • @@ -59,11 +58,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/index.html b/docs/api-docs/index.html index 292eaf6..4d1d531 100644 --- a/docs/api-docs/index.html +++ b/docs/api-docs/index.html @@ -56,7 +56,7 @@

    Installation

    Events

     -
    manager.on(MailboxManagerEvents.ticketCreate, (ticket: Ticket) => {});

    manager.on(MailboxManagerEvents.ticketUpdate, (ticket: Ticket) => {});

    manager.on(MailboxManagerEvents.ticketLog, (ticket: Ticket) => {});

    manager.on(MailboxManagerEvents.ticketClose, (ticket: Ticket) => {});

    manager.on(
      MailboxManagerEvents.ticketForceClose,
      (ticket: Ticket, user: User | PartialUser) => {}
    );

    manager.on(MailboxManagerEvents.ticketDelete, (ticket: Ticket) => {});

    manager.on(
      MailboxManagerEvents.replySent,
      (message: Message, answer: Message) => {}
    );

    manager.on(MailboxManagerEvents.replyDelete, (message: Message) => {});

    manager.on(
      MailboxManagerEvents.threadCreate,
      (ticket: Ticket, thread: ThreadChannel) => {}
    );

    manager.on(
      MailboxManagerEvents.threadArchive,
      (ticket: Ticket, thread: ThreadChannel) => {}
    );
+
    manager.on(MailboxManagerEvents.ticketCreate, (ticket: Ticket) => {});

    manager.on(MailboxManagerEvents.ticketUpdate, (ticket: Ticket) => {});

    manager.on(MailboxManagerEvents.ticketLog, (ticket: Ticket) => {});

    manager.on(MailboxManagerEvents.ticketClose, (ticket: Ticket) => {});

    manager.on(MailboxManagerEvents.ticketForceClose, (ticket: Ticket, user: User | PartialUser) => {});

    manager.on(MailboxManagerEvents.ticketDelete, (ticket: Ticket) => {});

    manager.on(MailboxManagerEvents.replySent, (message: Message, answer: Message) => {});

    manager.on(MailboxManagerEvents.replyDelete, (message: Message) => {});

    manager.on(MailboxManagerEvents.threadCreate, (ticket: Ticket, thread: ThreadChannel) => {});

    manager.on(MailboxManagerEvents.threadArchive, (ticket: Ticket, thread: ThreadChannel) => {});
 
    
 
 
@@ -98,11 +98,13 @@ 
    MailboxManager
 
  • Ticket
    • 
 
  • IMailboxManager
    • 
-
  • InteractionBasedMailboxManagerOptions
    • 
+
  • EmbedOptions
    • 
+
  • GlobalMailboxOptions
    • 
+
  • InteractionOptions
    • 
 
  • LoggingOptions
    • 
-
  • MailboxManagerOptions
    • 
-
  • MessageBasedMailboxManagerOptions
    • 
+
  • ManagerOptions
    • 
 
  • ModalOptions
    • 
+
  • PerGuildMailboxOptions
    • 
 
  • ThreadOptions
    • 
 
  • TicketContent
    • 
 
  • UserId
    • 
diff --git a/docs/api-docs/interfaces/IMailboxManager.html b/docs/api-docs/interfaces/IMailboxManager.html
index f83746c..4ca5e2d 100644
--- a/docs/api-docs/interfaces/IMailboxManager.html
+++ b/docs/api-docs/interfaces/IMailboxManager.html
@@ -24,7 +24,7 @@ 
    Implemented by
    
 
+
  • Defined in types/IMailboxManager.ts:9
    • 
 
    
 
    
 
    
@@ -51,7 +51,7 @@ 
    ReadonlyMemberof
    MailboxManager
    +
  • Defined in types/IMailboxManager.ts:16

    • Methods

    @@ -65,7 +65,7 @@

    Memberof

    MailboxManager

    Returns void

    +
  • Defined in types/IMailboxManager.ts:51

    • closeTicket

    Returns void

    +
  • Defined in types/IMailboxManager.ts:44

    • createTicket

    Returns Ticket

    +
  • Defined in types/IMailboxManager.ts:27

    • replyToTicket

    Returns void

    +
  • Defined in types/IMailboxManager.ts:36
    • diff --git a/docs/api-docs/modules.html b/docs/api-docs/modules.html index 7fda3ed..cbd0849 100644 --- a/docs/api-docs/modules.html +++ b/docs/api-docs/modules.html @@ -31,11 +31,13 @@

    Interfaces

    Type Aliases

    -
    InteractionBasedMailboxManagerOptions +
    EmbedOptions +GlobalMailboxOptions +InteractionOptions LoggingOptions -MailboxManagerOptions -MessageBasedMailboxManagerOptions +ManagerOptions ModalOptions +PerGuildMailboxOptions ThreadOptions TicketContent UserId @@ -73,11 +75,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/types/MessageBasedMailboxManagerOptions.html b/docs/api-docs/types/EmbedOptions.html similarity index 69% rename from docs/api-docs/types/MessageBasedMailboxManagerOptions.html rename to docs/api-docs/types/EmbedOptions.html index 0419ba2..967d0ec 100644 --- a/docs/api-docs/types/MessageBasedMailboxManagerOptions.html +++ b/docs/api-docs/types/EmbedOptions.html @@ -1,4 +1,4 @@ -MessageBasedMailboxManagerOptions | @hunteroi/discord-mailbox
    +EmbedOptions | @hunteroi/discord-mailbox
    +
    EmbedOptions: EmbedData
    +
  • Defined in types/EmbedOptions.ts:3

    • @@ -45,11 +45,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/types/MailboxManagerOptions.html b/docs/api-docs/types/GlobalMailboxOptions.html similarity index 73% rename from docs/api-docs/types/MailboxManagerOptions.html rename to docs/api-docs/types/GlobalMailboxOptions.html index e67c1ce..027e952 100644 --- a/docs/api-docs/types/MailboxManagerOptions.html +++ b/docs/api-docs/types/GlobalMailboxOptions.html @@ -1,4 +1,4 @@ -MailboxManagerOptions | @hunteroi/discord-mailbox
    +GlobalMailboxOptions | @hunteroi/discord-mailbox
    +
    GlobalMailboxOptions: {
        closeTicketAfterInMilliseconds: number;
        cronTime: string | Date | DateTime;
        maxOnGoingTicketsPerUser: number;
    }

    Type declaration

      @@ -28,15 +28,11 @@
      cronTime:

      The cron time for the background job in charge of checking the validity of all ongoing tickets.

  • -
    mailboxChannels: Collection<Snowflake, TextChannel | VoiceChannel | Snowflake>
    -

    The mailbox channels in which the content is sent (or from which the threads are created).

    -
    • -
  • maxOnGoingTicketsPerUser: number

    The maximum number of ongoing tickets per user

    • +
  • Defined in types/GlobalMailboxOptions.ts:3
    • @@ -64,11 +60,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/types/InteractionOptions.html b/docs/api-docs/types/InteractionOptions.html new file mode 100644 index 0000000..972a906 --- /dev/null +++ b/docs/api-docs/types/InteractionOptions.html @@ -0,0 +1,93 @@ +InteractionOptions | @hunteroi/discord-mailbox
    +
    + +
    +
    +
    +
    + +

    Type alias InteractionOptions

    +
    InteractionOptions: {
        createButtonOptions: Exclude<InteractionButtonComponentData, "disabled" | "customId">;
        forceCloseButtonOptions?: Exclude<InteractionButtonComponentData, "disabled" | "customId">;
        generateInteractionReplyMessage: ((ticket: Ticket, guild: Guild) => string);
        replyButtonOptions: Exclude<InteractionButtonComponentData, "disabled" | "customId">;
    }
    +
    +

    Type declaration

    +
      +
    • +
      createButtonOptions: Exclude<InteractionButtonComponentData, "disabled" | "customId">
      +

      The settings of the creation button.

      +
      • +
    • +
      Optional forceCloseButtonOptions?: Exclude<InteractionButtonComponentData, "disabled" | "customId">
      +

      The settings of the close button.

      +
      • +
    • +
      generateInteractionReplyMessage: ((ticket: Ticket, guild: Guild) => string)
      +
        +
      • +
          +
        • (ticket: Ticket, guild: Guild): string
          • +
        • +

          A function to build the reply message.

          +
          +
          +

          Parameters

          +
            +
          • +
            ticket: Ticket
            • +
          • +
            guild: Guild
          +

          Returns string

      • +
    • +
      replyButtonOptions: Exclude<InteractionButtonComponentData, "disabled" | "customId">
      +

      The settings of the reply button.

      +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/api-docs/types/LoggingOptions.html b/docs/api-docs/types/LoggingOptions.html index e23bf0b..3d86c2f 100644 --- a/docs/api-docs/types/LoggingOptions.html +++ b/docs/api-docs/types/LoggingOptions.html @@ -15,15 +15,11 @@
  • @hunteroi/discord-mailbox
  • LoggingOptions

    • Type alias LoggingOptions

    -
    LoggingOptions: {
        channels: Collection<Snowflake, GuildTextBasedChannel>;
        generateFilename: ((ticket: Ticket) => string);
        generateLogEntry: ((ticketContent: TicketContent) => string);
        generateMessage: ((ticket: Ticket) => string | BaseMessageOptions);
        sendInThread?: boolean;
        showSenderNames: boolean;
    }
    +
    LoggingOptions: {
        generateFilename: ((ticket: Ticket) => string);
        generateLogEntry: ((ticketContent: TicketContent) => string);
        generateMessage: ((ticket: Ticket) => string | BaseMessageOptions);
        logChannel: Snowflake;
        sendInThread?: boolean;
        showSenderNames: boolean;
    }

    Type declaration

    • -
      channels: Collection<Snowflake, GuildTextBasedChannel>
      -

      The channel in which the logs are sent.

      -
      • -
    • generateFilename: ((ticket: Ticket) => string)
      • @@ -69,6 +65,10 @@

        Parameters

        ticket: Ticket

    Returns string | BaseMessageOptions

  • +
    logChannel: Snowflake
    +

    The guild channel in which the logs are sent.

    +
    • +
  • Optional sendInThread?: boolean

    Whether the logs should be sent in the thread or not.

    • @@ -77,7 +77,7 @@
    showSenderNames:

    Whether the sender names should be displayed or not.

    +
  • Defined in types/LoggingOptions.ts:5
    • @@ -105,11 +105,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/types/InteractionBasedMailboxManagerOptions.html b/docs/api-docs/types/ManagerOptions.html similarity index 65% rename from docs/api-docs/types/InteractionBasedMailboxManagerOptions.html rename to docs/api-docs/types/ManagerOptions.html index 2a7c322..f1e4b7d 100644 --- a/docs/api-docs/types/InteractionBasedMailboxManagerOptions.html +++ b/docs/api-docs/types/ManagerOptions.html @@ -1,4 +1,4 @@ -InteractionBasedMailboxManagerOptions | @hunteroi/discord-mailbox
    +ManagerOptions | @hunteroi/discord-mailbox
    +
    ManagerOptions: {
        mailboxOptions: GlobalMailboxOptions;
        optionsPerGuild: Collection<GuildResolvable, PerGuildMailboxOptions>;
        selectGuildOptions?: Exclude<StringSelectMenuComponentData, "disabled" | "customId">;
    }
    +
    +

    Type declaration

    +
      +
    • +
      mailboxOptions: GlobalMailboxOptions
      +

      The global options for the mailbox manager, applied to all guilds.

      +
      • +
    • +
      optionsPerGuild: Collection<GuildResolvable, PerGuildMailboxOptions>
      +

      The options per guild.

      +
      • +
    • +
      Optional selectGuildOptions?: Exclude<StringSelectMenuComponentData, "disabled" | "customId">
      +

      The settings of the select menu.

      +
    +
  • Defined in types/ManagerOptions.ts:5

    • @@ -45,11 +60,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/types/ModalOptions.html b/docs/api-docs/types/ModalOptions.html index c2b1575..2f615ab 100644 --- a/docs/api-docs/types/ModalOptions.html +++ b/docs/api-docs/types/ModalOptions.html @@ -15,12 +15,12 @@
  • @hunteroi/discord-mailbox
  • ModalOptions

    • Type alias ModalOptions

    -
    ModalOptions: {
        formatTitle: ((guild: Guild) => string);
        modalComponentsOptions: Exclude<TextInputComponentData, "required" | "value">;
    }
    +
    ModalOptions: {
        generateTitle: ((guild: Guild) => string);
        modalComponentsOptions: Exclude<TextInputComponentData, "required" | "value">;
    }

    Type declaration

    • -
      formatTitle: ((guild: Guild) => string)
      +
      generateTitle: ((guild: Guild) => string)
        • @@ -39,7 +39,7 @@
          modalComponentsOptions:

          The modal components' settings.

    +
  • Defined in types/ModalOptions.ts:3
    • @@ -67,11 +67,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/types/PerGuildMailboxOptions.html b/docs/api-docs/types/PerGuildMailboxOptions.html new file mode 100644 index 0000000..191e903 --- /dev/null +++ b/docs/api-docs/types/PerGuildMailboxOptions.html @@ -0,0 +1,61 @@ +PerGuildMailboxOptions | @hunteroi/discord-mailbox
    +
    + +
    +
    +
    +
    + +

    Type alias PerGuildMailboxOptions

    +
    PerGuildMailboxOptions: {
        embedOptions?: EmbedOptions;
        generateClosedChannelName: ((ticket: Ticket, guild: Guild, thread?: ThreadChannel) => string);
        generateMessageTitle: ((ticket: Ticket, guild: Guild) => string);
        generateReplyMessage: ((ticket: Ticket, guild: Guild) => string);
        generateTooMuchTicketsMessage: ((user: User, guild: Guild) => string);
        loggingOptions?: LoggingOptions;
        mailboxChannel: Snowflake;
        maxOnGoingTicketsPerUser: number;
        modalOptions: ModalOptions;
        threadOptions?: ThreadOptions;
    } & InteractionOptions
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
    +
    +

    Theme

    + +
    +
    \ No newline at end of file diff --git a/docs/api-docs/types/ThreadOptions.html b/docs/api-docs/types/ThreadOptions.html index 0a6d2f9..f3cb2c2 100644 --- a/docs/api-docs/types/ThreadOptions.html +++ b/docs/api-docs/types/ThreadOptions.html @@ -15,12 +15,12 @@
  • @hunteroi/discord-mailbox
  • ThreadOptions

    • Type alias ThreadOptions

    -
    ThreadOptions: {
        name: ((ticket: Ticket) => string);
        startMessage: ((ticket: Ticket) => string | BaseMessageOptions);
    }
    +
    ThreadOptions: {
        generateName: ((ticket: Ticket) => string);
        generateStartMessage: ((ticket: Ticket) => string | BaseMessageOptions);
    }

    Type declaration

    • -
      name: ((ticket: Ticket) => string)
      +
      generateName: ((ticket: Ticket) => string)
        • @@ -35,7 +35,7 @@

          Parameters

          ticket: Ticket

    Returns string

  • -
    startMessage: ((ticket: Ticket) => string | BaseMessageOptions)
    +
    generateStartMessage: ((ticket: Ticket) => string | BaseMessageOptions)
      • @@ -50,7 +50,7 @@

        Parameters

        ticket: Ticket

    • Returns string | BaseMessageOptions

    +
  • Defined in types/ThreadOptions.ts:4
    • @@ -78,11 +78,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/types/TicketContent.html b/docs/api-docs/types/TicketContent.html index 330b0aa..80c7d4e 100644 --- a/docs/api-docs/types/TicketContent.html +++ b/docs/api-docs/types/TicketContent.html @@ -17,7 +17,7 @@

    Type alias TicketContent

    TicketContent: Pick<Message, "attachments" | "author" | "cleanContent" | "content" | "createdAt" | "createdTimestamp" | "id" | "stickers" | "url" | "channelId" | "embeds"> & {
        channel: TextBasedChannel | null;
        mentions?: MessageMentions;
    }
    +
  • Defined in types/TicketContent.ts:12
    • @@ -45,11 +45,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/types/UserId.html b/docs/api-docs/types/UserId.html index d626f58..6a69fc8 100644 --- a/docs/api-docs/types/UserId.html +++ b/docs/api-docs/types/UserId.html @@ -17,7 +17,7 @@

    Type alias UserId

    UserId: Snowflake
    +
  • Defined in types/IMailboxManager.ts:6
    • @@ -45,11 +45,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/docs/api-docs/types/UserTickets.html b/docs/api-docs/types/UserTickets.html index 4db2991..41386cc 100644 --- a/docs/api-docs/types/UserTickets.html +++ b/docs/api-docs/types/UserTickets.html @@ -17,7 +17,7 @@

    Type alias UserTickets

    UserTickets: Collection<string, Ticket>
    +
  • Defined in types/IMailboxManager.ts:7
    • @@ -45,11 +45,13 @@

    MailboxManager
  • Ticket
  • IMailboxManager
    • -
  • InteractionBasedMailboxManagerOptions
    • +
  • EmbedOptions
    • +
  • GlobalMailboxOptions
    • +
  • InteractionOptions
  • LoggingOptions
    • -
  • MailboxManagerOptions
    • -
  • MessageBasedMailboxManagerOptions
    • +
  • ManagerOptions
  • ModalOptions
    • +
  • PerGuildMailboxOptions
  • ThreadOptions
  • TicketContent
  • UserId
    • diff --git a/examples/index.js b/examples/index.js index 89742a9..e30cbe5 100644 --- a/examples/index.js +++ b/examples/index.js @@ -1,15 +1,5 @@ -const { - Client, - GatewayIntentBits, - Partials, - ButtonStyle, - TextInputStyle, - Collection, -} = require('discord.js'); -const { - InteractionBasedMailboxManager, - MailboxManagerEvents, -} = require('../lib'); +const { Client, GatewayIntentBits, Partials, ButtonStyle, TextInputStyle, Collection } = require('discord.js'); +const { InteractionBasedMailboxManager, MailboxManagerEvents } = require('../lib'); const client = new Client({ intents: [ @@ -20,65 +10,61 @@ const client = new Client({ partials: [Partials.Channel, Partials.Message], }); const manager = new InteractionBasedMailboxManager(client, { - mailboxChannels: new Collection([ - ['GUILD_ID', 'TEXT_CHANNEL_ID'], - ['GUILD_ID', 'TEXT_CHANNEL_ID'], - ]), - closeTicketAfterInMilliseconds: 60000, // in milliseconds - maxOngoingTicketsPerUser: 3, - cronTime: '* * * * *', // run each minute - loggingOptions: { - generateFilename: (ticket) => `log-ticket-${ticket.id}.txt`, - generateMessage: (ticket) => - `Logs for ticket ${ticket.id} - closed at ${new Date(ticket.closedAt)}`, - generateLogEntry: (ticketContent) => - `[${new Date(ticketContent.createdTimestamp)}] ${ - ticketContent.author.username - } | ${ticketContent.cleanContent}`, - showSenderNames: true, - sendToRecipient: false, - channels: new Collection([['GUILD_ID', 'TEXT_CHANNEL_ID']]), - sendInThread: true, + mailboxOptions: { + closeTicketAfterInMilliseconds: 60000, // in milliseconds + maxOngoingTicketsPerUser: 3, + cronTime: '* * * * *', // run each minute }, - threadOptions: { - name: (ticket) => `Ticket ${ticket.id}`, - startMessage: (ticket) => - `New ticket created by ${ticket.createdBy}`, - }, - embedOptions: { - color: 12272523, - }, - forceCloseEmoji: '❌', - replySentEmoji: '📤', - formatTitle: (ticket, guild) => `Ticket ${ticket.id} for ${guild.name} (${guild.id})`, - replyMessage: - 'Please use the "reply" feature to send an answer to this message.', - closedChannelPrefix: '[Closed] ', - tooMuchTickets: - 'You have too much tickets that are not closed! Please wait for your tickets to be closed before submitting new ones.', - createButtonOptions: { - label: 'CREATE TICKET', - emoji: '➕', - style: ButtonStyle.Primary, - }, - replyButtonOptions: { - label: 'REPLY', - emoji: '↩ī¸', - style: ButtonStyle.Primary, - }, - forceCloseButtonOptions: { - label: 'CLOSE', - style: ButtonStyle.Secondary, - }, - modalOptions: { - formatTitle: (guild) => `Ticket for ${guild.name}`, - modalComponentsOptions: { - placeholder: 'Write down your message here', - label: 'Your message', - style: TextInputStyle.Paragraph, - }, - }, - interactionReply: 'Your feedback has been received!', + optionsPerGuild: new Collection([ + ['GUILD_ID', { + mailboxChannel: 'TEXT_CHANNEL_ID', + maxOnGoingTicketsPerUser: 2, + modalOptions: { + generateTitle: (guild) => `Ticket for ${guild.name}`, + modalComponentsOptions: { + placeholder: 'Write down your message here', + label: 'Your message', + style: TextInputStyle.Paragraph, + }, + }, + loggingOptions: { + generateFilename: (ticket) => `log-ticket-${ticket.id}.txt`, + generateMessage: (ticket) => + `Logs for ticket ${ticket.id} - closed at ${new Date(ticket.closedAt)}`, + generateLogEntry: (ticketContent) => `[${new Date(ticketContent.createdTimestamp)}] ${ticketContent.author.username} | ${ticketContent.cleanContent}`, + showSenderNames: true, + logChannel: 'TEXT_CHANNEL_ID', + sendInThread: true, + }, + threadOptions: { + generateName: (ticket) => `Ticket ${ticket.id}`, + generateStartMessage: (ticket) => `New ticket created by ${ticket.createdBy}`, + }, + embedOptions: { + color: 12272523, + }, + generateReplyMessage: (ticket, guild) => 'Please use the reply button to send an answer to this message.', + generateMessageTitle: (ticket, guild) => `Ticket ${ticket.id} for ${guild.name} (${guild.id})`, + generateClosedChannelName: (ticket, guild, thread) => `[Closed] ${thread?.name ?? ticket.id}`, + generateTooMuchTicketsMessage: (user, guild) => 'You have too much tickets that are not closed! Please wait for your tickets to be closed before submitting new ones.', + generateInteractionReplyMessage: (ticket, guild) => 'Your feedback has been received!', + createButtonOptions: { + label: 'CREATE TICKET', + emoji: '➕', + style: ButtonStyle.Primary, + }, + replyButtonOptions: { + label: 'REPLY', + emoji: '↩ī¸', + style: ButtonStyle.Primary, + }, + forceCloseButtonOptions: { + label: 'CLOSE', + emoji: '❌', + style: ButtonStyle.Secondary, + } + }] + ]) }); client.on('ready', () => console.log('Connected!')); @@ -97,12 +83,8 @@ manager.on(MailboxManagerEvents.ticketCreate, async (ticket) => { 'Your ticket has been received and will be treated soon. Please remain patient as we get back to you!' ); }); -manager.on(MailboxManagerEvents.ticketUpdate, (ticket) => - console.log(`${ticket.id} has been updated with a new message.`) -); -manager.on(MailboxManagerEvents.ticketLog, (ticket) => - console.log(`${ticket.id} got logged.`) -); +manager.on(MailboxManagerEvents.ticketUpdate, (ticket) => console.log(`${ticket.id} has been updated with a new message.`)); +manager.on(MailboxManagerEvents.ticketLog, (ticket) => console.log(`${ticket.id} got logged.`)); manager.on(MailboxManagerEvents.ticketClose, async (ticket, userTickets) => { console.log(`${ticket.id} got closed!`); @@ -113,11 +95,7 @@ manager.on(MailboxManagerEvents.ticketClose, async (ticket, userTickets) => { `The ticket ${ticket.id} has been closed due to inactivity or manually by the receiver or yourself.\nYou now have ${nbTickets} opened tickets left.` ); }); -manager.on(MailboxManagerEvents.ticketForceClose, (ticket, user) => - console.log(`${user.username} forced closed ticket ${ticket.id}.`) -); -manager.on(MailboxManagerEvents.threadCreate, (ticket, thread) => { - console.log(`${ticket.id} is happening in ${thread.name}`); -}); +manager.on(MailboxManagerEvents.ticketForceClose, (ticket, user) => console.log(`${user.username} forced closed ticket ${ticket.id}.`)); +manager.on(MailboxManagerEvents.threadCreate, (ticket, thread) => console.log(`${ticket.id} is happening in ${thread.name}`)); client.login('TOKEN'); diff --git a/package.json b/package.json index 9247bfe..4da8d92 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@hunteroi/discord-mailbox", - "version": "3.1.0", + "version": "4.0.0", "description": "A framework to integrate a mailbox inside your Discord bot built with DiscordJS", "main": "lib/index.js", "scripts": { diff --git a/src/ErrorMessages.ts b/src/ErrorMessages.ts index 720e811..39c333e 100644 --- a/src/ErrorMessages.ts +++ b/src/ErrorMessages.ts @@ -1,25 +1,10 @@ -const noOpenedTicketWithId = 'Provided ticket ID does not exist for any user'; -const tooMuchTicketsOpened = 'Too much tickets for this user'; -const messageHasNoTicket = 'No ticket related to this message'; +enum ErrorMessages { + noOpenedTicketWithId = '0001 - Provided ticket ID does not exist for any user', + tooMuchTicketsOpened = '0002 - Too much tickets for this user', + messageHasNoTicket = '0003 - No ticket related to this message', + senderNamesAppear = '0004 - Sender names appear although the options is disabled', + noMailboxRegistered = '0005 - There is no mailbox registered in the options', + guildNotRegistered = '0006 - The provided guild is not registered by the mailbox manager', +} -const headerMustContainTicketId = - 'Ticket title must at least contain the ticket id'; -const noPreviousMessageId = 'Previous message does not contain message ID'; -const messageIsNotReply = 'Message is not a reply'; -const notForceCloseEmoji = 'Reaction emoji is not for force close'; -const senderNamesAppear = - 'Sender names appear although the options is disabled'; -const noMailboxRegistered = 'There are no mailbox registered in the options'; - -export default { - noOpenedTicketWithId, - tooMuchTicketsOpened, - messageHasNoTicket, - - headerMustContainTicketId, - noPreviousMessageId, - messageIsNotReply, - notForceCloseEmoji, - senderNamesAppear, - noMailboxRegistered, -}; +export default ErrorMessages; diff --git a/src/InteractionBasedMailboxManager.ts b/src/InteractionBasedMailboxManager.ts index a0bab64..6d9ab71 100644 --- a/src/InteractionBasedMailboxManager.ts +++ b/src/InteractionBasedMailboxManager.ts @@ -2,7 +2,6 @@ import { BaseGuildTextChannel, ButtonInteraction, Client, - GuildTextBasedChannel, Interaction, ModalSubmitInteraction, PartialTextBasedChannelFields, @@ -21,19 +20,22 @@ import { CacheType, StringSelectMenuBuilder, StringSelectMenuInteraction, - BaseMessageOptions + BaseMessageOptions, + Snowflake, + TextChannel } from 'discord.js'; import ErrorMessages from './ErrorMessages'; import { MailboxManager } from './MailboxManager'; import { MailboxManagerEvents } from './MailboxManagerEvents'; import { createTicketContentFromInteraction, - InteractionBasedMailboxManagerOptions, Ticket, UserTickets, + ManagerOptions } from './types'; import { isNullOrWhiteSpaces, truncate } from './utils/StringUtils'; + /** * A mailbox working on interactions. * @@ -53,17 +55,18 @@ export class InteractionBasedMailboxManager extends MailboxManager { * @protected * @memberof InteractionBasedMailboxManager */ - protected override readonly options!: InteractionBasedMailboxManagerOptions; + readonly #options!: ManagerOptions; /** * Creates an instance of InteractionBasedMailboxManager. * @param {Client} client - * @param {InteractionBasedMailboxManagerOptions} options + * @param {ManagerOptions} options * @memberof InteractionBasedMailboxManager */ - constructor(client: Client, options: InteractionBasedMailboxManagerOptions) { - super(client, options); + constructor(client: Client, options: ManagerOptions) { + super(client, options.mailboxOptions); + this.#options = options; this.client.on( Events.InteractionCreate, async (interaction: Interaction) => { @@ -89,18 +92,11 @@ export class InteractionBasedMailboxManager extends MailboxManager { await this.#onGuildChoiceInteraction(interaction); } catch (error) { console.debug(error); - if ( - (interaction.isMessageComponent() || interaction.isModalSubmit()) && - !interaction.replied - ) { + if ((interaction.isMessageComponent() || interaction.isModalSubmit()) && !interaction.replied) { if (interaction.deferred) - await interaction.editReply( - `Action not possible: ${(error as any).message}` - ); + await interaction.editReply(`Action not possible: ${(error as any).message}`); else - await interaction.reply( - `Action not possible: ${(error as any).message}` - ); + await interaction.reply(`Action not possible: ${(error as any).message}`); } } } @@ -120,8 +116,10 @@ export class InteractionBasedMailboxManager extends MailboxManager { this.usersTickets .flatMap((ut: UserTickets) => ut) .each(async (ticket: Ticket) => { - if (ticket.isOutdated(this.options.closeTicketAfterInMilliseconds)) { - this.#updateThread(ticket); + const guildId = ticket.guildId; + const guildOptions = this.#options.optionsPerGuild.get(guildId); + if (ticket.isOutdated(this.#options.mailboxOptions.closeTicketAfterInMilliseconds) && guildOptions) { + await this.#updateThread(ticket, guildOptions.generateClosedChannelName); this.closeTicket(ticket.id); } }); @@ -131,7 +129,7 @@ export class InteractionBasedMailboxManager extends MailboxManager { * Sends the select menu to choose a guild. * * @param {User} user - * @return {*} {Promise} + * @return {Promise} * @memberof InteractionBasedMailboxManager */ public async sendSelectGuildMenu(user: User): Promise { @@ -144,14 +142,14 @@ export class InteractionBasedMailboxManager extends MailboxManager { : null ) ) - ).filter( - (guild): guild is Guild => - guild instanceof Guild && this.options.mailboxChannels.has(guild.id) - ); - - const rowSelectMenu = - new ActionRowBuilder().addComponents( - new StringSelectMenuBuilder(this.options.selectGuildOptions) + ).filter((guild): guild is Guild => guild instanceof Guild && this.#options.optionsPerGuild.has(guild.id)); + + let row: ActionRowBuilder | ActionRowBuilder; + if (userGuilds.length === 1) { + row = await this.#generateStartButtonRow(userGuilds[0].id); + } else { + row = new ActionRowBuilder().addComponents( + new StringSelectMenuBuilder(this.#options.selectGuildOptions) .setCustomId(this.#selectGuild) .setOptions( userGuilds.map((g) => ({ @@ -163,50 +161,54 @@ export class InteractionBasedMailboxManager extends MailboxManager { })) ) ); - await user.send({ - components: [rowSelectMenu], - }); + } + await user.send({ components: [row] }); } /** * Sends the start button to create a ticket. * * @param {SelectMenuInteraction} interaction - * @return {*} {Promise} + * @return {Promise} * @memberof InteractionBasedMailboxManager */ - async #onGuildChoiceInteraction( - interaction: StringSelectMenuInteraction - ): Promise { + async #onGuildChoiceInteraction(interaction: StringSelectMenuInteraction): Promise { const guildId = interaction.values.shift()!; + const rowButton = await this.#generateStartButtonRow(guildId); + await interaction.update({ components: [rowButton] }); + } + + async #generateStartButtonRow(guildId: Snowflake): Promise> { const guild = await this.client.guilds.fetch(guildId); - const buttonLabel = truncate( - `${this.options.createButtonOptions.label} - ${guild.name}`, - 80 - ); + const guildOptions = this.#options.optionsPerGuild.get(guildId); + if (!guildOptions) throw Error(ErrorMessages.guildNotRegistered); + + const buttonLabel = truncate(`${guildOptions.createButtonOptions.label} - ${guild.name}`, 80); const rowButton = new ActionRowBuilder().addComponents( - new ButtonBuilder(this.options.createButtonOptions) + new ButtonBuilder(guildOptions.createButtonOptions) .setLabel(buttonLabel) .setCustomId(`${this.#createTicketId}${guildId}`) ); - await interaction.update({ components: [rowButton] }); + return rowButton; } async #handleLog(ticket: Ticket): Promise { - if (!this.options.loggingOptions) return; + const guildId = ticket.guildId; + const guildOptions = this.#options.optionsPerGuild.get(guildId); + if (!guildOptions) throw Error(ErrorMessages.guildNotRegistered); - const logs = ticket.messages.map( - this.options.loggingOptions.generateLogEntry - ); + if (!guildOptions.loggingOptions) return; + + const logs = ticket.messages.map(guildOptions.loggingOptions.generateLogEntry); if ( logs.length > 0 && - !this.options.loggingOptions.showSenderNames && + !guildOptions.loggingOptions.showSenderNames && logs[0].includes(ticket.messages[0].author.username) ) { throw new Error(ErrorMessages.senderNamesAppear); } - const content = this.options.loggingOptions.generateMessage(ticket); + const content = guildOptions.loggingOptions.generateMessage(ticket); const logMessage = typeof content === 'string' ? ({ @@ -214,7 +216,7 @@ export class InteractionBasedMailboxManager extends MailboxManager { files: [ { attachment: Buffer.from(logs.join('\n')), - name: this.options.loggingOptions.generateFilename(ticket), + name: guildOptions.loggingOptions.generateFilename(ticket), }, ], } as BaseMessageOptions) @@ -223,29 +225,22 @@ export class InteractionBasedMailboxManager extends MailboxManager { files: [ { attachment: Buffer.from(logs.join('\n')), - name: this.options.loggingOptions.generateFilename(ticket), + name: guildOptions.loggingOptions.generateFilename(ticket), }, ], }; - if (this.options.loggingOptions.sendInThread && ticket.threadId !== null) { + if (guildOptions.loggingOptions.sendInThread && ticket.threadId !== null) { const thread = (await this.client.channels.fetch( ticket.threadId )) as ThreadChannel; await thread.send(logMessage); - await this.#updateThread(ticket); + await this.#updateThread(ticket, guildOptions.generateClosedChannelName); } - const guildLogChannel = this.options.loggingOptions.channels.get( - ticket.guildId! - ); - const logChannel = - typeof guildLogChannel === 'string' - ? ((await this.client.channels.fetch( - guildLogChannel - )) as GuildTextBasedChannel) - : guildLogChannel; - await logChannel?.send(logMessage); + const guildLogChannel = guildOptions.loggingOptions.logChannel; + const logChannel = await this.client.channels.fetch(guildLogChannel) as TextChannel; + await logChannel.send(logMessage); await ticket.createdBy.send(logMessage); } @@ -277,12 +272,16 @@ export class InteractionBasedMailboxManager extends MailboxManager { this.#forceCloseTicketIdPrefix.length ); const ticket = this.getTicketById(ticketId); + const guildId = ticket.guildId; + const guildOptions = this.#options.optionsPerGuild.get(guildId); + if (!guildOptions) throw Error(ErrorMessages.guildNotRegistered); + const guild = await this.client.guilds.fetch(guildId); this.emit(MailboxManagerEvents.ticketForceClose, ticket, interaction.user); this.closeTicket(ticket.id); - await interaction.editReply(this.options.interactionReply); - await this.#updateThread(ticket); + await interaction.editReply(guildOptions.generateInteractionReplyMessage(ticket, guild)); + await this.#updateThread(ticket, guildOptions.generateClosedChannelName); } async #onNewTicketSubmitInteraction( @@ -291,16 +290,24 @@ export class InteractionBasedMailboxManager extends MailboxManager { await interaction.deferReply(); const guildId = interaction.customId.slice(this.#createTicketId.length); - const ticketContent = createTicketContentFromInteraction(interaction); - - const ticket = this.createTicket(ticketContent); - ticket.setGuild(guildId); + const guildOptions = this.#options.optionsPerGuild.get(guildId); + if (!guildOptions) throw Error(ErrorMessages.guildNotRegistered); + const guild = await this.client.guilds.fetch(guildId); + const ticketContent = createTicketContentFromInteraction(interaction); + let ticket: Ticket; + try { + ticket = this.createTicket(ticketContent, guildId, guildOptions.maxOnGoingTicketsPerUser); + } catch (error) { + if ((error as any).message.startsWith('0002')) + throw new Error(guildOptions.generateTooMuchTicketsMessage(interaction.user, guild)); + throw error; + } const channel = await this.#getChannel(ticket); const ticketMessage = await this.#generateMessageFromTicket(ticket); await channel.send(ticketMessage); - await interaction.editReply(this.options.interactionReply); + await interaction.editReply(guildOptions.generateInteractionReplyMessage(ticket, guild)); } async #onReplySubmitInteraction( @@ -313,9 +320,13 @@ export class InteractionBasedMailboxManager extends MailboxManager { this.#replyTicketIdPrefix.length ); const ticket = this.getTicketById(ticketId); + const guildId = ticket.guildId; + const guildOptions = this.#options.optionsPerGuild.get(guildId); + if (!guildOptions) throw Error(ErrorMessages.guildNotRegistered); this.replyToTicket(ticketContent, ticket.id); + const guild = await this.client.guilds.fetch(guildId); const ticketMessage = await this.#generateMessageFromTicket(ticket); const isSentToAdmin = interaction.channel?.type === ChannelType.DM; const channel = await this.#getChannel(ticket); @@ -324,41 +335,36 @@ export class InteractionBasedMailboxManager extends MailboxManager { : ticket.createdBy ).send(ticketMessage); - await interaction.editReply(this.options.interactionReply); + await interaction.editReply(guildOptions.generateInteractionReplyMessage(ticket, guild)); this.emit(MailboxManagerEvents.replySent, interaction, answerMessage); } async #getChannel(ticket: Ticket): Promise { - const mailboxChannel = this.options.mailboxChannels.get(ticket.guildId!); + const guildId = ticket.guildId; + const guildOptions = this.#options.optionsPerGuild.get(guildId); + if (!guildOptions) throw Error(ErrorMessages.guildNotRegistered); + + const mailboxChannel = guildOptions.mailboxChannel; if (!mailboxChannel) throw new Error(ErrorMessages.noMailboxRegistered); - const guildChannel = - typeof mailboxChannel === 'string' - ? ((await this.client.channels.fetch( - mailboxChannel - )) as BaseGuildTextChannel) - : mailboxChannel; + const guildChannel = await this.client.channels.fetch(mailboxChannel) as BaseGuildTextChannel; let thread: ThreadChannel | null = null; if ( !ticket.threadId && - this.options.threadOptions && + guildOptions.threadOptions && guildChannel.type !== ChannelType.GuildVoice ) { - const startMessage = await guildChannel.send( - this.options.threadOptions.startMessage(ticket) - ); - thread = await (guildChannel as BaseGuildTextChannel).threads.create({ - name: this.options.threadOptions.name(ticket), + const startMessage = await guildChannel.send(guildOptions.threadOptions.generateStartMessage(ticket)); + thread = await guildChannel.threads.create({ + name: guildOptions.threadOptions.generateName(ticket), autoArchiveDuration: ThreadAutoArchiveDuration.OneWeek, startMessage, - type: ChannelType.GuildPublicThread, + type: ChannelType.PublicThread, }); - ticket.setChannel(thread.id); + ticket.setThreadChannel(thread.id); this.emit(MailboxManagerEvents.threadCreate, ticket, thread); } else if (ticket.threadId) { - thread = await (guildChannel as BaseGuildTextChannel).threads.fetch( - ticket.threadId - ); + thread = await guildChannel.threads.fetch(ticket.threadId); } return thread ?? guildChannel; @@ -367,36 +373,39 @@ export class InteractionBasedMailboxManager extends MailboxManager { async #generateMessageFromTicket(ticket: Ticket): Promise { const isSentToAdmin = ticket.lastMessage.channel?.type === ChannelType.DM; - const guild = await this.client.guilds.fetch(ticket.guildId!); - const header = this.options.formatTitle(ticket, guild); + const guildId = ticket.guildId; + const guildOptions = this.#options.optionsPerGuild.get(guildId); + if (!guildOptions) throw Error(ErrorMessages.guildNotRegistered); + + const guild = await this.client.guilds.fetch(ticket.guildId); + const header = guildOptions.generateMessageTitle(ticket, guild); const description = ticket.lastMessage.cleanContent; const prefix = - isSentToAdmin || this.options.loggingOptions?.showSenderNames + isSentToAdmin || guildOptions.loggingOptions?.showSenderNames ? `${ticket.lastMessage.author.username}:\n` : null; - const suffix = `\n\n**${this.options.replyMessage}**`; + const suffix = `\n\n**${guildOptions.generateReplyMessage(ticket, guild)}**`; const footer = `ID: ${ticket.lastMessage.id}`; const replyButtonRow = new ActionRowBuilder().addComponents( new ButtonBuilder({ - ...this.options.replyButtonOptions, + ...guildOptions.replyButtonOptions, customId: `${this.#replyTicketIdPrefix}${ticket.id}`, }) ); - if (this.options.forceCloseEmoji) { + if (guildOptions.forceCloseButtonOptions) { replyButtonRow.addComponents( new ButtonBuilder({ - ...this.options.forceCloseButtonOptions, - emoji: this.options.forceCloseEmoji, + ...guildOptions.forceCloseButtonOptions, customId: `${this.#forceCloseTicketIdPrefix}${ticket.id}`, }) ); } - return this.options.embedOptions + return guildOptions.embedOptions ? { embeds: [ - new EmbedBuilder(this.options.embedOptions) + new EmbedBuilder(guildOptions.embedOptions) .setAuthor({ name: isSentToAdmin ? ticket.lastMessage.author.username : guild.name, iconURL: isSentToAdmin ? ticket.lastMessage.author.displayAvatarURL() : guild.iconURL() ?? undefined, @@ -421,18 +430,20 @@ export class InteractionBasedMailboxManager extends MailboxManager { ticket && ticket.guildId ? ticket.guildId : customId.slice(this.#createTicketId.length); + + const guildOptions = this.#options.optionsPerGuild.get(guildId); + if (!guildOptions) throw Error(ErrorMessages.guildNotRegistered); + const guild = await this.client.guilds.fetch(guildId); const messageRow = new ActionRowBuilder().addComponents( new TextInputBuilder({ - ...this.options.modalOptions.modalComponentsOptions, + ...guildOptions.modalOptions?.modalComponentsOptions, required: true, customId: 'message', }) ); - const modalTitle = ticket - ? this.options.formatTitle(ticket, guild) - : this.options.modalOptions.formatTitle(guild); + const modalTitle = (ticket ? guildOptions.generateMessageTitle(ticket, guild) : guildOptions.modalOptions?.generateTitle(guild)) ?? 'Anything to say?'; // TODO: add an attachment component https://github.com/discord/discord-api-docs/discussions/4482 const modal = new ModalBuilder() .setTitle(truncate(modalTitle, 45)) @@ -442,19 +453,13 @@ export class InteractionBasedMailboxManager extends MailboxManager { return modal; } - async #updateThread(ticket: Ticket): Promise { + async #updateThread(ticket: Ticket, generateName?: (ticket: Ticket, guild: Guild, thread?: ThreadChannel) => string): Promise { if (ticket.threadId) { - const thread = (await this.client.channels.fetch( - ticket.threadId - )) as ThreadChannel; + const thread = await this.client.channels.fetch(ticket.threadId) as ThreadChannel; + const newName = (generateName && generateName(ticket, thread.guild, thread)) ?? thread.name; - if ( - this.options.closedChannelPrefix && - !thread.name.startsWith(this.options.closedChannelPrefix) - ) { - await thread.setName( - `${this.options.closedChannelPrefix ?? ''}${thread.name}` - ); + if (thread.name !== newName) { + await thread.setName(newName); } if (!thread.archived) await thread.setArchived(true); } diff --git a/src/MailboxManager.ts b/src/MailboxManager.ts index 29a4ae1..0a024f4 100644 --- a/src/MailboxManager.ts +++ b/src/MailboxManager.ts @@ -1,11 +1,11 @@ -import { Client, Collection } from 'discord.js'; +import { Client, Collection, Snowflake } from 'discord.js'; import { EventEmitter } from 'events'; import { CronJob } from 'cron'; import ErrorMessages from './ErrorMessages'; import { MailboxManagerEvents } from './MailboxManagerEvents'; import { - MailboxManagerOptions, + GlobalMailboxOptions, IMailboxManager, Ticket, TicketContent, @@ -22,14 +22,7 @@ import { * @implements {IMailboxManager} */ export class MailboxManager extends EventEmitter implements IMailboxManager { - /** - * The mailbox options. - * - * @protected - * @type {MailboxManagerOptions} - * @memberof MailboxManager - */ - protected readonly options: MailboxManagerOptions; + readonly #managerOptions: GlobalMailboxOptions; readonly #cronJob: CronJob; /** @@ -45,20 +38,17 @@ export class MailboxManager extends EventEmitter implements IMailboxManager { /** * Creates an instance of MailboxManager. * @param {Client} client - * @param {MailboxManagerOptions} options + * @param {GlobalMailboxOptions} options * @memberof MailboxManager */ - constructor(client: Client, options: MailboxManagerOptions) { + constructor(client: Client, options: GlobalMailboxOptions) { super(); - if (!(options.mailboxChannels instanceof Collection)) - throw new Error('No mailboxes registered within a Collection'); - - this.options = options; + this.#managerOptions = options; this.client = client; this.usersTickets = new Collection(); this.#cronJob = new CronJob({ - cronTime: this.options.cronTime, + cronTime: this.#managerOptions.cronTime, onTick: () => this.checkTickets(), start: true, runOnInit: true, @@ -71,19 +61,18 @@ export class MailboxManager extends EventEmitter implements IMailboxManager { this.usersTickets .flatMap((ut: UserTickets) => ut) .each(async (ticket: Ticket) => { - if (ticket.isOutdated(this.options.closeTicketAfterInMilliseconds)) + if (ticket.isOutdated(this.#managerOptions.closeTicketAfterInMilliseconds)) this.closeTicket(ticket.id); }); } /** @inherit */ - createTicket(content: TicketContent): Ticket { - const ticket = new Ticket(content); + createTicket(content: TicketContent, guildId: Snowflake, maxOnGoingTicketsPerUser?: number): Ticket { + maxOnGoingTicketsPerUser ??= this.#managerOptions.maxOnGoingTicketsPerUser; + const ticket = new Ticket(content, guildId); - const userTickets = - this.usersTickets.get(ticket.createdBy.id) ?? - new Collection(); - if (userTickets.size === this.options.maxOnGoingTicketsPerUser) + const userTickets = this.usersTickets.get(ticket.createdBy.id) ?? new Collection(); + if (userTickets.size >= maxOnGoingTicketsPerUser) throw new Error(ErrorMessages.tooMuchTicketsOpened); userTickets.set(ticket.id, ticket); this.usersTickets.set(ticket.createdBy.id, userTickets); @@ -119,7 +108,7 @@ export class MailboxManager extends EventEmitter implements IMailboxManager { * Gets a ticket by id. * * @param {string} ticketId - * @return {*} {Ticket} + * @return {Ticket} * @memberof MailboxManager */ getTicketById(ticketId: string): Ticket { @@ -135,18 +124,12 @@ export class MailboxManager extends EventEmitter implements IMailboxManager { * * @param {string} lastMessageId * @param {false} [safeReturn] - * @return {*} {Ticket} + * @return {Ticket} * @memberof MailboxManager */ getTicketByLastMessage(lastMessageId: string, safeReturn?: false): Ticket; - getTicketByLastMessage( - lastMessageId: string, - safeReturn: true - ): Ticket | undefined; - getTicketByLastMessage( - lastMessageId: string, - safeReturn: boolean = false - ): Ticket | undefined { + getTicketByLastMessage(lastMessageId: string, safeReturn: true): Ticket | undefined; + getTicketByLastMessage(lastMessageId: string, safeReturn: boolean = false): Ticket | undefined { const ticket = this.usersTickets .flatMap((userTickets: UserTickets) => userTickets) .find((t: Ticket) => t.lastMessage.id === lastMessageId); diff --git a/src/index.ts b/src/index.ts index 17d65e5..8994799 100644 --- a/src/index.ts +++ b/src/index.ts @@ -2,4 +2,4 @@ export * from './MailboxManager'; export * from './InteractionBasedMailboxManager'; export * from './MailboxManagerEvents'; export * from './ErrorMessages'; -export * from './types'; \ No newline at end of file +export * from './types'; diff --git a/src/types/EmbedOptions.ts b/src/types/EmbedOptions.ts new file mode 100644 index 0000000..c3384cf --- /dev/null +++ b/src/types/EmbedOptions.ts @@ -0,0 +1,3 @@ +import { EmbedData } from 'discord.js'; + +export type EmbedOptions = EmbedData; diff --git a/src/types/GlobalMailboxOptions.ts b/src/types/GlobalMailboxOptions.ts new file mode 100644 index 0000000..93b4b8f --- /dev/null +++ b/src/types/GlobalMailboxOptions.ts @@ -0,0 +1,24 @@ +import { DateTime } from 'luxon'; + +export type GlobalMailboxOptions = { + /** + * The duration in milliseconds after a ticket's last activity before it gets closed. + * + * @type {number} + */ + closeTicketAfterInMilliseconds: number; + + /** + * The maximum number of ongoing tickets per user + * + * @type {number} + */ + maxOnGoingTicketsPerUser: number; + + /** + * The cron time for the background job in charge of checking the validity of all ongoing tickets. + * + * @type {(string | Date | DateTime)} + */ + cronTime: string | Date | DateTime; +}; diff --git a/src/types/IMailboxManager.ts b/src/types/IMailboxManager.ts index 41e3a44..fca334d 100644 --- a/src/types/IMailboxManager.ts +++ b/src/types/IMailboxManager.ts @@ -19,10 +19,12 @@ export interface IMailboxManager { * Creates a ticket based on the provided content. * * @param {TicketContent} content - * @return {*} {Ticket} + * @param {Snowflake} guildId + * @param {number?} maxOnGoingTicketsPerUser + * @return {Ticket} * @memberof IMailboxManager */ - createTicket(content: TicketContent): Ticket; + createTicket(content: TicketContent, guildId: Snowflake, maxOnGoingTicketsPerUser?: number): Ticket; /** * Replies to a ticket with a provided content. diff --git a/src/types/InteractionBasedMailboxManagerOptions.ts b/src/types/InteractionBasedMailboxManagerOptions.ts deleted file mode 100644 index ef94aa6..0000000 --- a/src/types/InteractionBasedMailboxManagerOptions.ts +++ /dev/null @@ -1,59 +0,0 @@ -import { - InteractionButtonComponentData, - StringSelectMenuComponentData, -} from 'discord.js'; -import { ModalOptions } from './ModalOptions'; -import { MessageBasedMailboxManagerOptions } from './MessageBasedMailboxManagerOptions'; - -export type InteractionBasedMailboxManagerOptions = { - /** - * The settings of the select menu. - * - * @type {(Exclude)} - */ - selectGuildOptions: Exclude; - - /** - * The settings of the creation button. - * - * @type {(Exclude)} - */ - createButtonOptions: Exclude< - InteractionButtonComponentData, - 'disabled' | 'customId' - >; - - /** - * The settings of the reply button. - * - * @type {(Exclude)} - */ - replyButtonOptions: Exclude< - InteractionButtonComponentData, - 'disabled' | 'customId' - >; - - /** - * The settings of the close button. - * - * @type {(Exclude)} - */ - forceCloseButtonOptions: Exclude< - InteractionButtonComponentData, - 'disabled' | 'emoji' | 'customId' - >; - - /** - * The settings for the modal forms. - * - * @type {ModalOptions} - */ - modalOptions: ModalOptions; - - /** - * The message sent when an interaction is replied. - * - * @type {string} - */ - interactionReply: string; -} & MessageBasedMailboxManagerOptions; diff --git a/src/types/InteractionOptions.ts b/src/types/InteractionOptions.ts new file mode 100644 index 0000000..b564efc --- /dev/null +++ b/src/types/InteractionOptions.ts @@ -0,0 +1,31 @@ +import { Guild, InteractionButtonComponentData } from 'discord.js'; +import { Ticket } from './Ticket'; + +export type InteractionOptions = { + /** + * A function to build the reply message. + * + */ + generateInteractionReplyMessage: (ticket: Ticket, guild: Guild) => string; + + /** + * The settings of the creation button. + * + * @type {(Exclude)} + */ + createButtonOptions: Exclude; + + /** + * The settings of the reply button. + * + * @type {(Exclude)} + */ + replyButtonOptions: Exclude; + + /** + * The settings of the close button. + * + * @type {(Exclude)} + */ + forceCloseButtonOptions?: Exclude; +}; diff --git a/src/types/LoggingOptions.ts b/src/types/LoggingOptions.ts index 4dcc397..cd19e48 100644 --- a/src/types/LoggingOptions.ts +++ b/src/types/LoggingOptions.ts @@ -1,49 +1,44 @@ -import { - BaseMessageOptions, - GuildTextBasedChannel, - Collection, - Snowflake, -} from 'discord.js'; +import { BaseMessageOptions, Snowflake } from 'discord.js'; import { Ticket } from './Ticket'; import { TicketContent } from './TicketContent'; export type LoggingOptions = { - /** - * A function to generate a filename based on a provided ticket. - * - */ - generateFilename: (ticket: Ticket) => string; + /** + * A function to generate a filename based on a provided ticket. + * + */ + generateFilename: (ticket: Ticket) => string; - /** - * A function to generate a message based on a provided ticket. - * - */ - generateMessage: (ticket: Ticket) => string | BaseMessageOptions; + /** + * A function to generate a message based on a provided ticket. + * + */ + generateMessage: (ticket: Ticket) => string | BaseMessageOptions; - /** - * A function to generate a log entry based on a provided ticket's content. - * - */ - generateLogEntry: (ticketContent: TicketContent) => string; + /** + * A function to generate a log entry based on a provided ticket's content. + * + */ + generateLogEntry: (ticketContent: TicketContent) => string; - /** - * Whether the sender names should be displayed or not. - * - * @type {boolean} - */ - showSenderNames: boolean; + /** + * Whether the sender names should be displayed or not. + * + * @type {boolean} + */ + showSenderNames: boolean; - /** - * The channel in which the logs are sent. - * - * @type {Collection} - */ - channels: Collection; + /** + * The guild channel in which the logs are sent. + * + * @type {GuildTextBasedChannel} + */ + logChannel: Snowflake; - /** - * Whether the logs should be sent in the thread or not. - * - * @type {boolean} - */ - sendInThread?: boolean; + /** + * Whether the logs should be sent in the thread or not. + * + * @type {boolean} + */ + sendInThread?: boolean; }; diff --git a/src/types/MailboxManagerOptions.ts b/src/types/MailboxManagerOptions.ts deleted file mode 100644 index 6a9a3bf..0000000 --- a/src/types/MailboxManagerOptions.ts +++ /dev/null @@ -1,35 +0,0 @@ -import { TextChannel, VoiceChannel, Snowflake, Collection } from 'discord.js'; -import { DateTime } from 'luxon'; - -export type MailboxManagerOptions = { - /** - * The mailbox channels in which the content is sent (or from which the threads are created). - * - * @type {Collection} - */ - mailboxChannels: Collection< - Snowflake, - TextChannel | VoiceChannel | Snowflake - >; - - /** - * The duration in milliseconds after a ticket's last activity before it gets closed. - * - * @type {number} - */ - closeTicketAfterInMilliseconds: number; - - /** - * The maximum number of ongoing tickets per user - * - * @type {number} - */ - maxOnGoingTicketsPerUser: number; - - /** - * The cron time for the background job in charge of checking the validity of all ongoing tickets. - * - * @type {(string | Date | DateTime)} - */ - cronTime: string | Date | DateTime; -}; diff --git a/src/types/ManagerOptions.ts b/src/types/ManagerOptions.ts new file mode 100644 index 0000000..9b6a397 --- /dev/null +++ b/src/types/ManagerOptions.ts @@ -0,0 +1,26 @@ +import { Collection, GuildResolvable, StringSelectMenuComponentData } from 'discord.js'; +import { GlobalMailboxOptions } from './GlobalMailboxOptions'; +import { PerGuildMailboxOptions } from './PerGuildMailboxOptions'; + +export type ManagerOptions = { + /** + * The settings of the select menu. + * + * @type {(Exclude)} + */ + selectGuildOptions?: Exclude; + + /** + * The global options for the mailbox manager, applied to all guilds. + * + * @type {GlobalMailboxOptions} + */ + mailboxOptions: GlobalMailboxOptions; + + /** + * The options per guild. + * + * @type {Collection} + */ + optionsPerGuild: Collection; +}; diff --git a/src/types/MessageBasedMailboxManagerOptions.ts b/src/types/MessageBasedMailboxManagerOptions.ts deleted file mode 100644 index e236704..0000000 --- a/src/types/MessageBasedMailboxManagerOptions.ts +++ /dev/null @@ -1,69 +0,0 @@ -import { EmojiIdentifierResolvable, EmbedData, Guild } from 'discord.js'; -import { LoggingOptions } from './LoggingOptions'; -import { ThreadOptions } from './ThreadOptions'; -import { Ticket } from './Ticket'; -import { MailboxManagerOptions } from './MailboxManagerOptions'; - -export type MessageBasedMailboxManagerOptions = { - /** - * The logging options - * - * @type {LoggingOptions} - */ - loggingOptions?: LoggingOptions; - - /** - * The thread options - * - * @type {ThreadOptions} - */ - threadOptions?: ThreadOptions; - - /** - * The embed options - * - * @type {EmbedData} - */ - embedOptions?: EmbedData; - - /** - * The emoji used in reaction and in button to force close a ticket. - * - * @type {string} - */ - forceCloseEmoji?: string; - - /** - * The emoji used in reaction to show the admins a ticket has received an answer. - * - * @type {EmojiIdentifierResolvable} - */ - replySentEmoji?: EmojiIdentifierResolvable; - - /** - * A function to build a ticket's title from the ticket object itself. - * - */ - formatTitle: (ticket: Ticket, guild: Guild) => string; - - /** - * The reply message - * - * @type {string} - */ - replyMessage: string; - - /** - * The prefix for threads used when a ticket is closed. - * - * @type {string} - */ - closedChannelPrefix?: string; - - /** - * The message sent to a user when they have too much ongoing tickets. - * - * @type {string} - */ - tooMuchTickets?: string; -} & MailboxManagerOptions; diff --git a/src/types/ModalOptions.ts b/src/types/ModalOptions.ts index 86084e4..a0287f3 100644 --- a/src/types/ModalOptions.ts +++ b/src/types/ModalOptions.ts @@ -1,17 +1,17 @@ import { Guild, TextInputComponentData } from 'discord.js'; export type ModalOptions = { - /** - * A function to build a modal's title from the selected guild object. - * - * @type {string} - */ - formatTitle: (guild: Guild) => string; + /** + * A function to build a modal's title from the selected guild object. + * + * @type {string} + */ + generateTitle: (guild: Guild) => string; - /** - * The modal components' settings. - * - * @type {(Exclude)} - */ - modalComponentsOptions: Exclude; + /** + * The modal components' settings. + * + * @type {(Exclude)} + */ + modalComponentsOptions: Exclude; }; diff --git a/src/types/PerGuildMailboxOptions.ts b/src/types/PerGuildMailboxOptions.ts new file mode 100644 index 0000000..769cd2b --- /dev/null +++ b/src/types/PerGuildMailboxOptions.ts @@ -0,0 +1,74 @@ +import { Guild, Snowflake, ThreadChannel, User } from 'discord.js'; +import { Ticket } from './Ticket'; +import { EmbedOptions } from './EmbedOptions'; +import { InteractionOptions } from './InteractionOptions'; +import { LoggingOptions } from './LoggingOptions'; +import { ModalOptions } from './ModalOptions'; +import { ThreadOptions } from './ThreadOptions'; + +export type PerGuildMailboxOptions = { + /** + * The settings for the modal forms. + * + * @type {ModalOptions} + */ + modalOptions: ModalOptions; + + /** + * The logging options. Do not provide if you do not want to log. + * + * @type {LoggingOptions} + */ + loggingOptions?: LoggingOptions; + + /** + * The thread options. Do not provide if you do not want to use threads. + * + * @type {ThreadOptions} + */ + threadOptions?: ThreadOptions; + + /** + * The embed options. Do not provide if you do not want to use embeds. + * + * @type {EmbedData} + */ + embedOptions?: EmbedOptions; + + /** + * The mailbox channel in which the content is sent (or from which the threads are created). + * + * @type {Snowflake} + */ + mailboxChannel: Snowflake; + + /** + * The maximum number of ongoing tickets per user for this guild. + * + * @type {number} + */ + maxOnGoingTicketsPerUser: number; + + /** + * A function to build the reply message. + * + */ + generateReplyMessage: (ticket: Ticket, guild: Guild) => string; + + /** + * A function to build a ticket's title from the ticket object itself. + * + */ + generateMessageTitle: (ticket: Ticket, guild: Guild) => string; + + /** + * A function to build the ticket's channel name when the ticket is closed. + * + */ + generateClosedChannelName: (ticket: Ticket, guild: Guild, thread?: ThreadChannel) => string; + + /** + * A function to build the message sent to a user when they have too much ongoing tickets. + */ + generateTooMuchTicketsMessage: (user: User, guild: Guild) => string; +} & InteractionOptions; diff --git a/src/types/ThreadOptions.ts b/src/types/ThreadOptions.ts index 5002af8..ba2f9f5 100644 --- a/src/types/ThreadOptions.ts +++ b/src/types/ThreadOptions.ts @@ -2,15 +2,15 @@ import { BaseMessageOptions } from 'discord.js'; import { Ticket } from './Ticket'; export type ThreadOptions = { - /** - * A function to build the thread name based on the provided ticket. - * - */ - name: (ticket: Ticket) => string; + /** + * A function to build the thread name based on the provided ticket. + * + */ + generateName: (ticket: Ticket) => string; - /** - * A function to create a start message for the thread. - * - */ - startMessage: (ticket: Ticket) => string | BaseMessageOptions; + /** + * A function to create a start message for the thread. + * + */ + generateStartMessage: (ticket: Ticket) => string | BaseMessageOptions; }; diff --git a/src/types/Ticket.ts b/src/types/Ticket.ts index dafa142..f3d5514 100644 --- a/src/types/Ticket.ts +++ b/src/types/Ticket.ts @@ -42,9 +42,15 @@ export class Ticket { */ readonly messages: TicketContent[]; + /** + * The guild in which the ticket has been created. + * + * @memberof Ticket + */ + readonly guildId: Snowflake; + + #threadId: Snowflake | null; #lastMessage!: TicketContent; - #channelId: Snowflake | null; - #guildId: Snowflake | null; #closedAt: EpochTimeStamp | null; /** @@ -77,18 +83,7 @@ export class Ticket { * @memberof Ticket */ get threadId(): Snowflake | null { - return this.#channelId; - } - - /** - * Returns the guild of the ticket, if any. - * - * @readonly - * @type {(Snowflake | null)} - * @memberof Ticket - */ - get guildId(): Snowflake | null { - return this.#guildId; + return this.#threadId; } /** @@ -96,36 +91,26 @@ export class Ticket { * @param {TicketContent} firstMessage * @memberof Ticket */ - constructor(firstMessage: TicketContent) { + constructor(firstMessage: TicketContent, guildId: Snowflake) { this.id = uuid.v4(); this.messages = []; this.createdBy = firstMessage.author; this.createdAt = firstMessage.createdTimestamp; + this.guildId = guildId; + this.#threadId = null; this.#closedAt = null; - this.#channelId = null; - this.#guildId = null; this.addMessage(firstMessage); } /** - * Sets the ticket's channel. - * - * @param {Snowflake} channelId - * @memberof Ticket - */ - setChannel(channelId: Snowflake): void { - this.#channelId = channelId; - } - - /** - * Sets the ticket's guild. + * Sets the ticket's thread channel. * - * @param {Snowflake} guildId + * @param {Snowflake} threadId * @memberof Ticket */ - setGuild(guildId: Snowflake): void { - this.#guildId = guildId; + setThreadChannel(threadId: Snowflake): void { + this.#threadId = threadId; } /** @@ -143,7 +128,7 @@ export class Ticket { * Checks if the ticket is outdated or not. * * @param {number} closeAfterInMilliseconds - * @return {*} {boolean} + * @return {boolean} * @memberof Ticket */ isOutdated(closeAfterInMilliseconds: number): boolean { diff --git a/src/types/TicketContent.ts b/src/types/TicketContent.ts index 6c2b8f2..e73981c 100644 --- a/src/types/TicketContent.ts +++ b/src/types/TicketContent.ts @@ -38,7 +38,7 @@ export type TicketContent = Pick< * @param {(Snowflake | null)} [channelId=null] * @param {(TextBasedChannel | null)} [channel=null] * @param {Collection} [attachments=new Collection()] - * @return {*} {TicketContent} + * @return {TicketContent} */ export function createTicketContent( content: string, @@ -70,7 +70,7 @@ export function createTicketContent( * * @export * @param {ModalSubmitInteraction} interaction - * @return {*} {TicketContent} + * @return {TicketContent} */ export function createTicketContentFromInteraction( interaction: ModalSubmitInteraction diff --git a/src/types/index.ts b/src/types/index.ts index f3adf7f..c4568b7 100644 --- a/src/types/index.ts +++ b/src/types/index.ts @@ -1,9 +1,11 @@ +export * from './EmbedOptions'; +export * from './GlobalMailboxOptions'; export * from './IMailboxManager'; -export * from './InteractionBasedMailboxManagerOptions'; +export * from './InteractionOptions'; export * from './LoggingOptions'; -export * from './MailboxManagerOptions'; -export * from './MessageBasedMailboxManagerOptions'; +export * from './ManagerOptions'; export * from './ModalOptions'; +export * from './PerGuildMailboxOptions'; export * from './ThreadOptions'; export * from './Ticket'; export * from './TicketContent';