@elevasis/sdk 1.20.2 → 1.22.0

package/reference/packages/core/src/test-utils/README.md

@@ -1,37 +1,37 @@
-# Test Utilities
-
-Published test helpers for downstream consumers of `@elevasis/core`.
-
-The public `@elevasis/core/test-utils` subpath exposes:
-
-- `RLSTestContext` for dev-database RLS integration tests
-- `setupMatchMedia`, `setupResizeObserver`, and `setupBrowserMocks` for jsdom/browser test setup
-- `TEST_USERS`, `TEST_ORGS`, `TEST_MEMBERSHIPS`, and related fixture factories
-- `createMockSupabaseClient`, `createMockWorkOSClient`, and related mocks
-- base entity factories such as `makeProject`, `makeDeal`, and `makeTask`
-- organization model/profile builders such as `makeOrganizationModel`, `makeInitializationState`, and `makeUserProfile`
-
-## Published Usage
-
-### Browser Mocks
-
-```typescript
-import { setupBrowserMocks } from '@elevasis/core/test-utils'
-
-setupBrowserMocks()
-```
-
-### RLS Integration Tests
-
-```typescript
-import { RLSTestContext } from '@elevasis/core/test-utils'
-
-const ctx = new RLSTestContext()
-```
-
-`RLSTestContext` requires a configured Supabase development environment:
-
-- `SUPABASE_URL`
-- `SUPABASE_ANON_KEY`
-- `SUPABASE_SERVICE_KEY`
-- `SUPABASE_JWT_SECRET`
+# Test Utilities
+
+Published test helpers for downstream consumers of `@elevasis/core`.
+
+The public `@elevasis/core/test-utils` subpath exposes:
+
+- `RLSTestContext` for dev-database RLS integration tests
+- `setupMatchMedia`, `setupResizeObserver`, and `setupBrowserMocks` for jsdom/browser test setup
+- `TEST_USERS`, `TEST_ORGS`, `TEST_MEMBERSHIPS`, and related fixture factories
+- `createMockSupabaseClient`, `createMockWorkOSClient`, and related mocks
+- base entity factories such as `makeProject`, `makeDeal`, and `makeTask`
+- organization model/profile builders such as `makeOrganizationModel`, `makeInitializationState`, and `makeUserProfile`
+
+## Published Usage
+
+### Browser Mocks
+
+```typescript
+import { setupBrowserMocks } from '@elevasis/core/test-utils'
+
+setupBrowserMocks()
+```
+
+### RLS Integration Tests
+
+```typescript
+import { RLSTestContext } from '@elevasis/core/test-utils'
+
+const ctx = new RLSTestContext()
+```
+
+`RLSTestContext` requires a configured Supabase development environment:
+
+- `SUPABASE_URL`
+- `SUPABASE_ANON_KEY`
+- `SUPABASE_SERVICE_KEY`
+- `SUPABASE_JWT_SECRET`

package/reference/packages/ui/src/api/README.md

@@ -1,18 +1,18 @@
-# API
-
-The API surface provides the HTTP client provider, the context hook, and the API config types.
-
-## Exports
-
-- `ApiClientProvider`
-- `useApiClientContext`
-- `useApiClient`
-- `ApiClientContextValue`
-- `ApiClientProviderProps`
-- `ApiErrorDetails`
-
-## Use When
-
-- You need a shared API request client at the app root.
-- You want org-aware request access through `useApiClient`.
-
+# API
+
+The API surface provides the HTTP client provider, the context hook, and the API config types.
+
+## Exports
+
+- `ApiClientProvider`
+- `useApiClientContext`
+- `useApiClient`
+- `ApiClientContextValue`
+- `ApiClientProviderProps`
+- `ApiErrorDetails`
+
+## Use When
+
+- You need a shared API request client at the app root.
+- You want org-aware request access through `useApiClient`.
+

package/reference/packages/ui/src/app/README.md

@@ -1,24 +1,24 @@
-# App
-
-Published app factory for downstream applications.
-
-## Exports
-
-- `createElevasisApp(config)` -- factory that composes providers, router, auth, and theme into a mountable React app
-- `ElevasisAppConfig` -- configuration interface (router, query client, theme, store hooks, error handling)
-- `ElevasisAppStoreConfig` -- store integration hooks for theme state
-
-## Usage
-
-```ts
-import { createElevasisApp } from '@elevasis/ui/app'
-
-const { App } = createElevasisApp({
-  router,
-  queryClient,
-  store: { useThemePreset, useThemeColorScheme, useSetTheme },
-  themeConfig: { presets, defaultPreset },
-})
-```
-
-Consumers must import CSS separately in their entry point.
+# App
+
+Published app factory for downstream applications.
+
+## Exports
+
+- `createElevasisApp(config)` -- factory that composes providers, router, auth, and theme into a mountable React app
+- `ElevasisAppConfig` -- configuration interface (router, query client, theme, store hooks, error handling)
+- `ElevasisAppStoreConfig` -- store integration hooks for theme state
+
+## Usage
+
+```ts
+import { createElevasisApp } from '@elevasis/ui/app'
+
+const { App } = createElevasisApp({
+  router,
+  queryClient,
+  store: { useThemePreset, useThemeColorScheme, useSetTheme },
+  themeConfig: { presets, defaultPreset },
+})
+```
+
+Consumers must import CSS separately in their entry point.

package/reference/packages/ui/src/auth/README.md

@@ -1,18 +1,18 @@
-# Auth
-
-The auth surface is the published authentication entry point for UI shells.
-
-## Exports
-
-- `AuthProvider`
-- `useAuthContext`
-- `useStableAccessToken`
-- `useSessionCheck`
-- `ProtectedRoute`
-- `AdminGuard`
-
-## Use When
-
-- You need auth state, access tokens, or session lifecycle checks.
-- You need route-level guards for protected or admin-only UI.
-
+# Auth
+
+The auth surface is the published authentication entry point for UI shells.
+
+## Exports
+
+- `AuthProvider`
+- `useAuthContext`
+- `useStableAccessToken`
+- `useSessionCheck`
+- `ProtectedRoute`
+- `AdminGuard`
+
+## Use When
+
+- You need auth state, access tokens, or session lifecycle checks.
+- You need route-level guards for protected or admin-only UI.
+

package/reference/packages/ui/src/components/README.md

@@ -1,24 +1,24 @@
-# Components
-
-This barrel groups the shared visual and domain UI surfaces that remain part of the published component layer.
-
-## What It Covers
-
-- Acquisition and CRM UI primitives
-- Navigation, breadcrumbs, tables, forms, modals, and display components
-- Charts, monitoring widgets, notifications, and error states
-- Layout shells, backgrounds, and sidebar primitives
-- Typeform, rich text, content, and resource-definition helpers
-- Operations UI surfaces that are still shared at the component layer
-
-## Related Subpaths
-
-- `./components/navigation`
-- `./components/chat`
-- `./layout`
-- `./charts`
-
-## Notes
-
-- The component layer is broad by design, but feature-oriented application shells should still prefer `./features/*` when a dedicated feature surface exists.
-
+# Components
+
+This barrel groups the shared visual and domain UI surfaces that remain part of the published component layer.
+
+## What It Covers
+
+- Acquisition and CRM UI primitives
+- Navigation, breadcrumbs, tables, forms, modals, and display components
+- Charts, monitoring widgets, notifications, and error states
+- Layout shells, backgrounds, and sidebar primitives
+- Typeform, rich text, content, and resource-definition helpers
+- Operations UI surfaces that are still shared at the component layer
+
+## Related Subpaths
+
+- `./components/navigation`
+- `./components/chat`
+- `./layout`
+- `./charts`
+
+## Notes
+
+- The component layer is broad by design, but feature-oriented application shells should still prefer `./features/*` when a dedicated feature surface exists.
+

package/reference/packages/ui/src/execution/README.md

@@ -1,16 +1,16 @@
-# Execution
-
-The execution surface contains headless helpers for execution timelines, workflow layouts, and execution-specific data shaping.
-
-## Exports
-
-- Hooks under `./hooks`
-- Utilities under `./utils`
-- Execution types under `./types`
-- Shared execution constants
-
-## Use When
-
-- You need execution timeline or workflow graph helpers without pulling in visual shells.
-- You need shared execution math or formatting utilities.
-
+# Execution
+
+The execution surface contains headless helpers for execution timelines, workflow layouts, and execution-specific data shaping.
+
+## Exports
+
+- Hooks under `./hooks`
+- Utilities under `./utils`
+- Execution types under `./types`
+- Shared execution constants
+
+## Use When
+
+- You need execution timeline or workflow graph helpers without pulling in visual shells.
+- You need shared execution math or formatting utilities.
+

package/reference/packages/ui/src/features/README.md

@@ -1,28 +1,28 @@
-# Features
-
-Feature subpaths package complete shell-level UI flows for downstream apps.
-
-## Published Feature Surfaces
-
-- `./features/auth`
-- `./features/crm`
-- `./features/dashboard`
-- `./features/delivery`
-- `./features/lead-gen`
-- `./features/operations`
-- `./features/monitoring`
-- `./features/seo`
-- `./features/settings`
-
-## What They Contain
-
-- Route shells and page-level components
-- Sidebars and feature-specific navigation
-- Feature manifests for registry consumers
-- Feature-specific hooks and shared constants
-
-## Notes
-
-- These surfaces are meant for app composition, not for low-level design-system primitives.
-- Some feature exports are also re-exported through `./components` for convenience in legacy or mixed consumers.
-
+# Features
+
+Feature subpaths package complete shell-level UI flows for downstream apps.
+
+## Published Feature Surfaces
+
+- `./features/auth`
+- `./features/crm`
+- `./features/dashboard`
+- `./features/delivery`
+- `./features/lead-gen`
+- `./features/operations`
+- `./features/monitoring`
+- `./features/seo`
+- `./features/settings`
+
+## What They Contain
+
+- Route shells and page-level components
+- Sidebars and feature-specific navigation
+- Feature manifests for registry consumers
+- Feature-specific hooks and shared constants
+
+## Notes
+
+- These surfaces are meant for app composition, not for low-level design-system primitives.
+- Some feature exports are also re-exported through `./components` for convenience in legacy or mixed consumers.
+

package/reference/packages/ui/src/graph/README.md

@@ -1,16 +1,16 @@
-# Graph
-
-The graph surface is headless. It provides hooks, types, constants, and utilities for ReactFlow-based graph behavior.
-
-## Exports
-
-- Graph constants
-- Graph types
-- Graph hooks
-- Graph utilities
-
-## Notes
-
-- Visual graph components moved out of this package surface.
-- Use this subpath when you need graph behavior without the visual shell.
-
+# Graph
+
+The graph surface is headless. It provides hooks, types, constants, and utilities for ReactFlow-based graph behavior.
+
+## Exports
+
+- Graph constants
+- Graph types
+- Graph hooks
+- Graph utilities
+
+## Notes
+
+- Visual graph components moved out of this package surface.
+- Use this subpath when you need graph behavior without the visual shell.
+

package/reference/packages/ui/src/hooks/README.md

@@ -1,23 +1,23 @@
-# Hooks
-
-The hooks barrel is the published headless hook surface for the UI package.
-
-## Grouped Areas
-
-- Execution and workflow hooks
-- Scheduling hooks
-- Monitoring, observability, and notification hooks
-- Session and SSE hooks
-- Operations hooks, including command-view helpers
-- Feature access, table state, and service helpers
-- Acquisition and delivery hooks
-
-## Published Subpaths
-
-- `./hooks`
-- `./hooks/delivery`
-- `./hooks/operations/command-view/utils/transformCommandViewData`
-
-## Notes
-
-- This barrel is intentionally headless. It should not pull in the visual component layer.
+# Hooks
+
+The hooks barrel is the published headless hook surface for the UI package.
+
+## Grouped Areas
+
+- Execution and workflow hooks
+- Scheduling hooks
+- Monitoring, observability, and notification hooks
+- Session and SSE hooks
+- Operations hooks, including command-view helpers
+- Feature access, table state, and service helpers
+- Acquisition and delivery hooks
+
+## Published Subpaths
+
+- `./hooks`
+- `./hooks/delivery`
+- `./hooks/operations/command-view/utils/transformCommandViewData`
+
+## Notes
+
+- This barrel is intentionally headless. It should not pull in the visual component layer.

package/reference/packages/ui/src/initialization/README.md

@@ -1,19 +1,19 @@
-# Initialization
-
-The initialization surface coordinates org-aware app startup.
-
-## Exports
-
-- `InitializationProvider`
-- `useInitialization`
-- `InitializationContext`
-- `createUseAppInitialization`
-- `InitializationError`
-- `AppInitializationState`
-- `SupabaseUserProfile` type re-export
-
-## Use When
-
-- You need zero-config app bootstrap inside an organization-aware provider tree.
-- You still need the deprecated factory pattern for older consumers.
-
+# Initialization
+
+The initialization surface coordinates org-aware app startup.
+
+## Exports
+
+- `InitializationProvider`
+- `useInitialization`
+- `InitializationContext`
+- `createUseAppInitialization`
+- `InitializationError`
+- `AppInitializationState`
+- `SupabaseUserProfile` type re-export
+
+## Use When
+
+- You need zero-config app bootstrap inside an organization-aware provider tree.
+- You still need the deprecated factory pattern for older consumers.
+

package/reference/packages/ui/src/knowledge/README.md

@@ -1,31 +1,31 @@
-# @elevasis/ui/knowledge
-
-Read-only browser primitives for the Organization Model knowledge graph.
-
-## Surface
-
-| Export                                                                 | Purpose                                                                             |
-| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
-| `KnowledgeBrowser`                                                     | Selected-node detail pane. Tree/search now live in the feature sidebar.             |
-| `KnowledgeTree`                                                        | By-feature primary tree with hierarchical features and multi-governance duplication. |
-| `KnowledgeNodeList`                                                    | Legacy flat list of node summary cards; exported for compatibility.                 |
-| `KnowledgeNodeView`                                                    | Single knowledge-node detail view using `NodeDescribeShell` and relationship groups. |
-| `KnowledgeSearchBar`                                                   | Client-side search over `_generated/knowledge-search-index.json`.                   |
-| `KnowledgeSidebarMiddle`                                               | Deprecated legacy sidebar middle section; active sidebar lives under `features/knowledge/sidebar`. |
-| `KNOWLEDGE_ITEMS`                                                      | Deprecated default sidebar nav items retained for compatibility.                    |
-| `KnowledgeMDXProvider`, `useKnowledgeAllowlist`, `KNOWLEDGE_ALLOWLIST` | MDX runtime allowlist (`Card`, `Cards`, `Step`, `Steps`, `Callout`, `Tab`, `Tabs`). |
-| `KNOWLEDGE_BODIES`                                                     | Build-time-compiled MDX components keyed by node id.                                |
-
-## Customization tiers
-
-1. **Default** — mount `knowledgeManifest` from `@elevasis/ui/features/knowledge`.
-2. **Extend** — pass `extraComponents` to `KnowledgeMDXProvider` or compose around the feature sidebar primitives.
-3. **Replace** — call `@elevasis/core/knowledge` queries directly from project-owned routes.
-
-## Codegen
-
-`KNOWLEDGE_BODIES` and the search index are regenerated by `pnpm scaffold:sync` (or `pnpm knowledge:generate` to run only the knowledge step). Source: `canonicalOrganizationModel.knowledge.nodes` from `@repo/elevasis-core`.
-
-The Vite plugin at `@elevasis/ui/vite-plugin-knowledge` re-runs codegen on `buildStart` and watches the OM source dir for HMR.
-
-Phase 1 is read-only. Phase 2 will move bodies into Supabase and ship via `mdx-bundler`.
+# @elevasis/ui/knowledge
+
+Read-only browser primitives for the Organization Model knowledge graph.
+
+## Surface
+
+| Export                                                                 | Purpose                                                                             |
+| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `KnowledgeBrowser`                                                     | Selected-node detail pane. Tree/search now live in the feature sidebar.             |
+| `KnowledgeTree`                                                        | By-feature primary tree with hierarchical features and multi-governance duplication. |
+| `KnowledgeNodeList`                                                    | Legacy flat list of node summary cards; exported for compatibility.                 |
+| `KnowledgeNodeView`                                                    | Single knowledge-node detail view using `NodeDescribeShell` and relationship groups. |
+| `KnowledgeSearchBar`                                                   | Client-side search over `_generated/knowledge-search-index.json`.                   |
+| `KnowledgeSidebarMiddle`                                               | Deprecated legacy sidebar middle section; active sidebar lives under `features/knowledge/sidebar`. |
+| `KNOWLEDGE_ITEMS`                                                      | Deprecated default sidebar nav items retained for compatibility.                    |
+| `KnowledgeMDXProvider`, `useKnowledgeAllowlist`, `KNOWLEDGE_ALLOWLIST` | MDX runtime allowlist (`Card`, `Cards`, `Step`, `Steps`, `Callout`, `Tab`, `Tabs`). |
+| `KNOWLEDGE_BODIES`                                                     | Build-time-compiled MDX components keyed by node id.                                |
+
+## Customization tiers
+
+1. **Default** — mount `knowledgeManifest` from `@elevasis/ui/features/knowledge`.
+2. **Extend** — pass `extraComponents` to `KnowledgeMDXProvider` or compose around the feature sidebar primitives.
+3. **Replace** — call `@elevasis/core/knowledge` queries directly from project-owned routes.
+
+## Codegen
+
+`KNOWLEDGE_BODIES` and the search index are regenerated by `pnpm scaffold:sync` (or `pnpm knowledge:generate` to run only the knowledge step). Source: `canonicalOrganizationModel.knowledge.nodes` from `@repo/elevasis-core`.
+
+The Vite plugin at `@elevasis/ui/vite-plugin-knowledge` re-runs codegen on `buildStart` and watches the OM source dir for HMR.
+
+Phase 1 is read-only. Phase 2 will move bodies into Supabase and ship via `mdx-bundler`.

package/reference/packages/ui/src/organization/README.md

@@ -1,18 +1,18 @@
-# Organization
-
-The organization surface manages multi-tenancy state and the related UI controls.
-
-## Exports
-
-- `OrganizationProvider`
-- `OrganizationContext`
-- `useOrganization`
-- `OrganizationSwitcher`
-- Store types and the legacy slice creator
-- Deprecated hook factories for older consumers
-
-## Notes
-
-- Prefer the provider and context exports for new code.
-- Legacy Zustand-based helpers remain exported for migration compatibility.
-
+# Organization
+
+The organization surface manages multi-tenancy state and the related UI controls.
+
+## Exports
+
+- `OrganizationProvider`
+- `OrganizationContext`
+- `useOrganization`
+- `OrganizationSwitcher`
+- Store types and the legacy slice creator
+- Deprecated hook factories for older consumers
+
+## Notes
+
+- Prefer the provider and context exports for new code.
+- Legacy Zustand-based helpers remain exported for migration compatibility.
+

package/reference/packages/ui/src/profile/README.md

@@ -1,19 +1,19 @@
-# Profile
-
-The profile surface manages the user profile context and profile-backed helpers.
-
-## Exports
-
-- `ProfileProvider`
-- `useProfile`
-- `ProfileContextValue`
-- `useUserProfile`
-- `UseUserProfileReturn`
-- `UserProfileService`
-- `SupabaseUserProfile` type re-export
-
-## Use When
-
-- You need a shared user profile context.
-- You need a standalone profile service or hook for sync and access.
-
+# Profile
+
+The profile surface manages the user profile context and profile-backed helpers.
+
+## Exports
+
+- `ProfileProvider`
+- `useProfile`
+- `ProfileContextValue`
+- `useUserProfile`
+- `UseUserProfileReturn`
+- `UserProfileService`
+- `SupabaseUserProfile` type re-export
+
+## Use When
+
+- You need a shared user profile context.
+- You need a standalone profile service or hook for sync and access.
+