@kelpie/server 0.8.0 → 0.10.0

package/src/modules/forms/repository.ts

@@ -1,11 +1,15 @@
 import { and, asc, eq, ilike, inArray, or } from 'drizzle-orm'
 import type { SQL } from 'drizzle-orm'
+import type { AnyPgColumn } from 'drizzle-orm/pg-core'
+import type { FormSubmissionLinkTarget, PipelineKind } from '@kelpie/schemas'
 
 import { keysetCondition, orderByWindow, textSort, timestampSort } from '../../lib/pagination.ts'
 import type { ListWindow, SortableFields } from '../../lib/pagination.ts'
 import { containsPattern } from '../../lib/search.ts'
 import type { Queryable } from '../../runtime/transaction.ts'
-import { formFields, formSubmissions, forms } from './schema.ts'
+import { lists } from '../lists/schema.ts'
+import type { RecordTargetType } from '../recordTargets.ts'
+import { formAttachTargets, formFields, formLists, formSubmissions, forms } from './schema.ts'
 
 export type FormRecord = typeof forms.$inferSelect
 export type FormFieldRecord = typeof formFields.$inferSelect
@@ -209,6 +213,72 @@ export function listSubmissions(
     .limit(window.fetchLimit)
 }
 
+/**
+ * Maps each `FormSubmissionLinkTarget` (declared in `@kelpie/schemas`) to the
+ * drizzle column that names the record. Keeping the enum in schemas keeps the
+ * wire shape one source of truth; the column mapping lives here because it
+ * references types the schemas package cannot see.
+ */
+const SUBMISSION_LINK_COLUMNS: Readonly<Record<FormSubmissionLinkTarget, AnyPgColumn>> = {
+  person: formSubmissions.personId,
+  company: formSubmissions.companyId,
+  position: formSubmissions.positionId,
+  deal: formSubmissions.dealId,
+  opportunity: formSubmissions.opportunityId,
+  partnership: formSubmissions.partnershipId,
+  enquiry: formSubmissions.enquiryId,
+}
+
+/**
+ * Lists submissions whose {target}_id points at `targetId`.
+ *
+ * The record itself is not checked here — the workspace scope and the FK
+ * filter are enough for a read. A caller reaching for a target from another
+ * workspace or one that no longer exists gets an empty page, which mirrors
+ * the answer any other cross-workspace read gives.
+ */
+export function listSubmissionsLinkedTo(
+  db: Queryable,
+  workspaceId: string,
+  target: FormSubmissionLinkTarget,
+  targetId: string,
+  window: ListWindow<FormSubmissionRecord>,
+): Promise<FormSubmissionRecord[]> {
+  return db
+    .select()
+    .from(formSubmissions)
+    .where(
+      and(
+        eq(formSubmissions.workspaceId, workspaceId),
+        eq(SUBMISSION_LINK_COLUMNS[target], targetId),
+        keysetCondition(window, formSubmissions.id),
+      ),
+    )
+    .orderBy(...orderByWindow(window, formSubmissions.id))
+    .limit(window.fetchLimit)
+}
+
+export async function findSubmission(
+  db: Queryable,
+  workspaceId: string,
+  formId: string,
+  id: string,
+): Promise<FormSubmissionRecord | undefined> {
+  const [row] = await db
+    .select()
+    .from(formSubmissions)
+    .where(
+      and(
+        eq(formSubmissions.workspaceId, workspaceId),
+        eq(formSubmissions.formId, formId),
+        eq(formSubmissions.id, id),
+      ),
+    )
+    .limit(1)
+
+  return row
+}
+
 export async function insertSubmission(
   db: Queryable,
   values: FormSubmissionColumns,
@@ -221,3 +291,94 @@ export async function insertSubmission(
 
   return created
 }
+
+/** One form's configured list memberships, joined to the list for target-type. */
+export interface FormListRow {
+  readonly listId: string
+  readonly targetType: RecordTargetType
+  /**
+   * When the list has a consent purpose, form-driven adds capture consent
+   * against it. Carried through so submission.ts needs no second query.
+   */
+  readonly consentPurposeId: string | null
+}
+
+export async function listFormLists(db: Queryable, formId: string): Promise<FormListRow[]> {
+  const rows = await db
+    .select({
+      listId: formLists.listId,
+      targetType: lists.targetType,
+      consentPurposeId: lists.consentPurposeId,
+    })
+    .from(formLists)
+    .innerJoin(lists, eq(lists.id, formLists.listId))
+    .where(eq(formLists.formId, formId))
+    .orderBy(asc(formLists.listId))
+
+  return rows.map((row) => ({
+    listId: row.listId,
+    targetType: row.targetType as RecordTargetType,
+    consentPurposeId: row.consentPurposeId,
+  }))
+}
+
+export async function replaceFormLists(
+  db: Queryable,
+  workspaceId: string,
+  formId: string,
+  listIds: readonly string[],
+): Promise<void> {
+  await db.delete(formLists).where(eq(formLists.formId, formId))
+
+  if (listIds.length === 0) {
+    return
+  }
+
+  await db.insert(formLists).values(listIds.map((listId) => ({ workspaceId, formId, listId })))
+}
+
+/** One form's configured attach targets, ordered so a resent identical set is not a write. */
+export interface FormAttachTargetRow {
+  readonly targetType: PipelineKind
+  readonly targetId: string
+}
+
+export async function listAttachTargets(
+  db: Queryable,
+  formId: string,
+): Promise<FormAttachTargetRow[]> {
+  const rows = await db
+    .select({ targetType: formAttachTargets.targetType, targetId: formAttachTargets.targetId })
+    .from(formAttachTargets)
+    .where(eq(formAttachTargets.formId, formId))
+    .orderBy(asc(formAttachTargets.targetType), asc(formAttachTargets.targetId))
+
+  return rows.map((row) => ({
+    targetType: row.targetType as PipelineKind,
+    targetId: row.targetId,
+  }))
+}
+
+export async function replaceAttachTargets(
+  db: Queryable,
+  workspaceId: string,
+  formId: string,
+  targets: readonly FormAttachTargetRow[],
+): Promise<void> {
+  await db.delete(formAttachTargets).where(eq(formAttachTargets.formId, formId))
+
+  if (targets.length === 0) {
+    return
+  }
+
+  await db
+    .insert(formAttachTargets)
+    .values(
+      targets.map((target) => ({
+        workspaceId,
+        formId,
+        targetType: target.targetType,
+        targetId: target.targetId,
+      })),
+    )
+}

package/src/modules/forms/routes.ts

@@ -1,5 +1,7 @@
 import type { Context, Hono } from 'hono'
 import { z } from 'zod'
+import { FORM_SUBMISSION_LINK_TARGETS, PIPELINE_KINDS } from '@kelpie/schemas'
+import type { FormAttachTarget, FormSubmissionLinkTarget } from '@kelpie/schemas'
 
 import { AppError } from '../../lib/errors.ts'
 import {
@@ -52,10 +54,19 @@ const fieldBody = z.strictObject({
   map_to: z.enum(FORM_FIELD_MAP_TARGETS),
   options: z.array(optionBody).default([]),
   placeholder: z.string().nullable().default(null),
+  statement: z.string().nullable().default(null),
+  consent_purpose_ids: z.array(z.string().min(1)).default([]),
+  consent_purpose_labels: z.record(z.string().min(1), z.string()).default({}),
+})
+
+const attachTargetBody = z.strictObject({
+  target_type: z.enum(PIPELINE_KINDS),
+  target_id: z.string().min(1),
 })
 
 const formShape = {
   name: z.string().min(1),
+  title: z.string().min(1),
   description: z.string().nullable(),
   status: z.enum(FORM_STATUSES),
   fields: z.array(fieldBody),
@@ -63,6 +74,25 @@ const formShape = {
   create_deal: z.boolean(),
   deal_stage_id: z.string().min(1).nullable(),
   deal_name_template: z.string().nullable(),
+  create_opportunity: z.boolean(),
+  opportunity_kind: z.string().nullable(),
+  opportunity_stage_id: z.string().min(1).nullable(),
+  opportunity_name_template: z.string().nullable(),
+  opportunity_owner_id: z.string().min(1).nullable(),
+  create_partnership: z.boolean(),
+  partnership_kind: z.string().nullable(),
+  partnership_stage_id: z.string().min(1).nullable(),
+  partnership_name_template: z.string().nullable(),
+  partnership_owner_id: z.string().min(1).nullable(),
+  create_enquiry: z.boolean(),
+  enquiry_source: z.string().nullable(),
+  enquiry_stage_id: z.string().min(1).nullable(),
+  enquiry_name_template: z.string().nullable(),
+  enquiry_owner_id: z.string().min(1).nullable(),
+  person_tags: z.array(z.string().min(1)),
+  company_tags: z.array(z.string().min(1)),
+  list_ids: z.array(z.string().min(1)),
+  attach_targets: z.array(attachTargetBody),
 }
 
 /**
@@ -76,12 +106,34 @@ const formShape = {
  */
 export const createBody = z.strictObject({
   ...formShape,
+  // Absent → copy of `name` in `toCreateInput`, so a create that only names the
+  // form still gets a public heading without a second field on every caller.
+  title: formShape.title.optional(),
   description: formShape.description.default(null),
   status: formShape.status.default('active'),
   thank_you_message: formShape.thank_you_message.default('Thanks. We will be in touch.'),
   create_deal: formShape.create_deal.default(false),
   deal_stage_id: formShape.deal_stage_id.default(null),
   deal_name_template: formShape.deal_name_template.default(null),
+  create_opportunity: formShape.create_opportunity.default(false),
+  opportunity_kind: formShape.opportunity_kind.default(null),
+  opportunity_stage_id: formShape.opportunity_stage_id.default(null),
+  opportunity_name_template: formShape.opportunity_name_template.default(null),
+  opportunity_owner_id: formShape.opportunity_owner_id.default(null),
+  create_partnership: formShape.create_partnership.default(false),
+  partnership_kind: formShape.partnership_kind.default(null),
+  partnership_stage_id: formShape.partnership_stage_id.default(null),
+  partnership_name_template: formShape.partnership_name_template.default(null),
+  partnership_owner_id: formShape.partnership_owner_id.default(null),
+  create_enquiry: formShape.create_enquiry.default(false),
+  enquiry_source: formShape.enquiry_source.default(null),
+  enquiry_stage_id: formShape.enquiry_stage_id.default(null),
+  enquiry_name_template: formShape.enquiry_name_template.default(null),
+  enquiry_owner_id: formShape.enquiry_owner_id.default(null),
+  person_tags: formShape.person_tags.default([]),
+  company_tags: formShape.company_tags.default([]),
+  list_ids: formShape.list_ids.default([]),
+  attach_targets: formShape.attach_targets.default([]),
 })
 
 export const updateBody = z.strictObject(formShape).partial()
@@ -123,12 +175,20 @@ function toFieldDraft(field: z.infer<typeof fieldBody>): FieldDraft {
       valueType: option.value_type,
     })),
     placeholder: field.placeholder,
+    statement: field.statement,
+    consentPurposeIds: field.consent_purpose_ids,
+    consentPurposeLabels: field.consent_purpose_labels,
   }
 }
 
+function toAttachTarget(body: z.infer<typeof attachTargetBody>): FormAttachTarget {
+  return { targetType: body.target_type, targetId: body.target_id }
+}
+
 export function toCreateInput(body: z.infer<typeof createBody>): CreateFormInput {
   return {
     name: body.name,
+    title: body.title ?? body.name,
     description: body.description,
     status: body.status,
     fields: body.fields.map(toFieldDraft),
@@ -136,12 +196,32 @@ export function toCreateInput(body: z.infer<typeof createBody>): CreateFormInput
     createDeal: body.create_deal,
     dealStageId: body.deal_stage_id,
     dealNameTemplate: body.deal_name_template,
+    createOpportunity: body.create_opportunity,
+    opportunityKind: body.opportunity_kind,
+    opportunityStageId: body.opportunity_stage_id,
+    opportunityNameTemplate: body.opportunity_name_template,
+    opportunityOwnerId: body.opportunity_owner_id,
+    createPartnership: body.create_partnership,
+    partnershipKind: body.partnership_kind,
+    partnershipStageId: body.partnership_stage_id,
+    partnershipNameTemplate: body.partnership_name_template,
+    partnershipOwnerId: body.partnership_owner_id,
+    createEnquiry: body.create_enquiry,
+    enquirySource: body.enquiry_source,
+    enquiryStageId: body.enquiry_stage_id,
+    enquiryNameTemplate: body.enquiry_name_template,
+    enquiryOwnerId: body.enquiry_owner_id,
+    personTags: body.person_tags,
+    companyTags: body.company_tags,
+    listIds: body.list_ids,
+    attachTargets: body.attach_targets.map(toAttachTarget),
   }
 }
 
 export function toUpdateInput(body: z.infer<typeof updateBody>): UpdateFormInput {
   return {
     ...(body.name === undefined ? {} : { name: body.name }),
+    ...(body.title === undefined ? {} : { title: body.title }),
     ...(body.description === undefined ? {} : { description: body.description }),
     ...(body.status === undefined ? {} : { status: body.status }),
     ...(body.fields === undefined ? {} : { fields: body.fields.map(toFieldDraft) }),
@@ -151,6 +231,45 @@ export function toUpdateInput(body: z.infer<typeof updateBody>): UpdateFormInput
     ...(body.deal_name_template === undefined
       ? {}
       : { dealNameTemplate: body.deal_name_template }),
+    ...(body.create_opportunity === undefined
+      ? {}
+      : { createOpportunity: body.create_opportunity }),
+    ...(body.opportunity_kind === undefined ? {} : { opportunityKind: body.opportunity_kind }),
+    ...(body.opportunity_stage_id === undefined
+      ? {}
+      : { opportunityStageId: body.opportunity_stage_id }),
+    ...(body.opportunity_name_template === undefined
+      ? {}
+      : { opportunityNameTemplate: body.opportunity_name_template }),
+    ...(body.opportunity_owner_id === undefined
+      ? {}
+      : { opportunityOwnerId: body.opportunity_owner_id }),
+    ...(body.create_partnership === undefined
+      ? {}
+      : { createPartnership: body.create_partnership }),
+    ...(body.partnership_kind === undefined ? {} : { partnershipKind: body.partnership_kind }),
+    ...(body.partnership_stage_id === undefined
+      ? {}
+      : { partnershipStageId: body.partnership_stage_id }),
+    ...(body.partnership_name_template === undefined
+      ? {}
+      : { partnershipNameTemplate: body.partnership_name_template }),
+    ...(body.partnership_owner_id === undefined
+      ? {}
+      : { partnershipOwnerId: body.partnership_owner_id }),
+    ...(body.create_enquiry === undefined ? {} : { createEnquiry: body.create_enquiry }),
+    ...(body.enquiry_source === undefined ? {} : { enquirySource: body.enquiry_source }),
+    ...(body.enquiry_stage_id === undefined ? {} : { enquiryStageId: body.enquiry_stage_id }),
+    ...(body.enquiry_name_template === undefined
+      ? {}
+      : { enquiryNameTemplate: body.enquiry_name_template }),
+    ...(body.enquiry_owner_id === undefined ? {} : { enquiryOwnerId: body.enquiry_owner_id }),
+    ...(body.person_tags === undefined ? {} : { personTags: body.person_tags }),
+    ...(body.company_tags === undefined ? {} : { companyTags: body.company_tags }),
+    ...(body.list_ids === undefined ? {} : { listIds: body.list_ids }),
+    ...(body.attach_targets === undefined
+      ? {}
+      : { attachTargets: body.attach_targets.map(toAttachTarget) }),
   }
 }
 
@@ -158,6 +277,7 @@ export function formResponse(form: FormView): Record<string, unknown> {
   return {
     id: form.id,
     name: form.name,
+    title: form.title,
     description: form.description,
     status: form.status,
     fields: form.fields.map((field) => ({
@@ -172,12 +292,37 @@ export function formResponse(form: FormView): Record<string, unknown> {
         value_type: option.valueType,
       })),
       placeholder: field.placeholder,
+      statement: field.statement,
+      consent_purpose_ids: field.consentPurposeIds,
+      consent_purpose_labels: field.consentPurposeLabels,
       sort_order: field.sortOrder,
     })),
     thank_you_message: form.thankYouMessage,
     create_deal: form.createDeal,
     deal_stage_id: form.dealStageId,
     deal_name_template: form.dealNameTemplate,
+    create_opportunity: form.createOpportunity,
+    opportunity_kind: form.opportunityKind,
+    opportunity_stage_id: form.opportunityStageId,
+    opportunity_name_template: form.opportunityNameTemplate,
+    opportunity_owner_id: form.opportunityOwnerId,
+    create_partnership: form.createPartnership,
+    partnership_kind: form.partnershipKind,
+    partnership_stage_id: form.partnershipStageId,
+    partnership_name_template: form.partnershipNameTemplate,
+    partnership_owner_id: form.partnershipOwnerId,
+    create_enquiry: form.createEnquiry,
+    enquiry_source: form.enquirySource,
+    enquiry_stage_id: form.enquiryStageId,
+    enquiry_name_template: form.enquiryNameTemplate,
+    enquiry_owner_id: form.enquiryOwnerId,
+    person_tags: form.personTags,
+    company_tags: form.companyTags,
+    list_ids: form.listIds,
+    attach_targets: form.attachTargets.map((target) => ({
+      target_type: target.targetType,
+      target_id: target.targetId,
+    })),
     public_key: form.publicKey,
     created_at: form.createdAt.toISOString(),
     updated_at: form.updatedAt.toISOString(),
@@ -194,15 +339,28 @@ export function formSubmissionResponse(submission: FormSubmissionView): Record<s
     company_id: submission.companyId,
     position_id: submission.positionId,
     deal_id: submission.dealId,
+    opportunity_id: submission.opportunityId,
+    partnership_id: submission.partnershipId,
+    enquiry_id: submission.enquiryId,
+    action_log: submission.actionLog.map((entry) => ({
+      action: entry.action,
+      status: entry.status,
+      detail: entry.detail,
+    })),
     created_at: submission.createdAt.toISOString(),
   }
 }
 
-/** The absolute URL of a form's hosted embed page, on the origin this request arrived at. */
+/** The absolute URL of a form's bare iframe document (fields only). */
 export function embedUrlFor(context: Context, publicKey: string): string {
   return `${requestOrigin(context)}${PUBLIC_ROUTE_PREFIX}/forms/${publicKey}/embed`
 }
 
+/** The absolute URL of a form's standalone hosted page (brand chrome). */
+export function hostedUrlFor(context: Context, publicKey: string): string {
+  return `${embedUrlFor(context, publicKey)}?view=page`
+}
+
 export function mountFormsRoutes(router: Hono, dependencies: FormsRoutesDependencies): void {
   const requireActor = (context: Context): Promise<Actor> => resolveActorFrom(dependencies, context)
 
@@ -256,6 +414,53 @@ export function mountFormsRoutes(router: Hono, dependencies: FormsRoutesDependen
     return context.json(pageBody(page, formSubmissionResponse))
   })
 
+  /**
+   * Submissions filtered by the record they touched.
+   *
+   * `target_type` names one of the seven FK columns a submission carries
+   * (person, company, position, deal, opportunity, partnership, enquiry) and
+   * `target_id` is the record's id. Both are required — an unfiltered global
+   * list of submissions is deliberately not a route here, since a workspace's
+   * submissions live under their form, not as a top-level browse.
+   */
+  router.get('/form-submissions', async (context) => {
+    const rawTargetType = context.req.query('target_type')
+    const targetId = context.req.query('target_id')
+
+    if (rawTargetType === undefined || targetId === undefined) {
+      throw AppError.validationFailed('target_type and target_id are required', [
+        { field: 'target_type', message: 'Missing filter' },
+        { field: 'target_id', message: 'Missing filter' },
+      ])
+    }
+
+    if (!(FORM_SUBMISSION_LINK_TARGETS as readonly string[]).includes(rawTargetType)) {
+      throw AppError.validationFailed(
+        `target_type must be one of ${FORM_SUBMISSION_LINK_TARGETS.join(', ')}`,
+        [{ field: 'target_type', message: `Got ${rawTargetType}` }],
+      )
+    }
+
+    const page = await dependencies.service.listSubmissionsLinkedTo(
+      await requireActor(context),
+      rawTargetType as FormSubmissionLinkTarget,
+      targetId,
+      readListParameters(context),
+    )
+
+    return context.json(pageBody(page, formSubmissionResponse))
+  })
+
+  router.get('/forms/:id/submissions/:submissionId', async (context) => {
+    const submission = await dependencies.service.getSubmission(
+      await requireActor(context),
+      context.req.param('id'),
+      context.req.param('submissionId'),
+    )
+
+    return context.json(formSubmissionResponse(submission))
+  })
+
   /**
    * What to paste into a website.
    *
@@ -265,10 +470,15 @@ export function mountFormsRoutes(router: Hono, dependencies: FormsRoutesDependen
    */
   router.get('/forms/:id/embed', async (context) => {
     const form = await dependencies.service.get(await requireActor(context), context.req.param('id'))
-    const snippets = embedSnippets(embedUrlFor(context, form.publicKey), form.id)
+    const snippets = embedSnippets(
+      hostedUrlFor(context, form.publicKey),
+      embedUrlFor(context, form.publicKey),
+      form.id,
+    )
 
     return context.json({
       url: snippets.url,
+      embed_url: snippets.embedUrl,
       iframe_snippet: snippets.iframe,
       script_snippet: snippets.script,
     })