@elqnt/admin 2.0.5 → 2.2.0

package/README.md

@@ -1,242 +1,97 @@
 # @elqnt/admin
 
-Admin APIs for Eloquent platform - onboarding, organization settings, and billing.
+Admin APIs and types for the Eloquent platform - onboarding, organization settings, billing, and user management.
 
 ## Installation
 
 ```bash
-pnpm add @elqnt/admin
+npm install @elqnt/admin
 ```
 
 ## Quick Start
 
 ```typescript
-import {
-  getOnboardingStatusApi,
-  createOrganizationApi,
-  getOrgSettingsApi,
-  getBillingPlansApi,
-} from "@elqnt/admin/api";
+import { getOnboardingStatusApi, getBillingPlansApi } from "@elqnt/admin/api";
+import type { User, Org, Plan } from "@elqnt/admin/models";
 
 // Check onboarding status
 const status = await getOnboardingStatusApi({
-  baseUrl: "https://api.elqnt.ai",
+  baseUrl: "https://api.example.com",
 });
 
-// Create organization during onboarding
-const org = await createOrganizationApi(
-  { name: "Acme Corp", industry: "Technology" },
-  { baseUrl: "https://api.elqnt.ai" }
-);
-
-// Get org settings (requires orgId)
-const settings = await getOrgSettingsApi({
-  baseUrl: "https://api.elqnt.ai",
-  orgId: "org-uuid",
+// Get billing plans
+const plans = await getBillingPlansApi({
+  baseUrl: "https://api.example.com",
+  orgId: "org_123",
 });
 ```
 
-## Exports
+## Entry Points
 
-| Import Path | Description |
-|-------------|-------------|
+| Import | Description |
+|--------|-------------|
 | `@elqnt/admin` | All exports |
 | `@elqnt/admin/api` | Browser API functions |
 | `@elqnt/admin/models` | TypeScript types |
+| `@elqnt/admin/hooks` | React hooks (`useOrgAdmin`, `useUsersAdmin`, `useInvitesAdmin`, `useOrgSettings`) |
 
-## API Reference
-
-### Onboarding API
+## APIs
 
-Functions for new user/organization setup flow.
+### Onboarding
+- `getOnboardingStatusApi()` - Get current state
+- `createOrganizationApi()` - Create org
+- `completeOnboardingApi()` - Finish onboarding
 
-| Function | Description |
-|----------|-------------|
-| `getOnboardingStatusApi(options)` | Get current onboarding state |
-| `startOnboardingApi(options)` | Initialize onboarding process |
-| `createPaymentSessionApi(params, options)` | Create Stripe checkout session |
-| `createOrganizationApi(org, options)` | Create new organization |
-| `sendOnboardingInvitesApi(invites, options)` | Send team invitations |
-| `createOnboardingKnowledgeApi(knowledge, options)` | Set up knowledge base |
-| `createOnboardingAgentApi(agent, options)` | Create initial AI agent |
-| `createAgentWithSkillsApi(payload, options)` | Create agent with skills |
-| `completeOnboardingApi(options)` | Mark onboarding complete |
-| `skipOnboardingStepApi(step, options)` | Skip optional step |
-
-```typescript
-import {
-  getOnboardingStatusApi,
-  createOrganizationApi,
-  completeOnboardingApi,
-} from "@elqnt/admin/api";
-
-// Onboarding options - orgId is optional
-interface OnboardingApiOptions {
-  baseUrl: string;
-  orgId?: string;      // May not exist yet
-  userId?: string;
-  userEmail?: string;
-}
-```
+### Organization Settings
+- `getOrgSettingsApi()` - Get settings
+- `updateOrgSettingsApi()` - Update settings
 
-### Organization Settings API
+### Billing
+- `getBillingPlansApi()` - List plans
+- `getSubscriptionApi()` - Current subscription
+- `createCheckoutSessionApi()` - Stripe checkout
+- `createPortalSessionApi()` - Billing portal
 
-Manage organization configuration.
-
-| Function | Description |
-|----------|-------------|
-| `getOrgSettingsApi(options)` | Get organization settings |
-| `createOrgSettingsApi(settings, options)` | Create settings (first time) |
-| `updateOrgSettingsApi(settings, options)` | Update settings |
-| `updateOrgAgentsApi(agentIds, options)` | Update enabled agents |
-| `updateEntityDefinitionsApi(entityNames, options)` | Update enabled entities |
-| `updateWorkflowDefinitionsApi(workflowIds, options)` | Update enabled workflows |
+## Hooks
 
 ```typescript
-import { getOrgSettingsApi, updateOrgSettingsApi } from "@elqnt/admin/api";
-
-const settings = await getOrgSettingsApi({
-  baseUrl: "https://api.elqnt.ai",
-  orgId: "org-uuid",
-});
-
-if (settings.data) {
-  await updateOrgSettingsApi(
-    { ...settings.data.settings, timezone: "America/New_York" },
-    { baseUrl: "https://api.elqnt.ai", orgId: "org-uuid" }
-  );
-}
-```
+import { useOrgAdmin, useUsersAdmin, useInvitesAdmin, useOrgSettings } from "@elqnt/admin/hooks";
 
-### Billing API
+// Organization management
+const { listOrgs, getOrg, createOrg, updateOrg, deleteOrg, loading, error } = useOrgAdmin(options);
 
-Subscription and payment management.
+// User management
+const { listUsers, getUser, createUser, updateUser, deleteUser, getUserSettings, updateUserSettings, loading, error } = useUsersAdmin(options);
 
-| Function | Description |
-|----------|-------------|
-| `getBillingPlansApi(options)` | List available plans |
-| `getSubscriptionApi(options)` | Get current subscription |
-| `getCreditsApi(options)` | Get credit balance |
-| `createCheckoutSessionApi(params, options)` | Create Stripe checkout |
-| `createPortalSessionApi(params, options)` | Create billing portal session |
-| `cancelSubscriptionApi(options)` | Cancel subscription |
-| `purchaseCreditsApi(params, options)` | Purchase additional credits |
+// Invite management
+const { listInvites, sendInvite, sendInvites, getInvite, acceptInvite, revokeInvite, resendInvite, loading, error } = useInvitesAdmin(options);
 
-```typescript
-import {
-  getBillingPlansApi,
-  getSubscriptionApi,
-  createPortalSessionApi,
-} from "@elqnt/admin/api";
-
-// Get available plans
-const plans = await getBillingPlansApi({
-  baseUrl: "https://api.elqnt.ai",
-  orgId: "org-uuid",
-});
-
-// Get current subscription
-const subscription = await getSubscriptionApi({
-  baseUrl: "https://api.elqnt.ai",
-  orgId: "org-uuid",
-});
-
-// Open billing portal
-const portal = await createPortalSessionApi(
-  { returnUrl: window.location.href },
-  { baseUrl: "https://api.elqnt.ai", orgId: "org-uuid" }
-);
-
-if (portal.data?.url) {
-  window.location.href = portal.data.url;
-}
+// Organization settings
+const { getSettings, createSettings, updateSettings, loading, error } = useOrgSettings(options);
 ```
 
-### Token Cache Management
-
-```typescript
-import { clearGatewayTokenCache } from "@elqnt/admin/api";
-
-// Clear cached token after org creation or user switch
-clearGatewayTokenCache();
-```
-
-## Types (`@elqnt/admin/models`)
+## Models
 
 ```typescript
 import type {
-  // Onboarding
-  OnboardingState,
-  OnboardingResponse,
-  CreateOrgResponse,
-  SendInvitesResponse,
-  CompleteOnboardingResponse,
-
-  // Organization
-  OrgSettings,
-  OrgSettingsResponse,
+  // User & Org
+  User, Org, OrgRole, Permission, Invite,
 
   // Billing
-  Plan,
-  OrganizationBilling,
-  UsageSummary,
-  CreditBalance,
-  PlansResponse,
-  SubscriptionResponse,
-  CreditsResponse,
-
-  // Provisioning
-  ProvisionAgentsResponse,
-  ProvisionEntitiesResponse,
-  ProvisionWorkflowsResponse,
-} from "@elqnt/admin/models";
-```
-
-### OnboardingState
-
-```typescript
-interface OnboardingState {
-  currentStep: string;
-  completedSteps: string[];
-  orgId?: string;
-  stripeSessionId?: string;
-  // ... step-specific data
-}
-```
-
-### OrgSettings
+  Plan, OrganizationBilling, CreditBalance, UsageSummary,
 
-```typescript
-interface OrgSettings {
-  id?: string;
-  orgId: string;
-  timezone?: string;
-  locale?: string;
-  features?: Record<string, boolean>;
-  agents?: string[];
-  entities?: string[];
-  workflows?: string[];
-}
+  // Onboarding
+  OnboardingState, OnboardingStep,
+} from "@elqnt/admin/models";
 ```
 
-## Deprecated APIs
+## Documentation
 
-The following provisioning APIs are deprecated. Use domain-specific packages instead:
-
-```typescript
-// DEPRECATED - use @elqnt/agents/api instead
-provisionDefaultAgentsApi(definitions, options)
-
-// DEPRECATED - use @elqnt/entity/api instead
-provisionEntitiesApi(definitions, options)
-
-// DEPRECATED - use @elqnt/workflow/api instead
-provisionWorkflowsApi(definitions, options)
-```
+Full API reference: https://docs.eloquent.ai/packages/admin
 
-## Peer Dependencies
+## Changelog
 
-- `react` ^18.0.0 || ^19.0.0
+See [CHANGELOG.md](./CHANGELOG.md)
 
 ## License