Deduplicate state/jurisdiction references (#665)

Author: kydecker

.gitignore

@@ -32,10 +32,10 @@ pnpm-debug.log*
 # tests
 artifacts/
 coverage/
-/test-results/
-/playwright-report/
-/blob-report/
-/playwright/.cache/
+test-results/
+playwright-report/
+blob-report/
+playwright/.cache/
 
 # cloudflare
 .wrangler/

docs/src/content/docs/guides/building-forms.mdx

@@ -35,7 +35,7 @@ import { defineForm } from "#lib/forms/defineForm";
 export default defineForm({
   title: "Court Order",
   description: "If you live in Massachusetts and want to update your name, this is the place to start.",
-  state: "ma",
+  jurisdiction: "ma",
   category: "court-order",
   steps: [
     // Step definitions...

pdf-manager/lib/fields.ts

@@ -21,8 +21,8 @@ export interface FormField {
 }
 
 export interface Jurisdiction {
+  id: string;
   name: string;
-  abbreviation: string;
 }
 
 let _formFields: FormField[] | null = null;
@@ -45,12 +45,11 @@ export function loadFormFields(): FormField[] {
 export function loadJurisdictions(): Jurisdiction[] {
   if (_jurisdictions) return _jurisdictions;
   const content = readFileSync(JURISDICTIONS_PATH, "utf8");
-  const regex = /\{\s*name:\s*"([^"]+)",\s*abbreviation:\s*"([^"]+)"/g;
-  const result: Jurisdiction[] = [];
-  for (const m of content.matchAll(regex)) {
-    result.push({ name: m[1], abbreviation: m[2] });
-  }
-  _jurisdictions = result;
+  const regex = /^\s*(\w{2}):\s*\{\s*name:\s*"([^"]+)"/gm;
+  _jurisdictions = [...content.matchAll(regex)].map(([, id, name]) => ({
+    id,
+    name,
+  }));
   return _jurisdictions;
 }
 

pdf-manager/lib/handlers.ts

@@ -227,8 +227,5 @@ export async function handleReplacePdf(c: Context) {
 }
 
 export async function handleGetJurisdictions(c: Context) {
-  return c.json([
-    { name: "Federal", abbreviation: "federal" },
-    ...loadJurisdictions(),
-  ]);
+  return c.json([{ id: "federal", name: "Federal" }, ...loadJurisdictions()]);
 }

pdf-manager/src/components/AddPdfModal.tsx

@@ -136,9 +136,9 @@ export function AddPdfModal({ isOpen, onClose, onSuccess }: AddPdfModalProps) {
                 <option value="" disabled>
                   Select…
                 </option>
-                {jurisdictions.map((j) => (
-                  <option key={j.abbreviation} value={j.abbreviation}>
-                    {j.name}
+                {jurisdictions.map((jurisdiction) => (
+                  <option key={jurisdiction.id} value={jurisdiction.id}>
+                    {jurisdiction.name}
                   </option>
                 ))}
               </select>

pdf-manager/src/types.ts

@@ -14,8 +14,8 @@ export interface PdfMeta {
 }
 
 export interface Jurisdiction {
+  id: string;
   name: string;
-  abbreviation: string;
 }
 
 export interface Diff {

web/src/components/SupportMap.astro

@@ -7,7 +7,7 @@ import { feature } from "topojson-client";
 import type { GeometryCollection, Topology } from "topojson-specification";
 import { formatStateList } from "#lib/utils/formatStateList";
 
-const stateEntries = await getCollection("states");
+const stateEntries = await getCollection("jurisdictions");
 
 const stateSupport = stateEntries.reduce(
   (acc: Record<string, string>, entry) => {

web/src/components/forms/AddressField/AddressField.test.tsx

@@ -47,7 +47,7 @@ describe("AddressField", () => {
     // Select a state
     await userEvent.click(stateSelect);
     const californiaOption = screen.getByRole("option", {
-      name: JURISDICTIONS.CA,
+      name: JURISDICTIONS.ca.name,
     });
     await userEvent.click(californiaOption);
 
@@ -238,7 +238,7 @@ describe("AddressField", () => {
     });
     await userEvent.click(stateSelect);
     const newYorkOption = screen.getByRole("option", {
-      name: JURISDICTIONS.NY,
+      name: JURISDICTIONS.ny.name,
     });
     await userEvent.click(newYorkOption);
 

web/src/components/forms/AddressField/AddressField.tsx

@@ -2,7 +2,7 @@ import { type MaskitoOptions, maskitoTransform } from "@maskito/core";
 import { type Key, useState } from "react";
 import { Controller, useFormContext } from "react-hook-form";
 import type { FieldName } from "#constants/fields";
-import { JURISDICTIONS } from "#constants/jurisdictions";
+import { JURISDICTION_OPTIONS } from "#constants/jurisdictions";
 import { ComboBox, ComboBoxItem } from "../../common/ComboBox";
 import { TextField } from "../../common/TextField";
 import "./AddressField.css";
@@ -206,9 +206,9 @@ export function AddressField({
             errorMessage={error?.message}
             menuTrigger="focus"
           >
-            {Object.entries(JURISDICTIONS).map(([value, label]) => (
-              <ComboBoxItem key={value} id={value}>
-                {label}
+            {JURISDICTION_OPTIONS.map((option) => (
+              <ComboBoxItem key={option.value} id={option.value}>
+                {option.label}
               </ComboBoxItem>
             ))}
           </ComboBox>

web/src/constants/forms.ts

@@ -1,6 +1,6 @@
 import type { Step } from "#lib/forms/types";
 import type { FormData } from "./fields";
-import type { StateId } from "./jurisdictions";
+import type { JurisdictionId } from "./jurisdictions";
 import type { PDFId } from "./pdf";
 
 export const FORM_SLUGS = [
@@ -80,8 +80,8 @@ export interface FormConfig {
   title: string;
   /** Optional description */
   description?: string;
-  /** State abbreviation, e.g. "ma" */
-  state?: StateId;
+  /** Jurisdiction ID, e.g. "ma" */
+  jurisdiction?: JurisdictionId;
   /** Category identifier */
   category: CategoryId;
   /** Costs associated with this form */