@kohost/api-client 7.9.0 → 7.11.0

package/dist/schemas/definitions.d.ts

@@ -8,6 +8,14 @@ export type NotificationChannel = (typeof NOTIFICATION_CHANNELS)[number];
  */
 export declare const PLATFORM_ROLE_NAMES: readonly ["SuperAdmin", "Administrator", "Manager", "Agent", "User"];
 export type PlatformRoleName = (typeof PLATFORM_ROLE_NAMES)[number];
+/**
+ * The people outside the platform a broadcast may name, sourced from the SIS
+ * roster. `students` is every system user the SIS marks as a Student;
+ * `parents` is everybody else on the roster — every emergency-contact
+ * relationship the source system carries, whatever it calls it.
+ */
+export declare const EXTERNAL_AUDIENCE_GROUPS: readonly ["students", "parents"];
+export type ExternalAudienceGroup = (typeof EXTERNAL_AUDIENCE_GROUPS)[number];
 declare const defs: {
     readonly $schema: "http://json-schema.org/draft-07/schema";
     readonly $id: "definitions.json";
@@ -234,9 +242,18 @@ declare const defs: {
                         };
                     };
                 };
+                readonly external: {
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                    readonly description: "Which groups of the external SIS roster were included. Human-triggered sends only; an Automation can never set it.";
+                    readonly items: {
+                        readonly type: "string";
+                        readonly enum: readonly ["students", "parents"];
+                    };
+                };
                 readonly emergencyContacts: {
                     readonly type: "boolean";
-                    readonly description: "Whether the external SIS emergency-contact roster was included. Human-triggered sends only; an Automation can never set it.";
+                    readonly description: 'Deprecated: superseded by `external`. A stored `true` reads as `external: ["parents"]`.';
                 };
                 readonly users: {
                     readonly type: "array";
@@ -269,10 +286,75 @@ declare const defs: {
                                 };
                             };
                         };
+                        readonly external: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["recipients", "sent", "failed"];
+                            readonly properties: {
+                                readonly recipients: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                };
+                                readonly sent: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                };
+                                readonly failed: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                };
+                                readonly byChannel: {
+                                    readonly type: "object";
+                                    readonly additionalProperties: false;
+                                    readonly description: "Per-channel counts, present only for the channels attempted.";
+                                    readonly properties: {
+                                        readonly sms: {
+                                            readonly type: "object";
+                                            readonly additionalProperties: false;
+                                            readonly required: readonly ["recipients", "sent", "failed"];
+                                            readonly properties: {
+                                                readonly recipients: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly sent: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly failed: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                            };
+                                        };
+                                        readonly email: {
+                                            readonly type: "object";
+                                            readonly additionalProperties: false;
+                                            readonly required: readonly ["recipients", "sent", "failed"];
+                                            readonly properties: {
+                                                readonly recipients: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly sent: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly failed: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
                         readonly emergencyContacts: {
                             readonly type: "object";
                             readonly additionalProperties: false;
                             readonly required: readonly ["recipients", "sent", "failed"];
+                            readonly description: "Deprecated: superseded by `external`.";
                             readonly properties: {
                                 readonly recipients: {
                                     readonly type: "integer";

package/dist/schemas/definitions.js

@@ -28,6 +28,13 @@ const PLATFORM_ROLE_NAMES = [
 	"Agent",
 	"User"
 ];
+/**
+* The people outside the platform a broadcast may name, sourced from the SIS
+* roster. `students` is every system user the SIS marks as a Student;
+* `parents` is everybody else on the roster — every emergency-contact
+* relationship the source system carries, whatever it calls it.
+*/
+const EXTERNAL_AUDIENCE_GROUPS = ["students", "parents"];
 const deliveryCountsNode = {
 	type: "object",
 	additionalProperties: false,
@@ -365,9 +372,18 @@ const defs = {
 						}
 					}
 				},
+				external: {
+					type: "array",
+					uniqueItems: true,
+					description: "Which groups of the external SIS roster were included. Human-triggered sends only; an Automation can never set it.",
+					items: {
+						type: "string",
+						enum: EXTERNAL_AUDIENCE_GROUPS
+					}
+				},
 				emergencyContacts: {
 					type: "boolean",
-					description: "Whether the external SIS emergency-contact roster was included. Human-triggered sends only; an Automation can never set it."
+					description: "Deprecated: superseded by `external`. A stored `true` reads as `external: [\"parents\"]`."
 				},
 				users: {
 					type: "array",
@@ -380,6 +396,27 @@ const defs = {
 					description: "Send-time delivery counts per audience. Absent for an audience that was not sent to.",
 					properties: {
 						internal: deliveryCountsNode,
+						external: {
+							type: "object",
+							additionalProperties: false,
+							required: [
+								"recipients",
+								"sent",
+								"failed"
+							],
+							properties: {
+								...deliveryCountsNode.properties,
+								byChannel: {
+									type: "object",
+									additionalProperties: false,
+									description: "Per-channel counts, present only for the channels attempted.",
+									properties: {
+										sms: deliveryCountsNode,
+										email: deliveryCountsNode
+									}
+								}
+							}
+						},
 						emergencyContacts: {
 							type: "object",
 							additionalProperties: false,
@@ -388,6 +425,7 @@ const defs = {
 								"sent",
 								"failed"
 							],
+							description: "Deprecated: superseded by `external`.",
 							properties: {
 								...deliveryCountsNode.properties,
 								byChannel: {
@@ -408,6 +446,6 @@ const defs = {
 	}
 };
 //#endregion
-export { NOTIFICATION_CHANNELS, PLATFORM_ROLE_NAMES, TICKET_NOTIFICATION_EVENTS, defs as default, defs as definitionsSchema };
+export { EXTERNAL_AUDIENCE_GROUPS, NOTIFICATION_CHANNELS, PLATFORM_ROLE_NAMES, TICKET_NOTIFICATION_EVENTS, defs as default, defs as definitionsSchema };
 
 //# sourceMappingURL=definitions.js.map

package/dist/schemas/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","names":[],"sources":["../../.generated/schemas/definitions.ts"],"sourcesContent":["export const TICKET_NOTIFICATION_EVENTS = [\n  \"ticketCreated\",\n  \"ticketAssignedToMe\",\n  \"addedAsCollaborator\",\n  \"mentionedInTicket\",\n  \"messageOnMyTicket\",\n  \"ticketResolved\",\n  \"ticketCreatedAsObserver\",\n  \"messageAsObserver\",\n  \"ticketResolvedAsObserver\",\n  \"approvalRequested\",\n  \"approvalDecided\",\n] as const;\n\nexport type TicketNotificationEvent =\n  (typeof TICKET_NOTIFICATION_EVENTS)[number];\n\nexport const NOTIFICATION_CHANNELS = [\"email\", \"sms\", \"push\"] as const;\n\nexport type NotificationChannel = (typeof NOTIFICATION_CHANNELS)[number];\n\n/**\n * The platform roles an Audience may be selected by. The legacy `Guest` role a\n * permission entry may still carry is deliberately absent: nothing targets it.\n */\nexport const PLATFORM_ROLE_NAMES = [\n  \"SuperAdmin\",\n  \"Administrator\",\n  \"Manager\",\n  \"Agent\",\n  \"User\",\n] as const;\n\nexport type PlatformRoleName = (typeof PLATFORM_ROLE_NAMES)[number];\n\nconst deliveryCountsNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"recipients\", \"sent\", \"failed\"],\n  properties: {\n    recipients: { type: \"integer\", minimum: 0 },\n    sent: { type: \"integer\", minimum: 0 },\n    failed: { type: \"integer\", minimum: 0 },\n  },\n} as const;\n\nconst defs = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"definitions.json\",\n  title: \"Definitions\",\n  definitions: {\n    id: {\n      type: \"string\",\n      description: \"Identifier of the object.\",\n    },\n    systemId: {\n      type: \"string\",\n      description: \"Identifier of the object, directly related to the system.\",\n    },\n    systemData: {\n      type: \"object\",\n    },\n    metadata: {\n      type: \"object\",\n      default: {},\n    },\n    date: {\n      type: [\"string\", \"object\"],\n      format: \"date-time\",\n    },\n    file: {\n      type: \"object\",\n      required: [\"name\", \"type\", \"data\"],\n      properties: {\n        name: {\n          type: \"string\",\n          description: \"Name of the file.\",\n        },\n        type: {\n          type: \"string\",\n          description: \"MIME type of the file (e.g. application/pdf).\",\n        },\n        data: {\n          type: \"string\",\n          description: \"Base64-encoded data of the file.\",\n        },\n      },\n    },\n    address: {\n      type: \"object\",\n      additionalProperties: false,\n      properties: {\n        id: {\n          type: \"string\",\n        },\n        line1: {\n          type: \"string\",\n        },\n        line2: {\n          type: \"string\",\n        },\n        line3: {\n          type: \"string\",\n        },\n        city: {\n          type: \"string\",\n        },\n        state: {\n          type: \"string\",\n        },\n        postalCode: {\n          type: \"string\",\n        },\n        countryCode: {\n          type: \"string\",\n          minLength: 2,\n          maxLength: 2,\n        },\n      },\n    },\n    driver: {\n      type: \"string\",\n      description: \"Driver used to communicate with the object.\",\n      enum: [\n        \"adlink\",\n        \"apex-american-audio\",\n        \"avigilon-alta\",\n        \"aws-kinesis\",\n        \"bacnet\",\n        \"benq\",\n        \"butler\",\n        \"comelit\",\n        \"cool-automation\",\n        \"crestron\",\n        \"dell\",\n        \"digital-watchdog\",\n        \"distech\",\n        \"dmp\",\n        \"doorbird\",\n        \"dormakaba\",\n        \"dsc\",\n        \"dsc-itv2\",\n        \"earbridge\",\n        \"ecobee\",\n        \"epson\",\n        \"geovision-rs\",\n        \"geovision-as-manager\",\n        \"honeywell-vista\",\n        \"honeywell-resideo\",\n        \"igor\",\n        \"inncom\",\n        \"isapi\",\n        \"kohost-k7\",\n        \"kohost\",\n        \"lapi\",\n        \"lg\",\n        \"lg-webos\",\n        \"linortek\",\n        \"lirc\",\n        \"mews\",\n        \"mht\",\n        \"mobile-mule\",\n        \"mock\",\n        \"modbus\",\n        \"napco\",\n        \"newline\",\n        \"obix\",\n        \"one-roster\",\n        \"onvif\",\n        \"orchid-fusion\",\n        \"paxton\",\n        \"pdk\",\n        \"pelican-wireless\",\n        \"power-shades\",\n        \"rachio\",\n        \"rebrandly\",\n        \"relay\",\n        \"reolink\",\n        \"rtsp\",\n        \"salto\",\n        \"salto-irn\",\n        \"samsung\",\n        \"se\",\n        \"sendgrid\",\n        \"singlewire\",\n        \"smartboard\",\n        \"sonifi\",\n        \"stay-n-touch\",\n        \"storable\",\n        \"twilio\",\n        \"unifi\",\n        \"valcom\",\n        \"veracross\",\n        \"verkada\",\n        \"vivotek\",\n        \"vizio\",\n        \"wisenet\",\n        \"zkteco\",\n        \"cloudflare-images\",\n        \"cloudflare-stream\",\n        \"insperia-privacy\",\n      ],\n    },\n    type: {\n      type: \"string\",\n      enum: [\n        \"alarm\",\n        \"camera\",\n        \"courtesy\",\n        \"dimmer\",\n        \"gateway\",\n        \"lock\",\n        \"mediaSource\",\n        \"motionSensor\",\n        \"switch\",\n        \"thermostat\",\n        \"windowCovering\",\n      ],\n    },\n    name: {\n      type: \"string\",\n    },\n    alerts: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        type: \"object\",\n        additionalProperties: false,\n        required: [\"type\", \"status\", \"message\"],\n        properties: {\n          id: {\n            type: \"string\",\n          },\n          type: {\n            type: \"string\",\n            enum: [\n              \"Battery\",\n              \"Button\",\n              \"Communication\",\n              \"Config\",\n              \"Cost\",\n              \"Door Ajar\",\n              \"Equipment\",\n              \"Maintenance\",\n              \"Motion\",\n              \"Registration\",\n              \"Temperature\",\n            ],\n          },\n          status: {\n            type: \"string\",\n            enum: [\"Active\", \"Resolved\"],\n          },\n          message: {\n            type: \"string\",\n          },\n        },\n      },\n    },\n    supportedNotifications: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        enum: [\n          \"button 1\",\n          \"button 2\",\n          \"button 3\",\n          \"button 4\",\n          \"button 5\",\n          \"idle\",\n          \"powerHasBeedApplied\",\n          \"acMainsDisconnected\",\n          \"acMainsReconnected\",\n          \"replaceBattery\",\n          \"replaceBatterySoon\",\n          \"replaceBatteryNow\",\n          \"batteryOk\",\n          \"hardwareFailure\",\n          \"softwareFailure\",\n          \"hardwareFailureWithCode\",\n          \"softwareFailureWithCode\",\n          \"motionDetection\",\n          \"airFilterNeedsCleaned\",\n          \"airFilterNeedsReplaced\",\n          \"smokeDetected\",\n          \"outsideSafeTemperatureRange\",\n          \"outsideSafeHumidityRange\",\n          \"scheduleMaintenance\",\n          \"doorAjar\",\n          \"communicationFailure\",\n          \"communicationOk\",\n          \"burglarAlarm\",\n          \"fireAlarm\",\n          \"powerTrouble\",\n          \"monitoringTrouble\",\n          \"bellTrouble\",\n          \"configIssue\",\n        ],\n      },\n    },\n    notification: {\n      type: [\"object\", \"null\"],\n      properties: {\n        name: {\n          type: \"string\",\n          $ref: \"#/definitions/supportedNotifications/items\",\n        },\n        timestamp: {\n          type: \"number\",\n          minimum: 1655907956593,\n        },\n        description: {\n          type: \"string\",\n        },\n      },\n    },\n    batteryLevel: {\n      type: \"number\",\n      minimum: 0,\n      maximum: 100,\n    },\n    watts: {\n      type: \"number\",\n      minimum: 0,\n    },\n    revenue: {\n      type: \"array\",\n      items: {\n        type: \"object\",\n        properties: {\n          id: {\n            $ref: \"definitions.json#/definitions/id\",\n          },\n          name: {\n            type: \"string\",\n          },\n          date: {\n            type: \"string\",\n            format: \"date-time\",\n          },\n          price: {\n            type: \"number\",\n          },\n          tax: {\n            type: [\"number\", \"null\"],\n          },\n        },\n      },\n    },\n    ticketNotificationEvent: {\n      type: \"string\",\n      enum: TICKET_NOTIFICATION_EVENTS,\n    },\n    notificationChannel: {\n      type: \"string\",\n      enum: NOTIFICATION_CHANNELS,\n    },\n    deliveryCounts: deliveryCountsNode,\n    audience: {\n      type: \"object\",\n      additionalProperties: false,\n      description:\n        \"Who a people-facing broadcast was directed at, as the sender expressed it, plus the snapshot it resolved to. One shape for Announcements, SOS broadcasts and Automation notifications.\",\n      properties: {\n        to: {\n          type: \"object\",\n          additionalProperties: false,\n          description:\n            'The User selector, one kind at a time. Absent or empty selects nobody; everyone is only ever the explicit `id: [\"*\"]` wildcard.',\n          properties: {\n            id: {\n              type: \"array\",\n              description:\n                \"Named User ids, or the single wildcard `*` meaning everyone in scope.\",\n              items: { type: \"string\" },\n            },\n            roles: {\n              type: \"array\",\n              items: { type: \"string\", enum: PLATFORM_ROLE_NAMES },\n            },\n            departmentIds: {\n              type: \"array\",\n              items: { type: \"string\" },\n            },\n          },\n        },\n        emergencyContacts: {\n          type: \"boolean\",\n          description:\n            \"Whether the external SIS emergency-contact roster was included. Human-triggered sends only; an Automation can never set it.\",\n        },\n        users: {\n          type: \"array\",\n          description:\n            \"Snapshot of the User ids the selector resolved to at send time.\",\n          items: { type: \"string\" },\n        },\n        delivery: {\n          type: \"object\",\n          additionalProperties: false,\n          description:\n            \"Send-time delivery counts per audience. Absent for an audience that was not sent to.\",\n          properties: {\n            internal: deliveryCountsNode,\n            emergencyContacts: {\n              type: \"object\",\n              additionalProperties: false,\n              required: [\"recipients\", \"sent\", \"failed\"],\n              properties: {\n                ...deliveryCountsNode.properties,\n                byChannel: {\n                  type: \"object\",\n                  additionalProperties: false,\n                  description:\n                    \"Per-channel counts, present only for the channels attempted.\",\n                  properties: {\n                    sms: deliveryCountsNode,\n                    email: deliveryCountsNode,\n                  },\n                },\n              },\n            },\n          },\n        },\n      },\n    },\n  },\n} as const;\n\nexport type ISODateString = ReturnType<Date[\"toISOString\"]>;\n\nexport { defs as definitionsSchema };\nexport default defs;\n"],"mappings":";AAAA,MAAa,6BAA6B;CACxC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;AAKA,MAAa,wBAAwB;CAAC;CAAS;CAAO;AAAM;;;;;AAQ5D,MAAa,sBAAsB;CACjC;CACA;CACA;CACA;CACA;AACF;AAIA,MAAM,qBAAqB;CACzB,MAAM;CACN,sBAAsB;CACtB,UAAU;EAAC;EAAc;EAAQ;CAAQ;CACzC,YAAY;EACV,YAAY;GAAE,MAAM;GAAW,SAAS;EAAE;EAC1C,MAAM;GAAE,MAAM;GAAW,SAAS;EAAE;EACpC,QAAQ;GAAE,MAAM;GAAW,SAAS;EAAE;CACxC;AACF;AAEA,MAAM,OAAO;CACX,SAAS;CACT,KAAK;CACL,OAAO;CACP,aAAa;EACX,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aAAa;EACf;EACA,YAAY,EACV,MAAM,SACR;EACA,UAAU;GACR,MAAM;GACN,SAAS,CAAC;EACZ;EACA,MAAM;GACJ,MAAM,CAAC,UAAU,QAAQ;GACzB,QAAQ;EACV;EACA,MAAM;GACJ,MAAM;GACN,UAAU;IAAC;IAAQ;IAAQ;GAAM;GACjC,YAAY;IACV,MAAM;KACJ,MAAM;KACN,aAAa;IACf;IACA,MAAM;KACJ,MAAM;KACN,aAAa;IACf;IACA,MAAM;KACJ,MAAM;KACN,aAAa;IACf;GACF;EACF;EACA,SAAS;GACP,MAAM;GACN,sBAAsB;GACtB,YAAY;IACV,IAAI,EACF,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,MAAM,EACJ,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,YAAY,EACV,MAAM,SACR;IACA,aAAa;KACX,MAAM;KACN,WAAW;KACX,WAAW;IACb;GACF;EACF;EACA,QAAQ;GACN,MAAM;GACN,aAAa;GACb,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF;EACF;EACA,MAAM;GACJ,MAAM;GACN,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF;EACF;EACA,MAAM,EACJ,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,sBAAsB;IACtB,UAAU;KAAC;KAAQ;KAAU;IAAS;IACtC,YAAY;KACV,IAAI,EACF,MAAM,SACR;KACA,MAAM;MACJ,MAAM;MACN,MAAM;OACJ;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;MACF;KACF;KACA,QAAQ;MACN,MAAM;MACN,MAAM,CAAC,UAAU,UAAU;KAC7B;KACA,SAAS,EACP,MAAM,SACR;IACF;GACF;EACF;EACA,wBAAwB;GACtB,MAAM;GACN,aAAa;GACb,OAAO,EACL,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF,EACF;EACF;EACA,cAAc;GACZ,MAAM,CAAC,UAAU,MAAM;GACvB,YAAY;IACV,MAAM;KACJ,MAAM;KACN,MAAM;IACR;IACA,WAAW;KACT,MAAM;KACN,SAAS;IACX;IACA,aAAa,EACX,MAAM,SACR;GACF;EACF;EACA,cAAc;GACZ,MAAM;GACN,SAAS;GACT,SAAS;EACX;EACA,OAAO;GACL,MAAM;GACN,SAAS;EACX;EACA,SAAS;GACP,MAAM;GACN,OAAO;IACL,MAAM;IACN,YAAY;KACV,IAAI,EACF,MAAM,mCACR;KACA,MAAM,EACJ,MAAM,SACR;KACA,MAAM;MACJ,MAAM;MACN,QAAQ;KACV;KACA,OAAO,EACL,MAAM,SACR;KACA,KAAK,EACH,MAAM,CAAC,UAAU,MAAM,EACzB;IACF;GACF;EACF;EACA,yBAAyB;GACvB,MAAM;GACN,MAAM;EACR;EACA,qBAAqB;GACnB,MAAM;GACN,MAAM;EACR;EACA,gBAAgB;EAChB,UAAU;GACR,MAAM;GACN,sBAAsB;GACtB,aACE;GACF,YAAY;IACV,IAAI;KACF,MAAM;KACN,sBAAsB;KACtB,aACE;KACF,YAAY;MACV,IAAI;OACF,MAAM;OACN,aACE;OACF,OAAO,EAAE,MAAM,SAAS;MAC1B;MACA,OAAO;OACL,MAAM;OACN,OAAO;QAAE,MAAM;QAAU,MAAM;OAAoB;MACrD;MACA,eAAe;OACb,MAAM;OACN,OAAO,EAAE,MAAM,SAAS;MAC1B;KACF;IACF;IACA,mBAAmB;KACjB,MAAM;KACN,aACE;IACJ;IACA,OAAO;KACL,MAAM;KACN,aACE;KACF,OAAO,EAAE,MAAM,SAAS;IAC1B;IACA,UAAU;KACR,MAAM;KACN,sBAAsB;KACtB,aACE;KACF,YAAY;MACV,UAAU;MACV,mBAAmB;OACjB,MAAM;OACN,sBAAsB;OACtB,UAAU;QAAC;QAAc;QAAQ;OAAQ;OACzC,YAAY;QACV,GAAG,mBAAmB;QACtB,WAAW;SACT,MAAM;SACN,sBAAsB;SACtB,aACE;SACF,YAAY;UACV,KAAK;UACL,OAAO;SACT;QACF;OACF;MACF;KACF;IACF;GACF;EACF;CACF;AACF"}
+{"version":3,"file":"definitions.js","names":[],"sources":["../../.generated/schemas/definitions.ts"],"sourcesContent":["export const TICKET_NOTIFICATION_EVENTS = [\n  \"ticketCreated\",\n  \"ticketAssignedToMe\",\n  \"addedAsCollaborator\",\n  \"mentionedInTicket\",\n  \"messageOnMyTicket\",\n  \"ticketResolved\",\n  \"ticketCreatedAsObserver\",\n  \"messageAsObserver\",\n  \"ticketResolvedAsObserver\",\n  \"approvalRequested\",\n  \"approvalDecided\",\n] as const;\n\nexport type TicketNotificationEvent =\n  (typeof TICKET_NOTIFICATION_EVENTS)[number];\n\nexport const NOTIFICATION_CHANNELS = [\"email\", \"sms\", \"push\"] as const;\n\nexport type NotificationChannel = (typeof NOTIFICATION_CHANNELS)[number];\n\n/**\n * The platform roles an Audience may be selected by. The legacy `Guest` role a\n * permission entry may still carry is deliberately absent: nothing targets it.\n */\nexport const PLATFORM_ROLE_NAMES = [\n  \"SuperAdmin\",\n  \"Administrator\",\n  \"Manager\",\n  \"Agent\",\n  \"User\",\n] as const;\n\nexport type PlatformRoleName = (typeof PLATFORM_ROLE_NAMES)[number];\n\n/**\n * The people outside the platform a broadcast may name, sourced from the SIS\n * roster. `students` is every system user the SIS marks as a Student;\n * `parents` is everybody else on the roster — every emergency-contact\n * relationship the source system carries, whatever it calls it.\n */\nexport const EXTERNAL_AUDIENCE_GROUPS = [\"students\", \"parents\"] as const;\n\nexport type ExternalAudienceGroup = (typeof EXTERNAL_AUDIENCE_GROUPS)[number];\n\nconst deliveryCountsNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"recipients\", \"sent\", \"failed\"],\n  properties: {\n    recipients: { type: \"integer\", minimum: 0 },\n    sent: { type: \"integer\", minimum: 0 },\n    failed: { type: \"integer\", minimum: 0 },\n  },\n} as const;\n\nconst defs = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"definitions.json\",\n  title: \"Definitions\",\n  definitions: {\n    id: {\n      type: \"string\",\n      description: \"Identifier of the object.\",\n    },\n    systemId: {\n      type: \"string\",\n      description: \"Identifier of the object, directly related to the system.\",\n    },\n    systemData: {\n      type: \"object\",\n    },\n    metadata: {\n      type: \"object\",\n      default: {},\n    },\n    date: {\n      type: [\"string\", \"object\"],\n      format: \"date-time\",\n    },\n    file: {\n      type: \"object\",\n      required: [\"name\", \"type\", \"data\"],\n      properties: {\n        name: {\n          type: \"string\",\n          description: \"Name of the file.\",\n        },\n        type: {\n          type: \"string\",\n          description: \"MIME type of the file (e.g. application/pdf).\",\n        },\n        data: {\n          type: \"string\",\n          description: \"Base64-encoded data of the file.\",\n        },\n      },\n    },\n    address: {\n      type: \"object\",\n      additionalProperties: false,\n      properties: {\n        id: {\n          type: \"string\",\n        },\n        line1: {\n          type: \"string\",\n        },\n        line2: {\n          type: \"string\",\n        },\n        line3: {\n          type: \"string\",\n        },\n        city: {\n          type: \"string\",\n        },\n        state: {\n          type: \"string\",\n        },\n        postalCode: {\n          type: \"string\",\n        },\n        countryCode: {\n          type: \"string\",\n          minLength: 2,\n          maxLength: 2,\n        },\n      },\n    },\n    driver: {\n      type: \"string\",\n      description: \"Driver used to communicate with the object.\",\n      enum: [\n        \"adlink\",\n        \"apex-american-audio\",\n        \"avigilon-alta\",\n        \"aws-kinesis\",\n        \"bacnet\",\n        \"benq\",\n        \"butler\",\n        \"comelit\",\n        \"cool-automation\",\n        \"crestron\",\n        \"dell\",\n        \"digital-watchdog\",\n        \"distech\",\n        \"dmp\",\n        \"doorbird\",\n        \"dormakaba\",\n        \"dsc\",\n        \"dsc-itv2\",\n        \"earbridge\",\n        \"ecobee\",\n        \"epson\",\n        \"geovision-rs\",\n        \"geovision-as-manager\",\n        \"honeywell-vista\",\n        \"honeywell-resideo\",\n        \"igor\",\n        \"inncom\",\n        \"isapi\",\n        \"kohost-k7\",\n        \"kohost\",\n        \"lapi\",\n        \"lg\",\n        \"lg-webos\",\n        \"linortek\",\n        \"lirc\",\n        \"mews\",\n        \"mht\",\n        \"mobile-mule\",\n        \"mock\",\n        \"modbus\",\n        \"napco\",\n        \"newline\",\n        \"obix\",\n        \"one-roster\",\n        \"onvif\",\n        \"orchid-fusion\",\n        \"paxton\",\n        \"pdk\",\n        \"pelican-wireless\",\n        \"power-shades\",\n        \"rachio\",\n        \"rebrandly\",\n        \"relay\",\n        \"reolink\",\n        \"rtsp\",\n        \"salto\",\n        \"salto-irn\",\n        \"samsung\",\n        \"se\",\n        \"sendgrid\",\n        \"singlewire\",\n        \"smartboard\",\n        \"sonifi\",\n        \"stay-n-touch\",\n        \"storable\",\n        \"twilio\",\n        \"unifi\",\n        \"valcom\",\n        \"veracross\",\n        \"verkada\",\n        \"vivotek\",\n        \"vizio\",\n        \"wisenet\",\n        \"zkteco\",\n        \"cloudflare-images\",\n        \"cloudflare-stream\",\n        \"insperia-privacy\",\n      ],\n    },\n    type: {\n      type: \"string\",\n      enum: [\n        \"alarm\",\n        \"camera\",\n        \"courtesy\",\n        \"dimmer\",\n        \"gateway\",\n        \"lock\",\n        \"mediaSource\",\n        \"motionSensor\",\n        \"switch\",\n        \"thermostat\",\n        \"windowCovering\",\n      ],\n    },\n    name: {\n      type: \"string\",\n    },\n    alerts: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        type: \"object\",\n        additionalProperties: false,\n        required: [\"type\", \"status\", \"message\"],\n        properties: {\n          id: {\n            type: \"string\",\n          },\n          type: {\n            type: \"string\",\n            enum: [\n              \"Battery\",\n              \"Button\",\n              \"Communication\",\n              \"Config\",\n              \"Cost\",\n              \"Door Ajar\",\n              \"Equipment\",\n              \"Maintenance\",\n              \"Motion\",\n              \"Registration\",\n              \"Temperature\",\n            ],\n          },\n          status: {\n            type: \"string\",\n            enum: [\"Active\", \"Resolved\"],\n          },\n          message: {\n            type: \"string\",\n          },\n        },\n      },\n    },\n    supportedNotifications: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        enum: [\n          \"button 1\",\n          \"button 2\",\n          \"button 3\",\n          \"button 4\",\n          \"button 5\",\n          \"idle\",\n          \"powerHasBeedApplied\",\n          \"acMainsDisconnected\",\n          \"acMainsReconnected\",\n          \"replaceBattery\",\n          \"replaceBatterySoon\",\n          \"replaceBatteryNow\",\n          \"batteryOk\",\n          \"hardwareFailure\",\n          \"softwareFailure\",\n          \"hardwareFailureWithCode\",\n          \"softwareFailureWithCode\",\n          \"motionDetection\",\n          \"airFilterNeedsCleaned\",\n          \"airFilterNeedsReplaced\",\n          \"smokeDetected\",\n          \"outsideSafeTemperatureRange\",\n          \"outsideSafeHumidityRange\",\n          \"scheduleMaintenance\",\n          \"doorAjar\",\n          \"communicationFailure\",\n          \"communicationOk\",\n          \"burglarAlarm\",\n          \"fireAlarm\",\n          \"powerTrouble\",\n          \"monitoringTrouble\",\n          \"bellTrouble\",\n          \"configIssue\",\n        ],\n      },\n    },\n    notification: {\n      type: [\"object\", \"null\"],\n      properties: {\n        name: {\n          type: \"string\",\n          $ref: \"#/definitions/supportedNotifications/items\",\n        },\n        timestamp: {\n          type: \"number\",\n          minimum: 1655907956593,\n        },\n        description: {\n          type: \"string\",\n        },\n      },\n    },\n    batteryLevel: {\n      type: \"number\",\n      minimum: 0,\n      maximum: 100,\n    },\n    watts: {\n      type: \"number\",\n      minimum: 0,\n    },\n    revenue: {\n      type: \"array\",\n      items: {\n        type: \"object\",\n        properties: {\n          id: {\n            $ref: \"definitions.json#/definitions/id\",\n          },\n          name: {\n            type: \"string\",\n          },\n          date: {\n            type: \"string\",\n            format: \"date-time\",\n          },\n          price: {\n            type: \"number\",\n          },\n          tax: {\n            type: [\"number\", \"null\"],\n          },\n        },\n      },\n    },\n    ticketNotificationEvent: {\n      type: \"string\",\n      enum: TICKET_NOTIFICATION_EVENTS,\n    },\n    notificationChannel: {\n      type: \"string\",\n      enum: NOTIFICATION_CHANNELS,\n    },\n    deliveryCounts: deliveryCountsNode,\n    audience: {\n      type: \"object\",\n      additionalProperties: false,\n      description:\n        \"Who a people-facing broadcast was directed at, as the sender expressed it, plus the snapshot it resolved to. One shape for Announcements, SOS broadcasts and Automation notifications.\",\n      properties: {\n        to: {\n          type: \"object\",\n          additionalProperties: false,\n          description:\n            'The User selector, one kind at a time. Absent or empty selects nobody; everyone is only ever the explicit `id: [\"*\"]` wildcard.',\n          properties: {\n            id: {\n              type: \"array\",\n              description:\n                \"Named User ids, or the single wildcard `*` meaning everyone in scope.\",\n              items: { type: \"string\" },\n            },\n            roles: {\n              type: \"array\",\n              items: { type: \"string\", enum: PLATFORM_ROLE_NAMES },\n            },\n            departmentIds: {\n              type: \"array\",\n              items: { type: \"string\" },\n            },\n          },\n        },\n        external: {\n          type: \"array\",\n          uniqueItems: true,\n          description:\n            \"Which groups of the external SIS roster were included. Human-triggered sends only; an Automation can never set it.\",\n          items: { type: \"string\", enum: EXTERNAL_AUDIENCE_GROUPS },\n        },\n        emergencyContacts: {\n          type: \"boolean\",\n          description:\n            'Deprecated: superseded by `external`. A stored `true` reads as `external: [\"parents\"]`.',\n        },\n        users: {\n          type: \"array\",\n          description:\n            \"Snapshot of the User ids the selector resolved to at send time.\",\n          items: { type: \"string\" },\n        },\n        delivery: {\n          type: \"object\",\n          additionalProperties: false,\n          description:\n            \"Send-time delivery counts per audience. Absent for an audience that was not sent to.\",\n          properties: {\n            internal: deliveryCountsNode,\n            external: {\n              type: \"object\",\n              additionalProperties: false,\n              required: [\"recipients\", \"sent\", \"failed\"],\n              properties: {\n                ...deliveryCountsNode.properties,\n                byChannel: {\n                  type: \"object\",\n                  additionalProperties: false,\n                  description:\n                    \"Per-channel counts, present only for the channels attempted.\",\n                  properties: {\n                    sms: deliveryCountsNode,\n                    email: deliveryCountsNode,\n                  },\n                },\n              },\n            },\n            emergencyContacts: {\n              type: \"object\",\n              additionalProperties: false,\n              required: [\"recipients\", \"sent\", \"failed\"],\n              description: \"Deprecated: superseded by `external`.\",\n              properties: {\n                ...deliveryCountsNode.properties,\n                byChannel: {\n                  type: \"object\",\n                  additionalProperties: false,\n                  description:\n                    \"Per-channel counts, present only for the channels attempted.\",\n                  properties: {\n                    sms: deliveryCountsNode,\n                    email: deliveryCountsNode,\n                  },\n                },\n              },\n            },\n          },\n        },\n      },\n    },\n  },\n} as const;\n\nexport type ISODateString = ReturnType<Date[\"toISOString\"]>;\n\nexport { defs as definitionsSchema };\nexport default defs;\n"],"mappings":";AAAA,MAAa,6BAA6B;CACxC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;AAKA,MAAa,wBAAwB;CAAC;CAAS;CAAO;AAAM;;;;;AAQ5D,MAAa,sBAAsB;CACjC;CACA;CACA;CACA;CACA;AACF;;;;;;;AAUA,MAAa,2BAA2B,CAAC,YAAY,SAAS;AAI9D,MAAM,qBAAqB;CACzB,MAAM;CACN,sBAAsB;CACtB,UAAU;EAAC;EAAc;EAAQ;CAAQ;CACzC,YAAY;EACV,YAAY;GAAE,MAAM;GAAW,SAAS;EAAE;EAC1C,MAAM;GAAE,MAAM;GAAW,SAAS;EAAE;EACpC,QAAQ;GAAE,MAAM;GAAW,SAAS;EAAE;CACxC;AACF;AAEA,MAAM,OAAO;CACX,SAAS;CACT,KAAK;CACL,OAAO;CACP,aAAa;EACX,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aAAa;EACf;EACA,YAAY,EACV,MAAM,SACR;EACA,UAAU;GACR,MAAM;GACN,SAAS,CAAC;EACZ;EACA,MAAM;GACJ,MAAM,CAAC,UAAU,QAAQ;GACzB,QAAQ;EACV;EACA,MAAM;GACJ,MAAM;GACN,UAAU;IAAC;IAAQ;IAAQ;GAAM;GACjC,YAAY;IACV,MAAM;KACJ,MAAM;KACN,aAAa;IACf;IACA,MAAM;KACJ,MAAM;KACN,aAAa;IACf;IACA,MAAM;KACJ,MAAM;KACN,aAAa;IACf;GACF;EACF;EACA,SAAS;GACP,MAAM;GACN,sBAAsB;GACtB,YAAY;IACV,IAAI,EACF,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,MAAM,EACJ,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,YAAY,EACV,MAAM,SACR;IACA,aAAa;KACX,MAAM;KACN,WAAW;KACX,WAAW;IACb;GACF;EACF;EACA,QAAQ;GACN,MAAM;GACN,aAAa;GACb,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF;EACF;EACA,MAAM;GACJ,MAAM;GACN,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF;EACF;EACA,MAAM,EACJ,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,sBAAsB;IACtB,UAAU;KAAC;KAAQ;KAAU;IAAS;IACtC,YAAY;KACV,IAAI,EACF,MAAM,SACR;KACA,MAAM;MACJ,MAAM;MACN,MAAM;OACJ;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;MACF;KACF;KACA,QAAQ;MACN,MAAM;MACN,MAAM,CAAC,UAAU,UAAU;KAC7B;KACA,SAAS,EACP,MAAM,SACR;IACF;GACF;EACF;EACA,wBAAwB;GACtB,MAAM;GACN,aAAa;GACb,OAAO,EACL,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF,EACF;EACF;EACA,cAAc;GACZ,MAAM,CAAC,UAAU,MAAM;GACvB,YAAY;IACV,MAAM;KACJ,MAAM;KACN,MAAM;IACR;IACA,WAAW;KACT,MAAM;KACN,SAAS;IACX;IACA,aAAa,EACX,MAAM,SACR;GACF;EACF;EACA,cAAc;GACZ,MAAM;GACN,SAAS;GACT,SAAS;EACX;EACA,OAAO;GACL,MAAM;GACN,SAAS;EACX;EACA,SAAS;GACP,MAAM;GACN,OAAO;IACL,MAAM;IACN,YAAY;KACV,IAAI,EACF,MAAM,mCACR;KACA,MAAM,EACJ,MAAM,SACR;KACA,MAAM;MACJ,MAAM;MACN,QAAQ;KACV;KACA,OAAO,EACL,MAAM,SACR;KACA,KAAK,EACH,MAAM,CAAC,UAAU,MAAM,EACzB;IACF;GACF;EACF;EACA,yBAAyB;GACvB,MAAM;GACN,MAAM;EACR;EACA,qBAAqB;GACnB,MAAM;GACN,MAAM;EACR;EACA,gBAAgB;EAChB,UAAU;GACR,MAAM;GACN,sBAAsB;GACtB,aACE;GACF,YAAY;IACV,IAAI;KACF,MAAM;KACN,sBAAsB;KACtB,aACE;KACF,YAAY;MACV,IAAI;OACF,MAAM;OACN,aACE;OACF,OAAO,EAAE,MAAM,SAAS;MAC1B;MACA,OAAO;OACL,MAAM;OACN,OAAO;QAAE,MAAM;QAAU,MAAM;OAAoB;MACrD;MACA,eAAe;OACb,MAAM;OACN,OAAO,EAAE,MAAM,SAAS;MAC1B;KACF;IACF;IACA,UAAU;KACR,MAAM;KACN,aAAa;KACb,aACE;KACF,OAAO;MAAE,MAAM;MAAU,MAAM;KAAyB;IAC1D;IACA,mBAAmB;KACjB,MAAM;KACN,aACE;IACJ;IACA,OAAO;KACL,MAAM;KACN,aACE;KACF,OAAO,EAAE,MAAM,SAAS;IAC1B;IACA,UAAU;KACR,MAAM;KACN,sBAAsB;KACtB,aACE;KACF,YAAY;MACV,UAAU;MACV,UAAU;OACR,MAAM;OACN,sBAAsB;OACtB,UAAU;QAAC;QAAc;QAAQ;OAAQ;OACzC,YAAY;QACV,GAAG,mBAAmB;QACtB,WAAW;SACT,MAAM;SACN,sBAAsB;SACtB,aACE;SACF,YAAY;UACV,KAAK;UACL,OAAO;SACT;QACF;OACF;MACF;MACA,mBAAmB;OACjB,MAAM;OACN,sBAAsB;OACtB,UAAU;QAAC;QAAc;QAAQ;OAAQ;OACzC,aAAa;OACb,YAAY;QACV,GAAG,mBAAmB;QACtB,WAAW;SACT,MAAM;SACN,sBAAsB;SACtB,aACE;SACF,YAAY;UACV,KAAK;UACL,OAAO;SACT;QACF;OACF;MACF;KACF;IACF;GACF;EACF;CACF;AACF"}

package/dist/schemas/sosEvent.d.ts

@@ -111,7 +111,39 @@ export declare const sosEventSchema: {
                         };
                         readonly audience: {
                             readonly $ref: "definitions.json#/definitions/audience";
-                            readonly description: "Who this entry was directed at, and who it resolved to. `activation` and `final` entries always carry the everyone wildcard — neither is narrowable.";
+                            readonly description: "Who this entry was directed at, and who it resolved to. `activation` entries always carry the everyone wildcard; `update` and `final` entries carry whatever the sender named — an empty selector reaches nobody.";
+                        };
+                        readonly channels: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                                readonly enum: readonly ["sms", "email"];
+                            };
+                            readonly description: "Personal channels the sender selected for this entry. Absent on entries recorded before channel selection existed, which sent over both.";
+                        };
+                        readonly surfaces: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["targets", "sent", "failed", "skipped"];
+                            readonly description: "Rollup of the PA-surface dispatch, present when the entry named surfaces. `targets` is the devices the selectors resolved to; `skipped` counts drivers that cannot render content.";
+                            readonly properties: {
+                                readonly targets: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                };
+                                readonly sent: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                };
+                                readonly failed: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                };
+                                readonly skipped: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                };
+                            };
                         };
                         readonly deliveryStatus: {
                             readonly type: "object";
@@ -163,7 +195,7 @@ export declare const sosEventSchema: {
                                         };
                                     };
                                 };
-                                readonly emergencyContacts: {
+                                readonly external: {
                                     readonly type: "object";
                                     readonly additionalProperties: false;
                                     readonly description: "Per-channel live outcomes for one audience.";
@@ -290,6 +322,68 @@ export declare const sosEventSchema: {
                 }];
             };
         };
+        readonly notes: {
+            readonly type: "array";
+            readonly default: readonly [];
+            readonly description: "Append-only, internal-only post-incident notes. Kept outside the timeline: a note is for the record, never something that was broadcast.";
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "text", "by", "at"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly description: "Unique identifier for the note.";
+                    };
+                    readonly text: {
+                        readonly type: "string";
+                        readonly description: "Internal, plain-text note body. Never broadcast.";
+                    };
+                    readonly by: {
+                        readonly type: readonly ["object", "null"];
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["id", "discriminator"];
+                        readonly properties: {
+                            readonly id: {
+                                readonly type: "string";
+                            };
+                            readonly discriminator: {
+                                readonly type: "string";
+                                readonly enum: readonly ["user", "device", "automation"];
+                            };
+                        };
+                        readonly description: "Actor that wrote the note; null when unattributed.";
+                    };
+                    readonly at: {
+                        readonly $ref: "definitions.json#/definitions/date";
+                        readonly description: "When the note was recorded.";
+                    };
+                };
+            };
+        };
+        readonly report: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["fileId", "url", "filename", "contentHash", "renderedAt"];
+            readonly description: "The most recently minted incident-report PDF, kept so a re-export of an unchanged, ended incident can reuse the file instead of rendering again. `contentHash` fingerprints the rendered content (excluding the generated-at stamp).";
+            readonly properties: {
+                readonly fileId: {
+                    readonly type: "string";
+                };
+                readonly url: {
+                    readonly type: "string";
+                };
+                readonly filename: {
+                    readonly type: "string";
+                };
+                readonly contentHash: {
+                    readonly type: "string";
+                };
+                readonly renderedAt: {
+                    readonly $ref: "definitions.json#/definitions/date";
+                };
+            };
+        };
         readonly createdAt: {
             readonly $ref: "definitions.json#/definitions/date";
             readonly description: "When the SOS Event was created.";
@@ -307,6 +401,7 @@ export declare const sosEventSchema: {
 };
 export type SOSEventSchema = FromSchema<typeof sosEventSchema, {
     references: [typeof defs];
+    keepDefaultedPropertiesOptional: true;
     deserialize: [
         {
             pattern: {

package/dist/schemas/sosEvent.js

@@ -86,7 +86,44 @@ const broadcastEntryNode = {
 		},
 		audience: {
 			$ref: "definitions.json#/definitions/audience",
-			description: "Who this entry was directed at, and who it resolved to. `activation` and `final` entries always carry the everyone wildcard — neither is narrowable."
+			description: "Who this entry was directed at, and who it resolved to. `activation` entries always carry the everyone wildcard; `update` and `final` entries carry whatever the sender named — an empty selector reaches nobody."
+		},
+		channels: {
+			type: "array",
+			items: {
+				type: "string",
+				enum: ["sms", "email"]
+			},
+			description: "Personal channels the sender selected for this entry. Absent on entries recorded before channel selection existed, which sent over both."
+		},
+		surfaces: {
+			type: "object",
+			additionalProperties: false,
+			required: [
+				"targets",
+				"sent",
+				"failed",
+				"skipped"
+			],
+			description: "Rollup of the PA-surface dispatch, present when the entry named surfaces. `targets` is the devices the selectors resolved to; `skipped` counts drivers that cannot render content.",
+			properties: {
+				targets: {
+					type: "integer",
+					minimum: 0
+				},
+				sent: {
+					type: "integer",
+					minimum: 0
+				},
+				failed: {
+					type: "integer",
+					minimum: 0
+				},
+				skipped: {
+					type: "integer",
+					minimum: 0
+				}
+			}
 		},
 		deliveryStatus: {
 			type: "object",
@@ -94,7 +131,7 @@ const broadcastEntryNode = {
 			description: "Computed on demand by DescribeSOSEvent (not persisted): live per-audience, per-channel outcome counts grouped from the sms/email collections by appData.sosUpdateId × status. Absent on the returned event until at least one matching message exists; only audiences/channels with data are present.",
 			properties: {
 				internal: audienceDeliveryNode,
-				emergencyContacts: audienceDeliveryNode
+				external: audienceDeliveryNode
 			}
 		}
 	}
@@ -187,6 +224,34 @@ const automationRunEntryNode = {
 		}
 	}
 };
+const noteNode = {
+	type: "object",
+	additionalProperties: false,
+	required: [
+		"id",
+		"text",
+		"by",
+		"at"
+	],
+	properties: {
+		id: {
+			type: "string",
+			description: "Unique identifier for the note."
+		},
+		text: {
+			type: "string",
+			description: "Internal, plain-text note body. Never broadcast."
+		},
+		by: {
+			...sosActorNode,
+			description: "Actor that wrote the note; null when unattributed."
+		},
+		at: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the note was recorded."
+		}
+	}
+};
 const sosEventSchema = {
 	$schema: "http://json-schema.org/draft-07/schema",
 	$id: "sosEvent.json",
@@ -242,6 +307,31 @@ const sosEventSchema = {
 			description: "Append-only timeline. The first entry is the `activation`; later entries are operator `update`s, automation runs, and a closing `final`.",
 			items: { oneOf: [broadcastEntryNode, automationRunEntryNode] }
 		},
+		notes: {
+			type: "array",
+			default: [],
+			description: "Append-only, internal-only post-incident notes. Kept outside the timeline: a note is for the record, never something that was broadcast.",
+			items: noteNode
+		},
+		report: {
+			type: "object",
+			additionalProperties: false,
+			required: [
+				"fileId",
+				"url",
+				"filename",
+				"contentHash",
+				"renderedAt"
+			],
+			description: "The most recently minted incident-report PDF, kept so a re-export of an unchanged, ended incident can reuse the file instead of rendering again. `contentHash` fingerprints the rendered content (excluding the generated-at stamp).",
+			properties: {
+				fileId: { type: "string" },
+				url: { type: "string" },
+				filename: { type: "string" },
+				contentHash: { type: "string" },
+				renderedAt: { $ref: "definitions.json#/definitions/date" }
+			}
+		},
 		createdAt: {
 			$ref: "definitions.json#/definitions/date",
 			description: "When the SOS Event was created."

package/dist/schemas/sosEvent.js.map

@@ -1 +1 @@
-{"version":3,"file":"sosEvent.js","names":[],"sources":["../../.generated/schemas/sosEvent.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\n// Sub-node consts must not be exported: the model generator treats the first\n// export ending in \"Schema\" as the entity schema.\nconst sosActorNode = {\n  type: [\"object\", \"null\"],\n  additionalProperties: false,\n  required: [\"id\", \"discriminator\"],\n  properties: {\n    id: { type: \"string\" },\n    discriminator: {\n      type: \"string\",\n      enum: [\"user\", \"device\", \"automation\"],\n    },\n  },\n} as const;\n\n// Live outcome rollup for one channel. Buckets map the raw vendor statuses:\n// `sent` = accepted/in-flight but not yet terminal, `delivered` = terminal\n// success (delivered/read/opened/clicked), `failed` = terminal failure\n// (failed/undelivered/bounced/blocked). See deliveryOutcomeForStatus.\nconst deliveryOutcomeNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"sent\", \"delivered\", \"failed\"],\n  properties: {\n    sent: { type: \"integer\", minimum: 0 },\n    delivered: { type: \"integer\", minimum: 0 },\n    failed: { type: \"integer\", minimum: 0 },\n  },\n} as const;\n\nconst audienceDeliveryNode = {\n  type: \"object\",\n  additionalProperties: false,\n  description: \"Per-channel live outcomes for one audience.\",\n  properties: {\n    sms: deliveryOutcomeNode,\n    email: deliveryOutcomeNode,\n  },\n} as const;\n\n// A timeline entry is a discriminated union on `type`, so `timeline.items` is\n// their `oneOf`. The branches are disjoint via the `type` enum plus\n// `additionalProperties: false`, so an entry validates against exactly one.\nconst broadcastEntryNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"id\", \"type\", \"message\", \"by\", \"at\", \"audience\"],\n  properties: {\n    id: {\n      type: \"string\",\n      description: \"Unique identifier for the timeline entry.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"activation\", \"update\", \"final\"],\n      description:\n        \"`activation` opens the event, `update` is an interim message, `final` closes it.\",\n    },\n    message: {\n      type: \"string\",\n      description:\n        \"The entry's message body. May be empty for entries that carry only audience/delivery intent.\",\n    },\n    by: {\n      ...sosActorNode,\n      description: \"Actor that authored the entry; null when unattributed.\",\n    },\n    at: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the entry was recorded.\",\n    },\n    audience: {\n      $ref: \"definitions.json#/definitions/audience\",\n      description:\n        \"Who this entry was directed at, and who it resolved to. `activation` and `final` entries always carry the everyone wildcard — neither is narrowable.\",\n    },\n    deliveryStatus: {\n      type: \"object\",\n      additionalProperties: false,\n      description:\n        \"Computed on demand by DescribeSOSEvent (not persisted): live per-audience, per-channel outcome counts grouped from the sms/email collections by appData.sosUpdateId × status. Absent on the returned event until at least one matching message exists; only audiences/channels with data are present.\",\n      properties: {\n        internal: audienceDeliveryNode,\n        emergencyContacts: audienceDeliveryNode,\n      },\n    },\n  },\n} as const;\n\nconst automationRunActionNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"type\", \"status\"],\n  properties: {\n    type: {\n      type: \"string\",\n      description: \"The use case the automation action invoked.\",\n    },\n    status: {\n      type: \"string\",\n      enum: [\"pending\", \"success\", \"failure\"],\n      description:\n        \"`pending` while the action is in flight; settles to `success` or `failure`.\",\n    },\n    error: {\n      type: [\"string\", \"null\"],\n      description: \"Failure message; absent when the action succeeded.\",\n    },\n    params: {\n      type: \"object\",\n      description:\n        \"Pruned snapshot of the action's configured params (e.g. SetDevices device states, StartSOS type ids), enough to render a human summary of what the action did. Absent when the use case has no summarizable params.\",\n    },\n  },\n} as const;\n\nconst automationRunEntryNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\n    \"id\",\n    \"type\",\n    \"at\",\n    \"by\",\n    \"automationName\",\n    \"runId\",\n    \"trigger\",\n    \"actions\",\n  ],\n  properties: {\n    id: {\n      type: \"string\",\n      description: \"Unique identifier for the timeline entry.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"automationRun\"],\n      description:\n        \"Discriminator: an automation that ran in response to this SOS.\",\n    },\n    at: {\n      $ref: \"definitions.json#/definitions/date\",\n      description:\n        \"When the run started. The entry is stamped with pending actions up front and settled in place.\",\n    },\n    by: {\n      type: \"object\",\n      additionalProperties: false,\n      required: [\"id\", \"discriminator\"],\n      description:\n        \"The Automation that ran. Its id is the automation's id — there is no separate automationId.\",\n      properties: {\n        id: { type: \"string\" },\n        discriminator: { type: \"string\", enum: [\"automation\"] },\n      },\n    },\n    automationName: {\n      type: \"string\",\n      description:\n        \"The automation's name snapshotted at run time, so a later rename or delete leaves the timeline readable.\",\n    },\n    runId: {\n      type: \"string\",\n      description:\n        \"Groups this run's Activity records; one event matching several automations yields one runId each.\",\n    },\n    trigger: {\n      type: \"string\",\n      enum: [\"SOSActive\", \"SOSInactive\"],\n      description: \"The SOS event type that matched the automation's trigger.\",\n    },\n    actions: {\n      type: \"array\",\n      default: [],\n      description: \"Per-action outcome, in the automation's action order.\",\n      items: automationRunActionNode,\n    },\n  },\n} as const;\n\nexport const sosEventSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"sosEvent.json\",\n  title: \"SOS Event\",\n  description:\n    \"A durable record of a single SOS activation on a Property, with an append-only timeline of updates. Persists as audit history after the SOS is cleared.\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"sosTypeIds\", \"activatedAt\", \"timeline\"],\n  additionalProperties: false,\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n      description: \"Unique identifier for the SOS Event.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"sosEvent\"],\n      default: \"sosEvent\",\n    },\n    propertyId: {\n      type: \"string\",\n      description:\n        \"ID of the Property this SOS was raised on. Used as a per-document filter inside the org-scoped database.\",\n    },\n    sosTypeIds: {\n      type: \"array\",\n      items: { type: \"string\" },\n      description: \"The SOS Type ids this event was raised for.\",\n    },\n    activatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the SOS was raised.\",\n    },\n    activatedBy: {\n      ...sosActorNode,\n      description:\n        \"Actor that raised the SOS (user, device, or automation); null when unattributed.\",\n    },\n    deactivatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description:\n        \"When the SOS was cleared. Absent while the event is active.\",\n    },\n    deactivatedBy: {\n      ...sosActorNode,\n      description:\n        \"Actor that cleared the SOS; null when unattributed. Absent while the event is active.\",\n    },\n    timeline: {\n      type: \"array\",\n      default: [],\n      description:\n        \"Append-only timeline. The first entry is the `activation`; later entries are operator `update`s, automation runs, and a closing `final`.\",\n      items: {\n        oneOf: [broadcastEntryNode, automationRunEntryNode],\n      },\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the SOS Event was created.\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the SOS Event was last modified.\",\n    },\n    deletedAt: {\n      type: [\"string\", \"object\", \"null\"],\n      format: \"date-time\",\n      description: \"Soft-delete tombstone.\",\n    },\n  },\n} as const;\n\nexport type SOSEventSchema = FromSchema<\n  typeof sosEventSchema,\n  {\n    references: [typeof defs];\n    deserialize: [\n      {\n        pattern: {\n          format: \"date-time\";\n        };\n        output: Date | ISODateString;\n      },\n    ];\n  }\n>;\n"],"mappings":";AAKA,MAAM,eAAe;CACnB,MAAM,CAAC,UAAU,MAAM;CACvB,sBAAsB;CACtB,UAAU,CAAC,MAAM,eAAe;CAChC,YAAY;EACV,IAAI,EAAE,MAAM,SAAS;EACrB,eAAe;GACb,MAAM;GACN,MAAM;IAAC;IAAQ;IAAU;GAAY;EACvC;CACF;AACF;AAMA,MAAM,sBAAsB;CAC1B,MAAM;CACN,sBAAsB;CACtB,UAAU;EAAC;EAAQ;EAAa;CAAQ;CACxC,YAAY;EACV,MAAM;GAAE,MAAM;GAAW,SAAS;EAAE;EACpC,WAAW;GAAE,MAAM;GAAW,SAAS;EAAE;EACzC,QAAQ;GAAE,MAAM;GAAW,SAAS;EAAE;CACxC;AACF;AAEA,MAAM,uBAAuB;CAC3B,MAAM;CACN,sBAAsB;CACtB,aAAa;CACb,YAAY;EACV,KAAK;EACL,OAAO;CACT;AACF;AAKA,MAAM,qBAAqB;CACzB,MAAM;CACN,sBAAsB;CACtB,UAAU;EAAC;EAAM;EAAQ;EAAW;EAAM;EAAM;CAAU;CAC1D,YAAY;EACV,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,MAAM;IAAC;IAAc;IAAU;GAAO;GACtC,aACE;EACJ;EACA,SAAS;GACP,MAAM;GACN,aACE;EACJ;EACA,IAAI;GACF,GAAG;GACH,aAAa;EACf;EACA,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;EACA,gBAAgB;GACd,MAAM;GACN,sBAAsB;GACtB,aACE;GACF,YAAY;IACV,UAAU;IACV,mBAAmB;GACrB;EACF;CACF;AACF;AA6BA,MAAM,yBAAyB;CAC7B,MAAM;CACN,sBAAsB;CACtB,UAAU;EACR;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACF;CACA,YAAY;EACV,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,eAAe;GACtB,aACE;EACJ;EACA,IAAI;GACF,MAAM;GACN,aACE;EACJ;EACA,IAAI;GACF,MAAM;GACN,sBAAsB;GACtB,UAAU,CAAC,MAAM,eAAe;GAChC,aACE;GACF,YAAY;IACV,IAAI,EAAE,MAAM,SAAS;IACrB,eAAe;KAAE,MAAM;KAAU,MAAM,CAAC,YAAY;IAAE;GACxD;EACF;EACA,gBAAgB;GACd,MAAM;GACN,aACE;EACJ;EACA,OAAO;GACL,MAAM;GACN,aACE;EACJ;EACA,SAAS;GACP,MAAM;GACN,MAAM,CAAC,aAAa,aAAa;GACjC,aAAa;EACf;EACA,SAAS;GACP,MAAM;GACN,SAAS,CAAC;GACV,aAAa;GACb,OAAO;IArFX,MAAM;IACN,sBAAsB;IACtB,UAAU,CAAC,QAAQ,QAAQ;IAC3B,YAAY;KACV,MAAM;MACJ,MAAM;MACN,aAAa;KACf;KACA,QAAQ;MACN,MAAM;MACN,MAAM;OAAC;OAAW;OAAW;MAAS;MACtC,aACE;KACJ;KACA,OAAO;MACL,MAAM,CAAC,UAAU,MAAM;MACvB,aAAa;KACf;KACA,QAAQ;MACN,MAAM;MACN,aACE;KACJ;IACF;GA8DiC;EAC/B;CACF;AACF;AAEA,MAAa,iBAAiB;CAC5B,SAAS;CACT,KAAK;CACL,OAAO;CACP,aACE;CACF,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;EAAc;EAAe;CAAU;CAChE,sBAAsB;CACtB,YAAY;EACV,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,UAAU;GACjB,SAAS;EACX;EACA,YAAY;GACV,MAAM;GACN,aACE;EACJ;EACA,YAAY;GACV,MAAM;GACN,OAAO,EAAE,MAAM,SAAS;GACxB,aAAa;EACf;EACA,aAAa;GACX,MAAM;GACN,aAAa;EACf;EACA,aAAa;GACX,GAAG;GACH,aACE;EACJ;EACA,eAAe;GACb,MAAM;GACN,aACE;EACJ;EACA,eAAe;GACb,GAAG;GACH,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,SAAS,CAAC;GACV,aACE;GACF,OAAO,EACL,OAAO,CAAC,oBAAoB,sBAAsB,EACpD;EACF;EACA,WAAW;GACT,MAAM;GACN,aAAa;EACf;EACA,WAAW;GACT,MAAM;GACN,aAAa;EACf;EACA,WAAW;GACT,MAAM;IAAC;IAAU;IAAU;GAAM;GACjC,QAAQ;GACR,aAAa;EACf;CACF;AACF"}
+{"version":3,"file":"sosEvent.js","names":[],"sources":["../../.generated/schemas/sosEvent.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\n// Sub-node consts must not be exported: the model generator treats the first\n// export ending in \"Schema\" as the entity schema.\nconst sosActorNode = {\n  type: [\"object\", \"null\"],\n  additionalProperties: false,\n  required: [\"id\", \"discriminator\"],\n  properties: {\n    id: { type: \"string\" },\n    discriminator: {\n      type: \"string\",\n      enum: [\"user\", \"device\", \"automation\"],\n    },\n  },\n} as const;\n\n// Live outcome rollup for one channel. Buckets map the raw vendor statuses:\n// `sent` = accepted/in-flight but not yet terminal, `delivered` = terminal\n// success (delivered/read/opened/clicked), `failed` = terminal failure\n// (failed/undelivered/bounced/blocked). See deliveryOutcomeForStatus.\nconst deliveryOutcomeNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"sent\", \"delivered\", \"failed\"],\n  properties: {\n    sent: { type: \"integer\", minimum: 0 },\n    delivered: { type: \"integer\", minimum: 0 },\n    failed: { type: \"integer\", minimum: 0 },\n  },\n} as const;\n\nconst audienceDeliveryNode = {\n  type: \"object\",\n  additionalProperties: false,\n  description: \"Per-channel live outcomes for one audience.\",\n  properties: {\n    sms: deliveryOutcomeNode,\n    email: deliveryOutcomeNode,\n  },\n} as const;\n\n// A timeline entry is a discriminated union on `type`, so `timeline.items` is\n// their `oneOf`. The branches are disjoint via the `type` enum plus\n// `additionalProperties: false`, so an entry validates against exactly one.\nconst broadcastEntryNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"id\", \"type\", \"message\", \"by\", \"at\", \"audience\"],\n  properties: {\n    id: {\n      type: \"string\",\n      description: \"Unique identifier for the timeline entry.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"activation\", \"update\", \"final\"],\n      description:\n        \"`activation` opens the event, `update` is an interim message, `final` closes it.\",\n    },\n    message: {\n      type: \"string\",\n      description:\n        \"The entry's message body. May be empty for entries that carry only audience/delivery intent.\",\n    },\n    by: {\n      ...sosActorNode,\n      description: \"Actor that authored the entry; null when unattributed.\",\n    },\n    at: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the entry was recorded.\",\n    },\n    audience: {\n      $ref: \"definitions.json#/definitions/audience\",\n      description:\n        \"Who this entry was directed at, and who it resolved to. `activation` entries always carry the everyone wildcard; `update` and `final` entries carry whatever the sender named — an empty selector reaches nobody.\",\n    },\n    channels: {\n      type: \"array\",\n      items: { type: \"string\", enum: [\"sms\", \"email\"] },\n      description:\n        \"Personal channels the sender selected for this entry. Absent on entries recorded before channel selection existed, which sent over both.\",\n    },\n    surfaces: {\n      type: \"object\",\n      additionalProperties: false,\n      required: [\"targets\", \"sent\", \"failed\", \"skipped\"],\n      description:\n        \"Rollup of the PA-surface dispatch, present when the entry named surfaces. `targets` is the devices the selectors resolved to; `skipped` counts drivers that cannot render content.\",\n      properties: {\n        targets: { type: \"integer\", minimum: 0 },\n        sent: { type: \"integer\", minimum: 0 },\n        failed: { type: \"integer\", minimum: 0 },\n        skipped: { type: \"integer\", minimum: 0 },\n      },\n    },\n    deliveryStatus: {\n      type: \"object\",\n      additionalProperties: false,\n      description:\n        \"Computed on demand by DescribeSOSEvent (not persisted): live per-audience, per-channel outcome counts grouped from the sms/email collections by appData.sosUpdateId × status. Absent on the returned event until at least one matching message exists; only audiences/channels with data are present.\",\n      properties: {\n        internal: audienceDeliveryNode,\n        external: audienceDeliveryNode,\n      },\n    },\n  },\n} as const;\n\nconst automationRunActionNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"type\", \"status\"],\n  properties: {\n    type: {\n      type: \"string\",\n      description: \"The use case the automation action invoked.\",\n    },\n    status: {\n      type: \"string\",\n      enum: [\"pending\", \"success\", \"failure\"],\n      description:\n        \"`pending` while the action is in flight; settles to `success` or `failure`.\",\n    },\n    error: {\n      type: [\"string\", \"null\"],\n      description: \"Failure message; absent when the action succeeded.\",\n    },\n    params: {\n      type: \"object\",\n      description:\n        \"Pruned snapshot of the action's configured params (e.g. SetDevices device states, StartSOS type ids), enough to render a human summary of what the action did. Absent when the use case has no summarizable params.\",\n    },\n  },\n} as const;\n\nconst automationRunEntryNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\n    \"id\",\n    \"type\",\n    \"at\",\n    \"by\",\n    \"automationName\",\n    \"runId\",\n    \"trigger\",\n    \"actions\",\n  ],\n  properties: {\n    id: {\n      type: \"string\",\n      description: \"Unique identifier for the timeline entry.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"automationRun\"],\n      description:\n        \"Discriminator: an automation that ran in response to this SOS.\",\n    },\n    at: {\n      $ref: \"definitions.json#/definitions/date\",\n      description:\n        \"When the run started. The entry is stamped with pending actions up front and settled in place.\",\n    },\n    by: {\n      type: \"object\",\n      additionalProperties: false,\n      required: [\"id\", \"discriminator\"],\n      description:\n        \"The Automation that ran. Its id is the automation's id — there is no separate automationId.\",\n      properties: {\n        id: { type: \"string\" },\n        discriminator: { type: \"string\", enum: [\"automation\"] },\n      },\n    },\n    automationName: {\n      type: \"string\",\n      description:\n        \"The automation's name snapshotted at run time, so a later rename or delete leaves the timeline readable.\",\n    },\n    runId: {\n      type: \"string\",\n      description:\n        \"Groups this run's Activity records; one event matching several automations yields one runId each.\",\n    },\n    trigger: {\n      type: \"string\",\n      enum: [\"SOSActive\", \"SOSInactive\"],\n      description: \"The SOS event type that matched the automation's trigger.\",\n    },\n    actions: {\n      type: \"array\",\n      default: [],\n      description: \"Per-action outcome, in the automation's action order.\",\n      items: automationRunActionNode,\n    },\n  },\n} as const;\n\nconst noteNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"id\", \"text\", \"by\", \"at\"],\n  properties: {\n    id: {\n      type: \"string\",\n      description: \"Unique identifier for the note.\",\n    },\n    text: {\n      type: \"string\",\n      description: \"Internal, plain-text note body. Never broadcast.\",\n    },\n    by: {\n      ...sosActorNode,\n      description: \"Actor that wrote the note; null when unattributed.\",\n    },\n    at: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the note was recorded.\",\n    },\n  },\n} as const;\n\nexport const sosEventSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"sosEvent.json\",\n  title: \"SOS Event\",\n  description:\n    \"A durable record of a single SOS activation on a Property, with an append-only timeline of updates. Persists as audit history after the SOS is cleared.\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"sosTypeIds\", \"activatedAt\", \"timeline\"],\n  additionalProperties: false,\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n      description: \"Unique identifier for the SOS Event.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"sosEvent\"],\n      default: \"sosEvent\",\n    },\n    propertyId: {\n      type: \"string\",\n      description:\n        \"ID of the Property this SOS was raised on. Used as a per-document filter inside the org-scoped database.\",\n    },\n    sosTypeIds: {\n      type: \"array\",\n      items: { type: \"string\" },\n      description: \"The SOS Type ids this event was raised for.\",\n    },\n    activatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the SOS was raised.\",\n    },\n    activatedBy: {\n      ...sosActorNode,\n      description:\n        \"Actor that raised the SOS (user, device, or automation); null when unattributed.\",\n    },\n    deactivatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description:\n        \"When the SOS was cleared. Absent while the event is active.\",\n    },\n    deactivatedBy: {\n      ...sosActorNode,\n      description:\n        \"Actor that cleared the SOS; null when unattributed. Absent while the event is active.\",\n    },\n    timeline: {\n      type: \"array\",\n      default: [],\n      description:\n        \"Append-only timeline. The first entry is the `activation`; later entries are operator `update`s, automation runs, and a closing `final`.\",\n      items: {\n        oneOf: [broadcastEntryNode, automationRunEntryNode],\n      },\n    },\n    notes: {\n      type: \"array\",\n      default: [],\n      description:\n        \"Append-only, internal-only post-incident notes. Kept outside the timeline: a note is for the record, never something that was broadcast.\",\n      items: noteNode,\n    },\n    report: {\n      type: \"object\",\n      additionalProperties: false,\n      required: [\"fileId\", \"url\", \"filename\", \"contentHash\", \"renderedAt\"],\n      description:\n        \"The most recently minted incident-report PDF, kept so a re-export of an unchanged, ended incident can reuse the file instead of rendering again. `contentHash` fingerprints the rendered content (excluding the generated-at stamp).\",\n      properties: {\n        fileId: { type: \"string\" },\n        url: { type: \"string\" },\n        filename: { type: \"string\" },\n        contentHash: { type: \"string\" },\n        renderedAt: { $ref: \"definitions.json#/definitions/date\" },\n      },\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the SOS Event was created.\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description: \"When the SOS Event was last modified.\",\n    },\n    deletedAt: {\n      type: [\"string\", \"object\", \"null\"],\n      format: \"date-time\",\n      description: \"Soft-delete tombstone.\",\n    },\n  },\n} as const;\n\nexport type SOSEventSchema = FromSchema<\n  typeof sosEventSchema,\n  {\n    references: [typeof defs];\n    // `notes` carries `default: []` but is not required; keep it optional in\n    // the type so pre-notes documents and writers that omit it still fit.\n    keepDefaultedPropertiesOptional: true;\n    deserialize: [\n      {\n        pattern: {\n          format: \"date-time\";\n        };\n        output: Date | ISODateString;\n      },\n    ];\n  }\n>;\n"],"mappings":";AAKA,MAAM,eAAe;CACnB,MAAM,CAAC,UAAU,MAAM;CACvB,sBAAsB;CACtB,UAAU,CAAC,MAAM,eAAe;CAChC,YAAY;EACV,IAAI,EAAE,MAAM,SAAS;EACrB,eAAe;GACb,MAAM;GACN,MAAM;IAAC;IAAQ;IAAU;GAAY;EACvC;CACF;AACF;AAMA,MAAM,sBAAsB;CAC1B,MAAM;CACN,sBAAsB;CACtB,UAAU;EAAC;EAAQ;EAAa;CAAQ;CACxC,YAAY;EACV,MAAM;GAAE,MAAM;GAAW,SAAS;EAAE;EACpC,WAAW;GAAE,MAAM;GAAW,SAAS;EAAE;EACzC,QAAQ;GAAE,MAAM;GAAW,SAAS;EAAE;CACxC;AACF;AAEA,MAAM,uBAAuB;CAC3B,MAAM;CACN,sBAAsB;CACtB,aAAa;CACb,YAAY;EACV,KAAK;EACL,OAAO;CACT;AACF;AAKA,MAAM,qBAAqB;CACzB,MAAM;CACN,sBAAsB;CACtB,UAAU;EAAC;EAAM;EAAQ;EAAW;EAAM;EAAM;CAAU;CAC1D,YAAY;EACV,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,MAAM;IAAC;IAAc;IAAU;GAAO;GACtC,aACE;EACJ;EACA,SAAS;GACP,MAAM;GACN,aACE;EACJ;EACA,IAAI;GACF,GAAG;GACH,aAAa;EACf;EACA,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,OAAO;IAAE,MAAM;IAAU,MAAM,CAAC,OAAO,OAAO;GAAE;GAChD,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,sBAAsB;GACtB,UAAU;IAAC;IAAW;IAAQ;IAAU;GAAS;GACjD,aACE;GACF,YAAY;IACV,SAAS;KAAE,MAAM;KAAW,SAAS;IAAE;IACvC,MAAM;KAAE,MAAM;KAAW,SAAS;IAAE;IACpC,QAAQ;KAAE,MAAM;KAAW,SAAS;IAAE;IACtC,SAAS;KAAE,MAAM;KAAW,SAAS;IAAE;GACzC;EACF;EACA,gBAAgB;GACd,MAAM;GACN,sBAAsB;GACtB,aACE;GACF,YAAY;IACV,UAAU;IACV,UAAU;GACZ;EACF;CACF;AACF;AA6BA,MAAM,yBAAyB;CAC7B,MAAM;CACN,sBAAsB;CACtB,UAAU;EACR;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACF;CACA,YAAY;EACV,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,eAAe;GACtB,aACE;EACJ;EACA,IAAI;GACF,MAAM;GACN,aACE;EACJ;EACA,IAAI;GACF,MAAM;GACN,sBAAsB;GACtB,UAAU,CAAC,MAAM,eAAe;GAChC,aACE;GACF,YAAY;IACV,IAAI,EAAE,MAAM,SAAS;IACrB,eAAe;KAAE,MAAM;KAAU,MAAM,CAAC,YAAY;IAAE;GACxD;EACF;EACA,gBAAgB;GACd,MAAM;GACN,aACE;EACJ;EACA,OAAO;GACL,MAAM;GACN,aACE;EACJ;EACA,SAAS;GACP,MAAM;GACN,MAAM,CAAC,aAAa,aAAa;GACjC,aAAa;EACf;EACA,SAAS;GACP,MAAM;GACN,SAAS,CAAC;GACV,aAAa;GACb,OAAO;IArFX,MAAM;IACN,sBAAsB;IACtB,UAAU,CAAC,QAAQ,QAAQ;IAC3B,YAAY;KACV,MAAM;MACJ,MAAM;MACN,aAAa;KACf;KACA,QAAQ;MACN,MAAM;MACN,MAAM;OAAC;OAAW;OAAW;MAAS;MACtC,aACE;KACJ;KACA,OAAO;MACL,MAAM,CAAC,UAAU,MAAM;MACvB,aAAa;KACf;KACA,QAAQ;MACN,MAAM;MACN,aACE;KACJ;IACF;GA8DiC;EAC/B;CACF;AACF;AAEA,MAAM,WAAW;CACf,MAAM;CACN,sBAAsB;CACtB,UAAU;EAAC;EAAM;EAAQ;EAAM;CAAI;CACnC,YAAY;EACV,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,aAAa;EACf;EACA,IAAI;GACF,GAAG;GACH,aAAa;EACf;EACA,IAAI;GACF,MAAM;GACN,aAAa;EACf;CACF;AACF;AAEA,MAAa,iBAAiB;CAC5B,SAAS;CACT,KAAK;CACL,OAAO;CACP,aACE;CACF,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;EAAc;EAAe;CAAU;CAChE,sBAAsB;CACtB,YAAY;EACV,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,UAAU;GACjB,SAAS;EACX;EACA,YAAY;GACV,MAAM;GACN,aACE;EACJ;EACA,YAAY;GACV,MAAM;GACN,OAAO,EAAE,MAAM,SAAS;GACxB,aAAa;EACf;EACA,aAAa;GACX,MAAM;GACN,aAAa;EACf;EACA,aAAa;GACX,GAAG;GACH,aACE;EACJ;EACA,eAAe;GACb,MAAM;GACN,aACE;EACJ;EACA,eAAe;GACb,GAAG;GACH,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,SAAS,CAAC;GACV,aACE;GACF,OAAO,EACL,OAAO,CAAC,oBAAoB,sBAAsB,EACpD;EACF;EACA,OAAO;GACL,MAAM;GACN,SAAS,CAAC;GACV,aACE;GACF,OAAO;EACT;EACA,QAAQ;GACN,MAAM;GACN,sBAAsB;GACtB,UAAU;IAAC;IAAU;IAAO;IAAY;IAAe;GAAY;GACnE,aACE;GACF,YAAY;IACV,QAAQ,EAAE,MAAM,SAAS;IACzB,KAAK,EAAE,MAAM,SAAS;IACtB,UAAU,EAAE,MAAM,SAAS;IAC3B,aAAa,EAAE,MAAM,SAAS;IAC9B,YAAY,EAAE,MAAM,qCAAqC;GAC3D;EACF;EACA,WAAW;GACT,MAAM;GACN,aAAa;EACf;EACA,WAAW;GACT,MAAM;GACN,aAAa;EACf;EACA,WAAW;GACT,MAAM;IAAC;IAAU;IAAU;GAAM;GACjC,QAAQ;GACR,aAAa;EACf;CACF;AACF"}

package/dist/schemas/ticket.d.ts

@@ -49,7 +49,7 @@ export declare const ticketSchema: {
                     };
                     readonly discriminator: {
                         readonly type: "string";
-                        readonly enum: readonly ["message", "opened", "assigned", "rated", "scheduled", "collaboratorAdded", "collaboratorRemoved", "statusChanged", "priorityChanged", "scheduleDateChanged", "locationChanged", "issueChanged", "nudged", "approvalRequested", "approvalApproved", "approvalDenied", "workScheduled", "workRescheduled", "workCanceled", "costRecorded", "costPriceChanged"];
+                        readonly enum: readonly ["message", "opened", "assigned", "rated", "scheduled", "collaboratorAdded", "collaboratorRemoved", "statusChanged", "priorityChanged", "scheduleDateChanged", "locationChanged", "issueChanged", "nudged", "approvalRequested", "approvalApproved", "approvalDenied", "workScheduled", "workRescheduled", "workCanceled", "costRecorded", "costPriceChanged", "costVoided"];
                         readonly default: "message";
                         readonly description: "The discriminator of the message.";
                     };
@@ -802,6 +802,11 @@ export declare const ticketSchema: {
                             readonly default: false;
                             readonly description: string;
                         };
+                        readonly voided: {
+                            readonly type: "boolean";
+                            readonly default: false;
+                            readonly description: string;
+                        };
                         readonly billingReview: {
                             readonly type: "array";
                             readonly default: readonly [];
@@ -817,7 +822,7 @@ export declare const ticketSchema: {
                                     };
                                     readonly action: {
                                         readonly type: "string";
-                                        readonly enum: readonly ["writtenOff", "reinstated", "divergenceAcknowledged"];
+                                        readonly enum: readonly ["writtenOff", "voided", "reinstated", "divergenceAcknowledged"];
                                     };
                                     readonly performedBy: {
                                         readonly type: readonly ["string", "null"];
@@ -870,6 +875,16 @@ export declare const ticketSchema: {
                             readonly minimum: 0;
                             readonly description: string;
                         };
+                        readonly voided: {
+                            readonly type: "boolean";
+                            readonly default: false;
+                            readonly description: string;
+                        };
+                        readonly settled: {
+                            readonly type: "boolean";
+                            readonly default: false;
+                            readonly description: string;
+                        };
                     };
                 }];
             };