udp-schema 0.1.21 → 0.2.0

package/dist/field-helpers.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Convenience helpers for accessing UDP field metadata.
+ *
+ * Mirrors the dating-schema `field-helpers.ts` pattern:
+ * pre-built lookup maps with `getUdpFieldOptions()` and `getUdpFieldMeta()`.
+ *
+ * @module udp-schema/field-helpers
+ */
+import { type UdpFieldMeta, type UdpFieldOption } from './field-meta.js';
+/**
+ * Get the `{ value, label }` options array for a UDP field by its key.
+ *
+ * @example
+ * ```ts
+ * import { getUdpFieldOptions } from 'udp-schema';
+ * const opts = getUdpFieldOptions('desireToBeLeader');
+ * // → [{ value: 'YES_STRONGLY', label: 'desireToBeLeader_YES_STRONGLY' }, ...]
+ * ```
+ */
+export declare function getUdpFieldOptions(fieldKey: string): readonly UdpFieldOption[];
+/**
+ * Get full field metadata (label, step, component, options, etc.) by key.
+ *
+ * @example
+ * ```ts
+ * import { getUdpFieldMeta } from 'udp-schema';
+ * const meta = getUdpFieldMeta('gender');
+ * // → { key: 'gender', step: 1, labelKey: 'gender', component: 'genderSelector', options: [...], immutable: true }
+ * ```
+ */
+export declare function getUdpFieldMeta(fieldKey: string): UdpFieldMeta | undefined;
+/**
+ * Get all field metadata entries for a given step number.
+ *
+ * @example
+ * ```ts
+ * import { getUdpStepFields } from 'udp-schema';
+ * const step5Fields = getUdpStepFields(5);
+ * // → [{ key: 'desireToBeLeader', ... }, { key: 'desiredPoliticalPosition', ... }, ...]
+ * ```
+ */
+export declare function getUdpStepFields(stepNumber: number): readonly UdpFieldMeta[];
+/**
+ * Get the list of field keys that are immutable after volunteer approval.
+ * These fields can only be changed by a volunteer in survey-mode once approved.
+ *
+ * @example
+ * ```ts
+ * import { getImmutableFields } from 'udp-schema';
+ * const locked = getImmutableFields();
+ * // → ['firstName', 'middleName', 'lastName', 'gender', 'dateOfBirth', 'phonePrimary']
+ * ```
+ */
+export declare function getImmutableFields(): readonly string[];
+//# sourceMappingURL=field-helpers.d.ts.map

package/dist/field-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-helpers.d.ts","sourceRoot":"","sources":["../src/field-helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAkB,KAAK,YAAY,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AA8BzF;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,cAAc,EAAE,CAE9E;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAE1E;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,YAAY,EAAE,CAE5E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,IAAI,SAAS,MAAM,EAAE,CAEtD"}

package/dist/field-helpers.js

@@ -0,0 +1,85 @@
+/**
+ * Convenience helpers for accessing UDP field metadata.
+ *
+ * Mirrors the dating-schema `field-helpers.ts` pattern:
+ * pre-built lookup maps with `getUdpFieldOptions()` and `getUdpFieldMeta()`.
+ *
+ * @module udp-schema/field-helpers
+ */
+import { UDP_FIELD_META } from './field-meta.js';
+// ─── Pre-built lookup maps ───────────────────────────────────────────────────
+const optionsMap = new Map();
+const fieldMap = new Map();
+const stepFieldsMap = new Map();
+const immutableFieldKeys = [];
+for (const meta of Object.values(UDP_FIELD_META)) {
+    fieldMap.set(meta.key, meta);
+    if (meta.options) {
+        optionsMap.set(meta.key, meta.options);
+    }
+    if (meta.immutable) {
+        immutableFieldKeys.push(meta.key);
+    }
+    const existing = stepFieldsMap.get(meta.step);
+    if (existing) {
+        existing.push(meta);
+    }
+    else {
+        stepFieldsMap.set(meta.step, [meta]);
+    }
+}
+// ─── Public helpers ──────────────────────────────────────────────────────────
+/**
+ * Get the `{ value, label }` options array for a UDP field by its key.
+ *
+ * @example
+ * ```ts
+ * import { getUdpFieldOptions } from 'udp-schema';
+ * const opts = getUdpFieldOptions('desireToBeLeader');
+ * // → [{ value: 'YES_STRONGLY', label: 'desireToBeLeader_YES_STRONGLY' }, ...]
+ * ```
+ */
+export function getUdpFieldOptions(fieldKey) {
+    return optionsMap.get(fieldKey) ?? [];
+}
+/**
+ * Get full field metadata (label, step, component, options, etc.) by key.
+ *
+ * @example
+ * ```ts
+ * import { getUdpFieldMeta } from 'udp-schema';
+ * const meta = getUdpFieldMeta('gender');
+ * // → { key: 'gender', step: 1, labelKey: 'gender', component: 'genderSelector', options: [...], immutable: true }
+ * ```
+ */
+export function getUdpFieldMeta(fieldKey) {
+    return fieldMap.get(fieldKey);
+}
+/**
+ * Get all field metadata entries for a given step number.
+ *
+ * @example
+ * ```ts
+ * import { getUdpStepFields } from 'udp-schema';
+ * const step5Fields = getUdpStepFields(5);
+ * // → [{ key: 'desireToBeLeader', ... }, { key: 'desiredPoliticalPosition', ... }, ...]
+ * ```
+ */
+export function getUdpStepFields(stepNumber) {
+    return stepFieldsMap.get(stepNumber) ?? [];
+}
+/**
+ * Get the list of field keys that are immutable after volunteer approval.
+ * These fields can only be changed by a volunteer in survey-mode once approved.
+ *
+ * @example
+ * ```ts
+ * import { getImmutableFields } from 'udp-schema';
+ * const locked = getImmutableFields();
+ * // → ['firstName', 'middleName', 'lastName', 'gender', 'dateOfBirth', 'phonePrimary']
+ * ```
+ */
+export function getImmutableFields() {
+    return immutableFieldKeys;
+}
+//# sourceMappingURL=field-helpers.js.map

package/dist/field-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-helpers.js","sourceRoot":"","sources":["../src/field-helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,cAAc,EAA0C,MAAM,iBAAiB,CAAC;AAEzF,gFAAgF;AAEhF,MAAM,UAAU,GAAG,IAAI,GAAG,EAAqC,CAAC;AAChE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAwB,CAAC;AACjD,MAAM,aAAa,GAAG,IAAI,GAAG,EAA0B,CAAC;AACxD,MAAM,kBAAkB,GAAa,EAAE,CAAC;AAExC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;IACjD,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAE7B,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,QAAQ,EAAE,CAAC;QACb,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;SAAM,CAAC;QACN,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACvC,CAAC;AACH,CAAC;AAED,gFAAgF;AAEhF;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAgB;IACjD,OAAO,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;AACxC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAAC,QAAgB;IAC9C,OAAO,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,UAAkB;IACjD,OAAO,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO,kBAAkB,CAAC;AAC5B,CAAC","sourcesContent":["/**\n * Convenience helpers for accessing UDP field metadata.\n *\n * Mirrors the dating-schema `field-helpers.ts` pattern:\n * pre-built lookup maps with `getUdpFieldOptions()` and `getUdpFieldMeta()`.\n *\n * @module udp-schema/field-helpers\n */\n\nimport { UDP_FIELD_META, type UdpFieldMeta, type UdpFieldOption } from './field-meta.js';\n\n// ─── Pre-built lookup maps ───────────────────────────────────────────────────\n\nconst optionsMap = new Map<string, readonly UdpFieldOption[]>();\nconst fieldMap = new Map<string, UdpFieldMeta>();\nconst stepFieldsMap = new Map<number, UdpFieldMeta[]>();\nconst immutableFieldKeys: string[] = [];\n\nfor (const meta of Object.values(UDP_FIELD_META)) {\n  fieldMap.set(meta.key, meta);\n\n  if (meta.options) {\n    optionsMap.set(meta.key, meta.options);\n  }\n\n  if (meta.immutable) {\n    immutableFieldKeys.push(meta.key);\n  }\n\n  const existing = stepFieldsMap.get(meta.step);\n  if (existing) {\n    existing.push(meta);\n  } else {\n    stepFieldsMap.set(meta.step, [meta]);\n  }\n}\n\n// ─── Public helpers ──────────────────────────────────────────────────────────\n\n/**\n * Get the `{ value, label }` options array for a UDP field by its key.\n *\n * @example\n * ```ts\n * import { getUdpFieldOptions } from 'udp-schema';\n * const opts = getUdpFieldOptions('desireToBeLeader');\n * // → [{ value: 'YES_STRONGLY', label: 'desireToBeLeader_YES_STRONGLY' }, ...]\n * ```\n */\nexport function getUdpFieldOptions(fieldKey: string): readonly UdpFieldOption[] {\n  return optionsMap.get(fieldKey) ?? [];\n}\n\n/**\n * Get full field metadata (label, step, component, options, etc.) by key.\n *\n * @example\n * ```ts\n * import { getUdpFieldMeta } from 'udp-schema';\n * const meta = getUdpFieldMeta('gender');\n * // → { key: 'gender', step: 1, labelKey: 'gender', component: 'genderSelector', options: [...], immutable: true }\n * ```\n */\nexport function getUdpFieldMeta(fieldKey: string): UdpFieldMeta | undefined {\n  return fieldMap.get(fieldKey);\n}\n\n/**\n * Get all field metadata entries for a given step number.\n *\n * @example\n * ```ts\n * import { getUdpStepFields } from 'udp-schema';\n * const step5Fields = getUdpStepFields(5);\n * // → [{ key: 'desireToBeLeader', ... }, { key: 'desiredPoliticalPosition', ... }, ...]\n * ```\n */\nexport function getUdpStepFields(stepNumber: number): readonly UdpFieldMeta[] {\n  return stepFieldsMap.get(stepNumber) ?? [];\n}\n\n/**\n * Get the list of field keys that are immutable after volunteer approval.\n * These fields can only be changed by a volunteer in survey-mode once approved.\n *\n * @example\n * ```ts\n * import { getImmutableFields } from 'udp-schema';\n * const locked = getImmutableFields();\n * // → ['firstName', 'middleName', 'lastName', 'gender', 'dateOfBirth', 'phonePrimary']\n * ```\n */\nexport function getImmutableFields(): readonly string[] {\n  return immutableFieldKeys;\n}\n"]}

package/dist/field-meta.d.ts

@@ -0,0 +1,40 @@
+/**
+ * UDP Field Metadata
+ * ==================
+ * Single source of truth for field-level metadata across all 14 UDP steps.
+ * Both frontend and backend import this — NO hardcoded option arrays elsewhere.
+ *
+ * Labels use i18n translation keys (not hardcoded English strings).
+ *
+ * @module udp-schema/field-meta
+ */
+export interface UdpFieldOption {
+    value: string;
+    /** i18n translation key */
+    label: string;
+}
+export interface UdpFieldMeta {
+    /** Unique field key — matches the Zod schema key and form field key */
+    key: string;
+    /** Step number (1–14) this field belongs to */
+    step: number;
+    /** i18n key for the field label */
+    labelKey: string;
+    /** i18n key for help text / description */
+    descriptionKey?: string;
+    /** Component type hint (matches frontend FieldComponentType) */
+    component: string;
+    /** Options for select / radio / multiCheckbox / genderSelector fields */
+    options?: readonly UdpFieldOption[];
+    /** Whether the field is required to complete the step */
+    required?: boolean;
+    /** i18n key for the toast shown after saving this field's step */
+    successMessageKey?: string;
+    /**
+     * If true, this field is locked after first volunteer approval.
+     * Only a volunteer (survey-mode) can change it once locked.
+     */
+    immutable?: boolean;
+}
+export declare const UDP_FIELD_META: Record<string, UdpFieldMeta>;
+//# sourceMappingURL=field-meta.d.ts.map

package/dist/field-meta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-meta.d.ts","sourceRoot":"","sources":["../src/field-meta.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,uEAAuE;IACvE,GAAG,EAAE,MAAM,CAAC;IACZ,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,OAAO,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;IACpC,yDAAyD;IACzD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kEAAkE;IAClE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AA66BD,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAyM9C,CAAC"}