@kohost/api-client 7.8.2 → 7.9.0

package/dist/schemas/sosEvent.d.ts

@@ -0,0 +1,318 @@
+import defs, { ISODateString } from "./definitions.js";
+import type { FromSchema } from "json-schema-to-ts";
+export declare const sosEventSchema: {
+    readonly $schema: "http://json-schema.org/draft-07/schema";
+    readonly $id: "sosEvent.json";
+    readonly title: "SOS Event";
+    readonly description: "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.";
+    readonly type: "object";
+    readonly required: readonly ["id", "type", "sosTypeIds", "activatedAt", "timeline"];
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly id: {
+            readonly $ref: "definitions.json#/definitions/id";
+            readonly description: "Unique identifier for the SOS Event.";
+        };
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["sosEvent"];
+            readonly default: "sosEvent";
+        };
+        readonly propertyId: {
+            readonly type: "string";
+            readonly description: "ID of the Property this SOS was raised on. Used as a per-document filter inside the org-scoped database.";
+        };
+        readonly sosTypeIds: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+            readonly description: "The SOS Type ids this event was raised for.";
+        };
+        readonly activatedAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When the SOS was raised.";
+        };
+        readonly activatedBy: {
+            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 raised the SOS (user, device, or automation); null when unattributed.";
+        };
+        readonly deactivatedAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When the SOS was cleared. Absent while the event is active.";
+        };
+        readonly deactivatedBy: {
+            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 cleared the SOS; null when unattributed. Absent while the event is active.";
+        };
+        readonly timeline: {
+            readonly type: "array";
+            readonly default: readonly [];
+            readonly description: "Append-only timeline. The first entry is the `activation`; later entries are operator `update`s, automation runs, and a closing `final`.";
+            readonly items: {
+                readonly oneOf: readonly [{
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["id", "type", "message", "by", "at", "audience"];
+                    readonly properties: {
+                        readonly id: {
+                            readonly type: "string";
+                            readonly description: "Unique identifier for the timeline entry.";
+                        };
+                        readonly type: {
+                            readonly type: "string";
+                            readonly enum: readonly ["activation", "update", "final"];
+                            readonly description: "`activation` opens the event, `update` is an interim message, `final` closes it.";
+                        };
+                        readonly message: {
+                            readonly type: "string";
+                            readonly description: "The entry's message body. May be empty for entries that carry only audience/delivery intent.";
+                        };
+                        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 authored the entry; null when unattributed.";
+                        };
+                        readonly at: {
+                            readonly $ref: "definitions.json#/definitions/date";
+                            readonly description: "When the entry was recorded.";
+                        };
+                        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 deliveryStatus: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly 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.";
+                            readonly properties: {
+                                readonly internal: {
+                                    readonly type: "object";
+                                    readonly additionalProperties: false;
+                                    readonly description: "Per-channel live outcomes for one audience.";
+                                    readonly properties: {
+                                        readonly sms: {
+                                            readonly type: "object";
+                                            readonly additionalProperties: false;
+                                            readonly required: readonly ["sent", "delivered", "failed"];
+                                            readonly properties: {
+                                                readonly sent: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly delivered: {
+                                                    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 ["sent", "delivered", "failed"];
+                                            readonly properties: {
+                                                readonly sent: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly delivered: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly failed: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                                readonly emergencyContacts: {
+                                    readonly type: "object";
+                                    readonly additionalProperties: false;
+                                    readonly description: "Per-channel live outcomes for one audience.";
+                                    readonly properties: {
+                                        readonly sms: {
+                                            readonly type: "object";
+                                            readonly additionalProperties: false;
+                                            readonly required: readonly ["sent", "delivered", "failed"];
+                                            readonly properties: {
+                                                readonly sent: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly delivered: {
+                                                    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 ["sent", "delivered", "failed"];
+                                            readonly properties: {
+                                                readonly sent: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly delivered: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly failed: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                }, {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["id", "type", "at", "by", "automationName", "runId", "trigger", "actions"];
+                    readonly properties: {
+                        readonly id: {
+                            readonly type: "string";
+                            readonly description: "Unique identifier for the timeline entry.";
+                        };
+                        readonly type: {
+                            readonly type: "string";
+                            readonly enum: readonly ["automationRun"];
+                            readonly description: "Discriminator: an automation that ran in response to this SOS.";
+                        };
+                        readonly at: {
+                            readonly $ref: "definitions.json#/definitions/date";
+                            readonly description: "When the run started. The entry is stamped with pending actions up front and settled in place.";
+                        };
+                        readonly by: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["id", "discriminator"];
+                            readonly description: "The Automation that ran. Its id is the automation's id — there is no separate automationId.";
+                            readonly properties: {
+                                readonly id: {
+                                    readonly type: "string";
+                                };
+                                readonly discriminator: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["automation"];
+                                };
+                            };
+                        };
+                        readonly automationName: {
+                            readonly type: "string";
+                            readonly description: "The automation's name snapshotted at run time, so a later rename or delete leaves the timeline readable.";
+                        };
+                        readonly runId: {
+                            readonly type: "string";
+                            readonly description: "Groups this run's Activity records; one event matching several automations yields one runId each.";
+                        };
+                        readonly trigger: {
+                            readonly type: "string";
+                            readonly enum: readonly ["SOSActive", "SOSInactive"];
+                            readonly description: "The SOS event type that matched the automation's trigger.";
+                        };
+                        readonly actions: {
+                            readonly type: "array";
+                            readonly default: readonly [];
+                            readonly description: "Per-action outcome, in the automation's action order.";
+                            readonly items: {
+                                readonly type: "object";
+                                readonly additionalProperties: false;
+                                readonly required: readonly ["type", "status"];
+                                readonly properties: {
+                                    readonly type: {
+                                        readonly type: "string";
+                                        readonly description: "The use case the automation action invoked.";
+                                    };
+                                    readonly status: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["pending", "success", "failure"];
+                                        readonly description: "`pending` while the action is in flight; settles to `success` or `failure`.";
+                                    };
+                                    readonly error: {
+                                        readonly type: readonly ["string", "null"];
+                                        readonly description: "Failure message; absent when the action succeeded.";
+                                    };
+                                    readonly params: {
+                                        readonly type: "object";
+                                        readonly description: "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.";
+                                    };
+                                };
+                            };
+                        };
+                    };
+                }];
+            };
+        };
+        readonly createdAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When the SOS Event was created.";
+        };
+        readonly updatedAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When the SOS Event was last modified.";
+        };
+        readonly deletedAt: {
+            readonly type: readonly ["string", "object", "null"];
+            readonly format: "date-time";
+            readonly description: "Soft-delete tombstone.";
+        };
+    };
+};
+export type SOSEventSchema = FromSchema<typeof sosEventSchema, {
+    references: [typeof defs];
+    deserialize: [
+        {
+            pattern: {
+                format: "date-time";
+            };
+            output: Date | ISODateString;
+        }
+    ];
+}>;

package/dist/schemas/sosEvent.js

@@ -0,0 +1,267 @@
+//#region .generated/schemas/sosEvent.ts
+const sosActorNode = {
+	type: ["object", "null"],
+	additionalProperties: false,
+	required: ["id", "discriminator"],
+	properties: {
+		id: { type: "string" },
+		discriminator: {
+			type: "string",
+			enum: [
+				"user",
+				"device",
+				"automation"
+			]
+		}
+	}
+};
+const deliveryOutcomeNode = {
+	type: "object",
+	additionalProperties: false,
+	required: [
+		"sent",
+		"delivered",
+		"failed"
+	],
+	properties: {
+		sent: {
+			type: "integer",
+			minimum: 0
+		},
+		delivered: {
+			type: "integer",
+			minimum: 0
+		},
+		failed: {
+			type: "integer",
+			minimum: 0
+		}
+	}
+};
+const audienceDeliveryNode = {
+	type: "object",
+	additionalProperties: false,
+	description: "Per-channel live outcomes for one audience.",
+	properties: {
+		sms: deliveryOutcomeNode,
+		email: deliveryOutcomeNode
+	}
+};
+const broadcastEntryNode = {
+	type: "object",
+	additionalProperties: false,
+	required: [
+		"id",
+		"type",
+		"message",
+		"by",
+		"at",
+		"audience"
+	],
+	properties: {
+		id: {
+			type: "string",
+			description: "Unique identifier for the timeline entry."
+		},
+		type: {
+			type: "string",
+			enum: [
+				"activation",
+				"update",
+				"final"
+			],
+			description: "`activation` opens the event, `update` is an interim message, `final` closes it."
+		},
+		message: {
+			type: "string",
+			description: "The entry's message body. May be empty for entries that carry only audience/delivery intent."
+		},
+		by: {
+			...sosActorNode,
+			description: "Actor that authored the entry; null when unattributed."
+		},
+		at: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the entry was recorded."
+		},
+		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."
+		},
+		deliveryStatus: {
+			type: "object",
+			additionalProperties: false,
+			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
+			}
+		}
+	}
+};
+const automationRunEntryNode = {
+	type: "object",
+	additionalProperties: false,
+	required: [
+		"id",
+		"type",
+		"at",
+		"by",
+		"automationName",
+		"runId",
+		"trigger",
+		"actions"
+	],
+	properties: {
+		id: {
+			type: "string",
+			description: "Unique identifier for the timeline entry."
+		},
+		type: {
+			type: "string",
+			enum: ["automationRun"],
+			description: "Discriminator: an automation that ran in response to this SOS."
+		},
+		at: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the run started. The entry is stamped with pending actions up front and settled in place."
+		},
+		by: {
+			type: "object",
+			additionalProperties: false,
+			required: ["id", "discriminator"],
+			description: "The Automation that ran. Its id is the automation's id — there is no separate automationId.",
+			properties: {
+				id: { type: "string" },
+				discriminator: {
+					type: "string",
+					enum: ["automation"]
+				}
+			}
+		},
+		automationName: {
+			type: "string",
+			description: "The automation's name snapshotted at run time, so a later rename or delete leaves the timeline readable."
+		},
+		runId: {
+			type: "string",
+			description: "Groups this run's Activity records; one event matching several automations yields one runId each."
+		},
+		trigger: {
+			type: "string",
+			enum: ["SOSActive", "SOSInactive"],
+			description: "The SOS event type that matched the automation's trigger."
+		},
+		actions: {
+			type: "array",
+			default: [],
+			description: "Per-action outcome, in the automation's action order.",
+			items: {
+				type: "object",
+				additionalProperties: false,
+				required: ["type", "status"],
+				properties: {
+					type: {
+						type: "string",
+						description: "The use case the automation action invoked."
+					},
+					status: {
+						type: "string",
+						enum: [
+							"pending",
+							"success",
+							"failure"
+						],
+						description: "`pending` while the action is in flight; settles to `success` or `failure`."
+					},
+					error: {
+						type: ["string", "null"],
+						description: "Failure message; absent when the action succeeded."
+					},
+					params: {
+						type: "object",
+						description: "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."
+					}
+				}
+			}
+		}
+	}
+};
+const sosEventSchema = {
+	$schema: "http://json-schema.org/draft-07/schema",
+	$id: "sosEvent.json",
+	title: "SOS Event",
+	description: "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.",
+	type: "object",
+	required: [
+		"id",
+		"type",
+		"sosTypeIds",
+		"activatedAt",
+		"timeline"
+	],
+	additionalProperties: false,
+	properties: {
+		id: {
+			$ref: "definitions.json#/definitions/id",
+			description: "Unique identifier for the SOS Event."
+		},
+		type: {
+			type: "string",
+			enum: ["sosEvent"],
+			default: "sosEvent"
+		},
+		propertyId: {
+			type: "string",
+			description: "ID of the Property this SOS was raised on. Used as a per-document filter inside the org-scoped database."
+		},
+		sosTypeIds: {
+			type: "array",
+			items: { type: "string" },
+			description: "The SOS Type ids this event was raised for."
+		},
+		activatedAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the SOS was raised."
+		},
+		activatedBy: {
+			...sosActorNode,
+			description: "Actor that raised the SOS (user, device, or automation); null when unattributed."
+		},
+		deactivatedAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the SOS was cleared. Absent while the event is active."
+		},
+		deactivatedBy: {
+			...sosActorNode,
+			description: "Actor that cleared the SOS; null when unattributed. Absent while the event is active."
+		},
+		timeline: {
+			type: "array",
+			default: [],
+			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] }
+		},
+		createdAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the SOS Event was created."
+		},
+		updatedAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the SOS Event was last modified."
+		},
+		deletedAt: {
+			type: [
+				"string",
+				"object",
+				"null"
+			],
+			format: "date-time",
+			description: "Soft-delete tombstone."
+		}
+	}
+};
+//#endregion
+export { sosEventSchema };
+
+//# sourceMappingURL=sosEvent.js.map

package/dist/schemas/sosEvent.js.map

@@ -0,0 +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"}

package/dist/schemas/systemUser.d.ts

@@ -97,6 +97,14 @@ export declare const systemUserSchema: {
         readonly systemId: {
             readonly $ref: "definitions.json#/definitions/systemId";
         };
+        readonly propertyId: {
+            readonly type: "string";
+            readonly description: "ID of the Property this synced user belongs to. Used as a per-document filter inside the org-scoped database.";
+        };
+        readonly syncedAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When this user was last written through from its source system.";
+        };
     };
 };
 export type SystemUserSchema = FromSchema<typeof systemUserSchema, {

package/dist/schemas/systemUser.js

@@ -87,7 +87,15 @@ const systemUserSchema = {
 		revenue: { $ref: "definitions.json#/definitions/revenue" },
 		createdAt: { $ref: "definitions.json#/definitions/date" },
 		updatedAt: { $ref: "definitions.json#/definitions/date" },
-		systemId: { $ref: "definitions.json#/definitions/systemId" }
+		systemId: { $ref: "definitions.json#/definitions/systemId" },
+		propertyId: {
+			type: "string",
+			description: "ID of the Property this synced user belongs to. Used as a per-document filter inside the org-scoped database."
+		},
+		syncedAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When this user was last written through from its source system."
+		}
 	}
 };
 //#endregion