search

woodjme / unifi-hotspot

A Node.js based external portal server for authorising Wi-Fi guests on Unifi products
Apache License 2.0
71 stars 28 forks source link

v3 release #69

Closed woodjme closed 2 months ago

woodjme commented 2 months ago

feat: unifi api service feat: typescript

Summary by CodeRabbit

woodjme commented 2 months ago

resolves #58

coderabbitai[bot] commented 2 months ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The update overhauls the codebase, including introducing TypeScript, updating configurations, enhancing logging, and setting up an environment for a Unifi controller. Key updates comprise restructured ESLint and Prettier configurations, robust Dockerfile enhancements, comprehensive README revisions, and newly added utility and interface modules. Moreover, the project now leverages modern technologies and tools for better maintainability, improved readability, and enhanced developer experience.

Changes

File(s) Change Summary
.env.example Introduced environment variables for Unifi controller setup.
.eslintrc.json Updated environment settings, configurations, parser options, and added new plugins.
.github/workflows/dev.yml, tags.yml Reformatted steps in the workflows by removing unnecessary hyphens.
.gitignore Added dist/ to the ignore list.
.husky/*, .huskyrc, .lintstagedrc Introduced Husky and lint-staged configurations for pre-commit linting and commit message validation.
.prettierignore, .prettierrc Introduced/modified Prettier configuration and ignore rules.
Dockerfile Split build process into two stages for better efficiency.
README.md Significant updates including environment variable renaming, Typescript adoption, and Node.js upgrade.
tests/…/basicauth.test.js Added semicolons, updated setup, and improved readability of test cases.
commitlint.config.js Introduced commit linting configuration for conventional commits.
docs/.vuepress/config.js Updated and restructured user configuration settings.
package.json Updated version, script paths, dependencies, and minimum Node.js version.
public/noAuth.html Made significant semantic and structural updates.
src/index.ts Introduced core functionality for environment configuration and server initialization.
src/interfaces/UnifiApiService.ts Added interface UnifiApiService for Unifi API communication.
src/routes/authorise.ts Implemented an Express.js route for Unifi device authorization.
src/routes/index.ts Introduced route handler for the root path with session management and logging.
src/server/index.ts Set up an Express server with middleware and routing.
src/types/global.d.ts Added global type declarations for logger and extended express-session properties.
src/unifi/index.ts Introduced functions for interacting with Unifi API, handling responses, and error conditions.
src/utils/axios.ts Created Axios instance with custom interceptors for request and response logging.
src/utils/config.ts Added configuration module with validation and environment variable checks.
src/utils/logAuthDrivers.ts Introduced functions for logging to webhooks and Google Sheets.
src/utils/logger.ts Set up logging system using pino, tailored for different environments.
tsconfig.json Updated TypeScript compilation options with strict mode and directory settings.
views/connecting.ejs Added loading page for checking internet connectivity and redirecting on success.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.