@cyberia-auth/auth 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to `@cyberia-auth/auth` are documented in this file.
+
+## 0.1.0
+
+- Initial public release.
+- Added `CyberiaAuth` sign-in/sign-up component.
+- Added `CyberiaAuthProvider` and hook `useCyberiaAuth()`.
+- Added auth UI helpers: `SignedIn`, `SignedOut`, `Protect`.
+- Added UI controls: `SignInButton`, `SignUpButton`, `SignOutButton`, `UserButton`.
+- Added no-flash branding cache per app token.
+- Added Clerk-like account dropdown and manage-account modal.

package/README.md

@@ -0,0 +1,199 @@
+# @cyberia-auth/auth
+
+React auth SDK for Cyberia Auth.
+
+It provides:
+
+- Prebuilt sign-in / sign-up UI (`CyberiaAuth`)
+- Auth state provider (`CyberiaAuthProvider`)
+- Clerk-like helpers (`SignedIn`, `SignedOut`, `Protect`, `UserButton`, `SignInButton`, `SignUpButton`, `SignOutButton`)
+
+## Installation
+
+```bash
+npm install @cyberia-auth/auth
+```
+
+Peer dependencies:
+
+- `react` `^18 || ^19`
+- `react-dom` `^18 || ^19`
+
+## Quick Start
+
+```tsx
+import {
+  CyberiaAuthProvider,
+  SignedIn,
+  SignedOut,
+  SignInButton,
+  SignUpButton,
+  UserButton,
+  Protect,
+} from '@cyberia-auth/auth';
+
+function App() {
+  return (
+    <CyberiaAuthProvider
+      backendUrl="https://auth.cyberia.host"
+      apiToken="app_your_token_here"
+      oauthRedirectUri="https://your-app-domain.com/protected"
+    >
+      <header style={{ display: 'flex', gap: 8 }}>
+        <SignedOut>
+          <SignInButton />
+          <SignUpButton />
+        </SignedOut>
+        <SignedIn>
+          <UserButton />
+        </SignedIn>
+      </header>
+
+      <Protect fallback={<p>Please sign in.</p>}>
+        <div>Protected content</div>
+      </Protect>
+    </CyberiaAuthProvider>
+  );
+}
+```
+
+## Components API
+
+### `CyberiaAuth`
+
+Embeddable sign-in / sign-up component.
+
+Props:
+
+- `backendUrl: string` - Cyberia backend base URL
+- `apiToken: string` - app API token
+- `oauthRedirectUri?: string` - redirect URL for Google/Microsoft OAuth
+- `initialMode?: 'login' | 'register'` - default mode
+- `hideModeSwitch?: boolean` - hide sign-in/sign-up toggle footer
+- `onAuthSuccess?: (result) => void` - callback with `{ token, user }`
+
+### `CyberiaAuthProvider`
+
+Global auth context + modal sign-in/sign-up experience.
+
+Props:
+
+- `backendUrl: string`
+- `apiToken: string`
+- `oauthRedirectUri?: string`
+- `children: ReactNode`
+- `storageKey?: string` - localStorage key override (default `cyberia_auth_session`)
+
+### `SignedIn` / `SignedOut`
+
+Conditional rendering blocks based on auth state.
+
+### `SignInButton` / `SignUpButton` / `SignOutButton`
+
+Convenience buttons for opening auth dialogs or clearing session.
+
+### `UserButton`
+
+Avatar trigger with account dropdown and manage-account modal.
+
+### `Protect`
+
+Guard wrapper:
+
+- renders children if signed in
+- renders `fallback` if signed out
+
+### `useCyberiaAuth`
+
+Hook returns:
+
+- `isLoaded`
+- `isSignedIn`
+- `user`
+- `token`
+- `openSignIn()`
+- `openSignUp()`
+- `signOut()`
+- `setSessionFromAuth(result)`
+
+## OAuth notes
+
+- For social auth, configure backend env vars for Google and Microsoft.
+- `oauthRedirectUri` should point to a route in your app that can receive query params.
+- Provider auto-parses OAuth callback params (`token`, `email`, `displayName`, `provider`) and stores session.
+
+## Theming and no-flash branding
+
+- Component fetches app branding from backend (`/api/public/app/config`).
+- Branding is cached per `apiToken` in localStorage to avoid initial color/logo flash.
+- If app branding is missing, default Cyberia theme is used.
+
+## NPM Publish Steps
+
+### 1) Build and verify package
+
+From package root:
+
+```bash
+npm run build
+```
+
+Optional package preview:
+
+```bash
+npm pack
+```
+
+### 2) Login to npm
+
+```bash
+npm login
+```
+
+### 3) Ensure package scope access
+
+This package is scoped (`@cyberia-auth/auth`) and configured with:
+
+- `"publishConfig": { "access": "public" }`
+
+### 4) Publish
+
+```bash
+npm publish
+```
+
+For first publish from a new scope, you can also run:
+
+```bash
+npm publish --access public
+```
+
+### 5) Publish updates
+
+Use one command from package folder:
+
+```bash
+npm run release:patch
+```
+
+Available release scripts:
+
+- `release:patch`
+- `release:minor`
+- `release:major`
+
+Each script does:
+
+1. `npm version <type>`
+2. `npm publish --access public`
+
+Also, `prepublishOnly` runs `npm run build` automatically before publishing.
+
+### 6) Verify
+
+- Open [npmjs.com](https://www.npmjs.com/) and check package page
+- Test install in a clean project:
+
+```bash
+npm i @cyberia-auth/auth
+```