{"id":16202219,"url":"https://github.com/mathiscode/helio-mod-users","last_synced_at":"2026-02-07T14:02:03.776Z","repository":{"id":37706067,"uuid":"188605671","full_name":"mathiscode/helio-mod-users","owner":"mathiscode","description":"Users mod for Helio API Boilerplate","archived":false,"fork":false,"pushed_at":"2023-01-03T22:39:56.000Z","size":1083,"stargazers_count":0,"open_issues_count":16,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-11T02:49:15.718Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mathiscode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-25T19:40:14.000Z","updated_at":"2023-05-01T02:09:10.000Z","dependencies_parsed_at":"2023-02-01T11:45:16.974Z","dependency_job_id":null,"html_url":"https://github.com/mathiscode/helio-mod-users","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mathiscode/helio-mod-users","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathiscode%2Fhelio-mod-users","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathiscode%2Fhelio-mod-users/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathiscode%2Fhelio-mod-users/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathiscode%2Fhelio-mod-users/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mathiscode","download_url":"https://codeload.github.com/mathiscode/helio-mod-users/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathiscode%2Fhelio-mod-users/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266127212,"owners_count":23880420,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T09:46:26.319Z","updated_at":"2026-02-07T14:02:03.696Z","avatar_url":"https://github.com/mathiscode.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Helio API Boilerplate: Users Mod\n\nHandles user registration, authentication, profile/setting management, and more.\n\nThis mod may be installed into projects utilizing [Helio API Boilerplate](https://github.com/mathiscode/helio-api-boilerplate).\n\n---\n\n- [Helio API Boilerplate: Users Mod](#helio-api-boilerplate-users-mod)\n  - [Install](#install)\n  - [Methods](#methods)\n    - [`GET /`](#get)\n    - [`DELETE /`](#delete)\n    - [`POST /register` [public]](#post-register-public)\n    - [`POST /login` [public]](#post-login-public)\n    - [`GET /logout`](#get-logout)\n    - [`GET /settings`](#get-settings)\n    - [`GET /settings/:key`](#get-settingskey)\n    - [`PUT /settings/:key`](#put-settingskey)\n    - [`GET /client-settings`](#get-client-settings)\n    - [`PUT /client-settings`](#put-client-settings)\n    - [`GET /profile`](#get-profile)\n    - [`GET /profile/:key`](#get-profilekey)\n    - [`PUT /profile/:key`](#put-profilekey)\n    - [`GET /username`](#get-username)\n    - [`GET /username/availability` [public]](#get-usernameavailability-public)\n    - [`PATCH /username`](#patch-username)\n    - [`PATCH /password`](#patch-password)\n\n---\n\n## Install\n\n```sh\nyarn add helio-mod-users # or npm install helio-mod-users\n```\n\n```js\nimport UsersMod from 'helio-mod-users'\nMods = [{ path: '/user', module: UsersMod }]\n```\n\n[More information on Helio mods](https://github.com/mathiscode/helio-api-boilerplate#mods)\n\n## Methods\n\n### `GET /`\n\n- Get user object of current user\n\n### `DELETE /`\n\n- Delete current user\n\n### `POST /register` [public]\n\n\u003e { email: 'jdoe@example.com', password: 'supersecretpassword' }\n\n- Register a new user; returns auth token\n\n### `POST /login` [public]\n\n\u003e { email: 'jdoe@example.com', password: 'supersecretpassword' }\n\n- Login as user; returns auth token\n\n### `GET /logout`\n\n- Invalidate token for current user\n\n### `GET /settings`\n\n- Get settings object of current user\n\n### `GET /settings/:key`\n\n- Get setting value with key name :key\n\n### `PUT /settings/:key`\n\n\u003e { value: 'NewValue' }\n\n- Set value for setting with key name :key\n\n### `GET /client-settings`\n\n- Get client settings object; may be used by a frontend to store preferences\n\n### `PUT /client-settings`\n\n\u003e { any: 'thing', can: 'be', stored: 'here' }\n\n- Update the client settings object; may be used by a frontend to store preferences\n\n### `GET /profile`\n\n- Get profile object of current user\n\n### `GET /profile/:key`\n\n- Get value for profile item with key name :key\n\n### `PUT /profile/:key`\n\n\u003e { value: 'NewValue' }\n\n- Set value for profile item with key name :key\n\n### `GET /username`\n\n- Get username of current user\n\n### `GET /username/availability` [public]\n\n\u003e { username: 'MyNewUsername' }\n\n- Check availbility of username\n\n### `PATCH /username`\n\n\u003e { username: 'MyNewUsername' }\n\n- Change username of current user\n\n### `PATCH /password`\n\n\u003e { currentPassword: 'mycurrentpassword', newPassword: 'mynewpass', confirmPassword: 'mynewpass' }\n\n- Update password for current user\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathiscode%2Fhelio-mod-users","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmathiscode%2Fhelio-mod-users","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathiscode%2Fhelio-mod-users/lists"}