.eslintrc.js

@@ -0,0 +1,27 @@
+module.exports = {
+    env: {
+        node: true,
+    },
+    // Specify the parser for TypeScript
+    parser: "@typescript-eslint/parser",
+    parserOptions: {
+        ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
+        sourceType: "module", // Allows for the use of imports
+    },
+    // existing ESLint configuration
+    extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:prettier/recommended", // Adds the Prettier plugin
+    ],
+    plugins: ['@typescript-eslint', 'prettier'],
+    rules: {
+        "prettier/prettier": "error", // Displays Prettier errors as ESLint errors
+        prefer_const: "warn", // prefers using "const" for variables that are not reassigned
+        no_var: "error", // disallows the use of "var", must use "let" or "const" only
+
+        // TS rules
+        "@typescript-eslint/no-explicit-any": "warn", // Warns when using "any" type
+        "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }], // warns against any used variables except those prefixed with "_"
+    },
+};

.prettierrc

@@ -0,0 +1,13 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": false,
+  "quoteProps": "as-needed",
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}

CONTRIBUTING.md

@@ -0,0 +1,123 @@
+# Contributing to LOC's Community Relations Alpha Edition System
+
+Thank you for considering contributing to this project! Your contributions are highly valued, and we’re excited to collaborate with you.
+
+This guide outlines the process for contributing code, reporting issues, and adhering to code quality standards using **ESLint** and **Prettier**.
+
+---
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+    - [Fork and Clone](#fork-and-clone)
+    - [Install Dependencies](#install-dependencies)
+- [Code Standards](#code-standards)
+    - [ESLint](#eslint)
+    - [Prettier](#prettier)
+- [Making Your Changes](#making-your-changes)
+    - [Running Tests](#running-tests)
+    - [Linting and Formatting](#linting-and-formatting)
+- [Submitting a Pull Request](#submitting-a-pull-request)
+- [Getting Help](#getting-help)
+
+---
+
+## Getting Started
+### Fork and Clone
+
+1. **Fork the Repository**: Click the "Fork" button at the top of this repository to create your own fork.
+
+2. **Clone Your Fork**: Clone the repository to your local environment.
+
+   `git clone https://git.site.com/your-username/project-name.git`
+
+3. **Navigate to the Project Directory**:
+
+   `cd project-name`
+
+### Install Dependencies
+To install all necessary project dependencies, run:
+`npm install`
+
+---
+
+## Code Standards
+
+### System Requirements
+
+- Node.js v18 or higher
+- MongoDB 4.x or higher
+- Redis
+
+We use **ESLint** for linting and **Prettier** for consistent code formatting. Please ensure your code follows these standards.
+
+### ESLint
+
+ESLint is configured to catch potential errors and enforce coding standards.
+
+- **Configuration File**: eslint.config.mjs
+- **Plugins**: Includes @typescript-eslint for TypeScript-specific rules and prettier to ensure Prettier rules are respected.
+
+### Prettier
+
+Prettier is used for automatic code formatting to maintain a consistent style across the codebase.
+
+- **Configuration File**: .prettierrc
+- **Integration**: Integrated with ESLint, so running eslint will also check for Prettier formatting issues.
+
+---
+
+## Making Your Changes
+
+1. **Create a Branch**: Create a new branch for your work.
+
+   git checkout -b feature/your-feature-name
+
+2. **Make Your Changes**: Edit files, add features, or fix bugs as needed.
+
+3. **Run Tests**: Ensure all tests pass.
+   
+   *Tests may not be active for the project, please check with Maintainer.*
+
+   `npm test`
+
+4. **Linting and Formatting**: Run ESLint and Prettier before committing.
+
+   `npm run lint`
+   `npm run format`
+
+To automatically fix linting issues:
+   `npm run lint:fix`
+
+### Git Hooks
+
+We use **Husky** and **lint-staged** to automate linting and formatting checks before each commit. Install these with:
+
+`npm run prepare`
+
+This will set up Git hooks to automatically check your code before committing.
+
+---
+
+## Submitting a Pull Request
+
+1. **Push to Your Fork**:
+
+   git push origin feature/your-feature-name
+
+2. **Open a Pull Request**:
+    - Go to the original repository on Git.
+    - Click on **New Pull Request**.
+    - Select your branch and provide a clear description of your changes.
+
+3. **Address Feedback**: The project maintainers may review and provide feedback. Please address any requested changes.
+
+---
+
+## Getting Help
+
+If you have questions or need assistance, feel free to reach out by opening an issue. We're here to help!
+
+This project is managed and maintained by the __Library of Code Department of Engineering__. We can be reached in our [Discord server](https://loc.sh/discord) or via [Email](mailto:engineering@libraryofcode.org).
+
+Thank you for contributing!

LICENSE

@@ -0,0 +1,661 @@
+ GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are 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.
+
+  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.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  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 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 work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero 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 Affero 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 Affero 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 Affero 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.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  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 AGPL, see
+<https://www.gnu.org/licenses/>.

README.md

@@ -0,0 +1,91 @@
+# Community Relations Alpha Edition System - CRRA
+
+[![License](https://img.shields.io/badge/license-AGPLv3-blue.svg)](LICENSE)
+
+A brief description of what your project does, what problem it solves, and why it’s useful.
+
+---
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Features](#features)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
+
+---
+
+## Installation
+
+### Prerequisites
+
+Ensure you have the following installed:
+- [Node.js](https://nodejs.org/) (version 18 or higher)
+- [Redis](https://redis.io/)
+- [MongoDB](https://www.mongodb.com/)
+
+### Steps
+
+1. **Clone the Repository**
+
+2. **Install Dependencies**
+
+   `npm install`
+
+3. **Environment Setup**
+
+   Configure environment variables (if any) in a .env file in the root directory.
+
+---
+
+## Usage
+
+1. **Run the Application**
+
+   `npm start`
+
+2. **Run Tests (if available)**
+
+   `npm test`
+
+---
+
+## Features
+TODO:
+
+- Briefly describe each main feature, such as:
+    - **Feature 1** - Describe the feature.
+    - **Feature 2** - Describe the feature.
+    - **Feature 3** - Describe the feature.
+
+---
+
+## Contributing
+
+We welcome contributions! To get started, please read our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute.
+
+1. Fork the repository.
+2. Create a branch (git checkout -b feature/feature-name).
+3. Commit your changes (git commit -m "Added a feature").
+4. Push the branch (git push origin feature-name).
+5. Open a Pull Request.
+
+---
+
+## License
+
+This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
+
+---
+
+## Contact
+
+For any questions, suggestions, or feedback, please contact:
+__Library of Code Department of Engineering__ @:
+- [Discord server](https://loc.sh/discord)
+- [Email](mailto:engineering@libraryofcode.org)
+---
+
+Thank you for checking out CRRA!

database/CommunityReport.ts

@@ -1,42 +1,46 @@
-import { prop, getModelForClass, Ref } from "@typegoose/typegoose"
+import { prop, getModelForClass, Ref } from "@typegoose/typegoose";
-import Member, { MemberAdditionalAcknowledgement, MemberUsedLanguages, MemberUsedOperatingSystems } from "./Member";
+import Member, {
+  MemberAdditionalAcknowledgement,
+  MemberUsedLanguages,
+  MemberUsedOperatingSystems,
+} from "./Member";
 
 export enum GenerationMethod {
-    TIMER_INTERNAL, // generated by the internal cron-job timer automatically
+  TIMER_INTERNAL, // generated by the internal cron-job timer automatically
-    INQUIRY_INTERNAL, // internal inquiry generated internally directly through the system. user checks their own inquiry, hard inquiry is performed by a staff member, etc.
+  INQUIRY_INTERNAL, // internal inquiry generated internally directly through the system. user checks their own inquiry, hard inquiry is performed by a staff member, etc.
-    INQUIRY_EXTERNAL, // external inquiry generated externally through the system via an external authorized request, such as via EDS
+  INQUIRY_EXTERNAL, // external inquiry generated externally through the system via an external authorized request, such as via EDS
 }
 
 export interface AddtlScoreData {
-    activity: number;
+  activity: number;
-    roles: number;
+  roles: number;
-    moderation: number;
+  moderation: number;
-    cloudServices: number;
+  cloudServices: number;
-    misc: number;
+  misc: number;
 }
 
 /* TODO
-* Comments
+ * Comments
-* Further attributes for class
+ * Further attributes for class
-* */
+ * */
 
 export default class CommunityReport {
-    @prop({ required: true, index: true, ref: () => Member })
+  @prop({ required: true, index: true, ref: () => Member })
-    // the member on which this report was generated for
+  // the member on which this report was generated for
-    public member: Ref<Member> | undefined;
+  public member: Ref<Member> | undefined;
 
-    @prop({ required: true })
+  @prop({ required: true })
-    // the date in which this report was generated on
+  // the date in which this report was generated on
-    public date: Date | undefined;
+  public date: Date | undefined;
 
-    @prop({ required: true })
+  @prop({ required: true })
-    // the CommScore of the member specified
+  // the CommScore of the member specified
-    public score: number | undefined;
+  public score: number | undefined;
 
-    @prop({ required: true })
+  @prop({ required: true })
-    // the method in which this report was generated under
+  // the method in which this report was generated under
-    public generationMethod: GenerationMethod | undefined;
+  public generationMethod: GenerationMethod | undefined;
 
-    @prop({ required: true })
+  @prop({ required: true })
-    public additionalScoreData: AddtlScoreData | undefined;
+  public additionalScoreData: AddtlScoreData | undefined;
 }

database/HardInquiry.ts

@@ -1,4 +1,4 @@
-import { prop, getModelForClass, Ref } from "@typegoose/typegoose"
+import { prop, getModelForClass, Ref } from "@typegoose/typegoose";
 import Inquiry from "./Inquiry";
 
 /**
@@ -6,6 +6,6 @@ import Inquiry from "./Inquiry";
  * Structure is performed this way to have two separate collections for Hard and Soft inquiries.
  */
 export default class HardInquiry extends Inquiry {
-    @prop({ required: true })
+  @prop({ required: true })
-    public reason: string | undefined;
+  public reason: string | undefined;
 }

database/Inquiry.ts

@@ -1,6 +1,6 @@
-import { prop, getModelForClass, Ref } from "@typegoose/typegoose"
+import { prop, getModelForClass, Ref } from "@typegoose/typegoose";
 import Member from "./Member";
-import CommunityReport from "./CommunityReport"
+import CommunityReport from "./CommunityReport";
 
 /**
  * TODO:
@@ -9,29 +9,28 @@ import CommunityReport from "./CommunityReport"
  * - Reason
  */
 
-
 export default abstract class Inquiry {
-    @prop({ required: true, unique: true })
+  @prop({ required: true, unique: true })
-    // the Inquiry Identifier (previously known as `iid`). this is an UUIDv4 string
+  // the Inquiry Identifier (previously known as `iid`). this is an UUIDv4 string
-    public id: string | undefined;
+  public id: string | undefined;
 
-    @prop({ required: true, index: true, ref: () => Member })
+  @prop({ required: true, index: true, ref: () => Member })
-    // the member on which this inquiry was performed on
+  // the member on which this inquiry was performed on
-    public member: Ref<Member> | undefined;
+  public member: Ref<Member> | undefined;
 
-    @prop({ required: true })
+  @prop({ required: true })
-    // the date in which this inquiry was performed
+  // the date in which this inquiry was performed
-    public date: Date | undefined;
+  public date: Date | undefined;
 
-    @prop({ required: true, ref: () => Member })
+  @prop({ required: true, ref: () => Member })
-    // the reference to the member who initiated this inquiry or a string value representing the name of a system that initiated the inquiry
+  // the reference to the member who initiated this inquiry or a string value representing the name of a system that initiated the inquiry
-    public initiatedBy: Ref<Member> | string | undefined;
+  public initiatedBy: Ref<Member> | string | undefined;
 
-    @prop({ required: true, ref: () => CommunityReport })
+  @prop({ required: true, ref: () => CommunityReport })
-    // the report that was generated or fetched from this inquiry as of current date
+  // the report that was generated or fetched from this inquiry as of current date
-    public report: Ref<CommunityReport> | undefined;
+  public report: Ref<CommunityReport> | undefined;
 
-    @prop()
+  @prop()
-    // a reason for the inquiry, if applicable. this value is required for HardInquiry
+  // a reason for the inquiry, if applicable. this value is required for HardInquiry
-    public reason: string | "N/A" | undefined;
+  public reason: string | "N/A" | undefined;
 }

database/Member.ts

@@ -1,88 +1,87 @@
-import { prop, getModelForClass } from "@typegoose/typegoose"
+import { prop, getModelForClass } from "@typegoose/typegoose";
 
 /* TODO
-* Comments
+ * Comments
-* Further attributes for class
+ * Further attributes for class
-* */
+ * */
 
 export interface SharedMemberAttributes {
-    discordID: string | undefined;
+  discordID: string | undefined;
 }
 
 export type MemberAdditionalAcknowledgement =
-    "Chair of the Board of Governors" |
+  | "Chair of the Board of Governors"
-    "Vice Chair of the Board of Governors" |
+  | "Vice Chair of the Board of Governors"
-    "Voting Seat Member of the Board of Governors" |
+  | "Voting Seat Member of the Board of Governors"
-    string;
+  | string;
 
 export const MemberGuildRoleIDMap = {
-    // Chair/Vice Chair of the Board of Governors
+  // Chair/Vice Chair of the Board of Governors
-    CHAIR_OR_VICE_OF_BOARD: "608394038466445320",
+  CHAIR_OR_VICE_OF_BOARD: "608394038466445320",
-    // Management
+  // Management
-    MANAGEMENT: "1077646568091570236",
+  MANAGEMENT: "1077646568091570236",
-    // Director of Operations
+  // Director of Operations
-    DIRECTOR_OF_OPERATIONS: "1077647072163020840",
+  DIRECTOR_OF_OPERATIONS: "1077647072163020840",
-    // Director of Engineering
+  // Director of Engineering
-    DIRECTOR_OF_ENGINEERING: "1077646956890951690",
+  DIRECTOR_OF_ENGINEERING: "1077646956890951690",
-    // Board of Governors
+  // Board of Governors
-    BOARD_OF_GOVERNORS: "662163685439045632",
+  BOARD_OF_GOVERNORS: "662163685439045632",
-    // Project Manager
+  // Project Manager
-    PROJECT_MANAGER: "1077647157928132711",
+  PROJECT_MANAGER: "1077647157928132711",
-    // Services Manager
+  // Services Manager
-    SERVICES_MANAGER: "1077647467056742482",
+  SERVICES_MANAGER: "1077647467056742482",
-    // Staff
+  // Staff
-    STAFF: "446104438969466890",
+  STAFF: "446104438969466890",
-    // Technician
+  // Technician
-    TECHNICIAN: "701454780828221450",
+  TECHNICIAN: "701454780828221450",
-    // Moderator
+  // Moderator
-    MODERATOR: "455972169449734144",
+  MODERATOR: "455972169449734144",
-    // Core Team
+  // Core Team
-    CORE_TEAM: "453689940140883988",
+  CORE_TEAM: "453689940140883988",
-    // Intern (Training)
+  // Intern (Training)
-    INTERN: "701481967149121627",
+  INTERN: "701481967149121627",
-
+};
-}
 
 // enum for the used programming languages in whois information
 export enum MemberUsedLanguages {
-    ASM = "lang-asm",
+  ASM = "lang-asm",
-    CFAM = "lang-cfam",
+  CFAM = "lang-cfam",
-    CSHARP = "lang-csharp",
+  CSHARP = "lang-csharp",
-    GO = "lang-go",
+  GO = "lang-go",
-    JAVA = "lang-java",
+  JAVA = "lang-java",
-    JS = "lang-js",
+  JS = "lang-js",
-    KT = "lang-kt",
+  KT = "lang-kt",
-    PY = "lang-py",
+  PY = "lang-py",
-    RB = "lang-rb",
+  RB = "lang-rb",
-    RS = "lang-rs",
+  RS = "lang-rs",
-    SWIFT = "lang-swift",
+  SWIFT = "lang-swift",
-    TS = "lang-ts"
+  TS = "lang-ts",
 }
 
 // enum for the used operating systems in the whois information
 export enum MemberUsedOperatingSystems {
-    ARCH = "os-arch",
+  ARCH = "os-arch",
-    DEB = "os-deb",
+  DEB = "os-deb",
-    CENT = "os-cent",
+  CENT = "os-cent",
-    FEDORA = "os-fedora",
+  FEDORA = "os-fedora",
-    MDARWIN = "os-mdarwin",
+  MDARWIN = "os-mdarwin",
-    MANJARO = "os-manjaro",
+  MANJARO = "os-manjaro",
-    REDHAT = "os-redhat",
+  REDHAT = "os-redhat",
-    UBUNTU = "os-ubuntu",
+  UBUNTU = "os-ubuntu",
-    WIN = "os-win"
+  WIN = "os-win",
 }
 export default class Member implements SharedMemberAttributes {
-    @prop({ required: true, unique: true })
+  @prop({ required: true, unique: true })
-    public discordID: string | undefined;
+  public discordID: string | undefined;
 
-    @prop()
+  @prop()
-    public usedOperatingSystems: MemberUsedOperatingSystems[] | undefined;
+  public usedOperatingSystems: MemberUsedOperatingSystems[] | undefined;
 
-    @prop()
+  @prop()
-    public usedLanguages: MemberUsedLanguages[] | undefined;
+  public usedLanguages: MemberUsedLanguages[] | undefined;
 
-    @prop()
+  @prop()
-    public additionalAcknowledgement: MemberAdditionalAcknowledgement[] | undefined;
+  public additionalAcknowledgement: MemberAdditionalAcknowledgement[] | undefined;
 }
 
 export const MemberModel = getModelForClass(Member);

database/Partner.ts

@@ -2,72 +2,71 @@ import { prop, getModelForClass } from "@typegoose/typegoose";
 import Member from "./Member";
 
 /* TODO
-* Comments
+ * Comments
-* Further attributes for class
+ * Further attributes for class
-* */
+ * */
 
 import { SharedMemberAttributes } from "./Member";
 
 export type PartnerTitle =
-    "Director of Engineering" |
+  | "Director of Engineering"
-    "Director of Operations" |
+  | "Director of Operations"
-    "Deputy Director of Engineering" |
+  | "Deputy Director of Engineering"
-    "Deputy Director of Operations" |
+  | "Deputy Director of Operations"
-    "Services Manager" |
+  | "Services Manager"
-    "Project Manager" |
+  | "Project Manager"
-    "Engineering Core Partner" |
+  | "Engineering Core Partner"
-    "Operations Core Partner" |
+  | "Operations Core Partner"
-    "Community Moderator" |
+  | "Community Moderator"
-    "Technician" |
+  | "Technician"
-    string;
+  | string;
-
 
 export enum PartnerDepartment {
-    INDEPENDENT_AGENCY,
+  INDEPENDENT_AGENCY,
-    ENGINEERING, // Department of Engineering
+  ENGINEERING, // Department of Engineering
-    OPERATIONS // Department of Operations
+  OPERATIONS, // Department of Operations
 }
 
 export enum PartnerRoleType {
-    MANAGERIAL,
+  MANAGERIAL,
-    NONMANAGERIAL,
+  NONMANAGERIAL,
 }
 
 export enum PartnerCommissionType {
-    TENURE,
+  TENURE,
-    PROVISIONAL,
+  PROVISIONAL,
-    CONTRACTUAL,
+  CONTRACTUAL,
-    ACTING,
+  ACTING,
-    INTERIM,
+  INTERIM,
-    TRIAL,
+  TRIAL,
 }
 
 export default class Partner implements SharedMemberAttributes {
-    @prop({ required: true, unique: true })
+  @prop({ required: true, unique: true })
-    public discordID: string | undefined;
+  public discordID: string | undefined;
 
-    @prop()
+  @prop()
-    public emailAddress: string | undefined;
+  public emailAddress: string | undefined;
 
-    @prop({ required: true })
+  @prop({ required: true })
-    public roleType: PartnerRoleType | undefined;
+  public roleType: PartnerRoleType | undefined;
 
-    @prop({ required: true })
+  @prop({ required: true })
-    public commissionType: PartnerCommissionType | undefined;
+  public commissionType: PartnerCommissionType | undefined;
 
-    @prop({ required: true })
+  @prop({ required: true })
-    public department: PartnerDepartment | undefined;
+  public department: PartnerDepartment | undefined;
 
-    @prop({ required: true })
+  @prop({ required: true })
-    public title: PartnerTitle | "Partner" | undefined;
+  public title: PartnerTitle | "Partner" | undefined;
 
-    @prop()
+  @prop()
-    //
+  //
-    public directReport: Partner | string | undefined;
+  public directReport: Partner | string | undefined;
 
-    @prop()
+  @prop()
-    // this field dictates if the partner is able to perform developer commands, such as "eval"
+  // this field dictates if the partner is able to perform developer commands, such as "eval"
-    public canPerformDevCommands: boolean | undefined;
+  public canPerformDevCommands: boolean | undefined;
 }
 
 export const PartnerModel = getModelForClass(Partner);

database/Vendor.ts

@@ -1,15 +1,15 @@
-import { prop } from '@typegoose/typegoose';
+import { prop } from "@typegoose/typegoose";
 
 // This class represents a Vendor, which ia an entity that is permitted to access CommunityReport information, and may be permitted to manipulate data, through the HTtP API.
 export default class Vendor {
-    @prop({ required: true })
+  @prop({ required: true })
-    public name: string | undefined;
+  public name: string | undefined;
 
-    @prop({ required: true, unique: true })
+  @prop({ required: true, unique: true })
-    // the uuidv4 string identifier of the vendor; this functions as the identifier and api key for the vendor
+  // the uuidv4 string identifier of the vendor; this functions as the identifier and api key for the vendor
-    public key: string | undefined;
+  public key: string | undefined;
 
-    @prop({ default: false })
+  @prop({ default: false })
-    // determines if this vendor can perform a Hard Inquiry and receive additional privileged information
+  // determines if this vendor can perform a Hard Inquiry and receive additional privileged information
-    public privileged: boolean | undefined;
+  public privileged: boolean | undefined;
 }

discord/commands/Eval.ts

@@ -4,64 +4,74 @@ import { inspect } from "util";
 import { discordBotToken } from "../../config.json";
 
 export default class Eval extends DiscordInteractionCommand {
-    // This is a list of IDs that are allowed to use this command.
+  // This is a list of IDs that are allowed to use this command.
-    private listOfAllowedIDs: string[];
+  private listOfAllowedIDs: string[];
 
-    constructor() {
+  constructor() {
-        super("eval", "Executes arbitrary JS code and returns the output.");
+    super("eval", "Executes arbitrary JS code and returns the output.");
-        // this option is required and is a string of JavaScript code to execute
+    // this option is required and is a string of JavaScript code to execute
-        this.builder.addStringOption(option => option.setName("code").setDescription("The code to execute.").setRequired(true));
+    this.builder.addStringOption((option) =>
-        // this option is optional and is a boolean that determines whether the code should be run as an async function
+      option.setName("code").setDescription("The code to execute.").setRequired(true)
-        this.builder.addBooleanOption(option => option.setName("async").setDescription("Whether to run the code as an async function.").setRequired(false));
+    );
-        // this option is optional and is an integer that determines the depth of the eval inspection
+    // this option is optional and is a boolean that determines whether the code should be run as an async function
-        this.builder.addIntegerOption(option => option.setName("depth").setDescription("The depth of the inspection.").setRequired(false));
+    this.builder.addBooleanOption((option) =>
+      option
+        .setName("async")
+        .setDescription("Whether to run the code as an async function.")
+        .setRequired(false)
+    );
+    // this option is optional and is an integer that determines the depth of the eval inspection
+    this.builder.addIntegerOption((option) =>
+      option.setName("depth").setDescription("The depth of the inspection.").setRequired(false)
+    );
 
-        this.listOfAllowedIDs = [
+    this.listOfAllowedIDs = [
-            "278620217221971968", // Matthew
+      "278620217221971968", // Matthew
-        ];
+    ];
+  }
+
+  public async execute(interaction: ChatInputCommandInteraction) {
+    // @ts-ignore
+    let evalString = interaction.options.getString("code").trim();
+    if (evalString == null)
+      return interaction.reply({ content: "You must provide code to evaluate.", ephemeral: true });
+    if (!this.listOfAllowedIDs.includes(interaction.user.id))
+      return interaction.reply({ content: "Permission denied.", ephemeral: true });
+    await interaction.deferReply({ ephemeral: true });
+
+    // set scoped variables to be able to access over eval
+    const guild = interaction.guild || interaction.client.guilds.cache.get(this.GUILD_ID);
+    // the output of eval() is stored in evaled
+    let evaled: any;
+    let depth: number | null = 0;
+    // if depth option exists, set the depth variable to the value provided by the user
+    if (interaction.options.getInteger("depth") != null) {
+      depth = interaction.options.getInteger("depth");
     }
 
-    public async execute(interaction: ChatInputCommandInteraction) {
+    // if command specified as async, swap the evalString in an async function
-        // @ts-ignore
+    if (interaction.options.getBoolean("async")) {
-        let evalString = interaction.options.getString("code").trim();
+      evalString = `(async () => { ${evalString} })()`;
-        if (evalString == null) return interaction.reply({ content: "You must provide code to evaluate.", ephemeral: true });
+    }
-        if (!this.listOfAllowedIDs.includes(interaction.user.id)) return interaction.reply({ content: "Permission denied.", ephemeral: true });
-        await interaction.deferReply({ephemeral: true});
 
-        // set scoped variables to be able to access over eval
+    try {
-        const guild = interaction.guild || interaction.client.guilds.cache.get(this.GUILD_ID);
+      evaled = await eval(evalString);
-        // the output of eval() is stored in evaled
+      if (typeof evaled !== "string") {
-        let evaled: any;
+        evaled = inspect(evaled, { depth });
-        let depth: number | null = 0;
+      }
-        // if depth option exists, set the depth variable to the value provided by the user
+      if (evaled === undefined) {
-        if (interaction.options.getInteger("depth") != null) {
+        evaled = "undefined";
-            depth = interaction.options.getInteger("depth");
+      }
-        }
+    } catch (error) {
+      // @ts-ignore
+      evaled = error.stack;
+    }
 
-        // if command specified as async, swap the evalString in an async function
+    // replaces all instances of the bot token with [REDACTED] in output
-        if (interaction.options.getBoolean("async")) {
+    evaled = evaled.replace(new RegExp(discordBotToken, "gi"), "[REDACTED]");
-            evalString = `(async () => { ${evalString} })()`;
-        }
 
-        try {
+    // TODO: Figure this out.
-            // eslint-disable-next-line no-eval
+    /*const display = this.client.util.splitString(evaled, 1975);
-            evaled = await eval(evalString);
-            if (typeof evaled !== 'string') {
-                evaled = inspect(evaled, { depth });
-            }
-            if (evaled === undefined) {
-                evaled = 'undefined';
-            }
-        } catch (error) {
-            // @ts-ignore
-            evaled = error.stack;
-        }
-
-        // replaces all instances of the bot token with [REDACTED] in output
-        evaled = evaled.replace(new RegExp(discordBotToken, 'gi'), '[REDACTED]');
-
-        // TODO: Figure this out.
-        /*const display = this.client.util.splitString(evaled, 1975);
         if (display[5]) {
             try {
                 const { data } = await axios.post('https://snippets.cloud.libraryofcode.org/documents', display.join(''));
@@ -70,6 +80,6 @@ export default class Eval extends DiscordInteractionCommand {
                 return this.error(ctx.message.channel, `${error}`);
             }
         }*/
-        await interaction.editReply({content: `\`\`\`js\n${evaled}\n\`\`\``})
+    await interaction.editReply({ content: `\`\`\`js\n${evaled}\n\`\`\`` });
-    }
+  }
 }

discord/commands/Partner.ts

@@ -2,12 +2,12 @@ import DiscordInteractionCommand from "../../util/DiscordInteractionCommand";
 import { ChatInputCommandInteraction } from "discord.js";
 
 export default class Ping extends DiscordInteractionCommand {
-    constructor() {
+  constructor() {
-        super("partner", "Manipulates partner information.");
+    super("partner", "Manipulates partner information.");
-    }
+  }
 
-    public async execute(interaction: ChatInputCommandInteraction): Promise<void> {
+  public async execute(interaction: ChatInputCommandInteraction): Promise<void> {
-        if (interaction.options?.getSubcommand(true) === "add") {
+    if (interaction.options?.getSubcommand(true) === "add") {
-        }
     }
+  }
 }

discord/commands/PartnerAdd.ts

@@ -1,25 +1,34 @@
-import DiscordInteractionCommand, { DiscordInteractionCommandSkeleton } from "../../util/DiscordInteractionCommand";
+import DiscordInteractionCommand, {
+  DiscordInteractionCommandSkeleton,
+} from "../../util/DiscordInteractionCommand";
 import { guildID } from "../../config.json";
 import { ChatInputCommandInteraction, SlashCommandBuilder } from "discord.js";
 import { MemberModel } from "../../database/Member";
 import { PartnerModel } from "../../database/Partner";
 
 export default class PartnerAdd implements DiscordInteractionCommandSkeleton {
-    public GUILD_ID: string;
+  public GUILD_ID: string;
-    public name: string;
+  public name: string;
-    public description: string
+  public description: string;
-    public builder: SlashCommandBuilder;
+  public builder: SlashCommandBuilder;
-    constructor() {
+  constructor() {
-        this.name = "partner";
+    this.name = "partner";
-        this.description = "Creates a new partner entry.";
+    this.description = "Creates a new partner entry.";
-        this.builder = new SlashCommandBuilder();
+    this.builder = new SlashCommandBuilder();
-        this.GUILD_ID = guildID;
+    this.GUILD_ID = guildID;
-    }
+  }
 
-    public async execute(interaction: ChatInputCommandInteraction) {
+  public async execute(interaction: ChatInputCommandInteraction) {
-        const member = MemberModel.findOne({ discordID: interaction.user.id });
+    const member = MemberModel.findOne({ discordID: interaction.user.id });
-        if (!member) return interaction.reply({ content: "The specified partner does not have a base member entry.", ephemeral: true });
+    if (!member)
-        if (!(await PartnerModel.findOne({discordID: interaction.user.id}))) return interaction.reply({ content: "The specified partner already has a partner entry.", ephemeral: true });
+      return interaction.reply({
-
+        content: "The specified partner does not have a base member entry.",
-    }
+        ephemeral: true,
+      });
+    if (!(await PartnerModel.findOne({ discordID: interaction.user.id })))
+      return interaction.reply({
+        content: "The specified partner already has a partner entry.",
+        ephemeral: true,
+      });
+  }
 }

discord/commands/Ping.ts

@@ -2,20 +2,20 @@ import DiscordInteractionCommand from "../../util/DiscordInteractionCommand";
 import { ChatInputCommandInteraction } from "discord.js";
 
 export default class Ping extends DiscordInteractionCommand {
-    constructor() {
+  constructor() {
-        super("ping", "Pings the bot");
+    super("ping", "Pings the bot");
-    }
+  }
 
-    public async execute(interaction: ChatInputCommandInteraction): Promise<void> {
+  public async execute(interaction: ChatInputCommandInteraction): Promise<void> {
-        const startTimestamp = Date.now(); // Mark the start of processing
+    const startTimestamp = Date.now(); // Mark the start of processing
 
-        await interaction.reply({ content: "Pong!", ephemeral: false });
+    await interaction.reply({ content: "Pong!", ephemeral: false });
-        const repliedTimestamp = Date.now(); // Mark the timestamp after replying
+    const repliedTimestamp = Date.now(); // Mark the timestamp after replying
 
-        const endTimestamp = Date.now(); // Mark the end of all processing (after editReply)
+    const endTimestamp = Date.now(); // Mark the end of all processing (after editReply)
 
-        await interaction.editReply({
+    await interaction.editReply({
-            content: `🏓 Pong!\nClient: \`${repliedTimestamp - interaction.createdTimestamp}ms\`\nResponse: \`${endTimestamp - startTimestamp}ms\``
+      content: `🏓 Pong!\nClient: \`${repliedTimestamp - interaction.createdTimestamp}ms\`\nResponse: \`${endTimestamp - startTimestamp}ms\``,
-        });
+    });
-    }
+  }
 }

discord/commands/Whois.ts

@@ -1,103 +1,117 @@
 import DiscordInteractionCommand from "../../util/DiscordInteractionCommand";
 import { MemberModel } from "../../database/Member";
-import Partner, { PartnerCommissionType, PartnerDepartment, PartnerModel, PartnerRoleType } from "../../database/Partner";
+import Partner, {
+  PartnerCommissionType,
+  PartnerDepartment,
+  PartnerModel,
+  PartnerRoleType,
+} from "../../database/Partner";
 import { ChatInputCommandInteraction, EmbedBuilder, GuildMember } from "discord.js";
 import MemberUtil from "../../util/MemberUtil";
-import EmojiConfig from "../../util/EmojiConfig"
+import EmojiConfig from "../../util/EmojiConfig";
 
 export default class Whois extends DiscordInteractionCommand {
-    constructor() {
+  constructor() {
-        super("whois", "Retrieves information about a user.");
+    super("whois", "Retrieves information about a user.");
-        this.builder.addUserOption(option => option.setName("member").setDescription("The member to get information about.").setRequired(true));
+    this.builder.addUserOption((option) =>
-    }
+      option
+        .setName("member")
+        .setDescription("The member to get information about.")
+        .setRequired(true)
+    );
+  }
 
-    public async execute(interaction: ChatInputCommandInteraction) {
+  public async execute(interaction: ChatInputCommandInteraction) {
-        // defer our reply and perform database/external API operations/lookups
+    // defer our reply and perform database/external API operations/lookups
-        await interaction.deferReply({ ephemeral: false });
+    await interaction.deferReply({ ephemeral: false });
-        const target = interaction.options.getUser("member", true);
+    const target = interaction.options.getUser("member", true);
-        const guild = interaction.guild || interaction.client.guilds.cache.get(this.GUILD_ID);
+    const guild = interaction.guild || interaction.client.guilds.cache.get(this.GUILD_ID);
-        const guildMember = await guild?.members.fetch(target.id);
+    const guildMember = await guild?.members.fetch(target.id);
-        const databaseMember = await MemberModel.findOne({ discordID: target.id });
+    const databaseMember = await MemberModel.findOne({ discordID: target.id });
-        const partner = await PartnerModel.findOne({ discordID: target.id });
+    const partner = await PartnerModel.findOne({ discordID: target.id });
-        // return an error if target was not located
+    // return an error if target was not located
-        if (!guildMember) return interaction.editReply({ content: `Member target ${target.id} was not located.`});
+    if (!guildMember)
-        // build our embed
+      return interaction.editReply({ content: `Member target ${target.id} was not located.` });
-        const embed = new EmbedBuilder();
+    // build our embed
-        // if the role type is managerial, add a [k] to the end of the name
+    const embed = new EmbedBuilder();
-        // if the partner exists, set the iconURL to the organizational logo
+    // if the role type is managerial, add a [k] to the end of the name
-        const formattedName = MemberUtil.formatName(guildMember, partner);
+    // if the partner exists, set the iconURL to the organizational logo
-        embed.setAuthor({ name: formattedName.text, iconURL: formattedName.iconURL });
+    const formattedName = MemberUtil.formatName(guildMember, partner);
-        // set the thumbnail to the user's avatar
+    embed.setAuthor({ name: formattedName.text, iconURL: formattedName.iconURL });
-        embed.setThumbnail(guildMember.user.displayAvatarURL());
+    // set the thumbnail to the user's avatar
-        // initialize the description string
+    embed.setThumbnail(guildMember.user.displayAvatarURL());
-        let embedDescription = '';
+    // initialize the description string
-        if (partner) {
+    let embedDescription = "";
-            // set the title to the partner's title if applicable
+    if (partner) {
-            if (partner.title) embedDescription += `## __${EmojiConfig.LOC} ${partner.title}__\n`;
+      // set the title to the partner's title if applicable
-            embedDescription += "### Partner Information\n";
+      if (partner.title) embedDescription += `## __${EmojiConfig.LOC} ${partner.title}__\n`;
-            if (partner.emailAddress) embedDescription += `**Email Address**: ${partner.emailAddress}\n`;
+      embedDescription += "### Partner Information\n";
-            switch (partner.department) {
+      if (partner.emailAddress) embedDescription += `**Email Address**: ${partner.emailAddress}\n`;
-                case PartnerDepartment.ENGINEERING:
+      switch (partner.department) {
-                    embedDescription += "**Department**: Dept. of Engineering\n";
+        case PartnerDepartment.ENGINEERING:
-                    break;
+          embedDescription += "**Department**: Dept. of Engineering\n";
-                case PartnerDepartment.OPERATIONS:
+          break;
-                    embedDescription += "**Department**: Dept. of Operations\n";
+        case PartnerDepartment.OPERATIONS:
-                    break;
+          embedDescription += "**Department**: Dept. of Operations\n";
-                case PartnerDepartment.INDEPENDENT_AGENCY:
+          break;
-                    embedDescription += "**Department**: Independent Agency/Contractor\n";
+        case PartnerDepartment.INDEPENDENT_AGENCY:
-                    break;
+          embedDescription += "**Department**: Independent Agency/Contractor\n";
-            }
+          break;
-            switch (partner.commissionType) {
+      }
-                case PartnerCommissionType.TENURE:
+      switch (partner.commissionType) {
-                    embedDescription += "**Commission Type**: Tenure\n";
+        case PartnerCommissionType.TENURE:
-                    break;
+          embedDescription += "**Commission Type**: Tenure\n";
-                case PartnerCommissionType.PROVISIONAL:
+          break;
-                    embedDescription += "**Commission Type**: Provisional\n";
+        case PartnerCommissionType.PROVISIONAL:
-                    break;
+          embedDescription += "**Commission Type**: Provisional\n";
-                case PartnerCommissionType.CONTRACTUAL:
+          break;
-                    embedDescription += "**Commission Type**: Contractual/Independent/Collaborator\n";
+        case PartnerCommissionType.CONTRACTUAL:
-                    break;
+          embedDescription += "**Commission Type**: Contractual/Independent/Collaborator\n";
-                case PartnerCommissionType.ACTING:
+          break;
-                    embedDescription += "**Commission Type**: Acting\n";
+        case PartnerCommissionType.ACTING:
-                    break;
+          embedDescription += "**Commission Type**: Acting\n";
-                case PartnerCommissionType.INTERIM:
+          break;
-                    embedDescription += "**Commission Type**: Interim\n";
+        case PartnerCommissionType.INTERIM:
-                    break;
+          embedDescription += "**Commission Type**: Interim\n";
-                case PartnerCommissionType.TRIAL:
+          break;
-                    embedDescription += "**Commission Type**: Trial/Intern\n";
+        case PartnerCommissionType.TRIAL:
-                    break;
+          embedDescription += "**Commission Type**: Trial/Intern\n";
-            }
+          break;
-            if (partner.directReport) {
+      }
-                if (partner.directReport instanceof Partner) {
+      if (partner.directReport) {
-                    embedDescription += `**Direct Report**: ${partner.directReport.title}\n`;
+        if (partner.directReport instanceof Partner) {
-                }
+          embedDescription += `**Direct Report**: ${partner.directReport.title}\n`;
-            }
         }
-        embed.setColor(guildMember.displayColor);
+      }
-        if (embedDescription?.length > 0) embed.setDescription(embedDescription);
-        // add status to embed
-        if (guildMember.presence?.status) { // TODO: this currently doesn't work for some reason
-            switch (guildMember.presence.status) {
-                case "online":
-                    embed.addFields({ name: "Status", value: "Online", inline: true });
-                    break;
-                case "idle":
-                    embed.addFields({ name: "Status", value: "Idle", inline: true });
-                    break;
-                case "dnd":
-                    embed.addFields({ name: "Status", value: "Do Not Disturb", inline: true });
-                    break;
-                case "offline" || "invisible":
-                    embed.addFields({ name: "Status", value: "Online", inline: true });
-                    break;
-                default:
-                    // TODO: decide what placeholder we should use for values that fall "out of range"
-                    embed.addFields({ name: "Status", value: "", inline: true });
-                    break;
-            }
-        }
-        embed.setFooter({ text: `Discord ID: ${guildMember.id}${databaseMember ? `Internal ID: ${databaseMember?._id}` : ''}` });
-
-        return await interaction.editReply({ embeds: [embed] });
     }
+    embed.setColor(guildMember.displayColor);
+    if (embedDescription?.length > 0) embed.setDescription(embedDescription);
+    // add status to embed
+    if (guildMember.presence?.status) {
+      // TODO: this currently doesn't work for some reason
+      switch (guildMember.presence.status) {
+        case "online":
+          embed.addFields({ name: "Status", value: "Online", inline: true });
+          break;
+        case "idle":
+          embed.addFields({ name: "Status", value: "Idle", inline: true });
+          break;
+        case "dnd":
+          embed.addFields({ name: "Status", value: "Do Not Disturb", inline: true });
+          break;
+        case "offline" || "invisible":
+          embed.addFields({ name: "Status", value: "Online", inline: true });
+          break;
+        default:
+          // TODO: decide what placeholder we should use for values that fall "out of range"
+          embed.addFields({ name: "Status", value: "", inline: true });
+          break;
+      }
+    }
+    embed.setFooter({
+      text: `Discord ID: ${guildMember.id}${databaseMember ? `Internal ID: ${databaseMember?._id}` : ""}`,
+    });
+
+    return await interaction.editReply({ embeds: [embed] });
+  }
 }

discord/events/InteractionCreate.ts

@@ -3,24 +3,34 @@ import { DiscordInteractionCommands } from "../../index";
 import { Client, Interaction } from "discord.js";
 
 export default class InteractionCreate extends DiscordEvent {
-    constructor(client: Client) {
+  constructor(client: Client) {
-        super("interactionCreate", client);
+    super("interactionCreate", client);
-    }
+  }
 
-    public async execute(interaction: Interaction): Promise<void> {
+  public async execute(interaction: Interaction): Promise<void> {
-        if (!interaction.isChatInputCommand()) return;
+    if (!interaction.isChatInputCommand()) return;
-        const command = DiscordInteractionCommands.get(interaction.commandName);
+    const command = DiscordInteractionCommands.get(interaction.commandName);
-        if (!command) return console.error(`No command matching ${interaction.commandName} was found.`);
+    if (!command) return console.error(`No command matching ${interaction.commandName} was found.`);
-        try {
+    try {
-            await command.execute(interaction);
+      await command.execute(interaction);
-            console.info(`[Info - Discord] Command '${interaction.commandName}' executed by '${interaction.user.username}'`);
+      console.info(
-        } catch (error) {
+        `[Info - Discord] Command '${interaction.commandName}' executed by '${interaction.user.username}'`
-            console.error(`Error executing command '${interaction.commandName}': by '${interaction.user.username}'\n${error}`);
+      );
-            if (interaction.replied || interaction.deferred) {
+    } catch (error) {
-                await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });
+      console.error(
-            } else {
+        `Error executing command '${interaction.commandName}': by '${interaction.user.username}'\n${error}`
-                await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });
+      );
-            }
+      if (interaction.replied || interaction.deferred) {
-        }
+        await interaction.followUp({
+          content: "There was an error while executing this command!",
+          ephemeral: true,
+        });
+      } else {
+        await interaction.reply({
+          content: "There was an error while executing this command!",
+          ephemeral: true,
+        });
+      }
     }
+  }
 }

eslint.config.mjs

@@ -0,0 +1,47 @@
+// eslint.config.mjs
+
+import js from "@eslint/js";
+import typescript from "@typescript-eslint/eslint-plugin";
+import typescriptParser from "@typescript-eslint/parser";
+import prettier from "eslint-config-prettier";
+import prettierPlugin from "eslint-plugin-prettier";
+import globals from "globals";
+
+export default [
+  // Base ESLint configuration
+  js.configs.recommended,
+
+  // TypeScript configuration
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    languageOptions: {
+      parser: typescriptParser,
+      globals: {
+        ...globals.node,
+      },
+      parserOptions: {
+        ecmaVersion: "latest", // Allows for the parsing of modern ECMAScript features
+        sourceType: "module", // Allows for the use of imports
+      },
+    },
+    plugins: {
+      "@typescript-eslint": typescript,
+    },
+    rules: {
+      ...typescript.configs.recommended.rules,
+      "@typescript-eslint/no-explicit-any": "warn",
+      "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
+    },
+  },
+
+  // Prettier configuration
+  {
+    plugins: {
+      prettier: prettierPlugin,
+    },
+    rules: {
+      ...prettier.rules,
+      "prettier/prettier": "error",
+    },
+  },
+];

package.json

@@ -1,8 +1,20 @@
 {
+  "license": "AGPL-3.0-or-later",
   "devDependencies": {
+    "@eslint/js": "^9.13.0",
     "@types/uuid": "^9.0.8",
+    "@typescript-eslint/eslint-plugin": "^8.11.0",
+    "@typescript-eslint/parser": "^8.11.0",
+    "eslint": "^9.13.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "globals": "^15.11.0",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
+    "prettier": "^3.3.3",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.2"
+    "typescript": "^5.4.2",
+    "typescript-eslint": "^8.11.0"
   },
   "dependencies": {
     "@typegoose/typegoose": "^12.2.0",
@@ -11,5 +23,21 @@
     "stripe": "^14.21.0",
     "typeorm": "^0.3.20",
     "uuid": "^9.0.1"
+  },
+  "scripts": {
+    "prepare": "husky",
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "lint:fix": "eslint . --ext .js,.jsx,.ts,.tsx --fix",
+    "format": "prettier --write .",
+    "test": ""
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{json,css,scss,md}": [
+      "prettier --write"
+    ]
   }
 }

util/Collection.ts

@@ -2,153 +2,153 @@
  * Hold a bunch of something
  */
 export default class Collection<V> extends Map<string, V> {
-    baseObject: (new (...args: any[]) => V) | undefined;
+  baseObject: (new (...args: any[]) => V) | undefined;
 
-    /**
+  /**
-     * Creates an instance of Collection
+   * Creates an instance of Collection
-     */
+   */
-    constructor(iterable: Iterable<[string, V]> | object | null = null) {
+  constructor(iterable: Iterable<[string, V]> | object | null = null) {
-        if (iterable && iterable instanceof Array) {
+    if (iterable && iterable instanceof Array) {
-            super(iterable);
+      super(iterable);
-        } else if (iterable && iterable instanceof Object) {
+    } else if (iterable && iterable instanceof Object) {
-            super(Object.entries(iterable));
+      super(Object.entries(iterable));
-        } else {
+    } else {
-            super();
+      super();
-        }
     }
+  }
 
-    /**
+  /**
-     * Map to array
+   * Map to array
-     * ```js
+   * ```js
-     * [value, value, value]
+   * [value, value, value]
-     * ```
+   * ```
-     */
+   */
-    toArray(): V[] {
+  toArray(): V[] {
-        return [...this.values()];
+    return [...this.values()];
+  }
+
+  /**
+   * Map to object
+   * ```js
+   * { key: value, key: value, key: value }
+   * ```
+   */
+  toObject(): { [key: string]: V } {
+    const obj: { [key: string]: V } = {};
+    for (const [key, value] of this.entries()) {
+      obj[key] = value;
     }
+    return obj;
+  }
 
-    /**
+  /**
-     * Map to object
+   * Add an object
-     * ```js
+   *
-     * { key: value, key: value, key: value }
+   * If baseObject, add only if instance of baseObject
-     * ```
+   *
-     */
+   * If no baseObject, add
-    toObject(): { [key: string]: V } {
+   * @param key The key of the object
-        const obj: { [key: string]: V } = {};
+   * @param value The object data
-        for (const [key, value] of this.entries()) {
+   * @param replace Whether to replace an existing object with the same key
-            obj[key] = value;
+   * @return The existing or newly created object
-        }
+   */
-        return obj;
+  add(key: string, value: V, replace: boolean = false): V | undefined | null {
+    if (this.has(key) && !replace) {
+      return this.get(key);
     }
+    if (this.baseObject && !(value instanceof this.baseObject)) return null;
 
-    /**
+    this.set(key, value);
-     * Add an object
+    return value;
-     *
+  }
-     * If baseObject, add only if instance of baseObject
-     *
-     * If no baseObject, add
-     * @param key The key of the object
-     * @param value The object data
-     * @param replace Whether to replace an existing object with the same key
-     * @return The existing or newly created object
-     */
-    add(key: string, value: V, replace: boolean = false): V | undefined | null {
-        if (this.has(key) && !replace) {
-            return this.get(key);
-        }
-        if (this.baseObject && !(value instanceof this.baseObject)) return null;
 
-        this.set(key, value);
+  /**
-        return value;
+   * Return the first object to make the function evaluate true
+   * @param func A function that takes an object and returns something
+   * @return The first matching object, or `null` if no match
+   */
+  find(func: Function): V | null {
+    for (const item of this.values()) {
+      if (func(item)) return item;
     }
+    return null;
+  }
 
-    /**
+  /**
-     * Return the first object to make the function evaluate true
+   * Return an array with the results of applying the given function to each element
-     * @param func A function that takes an object and returns something
+   * @param callbackfn A function that takes an object and returns something
-     * @return The first matching object, or `null` if no match
+   */
-     */
+  map<U>(callbackfn: (value?: V, index?: number, array?: V[]) => U): U[] {
-    find(func: Function): V | null {
+    const arr = [];
-        for (const item of this.values()) {
+    for (const item of this.values()) {
-            if (func(item)) return item;
+      arr.push(callbackfn(item));
-        }
-        return null;
     }
+    return arr;
+  }
 
-    /**
+  /**
-     * Return an array with the results of applying the given function to each element
+   * Return all the objects that make the function evaluate true
-     * @param callbackfn A function that takes an object and returns something
+   * @param func A function that takes an object and returns true if it matches
-     */
+   */
-    map<U>(callbackfn: (value?: V, index?: number, array?: V[]) => U): U[] {
+  filter(func: (value: V) => boolean): V[] {
-        const arr = [];
+    const arr = [];
-        for (const item of this.values()) {
+    for (const item of this.values()) {
-            arr.push(callbackfn(item));
+      if (func(item)) {
-        }
+        arr.push(item);
-        return arr;
+      }
     }
+    return arr;
+  }
 
-    /**
+  /**
-     * Return all the objects that make the function evaluate true
+   * Test if at least one element passes the test implemented by the provided function. Returns true if yes, or false if not.
-     * @param func A function that takes an object and returns true if it matches
+   * @param func A function that takes an object and returns true if it matches
-     */
+   */
-    filter(func: (value: V) => boolean): V[] {
+  some(func: (value: V) => boolean) {
-        const arr = [];
+    for (const item of this.values()) {
-        for (const item of this.values()) {
+      if (func(item)) {
-            if (func(item)) {
+        return true;
-                arr.push(item);
+      }
-            }
-        }
-        return arr;
     }
+    return false;
+  }
 
-    /**
+  /**
-     * Test if at least one element passes the test implemented by the provided function. Returns true if yes, or false if not.
+   * Update an object
-     * @param func A function that takes an object and returns true if it matches
+   * @param key The key of the object
-     */
+   * @param value The updated object data
-    some(func: (value: V) => boolean) {
+   */
-        for (const item of this.values()) {
+  update(key: string, value: V) {
-            if (func(item)) {
+    return this.add(key, value, true);
-                return true;
+  }
-            }
-        }
-        return false;
-    }
 
-    /**
+  /**
-     * Update an object
+   * Remove an object
-     * @param key The key of the object
+   * @param key The key of the object
-     * @param value The updated object data
+   * @returns The removed object, or `null` if nothing was removed
-     */
+   */
-    update(key: string, value: V) {
+  remove(key: string): V | null {
-        return this.add(key, value, true);
+    const item = this.get(key);
+    if (!item) {
+      return null;
     }
+    this.delete(key);
+    return item;
+  }
 
-    /**
+  /**
-     * Remove an object
+   * Get a random object from the Collection
-     * @param key The key of the object
+   * @returns The random object or `null` if empty
-     * @returns The removed object, or `null` if nothing was removed
+   */
-     */
+  random(): V | null {
-    remove(key: string): V | null {
+    if (!this.size) {
-        const item = this.get(key);
+      return null;
-        if (!item) {
-            return null;
-        }
-        this.delete(key);
-        return item;
     }
+    return Array.from(this.values())[Math.floor(Math.random() * this.size)];
+  }
 
-    /**
+  toString() {
-     * Get a random object from the Collection
+    // @ts-ignore
-     * @returns The random object or `null` if empty
+    return `[Collection<${this.baseObject.name}>]`;
-     */
+  }
-    random(): V | null {
-        if (!this.size) {
-            return null;
-        }
-        return Array.from(this.values())[Math.floor(Math.random() * this.size)];
-    }
-
-    toString() {
-        // @ts-ignore
-        return `[Collection<${this.baseObject.name}>]`;
-    }
 }

util/DiscordEvent.ts

@@ -1,12 +1,12 @@
 import { Client } from "discord.js";
 export default abstract class DiscordEvent {
-    public name: string;
+  public name: string;
-    protected client: Client;
+  protected client: Client;
 
-    protected constructor(name: string = "", client: Client) {
+  protected constructor(name: string = "", client: Client) {
-        this.name = name;
+    this.name = name;
-        this.client = client;
+    this.client = client;
-        this.execute = this.execute.bind(this);
+    this.execute = this.execute.bind(this);
-    }
+  }
-    public abstract execute(...args: any[]): Error | Promise<void>;
+  public abstract execute(...args: any[]): Error | Promise<void>;
 }

util/DiscordInteractionCommand.ts

@@ -2,30 +2,32 @@ import { SlashCommandBuilder, ChatInputCommandInteraction } from "discord.js";
 import { guildID } from "../config.json";
 
 export interface DiscordInteractionCommandSkeleton {
-    GUILD_ID: string;
+  GUILD_ID: string;
-    builder?: SlashCommandBuilder;
+  builder?: SlashCommandBuilder;
-    description: string;
+  description: string;
-    execute: (interaction: ChatInputCommandInteraction) => Error | Promise<void | any>;
+  execute: (interaction: ChatInputCommandInteraction) => Error | Promise<void | any>;
-    name: string;
+  name: string;
 }
 
-export default abstract class DiscordInteractionCommand implements DiscordInteractionCommandSkeleton {
+export default abstract class DiscordInteractionCommand
-    public name: string;
+  implements DiscordInteractionCommandSkeleton
-    public description: string;
+{
-    public builder: SlashCommandBuilder;
+  public name: string;
+  public description: string;
+  public builder: SlashCommandBuilder;
 
-    public GUILD_ID: string;
+  public GUILD_ID: string;
 
-    protected constructor(name: string, description: string) {
+  protected constructor(name: string, description: string) {
-        this.name = name;
+    this.name = name;
-        this.description = description;
+    this.description = description;
-        this.builder = new SlashCommandBuilder();
+    this.builder = new SlashCommandBuilder();
 
-        this.builder.setName(this.name);
+    this.builder.setName(this.name);
-        this.builder.setDescription(this.description);
+    this.builder.setDescription(this.description);
 
-        this.GUILD_ID = guildID;
+    this.GUILD_ID = guildID;
-    }
+  }
 
-    public abstract execute(interaction: ChatInputCommandInteraction): Error | Promise<void | any>;
+  public abstract execute(interaction: ChatInputCommandInteraction): Error | Promise<void | any>;
 }

util/EmojiConfig.ts

@@ -1,4 +1,4 @@
 export default class EmojiConfig {
-    public static LOC = "<:loc:607695848612167700>";
+  public static LOC = "<:loc:607695848612167700>";
-    public static EMAIL = "<:email:699786452267040878>";
+  public static EMAIL = "<:email:699786452267040878>";
 }

util/MemberUtil.ts

@@ -1,84 +1,118 @@
 import Partner, {
-    PartnerCommissionType,
+  PartnerCommissionType,
-    PartnerDepartment,
+  PartnerDepartment,
-    PartnerModel,
+  PartnerModel,
-    PartnerRoleType,
+  PartnerRoleType,
-    PartnerTitle
+  PartnerTitle,
 } from "../database/Partner";
 import Member, { MemberAdditionalAcknowledgement, MemberModel } from "../database/Member";
 import { Client, GuildMember, User } from "discord.js";
 import { guildID } from "../config.json";
 
 export interface PartnerOptions {
-    roleType: PartnerRoleType;
+  roleType: PartnerRoleType;
-    commissionType: PartnerCommissionType;
+  commissionType: PartnerCommissionType;
-    department: PartnerDepartment;
+  department: PartnerDepartment;
-    title: PartnerTitle;
+  title: PartnerTitle;
-    directReport: Partner | string;
+  directReport: Partner | string;
 }
 
 export interface FormatNameOptions {
-    text: string;
+  text: string;
-    iconURL: string;
+  iconURL: string;
 }
 
 // TODO: Add the rest of the remaining role configurations
 export const PartnerDiscordRoleMap = {
-    // Director of Engineering, Management, Staff, Technician, Core Team, Play Caller
+  // Director of Engineering, Management, Staff, Technician, Core Team, Play Caller
-    "Director of Engineering": ["1077646568091570236", "1077646956890951690", "446104438969466890", "701454780828221450", "453689940140883988", "1014978134573064293"],
+  "Director of Engineering": [
-    // Director of Operations, Management, Staff, Moderator, Core Team, Play Caller
+    "1077646568091570236",
-    "Director of Operations": ["1077647072163020840", "1077646956890951690", "446104438969466890", "455972169449734144", "453689940140883988", "1014978134573064293"]
+    "1077646956890951690",
-}
+    "446104438969466890",
+    "701454780828221450",
+    "453689940140883988",
+    "1014978134573064293",
+  ],
+  // Director of Operations, Management, Staff, Moderator, Core Team, Play Caller
+  "Director of Operations": [
+    "1077647072163020840",
+    "1077646956890951690",
+    "446104438969466890",
+    "455972169449734144",
+    "453689940140883988",
+    "1014978134573064293",
+  ],
+};
 
 export default class MemberUtil {
-    public static async createNewPartner(member: Member, options: PartnerOptions) {
+  public static async createNewPartner(member: Member, options: PartnerOptions) {
-        const partner = new PartnerModel();
+    const partner = new PartnerModel();
-        partner.discordID = member.discordID;
+    partner.discordID = member.discordID;
-        partner.roleType = options.roleType;
+    partner.roleType = options.roleType;
-        partner.commissionType = options.commissionType;
+    partner.commissionType = options.commissionType;
-        partner.department = options.department;
+    partner.department = options.department;
-        partner.title = options.title;
+    partner.title = options.title;
-        partner.directReport = options.directReport;
+    partner.directReport = options.directReport;
-        await partner.save();
+    await partner.save();
-        return partner;
+    return partner;
-    }
+  }
 
-    public static async getPartner(member: Member) {
+  public static async getPartner(member: Member) {
-        return PartnerModel.findOne({ discordID: member.discordID });
+    return PartnerModel.findOne({ discordID: member.discordID });
-    }
+  }
 
-    public static async deletePartner(member: Member) {
+  public static async deletePartner(member: Member) {
-        return PartnerModel.deleteOne({ discordID: member.discordID });
+    return PartnerModel.deleteOne({ discordID: member.discordID });
-    }
+  }
 
-    public static addAcknowledgementToMember(member: Member, acknowledgement: MemberAdditionalAcknowledgement) {
+  public static addAcknowledgementToMember(
-        if (!member.additionalAcknowledgement || member.additionalAcknowledgement?.length === 0) {
+    member: Member,
-            MemberModel.updateOne({ discordID: member.discordID }, { additionalAcknowledgement: [] });
+    acknowledgement: MemberAdditionalAcknowledgement
-        }
+  ) {
-        if (member.additionalAcknowledgement?.includes(acknowledgement)) throw new Error("This member already has this acknowledgement.")
+    if (!member.additionalAcknowledgement || member.additionalAcknowledgement?.length === 0) {
-        return MemberModel.updateOne({ discordID: member.discordID }, { $push: { additionalAcknowledgement: acknowledgement } });
+      MemberModel.updateOne({ discordID: member.discordID }, { additionalAcknowledgement: [] });
     }
+    if (member.additionalAcknowledgement?.includes(acknowledgement))
+      throw new Error("This member already has this acknowledgement.");
+    return MemberModel.updateOne(
+      { discordID: member.discordID },
+      { $push: { additionalAcknowledgement: acknowledgement } }
+    );
+  }
 
-    // TODO: comments and extended formatting
+  // TODO: comments and extended formatting
-    public static formatName(target: GuildMember | User, partner?: Partner | null): FormatNameOptions {
+  public static formatName(
-        console.log(`[MemberUtil] Formatting name for ${target.displayName} at url ${target instanceof GuildMember ? target.user.displayAvatarURL() : target.displayAvatarURL()}`);
+    target: GuildMember | User,
-        // if the role type is managerial, add a [k] to the end of the name
+    partner?: Partner | null
-        // if the partner exists, set the iconURL to the organizational logo
+  ): FormatNameOptions {
-        if (partner?.roleType == PartnerRoleType.MANAGERIAL) {
+    console.log(
-            return {
+      `[MemberUtil] Formatting name for ${target.displayName} at url ${target instanceof GuildMember ? target.user.displayAvatarURL() : target.displayAvatarURL()}`
-                text: `${target.displayName} [k]`,
+    );
-                iconURL: target.displayAvatarURL(),
+    // if the role type is managerial, add a [k] to the end of the name
-            }
+    // if the partner exists, set the iconURL to the organizational logo
-        } else if (partner?.commissionType == PartnerCommissionType.CONTRACTUAL) { // if the commission type is contractual, add a [c] to the end of the name
+    if (partner?.roleType == PartnerRoleType.MANAGERIAL) {
-            return {
+      return {
-                text: `${target.displayName} [c]`,
+        text: `${target.displayName} [k]`,
-                iconURL: target instanceof GuildMember ? target.user.displayAvatarURL() : target.displayAvatarURL(),
+        iconURL: target.displayAvatarURL(),
-            }
+      };
-        } else { // otherwise, just set the author to the member's display name
+    } else if (partner?.commissionType == PartnerCommissionType.CONTRACTUAL) {
-            return {
+      // if the commission type is contractual, add a [c] to the end of the name
-                text: target.displayName,
+      return {
-                iconURL: target instanceof GuildMember ? target.user.displayAvatarURL() : target.displayAvatarURL(),
+        text: `${target.displayName} [c]`,
-            }
+        iconURL:
-        }
+          target instanceof GuildMember
+            ? target.user.displayAvatarURL()
+            : target.displayAvatarURL(),
+      };
+    } else {
+      // otherwise, just set the author to the member's display name
+      return {
+        text: target.displayName,
+        iconURL:
+          target instanceof GuildMember
+            ? target.user.displayAvatarURL()
+            : target.displayAvatarURL(),
+      };
     }
+  }
 }