@ossy/authentication
v1.19.2
Published
Authentication feature package - sign-in, sign-up, and invitation pages for Ossy apps
Downloads
7,860
Readme
@ossy/authentication
Authentication feature package for the Ossy platform — provides sign-in, sign-up, and invitation verification pages that are auto-discovered by @ossy/app when the package is installed.
What's included
Pages (auto-discovered by @ossy/app)
| File | Page id | Default paths |
|---|---|---|
| sign-in.page.jsx | sign-in | /sign-in (en), /logga-in (sv) |
| sign-up.page.jsx | sign-up | /sign-up (en), /registrera (sv) |
| verify-sign-in.page.jsx | verify-sign-in | /verify-sign-in (en), /verifiera-inloggning (sv) |
| verify-invitation.page.jsx | invitations/verify | /invitations/verify (en), /inbjudan/verifiera (sv) |
Components
| Export | Description |
|---|---|
| ApiTokens | Lists API tokens for the current user with revoke action |
| AuthenticationGuard | Wraps children, rendering guards for unauthenticated/loading/error states |
| CreateApiToken | Form flow for creating a new API token |
| Invite | Form flow for inviting a user to a workspace |
| Definition | Module definition object (id, actions, views, statuses) |
| GetCurrentUser | Platform action POJO for session reads via sdk.read() |
| AuthenticationStatus | Loading state constants |
Usage
Install the package, then run your normal build — no imports or registration needed.
npm install @ossy/authentication
npm run build@ossy/app discovers the pages automatically by reading the "ossy": { "src": "./src" } field in this package's package.json. The pages are merged into the manifest alongside your app's own pages.
See the Feature packages concept doc for how this works.
Logo / branding
The auth components accept an optional logo prop. By default no logo is shown — pass your app's logo element if you want one displayed above the form:
import { SignIn } from '@ossy/authentication/src/SignIn.jsx'
import { Logo } from './logo/Logo.jsx'
<SignIn logo={<Logo />} />The page entries (*.page.jsx) do not pass a logo. If you need a branded page, create a local wrapper page in your app's src/ that renders the component directly.
Peer dependencies
| Package | Version |
|---|---|
| @ossy/design-system | >=1.0.0 |
| @ossy/router-react | >=1.0.0 |
| @ossy/sdk-react | >=1.0.0 |
| react | >=19.0.0 <20.0.0 |
