@kohost/api-client 7.8.2 → 7.10.0

package/dist/models/sosEvent.js

@@ -0,0 +1,31 @@
+import { Entity } from "./entity.js";
+import { sosEventSchema } from "../schemas/sosEvent.js";
+import { validateSOSEvent } from "../validate.js";
+//#region .generated/models/sosEvent.ts
+var SOSEvent = class extends Entity {
+	constructor(data) {
+		super(data);
+		this.id = data.id;
+		this.type = data.type;
+		if (data.propertyId !== void 0) this.propertyId = data.propertyId;
+		this.sosTypeIds = data.sosTypeIds;
+		this.activatedAt = data.activatedAt;
+		if (data.activatedBy !== void 0) this.activatedBy = data.activatedBy;
+		if (data.deactivatedAt !== void 0) this.deactivatedAt = data.deactivatedAt;
+		if (data.deactivatedBy !== void 0) this.deactivatedBy = data.deactivatedBy;
+		this.timeline = data.timeline;
+		if (data.notes !== void 0) this.notes = data.notes;
+		if (data.report !== void 0) this.report = data.report;
+		if (data.createdAt !== void 0) this.createdAt = data.createdAt;
+		if (data.updatedAt !== void 0) this.updatedAt = data.updatedAt;
+		if (data.deletedAt !== void 0) this.deletedAt = data.deletedAt;
+	}
+};
+Object.defineProperty(SOSEvent.prototype, "schema", { value: sosEventSchema });
+Object.defineProperty(SOSEvent.prototype, "validator", { get: function() {
+	return validateSOSEvent;
+} });
+//#endregion
+export { SOSEvent };
+
+//# sourceMappingURL=sosEvent.js.map

package/dist/models/sosEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sosEvent.js","names":["validate"],"sources":["../../.generated/models/sosEvent.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateSOSEvent as validate } from \"../validate.js\";\nimport { sosEventSchema, type SOSEventSchema } from \"../schemas/sosEvent.js\";\n\n/**\n * Data type for SOSEvent constructor - exported for backwards compatibility\n */\nexport type SOSEventData = SOSEventSchema;\n\n/**\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 */\nexport interface SOSEvent extends SOSEventSchema {}\nexport class SOSEvent extends Entity {\n  declare schema: typeof sosEventSchema;\n  declare validator: typeof validate;\n\n  constructor(data: SOSEventSchema) {\n    super(data);\n    this.id = data.id;\n    this.type = data.type;\n    if (data.propertyId !== undefined) this.propertyId = data.propertyId;\n    this.sosTypeIds = data.sosTypeIds;\n    this.activatedAt = data.activatedAt;\n    if (data.activatedBy !== undefined) this.activatedBy = data.activatedBy;\n    if (data.deactivatedAt !== undefined) this.deactivatedAt = data.deactivatedAt;\n    if (data.deactivatedBy !== undefined) this.deactivatedBy = data.deactivatedBy;\n    this.timeline = data.timeline;\n    if (data.notes !== undefined) this.notes = data.notes;\n    if (data.report !== undefined) this.report = data.report;\n    if (data.createdAt !== undefined) this.createdAt = data.createdAt;\n    if (data.updatedAt !== undefined) this.updatedAt = data.updatedAt;\n    if (data.deletedAt !== undefined) this.deletedAt = data.deletedAt;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(SOSEvent.prototype, \"schema\", {\n  value: sosEventSchema\n});\n\nObject.defineProperty(SOSEvent.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,WAAb,cAA8B,OAAO;CAInC,YAAY,MAAsB;EAChC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,KAAK,OAAO,KAAK;EACjB,IAAI,KAAK,eAAe,KAAA,GAAW,KAAK,aAAa,KAAK;EAC1D,KAAK,aAAa,KAAK;EACvB,KAAK,cAAc,KAAK;EACxB,IAAI,KAAK,gBAAgB,KAAA,GAAW,KAAK,cAAc,KAAK;EAC5D,IAAI,KAAK,kBAAkB,KAAA,GAAW,KAAK,gBAAgB,KAAK;EAChE,IAAI,KAAK,kBAAkB,KAAA,GAAW,KAAK,gBAAgB,KAAK;EAChE,KAAK,WAAW,KAAK;EACrB,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;CAC1D;AASF;AAEA,OAAO,eAAe,SAAS,WAAW,UAAU,EAClD,OAAO,eACT,CAAC;AAED,OAAO,eAAe,SAAS,WAAW,aAAa,EACrD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}

package/dist/models/systemUser.js

@@ -27,6 +27,8 @@ var SystemUser = class extends Entity {
 		if (data.createdAt !== void 0) this.createdAt = data.createdAt;
 		if (data.updatedAt !== void 0) this.updatedAt = data.updatedAt;
 		if (data.systemId !== void 0) this.systemId = data.systemId;
+		if (data.propertyId !== void 0) this.propertyId = data.propertyId;
+		if (data.syncedAt !== void 0) this.syncedAt = data.syncedAt;
 	}
 };
 Object.defineProperty(SystemUser.prototype, "schema", { value: systemUserSchema });

package/dist/models/systemUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"systemUser.js","names":["validate"],"sources":["../../.generated/models/systemUser.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateSystemUser as validate } from \"../validate.js\";\nimport { systemUserSchema, type SystemUserSchema } from \"../schemas/systemUser.js\";\n\n/**\n * Data type for SystemUser constructor - exported for backwards compatibility\n */\nexport type SystemUserData = SystemUserSchema;\n\n/**\n * A system user is a user that originated from an external 3rd party system.\n */\nexport interface SystemUser extends SystemUserSchema {}\nexport class SystemUser extends Entity {\n  declare schema: typeof systemUserSchema;\n  declare validator: typeof validate;\n\n  constructor(data: SystemUserSchema) {\n    super(data);\n    this.id = data.id;\n    if (data.type !== undefined) this.type = data.type;\n    if (data.driver !== undefined) this.driver = data.driver;\n    this.firstName = data.firstName;\n    this.lastName = data.lastName;\n    if (data.phone !== undefined) this.phone = data.phone;\n    if (data.email !== undefined) this.email = data.email;\n    if (data.address !== undefined) this.address = data.address;\n    if (data.photo !== undefined) this.photo = data.photo;\n    if (data.jobTitle !== undefined) this.jobTitle = data.jobTitle;\n    if (data.dob !== undefined) this.dob = data.dob;\n    if (data.gender !== undefined) this.gender = data.gender;\n    if (data.roles !== undefined) this.roles = data.roles;\n    if (data.nationality !== undefined) this.nationality = data.nationality;\n    if (data.notes !== undefined) this.notes = data.notes;\n    if (data.files !== undefined) this.files = data.files;\n    if (data.identifications !== undefined) this.identifications = data.identifications;\n    if (data.payments !== undefined) this.payments = data.payments;\n    if (data.revenue !== undefined) this.revenue = data.revenue;\n    if (data.createdAt !== undefined) this.createdAt = data.createdAt;\n    if (data.updatedAt !== undefined) this.updatedAt = data.updatedAt;\n    if (data.systemId !== undefined) this.systemId = data.systemId;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(SystemUser.prototype, \"schema\", {\n  value: systemUserSchema\n});\n\nObject.defineProperty(SystemUser.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,aAAb,cAAgC,OAAO;CAIrC,YAAY,MAAwB;EAClC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,IAAI,KAAK,SAAS,KAAA,GAAW,KAAK,OAAO,KAAK;EAC9C,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,KAAK,YAAY,KAAK;EACtB,KAAK,WAAW,KAAK;EACrB,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,QAAQ,KAAA,GAAW,KAAK,MAAM,KAAK;EAC5C,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,gBAAgB,KAAA,GAAW,KAAK,cAAc,KAAK;EAC5D,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,oBAAoB,KAAA,GAAW,KAAK,kBAAkB,KAAK;EACpE,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;CACxD;AASF;AAEA,OAAO,eAAe,WAAW,WAAW,UAAU,EACpD,OAAO,iBACT,CAAC;AAED,OAAO,eAAe,WAAW,WAAW,aAAa,EACvD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}
+{"version":3,"file":"systemUser.js","names":["validate"],"sources":["../../.generated/models/systemUser.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateSystemUser as validate } from \"../validate.js\";\nimport { systemUserSchema, type SystemUserSchema } from \"../schemas/systemUser.js\";\n\n/**\n * Data type for SystemUser constructor - exported for backwards compatibility\n */\nexport type SystemUserData = SystemUserSchema;\n\n/**\n * A system user is a user that originated from an external 3rd party system.\n */\nexport interface SystemUser extends SystemUserSchema {}\nexport class SystemUser extends Entity {\n  declare schema: typeof systemUserSchema;\n  declare validator: typeof validate;\n\n  constructor(data: SystemUserSchema) {\n    super(data);\n    this.id = data.id;\n    if (data.type !== undefined) this.type = data.type;\n    if (data.driver !== undefined) this.driver = data.driver;\n    this.firstName = data.firstName;\n    this.lastName = data.lastName;\n    if (data.phone !== undefined) this.phone = data.phone;\n    if (data.email !== undefined) this.email = data.email;\n    if (data.address !== undefined) this.address = data.address;\n    if (data.photo !== undefined) this.photo = data.photo;\n    if (data.jobTitle !== undefined) this.jobTitle = data.jobTitle;\n    if (data.dob !== undefined) this.dob = data.dob;\n    if (data.gender !== undefined) this.gender = data.gender;\n    if (data.roles !== undefined) this.roles = data.roles;\n    if (data.nationality !== undefined) this.nationality = data.nationality;\n    if (data.notes !== undefined) this.notes = data.notes;\n    if (data.files !== undefined) this.files = data.files;\n    if (data.identifications !== undefined) this.identifications = data.identifications;\n    if (data.payments !== undefined) this.payments = data.payments;\n    if (data.revenue !== undefined) this.revenue = data.revenue;\n    if (data.createdAt !== undefined) this.createdAt = data.createdAt;\n    if (data.updatedAt !== undefined) this.updatedAt = data.updatedAt;\n    if (data.systemId !== undefined) this.systemId = data.systemId;\n    if (data.propertyId !== undefined) this.propertyId = data.propertyId;\n    if (data.syncedAt !== undefined) this.syncedAt = data.syncedAt;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(SystemUser.prototype, \"schema\", {\n  value: systemUserSchema\n});\n\nObject.defineProperty(SystemUser.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,aAAb,cAAgC,OAAO;CAIrC,YAAY,MAAwB;EAClC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,IAAI,KAAK,SAAS,KAAA,GAAW,KAAK,OAAO,KAAK;EAC9C,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,KAAK,YAAY,KAAK;EACtB,KAAK,WAAW,KAAK;EACrB,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,QAAQ,KAAA,GAAW,KAAK,MAAM,KAAK;EAC5C,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,gBAAgB,KAAA,GAAW,KAAK,cAAc,KAAK;EAC5D,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,oBAAoB,KAAA,GAAW,KAAK,kBAAkB,KAAK;EACpE,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,eAAe,KAAA,GAAW,KAAK,aAAa,KAAK;EAC1D,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;CACxD;AASF;AAEA,OAAO,eAAe,WAAW,WAAW,UAAU,EACpD,OAAO,iBACT,CAAC;AAED,OAAO,eAAe,WAAW,WAAW,aAAa,EACvD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}

package/dist/schemas/announcement.d.ts

@@ -6,7 +6,7 @@ export declare const announcementSchema: {
     readonly title: "Announcement";
     readonly description: "Announcement message sent to users";
     readonly type: "object";
-    readonly required: readonly ["id", "type", "body"];
+    readonly required: readonly ["id", "type"];
     readonly properties: {
         readonly id: {
             readonly $ref: "definitions.json#/definitions/id";
@@ -20,18 +20,81 @@ export declare const announcementSchema: {
             readonly enum: readonly ["announcement"];
             readonly default: "announcement";
         };
-        readonly users: {
+        readonly status: {
+            readonly type: "string";
+            readonly description: "`sent` is a real broadcast; `preset` is a named, reusable configuration a sender loads into the composer. Absent on records written before presets existed — read as `sent`.";
+            readonly enum: readonly ["sent", "preset"];
+            readonly default: "sent";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly description: "Display name of a preset. Sent announcements have none.";
+        };
+        readonly presetId: {
+            readonly type: "string";
+            readonly description: "The preset this sent announcement was loaded from, when it was.";
+        };
+        readonly audience: {
+            readonly $ref: "definitions.json#/definitions/audience";
+            readonly description: "Who this announcement was directed at on the people axis. PA surfaces are the other axis and never reach the emergency-contact roster.";
+        };
+        readonly channels: {
             readonly type: "array";
+            readonly description: "Personal channels this announcement was sent over.";
             readonly items: {
                 readonly type: "string";
+                readonly enum: readonly ["sms", "email"];
             };
-            readonly minItems: 1;
         };
-        readonly group: {
+        readonly subject: {
             readonly type: "string";
+            readonly description: "Email subject, and the title shown on a surface.";
+        };
+        readonly surfaces: {
+            readonly type: "array";
+            readonly description: "Surface channels the announcement was broadcast to, as the sender selected them. `discriminator` is the mediaSource `Device.discriminator` targeted, open for future surface types; only `paSystem` ships today.";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["discriminator", "scope"];
+                readonly properties: {
+                    readonly discriminator: {
+                        readonly type: "string";
+                        readonly enum: readonly ["paSystem"];
+                    };
+                    readonly scope: {
+                        readonly type: "string";
+                        readonly enum: readonly ["all", "spaces", "devices"];
+                    };
+                    readonly spaceIds: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly deviceIds: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly outputs: {
+                        readonly type: "array";
+                        readonly description: "PA output zones to page; all zones when omitted.";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly playlistId: {
+                        readonly type: "string";
+                        readonly description: "A PA playlist (driver recording) played in place of the spoken body; its zones are the playlist's own.";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
         };
         readonly body: {
             readonly type: "string";
+            readonly description: "The spoken/written message. Optional only when every surface plays a preset and no channel is selected.";
         };
         readonly media: {
             readonly $ref: "mediaFile.json";
@@ -39,6 +102,103 @@ export declare const announcementSchema: {
         readonly sentBy: {
             readonly type: "string";
         };
+        readonly result: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["recipientsResolved", "perChannel", "skipped", "surfaces"];
+            readonly description: "What the send actually achieved, written once at send time and never recomputed. Absent on presets and on sends recorded before this was stored. The `audience.delivery` counts are the same send viewed per audience; this is the per-channel and per-device detail behind them.";
+            readonly properties: {
+                readonly recipientsResolved: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "How many internal Users the audience selector resolved to. Zero when no personal channel was selected, however wide the selector — an announcement with no channel reaches no User.";
+                };
+                readonly external: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["recipients", "delivery"];
+                    readonly description: "The external SIS roster this send reached. Absent when no external group was named.";
+                    readonly properties: {
+                        readonly recipients: {
+                            readonly type: "integer";
+                            readonly minimum: 0;
+                            readonly description: "Size of the roster the named groups resolved to.";
+                        };
+                        readonly delivery: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly description: "Per-channel counts, present only for the channels attempted.";
+                            readonly properties: {
+                                readonly sms: {
+                                    readonly $ref: "definitions.json#/definitions/deliveryCounts";
+                                };
+                                readonly email: {
+                                    readonly $ref: "definitions.json#/definitions/deliveryCounts";
+                                };
+                            };
+                        };
+                    };
+                };
+                readonly perChannel: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["sms", "email"];
+                    readonly description: "Messages handed to each personal channel; zero for a channel the send did not select.";
+                    readonly properties: {
+                        readonly sms: {
+                            readonly type: "integer";
+                        };
+                        readonly email: {
+                            readonly type: "integer";
+                        };
+                    };
+                };
+                readonly skipped: {
+                    readonly type: "array";
+                    readonly description: "Recipients a selected channel could not carry the announcement to. A missing contact detail is a per-channel skip, not a failed send, so one recipient may appear once per channel.";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["userId", "channel", "reason"];
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly userId: {
+                                readonly type: "string";
+                            };
+                            readonly channel: {
+                                readonly type: "string";
+                                readonly enum: readonly ["sms", "email"];
+                            };
+                            readonly reason: {
+                                readonly type: "string";
+                                readonly enum: readonly ["no-phone", "no-email"];
+                            };
+                        };
+                    };
+                };
+                readonly surfaces: {
+                    readonly type: "array";
+                    readonly description: "Per-device outcome of the surface page, one entry per device the selectors resolved to. Distinct from the top-level `surfaces`, which is the selector the sender expressed.";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["deviceId", "status"];
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly deviceId: {
+                                readonly type: "string";
+                            };
+                            readonly status: {
+                                readonly type: "string";
+                                readonly enum: readonly ["sent", "failed", "skipped"];
+                            };
+                            readonly reason: {
+                                readonly type: "string";
+                                readonly description: '`unsupported` when the driver advertises no content command; absent otherwise.';
+                            };
+                        };
+                    };
+                };
+            };
+        };
         readonly tags: {
             readonly type: "array";
             readonly items: {

package/dist/schemas/announcement.js

@@ -5,11 +5,7 @@ const announcementSchema = {
 	title: "Announcement",
 	description: "Announcement message sent to users",
 	type: "object",
-	required: [
-		"id",
-		"type",
-		"body"
-	],
+	required: ["id", "type"],
 	properties: {
 		id: { $ref: "definitions.json#/definitions/id" },
 		propertyId: {
@@ -21,15 +17,180 @@ const announcementSchema = {
 			enum: ["announcement"],
 			default: "announcement"
 		},
-		users: {
+		status: {
+			type: "string",
+			description: "`sent` is a real broadcast; `preset` is a named, reusable configuration a sender loads into the composer. Absent on records written before presets existed — read as `sent`.",
+			enum: ["sent", "preset"],
+			default: "sent"
+		},
+		name: {
+			type: "string",
+			description: "Display name of a preset. Sent announcements have none."
+		},
+		presetId: {
+			type: "string",
+			description: "The preset this sent announcement was loaded from, when it was."
+		},
+		audience: {
+			$ref: "definitions.json#/definitions/audience",
+			description: "Who this announcement was directed at on the people axis. PA surfaces are the other axis and never reach the emergency-contact roster."
+		},
+		channels: {
 			type: "array",
-			items: { type: "string" },
-			minItems: 1
+			description: "Personal channels this announcement was sent over.",
+			items: {
+				type: "string",
+				enum: ["sms", "email"]
+			}
+		},
+		subject: {
+			type: "string",
+			description: "Email subject, and the title shown on a surface."
+		},
+		surfaces: {
+			type: "array",
+			description: "Surface channels the announcement was broadcast to, as the sender selected them. `discriminator` is the mediaSource `Device.discriminator` targeted, open for future surface types; only `paSystem` ships today.",
+			items: {
+				type: "object",
+				required: ["discriminator", "scope"],
+				properties: {
+					discriminator: {
+						type: "string",
+						enum: ["paSystem"]
+					},
+					scope: {
+						type: "string",
+						enum: [
+							"all",
+							"spaces",
+							"devices"
+						]
+					},
+					spaceIds: {
+						type: "array",
+						items: { type: "string" }
+					},
+					deviceIds: {
+						type: "array",
+						items: { type: "string" }
+					},
+					outputs: {
+						type: "array",
+						description: "PA output zones to page; all zones when omitted.",
+						items: { type: "string" }
+					},
+					playlistId: {
+						type: "string",
+						description: "A PA playlist (driver recording) played in place of the spoken body; its zones are the playlist's own."
+					}
+				},
+				additionalProperties: false
+			}
+		},
+		body: {
+			type: "string",
+			description: "The spoken/written message. Optional only when every surface plays a preset and no channel is selected."
 		},
-		group: { type: "string" },
-		body: { type: "string" },
 		media: { $ref: "mediaFile.json" },
 		sentBy: { type: "string" },
+		result: {
+			type: "object",
+			additionalProperties: false,
+			required: [
+				"recipientsResolved",
+				"perChannel",
+				"skipped",
+				"surfaces"
+			],
+			description: "What the send actually achieved, written once at send time and never recomputed. Absent on presets and on sends recorded before this was stored. The `audience.delivery` counts are the same send viewed per audience; this is the per-channel and per-device detail behind them.",
+			properties: {
+				recipientsResolved: {
+					type: "integer",
+					minimum: 0,
+					description: "How many internal Users the audience selector resolved to. Zero when no personal channel was selected, however wide the selector — an announcement with no channel reaches no User."
+				},
+				external: {
+					type: "object",
+					additionalProperties: false,
+					required: ["recipients", "delivery"],
+					description: "The external SIS roster this send reached. Absent when no external group was named.",
+					properties: {
+						recipients: {
+							type: "integer",
+							minimum: 0,
+							description: "Size of the roster the named groups resolved to."
+						},
+						delivery: {
+							type: "object",
+							additionalProperties: false,
+							description: "Per-channel counts, present only for the channels attempted.",
+							properties: {
+								sms: { $ref: "definitions.json#/definitions/deliveryCounts" },
+								email: { $ref: "definitions.json#/definitions/deliveryCounts" }
+							}
+						}
+					}
+				},
+				perChannel: {
+					type: "object",
+					additionalProperties: false,
+					required: ["sms", "email"],
+					description: "Messages handed to each personal channel; zero for a channel the send did not select.",
+					properties: {
+						sms: { type: "integer" },
+						email: { type: "integer" }
+					}
+				},
+				skipped: {
+					type: "array",
+					description: "Recipients a selected channel could not carry the announcement to. A missing contact detail is a per-channel skip, not a failed send, so one recipient may appear once per channel.",
+					items: {
+						type: "object",
+						required: [
+							"userId",
+							"channel",
+							"reason"
+						],
+						additionalProperties: false,
+						properties: {
+							userId: { type: "string" },
+							channel: {
+								type: "string",
+								enum: ["sms", "email"]
+							},
+							reason: {
+								type: "string",
+								enum: ["no-phone", "no-email"]
+							}
+						}
+					}
+				},
+				surfaces: {
+					type: "array",
+					description: "Per-device outcome of the surface page, one entry per device the selectors resolved to. Distinct from the top-level `surfaces`, which is the selector the sender expressed.",
+					items: {
+						type: "object",
+						required: ["deviceId", "status"],
+						additionalProperties: false,
+						properties: {
+							deviceId: { type: "string" },
+							status: {
+								type: "string",
+								enum: [
+									"sent",
+									"failed",
+									"skipped"
+								]
+							},
+							reason: {
+								type: "string",
+								description: "`unsupported` when the driver advertises no content command; absent otherwise."
+							}
+						}
+					}
+				}
+			}
+		},
 		tags: {
 			type: "array",
 			items: { type: "string" }

package/dist/schemas/announcement.js.map

@@ -1 +1 @@
-{"version":3,"file":"announcement.js","names":[],"sources":["../../.generated/schemas/announcement.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const announcementSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"announcement.json\",\n  title: \"Announcement\",\n  description: \"Announcement message sent to users\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"body\"],\n  properties: {\n    id: { $ref: \"definitions.json#/definitions/id\" },\n    propertyId: {\n      type: \"string\",\n      description: \"ID of the property this entity belongs to. Optional — used as a per-document filter inside the org-scoped database.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"announcement\"],\n      default: \"announcement\",\n    },\n    users: {\n      type: \"array\",\n      items: {\n        type: \"string\",\n      },\n      minItems: 1,\n    },\n    group: {\n      type: \"string\",\n    },\n    body: {\n      type: \"string\",\n    },\n    media: {\n      $ref: \"mediaFile.json\",\n    },\n    sentBy: {\n      type: \"string\",\n    },\n    tags: {\n      type: \"array\",\n      items: {\n        type: \"string\",\n      },\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    deletedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n  },\n  additionalProperties: false,\n} as const;\n\nexport type AnnouncementSchema = FromSchema<\n  typeof announcementSchema,\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":";AAGA,MAAa,qBAAqB;CAChC,SAAS;CACT,KAAK;CACL,OAAO;CACP,aAAa;CACb,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;CAAM;CAC/B,YAAY;EACV,IAAI,EAAE,MAAM,mCAAmC;EAC/C,YAAY;GACV,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,cAAc;GACrB,SAAS;EACX;EACA,OAAO;GACL,MAAM;GACN,OAAO,EACL,MAAM,SACR;GACA,UAAU;EACZ;EACA,OAAO,EACL,MAAM,SACR;EACA,MAAM,EACJ,MAAM,SACR;EACA,OAAO,EACL,MAAM,iBACR;EACA,QAAQ,EACN,MAAM,SACR;EACA,MAAM;GACJ,MAAM;GACN,OAAO,EACL,MAAM,SACR;EACF;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;CACA,sBAAsB;AACxB"}
+{"version":3,"file":"announcement.js","names":[],"sources":["../../.generated/schemas/announcement.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const announcementSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"announcement.json\",\n  title: \"Announcement\",\n  description: \"Announcement message sent to users\",\n  type: \"object\",\n  required: [\"id\", \"type\"],\n  properties: {\n    id: { $ref: \"definitions.json#/definitions/id\" },\n    propertyId: {\n      type: \"string\",\n      description:\n        \"ID of the property this entity belongs to. Optional — used as a per-document filter inside the org-scoped database.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"announcement\"],\n      default: \"announcement\",\n    },\n    status: {\n      type: \"string\",\n      description:\n        \"`sent` is a real broadcast; `preset` is a named, reusable configuration a sender loads into the composer. Absent on records written before presets existed — read as `sent`.\",\n      enum: [\"sent\", \"preset\"],\n      default: \"sent\",\n    },\n    name: {\n      type: \"string\",\n      description: \"Display name of a preset. Sent announcements have none.\",\n    },\n    presetId: {\n      type: \"string\",\n      description:\n        \"The preset this sent announcement was loaded from, when it was.\",\n    },\n    audience: {\n      $ref: \"definitions.json#/definitions/audience\",\n      description:\n        \"Who this announcement was directed at on the people axis. PA surfaces are the other axis and never reach the emergency-contact roster.\",\n    },\n    channels: {\n      type: \"array\",\n      description: \"Personal channels this announcement was sent over.\",\n      items: {\n        type: \"string\",\n        enum: [\"sms\", \"email\"],\n      },\n    },\n    subject: {\n      type: \"string\",\n      description: \"Email subject, and the title shown on a surface.\",\n    },\n    surfaces: {\n      type: \"array\",\n      description:\n        \"Surface channels the announcement was broadcast to, as the sender selected them. `discriminator` is the mediaSource `Device.discriminator` targeted, open for future surface types; only `paSystem` ships today.\",\n      items: {\n        type: \"object\",\n        required: [\"discriminator\", \"scope\"],\n        properties: {\n          discriminator: {\n            type: \"string\",\n            enum: [\"paSystem\"],\n          },\n          scope: {\n            type: \"string\",\n            enum: [\"all\", \"spaces\", \"devices\"],\n          },\n          spaceIds: {\n            type: \"array\",\n            items: { type: \"string\" },\n          },\n          deviceIds: {\n            type: \"array\",\n            items: { type: \"string\" },\n          },\n          outputs: {\n            type: \"array\",\n            description: \"PA output zones to page; all zones when omitted.\",\n            items: { type: \"string\" },\n          },\n          playlistId: {\n            type: \"string\",\n            description:\n              \"A PA playlist (driver recording) played in place of the spoken body; its zones are the playlist's own.\",\n          },\n        },\n        additionalProperties: false,\n      },\n    },\n    body: {\n      type: \"string\",\n      description:\n        \"The spoken/written message. Optional only when every surface plays a preset and no channel is selected.\",\n    },\n    media: {\n      $ref: \"mediaFile.json\",\n    },\n    sentBy: {\n      type: \"string\",\n    },\n    result: {\n      type: \"object\",\n      additionalProperties: false,\n      required: [\"recipientsResolved\", \"perChannel\", \"skipped\", \"surfaces\"],\n      description:\n        \"What the send actually achieved, written once at send time and never recomputed. Absent on presets and on sends recorded before this was stored. The `audience.delivery` counts are the same send viewed per audience; this is the per-channel and per-device detail behind them.\",\n      properties: {\n        recipientsResolved: {\n          type: \"integer\",\n          minimum: 0,\n          description:\n            \"How many internal Users the audience selector resolved to. Zero when no personal channel was selected, however wide the selector — an announcement with no channel reaches no User.\",\n        },\n        external: {\n          type: \"object\",\n          additionalProperties: false,\n          required: [\"recipients\", \"delivery\"],\n          description:\n            \"The external SIS roster this send reached. Absent when no external group was named.\",\n          properties: {\n            recipients: {\n              type: \"integer\",\n              minimum: 0,\n              description: \"Size of the roster the named groups resolved to.\",\n            },\n            delivery: {\n              type: \"object\",\n              additionalProperties: false,\n              description:\n                \"Per-channel counts, present only for the channels attempted.\",\n              properties: {\n                sms: { $ref: \"definitions.json#/definitions/deliveryCounts\" },\n                email: { $ref: \"definitions.json#/definitions/deliveryCounts\" },\n              },\n            },\n          },\n        },\n        perChannel: {\n          type: \"object\",\n          additionalProperties: false,\n          required: [\"sms\", \"email\"],\n          description:\n            \"Messages handed to each personal channel; zero for a channel the send did not select.\",\n          properties: {\n            sms: { type: \"integer\" },\n            email: { type: \"integer\" },\n          },\n        },\n        skipped: {\n          type: \"array\",\n          description:\n            \"Recipients a selected channel could not carry the announcement to. A missing contact detail is a per-channel skip, not a failed send, so one recipient may appear once per channel.\",\n          items: {\n            type: \"object\",\n            required: [\"userId\", \"channel\", \"reason\"],\n            additionalProperties: false,\n            properties: {\n              userId: { type: \"string\" },\n              channel: { type: \"string\", enum: [\"sms\", \"email\"] },\n              reason: { type: \"string\", enum: [\"no-phone\", \"no-email\"] },\n            },\n          },\n        },\n        surfaces: {\n          type: \"array\",\n          description:\n            \"Per-device outcome of the surface page, one entry per device the selectors resolved to. Distinct from the top-level `surfaces`, which is the selector the sender expressed.\",\n          items: {\n            type: \"object\",\n            required: [\"deviceId\", \"status\"],\n            additionalProperties: false,\n            properties: {\n              deviceId: { type: \"string\" },\n              status: {\n                type: \"string\",\n                enum: [\"sent\", \"failed\", \"skipped\"],\n              },\n              reason: {\n                type: \"string\",\n                description:\n                  '`unsupported` when the driver advertises no content command; absent otherwise.',\n              },\n            },\n          },\n        },\n      },\n    },\n    tags: {\n      type: \"array\",\n      items: {\n        type: \"string\",\n      },\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    deletedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n  },\n  additionalProperties: false,\n} as const;\n\nexport type AnnouncementSchema = FromSchema<\n  typeof announcementSchema,\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":";AAGA,MAAa,qBAAqB;CAChC,SAAS;CACT,KAAK;CACL,OAAO;CACP,aAAa;CACb,MAAM;CACN,UAAU,CAAC,MAAM,MAAM;CACvB,YAAY;EACV,IAAI,EAAE,MAAM,mCAAmC;EAC/C,YAAY;GACV,MAAM;GACN,aACE;EACJ;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,cAAc;GACrB,SAAS;EACX;EACA,QAAQ;GACN,MAAM;GACN,aACE;GACF,MAAM,CAAC,QAAQ,QAAQ;GACvB,SAAS;EACX;EACA,MAAM;GACJ,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,MAAM,CAAC,OAAO,OAAO;GACvB;EACF;EACA,SAAS;GACP,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aACE;GACF,OAAO;IACL,MAAM;IACN,UAAU,CAAC,iBAAiB,OAAO;IACnC,YAAY;KACV,eAAe;MACb,MAAM;MACN,MAAM,CAAC,UAAU;KACnB;KACA,OAAO;MACL,MAAM;MACN,MAAM;OAAC;OAAO;OAAU;MAAS;KACnC;KACA,UAAU;MACR,MAAM;MACN,OAAO,EAAE,MAAM,SAAS;KAC1B;KACA,WAAW;MACT,MAAM;MACN,OAAO,EAAE,MAAM,SAAS;KAC1B;KACA,SAAS;MACP,MAAM;MACN,aAAa;MACb,OAAO,EAAE,MAAM,SAAS;KAC1B;KACA,YAAY;MACV,MAAM;MACN,aACE;KACJ;IACF;IACA,sBAAsB;GACxB;EACF;EACA,MAAM;GACJ,MAAM;GACN,aACE;EACJ;EACA,OAAO,EACL,MAAM,iBACR;EACA,QAAQ,EACN,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,sBAAsB;GACtB,UAAU;IAAC;IAAsB;IAAc;IAAW;GAAU;GACpE,aACE;GACF,YAAY;IACV,oBAAoB;KAClB,MAAM;KACN,SAAS;KACT,aACE;IACJ;IACA,UAAU;KACR,MAAM;KACN,sBAAsB;KACtB,UAAU,CAAC,cAAc,UAAU;KACnC,aACE;KACF,YAAY;MACV,YAAY;OACV,MAAM;OACN,SAAS;OACT,aAAa;MACf;MACA,UAAU;OACR,MAAM;OACN,sBAAsB;OACtB,aACE;OACF,YAAY;QACV,KAAK,EAAE,MAAM,+CAA+C;QAC5D,OAAO,EAAE,MAAM,+CAA+C;OAChE;MACF;KACF;IACF;IACA,YAAY;KACV,MAAM;KACN,sBAAsB;KACtB,UAAU,CAAC,OAAO,OAAO;KACzB,aACE;KACF,YAAY;MACV,KAAK,EAAE,MAAM,UAAU;MACvB,OAAO,EAAE,MAAM,UAAU;KAC3B;IACF;IACA,SAAS;KACP,MAAM;KACN,aACE;KACF,OAAO;MACL,MAAM;MACN,UAAU;OAAC;OAAU;OAAW;MAAQ;MACxC,sBAAsB;MACtB,YAAY;OACV,QAAQ,EAAE,MAAM,SAAS;OACzB,SAAS;QAAE,MAAM;QAAU,MAAM,CAAC,OAAO,OAAO;OAAE;OAClD,QAAQ;QAAE,MAAM;QAAU,MAAM,CAAC,YAAY,UAAU;OAAE;MAC3D;KACF;IACF;IACA,UAAU;KACR,MAAM;KACN,aACE;KACF,OAAO;MACL,MAAM;MACN,UAAU,CAAC,YAAY,QAAQ;MAC/B,sBAAsB;MACtB,YAAY;OACV,UAAU,EAAE,MAAM,SAAS;OAC3B,QAAQ;QACN,MAAM;QACN,MAAM;SAAC;SAAQ;SAAU;QAAS;OACpC;OACA,QAAQ;QACN,MAAM;QACN,aACE;OACJ;MACF;KACF;IACF;GACF;EACF;EACA,MAAM;GACJ,MAAM;GACN,OAAO,EACL,MAAM,SACR;EACF;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;CACA,sBAAsB;AACxB"}

package/dist/schemas/category.d.ts

@@ -40,7 +40,17 @@ export declare const categorySchema: {
         };
         readonly discriminator: {
             readonly type: "string";
-            readonly enum: readonly ["space", "product", "mediaFile", "property", "user"];
+            readonly enum: readonly ["space", "product", "mediaFile", "property", "user", "resource"];
+        };
+        readonly iconKey: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "Key into the app's curated icon gallery for this category's discriminator, selecting the glyph shown beside the name. Used by `resource` categories; the app falls back to a default glyph when unset or unrecognized.";
+        };
+        readonly color: {
+            readonly type: readonly ["string", "null"];
+            readonly pattern: "^#[0-9a-fA-F]{6}$";
+            readonly description: "Accent color for the category as a hex value, e.g. #3B93F0";
         };
         readonly systemId: {
             readonly $ref: "definitions.json#/definitions/systemId";

package/dist/schemas/category.js

@@ -40,9 +40,20 @@ const categorySchema = {
 				"product",
 				"mediaFile",
 				"property",
-				"user"
+				"user",
+				"resource"
 			]
 		},
+		iconKey: {
+			type: "string",
+			minLength: 1,
+			description: "Key into the app's curated icon gallery for this category's discriminator, selecting the glyph shown beside the name. Used by `resource` categories; the app falls back to a default glyph when unset or unrecognized."
+		},
+		color: {
+			type: ["string", "null"],
+			pattern: "^#[0-9a-fA-F]{6}$",
+			description: "Accent color for the category as a hex value, e.g. #3B93F0"
+		},
 		systemId: { $ref: "definitions.json#/definitions/systemId" },
 		createdAt: { $ref: "definitions.json#/definitions/date" },
 		updatedAt: { $ref: "definitions.json#/definitions/date" },

package/dist/schemas/category.js.map

@@ -1 +1 @@
-{"version":3,"file":"category.js","names":[],"sources":["../../.generated/schemas/category.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const categorySchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"category.json\",\n  title: \"Category\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"discriminator\"],\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n    },\n    propertyId: {\n      type: \"string\",\n      description: \"ID of the property this entity belongs to. Optional — used as a per-document filter inside the org-scoped database.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"category\"],\n      default: \"category\",\n    },\n    name: {\n      type: \"string\",\n      minLength: 1,\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n    },\n    description: {\n      type: \"string\",\n    },\n    image: {\n      $ref: \"mediaFile.json\",\n    },\n    rating: {\n      type: \"number\",\n      minimum: 0,\n      maximum: 10,\n      default: 9,\n    },\n    discriminator: {\n      type: \"string\",\n      enum: [\"space\", \"product\", \"mediaFile\", \"property\", \"user\"],\n    },\n    systemId: {\n      $ref: \"definitions.json#/definitions/systemId\",\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    deletedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n  },\n  additionalProperties: false,\n} as const;\n\nexport type CategorySchema = FromSchema<\n  typeof categorySchema,\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":";AAGA,MAAa,iBAAiB;CAC5B,SAAS;CACT,KAAK;CACL,OAAO;CACP,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;CAAe;CACxC,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,YAAY;GACV,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,UAAU;GACjB,SAAS;EACX;EACA,MAAM;GACJ,MAAM;GACN,WAAW;EACb;EACA,QAAQ,EACN,MAAM,uCACR;EACA,aAAa,EACX,MAAM,SACR;EACA,OAAO,EACL,MAAM,iBACR;EACA,QAAQ;GACN,MAAM;GACN,SAAS;GACT,SAAS;GACT,SAAS;EACX;EACA,eAAe;GACb,MAAM;GACN,MAAM;IAAC;IAAS;IAAW;IAAa;IAAY;GAAM;EAC5D;EACA,UAAU,EACR,MAAM,yCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;CACA,sBAAsB;AACxB"}
+{"version":3,"file":"category.js","names":[],"sources":["../../.generated/schemas/category.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const categorySchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"category.json\",\n  title: \"Category\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"discriminator\"],\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n    },\n    propertyId: {\n      type: \"string\",\n      description:\n        \"ID of the property this entity belongs to. Optional — used as a per-document filter inside the org-scoped database.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"category\"],\n      default: \"category\",\n    },\n    name: {\n      type: \"string\",\n      minLength: 1,\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n    },\n    description: {\n      type: \"string\",\n    },\n    image: {\n      $ref: \"mediaFile.json\",\n    },\n    rating: {\n      type: \"number\",\n      minimum: 0,\n      maximum: 10,\n      default: 9,\n    },\n    discriminator: {\n      type: \"string\",\n      enum: [\"space\", \"product\", \"mediaFile\", \"property\", \"user\", \"resource\"],\n    },\n    iconKey: {\n      type: \"string\",\n      minLength: 1,\n      description:\n        \"Key into the app's curated icon gallery for this category's discriminator, selecting the glyph shown beside the name. Used by `resource` categories; the app falls back to a default glyph when unset or unrecognized.\",\n    },\n    color: {\n      type: [\"string\", \"null\"],\n      pattern: \"^#[0-9a-fA-F]{6}$\",\n      description:\n        \"Accent color for the category as a hex value, e.g. #3B93F0\",\n    },\n    systemId: {\n      $ref: \"definitions.json#/definitions/systemId\",\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    deletedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n  },\n  additionalProperties: false,\n} as const;\n\nexport type CategorySchema = FromSchema<\n  typeof categorySchema,\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":";AAGA,MAAa,iBAAiB;CAC5B,SAAS;CACT,KAAK;CACL,OAAO;CACP,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;CAAe;CACxC,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,YAAY;GACV,MAAM;GACN,aACE;EACJ;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,UAAU;GACjB,SAAS;EACX;EACA,MAAM;GACJ,MAAM;GACN,WAAW;EACb;EACA,QAAQ,EACN,MAAM,uCACR;EACA,aAAa,EACX,MAAM,SACR;EACA,OAAO,EACL,MAAM,iBACR;EACA,QAAQ;GACN,MAAM;GACN,SAAS;GACT,SAAS;GACT,SAAS;EACX;EACA,eAAe;GACb,MAAM;GACN,MAAM;IAAC;IAAS;IAAW;IAAa;IAAY;IAAQ;GAAU;EACxE;EACA,SAAS;GACP,MAAM;GACN,WAAW;GACX,aACE;EACJ;EACA,OAAO;GACL,MAAM,CAAC,UAAU,MAAM;GACvB,SAAS;GACT,aACE;EACJ;EACA,UAAU,EACR,MAAM,yCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;CACA,sBAAsB;AACxB"}