@elevasis/ui 1.3.3 → 1.3.5

package/dist/organization/index.d.ts

@@ -1,22 +1,267 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+import { UseBoundStore, StoreApi } from 'zustand';
+
 /**
- * Organization module - Multi-tenancy concerns
- *
- * Exports:
- * - OrganizationProvider: Context provider that internalizes org state (replaces Zustand slice)
- * - useOrganization: Hook for consuming OrganizationProvider context
- * - OrganizationContextValue: Value type exposed by OrganizationProvider
- * - OrganizationsState, OrganizationsActions, OrganizationsSlice: Store types (legacy)
- * - createOrganizationsSlice: Zustand slice creator for organization state (legacy)
- * - createUseOrganizations: Factory to create useOrganizations hook for app's store (deprecated)
- * - createUseOrgInitialization: Factory to create useOrgInitialization hook (deprecated)
- * - OrganizationSwitcher: Component for switching organizations
- */
-export { OrganizationProvider } from './context/OrganizationProvider';
-export { useOrganization } from './context/OrganizationContext';
-export type { OrganizationContextValue } from './context/OrganizationContext';
-export * from './store/types';
-export { createOrganizationsSlice } from './store/organizationsSlice';
-export { createUseOrganizations } from './hooks/useOrganizations';
-export { createUseOrgInitialization } from './hooks/useOrgInitialization';
-export type { UseOrganizationsReturn, UseApiClientReturn, UseOrgInitializationReturn } from './hooks/useOrgInitialization';
-//# sourceMappingURL=index.d.ts.map
+ * Multi-tenancy configuration types
+ *
+ * Config is stored in dedicated `config` columns (NOT nested in metadata):
+ * - organizations.config: Org-level feature config
+ * - org_memberships.config: Per-user-per-org feature overrides
+ * - users.config: User-global config
+ */
+/**
+ * Org-level feature config (stored in organizations.config)
+ * Controls which features are available to all org members
+ * Valid feature keys: operations, monitoring, acquisition, calibration, seo
+ */
+interface OrgFeatureConfig {
+    features?: {
+        operations?: boolean;
+        monitoring?: boolean;
+        acquisition?: boolean;
+        calibration?: boolean;
+        seo?: boolean;
+    };
+}
+/**
+ * Per-user-per-org config (stored in org_memberships.config)
+ * Overrides org-level feature config for specific users
+ */
+type MembershipFeatureConfig = OrgFeatureConfig;
+
+/**
+ * Organization Membership types based on WorkOS API
+ */
+interface OrganizationMembership {
+    object: 'organization_membership';
+    id: string;
+    userId: string;
+    organizationId: string;
+    role: {
+        slug: string;
+    };
+    status: 'active' | 'inactive';
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Extended membership with user and organization details for UI
+ */
+interface MembershipWithDetails extends OrganizationMembership {
+    user?: {
+        id: string;
+        email: string;
+        firstName?: string;
+        lastName?: string;
+        profilePictureUrl?: string;
+    };
+    organization?: {
+        id: string;
+        name: string;
+        workos_org_id: string;
+        primaryDomain?: string;
+        is_test?: boolean;
+        status?: string;
+        metadata?: Record<string, unknown>;
+        config?: OrgFeatureConfig;
+    };
+    config?: MembershipFeatureConfig;
+}
+
+/**
+ * The value exposed by OrganizationProvider to all consumers.
+ */
+interface OrganizationContextValue {
+    /** WorkOS organization ID of the currently selected organization. */
+    currentWorkOSOrganizationId: string | null;
+    /** Supabase (UUID) organization ID of the currently selected organization. */
+    currentSupabaseOrganizationId: string | null;
+    /** Full membership record for the currently selected organization. */
+    currentMembership: MembershipWithDetails | null;
+    /** All memberships for the authenticated user. */
+    memberships: MembershipWithDetails[];
+    /** True while the initial membership list is being fetched. */
+    isInitializing: boolean;
+    /** True while a subsequent org switch / refresh is in flight. */
+    isOrgRefreshing: boolean;
+    /** Error message if the membership fetch or org switch failed. */
+    error: string | null;
+    /**
+     * Switch the active organization.
+     *
+     * Persists the selection to `last_visited_org` on the user profile and
+     * invalidates all org-scoped TanStack Query cache entries.
+     *
+     * @param workosOrgId - WorkOS organization ID to switch to.
+     */
+    switchOrganization: (workosOrgId: string) => void;
+    /**
+     * Re-fetch memberships and retry org selection after an error.
+     */
+    retry: () => Promise<void>;
+}
+/**
+ * Consumes the nearest OrganizationProvider.
+ *
+ * @throws {Error} If called outside of an OrganizationProvider tree.
+ */
+declare function useOrganization(): OrganizationContextValue;
+
+/**
+ * Provides organization state to its subtree via React Context.
+ *
+ * Must be rendered inside:
+ * - ElevasisServiceProvider (needs apiRequest)
+ * - ProfileProvider (needs useProfile for last_visited_org preference)
+ * - A TanStack QueryClientProvider (needs useQueryClient for cache invalidation)
+ *
+ * Behaviors:
+ * - Fetches all memberships for the authenticated user via GET /memberships/my-memberships
+ * - Selects the active org by priority: saved preference > WorkOS org ID > first membership
+ * - Persists org switches to PATCH /users/me { last_visited_org }
+ * - Clears all state when the user signs out (user becomes null)
+ */
+declare function OrganizationProvider({ children }: {
+    children: ReactNode;
+}): react.FunctionComponentElement<react.ProviderProps<OrganizationContextValue | null>>;
+
+interface OrganizationsState {
+    currentWorkOSOrganizationId: string | null;
+    currentSupabaseOrganizationId: string | null;
+    currentMembership: MembershipWithDetails | null;
+    isInitializing: boolean;
+    isOrgRefreshing: boolean;
+    error: string | null;
+}
+interface OrganizationsActions {
+    setCurrentWorkOSOrganizationId: (workOSorgId: string | null) => void;
+    setCurrentMembership: (membership: MembershipWithDetails | null) => void;
+    setOrganizationsInitializing: (initializing: boolean) => void;
+    setOrganizationsLoading: (loading: boolean) => void;
+    setOrganizationsError: (error: string | null) => void;
+}
+interface OrganizationsSlice extends OrganizationsActions {
+    organizations: OrganizationsState;
+}
+
+/**
+ * Type for Zustand's immer set function.
+ * This is a simplified version that works with immer middleware.
+ * The replace parameter uses false | undefined to match Zustand's type for immer mutation support.
+ */
+type ImmerSet<T> = (partial: T | Partial<T> | ((state: T) => void), replace?: false | undefined, action?: string) => void;
+/**
+ * Creates the organizations slice for Zustand store.
+ *
+ * Usage in app:
+ * ```typescript
+ * import { createOrganizationsSlice } from '@repo/ui/organization'
+ *
+ * // Define AppState that extends OrganizationsSlice
+ * interface AppState extends OrganizationsSlice {
+ *   // other slices...
+ * }
+ *
+ * // Pass the slice creator to your store
+ * const useAppStore = create<AppState>()(
+ *   devtools(
+ *     immer((...a) => ({
+ *       ...createOrganizationsSlice(...a),
+ *       // other slices...
+ *     }))
+ *   )
+ * )
+ * ```
+ *
+ * Note: The slice creator accepts set/get/store from any Zustand store
+ * that extends OrganizationsSlice. It returns the slice state and actions.
+ */
+declare const createOrganizationsSlice: <TAppState extends OrganizationsSlice>(set: ImmerSet<TAppState>, _get: () => TAppState, _store: unknown) => OrganizationsSlice;
+
+/**
+ * Factory function to create a useOrganizations hook for your app's store.
+ *
+ * Usage in app:
+ * ```typescript
+ * import { createUseOrganizations } from '@repo/ui/organization'
+ * import { useAppStore } from './zustand/store'
+ *
+ * export const useOrganizations = createUseOrganizations(useAppStore)
+ * ```
+ *
+ * This pattern allows the shared package to provide the hook logic
+ * while each app provides its own store instance.
+ */
+declare function createUseOrganizations<TStore extends OrganizationsSlice>(useStore: UseBoundStore<StoreApi<TStore>>): () => {
+    setCurrentWorkOSOrganizationId: (workOSorgId: string | null) => void;
+    setCurrentMembership: (membership: MembershipWithDetails | null) => void;
+    setOrganizationsInitializing: (initializing: boolean) => void;
+    setOrganizationsLoading: (loading: boolean) => void;
+    setOrganizationsError: (error: string | null) => void;
+    organizations: OrganizationsState;
+    currentWorkOSOrganizationId: string | null;
+    currentSupabaseOrganizationId: string | null;
+    currentMembership: MembershipWithDetails | null;
+    isInitializing: boolean;
+    isOrgRefreshing: boolean;
+    error: string | null;
+};
+
+/**
+ * Type for the useOrganizations hook return value
+ */
+interface UseOrganizationsReturn {
+    currentWorkOSOrganizationId: string | null;
+    currentMembership: MembershipWithDetails | null;
+    setCurrentWorkOSOrganizationId: (id: string | null) => void;
+    setCurrentMembership: (membership: MembershipWithDetails | null) => void;
+    setOrganizationsInitializing: (initializing: boolean) => void;
+    setOrganizationsLoading: (loading: boolean) => void;
+    setOrganizationsError: (error: string | null) => void;
+    organizations: {
+        isInitializing: boolean;
+        isOrgRefreshing: boolean;
+        error: string | null;
+    };
+}
+/**
+ * Type for the useApiClient hook return value
+ */
+interface UseApiClientReturn {
+    apiRequest: <T = unknown>(path: string, options?: RequestInit) => Promise<T>;
+}
+/**
+ * Return type for useOrgInitialization hook
+ */
+interface UseOrgInitializationReturn {
+    memberships: MembershipWithDetails[];
+    isInitializing: boolean;
+    isLoading: boolean;
+    isInitialized: boolean;
+    error: string | null;
+    currentOrganization: MembershipWithDetails['organization'] | null;
+    retry: () => Promise<void>;
+}
+/**
+ * Factory function to create a useOrgInitialization hook for your app.
+ *
+ * Usage in app:
+ * ```typescript
+ * import { createUseOrgInitialization } from '@repo/ui/organization'
+ * import { useOrganizations } from './hooks/useOrganizations'
+ * import { useApiClient } from './api/hooks/useApiClient'
+ *
+ * export const useOrgInitialization = createUseOrgInitialization(
+ *   useOrganizations,
+ *   useApiClient
+ * )
+ * ```
+ *
+ * This pattern allows the shared package to provide the hook logic
+ * while each app provides its own hook instances.
+ */
+declare function createUseOrgInitialization(useOrganizations: () => UseOrganizationsReturn, useApiClient: () => UseApiClientReturn): () => UseOrgInitializationReturn;
+
+export { OrganizationProvider, createOrganizationsSlice, createUseOrgInitialization, createUseOrganizations, useOrganization };
+export type { MembershipWithDetails, OrganizationContextValue, OrganizationsActions, OrganizationsSlice, OrganizationsState, UseApiClientReturn, UseOrgInitializationReturn, UseOrganizationsReturn };