diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..d0c0c4c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +* text eol=lf +*.png binary diff --git a/.github/logo.png b/.github/logo.png new file mode 100644 index 0000000..a9e3665 Binary files /dev/null and b/.github/logo.png differ diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..1927131 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,19 @@ +name: Publish +on: + push: + branches: + - main + +jobs: + publish: + runs-on: ubuntu-latest + + permissions: + contents: read + id-token: write + + steps: + - uses: actions/checkout@v4 + + - name: Publish package + run: npx jsr publish diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..efad747 --- /dev/null +++ b/.gitignore @@ -0,0 +1,133 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +.pnpm-debug.log* + +# Diagnostic reports (https://nodejs.org/api/report.html) +report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage +*.lcov + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) +web_modules/ + +# TypeScript cache +*.tsbuildinfo + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional stylelint cache +.stylelintcache + +# Microbundle cache +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variable files +.env +.env.development.local +.env.test.local +.env.production.local +.env.local + +# parcel-bundler cache (https://parceljs.org/) +.cache +.parcel-cache + +# Next.js build output +.next +out + +# Nuxt.js build / generate output +.nuxt +dist + +# Gatsby files +.cache/ +# Comment in the public line in if your project uses Gatsby and not Next.js +# https://nextjs.org/blog/next-9-1#public-directory-support +# public + +# vuepress build output +.vuepress/dist + +# vuepress v2.x temp and cache directory +.temp +.cache + +# Docusaurus cache and generated files +.docusaurus + +# Serverless directories +.serverless/ + +# FuseBox cache +.fusebox/ + +# DynamoDB Local files +.dynamodb/ + +# TernJS port file +.tern-port + +# Stores VSCode versions used for testing VSCode extensions +.vscode-test + +# yarn v2 +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +# VSCode +.vscode/* diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..8bd9510 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,6 @@ +{ + "tabWidth": 4, + "endOfLine": "lf", + "semi": true, + "printWidth": 120 +} diff --git a/Example/Main.ts b/Example/Main.ts new file mode 100644 index 0000000..1170f2f --- /dev/null +++ b/Example/Main.ts @@ -0,0 +1,105 @@ +/*! + * Callisto, a simple and powerful bot package for nin0-dev's chat server. + * Copyright (c) 2022 Kodarru and contributors. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +// ****** +// Import the necessary modules. +import { Client, type Callisto } from "../Source/Main.ts"; + +// ****** + +const client = new Client({ + Bot: { + username: "YOUR_BOT_NAME", + key: "YOUR_BOT_KEY", + // Has no use implemented yet. Leave it as an empty array. + staleMessages: [], + }, + Websocket: { + URI: "wss://guhws.nin0.dev", + Reconnect: true, + ReconnectMaxTrials: 5, + }, + LogLevel: 2, +}); + +const Log = client.Logger; +let prefix = "!"; + +// This function will be called when the Websocket is opened. +client.On("open", () => { + Log.Info("Connection established!"); + client.Send("Hello, world! My prefix is " + prefix + ". Type " + prefix + "help for a list of commands."); +}); + +// This function will be called when the Websocket receives a message. +client.On("message", (message: Callisto.Message) => { + // Will not respond to bots. + if (message.isBot()) return; + // Will not respond to itself. + if (message.isSelf()) return; + + /* + * The message object has the following functions: + * + * isMod(): boolean; - Checks if the message was sent by a admin/mod. + * isBot(): boolean; - Checks if the message was sent by a bot. + * isDiscord(): boolean; - Checks if the message was sent from Discord. + * isUser(): boolean; - Checks if the message was sent by a user. + * isSelf(): boolean; - Checks if the message was sent by the bot. + * Send(content: string): void; - Sends a message to the chat. + * Reply(content: string): void; - Replies to the user who sent the message. + */ + + // Check if the message starts with the prefix. + if (message.content?.startsWith(prefix)) { + // Split the message into an array of arguments. + // Example: !ping hello world + // Output: ["ping", "hello", "world"] + const args = message.content.slice(prefix.length).split(/ +/); + // Shift the first argument from the array. + // Example: ["ping", "hello", "world"] + // Output: "ping" + const command = args.shift()?.toLowerCase(); + + switch (command) { + case "ping": + // message.Reply will reply to the user who sent the message. + // Example: message.Reply("Pong!"); + // Output: Replying to : Pong! + message.Reply("Pong!"); + break; + case "prefix": + prefix = args[0]; + message.Reply("Prefix set to " + prefix); + break; + case "say": + // message.Send will send a message to the chat. + // Example: message.Send("Hello, world!"); + // Output: Hello, world! + // Note: This will not reply to the user. + message.Send(args.join(" ")); + break; + case "help": + message.Reply("Commands: help, ping, say, prefix"); + break; + } + } +}); + +// Connects to the Websocket server. +client.Connect(); diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ab421c0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) 2024 + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) 2024 + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..10d690c --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +
+

Callisto 🌙

+ +
+ This is what I think Callisto would look like. Made using Deno's Dinosaur Creator. +
+

Check out Releases.md for more information on v0.1.1!

+
+ +--- + +Callisto (getting it's name from Jupiter's second largest moon) is a simple, easy-to-use, and powerful Deno V2 library for creating and managing nin0chat bots. It only uses the `ws` library, everything else is built from scratch. + +## Installation 📦 + +The installation is very simple, just run the following command in your terminal: + +```bash +deno add jsr:@nin0chat/callisto +``` + +## Usage 📚 + +Here is a simple example of how to use Callisto: + +```ts +import { Client, Callisto } from "@nin0chat/callisto"; + +const client = new Client({ + Bot: { + username: "YOUR_BOT_NAME", + key: "YOUR_BOT_KEY", + staleMessages: [], + }, + Websocket: { + URI: "wss://guhws.nin0.dev", // If you're using a different server, change this. + Reconnect: true, + ReconnectMaxTrials: 5, + }, + LogLevel: 2, +}); + +const Log = client.Logger; + +// This event is called when the bot connects to the server. +client.On("open", () => { + Log.Info("Connected to the server!"); + client.Send("Hello, world!"); +}); + +// This event is called when the bot receives a message. +client.On("message", (message: Callisto.Message) => { + // This is a simple example of how to check if the message is from a bot. + if (message.isBot()) return; + + Log.Info("New message! " + message.content + " - " + message.username); +}); + +// Always put this at the end of your code (after you've registered all your events). +client.Connect(); +``` + +Was this not enough? It's okay! We have a more in-depth example [here](https://github.com/nin0chat/Callisto/tree/main/Example). + +## Documentation 📖 + +~~The documentation for Callisto can be found [here](https://github.com/nin0chat/Callisto/tree/main/Documentation).~~ There will be no documentation as of yet until the nin0chat rewrite is complete. Check out the [example](https://github.com/nin0chat/Callisto/tree/main/Example) or look at the JSDoc comments in the source code. + +## License 📜 + +This project is licensed under the GNU General Public License v3.0. You can find the license [here](https://github.com/nin0chat/Callisto/blob/main/LICENSE). diff --git a/Releases.md b/Releases.md new file mode 100644 index 0000000..7225baa --- /dev/null +++ b/Releases.md @@ -0,0 +1,39 @@ +
+

Callisto 🌙

+ +
+ This is what I think Callisto would look like. Made using Deno's Dinosaur Creator. +
+ +--- + +## Version `0.1.1` 📝 + +- Added `.Once` method. This method is the same as `.On`, but it only runs once. + - Example: + ```ts + client.Once("open", () => { + Log.Info("Connected to the server!"); + }); + ``` +- Added `.Off` method. This method is used to remove an event listener. + - Example: + ```ts + const openEvent = () => { + Log.Info("Connected to the server!"); + }; + + client.On("open", openEvent); + // This will remove the event listener. + client.Off("open", openEvent); + ``` +- Added more consistent documentation to the following files: + - `@/Main.ts` + - `@/Utilities/Types.ts` + - `@/Utilities/Logger.ts` + +Update to this version by running the following command in your terminal: + +```bash +deno upgrade jsr:@nin0chat/callisto@0.1.1 +``` diff --git a/Source/Handlers/Close.ts b/Source/Handlers/Close.ts new file mode 100644 index 0000000..fda8fb5 --- /dev/null +++ b/Source/Handlers/Close.ts @@ -0,0 +1,43 @@ +/*! + * Callisto, a simple and powerful bot package for nin0-dev's chat server. + * Copyright (c) 2022 Kodarru and contributors. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +// ****** + +import type { Client } from "@/Main.ts"; + +// ****** + +export function On_Close(client: Client) { + return () => { + client.Emit("close", client); + + if (client.DisconnectIntentional) return; + + client.Logger.Warning("Connection closed unexpectedly. Attempting to reconnect..."); + + if (client.ReconnectAttempts >= client.WebsocketData.ReconnectMaxTrials) { + // prettier-ignore + client.Logger.Error("Unable to establish a connection with the server. Tried reconnecting " + client.ReconnectAttempts + " times."); + return; + } + + client.ReconnectAttempts++; + client.Logger.Info("Starting reconnect attempt " + (client.ReconnectAttempts + 1) + "..."); + client.Connect(); + }; +} diff --git a/Source/Handlers/Error.ts b/Source/Handlers/Error.ts new file mode 100644 index 0000000..7f5b36b --- /dev/null +++ b/Source/Handlers/Error.ts @@ -0,0 +1,30 @@ +/*! + * Callisto, a simple and powerful bot package for nin0-dev's chat server. + * Copyright (c) 2022 Kodarru and contributors. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +// ****** + +import type { Client } from "@/Main.ts"; + +// ****** + +export function On_Error(error: string, client: Client) { + return () => { + client.Emit("error"); + client.Logger.Error("An unexpected error occurred! " + error); + }; +} diff --git a/Source/Handlers/Message.ts b/Source/Handlers/Message.ts new file mode 100644 index 0000000..32d59b9 --- /dev/null +++ b/Source/Handlers/Message.ts @@ -0,0 +1,74 @@ +/*! + * Callisto, a simple and powerful bot package for nin0-dev's chat server. + * Copyright (c) 2022 Kodarru and contributors. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +// ****** + +import type { Client } from "@/Main.ts"; +import type * as Callisto from "@/Utilities/Types.ts"; +import * as Constants from "@/Utilities/Constants.ts"; + +// ****** + +export function On_Message(data: any, client: Client) { + client.Logger.Debug("Received new message"); + + const _data = JSON.parse(data.toString()); + + const patchedMessage = { + username: _data.username, + content: _data.content, + role: _data.role, + isMod: function () { + return _data.role === Constants.Roles.Admin; + }, + isBot: function () { + return _data.role === Constants.Roles.Bot; + }, + isDiscord: function () { + return _data.role === Constants.Roles.Discord; + }, + isUser: function () { + return _data.role === Constants.Roles.User; + }, + isSelf: function () { + return _data.username === client.ClientData.username; + }, + Send: function (content: string) { + client.Send(content); + }, + Reply: function (content: string) { + client.Send("Replying to " + _data.username + ": " + content); + }, + }; + + /* + if (data.op === 10) { + client.Logger.Info("Found stale messages."); + + data.messages?.forEach((message: Callisto.Message) => { + message.user = data.username; + message.stale = true; + client.StaleMessages.push(message); + }); + + return; + } + */ + + client.Emit("message", patchedMessage); +} diff --git a/Source/Handlers/Open.ts b/Source/Handlers/Open.ts new file mode 100644 index 0000000..8575e4a --- /dev/null +++ b/Source/Handlers/Open.ts @@ -0,0 +1,29 @@ +/*! + * Callisto, a simple and powerful bot package for nin0-dev's chat server. + * Copyright (c) 2022 Kodarru and contributors. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +// ****** + +import type { Client } from "@/Main.ts"; + +// ****** + +export function On_Open(client: Client) { + return () => { + client.Emit("open"); + }; +} diff --git a/Source/Main.ts b/Source/Main.ts new file mode 100644 index 0000000..3235cf2 --- /dev/null +++ b/Source/Main.ts @@ -0,0 +1,272 @@ +/*! + * Callisto, a simple and powerful bot package for nin0-dev"s chat server. + * Copyright (c) 2022 Kodarru and contributors. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +// ****** +// Import all the necessary modules. +import Websocket from "ws"; +import { Logging } from "@/Utilities/Logging.ts"; +import * as Callisto from "@/Utilities/Types.ts"; + +// Import the handlers. +import { On_Open } from "@/Handlers/Open.ts"; +import { On_Close } from "@/Handlers/Close.ts"; +import { On_Message } from "@/Handlers/Message.ts"; + +// ***** +// Export types +export * as Callisto from "@/Utilities/Types.ts"; + +/** + * The main client class for Callisto. + * + * Example usage: + * + * ```typescript + * const client = new Client({ + * Bot: { + * username: "Ko-Ko", + * key: "xxx", + * staleMessages: [] + * }, + * Websocket: { + * URI: "wss://guhws.nin0.dev", + * Reconnect: true, + * ReconnectMaxTrials: 5 + * }, + * LogLevel: 2 + * }); + * ``` + * + * @param {Callisto.ClientData} Bot - The client data. + * ```json + * { + * username: "", + * key: "", + * staleMessages: [] + * } + * ``` + * @param {Callisto.WebsocketData} Websocket - The websocket data. + * ```json + * { + * URI: "", + * Reconnect: true, + * ReconnectMaxTrials: 5 + * } + * @param {1 | 2 | 3 | 4} [LogLevel=2] - The logging level. Defaults to 2. + * @returns {void} + */ + +export class Client { + // Properties for the client class. (Required) + private WS: Websocket; + public Logger: Logging; + public ClientData: Callisto.ClientData; + public WebsocketData: Callisto.WebsocketData; + + // Other properties. + public ReconnectAttempts: number = 0; + public DisconnectIntentional: boolean = false; + + // Handlers are used for event handling. They are arrays of strings and functions. + // The strings are the event names, and the functions are the event handlers. + private Handlers: Array<(string | Function)[]>; + + // OnceHandlers are used for one-time event handling. They are arrays of strings, functions, and booleans. + // The boolean is used to determine whether the event handler has been run. + private OnceHandlers: Array<(string | Function | boolean)[]>; + + // Constructor for the Client class. + constructor({ + Bot, + Websocket, + LogLevel = 2, + }: { + Bot: Callisto.ClientData; + Websocket: Callisto.WebsocketData; + LogLevel?: 1 | 2 | 3 | 4; + }) { + this.Logger = new Logging(LogLevel); + this.Logger.Debug("Starting client... may take a bit."); + + // Set the client data and websocket data. + this.ClientData = Bot; + this.WebsocketData = Websocket; + this.Handlers = []; + this.OnceHandlers = []; + } + + /** + * Connect to the websocket server. + * **This function should ONLY be called after you have registered all of your event handlers.** + * Not doing so may result in missed events. + * @returns {boolean} - Whether the connection was successful. + */ + + public Connect(): boolean { + this.Logger.Info("Attempting to connect to the server..."); + + try { + this.Logger.Debug("Connecting to the server..."); + this.WS = new Websocket(this.WebsocketData.URI); + this.RegisterHandlers(); + this.Logger.Info("Connected to the server."); + } catch (error) { + this.Logger.Error(`An error occurred while connecting to the server: ${error}`); + return false; + } + + return true; + } + + // Register the package"s event handlers. + private RegisterHandlers(): void { + this.Logger.Debug("Registering event handlers..."); + this.WS.on("open", On_Open(this)); + this.WS.on("close", On_Close(this)); + this.WS.on("message", (data: Callisto.Message) => On_Message(data, this)); + } + + /** + * Sends a message to the websocket connection. + * + * @param {string} message - The message to send. + * @param {boolean} [raw=false] - Whether to send the message as raw data. Defaults to false. + * @returns {void} + */ + + public Send(message: string, raw: boolean = false): void { + if (raw) { + this.Logger.Debug(`Sending RAW message: ${message}`); + this.WS.send(message); + return; + } + + this.Logger.Debug(`Sending message: ${message}`); + + const data = JSON.stringify({ + content: message, + username: this.ClientData.username, + key: this.ClientData.key, + }); + + this.WS.send(data); + } + + /** + * Get stale messages cached by the client. + * @returns {Array} - An array of stale messages + */ + + public get StaleMessages(): Callisto.Message[] { + this.Logger.Debug("Retrieving stale messages..."); + return this.ClientData.staleMessages; + } + + /** + * Listen for an event and run a function when it is emitted. + * @param event The event to listen for. + * @param handler The function to run when the event is emitted. + * @returns {void} + */ + public On(event: string, handler: Function): void { + this.Logger.Debug(`New event handler registered for event ${event}.`); + this.Handlers.push([event, handler]); + } + + /** + * Listen for an event and run a function when it is emitted. The function will only run once. + * @param event The event to listen for. + * @param handler The function to run when the event is emitted. + * @returns {void} + */ + public Once(event: string, handler: Function): void { + this.Logger.Debug(`New one-time event handler registered for event ${event}.`); + this.OnceHandlers.push([event, handler, false]); + } + + /** + * Remove an event handler. + * + * @param event The event to remove the handler from. + * @param handler The handler to remove. + * @returns {void} + */ + + public Off(event: string, handler: Function): void { + this.Logger.Debug(`Removing event handler for event ${event}.`); + + this.Handlers = this.Handlers.filter((h) => { + return h[0] !== event || h[1] !== handler; + }); + + this.OnceHandlers = this.OnceHandlers.filter((h) => { + return h[0] !== event || h[1] !== handler; + }); + } + + /** + * Emit an event. + * @param event The event to emit. + * @param args The arguments to pass to the event handler. + * @returns {void} + */ + + public Emit(event: string, ...args: any[]): void { + this.Logger.Debug(`Emitting event ${event}.`); + + this.Handlers.forEach((handler) => { + if (handler[0] === event && typeof handler[1] === "function") { + handler[1](...args); + } + }); + + this.OnceHandlers.forEach((handler) => { + if (handler[0] === event && typeof handler[1] === "function" && !handler[2]) { + handler[1](...args); + handler[2] = true; + } + }); + } + + /** + * Discards all event handlers. + * @returns {void} + */ + + public ClearHandlers(): void { + this.Logger.Debug("Clearing all event handlers..."); + this.Handlers = []; + } + + /** + * Disconnect from the websocket server. + * @returns {void} + */ + public Disconnect(): void { + this.Logger.Info("Attempting to disconnect from the server..."); + this.ClearHandlers(); + + if (this.WS.readyState === Websocket.OPEN) { + this.WS.close(); + this.DisconnectIntentional = true; + this.Logger.Info("Disconnected from the server."); + } else { + this.Logger.Warning("Could not disconnect from the server. Is the websocket connected?"); + } + } +} diff --git a/Source/Utilities/Constants.ts b/Source/Utilities/Constants.ts new file mode 100644 index 0000000..dde8b80 --- /dev/null +++ b/Source/Utilities/Constants.ts @@ -0,0 +1,36 @@ +/*! + * Callisto, a simple and powerful bot package for nin0-dev's chat server. + * Copyright (c) 2022 Kodarru and contributors. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +// ****** + +export const NewC_Roles = { + Guest: 1 << 6, + User: 1 << 7, + Bot: 1 << 8, + System: 1 << 10, + Mod: 1 << 11, + Admin: 1 << 12, +}; + +//! When nin0 rewrites the chat server, the roles will be updated to match the NewC_Roles object. +export const Roles = { + User: 0, + Admin: 2, + Discord: 3, + Bot: 12, +}; diff --git a/Source/Utilities/Logging.ts b/Source/Utilities/Logging.ts new file mode 100644 index 0000000..47e7be0 --- /dev/null +++ b/Source/Utilities/Logging.ts @@ -0,0 +1,130 @@ +/*! + * Callisto, a simple and powerful bot package for nin0-dev's chat server. + * Copyright (c) 2022 Kodarru and contributors. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +// ****** + +/** + * Logging class for logging messages to the console with user-defined log levels. + * + * ```typescript + * const Log = new Logging(1); + * Log.Log("This is a debug message.", "Debug"); + * Log.Log("This is an info message.", "Info"); + * Log.Log("This is a warning message.", "Warning"); + * Log.Log("This is an error message.", "Error"); + * ``` + * + * All of the above log messages will be logged to the console. The log level is set to 1 (Debug), so all messages will be logged. + * If the log level was set to 2 (Info), only the info, warning, and error messages would be logged. + * + * @class Logging + * @constructor Defines the log level. Defaults to 2 (Info). + * @method Log Logs a message to the console with the specified log level. Will only log messages with a log level equal to or higher than the current log level. + * @method Debug Logs a debug message to the console. + * @method Info Logs an info message to the console. + * @method Warning Logs a warning message to the console. + * @method Error Logs an error message to the console. + * @property LogLevel The log level. Defaults to 2 (Info). + */ + +export class Logging { + /** + * The log level. + * + * @type {1 | 2 | 3 | 4} + * @default 2 + */ + + public LogLevel: 1 | 2 | 3 | 4; + + private Colors = { + Reset: "\x1b[0m", + Dim: "\x1b[2m", + FgRed: "\x1b[31m", + FgYellow: "\x1b[33m", + FgBlue: "\x1b[34m", + }; + + private LogLevels: { + [key in "Debug" | "Info" | "Warning" | "Error"]: { + Level: number; + Color: string; + }; + } = { + Debug: { + Level: 1, + Color: this.Colors.Dim, + }, + Info: { + Level: 2, + Color: this.Colors.FgBlue, + }, + Warning: { + Level: 3, + Color: this.Colors.FgYellow, + }, + Error: { + Level: 4, + Color: this.Colors.FgRed, + }, + }; + + /** + * Constructor for the Logging class. + * + * @param {1 | 2 | 3 | 4} [logLevel=2] The log level. Defaults to 2. + * @returns {void} + */ + + constructor(logLevel?: 1 | 2 | 3 | 4) { + this.LogLevel = logLevel || 2; + } + + /** + * Logs a message to the console with the specified log level. + * + * @param {string} message The message to log. + * @param {"Debug" | "Info" | "Warning" | "Error"} level The log level. + * @returns {void} + */ + + public Log(message: string, level: "Debug" | "Info" | "Warning" | "Error") { + if (this.LogLevels[level].Level >= this.LogLevel) { + const logLevel = this.LogLevels[level]; + const timestamp = new Date().toISOString(); + + console.log(`${logLevel.Color}[${level.toUpperCase()}]${this.Colors.Reset} (${timestamp}): ${message}`); + } + } + + public Debug(message: string) { + this.Log(message, "Debug"); + } + + public Info(message: string) { + this.Log(message, "Info"); + } + + public Warning(message: string) { + this.Log(message, "Warning"); + } + + public Error(message: string) { + this.Log(message, "Error"); + } +} diff --git a/Source/Utilities/Types.ts b/Source/Utilities/Types.ts new file mode 100644 index 0000000..a0cb908 --- /dev/null +++ b/Source/Utilities/Types.ts @@ -0,0 +1,95 @@ +/*! + * Callisto, a simple and powerful bot package for nin0-dev's chat server. + * Copyright (c) 2022 Kodarru and contributors. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +// ****** + +/** + * + * The message object that is received from the chat server. + * + * @interface Message + * @property {string} content - The content of the message. + * @property {string} username - The username of the sender. + * @property {number} role - The role of the sender. + * @property {number} op (may not exist) - The op status of the sender. + * @property {Message[]} messages (may not exist) - The list of messages that were sent before the bot was started. + * @property {string} user (may not exist) - The user that sent the message. + * @property {boolean} stale (may not exist) - When a message is declared as stale, it means it is not a new message and was sent before the bot was started. + * @property {function} isMod - Checks if the message was sent by a admin/mod. + * @property {function} isBot - Checks if the message was sent by a bot. + * @property {function} isDiscord - Checks if the message was sent by Discord. + * @property {function} isUser - Checks if the message was sent by a user. + * @property {function} isSelf - Checks if the message was sent by the bot itself. + * @property {function} Send - Sends a message to the chat server. + * @property {function} Reply - Replies to the message. + */ + +export interface Message { + content: string; + username: string; + role: number; + op?: number; + + //? The list of messages that were sent before the bot was started. + messages?: Message[]; + + //! Will be deprecated with the new chat server. Only needed for previous messages. + user?: string; + + //? When a message is declared as stale, it means it is not a new message and was sent before the bot was started. + stale?: boolean; + + //? When a message is received, it will be patched with the following functions. + isMod(): boolean; + isBot(): boolean; + isDiscord(): boolean; + isUser(): boolean; + isSelf(): boolean; + Send(content: string): void; + Reply(content: string): void; +} + +/** + * The client data object. + * + * @interface ClientData + * @property {string} username - The username of the bot. + * @property {string} key - The key of the bot. + * @property {Message[]} staleMessages - The list of messages that were sent before the bot was started. + */ + +export interface ClientData { + username: string; + key: string; + staleMessages: Message[]; +} + +/** + * The websocket data object. + * + * @interface WebsocketData + * @property {string} URI - The URI of the websocket server. + * @property {boolean} Reconnect - Whether to reconnect to the server. + * @property {number} ReconnectMaxTrials - The maximum number of trials to reconnect to the server. Set to 0 if you already set reconnect to false. + */ + +export interface WebsocketData { + URI: string; + Reconnect: boolean; + ReconnectMaxTrials: number; +} diff --git a/deno.json b/deno.json new file mode 100644 index 0000000..6371f15 --- /dev/null +++ b/deno.json @@ -0,0 +1,10 @@ +{ + "name": "@nin0chat/callisto", + "version": "0.1.1", + "exports": "./Source/Main.ts", + "imports": { + "@std/assert": "jsr:@std/assert@1", + "ws": "npm:ws@^8.18.0", + "@/": "./Source/" + } +} diff --git a/deno.lock b/deno.lock new file mode 100644 index 0000000..1c198f9 --- /dev/null +++ b/deno.lock @@ -0,0 +1,30 @@ +{ + "version": "4", + "specifiers": { + "jsr:@std/assert@1": "1.0.6", + "jsr:@std/internal@^1.0.4": "1.0.4", + "npm:ws@^8.18.0": "8.18.0" + }, + "jsr": { + "@std/assert@1.0.6": { + "integrity": "1904c05806a25d94fe791d6d883b685c9e2dcd60e4f9fc30f4fc5cf010c72207", + "dependencies": [ + "jsr:@std/internal" + ] + }, + "@std/internal@1.0.4": { + "integrity": "62e8e4911527e5e4f307741a795c0b0a9e6958d0b3790716ae71ce085f755422" + } + }, + "npm": { + "ws@8.18.0": { + "integrity": "sha512-8VbfWfHLbbwu3+N6OKsOMpBdT4kXPDDB9cJk2bJ6mh9ucxdlnNvH1e+roYkKmN9Nxw2yjz7VzeO9oOz2zJ04Pw==" + } + }, + "workspace": { + "dependencies": [ + "jsr:@std/assert@1", + "npm:ws@^8.18.0" + ] + } +}