@kelpie/schemas 0.12.0 → 0.13.0

package/dist/values.js

@@ -75,8 +75,10 @@ export const EXTENSIBLE_RECORD_TYPES = [
     'partnership',
     'raise',
     'enquiry',
+    'event',
     'role',
     'candidate',
+    'attendance',
 ];
 /**
  * The record types a note, activity, decision, or plan item attaches to.
@@ -94,6 +96,8 @@ export const RECORD_TARGET_TYPES = [
     'raise',
     'enquiry',
     'candidate',
+    'event',
+    'attendance',
 ];
 /** Human labels for `RECORD_TARGET_TYPES`. Used by any picker that names a type. */
 export const RECORD_TARGET_TYPE_LABELS = {
@@ -105,6 +109,8 @@ export const RECORD_TARGET_TYPE_LABELS = {
     raise: 'Raise',
     enquiry: 'Enquiry',
     candidate: 'Candidate',
+    event: 'Event',
+    attendance: 'Attendance',
 };
 /**
  * What `GET /v1/search` looks through, and the order its groups come back in.
@@ -127,6 +133,7 @@ export const SEARCH_COLLECTIONS = [
     'opportunity',
     'raise',
     'partnership',
+    'event',
     'decision',
 ];
 /** Whether a Role is still being hired for. */
@@ -190,6 +197,86 @@ export const PIPELINE_KIND_LABELS = {
     raise: 'Fundraising',
     partnership: 'Partnership',
 };
+/**
+ * What a Plan item may attach to: the five pipelines plus Event.
+ *
+ * Event is a calendar object, not a pipeline, but prep work ("send reminder",
+ * "record the session") still needs a dated action on the Event itself.
+ */
+export const PLAN_ITEM_TARGET_TYPES = [
+    'enquiry',
+    'deal',
+    'opportunity',
+    'raise',
+    'partnership',
+    'event',
+];
+export const PLAN_ITEM_TARGET_TYPE_LABELS = {
+    enquiry: 'Enquiry',
+    deal: 'Deal',
+    opportunity: 'Opportunity',
+    raise: 'Fundraising',
+    partnership: 'Partnership',
+    event: 'Event',
+};
+/**
+ * Form attach targets: pipeline records (person_links) plus Event (Attendance).
+ */
+export const FORM_ATTACH_TARGET_TYPES = [
+    'enquiry',
+    'deal',
+    'opportunity',
+    'raise',
+    'partnership',
+    'event',
+];
+/** Where an Event may point besides its own Attendances. */
+export const EVENT_ASSOCIATION_TARGET_TYPES = [
+    'person',
+    'company',
+    'deal',
+    'opportunity',
+    'partnership',
+    'raise',
+    'enquiry',
+    'role',
+    'candidate',
+];
+export const EVENT_ASSOCIATION_TARGET_TYPE_LABELS = {
+    person: 'Person',
+    company: 'Company',
+    deal: 'Deal',
+    opportunity: 'Opportunity',
+    partnership: 'Partnership',
+    raise: 'Raise',
+    enquiry: 'Enquiry',
+    role: 'Role',
+    candidate: 'Candidate',
+};
+export const EVENT_FORMATS = ['in_person', 'virtual', 'hybrid'];
+export const EVENT_FORMAT_LABELS = {
+    in_person: 'In person',
+    virtual: 'Virtual',
+    hybrid: 'Hybrid',
+};
+export const EVENT_STATUSES = ['draft', 'scheduled', 'cancelled'];
+export const EVENT_STATUS_LABELS = {
+    draft: 'Draft',
+    scheduled: 'Scheduled',
+    cancelled: 'Cancelled',
+};
+export const ATTENDANCE_STATUSES = ['registered', 'attended', 'no_show', 'cancelled'];
+export const ATTENDANCE_STATUS_LABELS = {
+    registered: 'Registered',
+    attended: 'Attended',
+    no_show: 'No-show',
+    cancelled: 'Cancelled',
+};
+export const ATTENDANCE_SOURCES = ['manual', 'form'];
+export const ATTENDANCE_SOURCE_LABELS = {
+    manual: 'Manual',
+    form: 'Form',
+};
 /**
  * How far along a plan item is. Stored, never derived: whether something is
  * overdue is a question about its date, and whether it is finished is a question
@@ -369,6 +456,7 @@ export const AGENT_TASK_TARGET_TYPES = [
     'partnership',
     'raise',
     'enquiry',
+    'event',
     'candidate',
     'role',
     'handbook',
@@ -407,6 +495,7 @@ export const CUSTOM_FIELD_OBJECT_TYPES = [
     'partnership',
     'raise',
     'enquiry',
+    'event',
 ];
 export const CUSTOM_FIELD_OBJECT_TYPE_LABELS = {
     person: 'Person',
@@ -416,6 +505,7 @@ export const CUSTOM_FIELD_OBJECT_TYPE_LABELS = {
     partnership: 'Partnership',
     raise: 'Raise',
     enquiry: 'Enquiry',
+    event: 'Event',
 };
 /**
  * The nine editor types a custom field can carry.

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,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,eAAe;IACf,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,gBAAgB;IAChB,cAAc;IACd,WAAW;IACX,kBAAkB;IAClB,kBAAkB;IAClB,YAAY;CACJ,CAAA;AAKV,MAAM,CAAC,MAAM,4BAA4B,GAErC;IACF,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;IACxC,cAAc,EAAE,gBAAgB;IAChC,eAAe,EAAE,gBAAgB;IACjC,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"}
+{"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,OAAO;IACP,MAAM;IACN,WAAW;IACX,YAAY;CACJ,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;IACX,OAAO;IACP,YAAY;CACJ,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;IACtB,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,YAAY;CACzB,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,OAAO;IACP,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,sBAAsB,GAAG;IACpC,SAAS;IACT,MAAM;IACN,aAAa;IACb,OAAO;IACP,aAAa;IACb,OAAO;CACC,CAAA;AAIV,MAAM,CAAC,MAAM,4BAA4B,GAAiD;IACxF,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,aAAa;IAC1B,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,aAAa;IAC1B,KAAK,EAAE,OAAO;CACf,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,SAAS;IACT,MAAM;IACN,aAAa;IACb,OAAO;IACP,aAAa;IACb,OAAO;CACC,CAAA;AAIV,4DAA4D;AAC5D,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC5C,QAAQ;IACR,SAAS;IACT,MAAM;IACN,aAAa;IACb,aAAa;IACb,OAAO;IACP,SAAS;IACT,MAAM;IACN,WAAW;CACH,CAAA;AAIV,MAAM,CAAC,MAAM,oCAAoC,GAE7C;IACF,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,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,WAAW;CACvB,CAAA;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAA;AAIxE,MAAM,CAAC,MAAM,mBAAmB,GAA0C;IACxE,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACjB,CAAA;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,WAAW,EAAE,WAAW,CAAU,CAAA;AAI1E,MAAM,CAAC,MAAM,mBAAmB,GAA0C;IACxE,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;CACvB,CAAA;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,CAAU,CAAA;AAI9F,MAAM,CAAC,MAAM,wBAAwB,GAA+C;IAClF,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;CACvB,CAAA;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAU,CAAA;AAI7D,MAAM,CAAC,MAAM,wBAAwB,GAA+C;IAClF,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;CACb,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,eAAe;IACf,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,gBAAgB;IAChB,cAAc;IACd,WAAW;IACX,kBAAkB;IAClB,kBAAkB;IAClB,YAAY;CACJ,CAAA;AAKV,MAAM,CAAC,MAAM,4BAA4B,GAErC;IACF,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;IACxC,cAAc,EAAE,gBAAgB;IAChC,eAAe,EAAE,gBAAgB;IACjC,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,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;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,QAAQ;IACR,SAAS;IACT,MAAM;IACN,aAAa;IACb,aAAa;IACb,OAAO;IACP,SAAS;IACT,OAAO;CACC,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;IAClB,KAAK,EAAE,OAAO;CACf,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.12.0",
+  "version": "0.13.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/address.ts

@@ -0,0 +1,287 @@
+import { z } from 'zod'
+
+import { countryName, isCountryCode, normaliseCountry } from './countries.ts'
+
+/**
+ * Labelled postal addresses on Person and Company.
+ *
+ * Stored as jsonb arrays, like `phones` and `social_profiles`. They are not a
+ * CRM object and have no id. One entry per kind on a record. Wire keys are
+ * snake_case; TypeScript is camelCase, mapped at this boundary.
+ */
+
+export const PERSON_ADDRESS_KINDS = ['mailing', 'home', 'work', 'other'] as const
+export const COMPANY_ADDRESS_KINDS = ['hq', 'billing', 'shipping', 'other'] as const
+export const ADDRESS_PARTS = [
+  'line1',
+  'line2',
+  'city',
+  'region',
+  'postal_code',
+  'country',
+] as const
+
+export type PersonAddressKind = (typeof PERSON_ADDRESS_KINDS)[number]
+export type CompanyAddressKind = (typeof COMPANY_ADDRESS_KINDS)[number]
+export type AddressPart = (typeof ADDRESS_PARTS)[number]
+
+export const PERSON_ADDRESS_KIND_LABELS: Readonly<Record<PersonAddressKind, string>> = {
+  mailing: 'Mailing',
+  home: 'Home',
+  work: 'Work',
+  other: 'Other',
+}
+
+export const COMPANY_ADDRESS_KIND_LABELS: Readonly<Record<CompanyAddressKind, string>> = {
+  hq: 'Headquarters',
+  billing: 'Billing',
+  shipping: 'Shipping',
+  other: 'Other',
+}
+
+export interface PostalAddress<Kind extends string = string> {
+  readonly kind: Kind
+  readonly line1: string | null
+  readonly line2: string | null
+  readonly city: string | null
+  readonly region: string | null
+  readonly postalCode: string | null
+  readonly country: string | null
+  readonly primary: boolean
+}
+
+export type PersonAddress = PostalAddress<PersonAddressKind>
+export type CompanyAddress = PostalAddress<CompanyAddressKind>
+
+/** The parts that hold postal text. `kind` and `primary` are labels, not location. */
+const LOCATION_KEYS = ['line1', 'line2', 'city', 'region', 'postalCode', 'country'] as const
+
+function blankToNull(value: string | null): string | null {
+  if (value === null) {
+    return null
+  }
+
+  const trimmed = value.trim()
+
+  return trimmed.length === 0 ? null : trimmed
+}
+
+function hasLocation(address: {
+  readonly line1: string | null
+  readonly line2: string | null
+  readonly city: string | null
+  readonly region: string | null
+  readonly postalCode: string | null
+  readonly country: string | null
+}): boolean {
+  return LOCATION_KEYS.some((key) => address[key] !== null)
+}
+
+const nullablePart = z
+  .string()
+  .nullable()
+  .transform((value): string | null => blankToNull(value))
+
+/**
+ * A country on the wire: ISO 3166-1 alpha-2, or an English name / alias that
+ * resolves to one. Empty becomes null. An unknown string is refused in the
+ * address superRefine, after this maps a known name onto its code.
+ */
+const countryPart = z
+  .string()
+  .nullable()
+  .transform((value): string | null => {
+    const trimmed = blankToNull(value)
+
+    if (trimmed === null) {
+      return null
+    }
+
+    return normaliseCountry(trimmed) ?? trimmed
+  })
+
+function postalAddressObjectSchema<const K extends readonly [string, ...string[]]>(kinds: K) {
+  return z
+    .object({
+      kind: z.enum(kinds),
+      line1: nullablePart,
+      line2: nullablePart,
+      city: nullablePart,
+      region: nullablePart,
+      postal_code: nullablePart,
+      country: countryPart,
+      primary: z.boolean(),
+    })
+    .transform(
+      (wire): PostalAddress<K[number]> => ({
+        kind: wire.kind,
+        line1: wire.line1,
+        line2: wire.line2,
+        city: wire.city,
+        region: wire.region,
+        postalCode: wire.postal_code,
+        country: wire.country,
+        primary: wire.primary,
+      }),
+    )
+    .superRefine((address, context) => {
+      if (address.country !== null && !isCountryCode(address.country)) {
+        context.addIssue({
+          code: 'custom',
+          message: 'Must be an ISO 3166-1 alpha-2 country code',
+          path: ['country'],
+        })
+      }
+
+      if (!hasLocation(address)) {
+        context.addIssue({
+          code: 'custom',
+          message: 'An address needs at least one of line1, line2, city, region, postal_code, or country',
+        })
+      }
+    })
+}
+
+function uniqueKindsAndOnePrimary<Kind extends string>(
+  addresses: readonly PostalAddress<Kind>[],
+  context: z.RefinementCtx,
+): void {
+  const seen = new Set<string>()
+  let primaries = 0
+
+  for (const [index, address] of addresses.entries()) {
+    if (seen.has(address.kind)) {
+      context.addIssue({
+        code: 'custom',
+        message: 'Each kind may appear only once',
+        path: [index, 'kind'],
+      })
+    }
+
+    seen.add(address.kind)
+
+    if (address.primary) {
+      primaries += 1
+    }
+  }
+
+  if (addresses.length > 0 && primaries !== 1) {
+    context.addIssue({
+      code: 'custom',
+      message: 'A non-empty address list must mark exactly one entry primary',
+    })
+  }
+}
+
+export const personAddressSchema: z.ZodType<PersonAddress, unknown> =
+  postalAddressObjectSchema(PERSON_ADDRESS_KINDS)
+
+export const companyAddressSchema: z.ZodType<CompanyAddress, unknown> =
+  postalAddressObjectSchema(COMPANY_ADDRESS_KINDS)
+
+export const personAddressesSchema: z.ZodType<readonly PersonAddress[], unknown> = z
+  .array(personAddressSchema)
+  .superRefine((addresses, context) => {
+    uniqueKindsAndOnePrimary(addresses, context)
+  })
+
+export const companyAddressesSchema: z.ZodType<readonly CompanyAddress[], unknown> = z
+  .array(companyAddressSchema)
+  .superRefine((addresses, context) => {
+    uniqueKindsAndOnePrimary(addresses, context)
+  })
+
+/** The write body for one address. Same keys the response uses. */
+export function addressBody(address: PostalAddress): Record<string, unknown> {
+  return {
+    kind: address.kind,
+    line1: address.line1,
+    line2: address.line2,
+    city: address.city,
+    region: address.region,
+    postal_code: address.postalCode,
+    country: address.country,
+    primary: address.primary,
+  }
+}
+
+export function primaryAddress<Kind extends string>(
+  addresses: readonly PostalAddress<Kind>[],
+): PostalAddress<Kind> | undefined {
+  return addresses.find((address) => address.primary) ?? addresses[0]
+}
+
+/**
+ * One-line display for lists, export, and agents. Country is shown as its
+ * English name when we know it, otherwise the stored code. Empty parts are
+ * skipped. An empty address (should not reach here) returns an empty string.
+ */
+export function formatAddress(address: PostalAddress): string {
+  const country =
+    address.country === null ? null : (countryName(address.country) ?? address.country)
+  const parts = [
+    address.line1,
+    address.line2,
+    address.city,
+    address.region,
+    address.postalCode,
+    country,
+  ].filter((part): part is string => part !== null && part.length > 0)
+
+  return parts.join(', ')
+}
+
+export function addressColumnKey(kind: string, part: AddressPart): string {
+  return `${kind}_${part}`
+}
+
+export function personAddressColumnKeys(): readonly string[] {
+  return PERSON_ADDRESS_KINDS.flatMap((kind) => ADDRESS_PARTS.map((part) => addressColumnKey(kind, part)))
+}
+
+export function companyAddressColumnKeys(): readonly string[] {
+  return COMPANY_ADDRESS_KINDS.flatMap((kind) => ADDRESS_PARTS.map((part) => addressColumnKey(kind, part)))
+}
+
+function titleCaseKind(kind: string): string {
+  if (kind === 'hq') {
+    return 'HQ'
+  }
+
+  return kind.charAt(0).toUpperCase() + kind.slice(1)
+}
+
+function partLabel(part: AddressPart): string {
+  switch (part) {
+    case 'line1':
+      return 'line 1'
+    case 'line2':
+      return 'line 2'
+    case 'postal_code':
+      return 'postal code'
+    default:
+      return part
+  }
+}
+
+export function addressColumnLabel(kind: string, part: AddressPart): string {
+  return `${titleCaseKind(kind)} ${partLabel(part)}`
+}
+
+/**
+ * Build address-part CSV columns for one object's kinds, in kind then part
+ * order. Used by `OBJECT_COLUMNS` so import and export share one header list.
+ */
+export function addressCsvColumns(kinds: readonly string[]): readonly {
+  readonly key: string
+  readonly label: string
+  readonly required: false
+}[] {
+  return kinds.flatMap((kind) =>
+    ADDRESS_PARTS.map((part) => ({
+      key: addressColumnKey(kind, part),
+      label: addressColumnLabel(kind, part),
+      required: false as const,
+    })),
+  )
+}

package/src/apiKeyScopes.ts

@@ -31,6 +31,8 @@ export const API_KEY_OBJECT_DATA_RESOURCES = [
   'raises',
   'roles',
   'candidates',
+  'events',
+  'attendances',
   'decisions',
   'plan_items',
   'notes',
@@ -137,6 +139,10 @@ export const API_KEY_SCOPE_LABELS: Readonly<Record<ApiKeyScope, string>> = {
   'roles:write': 'Roles (write)',
   'candidates:read': 'Candidates (read)',
   'candidates:write': 'Candidates (write)',
+  'events:read': 'Events (read)',
+  'events:write': 'Events (write)',
+  'attendances:read': 'Attendances (read)',
+  'attendances:write': 'Attendances (write)',
   'decisions:read': 'Decisions (read)',
   'decisions:write': 'Decisions (write)',
   'plan_items:read': 'Plan items (read)',

package/src/attendance.ts

@@ -0,0 +1,72 @@
+import { z } from 'zod'
+
+import { ATTENDANCE_SOURCES, ATTENDANCE_STATUSES } from './values.ts'
+import type { AttendanceSource, AttendanceStatus } from './values.ts'
+import { definedFields, idSchema, recordTimestamps } from './wire.ts'
+import type { RecordTimestamps } from './wire.ts'
+
+/**
+ * Wire and write shapes for `/v1/attendances`, the Person↔Event link.
+ *
+ * RSVP state sits here rather than on Person, so the same person can attend one
+ * webinar and cancel another. Notes attach to the attendance, not to the person
+ * or the event in general.
+ *
+ * Neither end is updatable: moving an attendance to a different event or person
+ * is a delete and a create, the rule Candidate already follows.
+ */
+
+export interface Attendance extends RecordTimestamps {
+  readonly id: string
+  readonly eventId: string
+  readonly personId: string
+  readonly status: AttendanceStatus
+  readonly source: AttendanceSource
+}
+
+export const attendanceSchema: z.ZodType<Attendance, unknown> = z
+  .object({
+    id: idSchema,
+    event_id: idSchema,
+    person_id: idSchema,
+    status: z.enum(ATTENDANCE_STATUSES),
+    source: z.enum(ATTENDANCE_SOURCES),
+    ...recordTimestamps,
+  })
+  .transform(
+    (wire): Attendance => ({
+      id: wire.id,
+      eventId: wire.event_id,
+      personId: wire.person_id,
+      status: wire.status,
+      source: wire.source,
+      createdAt: wire.created_at,
+      updatedAt: wire.updated_at,
+    }),
+  )
+
+export interface CreateAttendanceInput {
+  readonly eventId: string
+  readonly personId: string
+  readonly status?: AttendanceStatus
+  readonly source?: AttendanceSource
+}
+
+export function createAttendanceBody(input: CreateAttendanceInput): Record<string, unknown> {
+  return definedFields({
+    event_id: input.eventId,
+    person_id: input.personId,
+    status: input.status,
+    source: input.source,
+  })
+}
+
+export interface AttendanceInput {
+  readonly status?: AttendanceStatus
+}
+
+export function attendanceBody(input: AttendanceInput): Record<string, unknown> {
+  return definedFields({
+    status: input.status,
+  })
+}

package/src/company.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { addressBody, companyAddressesSchema } from './address.ts'
+import type { CompanyAddress } from './address.ts'
 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'
@@ -17,8 +19,7 @@ export interface Company extends RecordTimestamps {
   readonly description: string
   readonly stage: CompanyStage
   readonly sizeBand: SizeBand
-  readonly hq: string | null
-  readonly website: string | null
+  readonly addresses: readonly CompanyAddress[]
   readonly accountType: AccountType
   readonly icpFit: IcpFit
   readonly techStack: readonly string[]
@@ -39,8 +40,7 @@ export const companySchema: z.ZodType<Company, unknown> = z
     description: z.string(),
     stage: z.enum(COMPANY_STAGES),
     size_band: z.enum(SIZE_BANDS),
-    hq: z.string().nullable(),
-    website: z.string().nullable(),
+    addresses: companyAddressesSchema,
     account_type: z.enum(ACCOUNT_TYPES),
     icp_fit: z.enum(ICP_FITS),
     tech_stack: z.array(z.string()),
@@ -59,8 +59,7 @@ export const companySchema: z.ZodType<Company, unknown> = z
       description: wire.description,
       stage: wire.stage,
       sizeBand: wire.size_band,
-      hq: wire.hq,
-      website: wire.website,
+      addresses: wire.addresses,
       accountType: wire.account_type,
       icpFit: wire.icp_fit,
       techStack: wire.tech_stack,
@@ -80,8 +79,7 @@ export interface CompanyInput {
   readonly description?: string
   readonly stage?: CompanyStage
   readonly sizeBand?: SizeBand
-  readonly hq?: string | null
-  readonly website?: string | null
+  readonly addresses?: readonly CompanyAddress[]
   readonly accountType?: AccountType
   readonly icpFit?: IcpFit
   readonly techStack?: readonly string[]
@@ -103,8 +101,7 @@ export function companyBody(input: CompanyInput): Record<string, unknown> {
     description: input.description,
     stage: input.stage,
     size_band: input.sizeBand,
-    hq: input.hq,
-    website: input.website,
+    addresses: input.addresses?.map(addressBody),
     account_type: input.accountType,
     icp_fit: input.icpFit,
     tech_stack: input.techStack,