@kelpie/schemas 0.8.0 → 0.10.0

package/dist/values.js

@@ -74,6 +74,7 @@ export const EXTENSIBLE_RECORD_TYPES = [
     'opportunity',
     'partnership',
     'raise',
+    'enquiry',
     'role',
     'candidate',
 ];
@@ -91,6 +92,7 @@ export const RECORD_TARGET_TYPES = [
     'opportunity',
     'partnership',
     'raise',
+    'enquiry',
     'candidate',
 ];
 /** Human labels for `RECORD_TARGET_TYPES`. Used by any picker that names a type. */
@@ -101,6 +103,7 @@ export const RECORD_TARGET_TYPE_LABELS = {
     opportunity: 'Opportunity',
     partnership: 'Partnership',
     raise: 'Raise',
+    enquiry: 'Enquiry',
     candidate: 'Candidate',
 };
 /**
@@ -119,6 +122,7 @@ export const SEARCH_COLLECTIONS = [
     'person',
     'role',
     'company',
+    'enquiry',
     'deal',
     'opportunity',
     'raise',
@@ -167,13 +171,20 @@ export const INTERVIEW_STAGE_LABELS = {
 /** Where a candidate enters the process when no stage is named. */
 export const FIRST_INTERVIEW_STAGE = INTERVIEW_STAGES[0];
 /**
- * The four pipelines whose board columns live in `pipeline_stages`. A Deal moves
+ * The five pipelines whose board columns live in `pipeline_stages`. A Deal moves
  * through `deal` stages and so on; the kinds are fixed even though the stages
  * within each are workspace-configurable.
  */
-export const PIPELINE_KINDS = ['deal', 'opportunity', 'raise', 'partnership'];
+export const PIPELINE_KINDS = [
+    'enquiry',
+    'deal',
+    'opportunity',
+    'raise',
+    'partnership',
+];
 /** Display names for `PIPELINE_KINDS`. "Fundraising" is what the nav calls a Raise. */
 export const PIPELINE_KIND_LABELS = {
+    enquiry: 'Enquiry',
     deal: 'Deal',
     opportunity: 'Opportunity',
     raise: 'Fundraising',
@@ -243,32 +254,59 @@ export const FORM_STATUSES = ['active', 'paused'];
  * uploads, multi-page forms and branching out of scope, and every type here is
  * one `<input>`, `<textarea>` or `<select>`.
  */
-export const FORM_FIELD_TYPES = ['text', 'email', 'textarea', 'select'];
+export const FORM_FIELD_TYPES = ['text', 'email', 'textarea', 'select', 'consent', 'notice'];
+/**
+ * The field types whose answer is stored as a boolean, not a string. A
+ * `consent` field renders as a checkbox whose label carries the consent
+ * statement; the answer records whether the visitor ticked it.
+ */
+export const FORM_BOOLEAN_FIELD_TYPES = ['consent'];
 /**
  * Where a field's answer lands on submit.
  *
  * `position.title` rather than a person field, because a job title belongs to the
  * Person↔Company link and nowhere else. `submission` stores the answer without
  * writing any CRM record, which is what a free-text "How can we help?" wants.
+ *
+ * A form asks for a name the way its author wants it asked: one `person.name`
+ * box, or the `person.first_name` / `person.last_name` pair most sign-up forms
+ * use. Mapping the pair and no `person.name` composes the display name from the
+ * two, so neither arrangement makes a nameless person. `salutation` and `suffix`
+ * are storable on a Person but are not offered here — a public form asking for
+ * them is rare enough that the choice is not worth the room in this list.
  */
 export const FORM_FIELD_MAP_TARGETS = [
     'person.name',
+    'person.first_name',
+    'person.last_name',
     'person.email',
+    'person.consent',
     'company.name',
     'company.domain',
     'position.title',
+    'enquiry.name',
     'deal.name',
+    'opportunity.name',
+    'partnership.name',
     'submission',
 ];
 export const FORM_FIELD_MAP_TARGET_LABELS = {
     'person.name': 'Person · name',
+    'person.first_name': 'Person · first name',
+    'person.last_name': 'Person · last name',
     'person.email': 'Person · email',
+    'person.consent': 'Person · consent',
     'company.name': 'Company · name',
     'company.domain': 'Company · domain',
     'position.title': 'Position · title',
+    'enquiry.name': 'Enquiry · name',
     'deal.name': 'Deal · name',
+    'opportunity.name': 'Opportunity · name',
+    'partnership.name': 'Partnership · name',
     submission: 'Submission only',
 };
+/** The map target for a consent field. Repeats per purpose, unlike `person.email`. */
+export const PERSON_CONSENT_TARGET = 'person.consent';
 /** The one mapping a form cannot process without, and may carry at most once. */
 export const PERSON_EMAIL_TARGET = 'person.email';
 /**
@@ -278,6 +316,13 @@ export const PERSON_EMAIL_TARGET = 'person.email';
  * the string means, so a consumer knows `"true"` was a checkbox and not a word.
  */
 export const FORM_OPTION_VALUE_TYPES = ['string', 'number', 'boolean'];
+/**
+ * Each post-submit action lands one of these on the submission's `action_log`.
+ * `ok` = the action ran; `skipped` = its precondition was absent (a company
+ * list on a submit that never resolved one); `error` = the savepoint rolled
+ * back so the rest of the submit could continue.
+ */
+export const FORM_ACTION_STATUSES = ['ok', 'skipped', 'error'];
 /**
  * The domain events a webhook can subscribe to.
  *
@@ -321,6 +366,7 @@ export const AGENT_TASK_TARGET_TYPES = [
     'opportunity',
     'partnership',
     'raise',
+    'enquiry',
     'candidate',
     'role',
     'handbook',
@@ -341,4 +387,95 @@ export const AGENT_RUN_STATUS_LABELS = {
     succeeded: 'Succeeded',
     failed: 'Failed',
 };
+/**
+ * The seven record types a workspace may attach custom field definitions to.
+ *
+ * The ones that already carry `tags` and agent-oriented fields on the record
+ * itself. Role and Candidate are absent on purpose: hiring state hangs off the
+ * Candidate link and a Role is a header rather than a rich record, so the demand
+ * signal for custom fields on either has not landed. Kept separate from
+ * `RECORD_TARGET_TYPES` and `EXTENSIBLE_RECORD_TYPES` so a later addition here
+ * cannot silently widen either of those.
+ */
+export const CUSTOM_FIELD_OBJECT_TYPES = [
+    'person',
+    'company',
+    'deal',
+    'opportunity',
+    'partnership',
+    'raise',
+    'enquiry',
+];
+export const CUSTOM_FIELD_OBJECT_TYPE_LABELS = {
+    person: 'Person',
+    company: 'Company',
+    deal: 'Deal',
+    opportunity: 'Opportunity',
+    partnership: 'Partnership',
+    raise: 'Raise',
+    enquiry: 'Enquiry',
+};
+/**
+ * The nine editor types a custom field can carry.
+ *
+ * Deliberately distinct from `FORM_FIELD_TYPES`: a form asks a stranger for four
+ * kinds of text over one submit; a custom field is a first-class attribute on a
+ * record with numeric, date, boolean and currency answers. Sharing one list
+ * would drag either surface toward the other's shape.
+ *
+ * `record_reference` is intentionally absent from v1 — it needs the polymorphic
+ * existence check and delete-transaction cleanup that Phase 2 owns.
+ */
+export const CUSTOM_FIELD_TYPES = [
+    'text',
+    'long_text',
+    'number',
+    'currency',
+    'date',
+    'checkbox',
+    'select',
+    'multi_select',
+    'url',
+];
+export const CUSTOM_FIELD_TYPE_LABELS = {
+    text: 'Text',
+    long_text: 'Long text',
+    number: 'Number',
+    currency: 'Currency',
+    date: 'Date',
+    checkbox: 'Checkbox',
+    select: 'Select',
+    multi_select: 'Multi-select',
+    url: 'URL',
+};
+/**
+ * The custom-field types whose definition carries an `options` list. Every
+ * other type stores its `options` as `[]` and any non-empty write is `422`.
+ */
+export const CUSTOM_FIELD_TYPES_WITH_OPTIONS = ['select', 'multi_select'];
+/**
+ * The default a consent purpose starts with, and what a person without an
+ * explicit `person_consents` row inherits for that purpose. `unknown` is the
+ * safest default — silence about a person's wishes is not a grant.
+ */
+export const CONSENT_PURPOSE_STATUSES = ['unknown', 'granted', 'withdrawn'];
+export const CONSENT_PURPOSE_STATUS_LABELS = {
+    unknown: 'Unknown',
+    granted: 'Granted',
+    withdrawn: 'Withdrawn',
+};
+/**
+ * The explicit status on a `person_consents` row. `unknown` is deliberately
+ * absent: no row is the unknown, so a stored row always carries a decision.
+ */
+export const CONSENT_STATUSES = ['granted', 'withdrawn'];
+export const CONSENT_STATUS_LABELS = {
+    granted: 'Granted',
+    withdrawn: 'Withdrawn',
+};
+/**
+ * Where a `person_consents` row came from. `form:<form_id>` and `list:<list_id>`
+ * are prefixed so the origin is inspectable; `import` and `manual` need no id.
+ */
+export const CONSENT_SOURCE_KINDS = ['form', 'list', 'import', 'manual'];
 //# sourceMappingURL=values.js.map

package/dist/values.js.map

@@ -1 +1 @@
-{"version":3,"file":"values.js","sourceRoot":"","sources":["../src/values.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAU,CAAA;AACxE,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,UAAU;IACV,gBAAgB;IAChB,YAAY;IACZ,SAAS;IACT,UAAU;CACF,CAAA;AACV,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAA;AAMtE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAU,CAAA;AACnF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAA;AACtE,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,CAAU,CAAA;AAC9F,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAU,CAAA;AAOrE,+EAA+E;AAC/E,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,WAAW;IACX,SAAS;IACT,YAAY;IACZ,UAAU;IACV,QAAQ;IACR,WAAW;IACX,UAAU;IACV,UAAU;IACV,QAAQ;IACR,UAAU;IACV,SAAS;IACT,QAAQ;IACR,SAAS;IACT,SAAS;IACT,OAAO;CACC,CAAA;AAIV,iEAAiE;AACjE,MAAM,CAAC,MAAM,qBAAqB,GAA8C;IAC9E,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,aAAa;IACtB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACf,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,QAAQ;IACR,SAAS;IACT,MAAM;IACN,aAAa;IACb,aAAa;IACb,OAAO;IACP,MAAM;IACN,WAAW;CACH,CAAA;AAIV;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,QAAQ;IACR,SAAS;IACT,MAAM;IACN,aAAa;IACb,aAAa;IACb,OAAO;IACP,WAAW;CACH,CAAA;AAIV,oFAAoF;AACpF,MAAM,CAAC,MAAM,yBAAyB,GAA+C;IACnF,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAC1B,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;CACvB,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,eAAe;IACf,QAAQ;IACR,MAAM;IACN,SAAS;IACT,MAAM;IACN,aAAa;IACb,OAAO;IACP,aAAa;IACb,UAAU;CACF,CAAA;AAIV,+CAA+C;AAC/C,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAU,CAAA;AAIxD,MAAM,CAAC,MAAM,kBAAkB,GAAyC;IACtE,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;CACjB,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,YAAY;IACZ,SAAS;IACT,OAAO;IACP,QAAQ;IACR,WAAW;CACH,CAAA;AAIV,MAAM,CAAC,MAAM,uBAAuB,GAA8C;IAChF,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;CACvB,CAAA;AAED,oFAAoF;AACpF,MAAM,CAAC,MAAM,UAAU,GAAoB,YAAY,CAAA;AAEvD;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAU,CAAA;AAIpF,MAAM,CAAC,MAAM,sBAAsB,GAA6C;IAC9E,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,OAAO;CACf,CAAA;AAED,mEAAmE;AACnE,MAAM,CAAC,MAAM,qBAAqB,GAAmB,gBAAgB,CAAC,CAAC,CAAC,CAAA;AAExE;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,CAAU,CAAA;AAItF,uFAAuF;AACvF,MAAM,CAAC,MAAM,oBAAoB,GAA2C;IAC1E,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,aAAa;IAC1B,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,aAAa;CAC3B,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAU,CAAA;AAI1E,MAAM,CAAC,MAAM,uBAAuB,GAA6C;IAC/E,IAAI,EAAE,OAAO;IACb,WAAW,EAAE,aAAa;IAC1B,IAAI,EAAE,MAAM;CACb,CAAA;AAED,sFAAsF;AACtF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAM,EAAE,aAAa,CAAU,CAAA;AAEvE;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS;IACT,SAAS;IACT,eAAe;IACf,YAAY;IACZ,OAAO;IACP,MAAM;IACN,SAAS;IACT,QAAQ;IACR,UAAU;CACF,CAAA;AAIV,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAA;AAIjE;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAU,CAAA;AAI3D,4EAA4E;AAC5E,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,SAAS,EAAE,SAAS,CAAU,CAAA;AAI9D;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,WAAW,EAAE,UAAU,CAAU,CAAA;AAI/D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAU,CAAA;AAIrE,yFAAyF;AACzF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAA;AAI1D;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAU,CAAA;AAIhF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,aAAa;IACb,cAAc;IACd,cAAc;IACd,gBAAgB;IAChB,gBAAgB;IAChB,WAAW;IACX,YAAY;CACJ,CAAA;AAIV,MAAM,CAAC,MAAM,4BAA4B,GAAiD;IACxF,aAAa,EAAE,eAAe;IAC9B,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;IAChC,gBAAgB,EAAE,kBAAkB;IACpC,gBAAgB,EAAE,kBAAkB;IACpC,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,iBAAiB;CAC9B,CAAA;AAED,iFAAiF;AACjF,MAAM,CAAC,MAAM,mBAAmB,GAAuB,cAAc,CAAA;AAErE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAA;AAI/E;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;CACR,CAAA;AAIV;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAA;AAIxE,oFAAoF;AACpF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAA;AAItE,mFAAmF;AACnF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAU,CAAA;AAIvE,MAAM,CAAC,MAAM,qBAAqB,GAA4C;IAC5E,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,QAAQ;IACR,SAAS;IACT,MAAM;IACN,aAAa;IACb,aAAa;IACb,OAAO;IACP,WAAW;IACX,MAAM;IACN,UAAU;IACV,WAAW;CACH,CAAA;AAIV,0EAA0E;AAC1E,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,SAAS,EAAE,UAAU,CAAU,CAAA;AAIrE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAA;AAIvF,MAAM,CAAC,MAAM,uBAAuB,GAA6C;IAC/E,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACjB,CAAA"}
+{"version":3,"file":"values.js","sourceRoot":"","sources":["../src/values.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAU,CAAA;AACxE,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,UAAU;IACV,gBAAgB;IAChB,YAAY;IACZ,SAAS;IACT,UAAU;CACF,CAAA;AACV,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAA;AAMtE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAU,CAAA;AACnF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAA;AACtE,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,CAAU,CAAA;AAC9F,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAU,CAAA;AAOrE,+EAA+E;AAC/E,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,WAAW;IACX,SAAS;IACT,YAAY;IACZ,UAAU;IACV,QAAQ;IACR,WAAW;IACX,UAAU;IACV,UAAU;IACV,QAAQ;IACR,UAAU;IACV,SAAS;IACT,QAAQ;IACR,SAAS;IACT,SAAS;IACT,OAAO;CACC,CAAA;AAIV,iEAAiE;AACjE,MAAM,CAAC,MAAM,qBAAqB,GAA8C;IAC9E,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,aAAa;IACtB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACf,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,QAAQ;IACR,SAAS;IACT,MAAM;IACN,aAAa;IACb,aAAa;IACb,OAAO;IACP,SAAS;IACT,MAAM;IACN,WAAW;CACH,CAAA;AAIV;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,QAAQ;IACR,SAAS;IACT,MAAM;IACN,aAAa;IACb,aAAa;IACb,OAAO;IACP,SAAS;IACT,WAAW;CACH,CAAA;AAIV,oFAAoF;AACpF,MAAM,CAAC,MAAM,yBAAyB,GAA+C;IACnF,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAC1B,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;CACvB,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,eAAe;IACf,QAAQ;IACR,MAAM;IACN,SAAS;IACT,SAAS;IACT,MAAM;IACN,aAAa;IACb,OAAO;IACP,aAAa;IACb,UAAU;CACF,CAAA;AAIV,+CAA+C;AAC/C,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAU,CAAA;AAIxD,MAAM,CAAC,MAAM,kBAAkB,GAAyC;IACtE,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;CACjB,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,YAAY;IACZ,SAAS;IACT,OAAO;IACP,QAAQ;IACR,WAAW;CACH,CAAA;AAIV,MAAM,CAAC,MAAM,uBAAuB,GAA8C;IAChF,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;CACvB,CAAA;AAED,oFAAoF;AACpF,MAAM,CAAC,MAAM,UAAU,GAAoB,YAAY,CAAA;AAEvD;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAU,CAAA;AAIpF,MAAM,CAAC,MAAM,sBAAsB,GAA6C;IAC9E,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,OAAO;CACf,CAAA;AAED,mEAAmE;AACnE,MAAM,CAAC,MAAM,qBAAqB,GAAmB,gBAAgB,CAAC,CAAC,CAAC,CAAA;AAExE;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS;IACT,MAAM;IACN,aAAa;IACb,OAAO;IACP,aAAa;CACL,CAAA;AAIV,uFAAuF;AACvF,MAAM,CAAC,MAAM,oBAAoB,GAA2C;IAC1E,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,aAAa;IAC1B,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,aAAa;CAC3B,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAU,CAAA;AAI1E,MAAM,CAAC,MAAM,uBAAuB,GAA6C;IAC/E,IAAI,EAAE,OAAO;IACb,WAAW,EAAE,aAAa;IAC1B,IAAI,EAAE,MAAM;CACb,CAAA;AAED,sFAAsF;AACtF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAM,EAAE,aAAa,CAAU,CAAA;AAEvE;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS;IACT,SAAS;IACT,eAAe;IACf,YAAY;IACZ,OAAO;IACP,MAAM;IACN,SAAS;IACT,QAAQ;IACR,UAAU;CACF,CAAA;AAIV,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAA;AAIjE;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAU,CAAA;AAI3D,4EAA4E;AAC5E,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,SAAS,EAAE,SAAS,CAAU,CAAA;AAI9D;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,WAAW,EAAE,UAAU,CAAU,CAAA;AAI/D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAU,CAAA;AAIrE,yFAAyF;AACzF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAA;AAI1D;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAA;AAIrG;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,SAAS,CAAU,CAAA;AAI5D;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,aAAa;IACb,mBAAmB;IACnB,kBAAkB;IAClB,cAAc;IACd,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,gBAAgB;IAChB,cAAc;IACd,WAAW;IACX,kBAAkB;IAClB,kBAAkB;IAClB,YAAY;CACJ,CAAA;AAIV,MAAM,CAAC,MAAM,4BAA4B,GAAiD;IACxF,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;IACxC,cAAc,EAAE,gBAAgB;IAChC,gBAAgB,EAAE,kBAAkB;IACpC,cAAc,EAAE,gBAAgB;IAChC,gBAAgB,EAAE,kBAAkB;IACpC,gBAAgB,EAAE,kBAAkB;IACpC,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAE,aAAa;IAC1B,kBAAkB,EAAE,oBAAoB;IACxC,kBAAkB,EAAE,oBAAoB;IACxC,UAAU,EAAE,iBAAiB;CAC9B,CAAA;AAED,sFAAsF;AACtF,MAAM,CAAC,MAAM,qBAAqB,GAAuB,gBAAgB,CAAA;AAEzE,iFAAiF;AACjF,MAAM,CAAC,MAAM,mBAAmB,GAAuB,cAAc,CAAA;AAErE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAA;AAI/E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAU,CAAA;AAIvE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;CACR,CAAA;AAIV;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAA;AAIxE,oFAAoF;AACpF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAA;AAItE,mFAAmF;AACnF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAU,CAAA;AAIvE,MAAM,CAAC,MAAM,qBAAqB,GAA4C;IAC5E,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,QAAQ;IACR,SAAS;IACT,MAAM;IACN,aAAa;IACb,aAAa;IACb,OAAO;IACP,SAAS;IACT,WAAW;IACX,MAAM;IACN,UAAU;IACV,WAAW;CACH,CAAA;AAIV,0EAA0E;AAC1E,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,SAAS,EAAE,UAAU,CAAU,CAAA;AAIrE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAA;AAIvF,MAAM,CAAC,MAAM,uBAAuB,GAA6C;IAC/E,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACjB,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,QAAQ;IACR,SAAS;IACT,MAAM;IACN,aAAa;IACb,aAAa;IACb,OAAO;IACP,SAAS;CACD,CAAA;AAIV,MAAM,CAAC,MAAM,+BAA+B,GAAoD;IAC9F,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAC1B,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;CACnB,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,MAAM;IACN,WAAW;IACX,QAAQ;IACR,UAAU;IACV,MAAM;IACN,UAAU;IACV,QAAQ;IACR,cAAc;IACd,KAAK;CACG,CAAA;AAIV,MAAM,CAAC,MAAM,wBAAwB,GAA8C;IACjF,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,YAAY,EAAE,cAAc;IAC5B,GAAG,EAAE,KAAK;CACX,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,QAAQ,EAAE,cAAc,CAAU,CAAA;AAIlF;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,CAAU,CAAA;AAIpF,MAAM,CAAC,MAAM,6BAA6B,GAAmD;IAC3F,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;CACvB,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,WAAW,CAAU,CAAA;AAIjE,MAAM,CAAC,MAAM,qBAAqB,GAA4C;IAC5E,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;CACvB,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAU,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kelpie/schemas",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "Wire contract for the Kelpie API, as Zod schemas. Shared by the service, the UI, and any agent decoding /v1 responses.",
   "keywords": [
     "kelpie",

package/src/company.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { customFieldValuesBody, customFieldValuesSchema } from './customField.ts'
+import type { CustomFieldValue, CustomFieldValues } from './customField.ts'
 import { ACCOUNT_TYPES, COMPANY_STAGES, ICP_FITS, SIZE_BANDS } from './values.ts'
 import type { AccountType, CompanyStage, IcpFit, SizeBand } from './values.ts'
 import { definedFields, idSchema, recordTimestamps } from './wire.ts'
@@ -24,6 +26,8 @@ export interface Company extends RecordTimestamps {
   readonly tags: readonly string[]
   /** True when this Company represents the workspace itself ("us"). */
   readonly isOwn: boolean
+  /** Workspace-defined fields, keyed by definition key. Always present (default `{}`). */
+  readonly customFields: CustomFieldValues
 }
 
 export const companySchema: z.ZodType<Company, unknown> = z
@@ -43,6 +47,7 @@ export const companySchema: z.ZodType<Company, unknown> = z
     summary: z.string(),
     tags: z.array(z.string()),
     is_own: z.boolean(),
+    custom_fields: customFieldValuesSchema,
     ...recordTimestamps,
   })
   .transform(
@@ -62,6 +67,7 @@ export const companySchema: z.ZodType<Company, unknown> = z
       summary: wire.summary,
       tags: wire.tags,
       isOwn: wire.is_own,
+      customFields: wire.custom_fields,
       createdAt: wire.created_at,
       updatedAt: wire.updated_at,
     }),
@@ -82,6 +88,11 @@ export interface CompanyInput {
   readonly summary?: string
   readonly tags?: readonly string[]
   readonly isOwn?: boolean
+  /**
+   * Partial merge patch: sent keys change, `null` clears a key, absent keys are
+   * left alone. Unknown keys are rejected at `422`.
+   */
+  readonly customFields?: Readonly<Record<string, CustomFieldValue | null>>
 }
 
 export function companyBody(input: CompanyInput): Record<string, unknown> {
@@ -100,5 +111,7 @@ export function companyBody(input: CompanyInput): Record<string, unknown> {
     summary: input.summary,
     tags: input.tags,
     is_own: input.isOwn,
+    custom_fields:
+      input.customFields === undefined ? undefined : customFieldValuesBody(input.customFields),
   })
 }

package/src/consentPurpose.ts

@@ -0,0 +1,95 @@
+import { z } from 'zod'
+
+import { CONSENT_PURPOSE_STATUSES } from './values.ts'
+import type { ConsentPurposeStatus } from './values.ts'
+import { definedFields, idSchema, recordTimestamps } from './wire.ts'
+import type { RecordTimestamps } from './wire.ts'
+
+/**
+ * Wire and write shapes for `/v1/consent_purposes`.
+ *
+ * A workspace defines its own purposes (`contact`, `marketing`, …). Every
+ * capture site — forms, lists, imports, the manual override on a Person —
+ * names one. Modelled on `custom_field_definitions`: `slug` is immutable and
+ * behaves as the key, `default_status` is the workspace default a person
+ * without an explicit `person_consents` row inherits, and `sort_order` runs
+ * 0..N-1 with the service renumbering on reorder and delete.
+ */
+
+/** A workspace's definition of one consent purpose. */
+export interface ConsentPurpose extends RecordTimestamps {
+  readonly id: string
+  /** Immutable after create. Lowercase snake_case, matches `/^[a-z][a-z0-9_]*$/`. */
+  readonly slug: string
+  readonly label: string
+  readonly description: string
+  /** The workspace default a person without an explicit row inherits. */
+  readonly defaultStatus: ConsentPurposeStatus
+  readonly sortOrder: number
+}
+
+export const consentPurposeSchema: z.ZodType<ConsentPurpose, unknown> = z
+  .object({
+    id: idSchema,
+    slug: z.string(),
+    label: z.string(),
+    description: z.string(),
+    default_status: z.enum(CONSENT_PURPOSE_STATUSES),
+    sort_order: z.number().int(),
+    ...recordTimestamps,
+  })
+  .transform(
+    (wire): ConsentPurpose => ({
+      id: wire.id,
+      slug: wire.slug,
+      label: wire.label,
+      description: wire.description,
+      defaultStatus: wire.default_status,
+      sortOrder: wire.sort_order,
+      createdAt: wire.created_at,
+      updatedAt: wire.updated_at,
+    }),
+  )
+
+/**
+ * The body a create takes. `slug` is only written here; a `PATCH` cannot
+ * change it — a rename would strand every stored `person_consents` row and
+ * every form/list/import that names the purpose.
+ */
+export interface CreateConsentPurposeInput {
+  readonly slug: string
+  readonly label: string
+  readonly description?: string
+  readonly defaultStatus?: ConsentPurposeStatus
+}
+
+export function createConsentPurposeBody(
+  input: CreateConsentPurposeInput,
+): Record<string, unknown> {
+  return definedFields({
+    slug: input.slug,
+    label: input.label,
+    description: input.description,
+    default_status: input.defaultStatus,
+  })
+}
+
+/**
+ * What a `PATCH` may change. `slug` is fixed for the purpose's lifetime and
+ * the strict body naturally makes it a `422`.
+ */
+export interface ConsentPurposeInput {
+  readonly label?: string
+  readonly description?: string
+  readonly defaultStatus?: ConsentPurposeStatus
+  readonly sortOrder?: number
+}
+
+export function consentPurposeBody(input: ConsentPurposeInput): Record<string, unknown> {
+  return definedFields({
+    label: input.label,
+    description: input.description,
+    default_status: input.defaultStatus,
+    sort_order: input.sortOrder,
+  })
+}

package/src/customField.ts

@@ -0,0 +1,211 @@
+import { z } from 'zod'
+
+import {
+  CUSTOM_FIELD_OBJECT_TYPES,
+  CUSTOM_FIELD_TYPES,
+} from './values.ts'
+import type { CustomFieldObjectType, CustomFieldType } from './values.ts'
+import { definedFields, idSchema, recordTimestamps } from './wire.ts'
+import type { RecordTimestamps } from './wire.ts'
+
+/**
+ * Wire and write shapes for `/v1/custom_fields`.
+ *
+ * The definition is workspace-scoped. Every record on the six object types
+ * carries a `custom_fields` object keyed by definition key; the values are the
+ * shape this file describes. The Zod layer here only checks structure — that a
+ * value looks like text / number / boolean / a string list / a money object —
+ * because the workspace's definitions are read from the database, not the
+ * request. Definition-aware checks (this key exists on this object type, this
+ * select value is one of the options) run in the service.
+ *
+ * Merge semantics on the record's `custom_fields` (documented in `api.md`): a
+ * `PATCH` sends the keys that change; `null` clears a key; an unknown key is
+ * `422` naming `custom_fields.<key>`.
+ */
+
+/**
+ * The value union a custom field can carry on the wire. Structural only — the
+ * validator in `@kelpie/server` reads the workspace's definitions and refuses a
+ * `number` written into a `text` field, an unknown `select` option, and so on.
+ *
+ * `text`, `long_text`, `url`, `date` and `select` all serialise as strings; a
+ * `multi_select` is a `string[]`; a `currency` is a small object; the rest are
+ * primitives. Nothing here reads a definition, so the caps below are the
+ * absolute ceilings meant to reject a runaway payload before it reaches the
+ * database, not the per-type limits (also enforced by the validator).
+ */
+export const customFieldWireValue = z.union([
+  z.string().max(65536),
+  z.number(),
+  z.boolean(),
+  z.array(z.string().min(1).max(120)).max(100),
+  z.strictObject({
+    amount_cents: z.number().int(),
+    currency: z.string().regex(/^[A-Z]{3}$/u),
+  }),
+])
+
+export type CustomFieldWireValue = z.infer<typeof customFieldWireValue>
+
+/** A value already parsed and rebuilt as the record the UI holds. */
+export type CustomFieldValue =
+  | string
+  | number
+  | boolean
+  | readonly string[]
+  | { readonly amountCents: number; readonly currency: string }
+
+/** The `custom_fields` object every record on the six object types carries. */
+export type CustomFieldValues = Readonly<Record<string, CustomFieldValue>>
+
+/**
+ * Parses the wire object into the record shape the UI works with. Currency is
+ * the one type that changes shape (`amount_cents` → `amountCents`); everything
+ * else is the same value.
+ */
+export const customFieldValuesSchema: z.ZodType<CustomFieldValues, unknown> = z
+  .record(z.string(), customFieldWireValue)
+  .transform((wire): CustomFieldValues => {
+    const out: Record<string, CustomFieldValue> = {}
+    for (const [key, value] of Object.entries(wire)) {
+      if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
+        out[key] = { amountCents: value.amount_cents, currency: value.currency }
+      } else {
+        out[key] = value
+      }
+    }
+    return out
+  })
+
+/**
+ * The shape a record's `PATCH` accepts for `custom_fields`. A key's value is
+ * the wire value, or `null` to clear that key; unknown keys fail at the service
+ * layer with `422 custom_fields.<key>`.
+ */
+export const customFieldsPatchShape: z.ZodType<
+  Readonly<Record<string, CustomFieldWireValue | null>>,
+  unknown
+> = z
+  .record(z.string().min(1).max(64), customFieldWireValue.nullable())
+  .describe(
+    'Workspace-defined fields keyed by definition key. List the workspace\'s definitions with the custom_fields_list tool before writing. A key set to null clears the value; an unknown key is refused.',
+  )
+
+/**
+ * Turns the UI's record shape back into the wire object for a `PATCH` body.
+ * The inverse of `customFieldValuesSchema`.
+ */
+export function customFieldValuesBody(
+  values: Readonly<Record<string, CustomFieldValue | null>>,
+): Record<string, CustomFieldWireValue | null> {
+  const out: Record<string, CustomFieldWireValue | null> = {}
+  for (const [key, value] of Object.entries(values)) {
+    out[key] = wireCustomFieldValue(value)
+  }
+  return out
+}
+
+function wireCustomFieldValue(value: CustomFieldValue | null): CustomFieldWireValue | null {
+  if (value === null) return null
+  if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+    return value
+  }
+  // Array.isArray does not narrow a `readonly` array literal, so branch on the
+  // currency object's shape and treat everything else as the string list.
+  if ('amountCents' in value && 'currency' in value) {
+    return { amount_cents: value.amountCents, currency: value.currency }
+  }
+  return [...value]
+}
+
+/** A workspace's definition of one custom field, for one object type. */
+export interface CustomFieldDefinition extends RecordTimestamps {
+  readonly id: string
+  readonly objectType: CustomFieldObjectType
+  /** Immutable after create. Lowercase snake_case, matches `/^[a-z][a-z0-9_]*$/`. */
+  readonly key: string
+  readonly label: string
+  /** Immutable after create. */
+  readonly type: CustomFieldType
+  /** Non-empty only for `select` and `multi_select`. */
+  readonly options: readonly string[]
+  readonly description: string
+  readonly sortOrder: number
+}
+
+export const customFieldDefinitionSchema: z.ZodType<CustomFieldDefinition, unknown> = z
+  .object({
+    id: idSchema,
+    object_type: z.enum(CUSTOM_FIELD_OBJECT_TYPES),
+    key: z.string(),
+    label: z.string(),
+    type: z.enum(CUSTOM_FIELD_TYPES),
+    options: z.array(z.string()),
+    description: z.string(),
+    sort_order: z.number().int(),
+    ...recordTimestamps,
+  })
+  .transform(
+    (wire): CustomFieldDefinition => ({
+      id: wire.id,
+      objectType: wire.object_type,
+      key: wire.key,
+      label: wire.label,
+      type: wire.type,
+      options: wire.options,
+      description: wire.description,
+      sortOrder: wire.sort_order,
+      createdAt: wire.created_at,
+      updatedAt: wire.updated_at,
+    }),
+  )
+
+/**
+ * The body a create takes. `object_type`, `key`, and `type` are only written
+ * here; a `PATCH` cannot change any of them (see `CustomFieldDefinitionInput`).
+ */
+export interface CreateCustomFieldDefinitionInput {
+  readonly objectType: CustomFieldObjectType
+  readonly key: string
+  readonly label: string
+  readonly type: CustomFieldType
+  readonly options?: readonly string[]
+  readonly description?: string
+}
+
+export function createCustomFieldDefinitionBody(
+  input: CreateCustomFieldDefinitionInput,
+): Record<string, unknown> {
+  return definedFields({
+    object_type: input.objectType,
+    key: input.key,
+    label: input.label,
+    type: input.type,
+    options: input.options,
+    description: input.description,
+  })
+}
+
+/**
+ * What a `PATCH` may change. `key` and `type` are fixed for the definition's
+ * lifetime — a change would strand records with the wrong value shape — and
+ * the strict body naturally makes either a `422`.
+ */
+export interface CustomFieldDefinitionInput {
+  readonly label?: string
+  readonly options?: readonly string[]
+  readonly description?: string
+  readonly sortOrder?: number
+}
+
+export function customFieldDefinitionBody(
+  input: CustomFieldDefinitionInput,
+): Record<string, unknown> {
+  return definedFields({
+    label: input.label,
+    options: input.options,
+    description: input.description,
+    sort_order: input.sortOrder,
+  })
+}

package/src/deal.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { customFieldValuesBody, customFieldValuesSchema } from './customField.ts'
+import type { CustomFieldValue, CustomFieldValues } from './customField.ts'
 import { definedFields, idSchema, recordTimestamps } from './wire.ts'
 import type { RecordTimestamps } from './wire.ts'
 
@@ -22,6 +24,8 @@ export interface Deal extends RecordTimestamps {
   readonly summary: string
   readonly tags: readonly string[]
   readonly externalId: string | null
+  /** Workspace-defined fields, keyed by definition key. Always present (default `{}`). */
+  readonly customFields: CustomFieldValues
 }
 
 export const dealSchema: z.ZodType<Deal, unknown> = z
@@ -41,6 +45,7 @@ export const dealSchema: z.ZodType<Deal, unknown> = z
     summary: z.string(),
     tags: z.array(z.string()),
     external_id: z.string().nullable(),
+    custom_fields: customFieldValuesSchema,
     ...recordTimestamps,
   })
   .transform(
@@ -60,6 +65,7 @@ export const dealSchema: z.ZodType<Deal, unknown> = z
       summary: wire.summary,
       tags: wire.tags,
       externalId: wire.external_id,
+      customFields: wire.custom_fields,
       createdAt: wire.created_at,
       updatedAt: wire.updated_at,
     }),
@@ -80,6 +86,11 @@ export interface DealInput {
   readonly summary?: string
   readonly tags?: readonly string[]
   readonly externalId?: string | null
+  /**
+   * Partial merge patch: sent keys change, `null` clears a key, absent keys are
+   * left alone. Unknown keys are rejected at `422`.
+   */
+  readonly customFields?: Readonly<Record<string, CustomFieldValue | null>>
 }
 
 export function dealBody(input: DealInput): Record<string, unknown> {
@@ -98,5 +109,7 @@ export function dealBody(input: DealInput): Record<string, unknown> {
     summary: input.summary,
     tags: input.tags,
     external_id: input.externalId,
+    custom_fields:
+      input.customFields === undefined ? undefined : customFieldValuesBody(input.customFields),
   })
 }