Files
WebForm-mw/app/api/data/route.ts
T
Joel Brock 8ecf64c79b Stage 0: org-contact custom fields (Food_Co_op_Organizing)
Adds four fields from the Organization Contact's Food_Co_op_Organizing
custom group to the Stage 0 (always-visible) section:

  Date Incorporated                (date, editable)
  Name on Incorporation Certificate (text, editable)
  Certificate of Incorporation     (readonly; see note)
  Equity share                     (currency, editable)

These live on the Organization Contact record, not on the Check-in
activity, so they read/write through a different code path:

  - FieldConfig gains civiContactField, mutually exclusive with civiField
  - /api/data extends the org Contact.get select to include them and
    merges values into the prefill payload keyed by form-side name
  - /api/submit splits incoming values: contact-bound fields go through
    Contact.update (run first), activity-bound fields stay in the
    Activity.create call (run second)
  - FieldRenderer readonly branch now detects file-shaped values
    ({id, file_name}) and displays the filename rather than [object Object]

Certificate_of_Incorporation is wired readonly only: the form's
file-upload pipeline is not actually wired end-to-end (FileList drops
at JSON.stringify in onSubmit; no /api/upload endpoint exists). A
follow-up will close that gap.

Also adds scripts/inspect-org-custom-fields.mjs, a one-off introspection
script for dumping CustomField metadata when wiring a new group.
2026-06-04 17:37:36 -07:00

268 lines
10 KiB
TypeScript

/**
* GET /api/data?cid=<cid>&cs=<cs>
*
* Verifies the checksum, resolves the org from the contact via the
* Primary Contact relationship, derives the org's current Framework Stage
* from the most recent `Check-in (organizing)` activity whose Stage custom
* field is non-empty (staff set this manually to mark transitions; the
* form itself leaves it null), and walks past activities for per-field
* most-recent prefill.
*
* Also fetches the OptionValue rows for any option_group_ids referenced by
* the form (so radio/select/multiselect fields render with real CRM-defined
* options) and returns them in `payload.options`.
*
* Returns FormDataPayload (see types/form.ts).
*
* STUB MODE: if CiviCRM env vars are unset, returns mock data + a small set
* of mock options so the UI is exercisable without a live CRM.
*/
import { NextRequest, NextResponse } from "next/server";
import { civi, verifyChecksum } from "@/lib/civicrm";
import { loadPrefill } from "@/lib/prefill";
import {
allFields,
optionGroupIds,
ACTIVITY_TYPE_NAME,
ACTIVITY_STAGE_FIELD,
FORM_CONTACT_RELATIONSHIP,
} from "@/config/form";
import type { FormDataPayload, SelectOption } from "@/types/form";
/**
* Fallback when an org has no stage-bearing check-in activity yet.
* Matches the entry stage in CiviCRM's Stage option group.
*/
const DEFAULT_STAGE = "Inquiry";
const STUB_PAYLOAD: FormDataPayload = {
orgName: "Sample Co-op (stub)",
currentStage: "Organizing",
contact: {
firstName: "Jordan",
lastName: "Sample",
email: "jordan.sample@example.coop",
},
prefill: {
Peer_Group_Participation: "Yes",
Members__current_: 87,
Total_members_at_opening: null,
Projected_Year_1_Sales: 2400000,
Projected_Year_2_Sales: 2950000,
Total_cost_of_project: 4200000,
Vision: "2024-09-15",
Business_Concept: "2024-12-02",
},
options: {
140: [{ value: "Yes", label: "Yes" }, { value: "No", label: "No" }, { value: "Considering", label: "Considering" }],
132: [{ value: "Strong", label: "Strong" }, { value: "Moderate", label: "Moderate" }, { value: "Needs Work", label: "Needs work" }],
141: [{ value: "Yes", label: "Yes" }, { value: "No", label: "No" }],
142: [{ value: "Yes", label: "Yes" }, { value: "No", label: "No" }],
133: [{ value: "Viable", label: "Viable" }, { value: "Marginal", label: "Marginal" }, { value: "Not viable", label: "Not viable" }],
134: [{ value: "Member equity", label: "Member-Owner equity" }, { value: "Member loans", label: "Member-Owner loans" }, { value: "Bank debt", label: "Bank debt" }, { value: "Grants", label: "Grants" }],
139: [{ value: "Yes", label: "Yes" }, { value: "No", label: "No" }],
135: [{ value: "Co-op", label: "Co-op grocery" }, { value: "Conventional", label: "Conventional grocery" }, { value: "Other", label: "Other" }],
136: [{ value: "Member", label: "Member" }, { value: "Considering", label: "Considering" }, { value: "Not a member", label: "Not a member" }],
137: [{ value: "Member", label: "Member" }, { value: "Considering", label: "Considering" }, { value: "Not a member", label: "Not a member" }],
138: [{ value: "UNFI", label: "UNFI" }, { value: "KeHE", label: "KeHE" }, { value: "Other", label: "Other" }, { value: "None", label: "None" }],
143: [{ value: "Northeast", label: "Northeast" }, { value: "Mid-Atlantic", label: "Mid-Atlantic" }, { value: "Midwest", label: "Midwest" }, { value: "South", label: "South" }, { value: "West", label: "West" }],
75: [
{ value: "Inquiry", label: "Inquiry" },
{ value: "Organizing", label: "Stage 1 — Convene & Prepare" },
{ value: "Feasibility", label: "Stage 2 — Grow & Plan" },
{ value: "Business feasibility", label: "Stage 3 — Connect & Gather" },
{ value: "Store Implementation", label: "Stage 4 — Excite & Build" },
{ value: "Stabilize newly opened co-op", label: "Stage 5 — Fulfill & Stabilize" },
],
},
};
function isStubMode(): boolean {
return !(
process.env.CIVI_BASE_URL &&
process.env.CIVI_API_KEY &&
process.env.CIVI_SITE_KEY
);
}
interface OptionValueRow {
value: string;
label: string;
option_group_id: number;
is_active: boolean;
}
async function fetchOptionGroups(): Promise<Record<number, SelectOption[]>> {
if (optionGroupIds.length === 0) return {};
const res = await civi<OptionValueRow>("OptionValue", "get", {
select: ["value", "label", "option_group_id", "is_active"],
where: [
["option_group_id", "IN", optionGroupIds],
["is_active", "=", true],
],
orderBy: { weight: "ASC" },
limit: 500,
});
const out: Record<number, SelectOption[]> = {};
for (const row of res.values ?? []) {
if (!out[row.option_group_id]) out[row.option_group_id] = [];
out[row.option_group_id].push({ value: row.value, label: row.label });
}
return out;
}
export async function GET(req: NextRequest) {
const url = new URL(req.url);
const cid = url.searchParams.get("cid");
const cs = url.searchParams.get("cs");
if (!cid || !cs) {
return NextResponse.json(
{ error: "Missing cid or cs parameter." },
{ status: 400 },
);
}
if (isStubMode()) {
return NextResponse.json(STUB_PAYLOAD);
}
// Verify checksum first.
const ok = await verifyChecksum(cid, cs);
if (!ok) {
return NextResponse.json(
{ error: "Link is invalid or has expired. Please request a fresh one." },
{ status: 401 },
);
}
// Resolve the org from the contact's "Primary Contact" relationship.
// The relationship is Individual (A) → Organization (B); fetch contact_id_b.
const relRes = await civi<{ contact_id_b: number }>("Relationship", "get", {
select: ["contact_id_b"],
where: [
["contact_id_a", "=", Number(cid)],
["relationship_type_id.name_a_b", "=", FORM_CONTACT_RELATIONSHIP],
["is_active", "=", true],
],
limit: 2,
});
const orgs = relRes.values ?? [];
if (orgs.length === 0) {
return NextResponse.json(
{ error: `No active "${FORM_CONTACT_RELATIONSHIP}" relationship found for your contact.` },
{ status: 404 },
);
}
if (orgs.length > 1) {
return NextResponse.json(
{ error: `Your contact has multiple active "${FORM_CONTACT_RELATIONSHIP}" relationships; staff must resolve before this link will work.` },
{ status: 409 },
);
}
const orgId = orgs[0].contact_id_b;
// Org-contact custom fields configured on form fields. Each
// FieldConfig.civiContactField is `<group_name>.<field_name>` and is
// selected directly off the Organization Contact record.
const orgContactFieldRefs = allFields
.map((f) => f.civiContactField)
.filter((s): s is string => Boolean(s));
// For file-typed org-contact fields, also pull the joined .file_name so
// we can surface a human-readable filename in the readonly indicator.
const orgContactFileRefs = allFields
.filter((f) => f.type === "file" || (f.type === "readonly" && f.civiContactField?.toLowerCase().includes("certificate")))
.map((f) => f.civiContactField)
.filter((s): s is string => Boolean(s));
const orgContactSelect = [
"id",
"display_name",
...orgContactFieldRefs,
...orgContactFileRefs.map((ref) => `${ref}.file_name`),
];
// Fire org-name lookup, contact-identity lookup, stage-bearing-activity
// lookup, prefill walk, and option-group fetch in parallel — they're
// independent.
const [orgRes, contactRes, stageActivityRes, { values: prefill }, options] = await Promise.all([
civi<{ id: number; display_name: string; [key: string]: unknown }>("Contact", "get", {
select: orgContactSelect,
where: [["id", "=", orgId]],
}),
// Identifying details for the form-filler. APIv4 lets us chain through
// the primary-email join in the same call.
civi<{
id: number;
first_name: string | null;
last_name: string | null;
"email_primary.email": string | null;
}>("Contact", "get", {
select: ["id", "first_name", "last_name", "email_primary.email"],
where: [["id", "=", Number(cid)]],
}),
// Most recent Check-in (organizing) activity whose Stage custom field
// is set. Staff own this field; the form never writes it. Tiebreaker on
// equal activity_date_time is id DESC.
civi<{ id: number; [key: string]: unknown }>("Activity", "get", {
select: ["id", ACTIVITY_STAGE_FIELD],
where: [
["activity_type_id:name", "=", ACTIVITY_TYPE_NAME],
["target_contact_id", "=", orgId],
[ACTIVITY_STAGE_FIELD, "IS NOT EMPTY"],
],
orderBy: { activity_date_time: "DESC", id: "DESC" },
limit: 1,
}),
loadPrefill(orgId, allFields, ACTIVITY_TYPE_NAME),
fetchOptionGroups(),
]);
const org = orgRes.values?.[0];
if (!org) {
return NextResponse.json({ error: "Organization not found." }, { status: 404 });
}
const stageRaw = stageActivityRes.values?.[0]?.[ACTIVITY_STAGE_FIELD];
const currentStage = typeof stageRaw === "string" && stageRaw ? stageRaw : DEFAULT_STAGE;
const contactRow = contactRes.values?.[0];
const contact = contactRow
? {
firstName: contactRow.first_name ?? "",
lastName: contactRow.last_name ?? "",
email: contactRow["email_primary.email"] ?? "",
}
: undefined;
// Merge org-contact custom-field values into prefill, keyed by form-side
// field name. Activity-based prefill values take precedence only when an
// explicit non-empty entry exists — but org-contact fields don't appear
// in the activity walk, so collisions can't happen in practice.
for (const f of allFields) {
if (!f.civiContactField) continue;
const raw = org[f.civiContactField];
if (raw === null || raw === undefined || raw === "") continue;
if (f.type === "file" || f.type === "readonly") {
// File or readonly fields: surface as {id, file_name} so the renderer
// can show a filename indicator. Plain readonly text fields fall
// through to the else branch.
const fname = org[`${f.civiContactField}.file_name`];
if (typeof fname === "string" && fname) {
prefill[f.name] = { id: raw, file_name: fname };
continue;
}
}
prefill[f.name] = raw;
}
const payload: FormDataPayload = {
orgName: org.display_name,
currentStage,
contact,
prefill,
options,
};
return NextResponse.json(payload);
}