@kelpie/ui 0.11.0 → 0.13.0

package/src/api/resources/handbookSeed.ts

@@ -0,0 +1,63 @@
+import { seedHandbookBody, seedHandbookResultSchema } from '@kelpie/schemas'
+import type { SeedHandbookInput, SeedHandbookResult } from '@kelpie/schemas'
+import { useMutation, useQueryClient } from '@tanstack/react-query'
+
+import { useApiClient } from '../context.ts'
+import type { MutationResult } from '../resource.ts'
+import { asMutationResult } from './mutation.ts'
+import { useSession } from './session.ts'
+
+/**
+ * `POST /v1/workspaces/:id/handbook/seed` — onboarding step 4 seeds the starter
+ * handbook once the reader has picked an organisation type.
+ */
+
+export function useSeedHandbook(): MutationResult<
+  SeedHandbookInput & { readonly workspaceId: string },
+  SeedHandbookResult
+> {
+  const client = useApiClient()
+  const queryClient = useQueryClient()
+
+  const mutation = useMutation({
+    mutationFn: ({ workspaceId, ...input }: SeedHandbookInput & { readonly workspaceId: string }) =>
+      client.post(
+        `/workspaces/${workspaceId}/handbook/seed`,
+        seedHandbookBody(input),
+        seedHandbookResultSchema.parse,
+      ),
+    onSuccess: async () => {
+      await queryClient.invalidateQueries({ queryKey: ['handbook_pages'] })
+    },
+  })
+
+  return asMutationResult(mutation)
+}
+
+export function useSeedHandbookForWorkspace(): MutationResult<SeedHandbookInput, SeedHandbookResult> {
+  const { session } = useSession()
+  const seedHandbook = useSeedHandbook()
+
+  return {
+    run: (input: SeedHandbookInput) => {
+      const workspaceId = session?.workspaceId
+
+      if (workspaceId === null || workspaceId === undefined) {
+        return
+      }
+
+      seedHandbook.run({ ...input, workspaceId })
+    },
+    runAsync: async (input: SeedHandbookInput) => {
+      const workspaceId = session?.workspaceId
+
+      if (workspaceId === null || workspaceId === undefined) {
+        throw new Error('No workspace is active')
+      }
+
+      return seedHandbook.runAsync({ ...input, workspaceId })
+    },
+    isPending: seedHandbook.isPending,
+    error: seedHandbook.error,
+  }
+}

package/src/api/resources/moduleSettings.ts

@@ -41,6 +41,31 @@ export function useModuleSettings(): ModuleSettingsState {
   }
 }
 
+/**
+ * Whether this workspace currently has a toggleable module on.
+ *
+ * Record tabs that belong to a module (Events on a Person) must not render
+ * while that module is off: the page answers 403. Loading counts as off so the
+ * tab cannot flash on a workspace that has switched it off. A module missing
+ * from the list after load is treated as on, matching the sidebar: core
+ * surfaces that are not toggleable stay visible.
+ */
+export function useModuleEnabled(moduleId: string): boolean {
+  const { session } = useSession()
+  const { settings, isLoading } = useModuleSettings()
+
+  // No workspace yet (session still loading) is the same as settings still
+  // loading: treating a missing list as "on" would fetch attendances, then
+  // 403, on a workspace that has Events off.
+  if (session?.workspaceId === undefined || isLoading) {
+    return false
+  }
+
+  const setting = settings.find((entry) => entry.moduleId === moduleId)
+
+  return setting === undefined || setting.enabled
+}
+
 export interface SetModuleEnabledArguments {
   readonly moduleId: string
   readonly enabled: boolean

package/src/api/resources/planItems.ts

@@ -1,10 +1,10 @@
 import { createPlanItemBody, planItemBody, planItemSchema } from '@kelpie/schemas'
 import type {
   CreatePlanItemInput,
-  PipelineKind,
   PlanItem,
   PlanItemInput,
   PlanItemStatus,
+  PlanItemTargetType,
 } from '@kelpie/schemas'
 
 import type { QueryParameters } from '../client.ts'
@@ -12,7 +12,7 @@ import { createResourceHooks } from '../resource.ts'
 import type { ListOptions, MutationResult, RecordListResult, UpdateArguments } from '../resource.ts'
 
 /**
- * `/v1/plan_items`: the dated next steps on the four pipelines.
+ * `/v1/plan_items`: the dated next steps on pipeline records and Events.
  *
  * Unlike notes, this list is answerable workspace-wide, because the Planning
  * page is exactly that question. `useRecordPlanItems` narrows it to one record's
@@ -35,7 +35,7 @@ const planItems = createResourceHooks<PlanItem, CreatePlanItemInput, PlanItemInp
 export const MAX_PAGE_SIZE = 200
 
 export interface PlanItemFilters {
-  readonly targetType?: PipelineKind | undefined
+  readonly targetType?: PlanItemTargetType | undefined
   /** The records to read steps for. Repeats on the wire: `?target_id=a&target_id=b`. */
   readonly targetIds?: readonly string[] | undefined
   readonly statuses?: readonly PlanItemStatus[] | undefined
@@ -66,7 +66,7 @@ export function usePlanItems(
 
 /** One record's plan, in date order: what the panel on a detail page shows. */
 export function useRecordPlanItems(
-  targetType: PipelineKind,
+  targetType: PlanItemTargetType,
   targetId: string,
 ): RecordListResult<PlanItem> {
   return usePlanItems({ targetType, targetIds: [targetId] })
@@ -81,7 +81,7 @@ export function useRecordPlanItems(
  * dropped rather than sent, because the request would be a 422 in full.
  */
 export function usePlanItemsForRecords(
-  targetType: PipelineKind,
+  targetType: PlanItemTargetType,
   targetIds: readonly string[],
 ): RecordListResult<PlanItem> {
   return usePlanItems(

package/src/api/resources/publicConfig.ts

@@ -8,9 +8,9 @@ import { toError } from '../errors.ts'
 /**
  * The deployment metadata `GET /v1/public/config` reports.
  *
- * Read once, cached forever: neither `runtimeMode` nor `siteName` changes
- * while the app is open. The endpoint is public, so this hook works before a
- * session exists (the sign-in page reads it too).
+ * Read once, cached forever: neither `runtimeMode` nor `siteName` nor
+ * `regions` changes while the app is open. The endpoint is public, so this
+ * hook works before a session exists (the sign-in page reads it too).
  */
 
 const PUBLIC_CONFIG_KEY = ['public-config'] as const

package/src/api/resources/sampleData.ts

@@ -48,6 +48,8 @@ export function useInstallSampleData(): MutationResult<InstallSampleDataInput, S
           'enquiries',
           'roles',
           'candidates',
+          'events',
+          'attendances',
         ].map((name) => cache.invalidateQueries({ queryKey: [name] })),
       )
     },

package/src/api/resources/session.ts

@@ -1,4 +1,5 @@
 import {
+  accountWorkspaceSchema,
   confirmEmailVerificationBody,
   confirmPasswordResetBody,
   createWorkspaceBody,
@@ -7,9 +8,11 @@ import {
   sessionSchema,
   signUpBody,
   signedInAccountSchema,
+  switchWorkspaceBody,
   workspaceSchema,
 } from '@kelpie/schemas'
 import type {
+  AccountWorkspace,
   ConfirmEmailVerificationInput,
   ConfirmPasswordResetInput,
   CreateWorkspaceInput,
@@ -18,6 +21,7 @@ import type {
   Session,
   SignUpInput,
   SignedInAccount,
+  SwitchWorkspaceInput,
   Workspace,
 } from '@kelpie/schemas'
 import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query'
@@ -254,3 +258,58 @@ export function useCreateWorkspace(): MutationResult<CreateWorkspaceInput, Works
   return asMutationResult(mutation)
 }
 
+const ACCOUNT_WORKSPACES_KEY = ['account', 'workspaces'] as const
+
+export interface AccountWorkspacesState {
+  readonly workspaces: readonly AccountWorkspace[]
+  readonly isLoading: boolean
+  readonly error: Error | null
+}
+
+/**
+ * Workspaces this account belongs to.
+ *
+ * Lives under `/auth` rather than `/workspaces/:id` so a session whose current
+ * workspace is suspended can still list the others and switch. The shell reads
+ * this for the header switcher.
+ */
+export function useAccountWorkspaces(): AccountWorkspacesState {
+  const client = useApiClient()
+  const result = useQuery({
+    queryKey: ACCOUNT_WORKSPACES_KEY,
+    queryFn: async () => {
+      const page = await client.list('/auth/workspaces', accountWorkspaceSchema.parse)
+
+      return page.items
+    },
+  })
+
+  return {
+    workspaces: result.data ?? [],
+    isLoading: result.isPending,
+    error: toError(result.error),
+  }
+}
+
+/**
+ * Moves this session into another membership.
+ *
+ * Every cached CRM list belongs to the workspace that is being left, so the
+ * whole cache is dropped. Leaving Acme's people in the cache for Globex would
+ * mix two tenants, not just show stale names.
+ */
+export function useSwitchWorkspace(): MutationResult<SwitchWorkspaceInput, Session> {
+  const client = useApiClient()
+  const queryClient = useQueryClient()
+  const mutation = useMutation({
+    mutationFn: (input: SwitchWorkspaceInput) =>
+      client.post('/auth/workspace', switchWorkspaceBody(input), sessionSchema.parse),
+    onSuccess: async () => {
+      queryClient.clear()
+      await queryClient.fetchQuery(sessionQuery(client))
+    },
+  })
+
+  return asMutationResult(mutation)
+}
+

package/src/api/resources/workspace.ts

@@ -11,9 +11,8 @@ import { useSession } from './session.ts'
 /**
  * The workspace the session is in.
  *
- * Not a CRM resource: there is one of them, its id comes from the session rather
- * than a route, and there is no list. `createResourceHooks` would have nothing
- * to configure.
+ * Not a CRM resource: the id comes from the session rather than a route.
+ * The account's memberships are a different list (`GET /v1/auth/workspaces`).
  */
 
 const WORKSPACE_KEY = 'workspace'

package/src/app/KelpieApp.tsx

@@ -21,6 +21,8 @@ import { NotFoundPage } from '../pages/NotFoundPage.tsx'
 import { EnquiriesPage } from '../pages/EnquiriesPage.tsx'
 import { EnquiryDetail } from '../pages/EnquiryDetail.tsx'
 import { EnquiryStageSettingsPage } from '../pages/EnquiryStageSettingsPage.tsx'
+import { EventDetail } from '../pages/EventDetail.tsx'
+import { EventsPage } from '../pages/EventsPage.tsx'
 import { OpportunitiesPage } from '../pages/OpportunitiesPage.tsx'
 import { OpportunityDetail } from '../pages/OpportunityDetail.tsx'
 import { OpportunityStageSettingsPage } from '../pages/OpportunityStageSettingsPage.tsx'
@@ -58,6 +60,8 @@ import { DashboardPage } from '../pages/dashboard/DashboardPage.tsx'
 import { HandbookLayout } from '../pages/handbook/HandbookPage.tsx'
 import { HandbookStepPage } from '../pages/onboarding/HandbookStepPage.tsx'
 import { InvitesStepPage } from '../pages/onboarding/InvitesStepPage.tsx'
+import { ModulesStepPage } from '../pages/onboarding/ModulesStepPage.tsx'
+import { OrganisationStepPage } from '../pages/onboarding/OrganisationStepPage.tsx'
 import { WorkspaceStepPage } from '../pages/onboarding/WorkspaceStepPage.tsx'
 import { UiExtensionProvider } from '../registry/UiExtensionProvider.tsx'
 import type { RouteContribution } from '../registry/contributions.ts'
@@ -138,9 +142,11 @@ function AppRoutes(): React.JSX.Element {
       <Route path="/verify-email/pending" element={<VerifyEmailPendingPage />} />
 
       <Route element={<SessionGate />}>
-        {/* Inside the gate and outside the Shell: both steps need the workspace
-            that step 1 created, and neither is a place to start navigating the
-            app from. */}
+        {/* Inside the gate and outside the Shell: these steps need the workspace
+            that step 1 created, and none of them is a place to start navigating
+            the app from. */}
+        <Route path="/onboarding/organisation" element={<OrganisationStepPage />} />
+        <Route path="/onboarding/modules" element={<ModulesStepPage />} />
         <Route path="/onboarding/invites" element={<InvitesStepPage />} />
         <Route path="/onboarding/handbook" element={<HandbookStepPage />} />
 
@@ -167,6 +173,8 @@ function AppRoutes(): React.JSX.Element {
           <Route path="fundraising" element={<FundraisingPage />} />
           <Route path="fundraising/settings" element={<RaiseStageSettingsPage />} />
           <Route path="fundraising/:id" element={<RaiseDetail />} />
+          <Route path="events" element={<EventsPage />} />
+          <Route path="events/:id" element={<EventDetail />} />
           <Route path="partnerships" element={<PartnershipsPage />} />
           <Route path="partnerships/settings" element={<PartnershipStageSettingsPage />} />
           <Route path="partnerships/:id" element={<PartnershipDetail />} />

package/src/components/ActivitiesPanel.tsx

@@ -50,6 +50,8 @@ const TARGET_TYPE_LABELS: Readonly<Record<RecordTargetType, string>> = {
   raise: 'Raise',
   enquiry: 'Enquiry',
   candidate: 'Candidate',
+  event: 'Event',
+  attendance: 'Attendance',
 }
 
 interface MonthGroup {