@ortha/admin-identity 0.0.0 → 0.0.3

package/README.md

@@ -0,0 +1,127 @@
+# @ortha/admin-identity
+
+Authentication UI plugin for the Ortha admin application — provides login, signup, and invite code verification pages. All auth routes are public (guest-only) and redirect authenticated users to the home page.
+
+## Installation
+
+Internal monorepo dependency — import directly:
+
+```ts
+import { identityPlugin } from '@ortha/admin-identity';
+import type { CurrentUser, Role, Permission } from '@ortha/admin-identity';
+```
+
+## Usage
+
+### Registering the plugin
+
+```ts
+import { bootstrap } from '@ortha/admin-platform-bootstrap';
+import { identityPlugin } from '@ortha/admin-identity';
+
+bootstrap(document.getElementById('root')!, [
+    identityPlugin()
+    // ...other plugins
+]);
+```
+
+### Using API hooks
+
+```ts
+import { useLogin, useCurrentUser, useRoles } from '@ortha/admin-identity';
+
+const LoginComponent = () => {
+    const login = useLogin();
+
+    const handleSubmit = (data: { email: string; password: string }) => {
+        login.mutate(data);
+    };
+};
+
+const ProfileComponent = () => {
+    const { data: user } = useCurrentUser();
+    const { data: roles } = useRoles();
+};
+```
+
+## Routes
+
+| Path           | Page                       | Auth Required |
+| -------------- | -------------------------- | ------------- |
+| `/auth`        | Auth layout wrapper        | No            |
+| `/auth/login`  | Login form                 | No            |
+| `/auth/signup` | Signup form (invite-gated) | No            |
+| `/auth/invite` | Invite code verification   | No            |
+
+## API Reference
+
+### Plugin
+
+| Export             | Kind    | Description                          |
+| ------------------ | ------- | ------------------------------------ |
+| `identityPlugin()` | factory | Admin plugin — registers auth routes |
+
+### Hooks
+
+| Export            | Kind | Description                                   |
+| ----------------- | ---- | --------------------------------------------- |
+| `useLogin`        | hook | Login mutation (`POST /api/identity/login`)   |
+| `useSignup`       | hook | Signup mutation (`POST /api/identity/signup`) |
+| `useInviteVerify` | hook | Invite verify mutation                        |
+| `useInviteCreate` | hook | Invite create mutation                        |
+| `useRefresh`      | hook | Token refresh mutation                        |
+| `useCurrentUser`  | hook | Current user query (`GET /api/identity/me`)   |
+| `useRoles`        | hook | Roles query (`GET /api/identity/roles`)       |
+| `currentUserKey`  | fn   | Query key factory for current user cache      |
+| `rolesKey`        | fn   | Query key factory for roles cache             |
+
+### Types
+
+| Export            | Kind | Description                          |
+| ----------------- | ---- | ------------------------------------ |
+| `CurrentUser`     | type | Current user entity                  |
+| `CurrentUserRole` | type | Current user's role with permissions |
+| `Permission`      | type | Permission (action + resource)       |
+| `Role`            | type | Role entity                          |
+
+## Internal Structure
+
+```
+src/lib/
+├── identityPlugin/index.ts         # Plugin factory with route registration
+├── types/index.ts                  # Shared entity types (CurrentUser, Role, etc.)
+├── api/
+│   ├── useLogin/index.ts           # LoginBody + login() + useLogin mutation
+│   ├── useSignup/index.ts          # SignupBody + signup() + useSignup mutation
+│   ├── useInviteVerify/index.ts    # InviteVerifyBody + useInviteVerify mutation
+│   ├── useInviteCreate/index.ts    # InviteCreateBody + useInviteCreate mutation
+│   ├── useRefresh/index.ts         # refresh() + useRefresh mutation
+│   ├── useCurrentUser/index.ts     # currentUserKey + useCurrentUser query
+│   └── useRoles/index.ts          # rolesKey + useRoles query
+└── pages/
+    ├── LoginPage/index.tsx
+    ├── SignUpPage/index.tsx
+    └── InviteCodePage/index.tsx
+```
+
+## Key Patterns
+
+- Auth pages use `react-hook-form` with `ajvResolver` from `@ortha/admin-utils`.
+- API hooks use TanStack React Query and `httpClient` from `@ortha/admin-platform-core`.
+- Request/response types specific to one hook are co-located inside that hook's file.
+- Shared entity types live in `types/index.ts`.
+- Error handling uses `handleMutationError` from `@ortha/admin-utils`.
+- This plugin has no dependencies on other feature plugins — it is foundational.
+
+## Dependencies
+
+- `@ortha/admin-platform-core` — `httpClient`, auth store
+- `@ortha/admin-platform-plugin-registry` — plugin types
+- `@ortha/admin-utils` — `ajvResolver`, `handleMutationError`
+- `@ortha/design-system` — theme and UI components
+
+## Building
+
+```bash
+nx build admin-identity
+```

package/package.json

@@ -1,5 +1,55 @@
 {
   "name": "@ortha/admin-identity",
-  "version": "0.0.0",
-  "description": "Reserved package placeholder"
-}
+  "version": "0.0.3",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@org/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "@org/source": "./src/lib/*/index.ts",
+      "types": "./dist/lib/*/index.d.ts",
+      "import": "./dist/lib/*/index.js",
+      "default": "./dist/lib/*/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ortha-source/ortha.git",
+    "directory": "packages/identity/admin"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@ortha/admin-platform-core": "0.0.1",
+    "@ortha/admin-platform-plugin-registry": "0.0.1",
+    "@ortha/design-system": "0.0.1",
+    "@ortha/admin-utils": "0.0.1"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0",
+    "react-router-dom": ">=6.0.0",
+    "react-hook-form": ">=7.0.0",
+    "react-intl": ">=6.0.0",
+    "@tanstack/react-query": ">=5.0.0",
+    "@mui/material": ">=7.0.0",
+    "@emotion/react": ">=11.0.0",
+    "@emotion/styled": ">=11.0.0",
+    "axios": ">=1.0.0"
+  },
+  "scripts": {}
+}