@kelpie/schemas 0.11.0 → 0.13.0

package/src/formMapTargets.ts

@@ -1,9 +1,12 @@
 import type { CustomFieldObjectType, CustomFieldType, FormFieldType } from './values.ts'
+import { COMPANY_ADDRESS_KINDS, PERSON_ADDRESS_KINDS } from './address.ts'
 import {
   ACCOUNT_TYPES,
   COMPANY_STAGES,
   CUSTOM_FIELD_OBJECT_TYPE_LABELS,
   CUSTOM_FIELD_TYPE_LABELS,
+  EVENT_FORMATS,
+  EVENT_STATUSES,
   FORM_FIELD_MAP_TARGET_LABELS,
   ICP_FITS,
   INFLUENCE_LEVELS,
@@ -33,6 +36,7 @@ export const FORM_MAP_OBJECT_TYPES = [
   'partnership',
   'enquiry',
   'raise',
+  'event',
 ] as const
 
 export type FormMapObjectType = (typeof FORM_MAP_OBJECT_TYPES)[number]
@@ -46,6 +50,7 @@ export const FORM_MAP_OBJECT_TYPE_LABELS: Readonly<Record<FormMapObjectType, str
   partnership: 'Partnership',
   enquiry: 'Enquiry',
   raise: 'Raise',
+  event: 'Event',
 }
 
 /** The value shape a mapped target expects from a submit answer. */
@@ -98,7 +103,18 @@ const PERSON_STANDARD_FIELDS: readonly FormMapStandardField[] = [
   { field: 'email', label: 'email', valueType: 'email' },
   { field: 'phones', label: 'phone', valueType: 'phones' },
   { field: 'timezone', label: 'timezone', valueType: 'text' },
-  { field: 'location', label: 'location', valueType: 'text' },
+  {
+    field: 'address.kind',
+    label: 'address kind',
+    valueType: 'enum',
+    enumValues: PERSON_ADDRESS_KINDS,
+  },
+  { field: 'address.line1', label: 'address line 1', valueType: 'text' },
+  { field: 'address.line2', label: 'address line 2', valueType: 'text' },
+  { field: 'address.city', label: 'address city', valueType: 'text' },
+  { field: 'address.region', label: 'address region', valueType: 'text' },
+  { field: 'address.postal_code', label: 'address postal code', valueType: 'text' },
+  { field: 'address.country', label: 'address country', valueType: 'text' },
   {
     field: 'preferred_channel',
     label: 'preferred channel',
@@ -139,8 +155,18 @@ const COMPANY_STANDARD_FIELDS: readonly FormMapStandardField[] = [
     valueType: 'enum',
     enumValues: SIZE_BANDS,
   },
-  { field: 'hq', label: 'hq', valueType: 'text' },
-  { field: 'website', label: 'website', valueType: 'url' },
+  {
+    field: 'address.kind',
+    label: 'address kind',
+    valueType: 'enum',
+    enumValues: COMPANY_ADDRESS_KINDS,
+  },
+  { field: 'address.line1', label: 'address line 1', valueType: 'text' },
+  { field: 'address.line2', label: 'address line 2', valueType: 'text' },
+  { field: 'address.city', label: 'address city', valueType: 'text' },
+  { field: 'address.region', label: 'address region', valueType: 'text' },
+  { field: 'address.postal_code', label: 'address postal code', valueType: 'text' },
+  { field: 'address.country', label: 'address country', valueType: 'text' },
   {
     field: 'account_type',
     label: 'account type',
@@ -211,6 +237,18 @@ const RAISE_STANDARD_FIELDS: readonly FormMapStandardField[] = [
   { field: 'tags', label: 'tags', valueType: 'tags' },
 ]
 
+const EVENT_STANDARD_FIELDS: readonly FormMapStandardField[] = [
+  { field: 'name', label: 'name', valueType: 'text' },
+  { field: 'kind', label: 'kind', valueType: 'text' },
+  { field: 'location', label: 'location', valueType: 'text' },
+  { field: 'meeting_url', label: 'meeting URL', valueType: 'url' },
+  { field: 'format', label: 'format', valueType: 'enum', enumValues: EVENT_FORMATS },
+  { field: 'details', label: 'details', valueType: 'long_text' },
+  { field: 'status', label: 'status', valueType: 'enum', enumValues: EVENT_STATUSES },
+  { field: 'summary', label: 'summary', valueType: 'long_text' },
+  { field: 'tags', label: 'tags', valueType: 'tags' },
+]
+
 /** Standard writable fields per object type, keyed by object. */
 export const FORM_STANDARD_MAP_FIELDS: Readonly<
   Record<FormMapObjectType, readonly FormMapStandardField[]>
@@ -223,6 +261,7 @@ export const FORM_STANDARD_MAP_FIELDS: Readonly<
   partnership: PARTNERSHIP_STANDARD_FIELDS,
   enquiry: ENQUIRY_STANDARD_FIELDS,
   raise: RAISE_STANDARD_FIELDS,
+  event: EVENT_STANDARD_FIELDS,
 }
 
 function standardFieldTarget(objectType: FormMapObjectType, field: FormMapStandardField): string {
@@ -343,7 +382,7 @@ export function parseFormMapTarget(target: string): ParsedFormMapTarget | undefi
     }
   }
 
-  const standardMatch = /^([a-z_]+)\.([a-z_]+)$/.exec(target)
+  const standardMatch = /^([a-z_]+)\.([a-z][a-z0-9_.]*)$/.exec(target)
 
   if (standardMatch === null) {
     return undefined

package/src/importExport.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod'
 
+import { addressCsvColumns, COMPANY_ADDRESS_KINDS, PERSON_ADDRESS_KINDS } from './address.ts'
 import type { CustomFieldObjectType, PipelineKind } from './values.ts'
 import { idSchema, recordTimestamps } from './wire.ts'
 import type { RecordTimestamps } from './wire.ts'
@@ -180,8 +181,7 @@ export const OBJECT_COLUMNS: Readonly<Record<ImportObject, readonly CsvColumn[]>
     { key: 'description', label: 'Description', required: false },
     { key: 'summary', label: 'Summary', required: false },
     { key: 'tags', label: 'Tags', required: false },
-    { key: 'website', label: 'Website', required: false },
-    { key: 'hq', label: 'HQ', required: false },
+    ...addressCsvColumns(COMPANY_ADDRESS_KINDS),
   ],
   people: [
     { key: 'name', label: 'Name', required: false },
@@ -191,7 +191,7 @@ export const OBJECT_COLUMNS: Readonly<Record<ImportObject, readonly CsvColumn[]>
     { key: 'suffix', label: 'Suffix', required: false },
     { key: 'email', label: 'Email', required: true },
     { key: 'timezone', label: 'Timezone', required: false },
-    { key: 'location', label: 'Location', required: false },
+    ...addressCsvColumns(PERSON_ADDRESS_KINDS),
     { key: 'preferred_channel', label: 'Preferred channel', required: false },
     { key: 'influence', label: 'Influence', required: false },
     { key: 'relationship', label: 'Relationship', required: false },

package/src/index.ts

@@ -21,6 +21,10 @@ export {
   AGENT_TASK_PLACEMENTS,
   AGENT_TASK_TARGET_TYPES,
   API_KEY_KINDS,
+  ATTENDANCE_SOURCE_LABELS,
+  ATTENDANCE_SOURCES,
+  ATTENDANCE_STATUS_LABELS,
+  ATTENDANCE_STATUSES,
   CANDIDATE_STATUS_LABELS,
   CANDIDATE_STATUSES,
   COMPANY_STAGES,
@@ -34,9 +38,16 @@ export {
   CUSTOM_FIELD_TYPE_LABELS,
   CUSTOM_FIELD_TYPES,
   CUSTOM_FIELD_TYPES_WITH_OPTIONS,
+  EVENT_ASSOCIATION_TARGET_TYPE_LABELS,
+  EVENT_ASSOCIATION_TARGET_TYPES,
+  EVENT_FORMAT_LABELS,
+  EVENT_FORMATS,
+  EVENT_STATUS_LABELS,
+  EVENT_STATUSES,
   EXTENSIBLE_RECORD_TYPES,
   FIRST_INTERVIEW_STAGE,
   FORM_ACTION_STATUSES,
+  FORM_ATTACH_TARGET_TYPES,
   FORM_BOOLEAN_FIELD_TYPES,
   FORM_FIELD_MAP_TARGET_LABELS,
   FORM_FIELD_MAP_TARGETS,
@@ -58,6 +69,8 @@ export {
   PIPELINE_KINDS,
   PLAN_ITEM_STATUS_LABELS,
   PLAN_ITEM_STATUSES,
+  PLAN_ITEM_TARGET_TYPE_LABELS,
+  PLAN_ITEM_TARGET_TYPES,
   PREFERRED_CHANNELS,
   RECORD_TARGET_TYPE_LABELS,
   RECORD_TARGET_TYPES,
@@ -82,6 +95,8 @@ export type {
   AgentTaskPlacement,
   AgentTaskTargetType,
   ApiKeyKind,
+  AttendanceSource,
+  AttendanceStatus,
   CandidateStatus,
   CompanyStage,
   ConsentPurposeStatus,
@@ -90,8 +105,12 @@ export type {
   CustomFieldObjectType,
   CustomFieldType,
   CustomFieldTypeWithOptions,
+  EventAssociationTargetType,
+  EventFormat,
+  EventStatus,
   ExtensibleRecordType,
   FormActionStatus,
+  FormAttachTargetType,
   FormBooleanFieldType,
   FormFieldMapTarget,
   FormFieldType,
@@ -105,6 +124,7 @@ export type {
   MemberRole,
   PipelineKind,
   PlanItemStatus,
+  PlanItemTargetType,
   PreferredChannel,
   RecordTargetType,
   Relationship,
@@ -164,6 +184,44 @@ export type { EventActor, EventTarget, KelpieEvent, UpdateEventData } from './ev
 
 export { composeName } from './names.ts'
 export type { NameParts } from './names.ts'
+
+export {
+  COUNTRIES,
+  COUNTRY_CODES,
+  countryName,
+  isCountryCode,
+  normaliseCountry,
+} from './countries.ts'
+export type { Country } from './countries.ts'
+
+export {
+  ADDRESS_PARTS,
+  COMPANY_ADDRESS_KINDS,
+  COMPANY_ADDRESS_KIND_LABELS,
+  PERSON_ADDRESS_KINDS,
+  PERSON_ADDRESS_KIND_LABELS,
+  addressBody,
+  addressColumnKey,
+  addressColumnLabel,
+  addressCsvColumns,
+  companyAddressColumnKeys,
+  companyAddressSchema,
+  companyAddressesSchema,
+  formatAddress,
+  personAddressColumnKeys,
+  personAddressSchema,
+  personAddressesSchema,
+  primaryAddress,
+} from './address.ts'
+export type {
+  AddressPart,
+  CompanyAddress,
+  CompanyAddressKind,
+  PersonAddress,
+  PersonAddressKind,
+  PostalAddress,
+} from './address.ts'
+
 export { personBody, personSchema } from './person.ts'
 export type { Person, PersonInput, SocialProfile } from './person.ts'
 
@@ -205,6 +263,15 @@ export type { Role, RoleInput } from './role.ts'
 export { candidateBody, candidateSchema, createCandidateBody } from './candidate.ts'
 export type { Candidate, CandidateInput, CreateCandidateInput } from './candidate.ts'
 
+export { attendanceBody, attendanceSchema, createAttendanceBody } from './attendance.ts'
+export type { Attendance, AttendanceInput, CreateAttendanceInput } from './attendance.ts'
+
+export { createEventBody, eventBody, eventSchema } from './event.ts'
+export type { CreateEventInput, Event, EventAssociation, EventInput } from './event.ts'
+
+export { eventAssociationRowSchema } from './eventAssociation.ts'
+export type { EventAssociationRow } from './eventAssociation.ts'
+
 export {
   createPipelineStageBody,
   pipelineStageSchema,
@@ -419,6 +486,7 @@ export type {
   DashboardSignal,
   DashboardStaleContact,
   DashboardTouchpoint,
+  DashboardUpcomingEvent,
   TargetRef,
 } from './dashboard.ts'
 
@@ -442,26 +510,36 @@ export { createInviteBody, inviteSchema } from './invite.ts'
 export type { CreateInviteInput, Invite } from './invite.ts'
 
 export {
+  accountWorkspaceSchema,
   confirmEmailVerificationBody,
   confirmPasswordResetBody,
   createWorkspaceBody,
+  HANDBOOK_TEMPLATE_IDS,
   logInBody,
   requestPasswordResetBody,
+  seedHandbookBody,
+  seedHandbookResultSchema,
   sessionSchema,
   signUpBody,
   signedInAccountSchema,
+  switchWorkspaceBody,
   updateWorkspaceBody,
   workspaceSchema,
 } from './session.ts'
 export type {
+  AccountWorkspace,
   ConfirmEmailVerificationInput,
   ConfirmPasswordResetInput,
   CreateWorkspaceInput,
+  HandbookTemplateId,
   LogInInput,
   RequestPasswordResetInput,
+  SeedHandbookInput,
+  SeedHandbookResult,
   Session,
   SignUpInput,
   SignedInAccount,
+  SwitchWorkspaceInput,
   UpdateWorkspaceInput,
   Workspace,
 } from './session.ts'
@@ -486,5 +564,5 @@ export type {
   UpdateAccountPreferencesInput,
 } from './account.ts'
 
-export { publicConfigSchema } from './publicConfig.ts'
-export type { PublicConfig, PublicRuntimeMode } from './publicConfig.ts'
+export { isHttpOrigin, publicConfigSchema, publicRegionSchema, publicRegionsSchema } from './publicConfig.ts'
+export type { PublicConfig, PublicRegion, PublicRuntimeMode } from './publicConfig.ts'

package/src/person.ts

@@ -5,6 +5,8 @@ import {
   customFieldValuesSchema,
 } from './customField.ts'
 import type { CustomFieldValue, CustomFieldValues } from './customField.ts'
+import { addressBody, personAddressesSchema } from './address.ts'
+import type { PersonAddress } from './address.ts'
 import { personConsentSchema, personConsentWriteBody } from './personConsent.ts'
 import type { PersonConsent, PersonConsentInput } from './personConsent.ts'
 import {
@@ -43,7 +45,7 @@ export interface Person extends RecordTimestamps {
   readonly phones: readonly string[]
   readonly socialProfiles: readonly SocialProfile[]
   readonly timezone: string | null
-  readonly location: string | null
+  readonly addresses: readonly PersonAddress[]
   readonly preferredChannel: PreferredChannel
   readonly influence: Influence
   readonly relationship: Relationship
@@ -79,7 +81,7 @@ export const personSchema: z.ZodType<Person, unknown> = z
     phones: z.array(z.string()),
     social_profiles: z.array(socialProfileSchema),
     timezone: z.string().nullable(),
-    location: z.string().nullable(),
+    addresses: personAddressesSchema,
     preferred_channel: z.enum(PREFERRED_CHANNELS),
     influence: z.enum(INFLUENCE_LEVELS),
     relationship: z.enum(RELATIONSHIP_LEVELS),
@@ -103,7 +105,7 @@ export const personSchema: z.ZodType<Person, unknown> = z
       phones: wire.phones,
       socialProfiles: wire.social_profiles,
       timezone: wire.timezone,
-      location: wire.location,
+      addresses: wire.addresses,
       preferredChannel: wire.preferred_channel,
       influence: wire.influence,
       relationship: wire.relationship,
@@ -134,7 +136,7 @@ export interface PersonInput {
   readonly phones?: readonly string[]
   readonly socialProfiles?: readonly SocialProfile[]
   readonly timezone?: string | null
-  readonly location?: string | null
+  readonly addresses?: readonly PersonAddress[]
   readonly preferredChannel?: PreferredChannel
   readonly influence?: Influence
   readonly relationship?: Relationship
@@ -166,7 +168,7 @@ export function personBody(input: PersonInput): Record<string, unknown> {
     phones: input.phones,
     social_profiles: input.socialProfiles,
     timezone: input.timezone,
-    location: input.location,
+    addresses: input.addresses?.map(addressBody),
     preferred_channel: input.preferredChannel,
     influence: input.influence,
     relationship: input.relationship,

package/src/planItem.ts

@@ -1,14 +1,14 @@
 import { z } from 'zod'
 
-import { PIPELINE_KINDS, PLAN_ITEM_STATUSES } from './values.ts'
-import type { PipelineKind, PlanItemStatus } from './values.ts'
+import { PLAN_ITEM_STATUSES, PLAN_ITEM_TARGET_TYPES } from './values.ts'
+import type { PlanItemStatus, PlanItemTargetType } from './values.ts'
 import { definedFields, idSchema, recordTimestamps } from './wire.ts'
 import type { RecordTimestamps } from './wire.ts'
 
 /**
  * Wire and write shapes for `/v1/plan_items`.
  *
- * A plan item is a dated action on one of the four pipelines. It replaces any
+ * A plan item is a dated action on a pipeline record or an Event. It replaces any
  * next-step text field (`brief.md`): the date, the owner, and the status are
  * columns, so "what is overdue" is a query rather than a read of prose.
  *
@@ -19,7 +19,7 @@ import type { RecordTimestamps } from './wire.ts'
 
 export interface PlanItem extends RecordTimestamps {
   readonly id: string
-  readonly targetType: PipelineKind
+  readonly targetType: PlanItemTargetType
   readonly targetId: string
   /** `YYYY-MM-DD`, per `api.md` date-only fields. */
   readonly date: string
@@ -31,7 +31,7 @@ export interface PlanItem extends RecordTimestamps {
 export const planItemSchema: z.ZodType<PlanItem, unknown> = z
   .object({
     id: idSchema,
-    target_type: z.enum(PIPELINE_KINDS),
+    target_type: z.enum(PLAN_ITEM_TARGET_TYPES),
     target_id: idSchema,
     date: z.string(),
     title: z.string(),
@@ -54,7 +54,7 @@ export const planItemSchema: z.ZodType<PlanItem, unknown> = z
   )
 
 export interface CreatePlanItemInput {
-  readonly targetType: PipelineKind
+  readonly targetType: PlanItemTargetType
   readonly targetId: string
   readonly date: string
   readonly title: string

package/src/publicConfig.ts

@@ -5,27 +5,68 @@ import { z } from 'zod'
  *
  * A public, credential-free endpoint the browser reads once at boot. It names
  * which runtime the server is in, and the human-readable name of this
- * deployment. The UI uses `runtimeMode` to gate a non-production banner and
- * `siteName` to label it. Nothing here is sensitive: `runtimeMode` is
- * observable from any error message, and `siteName` exists to be visible.
+ * deployment. The UI uses `runtimeMode` to gate a non-production banner,
+ * `siteName` to label it, `signupsEnabled` to show or hide the sign-up form,
+ * and `regions` to draw a region switcher on signed-out pages. Nothing here
+ * is sensitive: `runtimeMode` is observable from any error message, and the
+ * other fields exist to be visible.
  */
 
 export type PublicRuntimeMode = 'development' | 'test' | 'production'
 
+/**
+ * One deployable origin a multi-region assembly advertises on the sign-in
+ * page. `origin` is the host the browser navigates to; the path and query
+ * stay. An empty list (the default) means a single-origin install.
+ */
+export interface PublicRegion {
+  readonly id: string
+  readonly label: string
+  readonly origin: string
+}
+
 export interface PublicConfig {
   readonly runtimeMode: PublicRuntimeMode
   /** Undefined when the assembly did not set `KELPIE_SITE_NAME`. */
   readonly siteName: string | null
+  /** False when the instance has closed new-account creation (`SIGNUPS=closed`). */
+  readonly signupsEnabled: boolean
+  /** Empty when the assembly did not declare regions. Two or more draws a switcher. */
+  readonly regions: readonly PublicRegion[]
 }
 
+/**
+ * True when `value` is an absolute `http:` or `https:` origin, with no path
+ * or query. The switcher concatenates this with the current path, so a path
+ * on the origin would double up. Written as a pattern rather than `new URL`
+ * so this package does not take a DOM lib.
+ */
+const HTTP_ORIGIN = /^https?:\/\/[^/?#]+$/u
+
+export function isHttpOrigin(value: string): boolean {
+  return HTTP_ORIGIN.test(value)
+}
+
+export const publicRegionSchema = z.strictObject({
+  id: z.string().min(1),
+  label: z.string().min(1),
+  origin: z.string().refine(isHttpOrigin, { message: 'must be an absolute http or https origin' }),
+})
+
+export const publicRegionsSchema = z.array(publicRegionSchema)
+
 export const publicConfigSchema = z
   .strictObject({
     runtime_mode: z.enum(['development', 'test', 'production']),
     site_name: z.string().min(1).nullable(),
+    signups_enabled: z.boolean(),
+    regions: publicRegionsSchema.optional().default([]),
   })
   .transform(
     (wire): PublicConfig => ({
       runtimeMode: wire.runtime_mode,
       siteName: wire.site_name,
+      signupsEnabled: wire.signups_enabled,
+      regions: wire.regions,
     }),
   )

package/src/sampleData.ts

@@ -3,8 +3,11 @@ import { z } from 'zod'
 /**
  * Wire shape for `POST /v1/workspaces/:id/sample-data`.
  *
- * The endpoint takes no body. The response is a count per object type, so a
- * caller can tell the reader what the button just did without a second query.
+ * The endpoint takes no body. Existing records stay; the fixture is inserted
+ * next to them. A second install of the same fixture is `409` when a sample
+ * email or domain is already present. The response is a count per object type,
+ * so a caller can tell the reader what the button just did without a second
+ * query.
  */
 
 export interface SampleDataCounts {
@@ -20,6 +23,8 @@ export interface SampleDataCounts {
   readonly enquiries: number
   readonly roles: number
   readonly candidates: number
+  readonly events: number
+  readonly attendances: number
 }
 
 export const sampleDataCountsSchema: z.ZodType<SampleDataCounts, unknown> = z
@@ -36,6 +41,8 @@ export const sampleDataCountsSchema: z.ZodType<SampleDataCounts, unknown> = z
     enquiries: z.number().int().nonnegative(),
     roles: z.number().int().nonnegative(),
     candidates: z.number().int().nonnegative(),
+    events: z.number().int().nonnegative(),
+    attendances: z.number().int().nonnegative(),
   })
   .transform(
     (wire): SampleDataCounts => ({
@@ -51,5 +58,7 @@ export const sampleDataCountsSchema: z.ZodType<SampleDataCounts, unknown> = z
       enquiries: wire.enquiries,
       roles: wire.roles,
       candidates: wire.candidates,
+      events: wire.events,
+      attendances: wire.attendances,
     }),
   )

package/src/session.ts

@@ -86,16 +86,92 @@ export const workspaceSchema: z.ZodType<Workspace, unknown> = z
     }),
   )
 
+/**
+ * One workspace the signed-in account belongs to, as `GET /v1/auth/workspaces`
+ * returns it. `role` is this account's membership, not a workspace setting.
+ */
+export interface AccountWorkspace {
+  readonly id: string
+  readonly name: string
+  readonly slug: string
+  readonly timezone: string
+  readonly role: MemberRole
+}
+
+export const accountWorkspaceSchema: z.ZodType<AccountWorkspace, unknown> = z
+  .object({
+    id: idSchema,
+    name: z.string(),
+    slug: z.string(),
+    timezone: z.string(),
+    role: z.enum(MEMBER_ROLES),
+  })
+  .transform(
+    (wire): AccountWorkspace => ({
+      id: wire.id,
+      name: wire.name,
+      slug: wire.slug,
+      timezone: wire.timezone,
+      role: wire.role,
+    }),
+  )
+
+/** Body for `POST /v1/auth/workspace`: move this session into a membership. */
+export interface SwitchWorkspaceInput {
+  readonly workspaceId: string
+}
+
+export function switchWorkspaceBody(input: SwitchWorkspaceInput): Record<string, unknown> {
+  return { workspace_id: input.workspaceId }
+}
+
+export const HANDBOOK_TEMPLATE_IDS = [
+  'startup',
+  'agency',
+  'nonprofit',
+  'community',
+  'professional-services',
+  'creator',
+] as const
+
+export type HandbookTemplateId = (typeof HANDBOOK_TEMPLATE_IDS)[number]
+
 export interface CreateWorkspaceInput {
   readonly name: string
   readonly slug: string
   readonly timezone: string
 }
 
+export interface SeedHandbookInput {
+  readonly handbookTemplate: HandbookTemplateId
+  readonly replace?: boolean | undefined
+}
+
+export interface SeedHandbookResult {
+  readonly handbookPages: number
+}
+
+export const seedHandbookResultSchema: z.ZodType<SeedHandbookResult, unknown> = z
+  .object({
+    handbook_pages: z.number(),
+  })
+  .transform(
+    (wire): SeedHandbookResult => ({
+      handbookPages: wire.handbook_pages,
+    }),
+  )
+
 export function createWorkspaceBody(input: CreateWorkspaceInput): Record<string, unknown> {
   return { name: input.name, slug: input.slug, timezone: input.timezone }
 }
 
+export function seedHandbookBody(input: SeedHandbookInput): Record<string, unknown> {
+  return definedFields({
+    handbook_template: input.handbookTemplate,
+    replace: input.replace,
+  })
+}
+
 /** Settings a workspace admin can change. */
 export interface UpdateWorkspaceInput {
   readonly name?: string